summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <mail@nicolasgoaziou.fr>2019-02-14 01:15:20 +0100
committerNicolas Goaziou <mail@nicolasgoaziou.fr>2019-02-14 01:15:20 +0100
commit1cdcf36a0394c3e53b8fd633abfc94e8db98ae40 (patch)
treed5548d1d59e76e74f5d6785c58134761f0805b73
parent6d9022df22f86e8b0ea00dfb9179128136edc49a (diff)
downloadorg-mode-1cdcf36a0394c3e53b8fd633abfc94e8db98ae40.tar.gz
org-manual: Fix indentation in description lists
Fix indentation according to recent indentation rules changes in description lists.
-rw-r--r--doc/org-manual.org10054
1 files changed, 4976 insertions, 5078 deletions
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 96a9147..af0390e 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -333,24 +333,24 @@ conventions:
#+attr_texinfo: :sep ,
- =TODO=, =WAITING= ::
- TODO keywords are written with all capitals, even if they are
- user-defined.
+ TODO keywords are written with all capitals, even if they are
+ user-defined.
- =boss=, =ARCHIVE= ::
- Tags are case-sensitive. User-defined tags are written in
- lowercase; built-in tags with special meaning are written as they
- should appear in the document, usually with all capitals.
+ Tags are case-sensitive. User-defined tags are written in
+ lowercase; built-in tags with special meaning are written as they
+ should appear in the document, usually with all capitals.
- =Release=, =PRIORITY= ::
- User-defined properties are capitalized; built-in properties with
- special meaning are written with all capitals.
+ User-defined properties are capitalized; built-in properties with
+ special meaning are written with all capitals.
- =TITLE=, =BEGIN= ... =END= ::
- Keywords and blocks are written in uppercase to enhance their
- readability, but you can use lowercase in your Org files.
+ Keywords and blocks are written in uppercase to enhance their
+ readability, but you can use lowercase in your Org files.
*** Key bindings and commands
:PROPERTIES:
@@ -462,104 +462,104 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and
#+attr_texinfo: :sep ,
- {{{kbd(TAB)}}} (~org-cycle~) ::
- #+kindex: TAB
- #+findex: org-cycle
- /Subtree cycling/: Rotate current subtree among the states
+ #+kindex: TAB
+ #+findex: org-cycle
+ /Subtree cycling/: Rotate current subtree among the states
- #+begin_example
- ,-> FOLDED -> CHILDREN -> SUBTREE --.
- '-----------------------------------'
- #+end_example
+ #+begin_example
+ ,-> FOLDED -> CHILDREN -> SUBTREE --.
+ '-----------------------------------'
+ #+end_example
- #+vindex: org-cycle-emulate-tab
- Point must be on a headline for this to work[fn:4].
+ #+vindex: org-cycle-emulate-tab
+ Point must be on a headline for this to work[fn:4].
- {{{kbd(S-TAB)}}} (~org-global-cycle~), {{{kbd(C-u TAB)}}} ::
- #+cindex: global visibility states
- #+cindex: global cycling
- #+cindex: overview, global visibility state
- #+cindex: contents, global visibility state
- #+cindex: show all, global visibility state
- #+kindex: C-u TAB
- #+kindex: S-TAB
- #+findex: org-global-cycle
- /Global cycling/: Rotate the entire buffer among the states
-
- #+begin_example
- ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
- '--------------------------------------'
- #+end_example
-
- When {{{kbd(S-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 [[*Tables]]), {{{kbd(S-TAB)}}} jumps to the
- previous field instead.
-
- #+vindex: org-cycle-global-at-bob
- You can run global cycling using {{{kbd(TAB)}}} only if point is
- at the very beginning of the buffer, but not on a headline, and
- ~org-cycle-global-at-bob~ is set to a non-~nil~ value.
+ #+cindex: global visibility states
+ #+cindex: global cycling
+ #+cindex: overview, global visibility state
+ #+cindex: contents, global visibility state
+ #+cindex: show all, global visibility state
+ #+kindex: C-u TAB
+ #+kindex: S-TAB
+ #+findex: org-global-cycle
+ /Global cycling/: Rotate the entire buffer among the states
+
+ #+begin_example
+ ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
+ '--------------------------------------'
+ #+end_example
+
+ When {{{kbd(S-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 [[*Tables]]), {{{kbd(S-TAB)}}} jumps to the previous
+ field instead.
+
+ #+vindex: org-cycle-global-at-bob
+ You can run global cycling using {{{kbd(TAB)}}} only if point is at
+ the very beginning of the buffer, but not on a headline, and
+ ~org-cycle-global-at-bob~ is set to a non-~nil~ value.
- {{{kbd(C-u C-u TAB)}}} (~org-set-startup-visibility~) ::
- #+cindex: startup visibility
- #+kindex: C-u C-u TAB
- #+findex: org-set-startup-visibility
- Switch back to the startup visibility of the buffer (see [[*Initial
- visibility]]).
+ #+cindex: startup visibility
+ #+kindex: C-u C-u TAB
+ #+findex: org-set-startup-visibility
+ Switch back to the startup visibility of the buffer (see [[*Initial
+ visibility]]).
- {{{kbd(C-u C-u C-u TAB)}}} (~outline-show-all~) ::
- #+cindex: show all, command
- #+kindex: C-u C-u C-u TAB
- #+findex: outline-show-all
- Show all, including drawers.
+ #+cindex: show all, command
+ #+kindex: C-u C-u C-u TAB
+ #+findex: outline-show-all
+ Show all, including drawers.
- {{{kbd(C-c C-r)}}} (~org-reveal~) ::
- #+cindex: revealing context
- #+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 [[*Sparse Trees]]) or an agenda command (see [[*Commands in the
- Agenda Buffer]]). With a prefix argument show, on each level, all
- sibling headings. With a double prefix argument, also show the
- entire subtree of the parent.
+ #+cindex: revealing context
+ #+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
+ [[*Sparse Trees]]) or an agenda command (see [[*Commands in the Agenda
+ Buffer]]). With a prefix argument show, on each level, all sibling
+ headings. With a double prefix argument, also show the entire
+ subtree of the parent.
- {{{kbd(C-c C-k)}}} (~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.
+ #+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.
- {{{kbd(C-c TAB)}}} (~outline-show-children~) ::
- #+cindex: show children, command
- #+kindex: C-c TAB
- #+findex: outline-show-children
- Expose all direct children of the subtree. With a numeric prefix
- argument N, expose all children down to level N.
+ #+cindex: show children, command
+ #+kindex: C-c TAB
+ #+findex: outline-show-children
+ Expose all direct children of the subtree. With a numeric prefix
+ argument N, expose all children down to level N.
- {{{kbd(C-c C-x b)}}} (~org-tree-to-indirect-buffer~) ::
- #+kindex: C-c C-x b
- #+findex: org-tree-to-indirect-buffer
- Show the current subtree in an indirect buffer[fn:5]. 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.
+ #+kindex: C-c C-x b
+ #+findex: org-tree-to-indirect-buffer
+ Show the current subtree in an indirect buffer[fn:5]. 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.
- {{{kbd(C-c C-x v)}}} (~org-copy-visible~) ::
- #+kindex: C-c C-x v
- #+findex: org-copy-visible
- Copy the /visible/ text in the region into the kill ring.
+ #+kindex: C-c C-x v
+ #+findex: org-copy-visible
+ Copy the /visible/ text in the region into the kill ring.
*** Initial visibility
:PROPERTIES:
@@ -588,11 +588,11 @@ for this property are =folded=, =children=, =content=, and =all=.
- {{{kbd(C-u C-u TAB)}}} (~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 =VISIBILITY=
- properties in individual entries.
+ #+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 =VISIBILITY= properties in
+ individual entries.
*** Catching invisible edits
:PROPERTIES:
@@ -619,62 +619,62 @@ The following commands jump to other headlines in the buffer.
- {{{kbd(C-c C-n)}}} (~outline-next-visible-heading~) ::
- #+kindex: C-c C-n
- #+findex: outline-next-visible-heading
- Next heading.
+ #+kindex: C-c C-n
+ #+findex: outline-next-visible-heading
+ Next heading.
- {{{kbd(C-c C-p)}}} (~outline-previous-visible-heading~) ::
- #+kindex: C-c C-p
- #+findex: outline-previous-visible-heading
- Previous heading.
+ #+kindex: C-c C-p
+ #+findex: outline-previous-visible-heading
+ Previous heading.
- {{{kbd(C-c C-f)}}} (~org-forward-same-level~) ::
- #+kindex: C-c C-f
- #+findex: org-forward-same-level
- Next heading same level.
+ #+kindex: C-c C-f
+ #+findex: org-forward-same-level
+ Next heading same level.
- {{{kbd(C-c C-b)}}} (~org-backward-same-level~) ::
- #+kindex: C-c C-b
- #+findex: org-backward-same-level
- Previous heading same level.
+ #+kindex: C-c C-b
+ #+findex: org-backward-same-level
+ Previous heading same level.
- {{{kbd(C-c C-u)}}} (~outline-up-heading~) ::
- #+kindex: C-c C-u
- #+findex: outline-up-heading
- Backward to higher level heading.
+ #+kindex: C-c C-u
+ #+findex: outline-up-heading
+ Backward to higher level heading.
- {{{kbd(C-c C-j)}}} (~org-goto~) ::
- #+kindex: C-c C-j
- #+findex: org-goto
- #+vindex: org-goto-auto-isearch
- Jump to a different place without changing the current outline
- visibility. Shows the document structure in a temporary buffer,
- where you can use the following keys to find your destination:
-
- #+attr_texinfo: :columns 0.3 0.7
- | {{{kbd(TAB)}}} | Cycle visibility. |
- | {{{kbd(DOWN)}}} / {{{kbd(UP)}}} | Next/previous visible headline. |
- | {{{kbd(RET)}}} | Select this location. |
- | {{{kbd(/)}}} | Do a Sparse-tree search |
-
- #+texinfo: @noindent
- The following keys work if you turn off ~org-goto-auto-isearch~
-
- #+attr_texinfo: :columns 0.3 0.7
- | {{{kbd(n)}}} / {{{kbd(p)}}} | Next/previous visible headline. |
- | {{{kbd(f)}}} / {{{kbd(b)}}} | Next/previous headline same level. |
- | {{{kbd(u)}}} | One level up. |
- | {{{kbd(0)}}} ... {{{kbd(9)}}} | Digit argument. |
- | {{{kbd(q)}}} | Quit. |
-
- #+vindex: org-goto-interface
- #+texinfo: @noindent
- See also the variable ~org-goto-interface~.
+ #+kindex: C-c C-j
+ #+findex: org-goto
+ #+vindex: org-goto-auto-isearch
+ Jump to a different place without changing the current outline
+ visibility. Shows the document structure in a temporary buffer,
+ where you can use the following keys to find your destination:
+
+ #+attr_texinfo: :columns 0.3 0.7
+ | {{{kbd(TAB)}}} | Cycle visibility. |
+ | {{{kbd(DOWN)}}} / {{{kbd(UP)}}} | Next/previous visible headline. |
+ | {{{kbd(RET)}}} | Select this location. |
+ | {{{kbd(/)}}} | Do a Sparse-tree search |
+
+ #+texinfo: @noindent
+ The following keys work if you turn off ~org-goto-auto-isearch~
+
+ #+attr_texinfo: :columns 0.3 0.7
+ | {{{kbd(n)}}} / {{{kbd(p)}}} | Next/previous visible headline. |
+ | {{{kbd(f)}}} / {{{kbd(b)}}} | Next/previous headline same level. |
+ | {{{kbd(u)}}} | One level up. |
+ | {{{kbd(0)}}} ... {{{kbd(9)}}} | Digit argument. |
+ | {{{kbd(q)}}} | Quit. |
+
+ #+vindex: org-goto-interface
+ #+texinfo: @noindent
+ See also the variable ~org-goto-interface~.
** Structure Editing
:PROPERTIES:
@@ -693,208 +693,203 @@ The following commands jump to other headlines in the buffer.
- {{{kbd(M-RET)}}} (~org-meta-return~) ::
- #+kindex: M-RET
- #+findex: org-meta-return
- #+vindex: org-M-RET-may-split-line
- Insert a new heading, item or row.
+ #+kindex: M-RET
+ #+findex: org-meta-return
+ #+vindex: org-M-RET-may-split-line
+ Insert a new heading, item or row.
- If the command is used at the /beginning/ of a line, and if there
- is a heading or a plain list item (see [[*Plain Lists]]) at point,
- the new heading/item is created /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 /beginning/ of a line, and if there is
+ a heading or a plain list item (see [[*Plain Lists]]) at point, the new
+ heading/item is created /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
- ~org-M-RET-may-split-line~.
+ 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
+ ~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.
+ 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.
- {{{kbd(C-RET)}}} (~org-insert-heading-respect-content~) ::
- #+kindex: C-RET
- #+findex: org-insert-heading-respect-content
- Insert a new heading at the end of the current subtree.
+ #+kindex: C-RET
+ #+findex: org-insert-heading-respect-content
+ Insert a new heading at the end of the current subtree.
- {{{kbd(M-S-RET)}}} (~org-insert-todo-heading~) ::
- #+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
- ~org-treat-insert-todo-heading-as-state-change~.
+ #+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 ~org-treat-insert-todo-heading-as-state-change~.
- {{{kbd(C-S-RET)}}} (~org-insert-todo-heading-respect-content~) ::
- #+kindex: C-S-RET
- #+findex: org-insert-todo-heading-respect-content
- Insert new TODO entry with same level as current heading. Like
- {{{kbd(C-RET)}}}, the new headline is inserted after the current
- subtree.
+ #+kindex: C-S-RET
+ #+findex: org-insert-todo-heading-respect-content
+ Insert new TODO entry with same level as current heading. Like
+ {{{kbd(C-RET)}}}, the new headline is inserted after the current
+ subtree.
- {{{kbd(TAB)}}} (~org-cycle~) ::
- #+kindex: TAB
- #+findex: org-cycle
- In a new entry with no text yet, the first {{{kbd(TAB)}}} demotes
- the entry to become a child of the previous one. The next
- {{{kbd(TAB)}}} makes it a parent, and so on, all the way to top
- level. Yet another {{{kbd(TAB)}}}, and you are back to the
- initial level.
+ #+kindex: TAB
+ #+findex: org-cycle
+ In a new entry with no text yet, the first {{{kbd(TAB)}}} demotes
+ the entry to become a child of the previous one. The next
+ {{{kbd(TAB)}}} makes it a parent, and so on, all the way to top
+ level. Yet another {{{kbd(TAB)}}}, and you are back to the initial
+ level.
- {{{kbd(M-LEFT)}}} (~org-do-promote~) ::
- #+kindex: M-LEFT
- #+findex: org-do-promote
- Promote current heading by one level.
+ #+kindex: M-LEFT
+ #+findex: org-do-promote
+ Promote current heading by one level.
- {{{kbd(M-RIGHT)}}} (~org-do-demote~) ::
- #+kindex: M-RIGHT
- #+findex: org-do-demote
- Demote current heading by one level.
+ #+kindex: M-RIGHT
+ #+findex: org-do-demote
+ Demote current heading by one level.
- {{{kbd(M-S-LEFT)}}} (~org-promote-subtree~) ::
- #+kindex: M-S-LEFT
- #+findex: org-promote-subtree
- Promote the current subtree by one level.
+ #+kindex: M-S-LEFT
+ #+findex: org-promote-subtree
+ Promote the current subtree by one level.
- {{{kbd(M-S-RIGHT)}}} (~org-demote-subtree~) ::
- #+kindex: M-S-RIGHT
- #+findex: org-demote-subtree
- Demote the current subtree by one level.
+ #+kindex: M-S-RIGHT
+ #+findex: org-demote-subtree
+ Demote the current subtree by one level.
- {{{kbd(M-UP)}}} (~org-move-subtree-up~) ::
- #+kindex: M-UP
- #+findex: org-move-subtree-up
- Move subtree up, i.e., swap with previous subtree of same level.
+ #+kindex: M-UP
+ #+findex: org-move-subtree-up
+ Move subtree up, i.e., swap with previous subtree of same level.
- {{{kbd(M-DOWN)}}} (~org-move-subtree-down~) ::
- #+kindex: M-DOWN
- #+findex: org-move-subtree-down
- Move subtree down, i.e., swap with next subtree of same level.
+ #+kindex: M-DOWN
+ #+findex: org-move-subtree-down
+ Move subtree down, i.e., swap with next subtree of same level.
- {{{kbd(C-c @)}}} (~org-mark-subtree~) ::
- #+kindex: C-c @@
- #+findex: org-mark-subtree
- Mark the subtree at point. Hitting repeatedly marks subsequent
- subtrees of the same level as the marked subtree.
+ #+kindex: C-c @@
+ #+findex: org-mark-subtree
+ Mark the subtree at point. Hitting repeatedly marks subsequent
+ subtrees of the same level as the marked subtree.
- {{{kbd(C-c C-x C-w)}}} (~org-cut-subtree~) ::
- #+kindex: C-c C-x C-w
- #+findex: org-cut-subtree
- Kill subtree, i.e., remove it from buffer but save in kill ring.
- With a numeric prefix argument N, kill N sequential subtrees.
+ #+kindex: C-c C-x C-w
+ #+findex: org-cut-subtree
+ Kill subtree, i.e., remove it from buffer but save in kill ring.
+ With a numeric prefix argument N, kill N sequential subtrees.
- {{{kbd(C-c C-x M-w)}}} (~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.
+ #+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.
- {{{kbd(C-c C-x C-y)}}} (~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
- =****=.
+ #+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 =****=.
- {{{kbd(C-y)}}} (~org-yank~) ::
- #+kindex: C-y
- #+findex: org-yank
- #+vindex: org-yank-adjusted-subtrees
- #+vindex: org-yank-folded-subtrees
- Depending on the variables ~org-yank-adjusted-subtrees~ and
- ~org-yank-folded-subtrees~, Org's internal ~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 ~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 ~yank-pop~ after a yank, it
- yanks previous kill items plainly, without adjustment and
- folding.
+ #+kindex: C-y
+ #+findex: org-yank
+ #+vindex: org-yank-adjusted-subtrees
+ #+vindex: org-yank-folded-subtrees
+ Depending on the variables ~org-yank-adjusted-subtrees~ and
+ ~org-yank-folded-subtrees~, Org's internal ~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 ~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 ~yank-pop~ after a yank, it yanks previous kill
+ items plainly, without adjustment and folding.
- {{{kbd(C-c C-x c)}}} (~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 ~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 ~org-clone-subtree-with-time-shift~.
- {{{kbd(C-c C-w)}}} (~org-refile~) ::
- #+kindex: C-c C-w
- #+findex: org-refile
- Refile entry or region to a different location. See [[*Refile and
- Copy]].
+ #+kindex: C-c C-w
+ #+findex: org-refile
+ Refile entry or region to a different location. See [[*Refile and
+ Copy]].
- {{{kbd(C-c ^)}}} (~org-sort~) ::
- #+kindex: C-c ^
- #+findex: org-sort
- Sort same-level entries. When there is an active region, all
- 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
- 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.
+ #+kindex: C-c ^
+ #+findex: org-sort
+ Sort same-level entries. When there is an active region, all
+ 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
+ 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.
- {{{kbd(C-x n s)}}} (~org-narrow-to-subtree~) ::
- #+kindex: C-x n s
- #+findex: org-narrow-to-subtree
- Narrow buffer to current subtree.
+ #+kindex: C-x n s
+ #+findex: org-narrow-to-subtree
+ Narrow buffer to current subtree.
- {{{kbd(C-x n b)}}} (~org-narrow-to-block~) ::
- #+kindex: C-x n b
- #+findex: org-narrow-to-block
- Narrow buffer to current block.
+ #+kindex: C-x n b
+ #+findex: org-narrow-to-block
+ Narrow buffer to current block.
- {{{kbd(C-x n w)}}} (~widen~) ::
- #+kindex: C-x n w
- #+findex: widen
- Widen buffer to remove narrowing.
+ #+kindex: C-x n w
+ #+findex: widen
+ Widen buffer to remove narrowing.
- {{{kbd(C-c *)}}} (~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.
+ #+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.
#+cindex: region, active
#+cindex: active region
@@ -928,41 +923,41 @@ commands can be accessed through a dispatcher:
- {{{kbd(C-c /)}}} (~org-sparse-tree~) ::
- #+kindex: C-c /
- #+findex: org-sparse-tree
- This prompts for an extra key to select a sparse-tree creating
- command.
+ #+kindex: C-c /
+ #+findex: org-sparse-tree
+ This prompts for an extra key to select a sparse-tree creating
+ command.
- {{{kbd(C-c / r)}}} or {{{kbd(C-c / /)}}} (~org-occur~) ::
- #+kindex: C-c / r
- #+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
- 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)}}}[fn:8]. When called
- with a {{{kbd(C-u)}}} prefix argument, previous highlights are
- kept, so several calls to this command can be stacked.
+ #+kindex: C-c / r
+ #+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
+ 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)}}}[fn:8]. When called with
+ a {{{kbd(C-u)}}} prefix argument, previous highlights are kept, so
+ several calls to this command can be stacked.
- {{{kbd(M-g n)}}} or {{{kbd(M-g M-n)}}} (~next-error~) ::
- #+kindex: M-g n
- #+kindex: M-g M-n
- #+findex: next-error
- Jump to the next sparse tree match in this buffer.
+ #+kindex: M-g n
+ #+kindex: M-g M-n
+ #+findex: next-error
+ Jump to the next sparse tree match in this buffer.
- {{{kbd(M-g p)}}} or {{{kbd(M-g M-p)}}} (~previous-error~) ::
- #+kindex: M-g p
- #+kindex: M-g M-p
- #+findex: previous-error
- Jump to the previous sparse tree match in this buffer.
+ #+kindex: M-g p
+ #+kindex: M-g M-p
+ #+findex: previous-error
+ Jump to the previous sparse tree match in this buffer.
#+vindex: org-agenda-custom-commands
For frequently used sparse trees of specific search strings, you can
@@ -1077,134 +1072,133 @@ to disable them individually.
#+attr_texinfo: :sep ,
- {{{kbd(TAB)}}} (~org-cycle~) ::
- #+cindex: cycling, in plain lists
- #+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 ~org-cycle-include-plain-lists~. If this
- variable is set to ~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(TAB)}}} demotes the item to become a child of the previous
- one. Subsequent {{{kbd(TAB)}}}s move the item to meaningful
- levels in the list and eventually get it back to its initial
- position.
+ #+cindex: cycling, in plain lists
+ #+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 ~org-cycle-include-plain-lists~. If this variable is set
+ to ~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(TAB)}}} demotes the item to
+ become a child of the previous one. Subsequent {{{kbd(TAB)}}}s move
+ the item to meaningful levels in the list and eventually get it back
+ to its initial position.
- {{{kbd(M-RET)}}} (~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 [[*Structure Editing]]). If this command is used
- in the middle of an item, that item is /split/ in two, and the
- second part becomes the new item[fn:13]. If this command is
- executed /before item's body/, the new item is created /before/
- the current one.
+ #+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 [[*Structure Editing]]). If this command is used in
+ the middle of an item, that item is /split/ in two, and the second
+ part becomes the new item[fn:13]. If this command is executed
+ /before item's body/, the new item is created /before/ the current
+ one.
- {{{kbd(M-S-RET)}}} ::
- #+kindex: M-S-RET
- Insert a new item with a checkbox (see [[*Checkboxes]]).
+ #+kindex: M-S-RET
+ Insert a new item with a checkbox (see [[*Checkboxes]]).
- {{{kbd(S-UP)}}}, {{{kbd(S-DOWN)}}} ::
- #+kindex: S-UP
- #+kindex: S-DOWN
- #+cindex: shift-selection-mode
- #+vindex: org-support-shift-select
- #+vindex: org-list-use-circular-motion
- Jump to the previous/next item in the current list, but only if
- ~org-support-shift-select~ is off[fn:14]. If not, you can
- still use paragraph jumping commands like {{{kbd(C-UP)}}}
- and {{{kbd(C-DOWN)}}} to quite similar effect.
+ #+kindex: S-UP
+ #+kindex: S-DOWN
+ #+cindex: shift-selection-mode
+ #+vindex: org-support-shift-select
+ #+vindex: org-list-use-circular-motion
+ Jump to the previous/next item in the current list, but only if
+ ~org-support-shift-select~ is off[fn:14]. If not, you can still use
+ paragraph jumping commands like {{{kbd(C-UP)}}} and
+ {{{kbd(C-DOWN)}}} to quite similar effect.
- {{{kbd(M-UP)}}}, {{{kbd(M-DOWN)}}} ::
- #+kindex: M-UP
- #+kindex: M-DOWN
- Move the item including subitems up/down[fn:15], i.e., swap with
- previous/next item of same indentation. If the list is ordered,
- renumbering is automatic.
+ #+kindex: M-UP
+ #+kindex: M-DOWN
+ Move the item including subitems up/down[fn:15], i.e., swap with
+ previous/next item of same indentation. If the list is ordered,
+ renumbering is automatic.
- {{{kbd(M-LEFT)}}}, {{{kbd(M-RIGHT)}}} ::
- #+kindex: M-LEFT
- #+kindex: M-RIGHT
- Decrease/increase the indentation of an item, leaving children
- alone.
+ #+kindex: M-LEFT
+ #+kindex: M-RIGHT
+ Decrease/increase the indentation of an item, leaving children
+ alone.
- {{{kbd(M-S-LEFT)}}}, {{{kbd(M-S-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.
+ #+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.
- 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 ~org-list-automatic-rules~. The global indentation
- of a list has no influence on the text /after/ the list.
+ 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 ~org-list-automatic-rules~. The global indentation of
+ a list has no influence on the text /after/ the list.
- {{{kbd(C-c C-c)}}} ::
- #+kindex: C-c C-c
- If there is a checkbox (see [[*Checkboxes]]) in the item line, toggle
- the state of the checkbox. In any case, verify bullets and
- indentation consistency in the whole list.
+ #+kindex: C-c C-c
+ If there is a checkbox (see [[*Checkboxes]]) in the item line, toggle
+ the state of the checkbox. In any case, verify bullets and
+ indentation consistency in the whole list.
- {{{kbd(C-c -)}}} ::
- #+kindex: C-c -
- #+vindex: org-plain-list-ordered-item-terminator
- Cycle the entire list level through the different
- itemize/enumerate bullets (=-=, =+=, =*=, =1.=, =1)=) or a subset
- of them, depending on ~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.
+ #+kindex: C-c -
+ #+vindex: org-plain-list-ordered-item-terminator
+ Cycle the entire list level through the different itemize/enumerate
+ bullets (=-=, =+=, =*=, =1.=, =1)=) or a subset of them, depending
+ on ~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.
- {{{kbd(C-c *)}}} ::
- #+kindex: C-c *
- Turn a plain list item into a headline---so that it becomes
- a subheading at its location. See [[*Structure Editing]], for
- a detailed explanation.
+ #+kindex: C-c *
+ Turn a plain list item into a headline---so that it becomes
+ a subheading at its location. See [[*Structure Editing]], for
+ a detailed explanation.
- {{{kbd(C-c C-*)}}} ::
- #+kindex: C-c C-*
- Turn the whole plain list into a subtree of the current heading.
- Checkboxes (see [[*Checkboxes]]) become TODO, respectively DONE,
- keywords when unchecked, respectively checked.
+ #+kindex: C-c C-*
+ Turn the whole plain list into a subtree of the current heading.
+ Checkboxes (see [[*Checkboxes]]) become TODO, respectively DONE,
+ keywords when unchecked, respectively checked.
- {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} ::
- #+vindex: org-support-shift-select
- #+kindex: S-LEFT
- #+kindex: S-RIGHT
- This command also cycles bullet styles when point is in on the
- bullet or anywhere in an item line, details depending on
- ~org-support-shift-select~.
+ #+vindex: org-support-shift-select
+ #+kindex: S-LEFT
+ #+kindex: S-RIGHT
+ This command also cycles bullet styles when point is in on the
+ bullet or anywhere in an item line, details depending on
+ ~org-support-shift-select~.
- {{{kbd(C-c ^)}}} ::
- #+kindex: C-c ^
- #+cindex: sorting, of plain list
- Sort the plain list. Prompt for the sorting method: numerically,
- alphabetically, by time, or by custom function.
+ #+kindex: C-c ^
+ #+cindex: sorting, of plain list
+ Sort the plain list. Prompt for the sorting method: numerically,
+ alphabetically, by time, or by custom function.
** Drawers
:PROPERTIES:
@@ -1252,8 +1246,8 @@ a similar way to state changes, use
- {{{kbd(C-c C-z)}}} ::
- #+kindex: C-c C-z
- Add a time-stamped note to the =LOGBOOK= drawer.
+ #+kindex: C-c C-z
+ Add a time-stamped note to the =LOGBOOK= drawer.
** Blocks
:PROPERTIES:
@@ -1300,20 +1294,19 @@ optional inline definition. Here are the valid references:
- =[fn:NAME]= ::
- A named footnote reference, where {{{var(NAME)}}} is a unique
- label word, or, for simplicity of automatic creation, a number.
+ A named footnote reference, where {{{var(NAME)}}} is a unique
+ label word, or, for simplicity of automatic creation, a number.
- =[fn:: This is the inline definition of this footnote]= ::
- A LaTeX-like anonymous footnote where the definition is given
- directly at the reference point.
+ An anonymous footnote where the definition is given directly at the
+ reference point.
- =[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 =[fn:NAME]= to create additional
- references.
+ 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 =[fn:NAME]= to create additional references.
#+vindex: org-footnote-auto-label
Footnote labels can be created automatically, or you can create names
@@ -1325,51 +1318,49 @@ The following command handles footnotes:
- {{{kbd(C-c C-x f)}}} ::
- The footnote action command.
+ 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.
+ #+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
- ~org-footnote-define-inline~[fn:17], the definition is placed
- right into the text as part of the reference, or separately into
- the location determined by the variable ~org-footnote-section~.
+ #+vindex: org-footnote-define-inline
+ #+vindex: org-footnote-section
+ Otherwise, create a new footnote. Depending on the variable
+ ~org-footnote-define-inline~[fn:17], the definition is placed right
+ into the text as part of the reference, or separately into the
+ location determined by the variable ~org-footnote-section~.
- When this command is called with a prefix argument, a menu of
- additional options is offered:
+ When this command is called with a prefix argument, a menu of
+ additional options is offered:
- #+attr_texinfo: :columns 0.1 0.9
- | {{{kbd(s)}}} | Sort the footnote definitions by reference sequence. |
- | {{{kbd(r)}}} | Renumber the simple =fn:N= footnotes. |
- | {{{kbd(S)}}} | Short for first {{{kbd(r)}}}, then {{{kbd(s)}}} action. |
- | {{{kbd(n)}}} | Rename all footnotes into a =fn:1= ... =fn:n= sequence. |
- | {{{kbd(d)}}} | Delete the footnote at point, including definition and references. |
+ #+attr_texinfo: :columns 0.1 0.9
+ | {{{kbd(s)}}} | Sort the footnote definitions by reference sequence. |
+ | {{{kbd(r)}}} | Renumber the simple =fn:N= footnotes. |
+ | {{{kbd(S)}}} | Short for first {{{kbd(r)}}}, then {{{kbd(s)}}} action. |
+ | {{{kbd(n)}}} | Rename all footnotes into a =fn:1= ... =fn:n= sequence. |
+ | {{{kbd(d)}}} | Delete the footnote at point, including definition and references. |
- #+vindex: org-footnote-auto-adjust
- Depending on the variable ~org-footnote-auto-adjust~[fn:18],
- renumbering and sorting footnotes can be automatic after each
- insertion or deletion.
+ #+vindex: org-footnote-auto-adjust
+ Depending on the variable ~org-footnote-auto-adjust~[fn:18],
+ renumbering and sorting footnotes can be automatic after each
+ insertion or deletion.
- {{{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)}}}.
+ #+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)}}}.
- {{{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.
+ #+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.
* Tables
:PROPERTIES:
@@ -1440,22 +1431,22 @@ you, configure the option ~org-table-auto-blank-field~.
- {{{kbd(C-c |)}}} (~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(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(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(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 RET | - TAB)}}}.
+ #+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(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(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(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 RET | - TAB)}}}.
*** Re-aligning and field motion
:PROPERTIES:
@@ -1464,49 +1455,49 @@ you, configure the option ~org-table-auto-blank-field~.
- {{{kbd(C-c C-c)}}} (~org-table-align~) ::
- #+kindex: C-c C-c
- #+findex: org-table-align
- Re-align the table without moving point.
+ #+kindex: C-c C-c
+ #+findex: org-table-align
+ Re-align the table without moving point.
- {{{kbd(TAB)}}} (~org-table-next-field~) ::
- #+kindex: TAB
- #+findex: org-table-next-field
- Re-align the table, move to the next field. Creates a new row if
- necessary.
+ #+kindex: TAB
+ #+findex: org-table-next-field
+ Re-align the table, move to the next field. Creates a new row if
+ necessary.
- {{{kbd(C-c SPC)}}} (~org-table-blank-field~) ::
- #+kindex: C-c SPC
- #+findex: org-table-blank-field
- Blank the field at point.
+ #+kindex: C-c SPC
+ #+findex: org-table-blank-field
+ Blank the field at point.
- {{{kbd(S-TAB)}}} (~org-table-previous-field~) ::
- #+kindex: S-TAB
- #+findex: org-table-previous-field
- Re-align, move to previous field.
+ #+kindex: S-TAB
+ #+findex: org-table-previous-field
+ Re-align, move to previous field.
- {{{kbd(RET)}}} (~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(RET)}}}
- still inserts a new line, so it can be used to split a table.
+ #+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(RET)}}} still
+ inserts a new line, so it can be used to split a table.
- {{{kbd(M-a)}}} (~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.
+ #+kindex: M-a
+ #+findex: org-table-beginning-of-field
+ Move to beginning of the current table field, or on to the previous
+ field.
- {{{kbd(M-e)}}} (~org-table-end-of-field~) ::
- #+kindex: M-e
- #+findex: org-table-end-of-field
- Move to end of the current table field, or on to the next field.
+ #+kindex: M-e
+ #+findex: org-table-end-of-field
+ Move to end of the current table field, or on to the next field.
*** Column and row editing
:PROPERTIES:
@@ -1515,107 +1506,106 @@ you, configure the option ~org-table-auto-blank-field~.
- {{{kbd(M-LEFT)}}} (~org-table-move-column-left~) ::
- #+kindex: M-LEFT
- #+findex: org-table-move-column-left
- Move the current column left.
+ #+kindex: M-LEFT
+ #+findex: org-table-move-column-left
+ Move the current column left.
- {{{kbd(M-RIGHT)}}} (~org-table-move-column-right~) ::
- #+kindex: M-RIGHT
- #+findex: org-table-move-column-right
- Move the current column right.
+ #+kindex: M-RIGHT
+ #+findex: org-table-move-column-right
+ Move the current column right.
- {{{kbd(M-S-LEFT)}}} (~org-table-delete-column~) ::
- #+kindex: M-S-LEFT
- #+findex: org-table-delete-column
- Kill the current column.
+ #+kindex: M-S-LEFT
+ #+findex: org-table-delete-column
+ Kill the current column.
- {{{kbd(M-S-RIGHT)}}} (~org-table-insert-column~) ::
- #+kindex: M-S-RIGHT
- #+findex: org-table-insert-column
- Insert a new column to the left of point position.
+ #+kindex: M-S-RIGHT
+ #+findex: org-table-insert-column
+ Insert a new column to the left of point position.
- {{{kbd(M-UP)}}} (~org-table-move-row-up~) ::
- #+kindex: M-UP
- #+findex: org-table-move-row-up
- Move the current row up.
+ #+kindex: M-UP
+ #+findex: org-table-move-row-up
+ Move the current row up.
- {{{kbd(M-DOWN)}}} (~org-table-move-row-down~) ::
- #+kindex: M-DOWN
- #+findex: org-table-move-row-down
- Move the current row down.
+ #+kindex: M-DOWN
+ #+findex: org-table-move-row-down
+ Move the current row down.
- {{{kbd(M-S-UP)}}} (~org-table-kill-row~) ::
- #+kindex: M-S-UP
- #+findex: org-table-kill-row
- Kill the current row or horizontal line.
+ #+kindex: M-S-UP
+ #+findex: org-table-kill-row
+ Kill the current row or horizontal line.
- {{{kbd(S-UP)}}} (~org-table-move-cell-up~) ::
- #+kindex: S-UP
- #+findex: org-table-move-cell-up
- Move cell up by swapping with adjacent cell.
+ #+kindex: S-UP
+ #+findex: org-table-move-cell-up
+ Move cell up by swapping with adjacent cell.
- {{{kbd(S-DOWN)}}} (~org-table-move-cell-down~) ::
- #+kindex: S-DOWN
- #+findex: org-table-move-cell-down
- Move cell down by swapping with adjacent cell.
+ #+kindex: S-DOWN
+ #+findex: org-table-move-cell-down
+ Move cell down by swapping with adjacent cell.
- {{{kbd(S-LEFT)}}} (~org-table-move-cell-left~) ::
- #+kindex: S-LEFT
- #+findex: org-table-move-cell-left
- Move cell left by swapping with adjacent cell.
+ #+kindex: S-LEFT
+ #+findex: org-table-move-cell-left
+ Move cell left by swapping with adjacent cell.
- {{{kbd(S-RIGHT)}}} (~org-table-move-cell-right~) ::
- #+kindex: S-RIGHT
- #+findex: org-table-move-cell-right
- Move cell right by swapping with adjacent cell.
+ #+kindex: S-RIGHT
+ #+findex: org-table-move-cell-right
+ Move cell right by swapping with adjacent cell.
- {{{kbd(M-S-DOWN)}}} (~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.
+ #+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.
- {{{kbd(C-c -)}}} (~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.
+ #+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.
- {{{kbd(C-c RET)}}} (~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.
+ #+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.
- {{{kbd(C-c ^)}}} (~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.
+ #+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.
*** Regions
:PROPERTIES:
@@ -1624,43 +1614,40 @@ you, configure the option ~org-table-auto-blank-field~.
- {{{kbd(C-c C-x M-w)}}} (~org-table-copy-region~) ::
- #+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.
+ #+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.
- {{{kbd(C-c C-x C-w)}}} (~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.
+ #+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.
- {{{kbd(C-c C-x C-y)}}} (~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.
+ #+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.
- {{{kbd(M-RET)}}} (~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.
+ #+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.
*** Calculations
:PROPERTIES:
@@ -1672,25 +1659,25 @@ you, configure the option ~org-table-auto-blank-field~.
- {{{kbd(C-c +)}}} (~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)}}}.
+ #+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)}}}.
- {{{kbd(S-RET)}}} (~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
- ~org-table-copy-increment~, integer field values can be
- incremented during copy. Integers that are too large are not
- incremented, however. Also, a ~0~ prefix argument temporarily
- disables the increment. This key is also used by shift-selection
- and related modes (see [[*Packages that conflict with Org mode]]).
+ #+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
+ ~org-table-copy-increment~, integer field values can be incremented
+ during copy. Integers that are too large are not incremented,
+ however. Also, a ~0~ prefix argument temporarily disables the
+ increment. This key is also used by shift-selection and related
+ modes (see [[*Packages that conflict with Org mode]]).
*** Miscellaneous
:PROPERTIES:
@@ -1699,51 +1686,49 @@ you, configure the option ~org-table-auto-blank-field~.
- {{{kbd(C-c `)}}} (~org-table-edit-field~) ::
- #+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 [[*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 `)}}}.
+ #+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 [[*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 `)}}}.
- {{{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.
+ #+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.
- {{{kbd(C-c |)}}} (~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 [[*Creation and
- conversion]]).
+ #+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 [[*Creation and conversion]]).
- {{{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 ~org-table-export-default-format~. You may also
- use properties =TABLE_EXPORT_FILE= and =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 [[*Translator functions]], for a detailed
- description.
+ #+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
+ ~org-table-export-default-format~. You may also use properties
+ =TABLE_EXPORT_FILE= and =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 [[*Translator
+ functions]], for a detailed description.
** Column Width and Alignment
:PROPERTIES:
@@ -1765,9 +1750,9 @@ case, you can always align manually a table:
- {{{kbd(C-c C-c)}}} (~org-table-align~) ::
- #+kindex: C-c C-c
- #+findex: org-table-align
- Align the current table.
+ #+kindex: C-c C-c
+ #+findex: org-table-align
+ Align the current table.
#+vindex: org-startup-align-all-tables
Setting the option ~org-startup-align-all-tables~ re-aligns all tables
@@ -1800,28 +1785,28 @@ with the following tools:
- {{{kbd(C-c TAB)}}} (~org-table-toggle-column-width~) ::
- #+kindex: C-c TAB
- #+findex: org-table-toggle-column-width
- Shrink or expand current column.
+ #+kindex: C-c TAB
+ #+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.
- {{{kbd(C-u C-c TAB)}}} (~org-table-shrink~) ::
- #+kindex: C-u C-c TAB
- #+findex: org-table-shrink
- Shrink all columns with a column width. Expand the others.
+ #+kindex: C-u C-c TAB
+ #+findex: org-table-shrink
+ Shrink all columns with a column width. Expand the others.
- {{{kbd(C-u C-u C-c TAB)}}} (~org-table-expand~) ::
- #+kindex: C-u C-u C-c TAB
- #+findex: org-table-expand
- Expand all columns.
+ #+kindex: C-u C-u C-c TAB
+ #+findex: org-table-expand
+ Expand all columns.
To see the full text of a shrunk field, hold the mouse over it:
a tool-tip window then shows the full contents of the field.
@@ -2039,18 +2024,17 @@ and ~org-table-current-column~. Examples:
- =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.
- =$2 = '(identity remote(FOO, @@#$1))= ::
- Copy text or values of each row of column 1 of the table named
- {{{var(FOO)}}} into column 2 of the current table.
+ Copy text or values of each row of column 1 of the table named
+ {{{var(FOO)}}} into column 2 of the current table.
- =@3 = 2 * remote(FOO, @@1$$#)= ::
- Insert the doubled value of each column of row 1 of the table
- named {{{var(FOO)}}} into row 3 of the current table.
+ Insert the doubled value of each column of row 1 of the table
+ named {{{var(FOO)}}} into row 3 of the current table.
#+texinfo: @noindent
For the second and third examples, table {{{var(FOO)}}} must have at
@@ -2150,49 +2134,47 @@ variable ~org-calc-default-modes~.
- =p20= ::
- Set the internal Calc calculation precision to 20 digits.
+ Set the internal Calc calculation precision to 20 digits.
- =n3=, =s3=, =e2=, =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.
+ 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.
- =D=, =R= ::
- Degree and radian angle modes of Calc.
+ Degree and radian angle modes of Calc.
- =F=, =S= ::
- Fraction and symbolic modes of Calc.
+ Fraction and symbolic modes of Calc.
- =T=, =t=, =U= ::
- Duration computations in Calc or Lisp, [[*Durations and time
- values]].
+ Duration computations in Calc or Lisp, [[*Durations and time values]].
- =E= ::
- If and how to consider empty fields. Without =E= empty fields in
- range references are suppressed so that the Calc vector or Lisp
- list contains only the non-empty fields. With =E= the empty
- fields are kept. For empty fields in ranges or empty field
- references the value =nan= (not a number) is used in Calc
- formulas and the empty string is used for Lisp formulas. Add =N=
- to use 0 instead for both formula types. For the value of
- a field the mode =N= has higher precedence than =E=.
+ If and how to consider empty fields. Without =E= empty fields in
+ range references are suppressed so that the Calc vector or Lisp list
+ contains only the non-empty fields. With =E= the empty fields are
+ kept. For empty fields in ranges or empty field references the
+ value =nan= (not a number) is used in Calc formulas and the empty
+ string is used for Lisp formulas. Add =N= to use 0 instead for both
+ formula types. For the value of a field the mode =N= has higher
+ precedence than =E=.
- =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 =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 =N=.
- =L= ::
- Literal, for Lisp formulas only. See the next section.
+ Literal, for Lisp formulas only. See the next section.
Unless you use large integer numbers or high-precision calculation and
display for floating point numbers you may alternatively provide
@@ -2217,39 +2199,37 @@ Operations]]). For example
- =if($1 < 20, teen, string(""))= ::
- ="teen"= if age =$1= is less than 20, else the Org table result
- field is set to empty with the empty string.
+ ="teen"= if age =$1= is less than 20, else the Org table result
+ field is set to empty with the empty string.
- =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. =E=
- is required to not convert empty fields to 0. =f-1= is an
- optional Calc format string similar to =%.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. =E= is
+ required to not convert empty fields to 0. =f-1= is an optional
+ Calc format string similar to =%.1f= but leaves empty results empty.
- =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 =nan= which lets
- =vmean= result in =nan=. Then =typeof == 12= detects the =nan=
- from ~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 =nan= which lets =vmean=
+ result in =nan=. Then =typeof == 12= detects the =nan= from ~vmean~
+ and the Org table result field is set to empty. Use this when the
+ sample set is expected to never have missing values.
- =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.
- =vmean($1..$7); EN= ::
- To complete the example before: Mean value of a range with empty
- fields counting as samples with value 0. Use this only when
- incomplete sample sets should be padded with 0 to the full size.
+ To complete the example before: Mean value of a range with empty
+ fields counting as samples with value 0. Use this only when
+ incomplete sample sets should be padded with 0 to the full size.
You can add your own Calc functions defined in Emacs Lisp with
~defmath~ and use them in formula syntax for Calc.
@@ -2288,15 +2268,15 @@ computations in Lisp:
- ='(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))= ::
- Swap the first two characters of the content of column 1.
+ Swap the first two characters of the content of column 1.
- ='(+ $1 $2);N= ::
- Add columns 1 and 2, equivalent to Calc's =$1+$2=.
+ Add columns 1 and 2, equivalent to Calc's =$1+$2=.
- ='(apply '+ '($1..$4));N= ::
- Compute the sum of columns 1 to 4, like Calc's =vsum($1..$4)=.
+ Compute the sum of columns 1 to 4, like Calc's =vsum($1..$4)=.
*** Durations and time values
:PROPERTIES:
@@ -2366,38 +2346,37 @@ following command
- {{{kbd(C-u C-c =)}}} (~org-table-eval-formula~) ::
- #+kindex: C-u C-c =
- #+findex: org-table-eval-formula
- Install a new formula for the current field. The command prompts
- for a formula with default taken from the =TBLFM= keyword,
- applies it to the current field, and stores it.
+ #+kindex: C-u C-c =
+ #+findex: org-table-eval-formula
+ Install a new formula for the current field. The command prompts
+ for a formula with default taken from the =TBLFM= keyword,
+ 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 [[*Editing and debugging formulas]]) or edit the
-=TBLFM= keyword directly.
+the formula editor (see [[*Editing and debugging formulas]]) or edit
+the =TBLFM= keyword directly.
- =$2== ::
- Column formula, valid for the entire column. This is so common
- that Org treats these formulas in a special way, see [[*Column
- formulas]].
+ Column formula, valid for the entire column. This is so common that
+ Org treats these formulas in a special way, see [[*Column formulas]].
- =@3== ::
- Row formula, applies to all fields in the specified row. =@>==
- means the last row.
+ Row formula, applies to all fields in the specified row. =@>==
+ means the last row.
- =@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.
- =$NAME== ::
- Named field, see [[*Advanced features]].
+ Named field, see [[*Advanced features]].
*** Column formulas
:PROPERTIES:
@@ -2434,14 +2413,14 @@ following command:
- {{{kbd(C-c =)}}} (~org-table-eval-formula~) ::
- #+kindex: C-c =
- #+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 =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.
+ #+kindex: C-c =
+ #+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 =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.
*** Lookup functions
:PROPERTIES:
@@ -2454,36 +2433,36 @@ Org has three predefined Emacs Lisp functions for lookups in tables.
- =(org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)= ::
- #+findex: org-lookup-first
- Searches for the first element {{{var(S)}}} in list
- {{{var(S-LIST)}}} for which
- #+begin_src emacs-lisp
- (PREDICATE VAL S)
- #+end_src
- is non-~nil~; returns the value from the corresponding position
- in list {{{var(R-LIST)}}}. The default {{{var(PREDICATE)}}} is
- ~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
- ~org-lookup-first~, where {{{var(VAL)}}} precedes
- {{{var(S-LIST)}}}. If {{{var(R-LIST)}}} is ~nil~, the matching
- element {{{var(S)}}} of {{{var(S-LIST)}}} is returned.
+ #+findex: org-lookup-first
+ Searches for the first element {{{var(S)}}} in list
+ {{{var(S-LIST)}}} for which
+ #+begin_src emacs-lisp
+ (PREDICATE VAL S)
+ #+end_src
+ is non-~nil~; returns the value from the corresponding position in
+ list {{{var(R-LIST)}}}. The default {{{var(PREDICATE)}}} is
+ ~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 ~org-lookup-first~,
+ where {{{var(VAL)}}} precedes {{{var(S-LIST)}}}. If
+ {{{var(R-LIST)}}} is ~nil~, the matching element {{{var(S)}}} of
+ {{{var(S-LIST)}}} is returned.
- =(org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)= ::
- #+findex: org-lookup-last
- Similar to ~org-lookup-first~ above, but searches for the /last/
- element for which {{{var(PREDICATE)}}} is non-~nil~.
+ #+findex: org-lookup-last
+ Similar to ~org-lookup-first~ above, but searches for the /last/
+ element for which {{{var(PREDICATE)}}} is non-~nil~.
- =(org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)= ::
- #+findex: org-lookup-all
- Similar to ~org-lookup-first~, but searches for /all/ elements
- for which {{{var(PREDICATE)}}} is non-~nil~, and returns /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.
+ #+findex: org-lookup-all
+ Similar to ~org-lookup-first~, but searches for /all/ elements for
+ which {{{var(PREDICATE)}}} is non-~nil~, and returns /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.
If the ranges used in these functions contain empty fields, the =E=
mode for the formula should usually be specified: otherwise empty
@@ -2513,136 +2492,134 @@ you prefer to only work with the internal format (like =@3$2= or
- {{{kbd(C-c =)}}} or {{{kbd(C-u C-c =)}}} (~org-table-eval-formula~) ::
- #+kindex: C-c =
- #+kindex: C-u C-c =
- #+findex: org-table-eval-formula
- Edit the formula associated with the current column/field in the
- minibuffer. See [[*Column formulas]], and [[*Field and range formulas]].
+ #+kindex: C-c =
+ #+kindex: C-u C-c =
+ #+findex: org-table-eval-formula
+ Edit the formula associated with the current column/field in the
+ minibuffer. See [[*Column formulas]], and [[*Field and range formulas]].
- {{{kbd(C-u C-u C-c =)}}} (~org-table-eval-formula~) ::
- #+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 ?)}}}.
+ #+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 ?)}}}.
- {{{kbd(C-c ?)}}} (~org-table-field-info~) ::
- #+kindex: C-c ?
- #+findex: org-table-field-info
- While editing a formula in a table field, highlight the field(s)
- referenced by the reference at point position in the formula.
+ #+kindex: C-c ?
+ #+findex: org-table-field-info
+ While editing a formula in a table field, highlight the field(s)
+ referenced by the reference at point position in the formula.
- {{{kbd(C-c })}}} (~org-table-toggle-coordinate-overlays~) ::
- #+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)}}}.
+ #+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)}}}.
- {{{kbd(C-c {)}}} (~org-table-toggle-formula-debugger~) ::
- #+kindex: C-c @{
- #+findex: org-table-toggle-formula-debugger
- Toggle the formula debugger on and off. See below.
+ #+kindex: C-c @{
+ #+findex: org-table-toggle-formula-debugger
+ Toggle the formula debugger on and off. See below.
- {{{kbd(C-c ')}}} (~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:
+ #+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:
- - {{{kbd(C-c C-c)}}} or {{{kbd(C-x C-s)}}} (~org-table-fedit-finish~) ::
+ - {{{kbd(C-c C-c)}}} or {{{kbd(C-x C-s)}}} (~org-table-fedit-finish~) ::
- #+kindex: C-x C-s
- #+kindex: C-c C-c
- #+findex: org-table-fedit-finish
- Exit the formula editor and store the modified formulas. With
- {{{kbd(C-u)}}} prefix, also apply the new formulas to the
- entire table.
+ #+kindex: C-x C-s
+ #+kindex: C-c C-c
+ #+findex: org-table-fedit-finish
+ Exit the formula editor and store the modified formulas. With
+ {{{kbd(C-u)}}} prefix, also apply the new formulas to the
+ entire table.
- - {{{kbd(C-c C-q)}}} (~org-table-fedit-abort~) ::
+ - {{{kbd(C-c C-q)}}} (~org-table-fedit-abort~) ::
- #+kindex: C-c C-q
- #+findex: org-table-fedit-abort
- Exit the formula editor without installing changes.
+ #+kindex: C-c C-q
+ #+findex: org-table-fedit-abort
+ Exit the formula editor without installing changes.
- - {{{kbd(C-c C-r)}}} (~org-table-fedit-toggle-ref-type~) ::
+ - {{{kbd(C-c C-r)}}} (~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 =B3=) and internal (like =@3$2=).
+ #+kindex: C-c C-r
+ #+findex: org-table-fedit-toggle-ref-type
+ Toggle all references in the formula editor between standard (like
+ =B3=) and internal (like =@3$2=).
- - {{{kbd(TAB)}}} (~org-table-fedit-lisp-indent~) ::
+ - {{{kbd(TAB)}}} (~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(TAB)}}} collapses the formula
- back again. In the open formula, {{{kbd(TAB)}}} re-indents
- just like in Emacs Lisp mode.
+ #+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(TAB)}}} collapses the formula back
+ again. In the open formula, {{{kbd(TAB)}}} re-indents just like
+ in Emacs Lisp mode.
- - {{{kbd(M-TAB)}}} (~lisp-complete-symbol~) ::
+ - {{{kbd(M-TAB)}}} (~lisp-complete-symbol~) ::
- #+kindex: M-TAB
- #+findex: lisp-complete-symbol
- Complete Lisp symbols, just like in Emacs Lisp mode.
+ #+kindex: M-TAB
+ #+findex: lisp-complete-symbol
+ Complete Lisp symbols, just like in Emacs Lisp mode.
- - {{{kbd(S-UP)}}}, {{{kbd(S-DOWN)}}}, {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} ::
+ - {{{kbd(S-UP)}}}, {{{kbd(S-DOWN)}}}, {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} ::
- #+kindex: S-UP
- #+kindex: S-DOWN
- #+kindex: S-LEFT
- #+kindex: S-RIGHT
- #+findex: org-table-fedit-ref-up
- #+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 =B3= and you press {{{kbd(S-RIGHT)}}}, it becomes =C3=.
- This also works for relative references and for hline
- references.
+ #+kindex: S-UP
+ #+kindex: S-DOWN
+ #+kindex: S-LEFT
+ #+kindex: S-RIGHT
+ #+findex: org-table-fedit-ref-up
+ #+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
+ =B3= and you press {{{kbd(S-RIGHT)}}}, it becomes =C3=. This also
+ works for relative references and for hline references.
- - {{{kbd(M-S-UP)}}} (~org-table-fedit-line-up~) ::
+ - {{{kbd(M-S-UP)}}} (~org-table-fedit-line-up~) ::
- #+kindex: M-S-UP
- #+findex: org-table-fedit-line-up
- Move the test line for column formulas up in the Org buffer.
+ #+kindex: M-S-UP
+ #+findex: org-table-fedit-line-up
+ Move the test line for column formulas up in the Org buffer.
- - {{{kbd(M-S-DOWN)}}} (~org-table-fedit-line-down~) ::
+ - {{{kbd(M-S-DOWN)}}} (~org-table-fedit-line-down~) ::
- #+kindex: M-S-DOWN
- #+findex: org-table-fedit-line-down
- Move the test line for column formulas down in the Org buffer.
+ #+kindex: M-S-DOWN
+ #+findex: org-table-fedit-line-down
+ Move the test line for column formulas down in the Org buffer.
- - {{{kbd(M-UP)}}} (~org-table-fedit-scroll-up~) ::
+ - {{{kbd(M-UP)}}} (~org-table-fedit-scroll-up~) ::
- #+kindex: M-UP
- #+findex: org-table-fedit-scroll-up
- Scroll up the window displaying the table.
+ #+kindex: M-UP
+ #+findex: org-table-fedit-scroll-up
+ Scroll up the window displaying the table.
- - {{{kbd(M-DOWN)}}} (~org-table-fedit-scroll-down~) ::
+ - {{{kbd(M-DOWN)}}} (~org-table-fedit-scroll-down~) ::
- #+kindex: M-DOWN
- #+findex: org-table-fedit-scroll-down
- Scroll down the window displaying the table.
+ #+kindex: M-DOWN
+ #+findex: org-table-fedit-scroll-down
+ Scroll down the window displaying the table.
- - {{{kbd(C-c })}}} ::
+ - {{{kbd(C-c })}}} ::
- #+kindex: C-c @}
- #+findex: org-table-toggle-coordinate-overlays
- Turn the coordinate grid in the table on and off.
+ #+kindex: C-c @}
+ #+findex: org-table-toggle-coordinate-overlays
+ Turn the coordinate grid in the table on and off.
Making a table field blank does not remove the formula associated with
the field, because that is stored in a different line---the =TBLFM=
@@ -2734,40 +2711,39 @@ following commands:
- {{{kbd(C-c *)}}} (~org-table-recalculate~) ::
- #+kindex: C-c *
- #+findex: org-table-recalculate
- Recalculate the current row by first applying the stored column
- formulas from left to right, and all field/range formulas in the
- current row.
+ #+kindex: C-c *
+ #+findex: org-table-recalculate
+ Recalculate the current row by first applying the stored column
+ formulas from left to right, and all field/range formulas in the
+ current row.
- {{{kbd(C-u C-c *)}}} or {{{kbd(C-u C-c C-c)}}} ::
- #+kindex: C-u C-c *
- #+kindex: C-u C-c C-c
- Recompute the entire table, line by line. Any lines before the
- first hline are left alone, assuming that these are part of the
- table header.
+ #+kindex: C-u C-c *
+ #+kindex: C-u C-c C-c
+ Recompute the entire table, line by line. Any lines before the
+ first hline are left alone, assuming that these are part of the
+ table header.
- {{{kbd(C-u C-u C-c *)}}} or {{{kbd(C-u C-u C-c C-c)}}} (~org-table-iterate~) ::
- #+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 /later/ in the
- calculation sequence.
+ #+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 /later/ in the calculation sequence.
- {{{kbd(M-x org-table-recalculate-buffer-tables)}}} ::
- #+findex: org-table-recalculate-buffer-tables
- Recompute all tables in the current buffer.
+ #+findex: org-table-recalculate-buffer-tables
+ Recompute all tables in the current buffer.
- {{{kbd(M-x org-table-iterate-buffer-tables)}}} ::
- #+findex: org-table-iterate-buffer-tables
- Iterate all tables in the current buffer, in order to converge
- table-to-table dependencies.
+ #+findex: org-table-iterate-buffer-tables
+ Iterate all tables in the current buffer, in order to converge
+ table-to-table dependencies.
*** Advanced features
:PROPERTIES:
@@ -2781,11 +2757,11 @@ characters.
- {{{kbd(C-#)}}} (~org-table-rotate-recalc-marks~) ::
- #+kindex: C-#
- #+findex: org-table-rotate-recalc-marks
- Rotate the calculation mark in first column through the states
- =#=, =*=, =!=, =$=. When there is an active region, change all
- marks in the region.
+ #+kindex: C-#
+ #+findex: org-table-rotate-recalc-marks
+ Rotate the calculation mark in first column through the states =#=,
+ =*=, =!=, =$=. When there is an active region, change all marks in
+ the region.
Here is an example of a table that collects exam results of students
and makes use of these features:
@@ -2821,47 +2797,46 @@ The marking characters have the following meaning:
- =!= ::
- The fields in this line define names for the columns, so that you
- may refer to a column as =$Tot= instead of =$6=.
+ The fields in this line define names for the columns, so that you
+ may refer to a column as =$Tot= instead of =$6=.
- =^= ::
- This row defines names for the fields /above/ the row. With such
- a definition, any formula in the table may use =$m1= to refer to
- the value =10=. Also, if you assign a formula to a names field,
- it is stored as =$name = ...=.
+ This row defines names for the fields /above/ the row. With such
+ a definition, any formula in the table may use =$m1= to refer to the
+ value =10=. Also, if you assign a formula to a names field, it is
+ stored as =$name = ...=.
- =_= ::
- Similar to =^=, but defines names for the fields in the row
- /below/.
+ Similar to =^=, but defines names for the fields in the row /below/.
- =$= ::
- Fields in this row can define /parameters/ for formulas. For
- example, if a field in a =$= row contains =max=50=, then formulas
- in this table can refer to the value 50 using =$max=. Parameters
- work exactly like constants, only that they can be defined on
- a per-table basis.
+ Fields in this row can define /parameters/ for formulas. For
+ example, if a field in a =$= row contains =max=50=, then formulas in
+ this table can refer to the value 50 using =$max=. Parameters work
+ exactly like constants, only that they can be defined on a per-table
+ basis.
- =#= ::
- Fields in this row are automatically recalculated when pressing
- {{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(S-TAB)}}} in this row.
- Also, this row is selected for a global recalculation with
- {{{kbd(C-u C-c *)}}}. Unmarked lines are left alone by this
- command.
+ Fields in this row are automatically recalculated when pressing
+ {{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(S-TAB)}}} in this row.
+ Also, this row is selected for a global recalculation with
+ {{{kbd(C-u C-c *)}}}. Unmarked lines are left alone by this
+ command.
- =*= ::
- 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.
- =/= ::
- Do not export this line. Useful for lines that contain the
- narrowing =<N>= markers or column group markers.
+ Do not export this line. Useful for lines that contain the
+ narrowing =<N>= markers or column group markers.
Finally, just to whet your appetite for what can be done with the
fantastic Calc package, here is a table that computes the Taylor
@@ -2927,65 +2902,65 @@ For more information and examples see the [[https://orgmode.org/worg/org-tutoria
- =set= ::
- Specify any Gnuplot option to be set when graphing.
+ Specify any Gnuplot option to be set when graphing.
- =title= ::
- Specify the title of the plot.
+ Specify the title of the plot.
- =ind= ::
- Specify which column of the table to use as the =x= axis.
+ Specify which column of the table to use as the =x= axis.
- =deps= ::
- Specify the columns to graph as a Lisp style list, surrounded by
- parentheses and separated by spaces for example =dep:(3 4)= to
- graph the third and fourth columns. Defaults to graphing all
- other columns aside from the =ind= column.
+ Specify the columns to graph as a Lisp style list, surrounded by
+ parentheses and separated by spaces for example =dep:(3 4)= to graph
+ the third and fourth columns. Defaults to graphing all other
+ columns aside from the =ind= column.
- =type= ::
- Specify whether the plot is =2d=, =3d=, or =grid=.
+ Specify whether the plot is =2d=, =3d=, or =grid=.
- =with= ::
- Specify a =with= option to be inserted for every column being
- plotted, e.g., =lines=, =points=, =boxes=, =impulses=. Defaults
- to =lines=.
+ Specify a =with= option to be inserted for every column being
+ plotted, e.g., =lines=, =points=, =boxes=, =impulses=. Defaults to
+ =lines=.
- =file= ::
- If you want to plot to a file, specify
- ="path/to/desired/output-file"=.
+ If you want to plot to a file, specify
+ ="path/to/desired/output-file"=.
- =labels= ::
- List of labels to be used for the =deps=. Defaults to the column
- headers if they exist.
+ List of labels to be used for the =deps=. Defaults to the column
+ headers if they exist.
- =line= ::
- Specify an entire line to be inserted in the Gnuplot script.
+ Specify an entire line to be inserted in the Gnuplot script.
- =map= ::
- When plotting =3d= or =grid= types, set this to =t= to graph
- a flat mapping rather than a =3d= slope.
+ When plotting =3d= or =grid= types, set this to =t= to graph a flat
+ mapping rather than a =3d= slope.
- =timefmt= ::
- Specify format of Org mode timestamps as they will be parsed by
- Gnuplot. Defaults to =%Y-%m-%d-%H:%M:%S=.
+ Specify format of Org mode timestamps as they will be parsed by
+ Gnuplot. Defaults to =%Y-%m-%d-%H:%M:%S=.
- =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.
- Before plotting, every instance of =$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.
+ 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 =$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.
*** ASCII bar plots
:PROPERTIES:
@@ -3267,64 +3242,64 @@ current buffer:
- /Org mode buffers/ ::
- For Org files, if there is a =<<target>>= at point, the link
- points to the target. Otherwise it points to the current
- headline, which is also the description[fn:29].
-
- #+vindex: org-link-to-org-use-id
- #+cindex: @samp{CUSTOM_ID}, property
- #+cindex: @samp{ID}, property
- If the headline has a =CUSTOM_ID= property, store a link to this
- custom ID. In addition or alternatively, depending on the value
- of ~org-link-to-org-use-id~, create and/or use a globally unique
- =ID= property for the link[fn:30]. 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.
+ For Org files, if there is a =<<target>>= at point, the link points
+ to the target. Otherwise it points to the current headline, which
+ is also the description[fn:29].
+
+ #+vindex: org-link-to-org-use-id
+ #+cindex: @samp{CUSTOM_ID}, property
+ #+cindex: @samp{ID}, property
+ If the headline has a =CUSTOM_ID= property, store a link to this
+ custom ID. In addition or alternatively, depending on the value of
+ ~org-link-to-org-use-id~, create and/or use a globally unique =ID=
+ property for the link[fn:30]. 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.
- /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
- ~org-email-link-description-format~. By default, it refers to
- the addressee and the subject.
+ #+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
+ ~org-email-link-description-format~. By default, it refers to the
+ addressee and the subject.
- /Web browsers: W3, W3M and EWW/ ::
- Here the link is the current URL, with the page title as the
- description.
+ Here the link is the current URL, with the page title as the
+ description.
- /Contacts: BBDB/ ::
- Links created in a BBDB buffer point to the current entry.
+ Links created in a BBDB buffer point to the current entry.
- /Chat: IRC/ ::
- #+vindex: org-irc-links-to-logs
- For IRC links, if the variable ~org-irc-link-to-logs~ is
- non-~nil~, create a =file= style link to the relevant point in
- the logs for the current conversation. Otherwise store an =irc=
- style link to the user/channel/server under the point.
+ #+vindex: org-irc-links-to-logs
+ For IRC links, if the variable ~org-irc-link-to-logs~ is non-~nil~,
+ create a =file= style link to the relevant point in the logs for the
+ current conversation. Otherwise store an =irc= style link to the
+ user/channel/server under the point.
- /Other files/ ::
- For any other file, the link points to the file, with a search
- string (see [[*Search Options in File Links]]) 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 [[*Custom Searches]]).
+ For any other file, the link points to the file, with a search
+ string (see [[*Search Options in File Links]]) 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 [[*Custom Searches]]).
- You can also define dedicated links to other files. See [[*Adding
- Hyperlink Types]].
+ You can also define dedicated links to other files. See [[*Adding
+ Hyperlink Types]].
- /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.
From an Org buffer, the following commands create, navigate or, more
generally, act on links.
@@ -3332,144 +3307,141 @@ generally, act on links.
#+attr_texinfo: :sep ,
- {{{kbd(C-c C-l)}}} (~org-insert-link~) ::
- #+kindex: C-c C-l
- #+findex: org-insert-link
- #+cindex: link completion
- #+cindex: completion, of links
- #+cindex: inserting links
- #+vindex: org-keep-stored-link-after-insertion
- Insert a link[fn:31]. 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[fn:32]. If some text was selected at this
- time, it becomes the default description.
+ #+kindex: C-c C-l
+ #+findex: org-insert-link
+ #+cindex: link completion
+ #+cindex: completion, of links
+ #+cindex: inserting links
+ #+vindex: org-keep-stored-link-after-insertion
+ Insert a link[fn:31]. 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[fn:32]. If some text was selected at this time,
+ it becomes the default description.
- /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(UP)}}} and {{{kbd(DOWN)}}} (or {{{kbd(M-p)}}},
- {{{kbd(M-n)}}}).
+ All links stored during the current session are part of the
+ history for this prompt, so you can access them with {{{kbd(UP)}}}
+ and {{{kbd(DOWN)}}} (or {{{kbd(M-p)}}}, {{{kbd(M-n)}}}).
- /Completion support/ ::
- Completion with {{{kbd(TAB)}}} helps you to insert valid link
- prefixes like =http= or =ftp=, including the prefixes defined
- through link abbreviations (see [[*Link Abbreviations]]). If you
- press {{{kbd(RET)}}} after inserting only the prefix, Org
- offers specific completion support for some link types[fn:33].
- For example, if you type {{{kbd(f i l e RET)}}}---alternative
- access: {{{kbd(C-u C-c C-l)}}}, see below---Org offers file
- name completion, and after {{{kbd(b b d b RET)}}} you can
- complete contact names.
+ Completion with {{{kbd(TAB)}}} helps you to insert valid link
+ prefixes like =http= or =ftp=, including the prefixes defined
+ through link abbreviations (see [[*Link Abbreviations]]). If you
+ press {{{kbd(RET)}}} after inserting only the prefix, Org offers
+ specific completion support for some link types[fn:33]. For
+ example, if you type {{{kbd(f i l e RET)}}}---alternative access:
+ {{{kbd(C-u C-c C-l)}}}, see below---Org offers file name
+ completion, and after {{{kbd(b b d b RET)}}} you can complete
+ contact names.
- {{{kbd(C-u C-c C-l)}}} ::
- #+cindex: file name completion
- #+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 =../=. Otherwise an absolute path is used, if
- possible with =~/= for your home directory. You can force an
- absolute path with two {{{kbd(C-u)}}} prefixes.
+ #+cindex: file name completion
+ #+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 =../=.
+ Otherwise an absolute path is used, if possible with =~/= for your
+ home directory. You can force an absolute path with two
+ {{{kbd(C-u)}}} prefixes.
- {{{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.
+ #+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.
- {{{kbd(C-c C-o)}}} (~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
- ~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 [[*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 =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 ~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
- ~org-link-frame-setup~.
+ #+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
+ ~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 [[*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 =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 ~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 ~org-link-frame-setup~.
- {{{kbd(RET)}}} ::
- #+vindex: org-return-follows-link
- #+kindex: RET
- When ~org-return-follows-link~ is set, {{{kbd(RET)}}} also
- follows the link at point.
+ #+vindex: org-return-follows-link
+ #+kindex: RET
+ When ~org-return-follows-link~ is set, {{{kbd(RET)}}} also follows
+ the link at point.
- {{{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.
+ #+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.
- {{{kbd(mouse-3)}}} ::
- #+vindex: org-display-internal-link-with-indirect-buffer
- #+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[fn:34].
+ #+vindex: org-display-internal-link-with-indirect-buffer
+ #+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[fn:34].
- {{{kbd(C-c %)}}} (~org-mark-ring-push~) ::
- #+kindex: C-c %
- #+findex: org-mark-ring-push
- #+cindex: mark ring
- Push the current position onto the Org mark ring, to be able to
- return easily. Commands following an internal link do this
- automatically.
+ #+kindex: C-c %
+ #+findex: org-mark-ring-push
+ #+cindex: mark ring
+ Push the current position onto the Org mark ring, to be able to
+ return easily. Commands following an internal link do this
+ automatically.
- {{{kbd(C-c &)}}} (~org-mark-ring-goto~) ::
- #+kindex: C-c &
- #+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.
+ #+kindex: C-c &
+ #+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.
- {{{kbd(C-c C-x C-n)}}} (~org-next-link~), {{{kbd(C-c C-x C-p)}}} (~org-previous-link~) ::
- #+kindex: C-c C-x C-p
- #+findex: org-previous-link
- #+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)}}}.
-
- #+begin_src emacs-lisp
- (add-hook 'org-load-hook
- (lambda ()
- (define-key org-mode-map "\M-n" 'org-next-link)
- (define-key org-mode-map "\M-p" 'org-previous-link)))
- #+end_src
+ #+kindex: C-c C-x C-p
+ #+findex: org-previous-link
+ #+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)}}}.
+
+ #+begin_src emacs-lisp
+ (add-hook 'org-load-hook
+ (lambda ()
+ (define-key org-mode-map "\M-n" 'org-next-link)
+ (define-key org-mode-map "\M-p" 'org-previous-link)))
+ #+end_src
** Using Links Outside Org
:PROPERTIES:
@@ -3585,34 +3557,35 @@ link, together with explanations for each:
- =255= ::
- Jump to line 255.
+ Jump to line 255.
- =My Target= ::
- Search for a link target =<<My Target>>=, or do a text search for
- =my target=, similar to the search in internal links, see
- [[*Internal Links]]. In HTML export (see [[*HTML Export]]), such a file
- link becomes a HTML reference to the corresponding named anchor
- in the linked file.
+ Search for a link target =<<My Target>>=, or do a text search for
+ =my target=, similar to the search in internal links, see [[*Internal
+ Links]]. In HTML export (see [[*HTML Export]]), such a file link becomes
+ a HTML reference to the corresponding named anchor in the linked
+ file.
- =*My Target= ::
- In an Org file, restrict search to headlines.
+ In an Org file, restrict search to headlines.
- =#my-custom-id= ::
- Link to a heading with a =CUSTOM_ID= property
+ Link to a heading with a =CUSTOM_ID= property
- =/REGEXP/= ::
- Do a regular expression search for {{{var(REGEXP)}}}. This uses
- the Emacs command ~occur~ to list all matches in a separate
- window. If the target file is in Org mode, ~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 ~occur~ to list all matches in a separate window. If
+ the target file is in Org mode, ~org-occur~ is used to create
+ a sparse tree with the matches.
As a degenerate case, a file link with an empty file name can be used
to search the current file. For example, =[[file:::find me]]= does
-a search for =find me= in the current file, just as =[[find me]]= would.
+a search for =find me= in the current file, just as =[[find me]]=
+would.
** Custom Searches
:PROPERTIES:
@@ -3672,76 +3645,75 @@ The most important commands to work with TODO entries are:
- {{{kbd(C-c C-t)}}} (~org-todo~) ::
- #+kindex: C-c C-t
- #+cindex: cycling, of TODO states
- Rotate the TODO state of the current item among
+ #+kindex: C-c C-t
+ #+cindex: cycling, of TODO states
+ Rotate the TODO state of the current item among
- #+begin_example
- ,-> (unmarked) -> TODO -> DONE --.
- '--------------------------------'
- #+end_example
+ #+begin_example
+ ,-> (unmarked) -> TODO -> DONE --.
+ '--------------------------------'
+ #+end_example
- If TODO keywords have fast access keys (see [[*Fast access to
- TODO states]]), prompt for a TODO keyword through the fast
- selection interface; this is the default behavior when
- ~org-use-fast-todo-selection~ is non-~nil~.
+ If TODO keywords have fast access keys (see [[*Fast access to TODO
+ states]]), prompt for a TODO keyword through the fast selection
+ interface; this is the default behavior when
+ ~org-use-fast-todo-selection~ is non-~nil~.
- The same rotation can also be done "remotely" from the agenda
- buffer with the {{{kbd(t)}}} command key (see [[*Commands in the
- Agenda Buffer]]).
+ The same rotation can also be done "remotely" from the agenda buffer
+ with the {{{kbd(t)}}} command key (see [[*Commands in the Agenda
+ Buffer]]).
- {{{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 ~org-use-fast-todo-selection~ is set
- to ~prefix~, use the fast selection interface.
+ #+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 ~org-use-fast-todo-selection~ is set to ~prefix~,
+ use the fast selection interface.
- {{{kbd(S-RIGHT)}}} {{{kbd(S-LEFT)}}} ::
- #+kindex: S-RIGHT
- #+kindex: S-LEFT
- #+vindex: org-treat-S-cursor-todo-selection-as-state-change
- Select the following/preceding TODO state, similar to cycling.
- Useful mostly if more than two TODO states are possible (see
- [[*Extended Use of TODO Keywords]]). See also [[*Packages that
- conflict with Org mode]], for a discussion of the interaction with
- ~shift-selection-mode~. See also the variable
- ~org-treat-S-cursor-todo-selection-as-state-change~.
+ #+kindex: S-RIGHT
+ #+kindex: S-LEFT
+ #+vindex: org-treat-S-cursor-todo-selection-as-state-change
+ Select the following/preceding TODO state, similar to cycling.
+ Useful mostly if more than two TODO states are possible (see
+ [[*Extended Use of TODO Keywords]]). See also [[*Packages that conflict
+ with Org mode]], for a discussion of the interaction with
+ ~shift-selection-mode~. See also the variable
+ ~org-treat-S-cursor-todo-selection-as-state-change~.
- {{{kbd(C-c / t)}}} (~org-show-todo-tree~) ::
- #+kindex: C-c / t
- #+cindex: sparse tree, for TODO
- #+vindex: org-todo-keywords
- #+findex: org-show-todo-tree
- View TODO items in a /sparse tree/ (see [[*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 =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
- ~org-todo-keywords~. With two prefix arguments, find all TODO
- states, both un-done and done.
+ #+kindex: C-c / t
+ #+cindex: sparse tree, for TODO
+ #+vindex: org-todo-keywords
+ #+findex: org-show-todo-tree
+ View TODO items in a /sparse tree/ (see [[*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 =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 ~org-todo-keywords~. With two prefix
+ arguments, find all TODO states, both un-done and done.
- {{{kbd(M-x org-agenda t)}}} (~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 [[*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 [[*Commands in the Agenda Buffer]]). See [[*The
- global TODO list]], for more information.
+ #+kindex: t @r{(Agenda dispatcher)}
+ Show the global TODO list. Collects the TODO items (with not-DONE
+ states) from all agenda files (see [[*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 [[*Commands in the Agenda Buffer]]). See [[*The global TODO
+ list]], for more information.
- {{{kbd(S-M-RET)}}} (~org-insert-todo-heading~) ::
- #+kindex: S-M-RET
- #+findex: org-insert-todo-heading
- Insert a new TODO entry below the current one.
+ #+kindex: S-M-RET
+ #+findex: org-insert-todo-heading
+ Insert a new TODO entry below the current one.
#+vindex: org-todo-state-tags-triggers
Changing a TODO state can also trigger tag changes. See the docstring
@@ -3865,26 +3837,25 @@ correct sequence. In addition to typing a keyword or using completion
#+attr_texinfo: :sep ,
- {{{kbd(C-u C-u C-c C-t)}}}, {{{kbd(C-S-RIGHT)}}}, {{{kbd(C-S-LEFT)}}} ::
- #+kindex: C-S-RIGHT
- #+kindex: C-S-LEFT
- #+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-RIGHT)}}}
- would jump from =TODO= or =DONE= to =REPORT=, and any of the
- words in the second row to =CANCELED=. Note that the
- {{{kbd(C-S-)}}} key binding conflict with ~shift-selection-mode~
- (see [[*Packages that conflict with Org mode]]).
+ #+kindex: C-S-RIGHT
+ #+kindex: C-S-LEFT
+ #+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-RIGHT)}}}
+ would jump from =TODO= or =DONE= to =REPORT=, and any of the words
+ in the second row to =CANCELED=. Note that the {{{kbd(C-S-)}}} key
+ binding conflict with ~shift-selection-mode~ (see [[*Packages that
+ conflict with Org mode]]).
- {{{kbd(S-RIGHT)}}}, {{{kbd(S-LEFT)}}} ::
- #+kindex: S-RIGHT
- #+kindex: S-LEFT
- {{{kbd(S-LEFT)}}} and {{{kbd(S-RIGHT)}}} walk through /all/
- keywords from all sub-sequences, so for example
- {{{kbd(S-RIGHT)}}} would switch from =DONE= to =REPORT= in the
- example above. For a discussion of the interaction with
- ~shift-selection-mode~, see [[*Packages that conflict with Org
- mode]].
+ #+kindex: S-RIGHT
+ #+kindex: S-LEFT
+ {{{kbd(S-LEFT)}}} and {{{kbd(S-RIGHT)}}} walk through /all/ keywords
+ from all sub-sequences, so for example {{{kbd(S-RIGHT)}}} would
+ switch from =DONE= to =REPORT= in the example above. For
+ a discussion of the interaction with ~shift-selection-mode~, see
+ [[*Packages that conflict with Org mode]].
*** Fast access to TODO states
:PROPERTIES:
@@ -4033,20 +4004,20 @@ property (see [[*Properties and Columns]]):
- {{{kbd(C-c C-x o)}}} (~org-toggle-ordered-property~) ::
- #+kindex: C-c C-x o
- #+findex: org-toggle-ordered-property
- #+vindex: org-track-ordered-property-with-tag
- Toggle the =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
- [[*Tags]]). However, if you would like to /track/ the value of this
- property with a tag for better visibility, customize the variable
- ~org-track-ordered-property-with-tag~.
+ #+kindex: C-c C-x o
+ #+findex: org-toggle-ordered-property
+ #+vindex: org-track-ordered-property-with-tag
+ Toggle the =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 [[*Tags]]).
+ However, if you would like to /track/ the value of this property
+ with a tag for better visibility, customize the variable
+ ~org-track-ordered-property-with-tag~.
- {{{kbd(C-u C-u C-u C-c C-t)}}} ::
- #+kindex: C-u C-u C-u C-c C-t
- Change TODO state, regardless of any state blocking.
+ #+kindex: C-u C-u C-u C-c C-t
+ Change TODO state, regardless of any state blocking.
#+vindex: org-agenda-dim-blocked-tasks
If you set the variable ~org-agenda-dim-blocked-tasks~, TODO entries
@@ -4269,27 +4240,27 @@ the way habits are displayed in the agenda.
- ~org-habit-graph-column~ ::
- #+vindex: org-habit-graph-column
- The buffer column at which the consistency graph should be drawn.
- This overwrites any text in that column, so it is a good idea to
- keep your habits' titles brief and to the point.
+ #+vindex: org-habit-graph-column
+ The buffer column at which the consistency graph should be drawn.
+ This overwrites any text in that column, so it is a good idea to
+ keep your habits' titles brief and to the point.
- ~org-habit-preceding-days~ ::
- #+vindex: org-habit-preceding-days
- The amount of history, in days before today, to appear in
- consistency graphs.
+ #+vindex: org-habit-preceding-days
+ The amount of history, in days before today, to appear in
+ consistency graphs.
- ~org-habit-following-days~ ::
- #+vindex: org-habit-following-days
- The number of days after today that appear in consistency graphs.
+ #+vindex: org-habit-following-days
+ The number of days after today that appear in consistency graphs.
- ~org-habit-show-habits-only-for-today~ ::
- #+vindex: org-habit-show-habits-only-for-today
- If non-~nil~, only show habits in today's agenda view. The
- default value is ~t~.
+ #+vindex: org-habit-show-habits-only-for-today
+ If non-~nil~, only show habits in today's agenda view. The default
+ value is ~t~.
Lastly, pressing {{{kbd(K)}}} in the agenda buffer causes habits to
temporarily be disabled and do not appear at all. Press {{{kbd(K)}}}
@@ -4326,27 +4297,26 @@ TODO items.
#+attr_texinfo: :sep ;
- {{{kbd(C-c \,)}}} (~org-priority~) ::
- #+kindex: C-c ,
- #+findex: org-priority
- Set the priority of the current headline. The command prompts
- for a priority character =A=, =B= or =C=. When you press
- {{{kbd(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 [[*Commands in the Agenda Buffer]]).
+ #+kindex: C-c ,
+ #+findex: org-priority
+ Set the priority of the current headline. The command prompts for
+ a priority character =A=, =B= or =C=. When you press {{{kbd(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 [[*Commands in the
+ Agenda Buffer]]).
- {{{kbd(S-UP)}}} (~org-priority-up~); {{{kbd(S-DOWN)}}} (~org-priority-down~) ::
- #+kindex: S-UP
- #+kindex: S-DOWN
- #+findex: org-priority-up
- #+findex: org-priority-down
- #+vindex: org-priority-start-cycle-with-default
- Increase/decrease the priority of the current headline[fn:47].
- Note that these keys are also used to modify timestamps (see
- [[*Creating Timestamps]]). See also [[*Packages that conflict with Org
- mode]], for a discussion of the interaction with
- ~shift-selection-mode~.
+ #+kindex: S-UP
+ #+kindex: S-DOWN
+ #+findex: org-priority-up
+ #+findex: org-priority-down
+ #+vindex: org-priority-start-cycle-with-default
+ Increase/decrease the priority of the current headline[fn:47]. Note
+ that these keys are also used to modify timestamps (see [[*Creating
+ Timestamps]]). See also [[*Packages that conflict with Org mode]], for
+ a discussion of the interaction with ~shift-selection-mode~.
#+vindex: org-highest-priority
#+vindex: org-lowest-priority
@@ -4485,63 +4455,60 @@ The following commands work with checkboxes:
- {{{kbd(C-c C-c)}}} (~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[fn:51]. With a double prefix
- argument, set it to =[-]=, which is considered to be an
- intermediate state.
+ #+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[fn:51]. With a double prefix argument, set
+ it to =[-]=, which is considered to be an intermediate state.
- {{{kbd(C-c C-x C-b)}}} (~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 =[-]=,
- which is considered to be an intermediate state.
+ #+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 =[-]=, which is
+ considered to be an intermediate state.
- - 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.
+ - 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.
- - If point is in a headline, toggle checkboxes in the region
- between this headline and the next---so /not/ the entire
- subtree.
+ - If point is in a headline, toggle checkboxes in the region between
+ this headline and the next---so /not/ the entire subtree.
- - If there is no active region, just toggle the checkbox at
- point.
+ - If there is no active region, just toggle the checkbox at point.
- {{{kbd(M-S-RET)}}} (~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 [[*Plain Lists]]).
+ #+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 [[*Plain Lists]]).
- {{{kbd(C-c C-x o)}}} (~org-toggle-ordered-property~) ::
- #+kindex: C-c C-x o
- #+findex: org-toggle-ordered-property
- #+vindex: org-track-ordered-property-with-tag
- Toggle the =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
- /track/ the value of this property with a tag for better
- visibility, customize ~org-track-ordered-property-with-tag~.
+ #+kindex: C-c C-x o
+ #+findex: org-toggle-ordered-property
+ #+vindex: org-track-ordered-property-with-tag
+ Toggle the =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 /track/ the
+ value of this property with a tag for better visibility, customize
+ ~org-track-ordered-property-with-tag~.
- {{{kbd(C-c #)}}} (~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
- {{{kbd(M-S-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.
+ #+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
+ {{{kbd(M-S-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.
* Tags
:PROPERTIES:
@@ -4632,24 +4599,24 @@ also a special command for inserting tags:
- {{{kbd(C-c C-q)}}} (~org-set-tags-command~) ::
- #+kindex: C-c C-q
- #+findex: org-set-tags-command
- #+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(RET)}}}, the tags are inserted
- and aligned to ~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 [[*Basic TODO Functionality]]).
+ #+kindex: C-c C-q
+ #+findex: org-set-tags-command
+ #+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(RET)}}}, the tags are inserted and
+ aligned to ~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 [[*Basic TODO
+ Functionality]]).
- {{{kbd(C-c C-c)}}} (~org-set-tags-command~) ::
- #+kindex: C-c C-c
- When point is in a headline, this does the same as {{{kbd(C-c
- C-q)}}}.
+ #+kindex: C-c C-c
+ When point is in a headline, this does the same as {{{kbd(C-c
+ C-q)}}}.
#+vindex: org-complete-tags-always-offer-all-agenda-tags
#+vindex: org-tag-alist
@@ -4752,45 +4719,45 @@ In this interface, you can also use the following special keys:
- {{{kbd(TAB)}}} ::
- #+kindex: TAB
- Enter a tag in the minibuffer, even if the tag is not in the
- predefined list. You can complete on all tags present in the
- buffer. You can also add several tags: just separate them with
- a comma.
+ #+kindex: TAB
+ Enter a tag in the minibuffer, even if the tag is not in the
+ predefined list. You can complete on all tags present in the
+ buffer. You can also add several tags: just separate them with
+ a comma.
- {{{kbd(SPC)}}} ::
- #+kindex: SPC
- Clear all tags for this line.
+ #+kindex: SPC
+ Clear all tags for this line.
- {{{kbd(RET)}}} ::
- #+kindex: RET
- Accept the modified set.
+ #+kindex: RET
+ Accept the modified set.
- {{{kbd(C-g)}}} ::
- #+kindex: C-g
- Abort without installing changes.
+ #+kindex: C-g
+ Abort without installing changes.
- {{{kbd(q)}}} ::
- #+kindex: q
- If {{{kbd(q)}}} is not assigned to a tag, it aborts like
- {{{kbd(C-g)}}}.
+ #+kindex: q
+ If {{{kbd(q)}}} is not assigned to a tag, it aborts like
+ {{{kbd(C-g)}}}.
- {{{kbd(!)}}} ::
- #+kindex: !
- Turn off groups of mutually exclusive tags. Use this to (as an
- exception) assign several tags from such a group.
+ #+kindex: !
+ Turn off groups of mutually exclusive tags. Use this to (as an
+ exception) assign several tags from such a group.
- {{{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.
+ #+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.
This method lets you assign tags to a headline with very few keys.
With the above setup, you could clear the current tags and set
@@ -4927,27 +4894,27 @@ related information into special lists.
- {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} (~org-match-sparse-tree~) ::
- #+kindex: C-c / m
- #+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.
+ #+kindex: C-c / m
+ #+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.
- {{{kbd(M-x org-agenda m)}}} (~org-tags-view~) ::
- #+kindex: m @r{(Agenda dispatcher)}
- #+findex: org-tags-view
- Create a global list of tag matches from all agenda files. See
- [[*Matching tags and properties]].
+ #+kindex: m @r{(Agenda dispatcher)}
+ #+findex: org-tags-view
+ Create a global list of tag matches from all agenda files. See
+ [[*Matching tags and properties]].
- {{{kbd(M-x org-agenda M)}}} (~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
- ~org-tags-match-list-sublevels~).
+ #+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
+ ~org-tags-match-list-sublevels~).
These commands all prompt for a match string which allows basic
Boolean logic like =+boss+urgent-project1=, to find entries with tags
@@ -5078,63 +5045,62 @@ The following commands help to work with properties:
#+attr_texinfo: :sep ,
- {{{kbd(M-TAB)}}} (~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.
+ #+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.
- {{{kbd(C-c C-x p)}}} (~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.
+ #+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.
- {{{kbd(C-u M-x org-insert-drawer)}}} ::
- #+findex: org-insert-drawer
- Insert a property drawer into the current entry. The drawer is
- inserted early in the entry, but after the lines with planning
- information like deadlines.
+ #+findex: org-insert-drawer
+ Insert a property drawer into the current entry. The drawer is
+ inserted early in the entry, but after the lines with planning
+ information like deadlines.
- {{{kbd(C-c C-c)}}} (~org-property-action~) ::
- #+kindex: C-c C-c
- #+findex: org-property-action
- With point in a property drawer, this executes property commands.
+ #+kindex: C-c C-c
+ #+findex: org-property-action
+ With point in a property drawer, this executes property commands.
- {{{kbd(C-c C-c s)}}} (~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.
+ #+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.
- {{{kbd(S-RIGHT)}}} (~org-property-next-allowed-values~), {{{kbd(S-LEFT)}}} (~org-property-previous-allowed-value~) ::
- #+kindex: S-RIGHT
- #+kindex: S-LEFT
- Switch property at point to the next/previous allowed value.
+ #+kindex: S-RIGHT
+ #+kindex: S-LEFT
+ Switch property at point to the next/previous allowed value.
- {{{kbd(C-c C-c d)}}} (~org-delete-property~) ::
- #+kindex: C-c C-c d
- #+findex: org-delete-property
- Remove a property from the current entry.
+ #+kindex: C-c C-c d
+ #+findex: org-delete-property
+ Remove a property from the current entry.
- {{{kbd(C-c C-c D)}}} (~org-delete-property-globally~) ::
- #+kindex: C-c C-c D
- #+findex: org-delete-property-globally
- Globally remove a property, from all entries in the current file.
+ #+kindex: C-c C-c D
+ #+findex: org-delete-property-globally
+ Globally remove a property, from all entries in the current file.
- {{{kbd(C-c C-c c)}}} (~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.
+ #+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.
** Special Properties
:PROPERTIES:
@@ -5195,27 +5161,26 @@ Searches]]).
- {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} (~org-match-sparse-tree~) ::
- #+kindex: C-c / m
- #+kindex: C-c \
- #+findex: org-match-sparse-tree
- Create a sparse tree with all matching entries. With
- a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not
- a TODO line.
+ #+kindex: C-c / m
+ #+kindex: C-c \
+ #+findex: org-match-sparse-tree
+ Create a sparse tree with all matching entries. With
+ a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not
+ a TODO line.
- {{{kbd(M-x org-agenda m)}}}, ~org-tags-view~ ::
- #+kindex: m @r{(Agenda dispatcher)}
- #+findex: org-tags-view
- Create a global list of tag/property matches from all agenda
- files.
+ #+kindex: m @r{(Agenda dispatcher)}
+ #+findex: org-tags-view
+ Create a global list of tag/property matches from all agenda files.
- {{{kbd(M-x org-agenda M)}}} (~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 ~org-tags-match-list-sublevels~).
+ #+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
+ ~org-tags-match-list-sublevels~).
The syntax for the search string is described in [[*Matching tags and
properties]].
@@ -5225,13 +5190,13 @@ single property:
- {{{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.
+ #+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.
** Property Inheritance
:PROPERTIES:
@@ -5259,31 +5224,31 @@ least for the special applications for which they are used:
- ~COLUMNS~ ::
- #+cindex: @samp{COLUMNS}, property
- The =COLUMNS= property defines the format of column view (see
- [[*Column View]]). It is inherited in the sense that the level where
- a =COLUMNS= property is defined is used as the starting point for
- a column view table, independently of the location in the subtree
- from where columns view is turned on.
+ #+cindex: @samp{COLUMNS}, property
+ The =COLUMNS= property defines the format of column view (see
+ [[*Column View]]). It is inherited in the sense that the level where
+ a =COLUMNS= property is defined is used as the starting point for
+ a column view table, independently of the location in the subtree
+ from where columns view is turned on.
- ~CATEGORY~ ::
- #+cindex: @samp{CATEGORY}, property
- For agenda view, a category set through a =CATEGORY= property
- applies to the entire subtree.
+ #+cindex: @samp{CATEGORY}, property
+ For agenda view, a category set through a =CATEGORY= property
+ applies to the entire subtree.
- ~ARCHIVE~ ::
- #+cindex: @samp{ARCHIVE}, property
- For archiving, the =ARCHIVE= property may define the archive
- location for the entire subtree (see [[*Moving a tree to an archive
- file]]).
+ #+cindex: @samp{ARCHIVE}, property
+ For archiving, the =ARCHIVE= property may define the archive
+ location for the entire subtree (see [[*Moving a tree to an archive
+ file]]).
- ~LOGGING~ ::
- #+cindex: @samp{LOGGING}, property
- The =LOGGING= property may define logging settings for an entry
- or a subtree (see [[*Tracking TODO state changes]]).
+ #+cindex: @samp{LOGGING}, property
+ The =LOGGING= property may define logging settings for an entry or
+ a subtree (see [[*Tracking TODO state changes]]).
** Column View
:PROPERTIES:
@@ -5358,48 +5323,48 @@ optional. The individual parts have the following meaning:
- {{{var(WIDTH)}}} ::
- An integer specifying the width of the column in characters. If
- omitted, the width is determined automatically.
+ An integer specifying the width of the column in characters. If
+ omitted, the width is determined automatically.
- {{{var(PROPERTY)}}} ::
- The property that should be edited in this column. Special
- properties representing meta data are allowed here as well (see
- [[*Special Properties]]).
+ The property that should be edited in this column. Special
+ properties representing meta data are allowed here as well (see
+ [[*Special Properties]]).
- {{{var(TITLE)}}} ::
- The header text for the column. If omitted, the property name is
- used.
+ The header text for the column. If omitted, the property name is
+ used.
- {{{var(SUMMARY-TYPE)}}} ::
- The summary type. If specified, the column values for parent
- nodes are computed from the children[fn:56].
-
- Supported summary types are:
-
- | =+= | Sum numbers in this column. |
- | =+;%.1f= | Like =+=, but format result with =%.1f=. |
- | =$= | Currency, short for =+;%.2f=. |
- | =min= | Smallest number in column. |
- | =max= | Largest number. |
- | =mean= | Arithmetic mean of numbers. |
- | =X= | Checkbox status, =[X]= if all children are =[X]=. |
- | =X/= | Checkbox status, =[n/m]=. |
- | =X%= | Checkbox status, =[n%]=. |
- | =:= | Sum times, HH:MM, plain numbers are minutes. |
- | =:min= | Smallest time value in column. |
- | =:max= | Largest time value. |
- | =:mean= | Arithmetic mean of time values. |
- | =@min= | Minimum age[fn:57] (in days/hours/mins/seconds). |
- | =@max= | Maximum age (in days/hours/mins/seconds). |
- | =@mean= | Arithmetic mean of ages (in days/hours/mins/seconds). |
- | =est+= | Add low-high estimates. |
-
- #+vindex: org-columns-summary-types
- You can also define custom summary types by setting
- ~org-columns-summary-types~.
+ The summary type. If specified, the column values for parent nodes
+ are computed from the children[fn:56].
+
+ Supported summary types are:
+
+ | =+= | Sum numbers in this column. |
+ | =+;%.1f= | Like =+=, but format result with =%.1f=. |
+ | =$= | Currency, short for =+;%.2f=. |
+ | =min= | Smallest number in column. |
+ | =max= | Largest number. |
+ | =mean= | Arithmetic mean of numbers. |
+ | =X= | Checkbox status, =[X]= if all children are =[X]=. |
+ | =X/= | Checkbox status, =[n/m]=. |
+ | =X%= | Checkbox status, =[n%]=. |
+ | =:= | Sum times, HH:MM, plain numbers are minutes. |
+ | =:min= | Smallest time value in column. |
+ | =:max= | Largest time value. |
+ | =:mean= | Arithmetic mean of time values. |
+ | =@min= | Minimum age[fn:57] (in days/hours/mins/seconds). |
+ | =@max= | Maximum age (in days/hours/mins/seconds). |
+ | =@mean= | Arithmetic mean of ages (in days/hours/mins/seconds). |
+ | =est+= | Add low-high estimates. |
+
+ #+vindex: org-columns-summary-types
+ You can also define custom summary types by setting
+ ~org-columns-summary-types~.
The =est+= summary type requires further explanation. It is used for
combining estimates, expressed as low-high ranges. For example,
@@ -5458,33 +5423,33 @@ either for all clocks or just for today.
- {{{kbd(C-c C-x C-c)}}} (~org-columns~) ::
- #+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
- =#+COLUMNS= definition. If point is somewhere inside the
- outline, this command searches the hierarchy, up from point, for
- a =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 =COLUMNS= property. If no such property
- is found, the format is taken from the =#+COLUMNS= line or from
- the variable ~org-columns-default-format~, and column view is
- established for the current entry and its subtree.
+ #+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
+ =#+COLUMNS= definition. If point is somewhere inside the outline,
+ this command searches the hierarchy, up from point, for a =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 =COLUMNS= property. If no such property is found, the
+ format is taken from the =#+COLUMNS= line or from the variable
+ ~org-columns-default-format~, and column view is established for the
+ current entry and its subtree.
- {{{kbd(r)}}} or {{{kbd(g)}}} (~org-columns-redo~) ::
- #+kindex: r
- #+kindex: g
- #+findex: org-columns-redo
- Recreate the column view, to include recent changes made in the
- buffer.
+ #+kindex: r
+ #+kindex: g
+ #+findex: org-columns-redo
+ Recreate the column view, to include recent changes made in the
+ buffer.
- {{{kbd(q)}}} (~org-columns-quit~) ::
- #+kindex: q
- #+findex: org-columns-quit
- Exit column view.
+ #+kindex: q
+ #+findex: org-columns-quit
+ Exit column view.
**** Editing values
:PROPERTIES:
@@ -5494,55 +5459,55 @@ either for all clocks or just for today.
#+attr_texinfo: :sep and
- {{{kbd(LEFT)}}}, {{{kbd(RIGHT)}}}, {{{kbd(UP)}}}, {{{kbd(DOWN)}}} ::
- Move through the column view from field to field.
+ Move through the column view from field to field.
- {{{kbd(1..9\,0)}}} ::
- #+kindex: 1..9,0
- Directly select the Nth allowed value, {{{kbd(0)}}} selects the
- 10th value.
+ #+kindex: 1..9,0
+ Directly select the Nth allowed value, {{{kbd(0)}}} selects the
+ 10th value.
- {{{kbd(n)}}} or {{{kbd(S-RIGHT)}}} (~org-columns-next-allowed-value~) and {{{kbd(p)}}} or {{{kbd(S-LEFT)}}} (~org-columns-previous-allowed-value~) ::
- #+kindex: n
- #+kindex: S-RIGHT
- #+kindex: p
- #+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.
+ #+kindex: n
+ #+kindex: S-RIGHT
+ #+kindex: p
+ #+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.
- {{{kbd(e)}}} (~org-columns-edit-value~) ::
- #+kindex: e
- #+findex: org-columns-edit-value
- Edit the property at point. For the special properties, this
- invokes the same interface that you normally use to change that
- property. For example, the tag completion or fast selection
- interface pops up when editing a =TAGS= property.
+ #+kindex: e
+ #+findex: org-columns-edit-value
+ Edit the property at point. For the special properties, this
+ invokes the same interface that you normally use to change that
+ property. For example, the tag completion or fast selection
+ interface pops up when editing a =TAGS= property.
- {{{kbd(C-c C-c)}}} (~org-columns-set-tags-or-toggle~) ::
- #+kindex: C-c C-c
- #+findex: org-columns-set-tags-or-toggle
- When there is a checkbox at point, toggle it.
+ #+kindex: C-c C-c
+ #+findex: org-columns-set-tags-or-toggle
+ When there is a checkbox at point, toggle it.
- {{{kbd(v)}}} (~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.
+ #+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.
- {{{kbd(a)}}} (~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.
+ #+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.
**** Modifying column view on-the-fly
:PROPERTIES:
@@ -5552,23 +5517,23 @@ either for all clocks or just for today.
#+attr_texinfo: :sep and
- {{{kbd(<)}}} (~org-columns-narrow~) and {{{kbd(>)}}} (~org-columns-widen~) ::
- #+kindex: <
- #+kindex: >
- #+findex: org-columns-narrow
- #+findex: org-columns-widen
- Make the column narrower/wider by one character.
+ #+kindex: <
+ #+kindex: >
+ #+findex: org-columns-narrow
+ #+findex: org-columns-widen
+ Make the column narrower/wider by one character.
- {{{kbd(S-M-RIGHT)}}} (~org-columns-new~) ::
- #+kindex: S-M-RIGHT
- #+findex: org-columns-new
- Insert a new column, to the left of the current column.
+ #+kindex: S-M-RIGHT
+ #+findex: org-columns-new
+ Insert a new column, to the left of the current column.
- {{{kbd(S-M-LEFT)}}} (~org-columns-delete~) ::
- #+kindex: S-M-LEFT
- #+findex: org-columns-delete
- Delete the current column.
+ #+kindex: S-M-LEFT
+ #+findex: org-columns-delete
+ Delete the current column.
*** Capturing column view
:PROPERTIES:
@@ -5592,86 +5557,86 @@ This dynamic block has the following parameters:
- =: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:
- - =local= ::
+ - =local= ::
- Use the tree in which the capture block is located.
+ Use the tree in which the capture block is located.
- - =global= ::
+ - =global= ::
- Make a global view, including all headings in the file.
+ Make a global view, including all headings in the file.
- - =file:FILENAME= ::
+ - =file:FILENAME= ::
- Run column view at the top of the {{{var(FILENAME)}}} file.
+ Run column view at the top of the {{{var(FILENAME)}}} file.
- - =LABEL= ::
+ - =LABEL= ::
- #+cindex: @samp{ID}, property
- Call column view in the tree that has an =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.
+ #+cindex: @samp{ID}, property
+ Call column view in the tree that has an =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.
- =:hlines= ::
- When ~t~, insert an hline after every line. When a number N,
- insert an hline before each headline with level ~<= N~.
+ When ~t~, insert an hline after every line. When a number N, insert
+ an hline before each headline with level ~<= N~.
- =:vlines= ::
- When non-~nil~, force column groups to get vertical lines.
+ When non-~nil~, force column groups to get vertical lines.
- =:maxlevel= ::
- When set to a number, do not capture entries below this level.
+ When set to a number, do not capture entries below this level.
- =:skip-empty-rows= ::
- When non-~nil~, skip rows where the only non-empty specifier of
- the column view is =ITEM=.
+ When non-~nil~, skip rows where the only non-empty specifier of
+ the column view is =ITEM=.
- =:exclude-tags= ::
- List of tags to exclude from column view table: entries with
- these tags will be excluded from the column view.
+ List of tags to exclude from column view table: entries with these
+ tags will be excluded from the column view.
- =:indent= ::
- When non-~nil~, indent each =ITEM= field according to its level.
+ When non-~nil~, indent each =ITEM= field according to its level.
- =:format= ::
- Specify a column attribute (see [[*Column attributes]]) for the
- dynamic block.
+ Specify a column attribute (see [[*Column attributes]]) for the dynamic
+ block.
The following commands insert or update the dynamic block:
- {{{kbd(C-c C-x i)}}} (~org-insert-columns-dblock~) ::
- #+kindex: C-c C-x i
- #+findex: org-insert-columns-dblock
- Insert a dynamic block capturing a column view. Prompt for the
- scope or ID of the view.
+ #+kindex: C-c C-x i
+ #+findex: org-insert-columns-dblock
+ Insert a dynamic block capturing a column view. Prompt for the
+ scope or ID of the view.
- {{{kbd(C-c C-c)}}} {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) ::
- #+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
- =#+BEGIN= line of the dynamic block.
+ #+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 =#+BEGIN=
+ line of the dynamic block.
- {{{kbd(C-u C-c C-x C-u)}}} (~org-update-all-dblocks~) ::
- #+kindex: C-u C-c C-x C-u
- Update all dynamic blocks (see [[*Dynamic Blocks]]). This is useful
- if you have several clock table blocks, column-capturing blocks
- or other dynamic blocks in a buffer.
+ #+kindex: C-u C-c C-x C-u
+ Update all dynamic blocks (see [[*Dynamic Blocks]]). This is useful if
+ you have several clock table blocks, column-capturing blocks or
+ other dynamic blocks in a buffer.
You can add formulas to the column view table and you may add plotting
instructions in front of the table---these survive an update of the
@@ -5721,71 +5686,71 @@ the agenda (see [[*Weekly/daily agenda]]). We distinguish:
- Plain timestamp; Event; Appointment ::
- #+cindex: timestamp
- #+cindex: appointment
- A simple timestamp just assigns a date/time to an item. This is
- just like writing down an appointment or event in a paper agenda.
- In the agenda display, the headline of an entry associated with
- a plain timestamp is shown exactly on that date.
+ #+cindex: timestamp
+ #+cindex: appointment
+ A simple timestamp just assigns a date/time to an item. This is
+ just like writing down an appointment or event in a paper agenda.
+ In the agenda display, the headline of an entry associated with
+ a plain timestamp is shown exactly on that date.
- #+begin_example
- ,* Meet Peter at the movies
- <2006-11-01 Wed 19:15>
- ,* Discussion on climate change
- <2006-11-02 Thu 20:00-22:00>
- #+end_example
+ #+begin_example
+ ,* Meet Peter at the movies
+ <2006-11-01 Wed 19:15>
+ ,* Discussion on climate change
+ <2006-11-02 Thu 20:00-22:00>
+ #+end_example
- Timestamp with repeater interval ::
- #+cindex: timestamp, with repeater interval
- A timestamp may contain a /repeater interval/, indicating that it
- applies not only on the given date, but again and again after
- a certain interval of N days (d), weeks (w), months (m), or years
- (y). The following shows up in the agenda every Wednesday:
+ #+cindex: timestamp, with repeater interval
+ A timestamp may contain a /repeater interval/, indicating that it
+ applies not only on the given date, but again and again after
+ a certain interval of N days (d), weeks (w), months (m), or years
+ (y). The following shows up in the agenda every Wednesday:
- #+begin_example
- ,* Pick up Sam at school
- <2007-05-16 Wed 12:30 +1w>
- #+end_example
+ #+begin_example
+ ,* Pick up Sam at school
+ <2007-05-16 Wed 12:30 +1w>
+ #+end_example
- Diary-style sexp 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[fn:61]. For example, with optional time:
+ #+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[fn:61]. For example, with optional time:
- #+begin_example
- ,* 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
- <%%(diary-float t 4 2)>
- #+end_example
+ #+begin_example
+ ,* 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
+ <%%(diary-float t 4 2)>
+ #+end_example
- Time/Date range ::
- #+cindex: timerange
- #+cindex: date range
- Two timestamps connected by =--= 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:
+ #+cindex: timerange
+ #+cindex: date range
+ Two timestamps connected by =--= 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:
- #+begin_example
- ,** Meeting in Amsterdam
- <2004-08-23 Mon>--<2004-08-26 Thu>
- #+end_example
+ #+begin_example
+ ,** Meeting in Amsterdam
+ <2004-08-23 Mon>--<2004-08-26 Thu>
+ #+end_example
- Inactive timestamp ::
- #+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 /not/ trigger an entry to show up in the agenda.
+ #+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 /not/ trigger an entry to show up in the agenda.
- #+begin_example
- ,* Gillian comes late for the fifth time
- [2006-11-01 Wed]
- #+end_example
+ #+begin_example
+ ,* Gillian comes late for the fifth time
+ [2006-11-01 Wed]
+ #+end_example
** Creating Timestamps
:PROPERTIES:
@@ -5799,93 +5764,92 @@ format.
#+attr_texinfo: :sep ,
- {{{kbd(C-c .)}}} (~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.
-
- #+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
- multiples of 5 minutes. See the option
- ~org-time-stamp-rounding-minutes~.
-
- #+kindex: C-u C-u C-c .
- With two prefix arguments, insert an active timestamp with the
- current time without prompting.
+ #+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.
+
+ #+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
+ multiples of 5 minutes. See the option
+ ~org-time-stamp-rounding-minutes~.
+
+ #+kindex: C-u C-u C-c .
+ With two prefix arguments, insert an active timestamp with the
+ current time without prompting.
- {{{kbd(C-c !)}}} (~org-time-stamp-inactive~) ::
- #+kindex: C-c !
- #+kindex: C-u C-c !
- #+kindex: C-u C-u C-c !
- #+findex: org-time-stamp-inactive
- Like {{{kbd(C-c .)}}}, but insert an inactive timestamp that does
- not cause an agenda entry.
+ #+kindex: C-c !
+ #+kindex: C-u C-c !
+ #+kindex: C-u C-u C-c !
+ #+findex: org-time-stamp-inactive
+ Like {{{kbd(C-c .)}}}, but insert an inactive timestamp that does
+ not cause an agenda entry.
- {{{kbd(C-c C-c)}}} ::
- #+kindex: C-c C-c
- Normalize timestamp, insert or fix day name if missing or wrong.
+ #+kindex: C-c C-c
+ Normalize timestamp, insert or fix day name if missing or wrong.
- {{{kbd(C-c <)}}} (~org-date-from-calendar~) ::
- #+kindex: C-c <
- #+findex: org-date-from-calendar
- Insert a timestamp corresponding to point date in the calendar.
+ #+kindex: C-c <
+ #+findex: org-date-from-calendar
+ Insert a timestamp corresponding to point date in the calendar.
- {{{kbd(C-c >)}}} (~org-goto-calendar~) ::
- #+kindex: C-c >
- #+findex: org-goto-calendar
- Access the Emacs calendar for the current date. If there is
- a timestamp in the current line, go to the corresponding date
- instead.
+ #+kindex: C-c >
+ #+findex: org-goto-calendar
+ Access the Emacs calendar for the current date. If there is
+ a timestamp in the current line, go to the corresponding date
+ instead.
- {{{kbd(C-c C-o)}}} (~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 [[*Weekly/daily agenda]]).
+ #+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 [[*Weekly/daily agenda]]).
- {{{kbd(S-LEFT)}}} (~org-timestamp-down-day~), {{{kbd(S-RIGHT)}}} (~org-timestamp-up-day~) ::
- #+kindex: S-LEFT
- #+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 [[*Packages that
- conflict with Org mode]]).
+ #+kindex: S-LEFT
+ #+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 [[*Packages that conflict with
+ Org mode]]).
- {{{kbd(S-UP)}}} (~org-timestamp-up~), {{{kbd(S-DOWN)}}} (~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 =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 [[*Priorities]]). The
- key bindings also conflict with shift-selection and related modes
- (see [[*Packages that conflict with Org mode]]).
+ #+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 =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 [[*Priorities]]). The key bindings
+ also conflict with shift-selection and related modes (see [[*Packages
+ that conflict with Org mode]]).
- {{{kbd(C-c C-y)}}} (~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).
+ #+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).
*** The date/time prompt
:PROPERTIES:
@@ -6026,9 +5990,9 @@ it by customizing the variables ~org-display-custom-times~ and
- {{{kbd(C-c C-x C-t)}}} (~org-toggle-time-stamp-overlays~) ::
- #+kindex: C-c C-x C-t
- #+findex: org-toggle-time-stamp-overlays
- Toggle the display of custom formats for dates and times.
+ #+kindex: C-c C-x C-t
+ #+findex: org-toggle-time-stamp-overlays
+ Toggle the display of custom formats for dates and times.
Org mode needs the default format for scanning, so the custom
date/time format does not /replace/ the default format. Instead, it
@@ -6067,69 +6031,68 @@ immediately after the task they refer to.
- =DEADLINE= ::
- #+cindex: @samp{DEADLINE} marker
- 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 /today/ carries a warning about the
- approaching or missed deadline, starting
- ~org-deadline-warning-days~ before the due date, and continuing
- until the entry is marked DONE. An example:
-
- #+begin_example
- ,*** TODO write article about the Earth for the Guide
- DEADLINE: <2004-02-29 Sun>
- The editor in charge is [[bbdb:Ford Prefect]]
- #+end_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 =DEADLINE: <2004-02-29 Sun -5d>=.
- This warning is deactivated if the task gets scheduled and you
- set ~org-agenda-skip-deadline-prewarning-if-scheduled~ to ~t~.
+ #+cindex: @samp{DEADLINE} marker
+ 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 /today/ carries a warning about the
+ approaching or missed deadline, starting ~org-deadline-warning-days~
+ before the due date, and continuing until the entry is marked DONE.
+ An example:
+
+ #+begin_example
+ ,*** TODO write article about the Earth for the Guide
+ DEADLINE: <2004-02-29 Sun>
+ The editor in charge is [[bbdb:Ford Prefect]]
+ #+end_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 =DEADLINE: <2004-02-29 Sun -5d>=. This
+ warning is deactivated if the task gets scheduled and you set
+ ~org-agenda-skip-deadline-prewarning-if-scheduled~ to ~t~.
- =SCHEDULED= ::
- #+cindex: @samp{SCHEDULED} marker
- 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[fn:65]. In addition,
- a reminder that the scheduled date has passed is present in the
- compilation for /today/, until the entry is marked DONE, i.e.,
- the task is automatically forwarded until completed.
-
- #+begin_example
- ,*** TODO Call Trillian for a date on New Years Eve.
- SCHEDULED: <2004-12-25 Sat>
- #+end_example
-
- #+vindex: org-scheduled-delay-days
- #+vindex: org-agenda-skip-scheduled-delay-if-deadline
- If you want to /delay/ the display of this task in the agenda,
- use =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 =--2d= instead. See
- ~org-scheduled-delay-days~ and
- ~org-agenda-skip-scheduled-delay-if-deadline~ for details on how
- to control this globally or per agenda.
-
- #+attr_texinfo: :tag Important
- #+begin_quote
- Scheduling an item in Org mode should /not/ be understood in the
- same way that we understand /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, /scheduling/ means
- setting a date when you want to start working on an action item.
- #+end_quote
+ #+cindex: @samp{SCHEDULED} marker
+ 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[fn:65]. In addition,
+ a reminder that the scheduled date has passed is present in the
+ compilation for /today/, until the entry is marked DONE, i.e., the
+ task is automatically forwarded until completed.
+
+ #+begin_example
+ ,*** TODO Call Trillian for a date on New Years Eve.
+ SCHEDULED: <2004-12-25 Sat>
+ #+end_example
+
+ #+vindex: org-scheduled-delay-days
+ #+vindex: org-agenda-skip-scheduled-delay-if-deadline
+ If you want to /delay/ the display of this task in the agenda, use
+ =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 =--2d= instead. See ~org-scheduled-delay-days~ and
+ ~org-agenda-skip-scheduled-delay-if-deadline~ for details on how to
+ control this globally or per agenda.
+
+ #+attr_texinfo: :tag Important
+ #+begin_quote
+ Scheduling an item in Org mode should /not/ be understood in the
+ same way that we understand /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, /scheduling/ means setting a date when you want
+ to start working on an action item.
+ #+end_quote
You may use timestamps with repeaters in scheduling and deadline
entries. Org mode issues early and late warnings based on the
@@ -6155,63 +6118,62 @@ schedule an item:[fn:66]
- {{{kbd(C-c C-d)}}} (~org-deadline~) ::
- #+kindex: C-c C-d
- #+findex: org-deadline
- #+vindex: org-log-redeadline
- Insert =DEADLINE= keyword along with a stamp. The insertion
- happens in the line directly following the headline. Remove any
- =CLOSED= timestamp . When called with a prefix argument, also
- remove any existing deadline from the entry. Depending on the
- variable ~org-log-redeadline~, take a note when changing an
- existing deadline[fn:67].
+ #+kindex: C-c C-d
+ #+findex: org-deadline
+ #+vindex: org-log-redeadline
+ Insert =DEADLINE= keyword along with a stamp. The insertion happens
+ in the line directly following the headline. Remove any =CLOSED=
+ timestamp . When called with a prefix argument, also remove any
+ existing deadline from the entry. Depending on the variable
+ ~org-log-redeadline~, take a note when changing an existing
+ deadline[fn:67].
- {{{kbd(C-c C-s)}}} (~org-schedule~) ::
- #+kindex: C-c C-s
- #+findex: org-schedule
- #+vindex: org-log-reschedule
- Insert =SCHEDULED= keyword along with a stamp. The insertion
- happens in the line directly following the headline. Remove any
- =CLOSED= timestamp. When called with a prefix argument, also
- remove the scheduling date from the entry. Depending on the
- variable ~org-log-reschedule~, take a note when changing an
- existing scheduling time[fn:68].
+ #+kindex: C-c C-s
+ #+findex: org-schedule
+ #+vindex: org-log-reschedule
+ Insert =SCHEDULED= keyword along with a stamp. The insertion
+ happens in the line directly following the headline. Remove any
+ =CLOSED= timestamp. When called with a prefix argument, also remove
+ the scheduling date from the entry. Depending on the variable
+ ~org-log-reschedule~, take a note when changing an existing
+ scheduling time[fn:68].
- {{{kbd(C-c C-x C-k)}}} (~org-mark-entry-for-agenda-action~) ::
- #+kindex: C-c C-x C-k
- #+kindex: k a
- #+kindex: k s
- #+findex: org-mark-entry-for-agenda-action
- Mark the current entry for agenda action. After you have marked
- the entry like this, you can open the agenda or the calendar to
- find an appropriate date. With point on the selected date, press
- {{{kbd(k s)}}} or {{{kbd(k d)}}} to schedule the marked item.
+ #+kindex: C-c C-x C-k
+ #+kindex: k a
+ #+kindex: k s
+ #+findex: org-mark-entry-for-agenda-action
+ Mark the current entry for agenda action. After you have marked the
+ entry like this, you can open the agenda or the calendar to find an
+ appropriate date. With point on the selected date, press {{{kbd(k
+ s)}}} or {{{kbd(k d)}}} to schedule the marked item.
- {{{kbd(C-c / d)}}} (~org-check-deadlines~) ::
- #+kindex: C-c / d
- #+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 ~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.
+ #+kindex: C-c / d
+ #+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 ~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.
- {{{kbd(C-c / b)}}} (~org-check-before-date~) ::
- #+kindex: C-c / b
- #+findex: org-check-before-date
- Sparse tree for deadlines and scheduled items before a given
- date.
+ #+kindex: C-c / b
+ #+findex: org-check-before-date
+ Sparse tree for deadlines and scheduled items before a given date.
- {{{kbd(C-c / a)}}} (~org-check-after-date~) ::
- #+kindex: C-c / a
- #+findex: org-check-after-date
- Sparse tree for deadlines and scheduled items after a given date.
+ #+kindex: C-c / a
+ #+findex: org-check-after-date
+ Sparse tree for deadlines and scheduled items after a given date.
Note that ~org-schedule~ and ~org-deadline~ supports setting the date
by indicating a relative time e.g., =+1d= sets the date to the next
@@ -6358,140 +6320,136 @@ prompted about what to do with it.
#+attr_texinfo: :sep ,
- {{{kbd(C-c C-x C-i)}}} (~org-clock-in~) ::
- #+kindex: C-c C-x C-i
- #+findex: org-clock-in
- #+vindex: org-clock-into-drawer
- #+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 =LOGBOOK= drawer (see also the variable
- ~org-clock-into-drawer~). You can also overrule the setting of
- this variable for a subtree by setting a =CLOCK_INTO_DRAWER= or
- =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 [[*Effort
- Estimates]]), the mode line displays the current clocking time
- against it[fn:74]. If the task is a repeating one (see [[*Repeated
- tasks]]), show only the time since the last reset of the
- task[fn:75]. You can exercise more control over show time with
- the =CLOCK_MODELINE_TOTAL= property. It may have the values
- =current= to show only the current clocking instance, =today= to
- show all time clocked on this tasks today---see also the
- variable ~org-extend-today-until~, ~all~ to include all time, or
- ~auto~ which is the default[fn:76]. Clicking with
- {{{kbd(mouse-1)}}} onto the mode line entry pops up a menu with
- clocking options.
+ #+kindex: C-c C-x C-i
+ #+findex: org-clock-in
+ #+vindex: org-clock-into-drawer
+ #+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 =LOGBOOK= drawer (see also the variable ~org-clock-into-drawer~).
+ You can also overrule the setting of this variable for a subtree by
+ setting a =CLOCK_INTO_DRAWER= or =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 [[*Effort Estimates]]), the mode
+ line displays the current clocking time against it[fn:74]. If the
+ task is a repeating one (see [[*Repeated tasks]]), show only the time
+ since the last reset of the task[fn:75]. You can exercise more
+ control over show time with the =CLOCK_MODELINE_TOTAL= property. It
+ may have the values =current= to show only the current clocking
+ instance, =today= to show all time clocked on this tasks today---see
+ also the variable ~org-extend-today-until~, ~all~ to include all
+ time, or ~auto~ which is the default[fn:76]. Clicking with
+ {{{kbd(mouse-1)}}} onto the mode line entry pops up a menu with
+ clocking options.
- {{{kbd(C-c C-x C-o)}}} (~org-clock-out~) ::
- #+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 ==>HH:MM=. See the variable ~org-log-note-clock-out~
- for the possibility to record an additional note together with
- the clock-out timestamp[fn:77].
+ #+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
+ ==>HH:MM=. See the variable ~org-log-note-clock-out~ for the
+ possibility to record an additional note together with the clock-out
+ timestamp[fn:77].
- {{{kbd(C-c C-x C-x)}}} (~org-clock-in-last~) ::
- #+kindex: C-c C-x C-x
- #+findex: org-clock-in-last
- #+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.
+ #+kindex: C-c C-x C-x
+ #+findex: org-clock-in-last
+ #+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-c C-x C-e)}}} (~org-clock-modify-effort-estimate~) ::
- #+kindex: C-c C-x C-e
- #+findex: org-clock-modify-effort-estimate
- Update the effort estimate for the current clock task.
+ #+kindex: C-c C-x C-e
+ #+findex: org-clock-modify-effort-estimate
+ Update the effort estimate for the current clock task.
- {{{kbd(C-c C-c)}}} or {{{kbd(C-c C-y)}}} (~org-evaluate-time-range~) ::
- #+kindex: C-c C-c
- #+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
- automatic.
+ #+kindex: C-c C-c
+ #+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
+ automatic.
- {{{kbd(C-S-UP)}}} (~org-clock-timestamps-up~), {{{kbd(C-S-DOWN)}}} (~org-clock-timestamps-down~) ::
- #+kindex: C-S-UP
- #+findex: org-clock-timestamps-up
- #+kindex: C-S-DOWN
- #+findex: org-clock-timestamps-down
- On CLOCK log lines, increase/decrease both timestamps so that the
- clock duration keeps the same value.
+ #+kindex: C-S-UP
+ #+findex: org-clock-timestamps-up
+ #+kindex: C-S-DOWN
+ #+findex: org-clock-timestamps-down
+ On CLOCK log lines, increase/decrease both timestamps so that the
+ clock duration keeps the same value.
- {{{kbd(S-M-UP)}}} (~org-timestamp-up~), {{{kbd(S-M-DOWN)}}} (~org-timestamp-down~) ::
- #+kindex: S-M-UP
- #+findex: org-clock-timestamp-up
- #+kindex: S-M-DOWN
- #+findex: org-clock-timestamp-down
- On =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-UP)}}} to
- increase a clocked-out timestamp by five minutes, then the
- clocked-in timestamp of the next clock is increased by five
- minutes.
+ #+kindex: S-M-UP
+ #+findex: org-clock-timestamp-up
+ #+kindex: S-M-DOWN
+ #+findex: org-clock-timestamp-down
+ On =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-UP)}}} to increase
+ a clocked-out timestamp by five minutes, then the clocked-in
+ timestamp of the next clock is increased by five minutes.
- {{{kbd(C-c C-t)}}} (~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.
+ #+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.
- {{{kbd(C-c C-x C-q)}}} (~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.
+ #+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.
- {{{kbd(C-c C-x C-j)}}} (~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.
+ #+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.
- {{{kbd(C-c C-x C-d)}}} (~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 ~org-remove-highlights-with-change~) or press {{{kbd(C-c
- C-c)}}}.
+ #+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
+ ~org-remove-highlights-with-change~) or press {{{kbd(C-c C-c)}}}.
The {{{kbd(l)}}} key may be used in the agenda (see [[*Weekly/daily
agenda]]) to show which tasks have been worked on or closed during
@@ -6520,26 +6478,26 @@ The clock table includes archived trees.
#+attr_texinfo: :sep ,
- {{{kbd(C-c C-c)}}} or {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) ::
- #+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 =BEGIN=
- line of the dynamic block.
+ #+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 =BEGIN=
+ line of the dynamic block.
- {{{kbd(C-u C-c C-x C-u)}}} ::
- #+kindex: C-u C-c C-x C-u
- Update all dynamic blocks (see [[*Dynamic Blocks]]). This is useful
- if you have several clock table blocks in a buffer.
+ #+kindex: C-u C-c C-x C-u
+ Update all dynamic blocks (see [[*Dynamic Blocks]]). This is useful if
+ you have several clock table blocks in a buffer.
- {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} (~org-clocktable-try-shift~) ::
- #+kindex: S-LEFT
- #+kindex: S-RIGHT
- #+findex: org-clocktable-try-shift
- Shift the current =:block= interval and update the table. Point
- needs to be in the =#+BEGIN: clocktable= line for this command.
- If =:block= is =today=, it is shifted to =today-1=, etc.
+ #+kindex: S-LEFT
+ #+kindex: S-RIGHT
+ #+findex: org-clocktable-try-shift
+ Shift the current =:block= interval and update the table. Point
+ needs to be in the =#+BEGIN: clocktable= line for this command. If
+ =:block= is =today=, it is shifted to =today-1=, etc.
Here is an example of the frame for a clock table as it is inserted
into the buffer with the {{{kbd(C-c C-x C-r)}}} command:
@@ -6561,87 +6519,87 @@ be selected:
- =: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.
- =:scope= ::
- The scope to consider. This can be any of the following:
+ The scope to consider. This can be any of the following:
- | =nil= | the current buffer or narrowed region |
- | =file= | the full current buffer |
- | =subtree= | the subtree where the clocktable is located |
- | =treeN= | the surrounding level N tree, for example =tree3= |
- | =tree= | the surrounding level 1 tree |
- | =agenda= | all agenda files |
- | =("file" ...)= | scan these files |
- | =FUNCTION= | scan files returned by calling {{{var(FUNCTION)}}} with no argument |
- | =file-with-archives= | current file and its archives |
- | =agenda-with-archives= | all agenda files, including archives |
+ | =nil= | the current buffer or narrowed region |
+ | =file= | the full current buffer |
+ | =subtree= | the subtree where the clocktable is located |
+ | =treeN= | the surrounding level N tree, for example =tree3= |
+ | =tree= | the surrounding level 1 tree |
+ | =agenda= | all agenda files |
+ | =("file" ...)= | scan these files |
+ | =FUNCTION= | scan files returned by calling {{{var(FUNCTION)}}} with no argument |
+ | =file-with-archives= | current file and its archives |
+ | =agenda-with-archives= | all agenda files, including archives |
- =: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:
-
- | =2007-12-31= | New year eve 2007 |
- | =2007-12= | December 2007 |
- | =2007-W50= | ISO-week 50 in 2007 |
- | =2007-Q2= | 2nd quarter in 2007 |
- | =2007= | the year 2007 |
- | =today=, =yesterday=, =today-N= | a relative day |
- | =thisweek=, =lastweek=, =thisweek-N= | a relative week |
- | =thismonth=, =lastmonth=, =thismonth-N= | a relative month |
- | =thisyear=, =lastyear=, =thisyear-N= | a relative year |
- | =untilnow=[fn:78] | all clocked time ever |
-
- #+vindex: org-clock-display-default-range
- When this option is not set, Org falls back to the value in
- ~org-clock-display-default-range~, which defaults to the current
- year.
-
- Use {{{kbd(S-LEFT)}}} or {{{kbd(S-RIGHT)}}} to shift the time
- interval.
+ The time block to consider. This block is specified either
+ absolutely, or relative to the current time and may be any of these
+ formats:
+
+ | =2007-12-31= | New year eve 2007 |
+ | =2007-12= | December 2007 |
+ | =2007-W50= | ISO-week 50 in 2007 |
+ | =2007-Q2= | 2nd quarter in 2007 |
+ | =2007= | the year 2007 |
+ | =today=, =yesterday=, =today-N= | a relative day |
+ | =thisweek=, =lastweek=, =thisweek-N= | a relative week |
+ | =thismonth=, =lastmonth=, =thismonth-N= | a relative month |
+ | =thisyear=, =lastyear=, =thisyear-N= | a relative year |
+ | =untilnow=[fn:78] | all clocked time ever |
+
+ #+vindex: org-clock-display-default-range
+ When this option is not set, Org falls back to the value in
+ ~org-clock-display-default-range~, which defaults to the current
+ year.
+
+ Use {{{kbd(S-LEFT)}}} or {{{kbd(S-RIGHT)}}} to shift the time
+ interval.
- =:tstart= ::
- A time string specifying when to start considering times.
- Relative times like ="<-2w>"= can also be used. See [[*Matching
- tags and properties]] for relative time syntax.
+ A time string specifying when to start considering times. Relative
+ times like ="<-2w>"= can also be used. See [[*Matching tags and
+ properties]] for relative time syntax.
- =:tend= ::
- A time string specifying when to stop considering times.
- Relative times like ="<now>"= can also be used. See [[*Matching
- tags and properties]] for relative time syntax.
+ A time string specifying when to stop considering times. Relative
+ times like ="<now>"= can also be used. See [[*Matching tags and
+ properties]] for relative time syntax.
- =:wstart= ::
- The starting day of the week. The default is 1 for Monday.
+ The starting day of the week. The default is 1 for Monday.
- =:mstart= ::
- The starting day of the month. The default is 1 for the first.
+ The starting day of the month. The default is 1 for the first.
- =:step= ::
- Set to =day=, =week=, =month= or =year= to split the table into
- chunks. To use this, either =:block=, or =:tstart= and =:tend=
- are required.
+ Set to =day=, =week=, =month= or =year= to split the table into
+ chunks. To use this, either =:block=, or =:tstart= and =:tend= are
+ required.
- =:stepskip0= ::
- Do not show steps that have zero time.
+ Do not show steps that have zero time.
- =:fileskip0= ::
- Do not show table sections from files which did not contribute.
+ Do not show table sections from files which did not contribute.
- =:match= ::
- A tags match to select entries that should contribute. See
- [[*Matching tags and properties]] for the match syntax.
+ A tags match to select entries that should contribute. See
+ [[*Matching tags and properties]] for the match syntax.
#+findex: org-clocktable-write-default
Then there are options that determine the formatting of the table.
@@ -6651,75 +6609,75 @@ using the =:formatter= parameter.
- =:emphasize= ::
- When ~t~, emphasize level one and level two items.
+ When ~t~, emphasize level one and level two items.
- =:lang= ::
- Language[fn:79] to use for descriptive cells like "Task".
+ Language[fn:79] to use for descriptive cells like "Task".
- =:link= ::
- Link the item headlines in the table to their origins.
+ Link the item headlines in the table to their origins.
- =:narrow= ::
- An integer to limit the width of the headline column in the Org
- table. If you write it like =50!=, then the headline is also
- shortened in export.
+ An integer to limit the width of the headline column in the Org
+ table. If you write it like =50!=, then the headline is also
+ shortened in export.
- =:indent= ::
- Indent each headline field according to its level.
+ Indent each headline field according to its level.
- =:tcolumns= ::
- Number of columns to be used for times. If this is smaller than
- =:maxlevel=, lower levels are lumped into one column.
+ Number of columns to be used for times. If this is smaller than
+ =:maxlevel=, lower levels are lumped into one column.
- =:level= ::
- Should a level number column be included?
+ Should a level number column be included?
- =:sort= ::
- A cons cell containing the column to sort and a sorting type.
- E.g., =:sort (1 . ?a)= sorts the first column alphabetically.
+ A cons cell containing the column to sort and a sorting type. E.g.,
+ =:sort (1 . ?a)= sorts the first column alphabetically.
- =:compact= ::
- Abbreviation for =:level nil :indent t :narrow 40! :tcolumns 1=.
- All are overwritten except if there is an explicit =:narrow=.
+ Abbreviation for =:level nil :indent t :narrow 40! :tcolumns 1=.
+ All are overwritten except if there is an explicit =:narrow=.
- =:timestamp= ::
- A timestamp for the entry, when available. Look for =SCHEDULED=,
- =DEADLINE=, =TIMESTAMP= and =TIMESTAMP_IA= special properties
- (see [[*Special Properties]]), in this order.
+ A timestamp for the entry, when available. Look for =SCHEDULED=,
+ =DEADLINE=, =TIMESTAMP= and =TIMESTAMP_IA= special properties (see
+ [[*Special Properties]]), in this order.
- =:tags= ::
- When this flag is non-~nil~, show the headline's tags.
+ When this flag is non-~nil~, show the headline's tags.
- =: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.
- =:inherit-props= ::
- When this flag is non-~nil~, the values for =:properties= are
- inherited.
+ When this flag is non-~nil~, the values for =:properties= are
+ inherited.
- =:formula= ::
- Content of a =TBLFM= keyword to be added and evaluated. As
- a special case, =: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.
+ Content of a =TBLFM= keyword to be added and evaluated. As
+ a special case, =: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.
- =:formatter= ::
- A function to format clock data and insert it into the buffer.
+ A function to format clock data and insert it into the buffer.
To get a clock summary of the current level 1 tree, for the current
day, you could write:
@@ -6794,42 +6752,42 @@ choices to correct the discrepancy:
- {{{kbd(k)}}} ::
- #+kindex: k
- To keep some or all of the minutes and stay clocked in, press
- {{{kbd(k)}}}. Org asks how many of the minutes to keep. Press
- {{{kbd(RET)}}} to keep them all, effectively changing nothing, or
- enter a number to keep that many minutes.
+ #+kindex: k
+ To keep some or all of the minutes and stay clocked in, press
+ {{{kbd(k)}}}. Org asks how many of the minutes to keep. Press
+ {{{kbd(RET)}}} to keep them all, effectively changing nothing, or
+ enter a number to keep that many minutes.
- {{{kbd(K)}}} ::
- #+kindex: K
- If you use the shift key and press {{{kbd(K)}}}, it keeps however
- many minutes you request and then immediately clock out of that
- task. If you keep all of the minutes, this is the same as just
- clocking out of the current task.
+ #+kindex: K
+ If you use the shift key and press {{{kbd(K)}}}, it keeps however
+ many minutes you request and then immediately clock out of that
+ task. If you keep all of the minutes, this is the same as just
+ clocking out of the current task.
- {{{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.
+ #+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.
- {{{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.
+ #+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.
- {{{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.
+ #+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.
What if you subtracted those away minutes from the current clock, and
now want to apply them to a new clock? Simply clock in to any task
@@ -6892,18 +6850,18 @@ commands:
- {{{kbd(C-c C-x e)}}} (~org-set-effort~) ::
- #+kindex: C-c C-x e
- #+findex: org-set-effort
- Set the effort estimate for the current entry. With a prefix
- argument, set it to the next allowed value---see below. This
- command is also accessible from the agenda with the {{{kbd(e)}}}
- key.
+ #+kindex: C-c C-x e
+ #+findex: org-set-effort
+ Set the effort estimate for the current entry. With a prefix
+ argument, set it to the next allowed value---see below. This
+ command is also accessible from the agenda with the {{{kbd(e)}}}
+ key.
- {{{kbd(C-c C-x C-e)}}} (~org-clock-modify-effort-estimate~) ::
- #+kindex: C-c C-x C-e
- #+findex: org-clock-modify-effort-estimate
- Modify the effort estimate of the item currently being clocked.
+ #+kindex: C-c C-x C-e
+ #+findex: org-clock-modify-effort-estimate
+ Modify the effort estimate of the item currently being clocked.
Clearly the best way to work with effort estimates is through column
view (see [[*Column View]]). You should start by setting up discrete
@@ -6961,65 +6919,64 @@ The relative and countdown are started with separate commands.
- {{{kbd(C-c C-x 0)}}} (~org-timer-start~) ::
- #+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.
+ #+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.
- {{{kbd(C-c C-x ;)}}} (~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.
- ~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.
+ #+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.
+ ~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.
Once started, relative and countdown timers are controlled with the
same commands.
- {{{kbd(C-c C-x .)}}} (~org-timer~) ::
- #+kindex: C-c C-x .
- #+findex: org-timer
- Insert a relative time into the buffer. The first time you use
- this, the timer starts. Using a prefix argument restarts it.
+ #+kindex: C-c C-x .
+ #+findex: org-timer
+ Insert a relative time into the buffer. The first time you use
+ this, the timer starts. Using a prefix argument restarts it.
- {{{kbd(C-c C-x -)}}} (~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.
+ #+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.
- {{{kbd(M-RET)}}} (~org-insert-heading~) ::
- #+kindex: M-RET
- #+findex: org-insert-heading
- Once the timer list is started, you can also use
- {{{kbd(M-RET)}}} to insert new timer items.
+ #+kindex: M-RET
+ #+findex: org-insert-heading
+ Once the timer list is started, you can also use {{{kbd(M-RET)}}} to
+ insert new timer items.
- {{{kbd(C-c C-x \,)}}} (~org-timer-pause-or-continue~) ::
- #+kindex: C-c C-x ,
- #+findex: org-timer-pause-or-continue
- Pause the timer, or continue it if it is already paused.
+ #+kindex: C-c C-x ,
+ #+findex: org-timer-pause-or-continue
+ Pause the timer, or continue it if it is already paused.
- {{{kbd(C-c C-x _)}}} (~org-timer-stop~) ::
- #+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.
+ #+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.
* Capture, Refile, Archive
:PROPERTIES:
@@ -7067,42 +7024,42 @@ You may also define a global key for capturing new material (see
- {{{kbd(M-x org-capture)}}} (~org-capture~) ::
- #+findex: org-capture
- #+cindex: date tree
- Display the capture templates menu. If you have templates
- defined (see [[*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.
+ #+findex: org-capture
+ #+cindex: date tree
+ Display the capture templates menu. If you have templates defined
+ (see [[*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.
- {{{kbd(C-c C-c)}}} (~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.
+ #+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.
- {{{kbd(C-c C-w)}}} (~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 [[*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 ~org-refile~ command.
+ #+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 [[*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 ~org-refile~ command.
- {{{kbd(C-c C-k)}}} (~org-capture-kill~) ::
- #+kindex: C-c C-k @r{(Capture buffer)}
- #+findex: org-capture-kill
- Abort the capture process and return to the previous state.
+ #+kindex: C-c C-k @r{(Capture buffer)}
+ #+findex: org-capture-kill
+ Abort the capture process and return to the previous state.
#+kindex: k c @r{(Agenda)}
You can also call ~org-capture~ in a special way from the agenda,
@@ -7115,12 +7072,12 @@ with prefix commands:
- {{{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.
- {{{kbd(C-u C-u M-x org-capture)}}} ::
- Visit the last stored capture item in its buffer.
+ Visit the last stored capture item in its buffer.
#+vindex: org-capture-bookmark
#+vindex: org-capture-last-stored
@@ -7142,9 +7099,9 @@ is through the customize interface.
- {{{kbd(C)}}} ::
- #+kindex: C @r{(Capture menu}
- #+vindex: org-capture-templates
- Customize the variable ~org-capture-templates~.
+ #+kindex: C @r{(Capture menu}
+ #+vindex: org-capture-templates
+ Customize the variable ~org-capture-templates~.
Before we give the formal description of template definitions, let's
look at an example. Say you would like to use one template to create
@@ -7196,194 +7153,191 @@ Now lets look at the elements of a template definition. Each entry in
- keys ::
- The keys that selects the template, as a string, characters only,
- for example ="a"=, for a template to be selected with a single
- key, or ="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:
+ The keys that selects the template, as a string, characters only,
+ for example ="a"=, for a template to be selected with a single key,
+ or ="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:
- #+begin_src emacs-lisp
- ("b" "Templates for marking stuff to buy")
- #+end_src
+ #+begin_src emacs-lisp
+ ("b" "Templates for marking stuff to buy")
+ #+end_src
- 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.
- description ::
- A short string describing the template, shown during selection.
+ A short string describing the template, shown during selection.
- type ::
- The type of entry, a symbol. Valid values are:
+ The type of entry, a symbol. Valid values are:
- - ~entry~ ::
+ - ~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~ ::
+ - ~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.
- - ~checkitem~ ::
+ - ~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.
- - ~table-line~ ::
+ - ~table-line~ ::
- A new line in the first table at the target location. Where
- exactly the line will be inserted depends on the properties
- ~:prepend~ and ~:table-line-pos~ (see below).
+ A new line in the first table at the target location. Where
+ exactly the line will be inserted depends on the properties
+ ~:prepend~ and ~:table-line-pos~ (see below).
- - ~plain~ ::
+ - ~plain~ ::
- Text to be inserted as it is.
+ Text to be inserted as it is.
- 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 ~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 ~org-directory~.
+ #+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
+ ~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 ~org-directory~.
- Valid values are:
+ Valid values are:
- - =(file "path/to/file")= ::
+ - =(file "path/to/file")= ::
- Text will be placed at the beginning or end of that file.
+ Text will be placed at the beginning or end of that file.
- - =(id "id of existing org entry")= ::
+ - =(id "id of existing org entry")= ::
- Filing as child of this entry, or in the body of the entry.
+ Filing as child of this entry, or in the body of the entry.
- - =(file+headline "filename" "node headline")= ::
+ - =(file+headline "filename" "node headline")= ::
- Fast configuration if the target heading is unique in the file.
+ Fast configuration if the target heading is unique in the file.
- - =(file+olp "filename" "Level 1 heading" "Level 2" ...)= ::
+ - =(file+olp "filename" "Level 1 heading" "Level 2" ...)= ::
- For non-unique headings, the full path is safer.
+ For non-unique headings, the full path is safer.
- - =(file+regexp "filename" "regexp to find location")= ::
+ - =(file+regexp "filename" "regexp to find location")= ::
- Use a regular expression to position point.
+ Use a regular expression to position point.
- - =(file+olp+datetree "filename" [ "Level 1 heading" ...])= ::
+ - =(file+olp+datetree "filename" [ "Level 1 heading" ...])= ::
- This target[fn:83] creates a heading in a date tree[fn:84] 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 ~:time-prompt~ and ~:tree-type~
- properties below for additional options.
+ This target[fn:83] creates a heading in a date tree[fn:84] 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 ~:time-prompt~ and ~:tree-type~ properties
+ below for additional options.
- - =(file+function "filename" function-finding-location)= ::
+ - =(file+function "filename" function-finding-location)= ::
- A function to find the right location in the file.
+ A function to find the right location in the file.
- - =(clock)= ::
+ - =(clock)= ::
- File to the entry that is currently being clocked.
+ File to the entry that is currently being clocked.
- - =(function function-finding-location)= ::
+ - =(function function-finding-location)= ::
- Most general way: write your own function which both visits the
- file and moves point to the right location.
+ Most general way: write your own function which both visits the
+ file and moves point to the right location.
- 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 =(file "template filename")=. See below for more
- details.
+ 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 =(file
+ "template filename")=. See below for more details.
- properties ::
- The rest of the entry is a property list of additional options.
- Recognized properties are:
+ The rest of the entry is a property list of additional options.
+ Recognized properties are:
- - ~:prepend~ ::
+ - ~:prepend~ ::
- Normally new captured information will be appended at the
- target location (last child, last table line, last list item,
- ...). Setting this property changes that.
+ Normally new captured information will be appended at the target
+ location (last child, last table line, last list item, ...).
+ Setting this property changes that.
- - ~:immediate-finish~ ::
+ - ~:immediate-finish~ ::
- 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.
+ 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.
- - ~:empty-lines~ ::
+ - ~: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.
- - ~:clock-in~ ::
+ - ~:clock-in~ ::
- Start the clock in this item.
+ Start the clock in this item.
- - ~:clock-keep~ ::
+ - ~:clock-keep~ ::
- Keep the clock running when filing the captured entry.
+ Keep the clock running when filing the captured entry.
- - ~:clock-resume~ ::
+ - ~:clock-resume~ ::
- If starting the capture interrupted a clock, restart that clock
- when finished with the capture. Note that ~:clock-keep~ has
- precedence over ~:clock-resume~. When setting both to
- non-~nil~, the current clock will run and the previous one will
- not be resumed.
+ If starting the capture interrupted a clock, restart that clock
+ when finished with the capture. Note that ~:clock-keep~ has
+ precedence over ~:clock-resume~. When setting both to non-~nil~,
+ the current clock will run and the previous one will not be
+ resumed.
- - ~:time-prompt~ ::
+ - ~:time-prompt~ ::
- Prompt for a date/time to be used for date/week trees and when
- filling the template. Without this property, capture uses the
- current date and time. Even if this property has not been set,
- you can force the same behavior by calling ~org-capture~ with
- a {{{kbd(C-1)}}} prefix argument.
+ Prompt for a date/time to be used for date/week trees and when
+ filling the template. Without this property, capture uses the
+ current date and time. Even if this property has not been set,
+ you can force the same behavior by calling ~org-capture~ with
+ a {{{kbd(C-1)}}} prefix argument.
- - ~:tree-type~ ::
+ - ~:tree-type~ ::
- When ~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.
+ When ~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.
- - ~:unnarrowed~ ::
+ - ~: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.
- - ~:table-line-pos~ ::
+ - ~:table-line-pos~ ::
- Specification of the location in the table where the new line
- should be inserted. It should be a string like =II-3= meaning
- that the new line should become the third line before the
- second horizontal separator line.
+ Specification of the location in the table where the new line
+ should be inserted. It should be a string like =II-3= meaning
+ that the new line should become the third line before the second
+ horizontal separator line.
- - ~:kill-buffer~ ::
+ - ~: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.
- - ~:no-save~ ::
+ - ~:no-save~ ::
- Do not save the target file after finishing the capture.
+ Do not save the target file after finishing the capture.
**** Template expansion
:PROPERTIES:
@@ -7396,125 +7350,125 @@ here:
- =%[FILE]= ::
- Insert the contents of the file given by {{{var(FILE)}}}.
+ Insert the contents of the file given by {{{var(FILE)}}}.
- =%(EXP)= ::
- 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
- =%[file]=, are expanded this way. Since this happens after
- expanding non-interactive "%-escapes", those can be used to fill
- the expression.
+ 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
+ =%[file]=, are expanded this way. Since this happens after
+ expanding non-interactive "%-escapes", those can be used to fill the
+ expression.
- =%<FORMAT>= ::
- The result of format-time-string on the {{{var(FORMAT)}}}
- specification.
+ The result of format-time-string on the {{{var(FORMAT)}}}
+ specification.
- =%t= ::
- Timestamp, date only.
+ Timestamp, date only.
- =%T= ::
- Timestamp, with date and time.
+ Timestamp, with date and time.
- =%u=, =%U= ::
- Like =%t=, =%T= above, but inactive timestamps.
+ Like =%t=, =%T= above, but inactive timestamps.
- =%i= ::
- Initial content, the region when capture is called while the
- region is active. If there is text before =%i= on the same line,
- such as indentation, and =%i= is not inside a =%(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 =%i= on the same line, such as
+ indentation, and =%i= is not inside a =%(exp)= form, that prefix is
+ added before every line in the inserted text.
- =%a= ::
- Annotation, normally the link created with ~org-store-link~.
+ Annotation, normally the link created with ~org-store-link~.
- =%A= ::
- Like =%a=, but prompt for the description part.
+ Like =%a=, but prompt for the description part.
- =%l= ::
- Like =%a=, but only insert the literal link.
+ Like =%a=, but only insert the literal link.
- =%c= ::
- Current kill ring head.
+ Current kill ring head.
- =%x= ::
- Content of the X clipboard.
+ Content of the X clipboard.
- =%k= ::
- Title of the currently clocked task.
+ Title of the currently clocked task.
- =%K= ::
- Link to the currently clocked task.
+ Link to the currently clocked task.
- =%n= ::
- User name (taken from ~user-full-name~).
+ User name (taken from ~user-full-name~).
- =%f= ::
- File visited by current buffer when org-capture was called.
+ File visited by current buffer when org-capture was called.
- =%F= ::
- Full path of the file or directory visited by current buffer.
+ Full path of the file or directory visited by current buffer.
- =%:keyword= ::
- Specific information for certain link types, see below.
+ Specific information for certain link types, see below.
- =%^g= ::
- Prompt for tags, with completion on tags in target file.
+ Prompt for tags, with completion on tags in target file.
- =%^G= ::
- Prompt for tags, with completion all tags in all agenda files.
+ Prompt for tags, with completion all tags in all agenda files.
- =%^t= ::
- Like =%t=, but prompt for date. Similarly =%^T=, =%^u=, =%^U=. You may
- define a prompt like =%^{Birthday}t=.
+ Like =%t=, but prompt for date. Similarly =%^T=, =%^u=, =%^U=. You
+ may define a prompt like =%^{Birthday}t=.
- =%^C= ::
- Interactive selection of which kill or clip to use.
+ Interactive selection of which kill or clip to use.
- =%^L= ::
- Like =%^C=, but insert as link.
+ Like =%^C=, but insert as link.
- =%^{PROP}p= ::
- Prompt the user for a value for property {{{var(PROP)}}}.
+ Prompt the user for a value for property {{{var(PROP)}}}.
- =%^{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|default|completion2|completion3...}=. The arrow keys
- access a prompt-specific history.
+ Prompt the user for a string and replace this sequence with it. You
+ may specify a default value and a completion table with
+ =%^{prompt|default|completion2|completion3...}=. The arrow keys
+ access a prompt-specific history.
- =%\N= ::
- Insert the text entered at the {{{var(N)}}}th =%^{PROMPT}=, where
- {{{var(N)}}} is a number, starting from 1.
+ Insert the text entered at the {{{var(N)}}}th =%^{PROMPT}=, where
+ {{{var(N)}}} is a number, starting from 1.
- =%?= ::
- After completing the template, position point here.
+ After completing the template, position point here.
#+vindex: org-store-link-props
For specific link types, the following keywords are defined[fn:86]:
@@ -7593,103 +7547,103 @@ The following commands deal with attachments:
- {{{kbd(C-c C-a)}}} (~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:
+ #+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:
- {{{kbd(a)}}} (~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
- ~org-attach-method~. Note that hard links are not supported on
- all systems.
+ #+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
+ ~org-attach-method~. Note that hard links are not supported on
+ all systems.
- {{{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.
+ #+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.
- {{{kbd(b)}}} (~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.
+ #+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.
- {{{kbd(n)}}} (~org-attach-new~) ::
- #+kindex: C-c C-a n
- #+findex: org-attach-new
- Create a new attachment as an Emacs buffer.
+ #+kindex: C-c C-a n
+ #+findex: org-attach-new
+ Create a new attachment as an Emacs buffer.
- {{{kbd(z)}}} (~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.
+ #+kindex: C-c C-a z
+ #+findex: org-attach-sync
+ Synchronize the current task with its attachment directory, in
+ case you added attachments yourself.
- {{{kbd(o)}}} (~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
- ~org-file-apps~. For more details, see the information on
- following hyperlinks (see [[*Handling Links]]).
+ #+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
+ ~org-file-apps~. For more details, see the information on
+ following hyperlinks (see [[*Handling Links]]).
- {{{kbd(O)}}} (~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.
+ #+kindex: C-c C-a O
+ #+findex: org-attach-open-in-emacs
+ Also open the attachment, but force opening the file in Emacs.
- {{{kbd(f)}}} (~org-attach-reveal~) ::
- #+kindex: C-c C-a f
- #+findex: org-attach-reveal
- Open the current task's attachment directory.
+ #+kindex: C-c C-a f
+ #+findex: org-attach-reveal
+ Open the current task's attachment directory.
- {{{kbd(F)}}} (~org-attach-reveal-in-emacs~) ::
- #+kindex: C-c C-a F
- #+findex: org-attach-reveal-in-emacs
- Also open the directory, but force using Dired in Emacs.
+ #+kindex: C-c C-a F
+ #+findex: org-attach-reveal-in-emacs
+ Also open the directory, but force using Dired in Emacs.
- {{{kbd(d)}}} (~org-attach-delete-one~) ::
- #+kindex: C-c C-a d
- Select and delete a single attachment.
+ #+kindex: C-c C-a d
+ Select and delete a single attachment.
- {{{kbd(D)}}} (~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.
+ #+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.
- {{{kbd(s)}}} (~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 =ATTACH_DIR=
- property.
+ #+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 =ATTACH_DIR=
+ property.
- {{{kbd(i)}}} (~org-attach-set-inherit~) ::
- #+kindex: C-c C-a i
- #+cindex: @samp{ATTACH_DIR_INHERIT}, property
- Set the =ATTACH_DIR_INHERIT= property, so that children use the
- same directory for attachments as the parent does.
+ #+kindex: C-c C-a i
+ #+cindex: @samp{ATTACH_DIR_INHERIT}, property
+ Set the =ATTACH_DIR_INHERIT= property, so that children use the
+ same directory for attachments as the parent does.
#+cindex: attach from Dired
#+findex: org-attach-dired-to-subtree
@@ -7754,14 +7708,14 @@ Entries=, whenever the following command is used:
- {{{kbd(C-c C-x g)}}} (~org-feed-update-all~) ::
- #+kindex: C-c C-x g
- Collect items from the feeds configured in ~org-feed-alist~ and
- act upon them.
+ #+kindex: C-c C-x g
+ Collect items from the feeds configured in ~org-feed-alist~ and act
+ upon them.
- {{{kbd(C-c C-x G)}}} (~org-feed-goto-inbox~) ::
- #+kindex: C-c C-x G
- Prompt for a feed name and go to the inbox configured for this feed.
+ #+kindex: C-c C-x G
+ Prompt for a feed name and go to the inbox configured for this feed.
Under the same headline, Org creates a drawer =FEEDSTATUS= in which it
stores information about the status of items in the feed, to avoid
@@ -7976,73 +7930,72 @@ special command:
- {{{kbd(C-c M-w)}}} (~org-copy~) ::
- #+kindex: C-c M-w
- #+findex: org-copy
- Copying works like refiling, except that the original note is not
- deleted.
+ #+kindex: C-c M-w
+ #+findex: org-copy
+ Copying works like refiling, except that the original note is not
+ deleted.
- {{{kbd(C-c C-w)}}} (~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
- ~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
- ~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 ~org-refile-use-outline-path~ and
- ~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 ~org-refile-allow-creating-parent-nodes~.
- When the variable ~org-log-refile~[fn:89] is set, a timestamp or
- a note is recorded whenever an entry is refiled.
+ #+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
+ ~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 ~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 ~org-refile-use-outline-path~ and
+ ~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 ~org-refile-allow-creating-parent-nodes~. When the
+ variable ~org-log-refile~[fn:89] is set, a timestamp or a note is
+ recorded whenever an entry is refiled.
- {{{kbd(C-u C-c C-w)}}} ::
- #+kindex: C-u C-c C-w
- Use the refile interface to jump to a heading.
+ #+kindex: C-u C-c C-w
+ Use the refile interface to jump to a heading.
- {{{kbd(C-u C-u C-c C-w)}}} (~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 ~org-refile~ last moved a tree to.
+ #+kindex: C-u C-u C-c C-w
+ #+findex: org-refile-goto-last-stored
+ Jump to the location where ~org-refile~ last moved a tree to.
- {{{kbd(C-2 C-c C-w)}}} ::
- #+kindex: C-2 C-c C-w
- Refile as the child of the item currently being clocked.
+ #+kindex: C-2 C-c C-w
+ Refile as the child of the item currently being clocked.
- {{{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 ~org-refile-keep~
- to make this the default behavior, and beware that this may
- result in duplicated =ID= properties.
+ #+kindex: C-3 C-c C-w
+ #+vindex: org-refile-keep
+ Refile and keep the entry in place. Also see ~org-refile-keep~ to
+ make this the default behavior, and beware that this may result in
+ duplicated =ID= properties.
- {{{kbd(C-0 C-c C-w)}}} or {{{kbd(C-u C-u C-u C-c C-w)}}} (~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 ~org-refile-use-cache~. To make the command see
- new possible targets, you have to clear the cache with this
- command.
+ #+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 ~org-refile-use-cache~. To make the command see new
+ possible targets, you have to clear the cache with this command.
** Archiving
:PROPERTIES:
@@ -8057,11 +8010,11 @@ global searches like the construction of agenda views fast.
- {{{kbd(C-c C-x C-a)}}} (~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 ~org-archive-default-command~.
+ #+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 ~org-archive-default-command~.
*** Moving a tree to an archive file
:PROPERTIES:
@@ -8075,28 +8028,28 @@ file, the archive file.
- {{{kbd(C-c C-x C-s)}}} or short {{{kbd(C-c $)}}} (~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 ~org-archive-location~.
+ #+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 ~org-archive-location~.
- {{{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 /not/ on a headline when this
- command is invoked, check level 1 trees.
+ #+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 /not/ on a headline when this command
+ is invoked, check level 1 trees.
- {{{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 /does/
- contain a timestamp, and that timestamp is in the past.
+ #+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 /does/ contain
+ a timestamp, and that timestamp is in the past.
#+cindex: archive locations
The default archive location is a file in the same directory as the
@@ -8175,35 +8128,35 @@ The following commands help manage the =ARCHIVE= tag:
- {{{kbd(C-c C-x a)}}} (~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.
+ #+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.
- {{{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 =ARCHIVE= tag for
- the child. If point is /not/ on a headline when this command is
- invoked, check the level 1 trees.
+ #+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 =ARCHIVE= tag for the
+ child. If point is /not/ on a headline when this command is
+ invoked, check the level 1 trees.
- {{{kbd(C-TAB)}}} (~org-force-cycle-archived~) ::
- #+kindex: C-TAB
- Cycle a tree even if it is tagged with =ARCHIVE=.
+ #+kindex: C-TAB
+ Cycle a tree even if it is tagged with =ARCHIVE=.
- {{{kbd(C-c C-x A)}}} (~org-archive-to-archive-sibling~) ::
- #+kindex: C-c C-x A
- #+findex: org-archive-to-archive-sibling
- Move the current entry to the /Archive Sibling/. This is
- a sibling of the entry with the heading =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.
+ #+kindex: C-c C-x A
+ #+findex: org-archive-to-archive-sibling
+ Move the current entry to the /Archive Sibling/. This is a sibling
+ of the entry with the heading =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.
* Agenda Views
:PROPERTIES:
@@ -8277,33 +8230,33 @@ but the easiest way to maintain it is through the following commands
#+attr_texinfo: :sep and
- {{{kbd(C-c [)}}} (~org-agenda-file-to-front~) ::
- #+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.
+ #+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.
- {{{kbd(C-c ])}}} (~org-remove-file~) ::
- #+kindex: C-c ]
- #+findex: org-remove-file
- Remove current file from the list of agenda files.
+ #+kindex: C-c ]
+ #+findex: org-remove-file
+ Remove current file from the list of agenda files.
- {{{kbd(C-')}}} and {{{kbd(C-\,)}}} (~org-cycle-agenda-files~) ::
- #+kindex: C-'
- #+kindex: C-,
- #+findex: org-cycle-agenda-files
- #+cindex: cycling, of agenda files
- Cycle through agenda file list, visiting one file after the other.
+ #+kindex: C-'
+ #+kindex: C-,
+ #+findex: org-cycle-agenda-files
+ #+cindex: cycling, of agenda files
+ Cycle through agenda file list, visiting one file after the other.
- {{{kbd(M-x org-switchb)}}} ::
- #+findex: org-switchb
- Command to use an iswitchb-like interface to switch to and
- between Org buffers.
+ #+findex: org-switchb
+ Command to use an iswitchb-like interface to switch to and between
+ Org buffers.
#+texinfo: @noindent
The Org menu contains the current list of files and can be used to
@@ -8318,39 +8271,39 @@ scope for an extended period, use the following commands:
- {{{kbd(C-c C-x <)}}} (~org-agenda-set-restriction-lock~) ::
- #+kindex: C-c C-x <
- #+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.
+ #+kindex: C-c C-x <
+ #+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.
- {{{kbd(C-c C-x >)}}} (~org-agenda-remove-restriction-lock~) ::
- #+kindex: C-c C-x >
- #+findex: org-agenda-remove-restriction-lock
- Remove the restriction created by {{{kbd(C-c C-x <)}}}.
+ #+kindex: C-c C-x >
+ #+findex: org-agenda-remove-restriction-lock
+ Remove the restriction created by {{{kbd(C-c C-x <)}}}.
When working with Speedbar, you can use the following commands in the
Speedbar frame:
- {{{kbd(<)}}} (~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.
+ #+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.
- {{{kbd(>)}}} (~org-agenda-remove-restriction-lock~) ::
- #+findex: org-agenda-remove-restriction-lock
- Remove the restriction.
+ #+findex: org-agenda-remove-restriction-lock
+ Remove the restriction.
** The Agenda Dispatcher
:PROPERTIES:
@@ -8368,69 +8321,67 @@ commands:
- {{{kbd(a)}}} ::
- Create the calendar-like agenda (see [[*Weekly/daily agenda]]).
+ Create the calendar-like agenda (see [[*Weekly/daily agenda]]).
- {{{kbd(t)}}} or {{{kbd(T)}}} ::
- Create a list of all TODO items (see [[*The global TODO list]]).
+ Create a list of all TODO items (see [[*The global TODO list]]).
- {{{kbd(m)}}} or {{{kbd(M)}}} ::
- Create a list of headlines matching a given expression (see
- [[*Matching tags and properties]]).
+ Create a list of headlines matching a given expression (see
+ [[*Matching tags and properties]]).
- {{{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.
+ #+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.
- {{{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
- ~org-agenda-text-search-extra-files~. This uses the Emacs
- command ~multi-occur~. A prefix argument can be used to specify
- the number of context lines for each match, default is
- 1.
+ #+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 ~org-agenda-text-search-extra-files~. This
+ uses the Emacs command ~multi-occur~. A prefix argument can be used
+ to specify the number of context lines for each match, default is
+ 1.
- {{{kbd(#)}}} or {{{kbd(!)}}} ::
- Create a list of stuck projects (see [[*Stuck projects]]).
+ Create a list of stuck projects (see [[*Stuck projects]]).
- {{{kbd(<)}}} ::
- #+kindex: < @r{(Agenda dispatcher)}
- Restrict an agenda command to the current buffer[fn:92]. After
- pressing {{{kbd(<)}}}, you still need to press the character
- selecting the command.
+ #+kindex: < @r{(Agenda dispatcher)}
+ Restrict an agenda command to the current buffer[fn:92]. After
+ pressing {{{kbd(<)}}}, you still need to press the character
+ selecting the command.
- {{{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
- subtree[fn:93]. After pressing {{{kbd(< <)}}}, you still need to
- press the character selecting the command.
+ #+kindex: < < @r{(Agenda dispatcher)}
+ If there is an active region, restrict the following agenda command
+ to the region. Otherwise, restrict it to the current
+ subtree[fn:93]. After pressing {{{kbd(< <)}}}, you still need to
+ press the character selecting the command.
- {{{kbd(*)}}} ::
- #+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 ~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
- ~org-toggle-sticky-agenda~.
+ #+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
+ ~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 ~org-toggle-sticky-agenda~.
You can also define custom commands that are accessible through the
dispatcher, just like the default commands. This includes the
@@ -8459,13 +8410,13 @@ a paper agenda, showing all the tasks for the current week or day.
- {{{kbd(M-x org-agenda a)}}} (~org-agenda-list~) ::
- #+kindex: a @r{(Agenda dispatcher)}
- #+findex: org-agenda-list
- #+cindex: org-agenda, command
- Compile an agenda for the current week from a list of Org files.
- The agenda shows the entries for each day. With a numeric prefix
- argument[fn:94]---like {{{kbd(C-u 2 1 M-x org-agenda a)}}}---you
- may set the number of days to be displayed.
+ #+kindex: a @r{(Agenda dispatcher)}
+ #+findex: org-agenda-list
+ #+cindex: org-agenda, command
+ Compile an agenda for the current week from a list of Org files.
+ The agenda shows the entries for each day. With a numeric prefix
+ argument[fn:94]---like {{{kbd(C-u 2 1 M-x org-agenda a)}}}---you may
+ set the number of days to be displayed.
#+vindex: org-agenda-span
#+vindex: org-agenda-start-day
@@ -8631,37 +8582,37 @@ collected into a single place.
- {{{kbd(M-x org-agenda t)}}} (~org-todo-list~) ::
- #+kindex: t @r{(Agenda dispatcher)}
- #+findex: org-todo-list
- Show the global TODO list. This collects the TODO items from all
- agenda files (see [[*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
- [[*Commands in the Agenda Buffer]]).
+ #+kindex: t @r{(Agenda dispatcher)}
+ #+findex: org-todo-list
+ Show the global TODO list. This collects the TODO items from all
+ agenda files (see [[*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 [[*Commands in the
+ Agenda Buffer]]).
- {{{kbd(M-x org-agenda T)}}} (~org-todo-list~) ::
- #+kindex: T @r{(Agenda dispatcher)}
- #+findex: org-todo-list
- #+cindex: TODO keyword matching
- #+vindex: org-todo-keywords
- 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 =|= as the
- boolean OR operator. With a numeric prefix, the Nth keyword in
- ~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 [[*The Agenda Dispatcher]]).
-
- Matching specific TODO keywords can also be done as part of
- a tags search (see [[*Tag Searches]]).
+ #+kindex: T @r{(Agenda dispatcher)}
+ #+findex: org-todo-list
+ #+cindex: TODO keyword matching
+ #+vindex: org-todo-keywords
+ 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 =|= as the boolean
+ OR operator. With a numeric prefix, the Nth keyword in
+ ~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
+ [[*The Agenda Dispatcher]]).
+
+ Matching specific TODO keywords can also be done as part of a tags
+ search (see [[*Tag Searches]]).
Remote editing of TODO items means that you can change the state of
a TODO entry with a single key press. The commands available in the
@@ -8710,27 +8661,26 @@ sparse trees with {{{kbd(C-c / m)}}}.
- {{{kbd(M-x org-agenda m)}}} (~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 =+work+urgent-withboss= or
- =work|home= (see [[*Tags]]). If you often need a specific search,
- define a custom command for it (see [[*The Agenda Dispatcher]]).
+ #+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 =+work+urgent-withboss= or =work|home=
+ (see [[*Tags]]). If you often need a specific search, define a custom
+ command for it (see [[*The Agenda Dispatcher]]).
- {{{kbd(M-x org-agenda M)}}} (~org-tags-view~) ::
- #+kindex: M @r{(Agenda dispatcher)}
- #+findex: org-tags-view
- #+vindex: org-tags-match-list-sublevels
- #+vindex: org-agenda-tags-todo-honor-ignore-options
- Like {{{kbd(m)}}}, but only select headlines that are also TODO
- items and force checking subitems (see the variable
- ~org-tags-match-list-sublevels~). To exclude scheduled/deadline
- items, see the variable
- ~org-agenda-tags-todo-honor-ignore-options~. Matching specific
- TODO keywords together with a tags match is also possible, see
- [[*Tag Searches]].
+ #+kindex: M @r{(Agenda dispatcher)}
+ #+findex: org-tags-view
+ #+vindex: org-tags-match-list-sublevels
+ #+vindex: org-agenda-tags-todo-honor-ignore-options
+ Like {{{kbd(m)}}}, but only select headlines that are also TODO
+ items and force checking subitems (see the variable
+ ~org-tags-match-list-sublevels~). To exclude scheduled/deadline
+ items, see the variable ~org-agenda-tags-todo-honor-ignore-options~.
+ Matching specific TODO keywords together with a tags match is also
+ possible, see [[*Tag Searches]].
The commands available in the tags list are described in [[*Commands in
the Agenda Buffer]].
@@ -8748,17 +8698,17 @@ only tags.
- ~+work-boss~ ::
- Select headlines tagged =work=, but discard those also tagged
- =boss=.
+ Select headlines tagged =work=, but discard those also tagged
+ =boss=.
- ~work|laptop~ ::
- Selects lines tagged =work= or =laptop=.
+ Selects lines tagged =work= or =laptop=.
- ~work|laptop+night~ ::
- Like before, but require the =laptop= lines to be tagged
- also =night=.
+ Like before, but require the =laptop= lines to be tagged also
+ =night=.
#+cindex: regular expressions, with tags search
Instead of a tag, you may also specify a regular expression enclosed
@@ -8791,12 +8741,12 @@ Here are more examples:
- =work+TODO​="WAITING"= ::
- Select =work=-tagged TODO lines with the specific TODO keyword
- =WAITING=.
+ Select =work=-tagged TODO lines with the specific TODO keyword
+ =WAITING=.
- =work+TODO​="WAITING"|home+TODO​="WAITING"= ::
- Waiting tasks both at work and at home.
+ Waiting tasks both at work and at home.
When matching properties, a number of different operators can be used
to test the value of a property. Here is a complex example:
@@ -8856,17 +8806,16 @@ TODO keywords in a DONE state. Examples:
- =work/WAITING= ::
- Same as =work+TODO​="WAITING"=.
+ Same as =work+TODO​="WAITING"=.
- =work/!-WAITING-NEXT= ::
- Select =work=-tagged TODO lines that are neither =WAITING= nor
- =NEXT=.
+ Select =work=-tagged TODO lines that are neither =WAITING= nor
+ =NEXT=.
- =work/!+WAITING|+NEXT= ::
- Select =work=-tagged TODO lines that are either =WAITING= or
- =NEXT=.
+ Select =work=-tagged TODO lines that are either =WAITING= or =NEXT=.
*** Search view
:PROPERTIES:
@@ -8881,10 +8830,10 @@ entries. It is particularly useful to find notes.
- {{{kbd(M-x org-agenda s)}}} (~org-search-view~) ::
- #+kindex: s @r{(Agenda dispatcher)}
- #+findex: org-search-view
- This is a special search that lets you select entries by matching
- a substring or specific words using a boolean logic.
+ #+kindex: s @r{(Agenda dispatcher)}
+ #+findex: org-search-view
+ This is a special search that lets you select entries by matching
+ a substring or specific words using a boolean logic.
For example, the search string =computer equipment= matches entries
that contain =computer equipment= as a substring, even if the two
@@ -8927,16 +8876,16 @@ and define next actions for them.
- {{{kbd(M-x org-agenda #)}}} (~org-agenda-list-stuck-projects~) ::
- #+kindex: # @r{(Agenda dispatcher)}
- #+findex: org-agenda-list-stuck-projects
- List projects that are stuck.
+ #+kindex: # @r{(Agenda dispatcher)}
+ #+findex: org-agenda-list-stuck-projects
+ List projects that are stuck.
- {{{kbd(M-x org-agenda !)}}} ::
- #+kindex: ! @r{(Agenda dispatcher)}
- #+vindex: org-stuck-projects
- Customize the variable ~org-stuck-projects~ to define what
- a stuck project is and how to find it.
+ #+kindex: ! @r{(Agenda dispatcher)}
+ #+vindex: org-stuck-projects
+ Customize the variable ~org-stuck-projects~ to define what a stuck
+ project is and how to find it.
You almost certainly need to configure this view before it works for
you. The built-in default assumes that all your projects are level-2
@@ -9130,118 +9079,117 @@ custom agenda commands.
- {{{kbd(/)}}} (~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.[fn:97]
-
- You are prompted for a tag selection letter; {{{kbd(SPC)}}} means
- any tag at all. Pressing {{{kbd(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 /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 ~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(RET)}}} as
- a sub-option key and runs the auto exclusion logic. For example,
- let's say you use a =Net= tag to identify tasks which need
- network access, an =Errand= tag for errands in town, and a =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:
-
- #+begin_src emacs-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_src
+ #+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.[fn:97]
+
+ You are prompted for a tag selection letter; {{{kbd(SPC)}}} means
+ any tag at all. Pressing {{{kbd(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 /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 ~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(RET)}}} as a sub-option key and runs the
+ auto exclusion logic. For example, let's say you use a =Net= tag to
+ identify tasks which need network access, an =Errand= tag for
+ errands in town, and a =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:
+
+ #+begin_src emacs-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_src
- {{{kbd(<)}}} (~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.
+ #+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 ~org-agenda-category-filter-preset~. See [[*Setting options
- for custom commands]].
+ #+vindex: org-agenda-category-filter-preset
+ You can add a filter preset in custom agenda commands through the
+ option ~org-agenda-category-filter-preset~. See [[*Setting options
+ for custom commands]].
- {{{kbd(^)}}} (~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.
+ #+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.
- {{{kbd(=)}}} (~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 /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.
+ #+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 /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 ~org-agenda-regexp-filter-preset~. See [[*Setting options
- for custom commands]].
+ #+vindex: org-agenda-regexp-filter-preset
+ You can add a filter preset in custom agenda commands through the
+ option ~org-agenda-regexp-filter-preset~. See [[*Setting options
+ for custom commands]].
- {{{kbd(_)}}} (~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
-
- #+begin_src emacs-lisp
- (setq org-global-properties
- '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
- #+end_src
-
- #+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
- 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 ~org-sort-agenda-noeffort-is-high~.
-
- 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.
-
- #+vindex: org-agenda-effort-filter-preset
- You can add a filter preset in custom agenda commands through the
- option ~org-agenda-effort-filter-preset~. See [[*Setting options
- for custom commands]].
+ #+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
+
+ #+begin_src emacs-lisp
+ (setq org-global-properties
+ '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
+ #+end_src
+
+ #+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
+ 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 ~org-sort-agenda-noeffort-is-high~.
+
+ 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.
+
+ #+vindex: org-agenda-effort-filter-preset
+ You can add a filter preset in custom agenda commands through the
+ option ~org-agenda-effort-filter-preset~. See [[*Setting options for
+ custom commands]].
- {{{kbd(|)}}} (~org-agenda-filter-remove-all~) ::
- Remove all filters in the current agenda view.
+ Remove all filters in the current agenda view.
**** Setting limits for the agenda
:PROPERTIES:
@@ -9254,23 +9202,23 @@ locally in your custom agenda views (see [[*Custom Agenda Views]]).
- ~org-agenda-max-entries~ ::
- #+vindex: org-agenda-max-entries
- Limit the number of entries.
+ #+vindex: org-agenda-max-entries
+ Limit the number of entries.
- ~org-agenda-max-effort~ ::
- #+vindex: org-agenda-max-effort
- Limit the duration of accumulated efforts (as minutes).
+ #+vindex: org-agenda-max-effort
+ Limit the duration of accumulated efforts (as minutes).
- ~org-agenda-max-todos~ ::
- #+vindex: org-agenda-max-todos
- Limit the number of entries with TODO keywords.
+ #+vindex: org-agenda-max-todos
+ Limit the number of entries with TODO keywords.
- ~org-agenda-max-tags~ ::
- #+vindex: org-agenda-max-tags
- Limit the number of tagged entries.
+ #+vindex: org-agenda-max-tags
+ Limit the number of tagged entries.
When set to a positive integer, each option excludes entries from
other categories: for example, =(setq org-agenda-max-effort 100)=
@@ -9296,8 +9244,8 @@ rebuilding the agenda:
- {{{kbd(~ )}}} (~org-agenda-limit-interactively~) ::
- #+findex: org-agenda-limit-interactively
- This prompts for the type of limit to apply and its value.
+ #+findex: org-agenda-limit-interactively
+ This prompts for the type of limit to apply and its value.
** Commands in the Agenda Buffer
:PROPERTIES:
@@ -9324,15 +9272,15 @@ the other commands, point needs to be in the desired line.
- {{{kbd(n)}}} (~org-agenda-next-line~) ::
- #+kindex: n
- #+findex: org-agenda-next-line
- Next line (same as {{{kbd(DOWN)}}} and {{{kbd(C-n)}}}).
+ #+kindex: n
+ #+findex: org-agenda-next-line
+ Next line (same as {{{kbd(DOWN)}}} and {{{kbd(C-n)}}}).
- {{{kbd(p)}}} (~org-agenda-previous-line~) ::
- #+kindex: p
- #+findex: org-agenda-previous-line
- Previous line (same as {{{kbd(UP)}}} and {{{kbd(C-p)}}}).
+ #+kindex: p
+ #+findex: org-agenda-previous-line
+ Previous line (same as {{{kbd(UP)}}} and {{{kbd(C-p)}}}).
*** View/Go to Org file
:PROPERTIES:
@@ -9342,58 +9290,58 @@ the other commands, point needs to be in the desired line.
- {{{kbd(SPC)}}} or {{{kbd(mouse-3)}}} (~org-agenda-show-and-scroll-up~) ::
- #+kindex: SPC
- #+kindex: mouse-3
- #+findex: org-agenda-show-and-scroll-up
- Display the original location of the item in another window.
- With a prefix argument, make sure that drawers stay folded.
+ #+kindex: SPC
+ #+kindex: mouse-3
+ #+findex: org-agenda-show-and-scroll-up
+ Display the original location of the item in another window.
+ With a prefix argument, make sure that drawers stay folded.
- {{{kbd(L)}}} (~org-agenda-recenter~) ::
- #+findex: org-agenda-recenter
- Display original location and recenter that window.
+ #+findex: org-agenda-recenter
+ Display original location and recenter that window.
- {{{kbd(TAB)}}} or {{{kbd(mouse-2)}}} (~org-agenda-goto~) ::
- #+kindex: TAB
- #+kindex: mouse-2
- #+findex: org-agenda-goto
- Go to the original location of the item in another window.
+ #+kindex: TAB
+ #+kindex: mouse-2
+ #+findex: org-agenda-goto
+ Go to the original location of the item in another window.
- {{{kbd(RET)}}} (~org-agenda-switch-to~) ::
- #+kindex: RET
- #+findex: org-agenda-switch-to
- Go to the original location of the item and delete other windows.
+ #+kindex: RET
+ #+findex: org-agenda-switch-to
+ Go to the original location of the item and delete other windows.
- {{{kbd(F)}}} (~org-agenda-follow-mode~) ::
- #+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
- ~org-agenda-start-with-follow-mode~.
+ #+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
+ ~org-agenda-start-with-follow-mode~.
- {{{kbd(C-c C-x b)}}} (~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.
+ #+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.
- {{{kbd(C-c C-o)}}} (~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.
+ #+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.
*** Change display
:PROPERTIES:
@@ -9405,258 +9353,255 @@ the other commands, point needs to be in the desired line.
#+attr_texinfo: :sep ,
- {{{kbd(A)}}} ::
- #+kindex: A
- Interactively select another agenda view and append it to the
- current view.
+ #+kindex: A
+ Interactively select another agenda view and append it to the
+ current view.
- {{{kbd(o)}}} ::
- #+kindex: o
- Delete other windows.
+ #+kindex: o
+ Delete other windows.
- {{{kbd(v d)}}} or short {{{kbd(d)}}} (~org-agenda-day-view~) ::
- #+kindex: v d
- #+kindex: d
- #+findex: org-agenda-day-view
- 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.
+ #+kindex: v d
+ #+kindex: d
+ #+findex: org-agenda-day-view
+ 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.
- {{{kbd(v w)}}} or short {{{kbd(w)}}} (~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.
+ #+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.
- {{{kbd(v m)}}} (~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.
+ #+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.
- {{{kbd(v y)}}} (~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.
+ #+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.
- {{{kbd(v SPC)}}} (~org-agenda-reset-view~) ::
- #+kindex: v SPC
- #+findex: org-agenda-reset-view
- #+vindex: org-agenda-span
- Reset the current view to ~org-agenda-span~.
+ #+kindex: v SPC
+ #+findex: org-agenda-reset-view
+ #+vindex: org-agenda-span
+ Reset the current view to ~org-agenda-span~.
- {{{kbd(f)}}} (~org-agenda-later~) ::
- #+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.
+ #+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.
- {{{kbd(b)}}} (~org-agenda-earlier~) ::
- #+kindex: b
- #+findex: org-agenda-earlier
- Go backward in time to display earlier dates.
+ #+kindex: b
+ #+findex: org-agenda-earlier
+ Go backward in time to display earlier dates.
- {{{kbd(.)}}} (~org-agenda-goto-today~) ::
- #+kindex: .
- #+findex: org-agenda-goto-today
- Go to today.
+ #+kindex: .
+ #+findex: org-agenda-goto-today
+ Go to today.
- {{{kbd(j)}}} (~org-agenda-goto-date~) ::
- #+kindex: j
- #+findex: org-agenda-goto-date
- Prompt for a date and go there.
+ #+kindex: j
+ #+findex: org-agenda-goto-date
+ Prompt for a date and go there.
- {{{kbd(J)}}} (~org-agenda-clock-goto~) ::
- #+kindex: J
- #+findex: org-agenda-clock-goto
- Go to the currently clocked-in task /in the agenda buffer/.
+ #+kindex: J
+ #+findex: org-agenda-clock-goto
+ Go to the currently clocked-in task /in the agenda buffer/.
- {{{kbd(D)}}} (~org-agenda-toggle-diary~) ::
- #+kindex: D
- #+findex: org-agenda-toggle-diary
- Toggle the inclusion of diary entries. See [[*Weekly/daily agenda]].
+ #+kindex: D
+ #+findex: org-agenda-toggle-diary
+ Toggle the inclusion of diary entries. See [[*Weekly/daily agenda]].
- {{{kbd(v l)}}} or {{{kbd(v L)}}} or short {{{kbd(l)}}} (~org-agenda-log-mode~) ::
- #+kindex: v l
- #+kindex: l
- #+kindex: v L
- #+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 ~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
- ~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)}}}.
+ #+kindex: v l
+ #+kindex: l
+ #+kindex: v L
+ #+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 ~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 ~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)}}}.
- {{{kbd(v [)}}} or short {{{kbd([)}}} (~org-agenda-manipulate-query-add~) ::
- #+kindex: v [
- #+kindex: [
- #+findex: org-agenda-manipulate-query-add
- Include inactive timestamps into the current view. Only for
- weekly/daily agenda.
+ #+kindex: v [
+ #+kindex: [
+ #+findex: org-agenda-manipulate-query-add
+ Include inactive timestamps into the current view. Only for
+ weekly/daily agenda.
- {{{kbd(v a)}}} (~org-agenda-archives-mode~) ::
- #+kindex: v a
- #+findex: org-agenda-archives-mode
- Toggle Archives mode. In Archives mode, trees that are archived
- (see [[*Internal archiving]]) are also scanned when producing the
- agenda. To exit archives mode, press {{{kbd(v a)}}} again.
+ #+kindex: v a
+ #+findex: org-agenda-archives-mode
+ Toggle Archives mode. In Archives mode, trees that are archived
+ (see [[*Internal archiving]]) are also scanned when producing the
+ agenda. To exit archives mode, press {{{kbd(v a)}}} again.
- {{{kbd(v A)}}} ::
- #+kindex: v A
- Toggle Archives mode. Include all archive files as well.
+ #+kindex: v A
+ Toggle Archives mode. Include all archive files as well.
- {{{kbd(v R)}}} or short {{{kbd(R)}}} (~org-agenda-clockreport-mode~) ::
- #+kindex: v R
- #+kindex: R
- #+findex: org-agenda-clockreport-mode
- #+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 ~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[fn:98]. See also the
- variable ~org-clock-report-include-clocking-task~.
+ #+kindex: v R
+ #+kindex: R
+ #+findex: org-agenda-clockreport-mode
+ #+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 ~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[fn:98]. See also the variable
+ ~org-clock-report-include-clocking-task~.
- {{{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
- ~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.
+ #+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
+ ~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.
- {{{kbd(v E)}}} or short {{{kbd(E)}}} (~org-agenda-entry-text-mode~) ::
- #+kindex: v E
- #+kindex: E
- #+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 ~org-agenda-entry-text-maxlines~. Calling this
- command with a numeric prefix argument temporarily modifies that
- number to the prefix value.
+ #+kindex: v E
+ #+kindex: E
+ #+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 ~org-agenda-entry-text-maxlines~. Calling this command
+ with a numeric prefix argument temporarily modifies that number to
+ the prefix value.
- {{{kbd(G)}}} (~org-agenda-toggle-time-grid~) ::
- #+kindex: G
- #+vindex: org-agenda-use-time-grid
- #+vindex: org-agenda-time-grid
- Toggle the time grid on and off. See also the variables
- ~org-agenda-use-time-grid~ and ~org-agenda-time-grid~.
+ #+kindex: G
+ #+vindex: org-agenda-use-time-grid
+ #+vindex: org-agenda-time-grid
+ Toggle the time grid on and off. See also the variables
+ ~org-agenda-use-time-grid~ and ~org-agenda-time-grid~.
- {{{kbd(r)}}} (~org-agenda-redo~), {{{kbd(g)}}} ::
- #+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-LEFT)}}} and {{{kbd(S-RIGHT)}}}. When the
- buffer is the global TODO list, a prefix argument is interpreted
- to create a selective list for a specific TODO keyword.
+ #+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-LEFT)}}} and
+ {{{kbd(S-RIGHT)}}}. When the buffer is the global TODO list,
+ a prefix argument is interpreted to create a selective list for
+ a specific TODO keyword.
- {{{kbd(C-x C-s)}}} or short {{{kbd(s)}}} (~org-save-all-org-buffers~) ::
- #+kindex: C-x C-s
- #+findex: org-save-all-org-buffers
- #+kindex: s
- Save all Org buffers in the current Emacs session, and also the
- locations of IDs.
+ #+kindex: C-x C-s
+ #+findex: org-save-all-org-buffers
+ #+kindex: s
+ Save all Org buffers in the current Emacs session, and also the
+ locations of IDs.
- {{{kbd(C-c C-x C-c)}}} (~org-agenda-columns~) ::
- #+kindex: C-c C-x C-c
- #+findex: org-agenda-columns
- #+vindex: org-columns-default-format
- Invoke column view (see [[*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 =COLUMNS= keyword, or from
- the default variable ~org-columns-default-format~) is used in the
- agenda.
+ #+kindex: C-c C-x C-c
+ #+findex: org-agenda-columns
+ #+vindex: org-columns-default-format
+ Invoke column view (see [[*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 =COLUMNS= keyword, or from the
+ default variable ~org-columns-default-format~) is used in the
+ agenda.
- {{{kbd(C-c C-x >)}}} (~org-agenda-remove-restriction-lock~) ::
- #+kindex: C-c C-x >
- #+findex: org-agenda-remove-restriction-lock
- Remove the restriction lock on the agenda, if it is currently
- restricted to a file or subtree (see [[*Agenda Files]]).
+ #+kindex: C-c C-x >
+ #+findex: org-agenda-remove-restriction-lock
+ Remove the restriction lock on the agenda, if it is currently
+ restricted to a file or subtree (see [[*Agenda Files]]).
- {{{kbd(M-UP)}}} (~org-agenda-drag-line-backward~) ::
- #+kindex: M-UP
- #+findex: org-agenda-drag-line-backward
- Drag the line at point backward one line. With a numeric prefix
- argument, drag backward by that many lines.
+ #+kindex: M-UP
+ #+findex: org-agenda-drag-line-backward
+ Drag the line at point backward one line. With a numeric prefix
+ argument, drag backward by that many lines.
- Moving agenda lines does not persist after an agenda refresh and
- does not modify the contributing Org files.
+ Moving agenda lines does not persist after an agenda refresh and
+ does not modify the contributing Org files.
- {{{kbd(M-DOWN)}}} (~org-agenda-drag-line-forward~) ::
- #+kindex: M-DOWN
- #+findex: org-agenda-drag-line-forward
- Drag the line at point forward one line. With a numeric prefix
- argument, drag forward by that many lines.
+ #+kindex: M-DOWN
+ #+findex: org-agenda-drag-line-forward
+ Drag the line at point forward one line. With a numeric prefix
+ argument, drag forward by that many lines.
*** Remote editing
:PROPERTIES:
@@ -9666,225 +9611,225 @@ the other commands, point needs to be in the desired line.
- {{{kbd(0--9)}}} ::
- Digit argument.
+ Digit argument.
- {{{kbd(C-_)}}} (~org-agenda-undo~) ::
- #+kindex: C-_
- #+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.
+ #+kindex: C-_
+ #+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.
- {{{kbd(t)}}} (~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.
+ #+kindex: t
+ #+findex: org-agenda-todo
+ Change the TODO state of the item, both in the agenda and in the
+ original Org file.
- {{{kbd(C-S-RIGHT)}}} (~org-agenda-todo-nextset~) ::
- #+kindex: C-S-RIGHT
- #+findex: org-agenda-todo-nextset
- Switch to the next set of TODO keywords.
+ #+kindex: C-S-RIGHT
+ #+findex: org-agenda-todo-nextset
+ Switch to the next set of TODO keywords.
- {{{kbd(C-S-LEFT)}}}, ~org-agenda-todo-previousset~ ::
- #+kindex: C-S-LEFT
- Switch to the previous set of TODO keywords.
+ #+kindex: C-S-LEFT
+ Switch to the previous set of TODO keywords.
- {{{kbd(C-k)}}} (~org-agenda-kill~) ::
- #+kindex: C-k
- #+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 ~org-agenda-confirm-kill~.
+ #+kindex: C-k
+ #+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 ~org-agenda-confirm-kill~.
- {{{kbd(C-c C-w)}}} (~org-agenda-refile~) ::
- #+kindex: C-c C-w
- #+findex: org-agenda-refile
- Refile the entry at point.
+ #+kindex: C-c C-w
+ #+findex: org-agenda-refile
+ Refile the entry at point.
- {{{kbd(C-c C-x C-a)}}} or short {{{kbd(a)}}} (~org-agenda-archive-default-with-confirmation~) ::
- #+kindex: C-c C-x C-a
- #+kindex: a
- #+findex: org-agenda-archive-default-with-confirmation
- #+vindex: org-archive-default-command
- Archive the subtree corresponding to the entry at point using the
- default archiving command set in ~org-archive-default-command~.
- When using the {{{kbd(a)}}} key, confirmation is required.
+ #+kindex: C-c C-x C-a
+ #+kindex: a
+ #+findex: org-agenda-archive-default-with-confirmation
+ #+vindex: org-archive-default-command
+ Archive the subtree corresponding to the entry at point using the
+ default archiving command set in ~org-archive-default-command~.
+ When using the {{{kbd(a)}}} key, confirmation is required.
- {{{kbd(C-c C-x a)}}} (~org-agenda-toggle-archive-tag~) ::
- #+kindex: C-c C-x a
- #+findex: org-agenda-toggle-archive-tag
- Toggle the archive tag (see [[*Internal archiving]]) for the current
- headline.
+ #+kindex: C-c C-x a
+ #+findex: org-agenda-toggle-archive-tag
+ Toggle the archive tag (see [[*Internal archiving]]) for the current
+ headline.
- {{{kbd(C-c C-x A)}}} (~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
- /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 /archive
+ sibling/.
- {{{kbd(C-c C-x C-s)}}} or short {{{kbd($)}}} (~org-agenda-archive~) ::
- #+kindex: C-c C-x C-s
- #+kindex: $
- #+findex: org-agenda-archive
- Archive the subtree corresponding to the current headline. This
- means the entry is moved to the configured archive location, most
- likely a different file.
+ #+kindex: C-c C-x C-s
+ #+kindex: $
+ #+findex: org-agenda-archive
+ Archive the subtree corresponding to the current headline. This
+ means the entry is moved to the configured archive location, most
+ likely a different file.
- {{{kbd(T)}}} (~org-agenda-show-tags~) ::
- #+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 ~org-agenda-show-inherited-tags~, but
- still want to see all tags of a headline occasionally.
+ #+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 ~org-agenda-show-inherited-tags~, but still want
+ to see all tags of a headline occasionally.
- {{{kbd(:)}}} (~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.
+ #+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.
- {{{kbd(\,)}}} (~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(SPC)}}}, the
- priority cookie is removed from the entry.
+ #+kindex: ,
+ #+findex: org-agenda-priority
+ Set the priority for the current item. Org mode prompts for the
+ priority character. If you reply with {{{kbd(SPC)}}}, the priority
+ cookie is removed from the entry.
- {{{kbd(P)}}} (~org-agenda-show-priority~) ::
- #+kindex: P
- #+findex: org-agenda-show-priority
- Display weighted priority of current item.
+ #+kindex: P
+ #+findex: org-agenda-show-priority
+ Display weighted priority of current item.
- {{{kbd(+)}}} or {{{kbd(S-UP)}}} (~org-agenda-priority-up~) ::
- #+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.
+ #+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.
- {{{kbd(-)}}} or {{{kbd(S-DOWN)}}} (~org-agenda-priority-down~) ::
- #+kindex: -
- #+kindex: S-DOWN
- #+findex: org-agenda-priority-down
- Decrease the priority of the current item.
+ #+kindex: -
+ #+kindex: S-DOWN
+ #+findex: org-agenda-priority-down
+ Decrease the priority of the current item.
- {{{kbd(C-c C-z)}}} or short {{{kbd(z)}}} (~org-agenda-add-note~) ::
- #+kindex: z
- #+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 ~org-log-into-drawer~, this may be inside a drawer.
+ #+kindex: z
+ #+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
+ ~org-log-into-drawer~, this may be inside a drawer.
- {{{kbd(C-c C-a)}}} (~org-attach~) ::
- #+kindex: C-c C-a
- #+findex: org-attach
- Dispatcher for all command related to attachments.
+ #+kindex: C-c C-a
+ #+findex: org-attach
+ Dispatcher for all command related to attachments.
- {{{kbd(C-c C-s)}}} (~org-agenda-schedule~) ::
- #+kindex: C-c C-s
- #+findex: org-agenda-schedule
- Schedule this item. With a prefix argument, remove the
- scheduling timestamp
+ #+kindex: C-c C-s
+ #+findex: org-agenda-schedule
+ Schedule this item. With a prefix argument, remove the
+ scheduling timestamp
- {{{kbd(C-c C-d)}}} (~org-agenda-deadline~) ::
- #+kindex: C-c C-d
- #+findex: org-agenda-deadline
- Set a deadline for this item. With a prefix argument, remove the
- deadline.
+ #+kindex: C-c C-d
+ #+findex: org-agenda-deadline
+ Set a deadline for this item. With a prefix argument, remove the
+ deadline.
- {{{kbd(S-RIGHT)}}} (~org-agenda-do-date-later~) ::
- #+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-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.
+ #+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-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.
- {{{kbd(S-LEFT)}}} (~org-agenda-do-date-earlier~) ::
- #+kindex: S-LEFT
- #+findex: org-agenda-do-date-earlier
- Change the timestamp associated with the current line by one day
- into the past.
+ #+kindex: S-LEFT
+ #+findex: org-agenda-do-date-earlier
+ Change the timestamp associated with the current line by one day
+ into the past.
- {{{kbd(>)}}} (~org-agenda-date-prompt~) ::
- #+kindex: >
- #+findex: org-agenda-date-prompt
- Change the timestamp associated with the current line. The key
- {{{kbd(>)}}} has been chosen, because it is the same as
- {{{kbd(S-.)}}} on my keyboard.
+ #+kindex: >
+ #+findex: org-agenda-date-prompt
+ Change the timestamp associated with the current line. The key
+ {{{kbd(>)}}} has been chosen, because it is the same as
+ {{{kbd(S-.)}}} on my keyboard.
- {{{kbd(I)}}} (~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.
+ #+kindex: I
+ #+findex: org-agenda-clock-in
+ Start the clock on the current item. If a clock is running already,
+ it is stopped first.
- {{{kbd(O)}}} (~org-agenda-clock-out~) ::
- #+kindex: O
- #+findex: org-agenda-clock-out
- Stop the previously started clock.
+ #+kindex: O
+ #+findex: org-agenda-clock-out
+ Stop the previously started clock.
- {{{kbd(X)}}} (~org-agenda-clock-cancel~) ::
- #+kindex: X
- #+findex: org-agenda-clock-cancel
- Cancel the currently running clock.
+ #+kindex: X
+ #+findex: org-agenda-clock-cancel
+ Cancel the currently running clock.
- {{{kbd(J)}}} (~org-agenda-clock-goto~) ::
- #+kindex: J
- #+findex: org-agenda-clock-goto
- Jump to the running clock in another window.
+ #+kindex: J
+ #+findex: org-agenda-clock-goto
+ Jump to the running clock in another window.
- {{{kbd(k)}}} (~org-agenda-capture~) ::
- #+kindex: k
- #+findex: org-agenda-capture
- #+cindex: capturing, from agenda
- #+vindex: org-capture-use-agenda-date
- Like ~org-capture~, but use the date at point as the default date
- for the capture template. See ~org-capture-use-agenda-date~ to
- make this the default behavior of ~org-capture~.
+ #+kindex: k
+ #+findex: org-agenda-capture
+ #+cindex: capturing, from agenda
+ #+vindex: org-capture-use-agenda-date
+ Like ~org-capture~, but use the date at point as the default date
+ for the capture template. See ~org-capture-use-agenda-date~ to make
+ this the default behavior of ~org-capture~.
*** Bulk remote editing selected entries
:PROPERTIES:
@@ -9894,128 +9839,127 @@ the other commands, point needs to be in the desired line.
#+vindex: org-agenda-bulk-custom-functions
- {{{kbd(m)}}} (~org-agenda-bulk-mark~) ::
- #+kindex: m
- #+findex: org-agenda-bulk-mark
+ #+kindex: m
+ #+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.
+ 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.
- {{{kbd(*)}}} (~org-agenda-bulk-mark-all~) ::
- #+kindex: *
- #+findex: org-agenda-bulk-mark-all
+ #+kindex: *
+ #+findex: org-agenda-bulk-mark-all
- Mark all visible agenda entries for bulk action.
+ Mark all visible agenda entries for bulk action.
- {{{kbd(u)}}} (~org-agenda-bulk-unmark~) ::
- #+kindex: u
- #+findex: org-agenda-bulk-unmark
+ #+kindex: u
+ #+findex: org-agenda-bulk-unmark
- Unmark entry for bulk action.
+ Unmark entry for bulk action.
- {{{kbd(U)}}} (~org-agenda-bulk-remove-all-marks~) ::
- #+kindex: U
- #+findex: org-agenda-bulk-remove-all-marks
+ #+kindex: U
+ #+findex: org-agenda-bulk-remove-all-marks
- Unmark all marked entries for bulk action.
+ Unmark all marked entries for bulk action.
- {{{kbd(M-m)}}} (~org-agenda-bulk-toggle~) ::
- #+kindex: M-m
- #+findex: org-agenda-bulk-toggle
+ #+kindex: M-m
+ #+findex: org-agenda-bulk-toggle
- Toggle mark of the entry at point for bulk action.
+ Toggle mark of the entry at point for bulk action.
- {{{kbd(M-*)}}} (~org-agenda-bulk-toggle-all~) ::
- #+kindex: M-*
- #+findex: org-agenda-bulk-toggle-all
+ #+kindex: M-*
+ #+findex: org-agenda-bulk-toggle-all
- Toggle mark of every entry for bulk action.
+ Toggle mark of every entry for bulk action.
- {{{kbd(%)}}} (~org-agenda-bulk-mark-regexp~) ::
- #+kindex: %
- #+findex: org-agenda-bulk-mark-regexp
+ #+kindex: %
+ #+findex: org-agenda-bulk-mark-regexp
- Mark entries matching a regular expression for bulk action.
+ Mark entries matching a regular expression for bulk action.
- {{{kbd(B)}}} (~org-agenda-bulk-action~) ::
- #+kindex: B
- #+findex: org-agenda-bulk-action
- #+vindex: org-agenda-bulk-persistent-marks
+ #+kindex: B
+ #+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
- ~org-agenda-bulk-persistent-marks~ to ~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 ~org-agenda-bulk-persistent-marks~ to ~t~ or hit
+ {{{kbd(p)}}} at the prompt.
- - {{{kbd(*)}}} ::
+ - {{{kbd(*)}}} ::
- Toggle persistent marks.
+ Toggle persistent marks.
- - {{{kbd($)}}} ::
+ - {{{kbd($)}}} ::
- Archive all selected entries.
+ Archive all selected entries.
- - {{{kbd(A)}}} ::
+ - {{{kbd(A)}}} ::
- Archive entries by moving them to their respective archive
- siblings.
+ Archive entries by moving them to their respective archive
+ siblings.
- - {{{kbd(t)}}} ::
+ - {{{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.
+ 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.
- - {{{kbd(+)}}} ::
+ - {{{kbd(+)}}} ::
- Add a tag to all selected entries.
+ Add a tag to all selected entries.
- - {{{kbd(-)}}} ::
+ - {{{kbd(-)}}} ::
- Remove a tag from all selected entries.
+ Remove a tag from all selected entries.
- - {{{kbd(s)}}} ::
+ - {{{kbd(s)}}} ::
- Schedule all items to a new date. To shift existing schedule
- dates by a fixed number of days, use something starting with
- double plus at the prompt, for example =++8d= or =++2w=.
+ Schedule all items to a new date. To shift existing schedule
+ dates by a fixed number of days, use something starting with
+ double plus at the prompt, for example =++8d= or =++2w=.
- - {{{kbd(d)}}} ::
+ - {{{kbd(d)}}} ::
- Set deadline to a specific date.
+ Set deadline to a specific date.
- - {{{kbd(r)}}} ::
+ - {{{kbd(r)}}} ::
- Prompt for a single refile target and move all entries. The
- entries are no longer in the agenda; refresh ({{{kbd(g)}}}) to
- bring them back.
+ Prompt for a single refile target and move all entries. The
+ entries are no longer in the agenda; refresh ({{{kbd(g)}}}) to
+ bring them back.
- - {{{kbd(S)}}} ::
+ - {{{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.
+ Reschedule randomly into the coming N days. N is prompted for.
+ With a prefix argument ({{{kbd(C-u B S)}}}), scatter only across
+ weekdays.
- - {{{kbd(f)}}} ::
+ - {{{kbd(f)}}} ::
- #+vindex: org-agenda-bulk-custom-functions
- Apply a function[fn:99] to marked entries. For example, the
- function below sets the =CATEGORY= property of the entries to
- =web=.
+ #+vindex: org-agenda-bulk-custom-functions
+ Apply a function[fn:99] to marked entries. For example, the
+ function below sets the =CATEGORY= property of the entries to
+ =web=.
- #+begin_src emacs-lisp
- (defun set-category ()
- (interactive "P")
- (let ((marker (or (org-get-at-bol 'org-hd-marker)
- (org-agenda-error))))
- (org-with-point-at marker
- (org-back-to-heading t)
- (org-set-property "CATEGORY" "web"))))
- #+end_src
+ #+begin_src emacs-lisp
+ (defun set-category ()
+ (interactive "P")
+ (let ((marker (or (org-get-at-bol 'org-hd-marker)
+ (org-agenda-error))))
+ (org-with-point-at marker
+ (org-back-to-heading t)
+ (org-set-property "CATEGORY" "web"))))
+ #+end_src
*** Calendar commands
:PROPERTIES:
@@ -10025,69 +9969,67 @@ the other commands, point needs to be in the desired line.
- {{{kbd(c)}}} (~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.
+ #+kindex: c
+ #+findex: org-agenda-goto-calendar
+ Open the Emacs calendar and go to the date at point in the agenda.
- {{{kbd(c)}}} (~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.
+ #+kindex: c
+ #+findex: org-calendar-goto-agenda
+ When in the calendar, compute and show the Org agenda for the date
+ at point.
- {{{kbd(i)}}} (~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[fn:100], 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 ~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 =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
- ~org-agenda-diary-file~ without further interaction. If you
- directly press {{{kbd(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.
+ #+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[fn:100], 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 ~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 =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 ~org-agenda-diary-file~ without further
+ interaction. If you directly press {{{kbd(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.
- {{{kbd(M)}}} (~org-agenda-phases-of-moon~) ::
- #+kindex: M
- #+findex: org-agenda-phases-of-moon
- Show the phases of the moon for the three months around current
- date.
+ #+kindex: M
+ #+findex: org-agenda-phases-of-moon
+ Show the phases of the moon for the three months around current
+ date.
- {{{kbd(S)}}} (~org-agenda-sunrise-sunset~) ::
- #+kindex: S
- #+findex: org-agenda-sunrise-sunset
- Show sunrise and sunset times. The geographical location must be
- set with calendar variables, see the documentation for the Emacs
- calendar.
+ #+kindex: S
+ #+findex: org-agenda-sunrise-sunset
+ Show sunrise and sunset times. The geographical location must be
+ set with calendar variables, see the documentation for the Emacs
+ calendar.
- {{{kbd(C)}}} (~org-agenda-convert-date~) ::
- #+kindex: C
- #+findex: org-agenda-convert-date
- Convert the date at point into many other cultural and historic
- calendars.
+ #+kindex: C
+ #+findex: org-agenda-convert-date
+ Convert the date at point into many other cultural and historic
+ calendars.
- {{{kbd(H)}}} (~org-agenda-holidays~) ::
- #+kindex: H
- #+findex: org-agenda-holidays
- Show holidays for three months around point date.
+ #+kindex: H
+ #+findex: org-agenda-holidays
+ Show holidays for three months around point date.
*** Quit and exit
:PROPERTIES:
@@ -10095,19 +10037,19 @@ the other commands, point needs to be in the desired line.
:END:
- {{{kbd(q)}}} (~org-agenda-quit~) ::
- #+kindex: q
- #+findex: org-agenda-quit
+ #+kindex: q
+ #+findex: org-agenda-quit
- Quit agenda, remove the agenda buffer.
+ Quit agenda, remove the agenda buffer.
- {{{kbd(x)}}} (~org-agenda-exit~) ::
- #+kindex: x
- #+findex: org-agenda-exit
+ #+kindex: x
+ #+findex: org-agenda-exit
- #+cindex: agenda files, removing buffers
- Exit agenda, remove the agenda buffer and all buffers loaded by
- Emacs for the compilation of the agenda. Buffers created by the
- user to visit Org files are not removed.
+ #+cindex: agenda files, removing buffers
+ Exit agenda, remove the agenda buffer and all buffers loaded by
+ Emacs for the compilation of the agenda. Buffers created by the
+ user to visit Org files are not removed.
** Custom Agenda Views
:PROPERTIES:
@@ -10178,50 +10120,48 @@ above will therefore define:
- {{{kbd(x)}}} ::
- as a global search for agenda entries planned[fn:102] this
- week/day.
+ as a global search for agenda entries planned[fn:102] this week/day.
- {{{kbd(y)}}} ::
- as the same search, but only for entries with an hour
- specification like =[h]h:mm=---think of them as appointments.
+ as the same search, but only for entries with an hour specification
+ like =[h]h:mm=---think of them as appointments.
- {{{kbd(w)}}} ::
- as a global search for TODO entries with =WAITING= as the TODO
- keyword.
+ as a global search for TODO entries with =WAITING= as the TODO
+ keyword.
- {{{kbd(W)}}} ::
- as the same search, but only in the current buffer and displaying
- the results as a sparse tree.
+ as the same search, but only in the current buffer and displaying
+ the results as a sparse tree.
- {{{kbd(u)}}} ::
- as a global tags search for headlines tagged =boss= but not
- =urgent=.
+ as a global tags search for headlines tagged =boss= but not
+ =urgent=.
- {{{kbd(v)}}} ::
- The same search, but limiting it to headlines that are also TODO
- items.
+ The same search, but limiting it to headlines that are also TODO
+ items.
- {{{kbd(U)}}} ::
- as the same search, but only in the current buffer and displaying
- the result as a sparse tree.
+ as the same search, but only in the current buffer and displaying
+ the result as a sparse tree.
- {{{kbd(f)}}} ::
- to create a sparse tree (again, current buffer only) with all
- entries containing the word =FIXME=.
+ to create a sparse tree (again, current buffer only) with all
+ entries containing the word =FIXME=.
- {{{kbd(h)}}} ::
- as a prefix command for a =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 =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.
Note that ~*-tree~ agenda views need to be called from an Org buffer
as they operate on the current buffer only.
@@ -10365,13 +10305,13 @@ PDF[fn:104], and iCalendar files. If you want to do this only
occasionally, use the following command:
- {{{kbd(C-x C-w)}}} (~org-agenda-write~) ::
- #+kindex: C-x C-w
- #+findex: org-agenda-write
- #+cindex: exporting agenda views
- #+cindex: agenda views, exporting
+ #+kindex: C-x C-w
+ #+findex: org-agenda-write
+ #+cindex: exporting agenda views
+ #+cindex: agenda views, exporting
- #+vindex: org-agenda-exporter-settings
- Write the agenda view to a file.
+ #+vindex: org-agenda-exporter-settings
+ Write the agenda view to a file.
If you need to export certain agenda views frequently, you can
associate any custom agenda command with a list of output file
@@ -10415,10 +10355,10 @@ files in one step:
- {{{kbd(e)}}} (~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.
+ #+kindex: e @r{(Agenda dispatcher)}
+ #+findex: org-store-agenda-views
+ Export all agenda views that have export file names associated with
+ them.
You can use the options section of the custom agenda commands to also
set options for the export commands. For example:
@@ -10496,10 +10436,10 @@ can be quite useful to use column view also from the agenda, where
entries are collected by certain criteria.
- {{{kbd(C-c C-x C-c)}}} (~org-agenda-columns~) ::
- #+kindex: C-c C-x C-c
- #+findex: org-agenda-columns
+ #+kindex: C-c C-x C-c
+ #+findex: org-agenda-columns
- Turn on column view in the agenda.
+ Turn on column view in the agenda.
To understand how to use this properly, it is important to realize
that the entries in the agenda are no longer in their proper outline
@@ -10665,9 +10605,9 @@ change this convention. For example, when setting this variable to
- {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) ::
- #+kindex: C-c C-x \
- #+findex: org-toggle-pretty-entities
- This command formats sub- and superscripts in a WYSIWYM way.
+ #+kindex: C-c C-x \
+ #+findex: org-toggle-pretty-entities
+ This command formats sub- and superscripts in a WYSIWYM way.
** Special Symbols
:PROPERTIES:
@@ -10707,12 +10647,12 @@ If you would like to see entities displayed as UTF-8 characters, use
the following command[fn:107]:
- {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) ::
- #+kindex: C-c C-x \
- #+findex: org-toggle-pretty-entities
+ #+kindex: C-c C-x \
+ #+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.
+ 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.
#+cindex: shy hyphen, special symbol
#+cindex: dash, special symbol
@@ -10816,7 +10756,7 @@ images.
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.
+ 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
@@ -10859,51 +10799,51 @@ more details see the documentation of CDLaTeX mode):
#+attr_texinfo: :sep ,
- {{{kbd(C-c {)}}} ::
- #+kindex: C-c @{
+ #+kindex: C-c @{
- Insert an environment template.
+ Insert an environment template.
- {{{kbd(TAB)}}} ::
- #+kindex: TAB
+ #+kindex: TAB
- The {{{kbd(TAB)}}} key expands the template if point is inside
- a LaTeX fragment[fn:112]. For example, {{{kbd(TAB)}}} expands
- =fr= to =\frac{}{}= and position point correctly inside the first
- brace. Another {{{kbd(TAB)}}} gets you into the second brace.
+ The {{{kbd(TAB)}}} key expands the template if point is inside
+ a LaTeX fragment[fn:112]. For example, {{{kbd(TAB)}}} expands =fr=
+ to =\frac{}{}= and position point correctly inside the first brace.
+ Another {{{kbd(TAB)}}} gets you into the second brace.
- Even outside fragments, {{{kbd(TAB)}}} expands environment
- abbreviations at the beginning of a line. For example, if you
- write =equ= at the beginning of a line and press {{{kbd(TAB)}}},
- this abbreviation is expanded to an =equation= environment. To
- get a list of all abbreviations, type {{{kbd(M-x
- cdlatex-command-help)}}}.
+ Even outside fragments, {{{kbd(TAB)}}} expands environment
+ abbreviations at the beginning of a line. For example, if you write
+ =equ= at the beginning of a line and press {{{kbd(TAB)}}}, this
+ abbreviation is expanded to an =equation= environment. To get
+ a list of all abbreviations, type {{{kbd(M-x
+ cdlatex-command-help)}}}.
- {{{kbd(^)}}}, {{{kbd(_)}}} ::
- #+kindex: _
- #+kindex: ^
- #+vindex: cdlatex-simplify-sub-super-scripts
+ #+kindex: _
+ #+kindex: ^
+ #+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(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 ~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(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 ~cdlatex-simplify-sub-super-scripts~).
- {{{kbd(`)}}} ::
- #+kindex: `
+ #+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.
- {{{kbd(')}}} ::
- #+kindex: '
+ #+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.
** Literal Examples
:PROPERTIES:
@@ -11016,16 +10956,16 @@ a shortcut is provided (see [[*Structure Templates]]).
- {{{kbd(C-c ')}}} (~org-edit-special~) ::
- #+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[fn:116]. 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~[fn:117] to
- allow creating ASCII drawings easily. Using this command in an
- empty line creates a new fixed-width region.
+ #+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[fn:116]. 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~[fn:117] to allow
+ creating ASCII drawings easily. Using this command in an empty line
+ creates a new fixed-width region.
#+cindex: storing link, in a source code buffer
Calling ~org-store-link~ (see [[*Handling Links]]) while editing a source
@@ -11064,14 +11004,14 @@ command:
- {{{kbd(C-c C-x C-v)}}} (~org-toggle-inline-images~) ::
- #+kindex: C-c C-x C-v
- #+findex: org-toggle-inline-images
- #+vindex: org-startup-with-inline-images
- Toggle the inline display of linked images. When called with
- a prefix argument, also display images that do have a link
- description. You can ask for inline images to be displayed at
- startup by configuring the variable
- ~org-startup-with-inline-images~[fn:119].
+ #+kindex: C-c C-x C-v
+ #+findex: org-toggle-inline-images
+ #+vindex: org-startup-with-inline-images
+ Toggle the inline display of linked images. When called with
+ a prefix argument, also display images that do have a link
+ description. You can ask for inline images to be displayed at
+ startup by configuring the variable
+ ~org-startup-with-inline-images~[fn:119].
** Captions
:PROPERTIES:
@@ -11170,13 +11110,12 @@ a non-~nil~ value, Org prompts in the minibuffer. To switch back to
the hierarchical menu, press {{{kbd(?)}}}.
- {{{kbd(C-c C-e)}}} (~org-export~) ::
- #+kindex: C-c C-e
- #+findex: org-export
+ #+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.
Org exports the entire buffer by default. If the Org buffer has an
active region, then Org exports just that region.
@@ -11185,53 +11124,53 @@ Within the dispatcher interface, the following key combinations can
further alter what is exported, and how.
- {{{kbd(C-a)}}} ::
- #+kindex: C-c C-e C-a
+ #+kindex: C-c C-e C-a
- Toggle asynchronous export. Asynchronous export uses an external
- 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.
+ Toggle asynchronous export. Asynchronous export uses an external
+ 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 /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 /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
- ~org-export-in-background~.
+ #+vindex: org-export-in-background
+ You can make asynchronous export the default by setting
+ ~org-export-in-background~.
- #+vindex: org-export-async-init-file
- You can set the initialization file used by the background process
- by setting ~org-export-async-init-file~.
+ #+vindex: org-export-async-init-file
+ You can set the initialization file used by the background process
+ by setting ~org-export-async-init-file~.
- {{{kbd(C-b)}}} ::
- #+kindex: C-c C-e 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 =<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 =<head>...</head>= in HTML.
- {{{kbd(C-s)}}} ::
- #+kindex: C-c C-e 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.
+ 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.
- #+vindex: org-export-initial-scope
- To make sub-tree export the default, customize the variable
- ~org-export-initial-scope~.
+ #+vindex: org-export-initial-scope
+ To make sub-tree export the default, customize the variable
+ ~org-export-initial-scope~.
- {{{kbd(C-v)}}} ::
- #+kindex: C-c C-e 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.
** Export Settings
:PROPERTIES:
@@ -11263,73 +11202,72 @@ global variables, include:
- =AUTHOR= ::
- #+cindex: @samp{AUTHOR}, keyword
- #+vindex: user-full-name
- The document author (~user-full-name~).
+ #+cindex: @samp{AUTHOR}, keyword
+ #+vindex: user-full-name
+ The document author (~user-full-name~).
- =CREATOR= ::
- #+cindex: @samp{CREATOR}, keyword
- #+vindex: org-expot-creator-string
- Entity responsible for output generation
- (~org-export-creator-string~).
+ #+cindex: @samp{CREATOR}, keyword
+ #+vindex: org-expot-creator-string
+ Entity responsible for output generation
+ (~org-export-creator-string~).
- =DATE= ::
- #+cindex: @samp{DATE}, keyword
- #+vindex: org-export-date-timestamp-format
- A date or a time-stamp[fn:120].
+ #+cindex: @samp{DATE}, keyword
+ #+vindex: org-export-date-timestamp-format
+ A date or a time-stamp[fn:120].
- =EMAIL= ::
- #+cindex: @samp{EMAIL}, keyword
- #+vindex: user-mail-address
- The email address (~user-mail-address~).
+ #+cindex: @samp{EMAIL}, keyword
+ #+vindex: user-mail-address
+ The email address (~user-mail-address~).
- =LANGUAGE= ::
- #+cindex: @samp{LANGUAGE}, keyword
- #+vindex: org-export-default-language
- Language to use for translating certain strings
- (~org-export-default-language~). With =#+LANGUAGE: fr=, for
- example, Org translates =Table of contents= to the French =Table
- des matières=[fn:121].
+ #+cindex: @samp{LANGUAGE}, keyword
+ #+vindex: org-export-default-language
+ Language to use for translating certain strings
+ (~org-export-default-language~). With =#+LANGUAGE: fr=, for
+ example, Org translates =Table of contents= to the French =Table des
+ matières=[fn:121].
- =SELECT_TAGS= ::
- #+cindex: @samp{SELECT_TAGS}, keyword
- #+vindex: org-export-select-tags
- The default value is =("export")=. When a tree is tagged with
- =export= (~org-export-select-tags~), Org selects that tree and
- its sub-trees for export. Org excludes trees with =noexport=
- tags, see below. When selectively exporting files with =export=
- tags set, Org does not export any text that appears before the
- first headline.
+ #+cindex: @samp{SELECT_TAGS}, keyword
+ #+vindex: org-export-select-tags
+ The default value is =("export")=. When a tree is tagged with
+ =export= (~org-export-select-tags~), Org selects that tree and its
+ sub-trees for export. Org excludes trees with =noexport= tags, see
+ below. When selectively exporting files with =export= tags set, Org
+ does not export any text that appears before the first headline.
- =EXCLUDE_TAGS= ::
- #+cindex: @samp{EXCLUDE_TAGS}, keyword
- #+vindex: org-export-exclude-tags
- The default value is =("noexport")=. When a tree is tagged with
- =noexport= (~org-export-exclude-tags~), Org excludes that tree
- and its sub-trees from export. Entries tagged with =noexport=
- are unconditionally excluded from the export, even if they have
- an =export= tag. Even if a sub-tree is not exported, Org
- executes any code blocks contained there.
+ #+cindex: @samp{EXCLUDE_TAGS}, keyword
+ #+vindex: org-export-exclude-tags
+ The default value is =("noexport")=. When a tree is tagged with
+ =noexport= (~org-export-exclude-tags~), Org excludes that tree and
+ its sub-trees from export. Entries tagged with =noexport= are
+ unconditionally excluded from the export, even if they have an
+ =export= tag. Even if a sub-tree is not exported, Org executes any
+ code blocks contained there.
- =TITLE= ::
- #+cindex: @samp{TITLE}, keyword
- #+cindex: document title
- Org displays this title. For long titles, use multiple =#+TITLE=
- lines.
+ #+cindex: @samp{TITLE}, keyword
+ #+cindex: document title
+ Org displays this title. For long titles, use multiple =#+TITLE=
+ lines.
- =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.
+ #+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.
The =OPTIONS= keyword is a compact form. To configure multiple
options, use several =OPTIONS= lines. =OPTIONS= recognizes the
@@ -11337,202 +11275,201 @@ following arguments.
- ~'~ ::
- #+vindex: org-export-with-smart-quotes
- Toggle smart quotes (~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.
+ #+vindex: org-export-with-smart-quotes
+ Toggle smart quotes (~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.
- ~*~ ::
- #+vindex: org-export-with-emphasize
- Toggle emphasized text (~org-export-with-emphasize~).
+ #+vindex: org-export-with-emphasize
+ Toggle emphasized text (~org-export-with-emphasize~).
- ~-~ ::
- #+vindex: org-export-with-special-strings
- Toggle conversion of special strings
- (~org-export-with-special-strings~).
+ #+vindex: org-export-with-special-strings
+ Toggle conversion of special strings
+ (~org-export-with-special-strings~).
- ~:~ ::
- #+vindex: org-export-with-fixed-width
- Toggle fixed-width sections (~org-export-with-fixed-width~).
+ #+vindex: org-export-with-fixed-width
+ Toggle fixed-width sections (~org-export-with-fixed-width~).
- ~<~ ::
- #+vindex: org-export-with-timestamps
- Toggle inclusion of time/date active/inactive stamps
- (~org-export-with-timestamps~).
+ #+vindex: org-export-with-timestamps
+ Toggle inclusion of time/date active/inactive stamps
+ (~org-export-with-timestamps~).
- ~\n~ ::
- #+vindex: org-export-preserve-breaks
- Toggles whether to preserve line breaks
- (~org-export-preserve-breaks~).
+ #+vindex: org-export-preserve-breaks
+ Toggles whether to preserve line breaks
+ (~org-export-preserve-breaks~).
- ~^~ ::
- #+vindex: org-export-with-sub-superscripts
- Toggle TeX-like syntax for sub- and superscripts. If you write
- =^:{}=, =a_{b}= is interpreted, but the simple =a_b= is left as
- it is (~org-export-with-sub-superscripts~).
+ #+vindex: org-export-with-sub-superscripts
+ Toggle TeX-like syntax for sub- and superscripts. If you write
+ =^:{}=, =a_{b}= is interpreted, but the simple =a_b= is left as it
+ is (~org-export-with-sub-superscripts~).
- ~arch~ ::
- #+vindex: org-export-with-archived-trees
- Configure how archived trees are exported. When set to
- ~headline~, the export process skips the contents and processes
- only the headlines (~org-export-with-archived-trees~).
+ #+vindex: org-export-with-archived-trees
+ Configure how archived trees are exported. When set to ~headline~,
+ the export process skips the contents and processes only the
+ headlines (~org-export-with-archived-trees~).
- ~author~ ::
- #+vindex: org-export-with-author
- Toggle inclusion of author name into exported file
- (~org-export-with-author~).
+ #+vindex: org-export-with-author
+ Toggle inclusion of author name into exported file
+ (~org-export-with-author~).
- ~broken-links~ ::
- #+vindex: org-export-with-broken-links
- Toggles if Org should continue exporting upon finding a broken
- internal link. When set to ~mark~, Org clearly marks the problem
- link in the output (~org-export-with-broken-links~).
+ #+vindex: org-export-with-broken-links
+ Toggles if Org should continue exporting upon finding a broken
+ internal link. When set to ~mark~, Org clearly marks the problem
+ link in the output (~org-export-with-broken-links~).
- ~c~ ::
- #+vindex: org-export-with-clocks
- Toggle inclusion of CLOCK keywords (~org-export-with-clocks~).
+ #+vindex: org-export-with-clocks
+ Toggle inclusion of CLOCK keywords (~org-export-with-clocks~).
- ~creator~ ::
- #+vindex: org-export-with-creator
- Toggle inclusion of creator information in the exported file
- (~org-export-with-creator~).
+ #+vindex: org-export-with-creator
+ Toggle inclusion of creator information in the exported file
+ (~org-export-with-creator~).
- ~d~ ::
- #+vindex: org-export-with-drawers
- Toggles inclusion of drawers, or list of drawers to include, or
- list of drawers to exclude (~org-export-with-drawers~).
+ #+vindex: org-export-with-drawers
+ Toggles inclusion of drawers, or list of drawers to include, or list
+ of drawers to exclude (~org-export-with-drawers~).
- ~date~ ::
- #+vindex: org-export-with-date
- Toggle inclusion of a date into exported file
- (~org-export-with-date~).
+ #+vindex: org-export-with-date
+ Toggle inclusion of a date into exported file
+ (~org-export-with-date~).
- ~e~ ::
- #+vindex: org-export-with-entities
- Toggle inclusion of entities (~org-export-with-entities~).
+ #+vindex: org-export-with-entities
+ Toggle inclusion of entities (~org-export-with-entities~).
- ~email~ ::
- #+vindex: org-export-with-email
- Toggle inclusion of the author's e-mail into exported file
- (~org-export-with-email~).
+ #+vindex: org-export-with-email
+ Toggle inclusion of the author's e-mail into exported file
+ (~org-export-with-email~).
- ~f~ ::
- #+vindex: org-export-with-footnotes
- Toggle the inclusion of footnotes (~org-export-with-footnotes~).
+ #+vindex: org-export-with-footnotes
+ Toggle the inclusion of footnotes (~org-export-with-footnotes~).
- ~H~ ::
- #+vindex: org-export-headline-levels
- Set the number of headline levels for export
- (~org-export-headline-levels~). Below that level, headlines are
- treated differently. In most back-ends, they become list items.
+ #+vindex: org-export-headline-levels
+ Set the number of headline levels for export
+ (~org-export-headline-levels~). Below that level, headlines are
+ treated differently. In most back-ends, they become list items.
- ~inline~ ::
- #+vindex: org-export-with-inlinetasks
- Toggle inclusion of inlinetasks (~org-export-with-inlinetasks~).
+ #+vindex: org-export-with-inlinetasks
+ Toggle inclusion of inlinetasks (~org-export-with-inlinetasks~).
- ~num~ ::
- #+vindex: org-export-with-section-numbers
- #+cindex: @samp{UNNUMBERED}, property
- Toggle section-numbers (~org-export-with-section-numbers~). When
- set to number N, Org numbers only those headlines at level N or
- above. Set =UNNUMBERED= property to non-~nil~ to disable
- numbering of heading and subheadings entirely. Moreover, when
- the value is =notoc= the headline, and all its children, do not
- appear in the table of contents either (see [[*Table of Contents]]).
+ #+vindex: org-export-with-section-numbers
+ #+cindex: @samp{UNNUMBERED}, property
+ Toggle section-numbers (~org-export-with-section-numbers~). When
+ set to number N, Org numbers only those headlines at level N or
+ above. Set =UNNUMBERED= property to non-~nil~ to disable numbering
+ of heading and subheadings entirely. Moreover, when the value is
+ =notoc= the headline, and all its children, do not appear in the
+ table of contents either (see [[*Table of Contents]]).
- ~p~ ::
- #+vindex: org-export-with-planning
- Toggle export of planning information
- (~org-export-with-planning~). "Planning information" comes from
- lines located right after the headline and contain any
- combination of these cookies: =SCHEDULED=, =DEADLINE=, or
- =CLOSED=.
+ #+vindex: org-export-with-planning
+ Toggle export of planning information (~org-export-with-planning~).
+ "Planning information" comes from lines located right after the
+ headline and contain any combination of these cookies: =SCHEDULED=,
+ =DEADLINE=, or =CLOSED=.
- ~pri~ ::
- #+vindex: org-export-with-priority
- Toggle inclusion of priority cookies
- (~org-export-with-priority~).
+ #+vindex: org-export-with-priority
+ Toggle inclusion of priority cookies
+ (~org-export-with-priority~).
- ~prop~ ::
- #+vindex: org-export-with-properties
- Toggle inclusion of property drawers, or list the properties to
- include (~org-export-with-properties~).
+ #+vindex: org-export-with-properties
+ Toggle inclusion of property drawers, or list the properties to
+ include (~org-export-with-properties~).
- ~stat~ ::
- #+vindex: org-export-with-statistics-cookies
- Toggle inclusion of statistics cookies
- (~org-export-with-statistics-cookies~).
+ #+vindex: org-export-with-statistics-cookies
+ Toggle inclusion of statistics cookies
+ (~org-export-with-statistics-cookies~).
- ~tags~ ::
- #+vindex: org-export-with-tags
- Toggle inclusion of tags, may also be ~not-in-toc~
- (~org-export-with-tags~).
+ #+vindex: org-export-with-tags
+ Toggle inclusion of tags, may also be ~not-in-toc~
+ (~org-export-with-tags~).
- ~tasks~ ::
- #+vindex: org-export-with-tasks
- Toggle inclusion of tasks (TODO items); or ~nil~ to remove all
- tasks; or ~todo~ to remove DONE tasks; or list the keywords to
- keep (~org-export-with-tasks~).
+ #+vindex: org-export-with-tasks
+ Toggle inclusion of tasks (TODO items); or ~nil~ to remove all
+ tasks; or ~todo~ to remove DONE tasks; or list the keywords to keep
+ (~org-export-with-tasks~).
- ~tex~ ::
- #+vindex: org-export-with-latex
- ~nil~ does not export; ~t~ exports; ~verbatim~ keeps everything
- in verbatim (~org-export-with-latex~).
+ #+vindex: org-export-with-latex
+ ~nil~ does not export; ~t~ exports; ~verbatim~ keeps everything in
+ verbatim (~org-export-with-latex~).
- ~timestamp~ ::
- #+vindex: org-export-time-stamp-file
- Toggle inclusion of the creation time in the exported file
- (~org-export-time-stamp-file~).
+ #+vindex: org-export-time-stamp-file
+ Toggle inclusion of the creation time in the exported file
+ (~org-export-time-stamp-file~).
- ~title~ ::
- #+vindex: org-export-with-title
- Toggle inclusion of title (~org-export-with-title~).
+ #+vindex: org-export-with-title
+ Toggle inclusion of title (~org-export-with-title~).
- ~toc~ ::
- #+vindex: org-export-with-toc
- Toggle inclusion of the table of contents, or set the level limit
- (~org-export-with-toc~).
+ #+vindex: org-export-with-toc
+ Toggle inclusion of the table of contents, or set the level limit
+ (~org-export-with-toc~).
- ~todo~ ::
- #+vindex: org-export-with-todo-keywords
- Toggle inclusion of TODO keywords into exported text
- (~org-export-with-todo-keywords~).
+ #+vindex: org-export-with-todo-keywords
+ Toggle inclusion of TODO keywords into exported text
+ (~org-export-with-todo-keywords~).
- ~|~ ::
- #+vindex: org-export-with-tables
- Toggle inclusion of tables (~org-export-with-tables~).
+ #+vindex: org-export-with-tables
+ Toggle inclusion of tables (~org-export-with-tables~).
When exporting sub-trees, special node properties can override the
above keywords. These properties have an =EXPORT_= prefix. For
@@ -11696,10 +11633,10 @@ The following command allows navigating back and forth to the included
document:
- {{{kbd(C-c ')}}} (~org-edit~special~) ::
- #+kindex: C-c '
- #+findex: org-edit-special
+ #+kindex: C-c '
+ #+findex: org-edit-special
- Visit the included file at point.
+ Visit the included file at point.
** Macro Replacement
:PROPERTIES:
@@ -11749,60 +11686,60 @@ Org comes with following pre-defined macros:
#+attr_texinfo: :sep ;
- ={{{keyword(NAME)}}}=; ={{{title}}}=; ={{{author}}}=; ={{{email}}}= ::
- #+cindex: @samp{keyword}, macro
- #+cindex: @samp{title}, macro
- #+cindex: @samp{author}, macro
- #+cindex: @samp{email}, macro
- The =keyword= macro collects all values from {{{var(NAME)}}}
- keywords throughout the buffer, separated with white space.
- =title=, =author= and =email= macros are shortcuts for,
- respectively, ={{{keyword(TITLE)}}}=, ={{{keyword(AUTHOR)}}}= and
- ={{{keyword(EMAIL)}}}=.
+ #+cindex: @samp{keyword}, macro
+ #+cindex: @samp{title}, macro
+ #+cindex: @samp{author}, macro
+ #+cindex: @samp{email}, macro
+ The =keyword= macro collects all values from {{{var(NAME)}}}
+ keywords throughout the buffer, separated with white space.
+ =title=, =author= and =email= macros are shortcuts for,
+ respectively, ={{{keyword(TITLE)}}}=, ={{{keyword(AUTHOR)}}}= and
+ ={{{keyword(EMAIL)}}}=.
- ={{{date}}}=; ={{{date(FORMAT)}}}= ::
- #+cindex: @samp{date}, macro
- This macro refers to the =DATE= keyword. {{{var(FORMAT)}}} is an
- optional argument to the =date= macro that is used only if =DATE=
- is a single timestamp. {{{var(FORMAT)}}} should be a format
- string understood by ~format-time-string~.
+ #+cindex: @samp{date}, macro
+ This macro refers to the =DATE= keyword. {{{var(FORMAT)}}} is an
+ optional argument to the =date= macro that is used only if =DATE= is
+ a single timestamp. {{{var(FORMAT)}}} should be a format string
+ understood by ~format-time-string~.
- ={{{time(FORMAT)}}}=; ={{{modification-time(FORMAT, VC)}}}= ::
- #+cindex: @samp{time}, macro
- #+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 ~format-time-string~. If the second argument to
- the ~modification-time~ macro is non-~nil~, Org uses =vc.el= to
- retrieve the document's modification time from the version
- control system. Otherwise Org reads the file attributes.
+ #+cindex: @samp{time}, macro
+ #+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 ~format-time-string~. If the second argument to the
+ ~modification-time~ macro is non-~nil~, Org uses =vc.el= to retrieve
+ the document's modification time from the version control system.
+ Otherwise Org reads the file attributes.
- ={{{input-file}}}= ::
- #+cindex: @samp{input-file}, macro
- This macro refers to the filename of the exported file.
+ #+cindex: @samp{input-file}, macro
+ This macro refers to the filename of the exported file.
- ={{{property(PROPERTY-NAME)}}}=; ={{{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 [[*Search
- Options in File Links]]) refers to a remote entry, use it instead.
+ #+cindex: @samp{property}, macro
+ This macro returns the value of property {{{var(PROPERTY-NAME)}}} in
+ the current entry. If {{{var(SEARCH-OPTION)}}} (see [[*Search
+ Options in File Links]]) refers to a remote entry, use it instead.
- ={{{n}}}=; ={{{n(NAME)}}}=; ={{{n(NAME, ACTION)}}}= ::
- #+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 =-=, 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.
+ #+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 =-=, 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.
#+cindex: @samp{results}, macro
Moreover, inline source blocks (see [[*Structure of Code Blocks]]) use the
@@ -11839,10 +11776,10 @@ is executed either[fn:125]. The command below helps changing the
comment status of a headline.
- {{{kbd(C-c ;)}}} (~org-toggle-comment~) ::
- #+kindex: C-c ;
- #+findex: org-toggle-comment
+ #+kindex: C-c ;
+ #+findex: org-toggle-comment
- Toggle the =COMMENT= keyword at the beginning of an entry.
+ Toggle the =COMMENT= keyword at the beginning of an entry.
** ASCII/Latin-1/UTF-8 export
:PROPERTIES:
@@ -11875,24 +11812,24 @@ See the variable ~org-ascii-links-to-notes~ for details.
#+attr_texinfo: :sep ,
- {{{kbd(C-c C-e t a)}}} (~org-ascii-export-to-ascii~), {{{kbd(C-c C-e t l)}}}, {{{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
+ #+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
- Export as an ASCII file with a =.txt= extension. For
- =myfile.org=, Org exports to =myfile.txt=, overwriting without
- warning. For =myfile.txt=, Org exports to =myfile.txt.txt= in
- order to prevent data loss.
+ Export as an ASCII file with a =.txt= extension. For =myfile.org=,
+ Org exports to =myfile.txt=, overwriting without warning. For
+ =myfile.txt=, Org exports to =myfile.txt.txt= in order to prevent
+ data loss.
#+attr_texinfo: :sep ,
- {{{kbd(C-c C-e t A)}}} (~org-ascii-export-to-ascii~), {{{kbd(C-c C-e t L)}}}, {{{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
+ #+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
- Export to a temporary buffer. Does not create a file.
+ Export to a temporary buffer. Does not create a file.
*** ASCII specific export settings
:PROPERTIES:
@@ -11905,10 +11842,10 @@ output. Setting this keyword works similar to the general options
- =SUBTITLE= ::
- #+cindex: @samp{SUBTITLE}, keyword
- The document subtitle. For long subtitles, use multiple
- =#+SUBTITLE= lines in the Org file. Org prints them on one
- continuous line, wrapping into multiple lines if necessary.
+ #+cindex: @samp{SUBTITLE}, keyword
+ The document subtitle. For long subtitles, use multiple
+ =#+SUBTITLE= lines in the Org file. Org prints them on one
+ continuous line, wrapping into multiple lines if necessary.
*** Header and sectioning structure
:PROPERTIES:
@@ -11990,29 +11927,29 @@ popular display formats.
:END:
- {{{kbd(C-c C-e l b)}}} (~org-beamer-export-to-latex~) ::
- #+kindex: C-c C-e l b
- #+findex: org-beamer-export-to-latex
+ #+kindex: C-c C-e l b
+ #+findex: org-beamer-export-to-latex
- Export as LaTeX file with a =.tex= extension. For =myfile.org=,
- Org exports to =myfile.tex=, overwriting without warning.
+ Export as LaTeX file with a =.tex= extension. For =myfile.org=, Org
+ exports to =myfile.tex=, overwriting without warning.
- {{{kbd(C-c C-e l B)}}} (~org-beamer-export-as-latex~) ::
- #+kindex: C-c C-e l B
- #+findex: org-beamer-export-as-latex
+ #+kindex: C-c C-e l B
+ #+findex: org-beamer-export-as-latex
- Export to a temporary buffer. Does not create a file.
+ Export to a temporary buffer. Does not create a file.
- {{{kbd(C-c C-e l P)}}} (~org-beamer-export-to-pdf~) ::
- #+kindex: C-c C-e l P
- #+findex: org-beamer-export-to-pdf
+ #+kindex: C-c C-e l P
+ #+findex: org-beamer-export-to-pdf
- Export as LaTeX file and then convert it to PDF format.
+ Export as LaTeX file and then convert it to PDF format.
- {{{kbd(C-c C-e l O)}}} ::
- #+kindex: C-c C-e l O
+ #+kindex: C-c C-e l O
- Export as LaTeX file, convert it to PDF format, and then open the
- PDF file.
+ Export as LaTeX file, convert it to PDF format, and then open the
+ PDF file.
*** Beamer specific export settings
:PROPERTIES:
@@ -12025,61 +11962,60 @@ settings (see [[*Export Settings]]).
- =BEAMER_THEME= ::
- #+cindex: @samp{BEAMER_THEME}, keyword
- #+vindex: org-beamer-theme
- The Beamer layout theme (~org-beamer-theme~). Use square
- brackets for options. For example:
+ #+cindex: @samp{BEAMER_THEME}, keyword
+ #+vindex: org-beamer-theme
+ The Beamer layout theme (~org-beamer-theme~). Use square brackets
+ for options. For example:
- : #+BEAMER_THEME: Rochester [height=20pt]
+ : #+BEAMER_THEME: Rochester [height=20pt]
- =BEAMER_FONT_THEME= ::
- #+cindex: @samp{BEAMER_FONT_THEME}, keyword
- The Beamer font theme.
+ #+cindex: @samp{BEAMER_FONT_THEME}, keyword
+ The Beamer font theme.
- =BEAMER_INNER_THEME= ::
- #+cindex: @samp{BEAMER_INNER_THEME}, keyword
- The Beamer inner theme.
+ #+cindex: @samp{BEAMER_INNER_THEME}, keyword
+ The Beamer inner theme.
- =BEAMER_OUTER_THEME= ::
- #+cindex: @samp{BEAMER_OUTER_THEME}, keyword
- The Beamer outer theme.
+ #+cindex: @samp{BEAMER_OUTER_THEME}, keyword
+ The Beamer outer theme.
- =BEAMER_HEADER= ::
- #+cindex: @samp{BEAMER_HEADER}, keyword
- Arbitrary lines inserted in the preamble, just before the
- =hyperref= settings.
+ #+cindex: @samp{BEAMER_HEADER}, keyword
+ Arbitrary lines inserted in the preamble, just before the =hyperref=
+ settings.
- =DESCRIPTION= ::
- #+cindex: @samp{DESCRIPTION}, keyword
- The document description. For long descriptions, use multiple
- =DESCRIPTION= keywords. By default, =hyperref= inserts
- =DESCRIPTION= as metadata. Use ~org-latex-hyperref-template~ to
- configure document metadata. Use ~org-latex-title-command~ to
- configure typesetting of description as part of front matter.
+ #+cindex: @samp{DESCRIPTION}, keyword
+ The document description. For long descriptions, use multiple
+ =DESCRIPTION= keywords. By default, =hyperref= inserts
+ =DESCRIPTION= as metadata. Use ~org-latex-hyperref-template~ to
+ configure document metadata. Use ~org-latex-title-command~ to
+ configure typesetting of description as part of front matter.
- =KEYWORDS= ::
- #+cindex: @samp{KEYWORDS}, keyword
- The keywords for defining the contents of the document. Use
- multiple =KEYWORDS= lines if necessary. By default, =hyperref=
- inserts =KEYWORDS= as metadata. Use
- ~org-latex-hyperref-template~ to configure document metadata.
- Use ~org-latex-title-command~ to configure typesetting of
- keywords as part of front matter.
+ #+cindex: @samp{KEYWORDS}, keyword
+ The keywords for defining the contents of the document. Use
+ multiple =KEYWORDS= lines if necessary. By default, =hyperref=
+ inserts =KEYWORDS= as metadata. Use ~org-latex-hyperref-template~
+ to configure document metadata. Use ~org-latex-title-command~ to
+ configure typesetting of keywords as part of front matter.
- =SUBTITLE= ::
- #+cindex: @samp{SUBTITLE}, keyword
- Document's subtitle. For typesetting, use
- ~org-beamer-subtitle-format~ string. Use
- ~org-latex-hyperref-template~ to configure document metadata.
- Use ~org-latex-title-command~ to configure typesetting of
- subtitle as part of front matter.
+ #+cindex: @samp{SUBTITLE}, keyword
+ Document's subtitle. For typesetting, use
+ ~org-beamer-subtitle-format~ string. Use
+ ~org-latex-hyperref-template~ to configure document metadata. Use
+ ~org-latex-title-command~ to configure typesetting of subtitle as
+ part of front matter.
*** Frames and Blocks in Beamer
:PROPERTIES:
@@ -12225,12 +12161,12 @@ Beamer documents.
: #+STARTUP: beamer
- {{{kbd(C-c C-b)}}} (~org-beamer-select-environment~) ::
- #+kindex: C-c C-b
- #+findex: org-beamer-select-environment
+ #+kindex: C-c C-b
+ #+findex: org-beamer-select-environment
- The ~org-beamer-mode~ provides this key for quicker selections in
- Beamer normal environments, and for selecting the =BEAMER_COL=
- property.
+ The ~org-beamer-mode~ provides this key for quicker selections in
+ Beamer normal environments, and for selecting the =BEAMER_COL=
+ property.
*** A Beamer example
:PROPERTIES:
@@ -12288,20 +12224,19 @@ compatible with XHTML 1.0 strict standard.
:END:
- {{{kbd(C-c C-e h h)}}} (~org-html-export-to-html~) ::
- #+kindex: C-c C-e h h
- #+kindex: C-c C-e h o
- #+findex: org-html-export-to-html
+ #+kindex: C-c C-e h h
+ #+kindex: C-c C-e h o
+ #+findex: org-html-export-to-html
- Export as HTML file with a =.html= extension. For =myfile.org=,
- Org exports to =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 =.html= extension. For =myfile.org=, Org
+ exports to =myfile.html=, overwriting without warning. {{{kbd{C-c
+ C-e h o)}}} exports to HTML and opens it in a web browser.
- {{{kbd(C-c C-e h H)}}} (~org-html-export-as-html~) ::
- #+kindex: C-c C-e h H
- #+findex: org-html-export-as-html
+ #+kindex: C-c C-e h H
+ #+findex: org-html-export-as-html
- Exports to a temporary buffer. Does not create a file.
+ Exports to a temporary buffer. Does not create a file.
*** HTML specific export settings
:PROPERTIES:
@@ -12313,80 +12248,78 @@ settings described in [[*Export Settings]].
- =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 =DESCRIPTION= lines. The exporter
- takes care of wrapping the lines properly.
+ #+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 =DESCRIPTION= lines. The exporter takes care of wrapping
+ the lines properly.
- =HTML_DOCTYPE= ::
- #+cindex: @samp{HTML_DOCTYPE}, keyword
- #+vindex: org-html-doctype
- Specify the document type, for example: HTML5
- (~org-html-doctype~).
+ #+cindex: @samp{HTML_DOCTYPE}, keyword
+ #+vindex: org-html-doctype
+ Specify the document type, for example: HTML5 (~org-html-doctype~).
- =HTML_CONTAINER= ::
- #+cindex: @samp{HTML_CONTAINER}, keyword
- #+vindex: org-html-container-element
- Specify the HTML container, such as =div=, for wrapping sections
- and elements (~org-html-container-element~).
+ #+cindex: @samp{HTML_CONTAINER}, keyword
+ #+vindex: org-html-container-element
+ Specify the HTML container, such as =div=, for wrapping sections and
+ elements (~org-html-container-element~).
- =HTML_LINK_HOME= ::
- #+cindex: @samp{HTML_LINK_HOME}, keyword
- #+vindex: org-html-link-home
- The URL for home link (~org-html-link-home~).
+ #+cindex: @samp{HTML_LINK_HOME}, keyword
+ #+vindex: org-html-link-home
+ The URL for home link (~org-html-link-home~).
- =HTML_LINK_UP= ::
- #+cindex: @samp{HTML_LINK_UP}, keyword
- #+vindex: org-html-link-up
- The URL for the up link of exported HTML pages
- (~org-html-link-up~).
+ #+cindex: @samp{HTML_LINK_UP}, keyword
+ #+vindex: org-html-link-up
+ The URL for the up link of exported HTML pages (~org-html-link-up~).
- =HTML_MATHJAX= ::
- #+cindex: @samp{HTML_MATHJAX}, keyword
- #+vindex: org-html-mathjax-options
- Options for MathJax (~org-html-mathjax-options~). MathJax is
- used to typeset LaTeX math in HTML documents. See [[*Math
- formatting in HTML export]], for an example.
+ #+cindex: @samp{HTML_MATHJAX}, keyword
+ #+vindex: org-html-mathjax-options
+ Options for MathJax (~org-html-mathjax-options~). MathJax is used
+ to typeset LaTeX math in HTML documents. See [[*Math formatting in
+ HTML export]], for an example.
- =HTML_HEAD= ::
- #+cindex: @samp{HTML_HEAD}, keyword
- #+vindex: org-html-head
- Arbitrary lines for appending to the HTML document's head
- (~org-html-head~).
+ #+cindex: @samp{HTML_HEAD}, keyword
+ #+vindex: org-html-head
+ Arbitrary lines for appending to the HTML document's head
+ (~org-html-head~).
- =HTML_HEAD_EXTRA= ::
- #+cindex: @samp{HTML_HEAD_EXTRA}, keyword
- #+vindex: org-html-head-extra
- More arbitrary lines for appending to the HTML document's head
- (~org-html-head-extra~).
+ #+cindex: @samp{HTML_HEAD_EXTRA}, keyword
+ #+vindex: org-html-head-extra
+ More arbitrary lines for appending to the HTML document's head
+ (~org-html-head-extra~).
- =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 =KEYWORDS= lines.
+ #+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
+ =KEYWORDS= lines.
- =LATEX_HEADER= ::
- #+cindex: @samp{LATEX_HEADER}, keyword
- Arbitrary lines for appending to the preamble; HTML exporter
- appends when transcoding LaTeX fragments to images (see [[*Math
- formatting in HTML export]]).
+ #+cindex: @samp{LATEX_HEADER}, keyword
+ Arbitrary lines for appending to the preamble; HTML exporter appends
+ when transcoding LaTeX fragments to images (see [[*Math formatting in
+ HTML export]]).
- =SUBTITLE= ::
- #+cindex: @samp{SUBTITLE}, keyword
- The document's subtitle. HTML exporter formats subtitle if
- document type is =HTML5= and the CSS has a =subtitle= class.
+ #+cindex: @samp{SUBTITLE}, keyword
+ The document's subtitle. HTML exporter formats subtitle if document
+ type is =HTML5= and the CSS has a =subtitle= class.
Some of these keywords are explained in more detail in the following
sections of the manual.
@@ -12609,39 +12542,39 @@ Additional options for customizing tables for HTML export.
- ~org-html-table-align-individual-fields~ ::
- #+vindex: org-html-table-align-individual-fields
- Non-~nil~ attaches style attributes for alignment to each table
- field.
+ #+vindex: org-html-table-align-individual-fields
+ Non-~nil~ attaches style attributes for alignment to each table
+ field.
- ~org-html-table-caption-above~ ::
- #+vindex: org-html-table-caption-above
- Non-~nil~ places caption string at the beginning of the table.
+ #+vindex: org-html-table-caption-above
+ Non-~nil~ places caption string at the beginning of the table.
- ~org-html-table-data-tags~ ::
- #+vindex: org-html-table-data-tags
- Opening and ending tags for table data fields.
+ #+vindex: org-html-table-data-tags
+ Opening and ending tags for table data fields.
- ~org-html-table-default-attributes~ ::
- #+vindex: org-html-table-default-attributes
- Default attributes and values for table tags.
+ #+vindex: org-html-table-default-attributes
+ Default attributes and values for table tags.
- ~org-html-table-header-tags~ ::
- #+vindex: org-html-table-header-tags
- Opening and ending tags for table's header fields.
+ #+vindex: org-html-table-header-tags
+ Opening and ending tags for table's header fields.
- ~org-html-table-row-tags~ ::
- #+vindex: org-html-table-row-tags
- Opening and ending tags for table rows.
+ #+vindex: org-html-table-row-tags
+ Opening and ending tags for table rows.
- ~org-html-table-use-header-tags-for-first-column~ ::
- #+vindex: org-html-table-use-header-tags-for-first-column
- Non-~nil~ formats column one in tables with header tags.
+ #+vindex: org-html-table-use-header-tags-for-first-column
+ Non-~nil~ formats column one in tables with header tags.
*** Images in HTML export
:PROPERTIES:
@@ -12879,57 +12812,56 @@ options described below:
- =path:= ::
- The path to the script. The default is to grab the script from
- [[https://orgmode.org/org-info.js]], but you might want to have
- a local copy and use a path like =../scripts/org-info.js=.
+ The path to the script. The default is to grab the script from
+ [[https://orgmode.org/org-info.js]], but you might want to have a local
+ copy and use a path like =../scripts/org-info.js=.
- =view:= ::
- Initial view when the website is first shown. Possible values are:
+ Initial view when the website is first shown. Possible values are:
- | =info= | Info-like interface with one section per page |
- | =overview= | Folding interface, initially showing only top-level |
- | =content= | Folding interface, starting with all headlines visible |
- | =showall= | Folding interface, all headlines and text visible |
+ | =info= | Info-like interface with one section per page |
+ | =overview= | Folding interface, initially showing only top-level |
+ | =content= | Folding interface, starting with all headlines visible |
+ | =showall= | Folding interface, all headlines and text visible |
- =sdepth:= ::
- Maximum headline level still considered as an independent section
- for info and folding modes. The default is taken from
- ~org-export-headline-levels~, i.e., the =H= switch in =OPTIONS=.
- If this is smaller than in ~org-export-headline-levels~, each
- info/folding section can still contain child headlines.
+ Maximum headline level still considered as an independent section
+ for info and folding modes. The default is taken from
+ ~org-export-headline-levels~, i.e., the =H= switch in =OPTIONS=. If
+ this is smaller than in ~org-export-headline-levels~, each
+ info/folding section can still contain child headlines.
- =toc:= ::
- Should the table of contents /initially/ be visible? Even when
- =nil=, you can always get to the "toc" with {{{kbd(i)}}}.
+ Should the table of contents /initially/ be visible? Even when
+ =nil=, you can always get to the "toc" with {{{kbd(i)}}}.
- =tdepth:= ::
- The depth of the table of contents. The defaults are taken from
- the variables ~org-export-headline-levels~ and
- ~org-export-with-toc~.
+ The depth of the table of contents. The defaults are taken from the
+ variables ~org-export-headline-levels~ and ~org-export-with-toc~.
- =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.
- =ltoc:= ::
- Should there be short contents (children) in each section? Make
- this =above= if the section should be above initial text.
+ Should there be short contents (children) in each section? Make
+ this =above= if the section should be above initial text.
- =mouse:= ::
- Headings are highlighted when the mouse is over them. Should be
- =underline= (default) or a background color like =#cccccc=.
+ Headings are highlighted when the mouse is over them. Should be
+ =underline= (default) or a background color like =#cccccc=.
- =buttons:= ::
- Should view-toggle buttons be everywhere? When =nil= (the
- default), only one such button is present.
+ Should view-toggle buttons be everywhere? When =nil= (the default),
+ only one such button is present.
#+vindex: org-infojs-options
#+vindex: org-export-html-use-infojs
@@ -12967,35 +12899,34 @@ on blank lines to tell apart syntactical elements, such as paragraphs.
- {{{kbd(C-c C-e l l)}}} (~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 =.tex= extension. For
- =myfile.org=, Org exports to =myfile.tex=, overwriting without
- warning.
+ #+kindex: C-c C-e l l
+ #+findex: org-latex-export-to-latex~
+ Export to a LaTeX file with a =.tex= extension. For =myfile.org=,
+ Org exports to =myfile.tex=, overwriting without warning.
- {{{kbd(C-c C-e l L)}}} (~org-latex-export-as-latex~) ::
- #+kindex: C-c C-e l L
- #+findex: org-latex-export-as-latex
- Export to a temporary buffer. Do not create a file.
+ #+kindex: C-c C-e l L
+ #+findex: org-latex-export-as-latex
+ Export to a temporary buffer. Do not create a file.
- {{{kbd(C-c C-e l p)}}} (~org-latex-export-to-pdf~) ::
- #+kindex: C-c C-e l p
- #+findex: org-latex-export-to-pdf
- Export as LaTeX file and convert it to PDF file.
+ #+kindex: C-c C-e l p
+ #+findex: org-latex-export-to-pdf
+ Export as LaTeX file and convert it to PDF file.
- {{{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.
+ #+kindex: C-c C-e l o
+ Export as LaTeX file and convert it to PDF, then open the PDF using
+ the default viewer.
- {{{kbd(M-x org-export-region-as-latex)}}} ::
- Convert the region to LaTeX under the assumption that it was in Org
- mode syntax before. This is a global command that can be invoked in
- any buffer.
+ Convert the region to LaTeX under the assumption that it was in Org
+ mode syntax before. This is a global command that can be invoked in
+ any buffer.
#+vindex: org-latex-compiler
#+vindex: org-latex-bibtex-compiler
@@ -13025,91 +12956,89 @@ general options (see [[*Export Settings]]).
#+attr_texinfo: :sep ,
- =DESCRIPTION= ::
- #+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
- ~org-latex-hyperref-template~ for customizing metadata items.
- See ~org-latex-title-command~ for typesetting description into
- the document's front matter. Use multiple =DESCRIPTION= keywords
- for long descriptions.
+ #+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 ~org-latex-hyperref-template~ for
+ customizing metadata items. See ~org-latex-title-command~ for
+ typesetting description into the document's front matter. Use
+ multiple =DESCRIPTION= keywords for long descriptions.
- =LANGUAGE= ::
- #+cindex: @samp{LANGUAGE}, keyword
- #+vindex: org-latex-package-alist
- In order to be effective, the =babel= or =polyglossia=
- packages---according to the LaTeX compiler used---must be loaded
- with the appropriate language as argument. This can be
- accomplished by modifying the =org-latex-package-alist= variable,
- e.g., with the following snippet:
+ #+cindex: @samp{LANGUAGE}, keyword
+ #+vindex: org-latex-package-alist
+ In order to be effective, the =babel= or =polyglossia=
+ packages---according to the LaTeX compiler used---must be loaded
+ with the appropriate language as argument. This can be accomplished
+ by modifying the =org-latex-package-alist= variable, e.g., with the
+ following snippet:
- #+begin_src emacs-lisp
- (add-to-list org-latex-package-alist
- '("AUTO" "babel" t ("pdflatex")))
- (add-to-list org-latex-package-alist
- '("AUTO" "polyglossia" t ("xelatex" "lualatex")))
- #+end_src
+ #+begin_src emacs-lisp
+ (add-to-list org-latex-package-alist
+ '("AUTO" "babel" t ("pdflatex")))
+ (add-to-list org-latex-package-alist
+ '("AUTO" "polyglossia" t ("xelatex" "lualatex")))
+ #+end_src
- =LATEX_CLASS= ::
- #+cindex: @samp{LATEX_CLASS}, keyword
- #+vindex: org-latex-default-class
- #+vindex: org-latex-classes
- This is LaTeX document class, such as /article/, /report/,
- /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 ~org-latex-default-class~
- variable. Org has /article/ as the default class. A valid
- default class must be an element of ~org-latex-classes~.
+ #+cindex: @samp{LATEX_CLASS}, keyword
+ #+vindex: org-latex-default-class
+ #+vindex: org-latex-classes
+ This is LaTeX document class, such as /article/, /report/, /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 ~org-latex-default-class~ variable.
+ Org has /article/ as the default class. A valid default class must
+ be an element of ~org-latex-classes~.
- =LATEX_CLASS_OPTIONS= ::
- #+cindex: @samp{LATEX_CLASS_OPTIONS}, keyword
- Options the LaTeX export back-end uses when calling the LaTeX
- document class.
+ #+cindex: @samp{LATEX_CLASS_OPTIONS}, keyword
+ Options the LaTeX export back-end uses when calling the LaTeX
+ document class.
- =LATEX_COMPILER= ::
- #+cindex: @samp{LATEX_COMPILER}, keyword
- #+vindex: org-latex-compiler
- The compiler, such as =pdflatex=, =xelatex=, =lualatex=, for
- producing the PDF. See ~org-latex-compiler~.
+ #+cindex: @samp{LATEX_COMPILER}, keyword
+ #+vindex: org-latex-compiler
+ The compiler, such as =pdflatex=, =xelatex=, =lualatex=, for
+ producing the PDF. See ~org-latex-compiler~.
- =LATEX_HEADER=, =LATEX_HEADER_EXTRA= ::
- #+cindex: @samp{LATEX_HEADER}, keyword
- #+cindex: @samp{LATEX_HEADER_EXTRA}, keyword
- #+vindex: org-latex-classes
- Arbitrary lines to add to the document's preamble, before the
- hyperref settings. See ~org-latex-classes~ for adjusting the
- structure and order of the LaTeX headers.
+ #+cindex: @samp{LATEX_HEADER}, keyword
+ #+cindex: @samp{LATEX_HEADER_EXTRA}, keyword
+ #+vindex: org-latex-classes
+ Arbitrary lines to add to the document's preamble, before the
+ hyperref settings. See ~org-latex-classes~ for adjusting the
+ structure and order of the LaTeX headers.
- =KEYWORDS= ::
- #+cindex: @samp{KEYWORDS}, keyword
- #+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
- ~org-latex-hyperref-template~ for customizing metadata items.
- See ~org-latex-title-command~ for typesetting description into
- the document's front matter. Use multiple =KEYWORDS= lines if
- necessary.
+ #+cindex: @samp{KEYWORDS}, keyword
+ #+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 ~org-latex-hyperref-template~ for
+ customizing metadata items. See ~org-latex-title-command~ for
+ typesetting description into the document's front matter. Use
+ multiple =KEYWORDS= lines if necessary.
- =SUBTITLE= ::
- #+cindex: @samp{SUBTITLE}, keyword
- #+vindex: org-latex-subtitle-separate
- #+vindex: org-latex-subtitle-format
- The document's subtitle. It is typeset as per
- ~org-latex-subtitle-format~. If ~org-latex-subtitle-separate~ is
- non-~nil~, it is typed as part of the ~\title~ macro. See
- ~org-latex-hyperref-template~ for customizing metadata items.
- See ~org-latex-title-command~ for typesetting description
- into the document's front matter.
+ #+cindex: @samp{SUBTITLE}, keyword
+ #+vindex: org-latex-subtitle-separate
+ #+vindex: org-latex-subtitle-format
+ The document's subtitle. It is typeset as per
+ ~org-latex-subtitle-format~. If ~org-latex-subtitle-separate~ is
+ non-~nil~, it is typed as part of the ~\title~ macro. See
+ ~org-latex-hyperref-template~ for customizing metadata items. See
+ ~org-latex-title-command~ for typesetting description into the
+ document's front matter.
The following sections have further details.
@@ -13221,82 +13150,79 @@ include:
#+attr_texinfo: :sep ,
- =: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 =table=, =math=, =inline-math= or =verbatim=.
+ #+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
+ =table=, =math=, =inline-math= or =verbatim=.
- For =math= or =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 ~org-latex-default-table-mode~. The LaTeX export back-end
- merges contiguous tables in the same mode into a single
- environment.
+ For =math= or =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
+ ~org-latex-default-table-mode~. The LaTeX export back-end merges
+ contiguous tables in the same mode into a single environment.
- =: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
- ~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
- ~org-latex-packages-alist~ variable for configuring these
- packages for LaTeX snippet previews, if any.
+ #+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
+ ~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 ~org-latex-packages-alist~
+ variable for configuring these packages for LaTeX snippet previews,
+ if any.
- =:caption= ::
- Use =CAPTION= keyword to set a simple caption for a table (see
- [[*Captions]]). For custom captions, use =:caption= attribute, which
- accepts raw LaTeX code. =:caption= value overrides =CAPTION=
- value.
+ Use =CAPTION= keyword to set a simple caption for a table (see
+ [[*Captions]]). For custom captions, use =:caption= attribute, which
+ accepts raw LaTeX code. =:caption= value overrides =CAPTION= value.
- =:float=, =:placement= ::
- The table environments by default are not floats in LaTeX. To
- make them floating objects use =:float= with one of the following
- options: =sideways=, =multicolumn=, =t=, and =nil=.
+ The table environments by default are not floats in LaTeX. To make
+ them floating objects use =:float= with one of the following
+ options: =sideways=, =multicolumn=, =t=, and =nil=.
- LaTeX floats can also have additional layout =:placement=
- attributes. These are the usual =[h t b p ! H]= permissions
- specified in square brackets. Note that for =:float sideways=
- tables, the LaTeX export back-end ignores =:placement=
- attributes.
+ LaTeX floats can also have additional layout =:placement=
+ attributes. These are the usual =[h t b p ! H]= permissions
+ specified in square brackets. Note that for =:float sideways=
+ tables, the LaTeX export back-end ignores =:placement= attributes.
- =:align=, =:font=, =: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.
- =:spread= ::
- When =:spread= is non-~nil~, the LaTeX export back-end spreads or
- shrinks the table by the =:width= for tabu and longtabu
- environments. =:spread= has no effect if =:width= is not set.
+ When =:spread= is non-~nil~, the LaTeX export back-end spreads or
+ shrinks the table by the =:width= for tabu and longtabu
+ environments. =:spread= has no effect if =:width= is not set.
- =:booktabs=, =:center=, =:rmlines= ::
- #+vindex: org-latex-tables-booktabs
- #+vindex: org-latex-tables-centered
- All three commands are toggles. =:booktabs= brings in modern
- typesetting enhancements to regular tables. The booktabs package
- has to be loaded through ~org-latex-packages-alist~. =:center=
- is for centering the table. =:rmlines= removes all but the very
- first horizontal line made of ASCII characters from "table.el"
- tables only.
+ #+vindex: org-latex-tables-booktabs
+ #+vindex: org-latex-tables-centered
+ All three commands are toggles. =:booktabs= brings in modern
+ typesetting enhancements to regular tables. The booktabs package
+ has to be loaded through ~org-latex-packages-alist~. =:center= is
+ for centering the table. =:rmlines= removes all but the very first
+ horizontal line made of ASCII characters from "table.el" tables
+ only.
- =:math-prefix=, =:math-suffix=, =:math-arguments= ::
- The LaTeX export back-end inserts =:math-prefix= string value in
- a math environment before the table. The LaTeX export back-end
- inserts =:math-suffix= string value in a math environment after
- the table. The LaTeX export back-end inserts =:math-arguments=
- string value between the macro name and the table's contents.
- =:math-arguments= comes in use for matrix macros that require
- more than one argument, such as =qbordermatrix=.
+ The LaTeX export back-end inserts =:math-prefix= string value in
+ a math environment before the table. The LaTeX export back-end
+ inserts =:math-suffix= string value in a math environment after the
+ table. The LaTeX export back-end inserts =:math-arguments= string
+ value between the macro name and the table's contents.
+ =:math-arguments= comes in use for matrix macros that require more
+ than one argument, such as =qbordermatrix=.
LaTeX table attributes help formatting tables for a wide range of
situations, such as matrix product or spanning multiple pages:
@@ -13363,28 +13289,27 @@ attribute to one of the following:
- =t= ::
- For a standard =figure= environment; used by default whenever an
- image has a caption.
+ For a standard =figure= environment; used by default whenever an
+ image has a caption.
- =multicolumn= ::
- To span the image across multiple columns of a page; the back-end
- wraps the image in a =figure*= environment.
+ To span the image across multiple columns of a page; the back-end
+ wraps the image in a =figure*= environment.
- =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.
- =sideways= ::
- For a new page with the image sideways, rotated ninety degrees,
- in a =sidewaysfigure= environment; overrides =:placement=
- setting.
+ For a new page with the image sideways, rotated ninety degrees, in
+ a =sidewaysfigure= environment; overrides =:placement= setting.
- =nil= ::
- To avoid a =:float= even if using a caption.
+ To avoid a =:float= even if using a caption.
Use the =placement= attribute to modify a floating environment's
placement.
@@ -13452,17 +13377,17 @@ objects through the attributes =:float= and =:options=. For =:float=:
- =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.
- =multicolumn= ::
- Spans the source block across multiple columns of a page.
+ Spans the source block across multiple columns of a page.
- =nil= ::
- Avoids a =:float= even if using a caption; useful for source code
- blocks that may not fit on a page.
+ Avoids a =:float= even if using a caption; useful for source code
+ blocks that may not fit on a page.
#+begin_example
,#+ATTR_LATEX: :float nil
@@ -13599,21 +13524,21 @@ tables, to HTML.
- {{{kbd(C-c C-e m m)}}} (~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 =myfile.org=,
- Org exports to =myfile.md=, overwritten without warning.
+ #+kindex: C-c C-c m m
+ #+findex: org-md-export-to-markdown
+ Export to a text file with Markdown syntax. For =myfile.org=, Org
+ exports to =myfile.md=, overwritten without warning.
- {{{kbd(C-c C-e m M)}}} (~org-md-export-as-markdown~) ::
- #+kindex: C-c C-c m M
- #+findex: org-md-export-as-markdown
- Export to a temporary buffer. Does not create a file.
+ #+kindex: C-c C-c m M
+ #+findex: org-md-export-as-markdown
+ Export to a temporary buffer. Does not create a file.
- {{{kbd(C-c C-e m o)}}} ::
- #+kindex: C-c C-e m o
- Export as a text file with Markdown syntax, then open it.
+ #+kindex: C-c C-e m o
+ Export as a text file with Markdown syntax, then open it.
*** Header and sectioning structure
:PROPERTIES:
@@ -13658,35 +13583,35 @@ executable. Without it, export cannot finish.
- {{{kbd(C-c C-e o o)}}} (~org-export-to-odt~) ::
- #+kindex: C-c C-e o o
- #+findex: org-export-to-odt
- Export as OpenDocument Text file.
+ #+kindex: C-c C-e o o
+ #+findex: org-export-to-odt
+ Export as OpenDocument Text file.
- #+cindex: @samp{EXPORT_FILE_NAME}, property
- #+vindex: org-odt-preferred-output-format
+ #+cindex: @samp{EXPORT_FILE_NAME}, property
+ #+vindex: org-odt-preferred-output-format
- If ~org-odt-preferred-output-format~ is specified, the ODT export
- back-end automatically converts the exported file to that format.
+ If ~org-odt-preferred-output-format~ is specified, the ODT export
+ back-end automatically converts the exported file to that format.
- For =myfile.org=, Org exports to =myfile.odt=, overwriting
- without warning. The ODT export back-end exports a region only
- if a region was active.
+ For =myfile.org=, Org exports to =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 =EXPORT_FILE_NAME= property, the ODT export
- back-end uses that for file name.
+ 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 =EXPORT_FILE_NAME= property, the ODT export back-end
+ uses that for file name.
- {{{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.
+ #+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 ~org-export-odt-preferred-output-format~ is specified, open
- the converted file instead. See [[*Automatically exporting to
- other formats]].
+ #+vindex: org-export-odt-preferred-output-format
+ If ~org-export-odt-preferred-output-format~ is specified, open the
+ converted file instead. See [[*Automatically exporting to other
+ formats]].
*** ODT specific export settings
:PROPERTIES:
@@ -13699,30 +13624,30 @@ general options (see [[*Export Settings]]).
- =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 =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 =DESCRIPTION=.
- =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
- =KEYWORDS= if necessary.
+ #+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 =KEYWORDS= if
+ necessary.
- =ODT_STYLES_FILE= ::
- #+cindex: @samp{ODT_STYLES_FILE}, keyword
- #+vindex: org-odt-styles-file
- The ODT export back-end uses the ~org-odt-styles-file~ by
- default. See [[*Applying custom styles]] for details.
+ #+cindex: @samp{ODT_STYLES_FILE}, keyword
+ #+vindex: org-odt-styles-file
+ The ODT export back-end uses the ~org-odt-styles-file~ by default.
+ See [[*Applying custom styles]] for details.
- =SUBTITLE= ::
- #+cindex: @samp{SUBTITLE}, keyword
- The document subtitle.
+ #+cindex: @samp{SUBTITLE}, keyword
+ The document subtitle.
*** Extending ODT export
:PROPERTIES:
@@ -13768,9 +13693,9 @@ installed. Here are some generic commands:
- {{{kbd(M-x org-odt-convert)}}} ::
- #+findex: org-odt-convert
- Convert an existing document from one format to another. With
- a prefix argument, opens the newly produced file.
+ #+findex: org-odt-convert
+ Convert an existing document from one format to another. With
+ a prefix argument, opens the newly produced file.
*** Applying custom styles
:PROPERTIES:
@@ -13952,41 +13877,41 @@ image scaling operations:
- Explicitly size the image ::
- To embed =img.png= as a 10 cm x 10 cm image, do the following:
+ To embed =img.png= as a 10 cm x 10 cm image, do the following:
- #+begin_example
- ,#+ATTR_ODT: :width 10 :height 10
- [[./img.png]]
- #+end_example
+ #+begin_example
+ ,#+ATTR_ODT: :width 10 :height 10
+ [[./img.png]]
+ #+end_example
- Scale the image ::
- To embed =img.png= at half its size, do the following:
+ To embed =img.png= at half its size, do the following:
- #+begin_example
- ,#+ATTR_ODT: :scale 0.5
- [[./img.png]]
- #+end_example
+ #+begin_example
+ ,#+ATTR_ODT: :scale 0.5
+ [[./img.png]]
+ #+end_example
- Scale the image to a specific width ::
- To embed =img.png= with a width of 10 cm while retaining the
- original height:width ratio, do the following:
+ To embed =img.png= with a width of 10 cm while retaining the
+ original height:width ratio, do the following:
- #+begin_example
- ,#+ATTR_ODT: :width 10
- [[./img.png]]
- #+end_example
+ #+begin_example
+ ,#+ATTR_ODT: :width 10
+ [[./img.png]]
+ #+end_example
- Scale the image to a specific height ::
- To embed =img.png= with a height of 10 cm while retaining the
- original height:width ratio, do the following:
+ To embed =img.png= with a height of 10 cm while retaining the
+ original height:width ratio, do the following:
- #+begin_example
- ,#+ATTR_ODT: :height 10
- [[./img.png]]
- #+end_example
+ #+begin_example
+ ,#+ATTR_ODT: :height 10
+ [[./img.png]]
+ #+end_example
**** Anchoring of images
:PROPERTIES:
@@ -14022,76 +13947,76 @@ document in one of the following ways:
- MathML ::
- #+cindex: MathML
- Add this line to the Org file. This option is activated on
- a per-file basis.
+ #+cindex: MathML
+ Add this line to the Org file. This option is activated on
+ a per-file basis.
- : #+OPTIONS: tex:t
+ : #+OPTIONS: tex:t
- 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.
+ 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.
- #+vindex: org-latex-to-mathml-convert-command
- #+vindex: org-latex-to-mathml-jar-file
- You can specify the LaTeX-to-MathML converter by customizing the
- variables ~org-latex-to-mathml-convert-command~ and
- ~org-latex-to-mathml-jar-file~.
+ #+vindex: org-latex-to-mathml-convert-command
+ #+vindex: org-latex-to-mathml-jar-file
+ You can specify the LaTeX-to-MathML converter by customizing the
+ variables ~org-latex-to-mathml-convert-command~ and
+ ~org-latex-to-mathml-jar-file~.
- If you prefer to use MathToWeb[fn:133] as your converter, you can
- configure the above variables as shown below.
+ If you prefer to use MathToWeb[fn:133] as your converter, you can
+ configure the above variables as shown below.
- #+begin_src emacs-lisp
- (setq org-latex-to-mathml-convert-command
- "java -jar %j -unicode -force -df %o %I"
- org-latex-to-mathml-jar-file
- "/path/to/mathtoweb.jar")
- #+end_src
+ #+begin_src emacs-lisp
+ (setq org-latex-to-mathml-convert-command
+ "java -jar %j -unicode -force -df %o %I"
+ org-latex-to-mathml-jar-file
+ "/path/to/mathtoweb.jar")
+ #+end_src
- #+texinfo: @noindent
- or, to use LaTeX​ML[fn:134] instead,
+ #+texinfo: @noindent
+ or, to use LaTeX​ML[fn:134] instead,
- #+begin_src emacs-lisp
- (setq org-latex-to-mathml-convert-command
- "latexmlmath \"%i\" --presentationmathml=%o")
- #+end_src
+ #+begin_src emacs-lisp
+ (setq org-latex-to-mathml-convert-command
+ "latexmlmath \"%i\" --presentationmathml=%o")
+ #+end_src
- To quickly verify the reliability of the LaTeX-to-MathML
- converter, use the following commands:
+ To quickly verify the reliability of the LaTeX-to-MathML
+ converter, use the following commands:
- - {{{kbd(M-x org-export-as-odf)}}} ::
+ - {{{kbd(M-x org-export-as-odf)}}} ::
- Convert a LaTeX math snippet to an OpenDocument formula
- (=.odf=) file.
+ Convert a LaTeX math snippet to an OpenDocument formula (=.odf=)
+ file.
- - {{{kbd(M-x org-export-as-odf-and-open)}}} ::
+ - {{{kbd(M-x org-export-as-odf-and-open)}}} ::
- Convert a LaTeX math snippet to an OpenDocument formula
- (=.odf=) file and open the formula file with the
- system-registered application.
+ Convert a LaTeX math snippet to an OpenDocument formula (=.odf=)
+ file and open the formula file with the system-registered
+ application.
- PNG images ::
- #+cindex: dvipng
- #+cindex: dvisvgm
- #+cindex: ImageMagick
- Add this line to the Org file. This option is activated on
- a per-file basis.
+ #+cindex: dvipng
+ #+cindex: dvisvgm
+ #+cindex: ImageMagick
+ Add this line to the Org file. This option is activated on
+ a per-file basis.
- : #+OPTIONS: tex:dvipng
+ : #+OPTIONS: tex:dvipng
- : #+OPTIONS: tex:dvisvgm
+ : #+OPTIONS: tex:dvisvgm
- #+texinfo: @noindent
- or
+ #+texinfo: @noindent
+ or
- : #+OPTIONS: tex:imagemagick
+ : #+OPTIONS: tex:imagemagick
- Under this option, LaTeX fragments are processed into PNG or SVG
- images and the resulting images are embedded in the exported
- document. This method requires dvipng program, dvisvgm or
- ImageMagick programs.
+ Under this option, LaTeX fragments are processed into PNG or SVG
+ images and the resulting images are embedded in the exported
+ document. This method requires dvipng program, dvisvgm or
+ ImageMagick programs.
**** MathML and OpenDocument formula files
:PROPERTIES:
@@ -14190,25 +14115,24 @@ for unsupported converters or tweaking existing defaults.
- Register the converter ::
- #+vindex: org-export-odt-convert-processes
- Add the name of the converter to the ~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.
+ #+vindex: org-export-odt-convert-processes
+ Add the name of the converter to the ~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.
- Configure its capabilities ::
- #+vindex: org-export-odt-convert-capabilities
- Specify which formats the converter can handle by customizing the
- variable ~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.
+ #+vindex: org-export-odt-convert-capabilities
+ Specify which formats the converter can handle by customizing the
+ variable ~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.
- Choose the converter ::
- #+vindex: org-export-odt-convert-process
- Select the newly added converter as the preferred one by
- customizing the option ~org-odt-convert-process~.
+ #+vindex: org-export-odt-convert-process
+ Select the newly added converter as the preferred one by customizing
+ the option ~org-odt-convert-process~.
**** Working with OpenDocument style files
:PROPERTIES:
@@ -14228,29 +14152,29 @@ by the variable ~org-odt-styles-dir~. The two files are:
- =OrgOdtStyles.xml= <<x-orgodtstyles-xml>> ::
- This file contributes to the =styles.xml= file of the final ODT
- document. This file gets modified for the following purposes:
+ This file contributes to the =styles.xml= file of the final ODT
+ document. This file gets modified for the following purposes:
- 1. To control outline numbering based on user settings;
+ 1. To control outline numbering based on user settings;
- 2. To add styles generated by =htmlfontify.el= for fontification of
- code blocks.
+ 2. To add styles generated by =htmlfontify.el= for fontification of
+ code blocks.
- =OrgOdtContentTemplate.xml= <<x-orgodtcontenttemplate-xml>> ::
- This file contributes to the =content.xml= file of the final ODT
- document. The contents of the Org outline are inserted between the
- =<office:text>= ... =</office:text>= elements of this file.
+ This file contributes to the =content.xml= file of the final ODT
+ document. The contents of the Org outline are inserted between the
+ =<office:text>= ... =</office:text>= elements of this file.
- Apart from serving as a template file for the final =content.xml=,
- the file serves the following purposes:
+ Apart from serving as a template file for the final =content.xml=,
+ the file serves the following purposes:
- 1. It contains automatic styles for formatting of tables which are
- referenced by the exporter;
+ 1. It contains automatic styles for formatting of tables which are
+ referenced by the exporter;
- 2. It contains =<text:sequence-decl>= ... =</text:sequence-decl>=
- elements that control numbering of tables, images, equations, and
- similar entities.
+ 2. It contains =<text:sequence-decl>= ... =</text:sequence-decl>=
+ elements that control numbering of tables, images, equations, and
+ similar entities.
<<x-overriding-factory-styles>> The following two variables control
the location from where the ODT exporter picks up the custom styles
@@ -14259,36 +14183,36 @@ factory styles used by the exporter.
- ~org-odt-styles-file~ ::
- The ODT export back-end uses the file pointed to by this
- variable, such as =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 =styles.xml=, for the final output. It can take one of the
+ following values:
- - =FILE.xml= ::
+ - =FILE.xml= ::
- Use this file instead of the default =styles.xml=
+ Use this file instead of the default =styles.xml=
- - =FILE.odt= or =FILE.ott= ::
+ - =FILE.odt= or =FILE.ott= ::
- Use the =styles.xml= contained in the specified OpenDocument
- Text or Template file
+ Use the =styles.xml= contained in the specified OpenDocument
+ Text or Template file
- - =FILE.odt= or =FILE.ott= and a subset of included files ::
+ - =FILE.odt= or =FILE.ott= and a subset of included files ::
- Use the =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 =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 =styles.xml= file references additional
- files like header and footer images.
+ Use this option if the =styles.xml= file references additional
+ files like header and footer images.
- - ~nil~ ::
+ - ~nil~ ::
- Use the default =styles.xml=.
+ Use the default =styles.xml=.
- ~org-odt-content-template-file~ ::
- Use this variable to specify the blank =content.xml= used in the
- final output.
+ Use this variable to specify the blank =content.xml= used in the
+ final output.
**** Creating one-off styles
:PROPERTIES:
@@ -14301,61 +14225,61 @@ the Org file. Such direct formatting is useful for one-off instances.
- Embedding ODT tags as part of regular text ::
- Enclose OpenDocument syntax in =@@odt:...@@= for inline markup.
- For example, to highlight a region of text do the following:
+ Enclose OpenDocument syntax in =@@odt:...@@= for inline markup. For
+ example, to highlight a region of text do the following:
- #+begin_example
- @@odt:<text:span text:style-name="Highlight">This is highlighted
- text</text:span>@@. But this is regular text.
- #+end_example
+ #+begin_example
+ @@odt:<text:span text:style-name="Highlight">This is highlighted
+ text</text:span>@@. But this is regular text.
+ #+end_example
- *Hint:* To see the above example in action, edit the =styles.xml=
- (see [[x-orgodtstyles-xml][Factory styles]]) and add a custom /Highlight/ style as shown
- below:
+ *Hint:* To see the above example in action, edit the =styles.xml=
+ (see [[x-orgodtstyles-xml][Factory styles]]) and add a custom /Highlight/ style as shown
+ below:
- #+begin_example
- <style:style style:name="Highlight" style:family="text">
- <style:text-properties fo:background-color="#ff0000"/>
- </style:style>
- #+end_example
+ #+begin_example
+ <style:style style:name="Highlight" style:family="text">
+ <style:text-properties fo:background-color="#ff0000"/>
+ </style:style>
+ #+end_example
- Embedding a one-line OpenDocument XML ::
- #+cindex: @samp{ODT}, keyword
- The ODT export back-end can read one-liner options with =#+ODT:=
- in the Org file. For example, to force a page break:
+ #+cindex: @samp{ODT}, keyword
+ The ODT export back-end can read one-liner options with =#+ODT:= in
+ the Org file. For example, to force a page break:
- #+begin_example
- ,#+ODT: <text:p text:style-name="PageBreak"/>
- #+end_example
+ #+begin_example
+ ,#+ODT: <text:p text:style-name="PageBreak"/>
+ #+end_example
- *Hint:* To see the above example in action, edit your
- =styles.xml= (see [[x-orgodtstyles-xml][Factory styles]]) and add a custom =PageBreak=
- style as shown below.
+ *Hint:* To see the above example in action, edit your
+ =styles.xml= (see [[x-orgodtstyles-xml][Factory styles]]) and add a custom =PageBreak=
+ style as shown below.
- #+begin_example
- <style:style style:name="PageBreak" style:family="paragraph"
- style:parent-style-name="Text_20_body">
- <style:paragraph-properties fo:break-before="page"/>
- </style:style>
- #+end_example
+ #+begin_example
+ <style:style style:name="PageBreak" style:family="paragraph"
+ style:parent-style-name="Text_20_body">
+ <style:paragraph-properties fo:break-before="page"/>
+ </style:style>
+ #+end_example
- Embedding a block of OpenDocument XML ::
- The ODT export back-end can also read ODT export blocks for
- OpenDocument XML. Such blocks use the =#+BEGIN_EXPORT odt=
- ... =#+END_EXPORT= constructs.
+ The ODT export back-end can also read ODT export blocks for
+ OpenDocument XML. Such blocks use the =#+BEGIN_EXPORT odt=
+ ... =#+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:
- #+begin_example
- ,#+BEGIN_EXPORT odt
- <text:p text:style-name="Text_20_body_20_bold">
- This paragraph is specially formatted and uses bold text.
- </text:p>
- ,#+END_EXPORT
- #+end_example
+ #+begin_example
+ ,#+BEGIN_EXPORT odt
+ <text:p text:style-name="Text_20_body_20_bold">
+ This paragraph is specially formatted and uses bold text.
+ </text:p>
+ ,#+END_EXPORT
+ #+end_example
**** Customizing tables in ODT export
:PROPERTIES:
@@ -14493,8 +14417,7 @@ OpenDocument Relax NG Compact (RNC) syntax schema. But first the
=.odt= files have to be decompressed using =zip=. Note that =.odt=
files are ZIP archives: [[info:emacs::File Archives]]. The contents of
ODT files are in XML. For general help with validation---and
-schema-sensitive editing---of XML files:
-[[info:nxml-mode::Introduction]].
+schema-sensitive editing---of XML files: [[info:nxml-mode::Introduction]].
#+vindex: org-export-odt-schema-dir
Customize ~org-odt-schema-dir~ to point to a directory with
@@ -14519,15 +14442,15 @@ Code Blocks]]) and removes content specific to other back-ends.
- {{{kbd(C-c C-e O o)}}} (~org-org-export-to-org~) ::
- #+kindex: C-c C-e O o
- #+findex: org-org-export-to-org
- Export as an Org file with a =.org= extension. For =myfile.org=,
- Org exports to =myfile.org.org=, overwriting without warning.
+ #+kindex: C-c C-e O o
+ #+findex: org-org-export-to-org
+ Export as an Org file with a =.org= extension. For =myfile.org=,
+ Org exports to =myfile.org.org=, overwriting without warning.
- {{{kbd(C-c C-e O v)}}} (~~) ::
- #+kindex: C-c C-e O v
- Export to an Org file, then open it.
+ #+kindex: C-c C-e O v
+ Export to an Org file, then open it.
** Texinfo Export
:PROPERTIES:
@@ -14541,20 +14464,19 @@ Code Blocks]]) and removes content specific to other back-ends.
- {{{kbd(C-c C-e i t)}}} (~org-texinfo-export-to-texinfo~) ::
- #+kindex: C-c C-e i t
- #+findex: org-texinfo-export-to-texinfo
- Export as a Texinfo file with =.texi= extension. For
- =myfile.org=, Org exports to =myfile.texi=, overwriting without
- warning.
+ #+kindex: C-c C-e i t
+ #+findex: org-texinfo-export-to-texinfo
+ Export as a Texinfo file with =.texi= extension. For =myfile.org=,
+ Org exports to =myfile.texi=, overwriting without warning.
- {{{kbd(C-c C-e i i)}}} (~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 ~org-texinfo-info-process~ variable.
+ #+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
+ ~org-texinfo-info-process~ variable.
*** Texinfo specific export settings
:PROPERTIES:
@@ -14567,55 +14489,55 @@ the general options (see [[*Export Settings]]).
- =SUBTITLE= ::
- #+cindex: @samp{SUBTITLE}, keyword
- The document subtitle.
+ #+cindex: @samp{SUBTITLE}, keyword
+ The document subtitle.
- =SUBAUTHOR= ::
- #+cindex: @samp{SUBAUTHOR}, keyword
- Additional authors for the document.
+ #+cindex: @samp{SUBAUTHOR}, keyword
+ Additional authors for the document.
- =TEXINFO_FILENAME= ::
- #+cindex: @samp{TEXINFO_FILENAME}, keyword
- The Texinfo filename.
+ #+cindex: @samp{TEXINFO_FILENAME}, keyword
+ The Texinfo filename.
- =TEXINFO_CLASS= ::
- #+cindex: @samp{TEXINFO_CLASS}, keyword
- #+vindex: org-texinfo-default-class
- The default document class (~org-texinfo-default-class~), which
- must be a member of ~org-texinfo-classes~.
+ #+cindex: @samp{TEXINFO_CLASS}, keyword
+ #+vindex: org-texinfo-default-class
+ The default document class (~org-texinfo-default-class~), which must
+ be a member of ~org-texinfo-classes~.
- =TEXINFO_HEADER= ::
- #+cindex: @samp{TEXINFO_HEADER}, keyword
- Arbitrary lines inserted at the end of the header.
+ #+cindex: @samp{TEXINFO_HEADER}, keyword
+ Arbitrary lines inserted at the end of the header.
- =TEXINFO_POST_HEADER= ::
- #+cindex: @samp{TEXINFO_POST_HEADER}, keyword
- Arbitrary lines inserted after the end of the header.
+ #+cindex: @samp{TEXINFO_POST_HEADER}, keyword
+ Arbitrary lines inserted after the end of the header.
- =TEXINFO_DIR_CATEGORY= ::
- #+cindex: @samp{TEXINFO_DIR_CATEGORY}, keyword
- The directory category of the document.
+ #+cindex: @samp{TEXINFO_DIR_CATEGORY}, keyword
+ The directory category of the document.
- =TEXINFO_DIR_TITLE= ::
- #+cindex: @samp{TEXINFO_DIR_TITLE}, keyword
- The directory title of the document.
+ #+cindex: @samp{TEXINFO_DIR_TITLE}, keyword
+ The directory title of the document.
- =TEXINFO_DIR_DESC= ::
- #+cindex: @samp{TEXINFO_DIR_DESC}, keyword
- The directory description of the document.
+ #+cindex: @samp{TEXINFO_DIR_DESC}, keyword
+ The directory description of the document.
- =TEXINFO_PRINTED_TITLE= ::
- #+cindex: @samp{TEXINFO_PRINTED_TITLE}, keyword
- The printed title of the document.
+ #+cindex: @samp{TEXINFO_PRINTED_TITLE}, keyword
+ The printed title of the document.
*** Texinfo file header
:PROPERTIES:
@@ -15080,26 +15002,26 @@ connections.
- {{{kbd(C-c C-e c f)}}} (~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 =.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 =.ics=.
- {{{kbd(C-c C-e c a)}}} (~org-icalendar-export-agenda-files~) ::
- #+kindex: C-c C-e c a
- #+findex: org-icalendar-export-agenda-files
- Create iCalendar entries from Org files in ~org-agenda-files~ and
- store in a separate iCalendar file for each Org file.
+ #+kindex: C-c C-e c a
+ #+findex: org-icalendar-export-agenda-files
+ Create iCalendar entries from Org files in ~org-agenda-files~ and
+ store in a separate iCalendar file for each Org file.
- {{{kbd(C-c C-e c c)}}} (~org-icalendar-combine-agenda-files~) ::
- #+kindex: C-c C-e c c
- #+findex: org-icalendar-combine-agenda-files
- #+vindex: org-icalendar-combined-agenda-file
- Create a combined iCalendar file from Org files in
- ~org-agenda-files~ and write it to
- ~org-icalendar-combined-agenda-file~ file name.
+ #+kindex: C-c C-e c c
+ #+findex: org-icalendar-combine-agenda-files
+ #+vindex: org-icalendar-combined-agenda-file
+ Create a combined iCalendar file from Org files in
+ ~org-agenda-files~ and write it to
+ ~org-icalendar-combined-agenda-file~ file name.
#+cindex: @samp{SUMMARY}, property
#+cindex: @samp{DESCRIPTION}, property
@@ -15131,7 +15053,7 @@ class or access restrictions, and is applied to any entry with class
information. The iCalendar standard defines three visibility classes:
- =PUBLIC= :: The entry is publicly visible (this is the default).
- =CONFIDENTIAL= :: Only a limited group of clients get access to the
- event.
+ event.
- =PRIVATE= :: The entry can be retrieved only by its owner.
The server should treat unknown class properties the same as
=PRIVATE=.
@@ -15340,33 +15262,33 @@ functions:
- ~org-ascii-convert-region-to-ascii~ ::
- #+findex: org-ascii-convert-region-to-ascii
- Convert the selected region into ASCII.
+ #+findex: org-ascii-convert-region-to-ascii
+ Convert the selected region into ASCII.
- ~org-ascii-convert-region-to-utf8~ ::
- #+findex: org-ascii-convert-region-to-utf8
- Convert the selected region into UTF-8.
+ #+findex: org-ascii-convert-region-to-utf8
+ Convert the selected region into UTF-8.
- ~org-html-convert-region-to-html~ ::
- #+findex: org-html-convert-region-to-html
- Convert the selected region into HTML.
+ #+findex: org-html-convert-region-to-html
+ Convert the selected region into HTML.
- ~org-latex-convert-region-to-latex~ ::
- #+findex: org-latex-convert-region-to-latex
- Convert the selected region into LaTeX.
+ #+findex: org-latex-convert-region-to-latex
+ Convert the selected region into LaTeX.
- ~org-texinfo-convert-region-to-texinfo~ ::
- #+findex: org-texinfo-convert-region-to-texinfo
- Convert the selected region into Texinfo.
+ #+findex: org-texinfo-convert-region-to-texinfo
+ Convert the selected region into Texinfo.
- ~org-md-convert-region-to-md~ ::
- #+findex: org-md-convert-region-to-md
- Convert the selected region into Markdown.
+ #+findex: org-md-convert-region-to-md
+ Convert the selected region into Markdown.
In-place conversions are particularly handy for quick conversion of
tables and lists in foreign buffers. For example, in an HTML buffer,
@@ -15445,29 +15367,28 @@ where to put published files.
- ~:base-directory~ ::
- Directory containing publishing source files.
+ Directory containing publishing source files.
- ~: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 [[*Uploading
- Files]]).
+ 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 [[*Uploading Files]]).
- ~:preparation-function~ ::
- Function or list of functions to be called before starting the
- publishing process, for example, to run =make= for updating files
- to be published. Each preparation function is called with
- a single argument, the project property list.
+ Function or list of functions to be called before starting the
+ publishing process, for example, to run =make= for updating files to
+ be published. Each preparation function is called with a single
+ argument, the project property list.
- ~: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.
*** Selecting files
:PROPERTIES:
@@ -15481,25 +15402,24 @@ following properties
- ~:base-extension~ ::
- Extension---without the dot---of source files. This actually
- is a regular expression. Set this to the symbol ~any~ if you
- want to get all files in ~:base-directory~, even without
- extension.
+ Extension---without the dot---of source files. This actually is
+ a regular expression. Set this to the symbol ~any~ if you want to
+ get all files in ~:base-directory~, even without extension.
- ~:exclude~ ::
- Regular expression to match file names that should not be published,
- even though they have been selected on the basis of their extension.
+ Regular expression to match file names that should not be published,
+ even though they have been selected on the basis of their extension.
- ~:include~ ::
- List of files to be included regardless of ~:base-extension~ and
- ~:exclude~.
+ List of files to be included regardless of ~:base-extension~ and
+ ~:exclude~.
- ~:recursive~ ::
- Non-~nil~ means, check base-directory recursively for files to
- publish.
+ Non-~nil~ means, check base-directory recursively for files to
+ publish.
*** Publishing action
:PROPERTIES:
@@ -15528,12 +15448,12 @@ non-Org files, you always need to specify the publishing function:
- ~:publishing-function~ ::
- Function executing the publication of a file. This may also be
- a list of functions, which are all called in turn.
+ Function executing the publication of a file. This may also be
+ a list of functions, which are all called in turn.
- ~:htmlized-source~ ::
- Non-~nil~ means, publish htmlized source.
+ Non-~nil~ means, publish htmlized source.
The function must accept three arguments: a property list containing
at least a ~:publishing-directory~ property, the name of the file to
@@ -15828,81 +15748,77 @@ a map of files for a given project.
- ~:auto-sitemap~ ::
- When non-~nil~, publish a sitemap during
- ~org-publish-current-project~ or ~org-publish-all~.
+ When non-~nil~, publish a sitemap during
+ ~org-publish-current-project~ or ~org-publish-all~.
- ~:sitemap-filename~ ::
- Filename for output of sitemap. Defaults to =sitemap.org=, which
- becomes =sitemap.html=.
+ Filename for output of sitemap. Defaults to =sitemap.org=, which
+ becomes =sitemap.html=.
- ~:sitemap-title~ ::
- Title of sitemap page. Defaults to name of file.
+ Title of sitemap page. Defaults to name of file.
- ~:sitemap-format-entry~ ::
- #+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 ~org-publish-find-date~,
- ~org-publish-find-title~ and ~org-publish-find-property~, to
- retrieve additional information about published documents.
+ #+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 ~org-publish-find-date~, ~org-publish-find-title~ and
+ ~org-publish-find-property~, to retrieve additional information
+ about published documents.
- ~: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
- ~org-list-to-generic~, ~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 ~org-list-to-generic~,
+ ~org-list-to-subtree~ and alike. Default value generates a plain
+ list of links to all files in the project.
- ~:sitemap-sort-folders~ ::
- Where folders should appear in the sitemap. Set this to ~first~
- (default) or ~last~ to display folders first or last,
- respectively. When set to ~ignore~, folders are ignored
- altogether. Any other value mixes files and folders. This
- variable has no effect when site-map style is ~tree~.
+ Where folders should appear in the sitemap. Set this to ~first~
+ (default) or ~last~ to display folders first or last, respectively.
+ When set to ~ignore~, folders are ignored altogether. Any other
+ value mixes files and folders. This variable has no effect when
+ site-map style is ~tree~.
- ~:sitemap-sort-files~ ::
- How the files are sorted in the site map. Set this to
- ~alphabetically~ (default), ~chronologically~ or
- ~anti-chronologically~. ~chronologically~ sorts the files with
- older date first while ~anti-chronologically~ sorts the files
- with newer date first. ~alphabetically~ sorts the files
- alphabetically. The date of a file is retrieved with
- ~org-publish-find-date~.
+ How the files are sorted in the site map. Set this to
+ ~alphabetically~ (default), ~chronologically~ or
+ ~anti-chronologically~. ~chronologically~ sorts the files with
+ older date first while ~anti-chronologically~ sorts the files with
+ newer date first. ~alphabetically~ sorts the files alphabetically.
+ The date of a file is retrieved with ~org-publish-find-date~.
- ~:sitemap-ignore-case~ ::
- Should sorting be case-sensitive? Default ~nil~.
+ Should sorting be case-sensitive? Default ~nil~.
- ~: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: ~%t~ stands for the title of the file, ~%a~ stands for
- the author of the file and ~%d~ stands for the date of the file.
- The date is retrieved with the ~org-publish-find-date~ function
- and formatted with ~org-publish-sitemap-date-format~. Default
- ~%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:
+ ~%t~ stands for the title of the file, ~%a~ stands for the author of
+ the file and ~%d~ stands for the date of the file. The date is
+ retrieved with the ~org-publish-find-date~ function and formatted
+ with ~org-publish-sitemap-date-format~. Default ~%t~.
- ~:sitemap-date-format~ ::
- Format string for the ~format-time-string~ function that tells
- how a sitemap entry's date is to be formatted. This property
- bypasses ~org-publish-sitemap-date-format~ which defaults to
- ~%Y-%m-%d~.
+ Format string for the ~format-time-string~ function that tells how
+ a sitemap entry's date is to be formatted. This property bypasses
+ ~org-publish-sitemap-date-format~ which defaults to ~%Y-%m-%d~.
*** Generating an index
:PROPERTIES:
@@ -15914,8 +15830,8 @@ Org mode can generate an index across the files of a publishing project.
- ~:makeindex~ ::
- When non-~nil~, generate in index in the file =theindex.org= and
- publish it as =theindex.html=.
+ When non-~nil~, generate in index in the file =theindex.org= and
+ publish it as =theindex.html=.
The file is created when first publishing a project with the
~:makeindex~ set. The file only contains a statement =#+INCLUDE:
@@ -16059,28 +15975,28 @@ Once properly configured, Org can publish with the following commands:
- {{{kbd(C-c C-e X)}}} (~org-publish~) ::
- #+kindex: C-c C-e X
- #+findex: org-publish
- Prompt for a specific project and publish all files that belong
- to it.
+ #+kindex: C-c C-e X
+ #+findex: org-publish
+ Prompt for a specific project and publish all files that belong to
+ it.
- {{{kbd(C-c C-e P)}}} (~org-publish-current-project~) ::
- #+kindex: C-c C-e P
- #+findex: org-publish-current-project
- Publish the project containing the current file.
+ #+kindex: C-c C-e P
+ #+findex: org-publish-current-project
+ Publish the project containing the current file.
- {{{kbd(C-c C-e F)}}} (~org-publish-current-file~) ::
- #+kindex: C-c C-e F
- #+findex: org-publish-current-file
- Publish only the current file.
+ #+kindex: C-c C-e F
+ #+findex: org-publish-current-file
+ Publish only the current file.
- {{{kbd(C-c C-e E)}}} (~org-publish-all~) ::
- #+kindex: C-c C-e E
- #+findex: org-publish-all
- Publish every project.
+ #+kindex: C-c C-e E
+ #+findex: org-publish-all
+ Publish every project.
#+vindex: org-publish-use-timestamps-flag
Org uses timestamps to track when a file has changed. The above
@@ -16214,46 +16130,45 @@ or
- =#+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 [[*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.
+ 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 [[*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.
- =#+BEGIN_SRC= ... =#+END_SRC= ::
- Mandatory. They mark the start and end of a block that Org
- requires. The =#+BEGIN_SRC= line takes additional arguments, as
- described next.
+ Mandatory. They mark the start and end of a block that Org
+ requires. The =#+BEGIN_SRC= line takes additional arguments, as
+ described next.
- =<language>= ::
- #+cindex: language, in code blocks
- Mandatory. It is the identifier of the source code language in
- the block. See [[*Languages]], for identifiers of supported
- languages.
+ #+cindex: language, in code blocks
+ Mandatory. It is the identifier of the source code language in the
+ block. See [[*Languages]], for identifiers of supported languages.
- =<switches>= ::
- #+cindex: switches, in code blocks
- Optional. Switches provide finer control of the code execution,
- export, and format (see the discussion of switches in [[*Literal
- Examples]]).
+ #+cindex: switches, in code blocks
+ Optional. Switches provide finer control of the code execution,
+ export, and format (see the discussion of switches in [[*Literal
+ Examples]]).
- =<header arguments>= ::
- #+cindex: header arguments, in code blocks
- Optional. Heading arguments control many aspects of evaluation,
- export and tangling of code blocks (see [[*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.
+ #+cindex: header arguments, in code blocks
+ Optional. Heading arguments control many aspects of evaluation,
+ export and tangling of code blocks (see [[*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.
- =<body>= ::
- Source code in the dialect of the specified language identifier.
+ Source code in the dialect of the specified language identifier.
** Using Header Arguments
:PROPERTIES:
@@ -16483,158 +16398,158 @@ Here are examples of passing values by reference:
- table ::
- A table named with a =NAME= keyword.
-
- #+begin_example
- ,#+NAME: example-table
- | 1 |
- | 2 |
- | 3 |
- | 4 |
-
- ,#+NAME: table-length
- ,#+BEGIN_SRC emacs-lisp :var table=example-table
- (length table)
- ,#+END_SRC
-
- ,#+RESULTS: table-length
- : 4
- #+end_example
-
- When passing a table, you can treat specially the row, or the
- column, containing labels for the columns, or the rows, in the
- table.
-
- #+cindex: @samp{colnames}, header argument
- The =colnames= header argument accepts =yes=, =no=, or =nil=
- values. The default value is =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 =yes=, Org does the same to the first row, even if the
- initial table does not contain any horizontal rule. When set to
- =no=, Org does not pre-process column names at all.
-
- #+begin_example
- ,#+NAME: less-cols
- | a |
- |---|
- | b |
- | c |
-
- ,#+BEGIN_SRC python :var tab=less-cols :colnames nil
- return [[val + '*' for val in row] for row in tab]
- ,#+END_SRC
-
- ,#+RESULTS:
- | a |
- |----|
- | b* |
- | c* |
- #+end_example
-
- #+cindex: @samp{rownames}, header argument
- Similarly, the =rownames= header argument can take two values:
- =yes= or =no=. When set to =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 =no=, which means
- Org does not pre-process the first column. Note that Emacs Lisp
- code blocks ignore =rownames= header argument because of the ease
- of table-handling in Emacs.
-
- #+begin_example
- ,#+NAME: with-rownames
- | one | 1 | 2 | 3 | 4 | 5 |
- | two | 6 | 7 | 8 | 9 | 10 |
-
- ,#+BEGIN_SRC python :var tab=with-rownames :rownames yes
- return [[val + 10 for val in row] for row in tab]
- ,#+END_SRC
-
- ,#+RESULTS:
- | one | 11 | 12 | 13 | 14 | 15 |
- | two | 16 | 17 | 18 | 19 | 20 |
- #+end_example
+ A table named with a =NAME= keyword.
+
+ #+begin_example
+ ,#+NAME: example-table
+ | 1 |
+ | 2 |
+ | 3 |
+ | 4 |
+
+ ,#+NAME: table-length
+ ,#+BEGIN_SRC emacs-lisp :var table=example-table
+ (length table)
+ ,#+END_SRC
+
+ ,#+RESULTS: table-length
+ : 4
+ #+end_example
+
+ When passing a table, you can treat specially the row, or the
+ column, containing labels for the columns, or the rows, in the
+ table.
+
+ #+cindex: @samp{colnames}, header argument
+ The =colnames= header argument accepts =yes=, =no=, or =nil=
+ values. The default value is =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 =yes=, Org does the same to the first row, even if the
+ initial table does not contain any horizontal rule. When set to
+ =no=, Org does not pre-process column names at all.
+
+ #+begin_example
+ ,#+NAME: less-cols
+ | a |
+ |---|
+ | b |
+ | c |
+
+ ,#+BEGIN_SRC python :var tab=less-cols :colnames nil
+ return [[val + '*' for val in row] for row in tab]
+ ,#+END_SRC
+
+ ,#+RESULTS:
+ | a |
+ |----|
+ | b* |
+ | c* |
+ #+end_example
+
+ #+cindex: @samp{rownames}, header argument
+ Similarly, the =rownames= header argument can take two values: =yes=
+ or =no=. When set to =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 =no=, which means Org does not
+ pre-process the first column. Note that Emacs Lisp code blocks
+ ignore =rownames= header argument because of the ease of
+ table-handling in Emacs.
+
+ #+begin_example
+ ,#+NAME: with-rownames
+ | one | 1 | 2 | 3 | 4 | 5 |
+ | two | 6 | 7 | 8 | 9 | 10 |
+
+ ,#+BEGIN_SRC python :var tab=with-rownames :rownames yes
+ return [[val + 10 for val in row] for row in tab]
+ ,#+END_SRC
+
+ ,#+RESULTS:
+ | one | 11 | 12 | 13 | 14 | 15 |
+ | two | 16 | 17 | 18 | 19 | 20 |
+ #+end_example
- list ::
- A simple named list.
+ A simple named list.
- #+begin_example
- ,#+NAME: example-list
- - simple
- - not
- - nested
- - list
+ #+begin_example
+ ,#+NAME: example-list
+ - simple
+ - not
+ - nested
+ - list
- ,#+BEGIN_SRC emacs-lisp :var x=example-list
- (print x)
- ,#+END_SRC
+ ,#+BEGIN_SRC emacs-lisp :var x=example-list
+ (print x)
+ ,#+END_SRC
- ,#+RESULTS:
- | simple | list |
- #+end_example
+ ,#+RESULTS:
+ | simple | list |
+ #+end_example
- Note that only the top level list items are passed along. Nested
- list items are ignored.
+ Note that only the top level list items are passed along. Nested
+ list items are ignored.
- code block without arguments ::
- A code block name, as assigned by =NAME= keyword from the example
- above, optionally followed by parentheses.
+ A code block name, as assigned by =NAME= keyword from the example
+ above, optionally followed by parentheses.
- #+begin_example
- ,#+BEGIN_SRC emacs-lisp :var length=table-length()
- (* 2 length)
- ,#+END_SRC
+ #+begin_example
+ ,#+BEGIN_SRC emacs-lisp :var length=table-length()
+ (* 2 length)
+ ,#+END_SRC
- ,#+RESULTS:
- : 8
- #+end_example
+ ,#+RESULTS:
+ : 8
+ #+end_example
- code block with arguments ::
- A code block name, as assigned by =NAME= keyword, followed by
- parentheses and optional arguments passed within the parentheses.
+ A code block name, as assigned by =NAME= keyword, followed by
+ parentheses and optional arguments passed within the parentheses.
- #+begin_example
- ,#+NAME: double
- ,#+BEGIN_SRC emacs-lisp :var input=8
- (* 2 input)
- ,#+END_SRC
+ #+begin_example
+ ,#+NAME: double
+ ,#+BEGIN_SRC emacs-lisp :var input=8
+ (* 2 input)
+ ,#+END_SRC
- ,#+RESULTS: double
- : 16
+ ,#+RESULTS: double
+ : 16
- ,#+NAME: squared
- ,#+BEGIN_SRC emacs-lisp :var input=double(input=1)
- (* input input)
- ,#+END_SRC
+ ,#+NAME: squared
+ ,#+BEGIN_SRC emacs-lisp :var input=double(input=1)
+ (* input input)
+ ,#+END_SRC
- ,#+RESULTS: squared
- : 4
- #+end_example
+ ,#+RESULTS: squared
+ : 4
+ #+end_example
- literal example ::
- A literal example block named with a =NAME= keyword.
+ A literal example block named with a =NAME= keyword.
- #+begin_example
- ,#+NAME: literal-example
- ,#+BEGIN_EXAMPLE
- A literal example
- on two lines
- ,#+END_EXAMPLE
+ #+begin_example
+ ,#+NAME: literal-example
+ ,#+BEGIN_EXAMPLE
+ A literal example
+ on two lines
+ ,#+END_EXAMPLE
- ,#+NAME: read-literal-example
- ,#+BEGIN_SRC emacs-lisp :var x=literal-example
- (concatenate #'string x " for you.")
- ,#+END_SRC
+ ,#+NAME: read-literal-example
+ ,#+BEGIN_SRC emacs-lisp :var x=literal-example
+ (concatenate #'string x " for you.")
+ ,#+END_SRC
- ,#+RESULTS: read-literal-example
- : A literal example
- : on two lines for you.
- #+end_example
+ ,#+RESULTS: read-literal-example
+ : A literal example
+ : on two lines for you.
+ #+end_example
Indexing variable values enables referencing portions of a variable.
Indexes are 0 based with negative values counting backwards from the
@@ -16771,20 +16686,20 @@ interpreter process.
- =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.
- {{{var(STRING)}}} ::
- Any string besides =none= turns that string into the name of that
- session. For example, =:session STRING= names it =STRING=. If
- =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.
+ Any string besides =none= turns that string into the name of that
+ session. For example, =:session STRING= names it =STRING=. If
+ =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.
Only languages that provide interactive evaluation can have session
support. Not all languages provide this support, such as C and ditaa.
@@ -16925,42 +16840,41 @@ variable ~org-babel-inline-result-wrap~, which by default is set to
- =<name>= ::
- This is the name of the code block (see [[*Structure of Code
- Blocks]]) to be evaluated in the current document. If the block is
- located in another file, start =<name>= with the file name
- followed by a colon. For example, in order to execute a block
- named =clear-data= in =file.org=, you can write the following:
+ This is the name of the code block (see [[*Structure of Code Blocks]])
+ to be evaluated in the current document. If the block is located in
+ another file, start =<name>= with the file name followed by
+ a colon. For example, in order to execute a block named =clear-data=
+ in =file.org=, you can write the following:
- : #+CALL: file.org:clear-data()
+ : #+CALL: file.org:clear-data()
- =<arguments>= ::
- Org passes arguments to the code block using standard function
- call syntax. For example, a =#+CALL:= line that passes =4= to
- a code block named =double=, which declares the header argument
- =:var n=2=, would be written as:
+ Org passes arguments to the code block using standard function call
+ syntax. For example, a =#+CALL:= line that passes =4= to a code
+ block named =double=, which declares the header argument =:var n=2=,
+ would be written as:
- : #+CALL: double(n=4)
+ : #+CALL: double(n=4)
- #+texinfo: @noindent
- Note how this function call syntax is different from the header
- argument syntax.
+ #+texinfo: @noindent
+ Note how this function call syntax is different from the header
+ argument syntax.
- =<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, =[: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, =[: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.
- =<end header arguments>= ::
- End header arguments affect the results returned by the code
- block. For example, =:results html= wraps the results in
- a =#+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, =:results html= wraps the results in a =#+BEGIN_EXPORT
+ html= block before inserting the results in the Org buffer.
*** Limit code block evaluation
:PROPERTIES:
@@ -16975,21 +16889,21 @@ evaluating untrusted code blocks by prompting for a confirmation.
- =never= or =no= ::
- Org never evaluates the source code.
+ Org never evaluates the source code.
- =query= ::
- Org prompts the user for permission to evaluate the source code.
+ Org prompts the user for permission to evaluate the source code.
- =never-export= or =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.
- =query-export= ::
- Org prompts the user for permission to evaluate the source code
- during export.
+ Org prompts the user for permission to evaluate the source code
+ during export.
If =eval= header argument is not set, then Org determines whether to
evaluate the source code from the ~org-confirm-babel-evaluate~
@@ -17031,18 +16945,17 @@ The =cache= header argument can have one of two values: =yes= or =no=.
- =no= ::
- Default. No caching of results; code block evaluated every
- time.
+ Default. No caching of results; code block evaluated every time.
- =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 =#+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 =#+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
+ =#+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 =#+RESULTS:= line.
In this example, both functions are cached. But =caller= runs only if
the result from =random= has changed since the last run.
@@ -17080,21 +16993,21 @@ Each code block can take only one option per class:
- collection ::
- For how the results should be collected from the code block;
+ For how the results should be collected from the code block;
- type ::
- For which type of result the code block will return; affects how
- Org processes and inserts results in the Org buffer;
+ For which type of result the code block will return; affects how Org
+ processes and inserts results in the Org buffer;
- format ::
- For the result; affects how Org processes and inserts results in
- the Org buffer;
+ For the result; affects how Org processes and inserts results in the
+ Org buffer;
- handling ::
- For processing results after evaluation of the code block;
+ For processing results after evaluation of the code block;
*** Collection
:PROPERTIES:
@@ -17106,67 +17019,66 @@ they are mutually exclusive.
- =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 =:results value=, code should
- execute like a function and return a value. For languages like
- Python, an explicit ~return~ statement is mandatory when using
- =:results value=. Result is the value returned by the last
- statement in the code block.
-
- When evaluating the code block in a session (see [[*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 ~_~ in Python and Ruby, and the value of
- ~.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 =:results value=, code should execute like
+ a function and return a value. For languages like Python, an
+ explicit ~return~ statement is mandatory when using =:results
+ value=. Result is the value returned by the last statement in the
+ code block.
+
+ When evaluating the code block in a session (see [[*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 ~_~ in Python and Ruby, and the value of ~.Last.value~
+ in R.
- =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.
-
- 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:
-
- #+begin_example
- ,#+BEGIN_SRC python :results output
- print "hello"
- 2
- print "bye"
- ,#+END_SRC
-
- ,#+RESULTS:
- : hello
- : bye
- #+end_example
-
- In the above non-session mode, the "2" is not printed; so it does
- not appear in results.
-
- #+begin_example
- ,#+BEGIN_SRC python :results output :session
- print "hello"
- 2
- print "bye"
- ,#+END_SRC
-
- ,#+RESULTS:
- : hello
- : 2
- : bye
- #+end_example
-
- In the above session, the interactive interpreter receives and
- prints "2". Results show that.
+ 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.
+
+ 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:
+
+ #+begin_example
+ ,#+BEGIN_SRC python :results output
+ print "hello"
+ 2
+ print "bye"
+ ,#+END_SRC
+
+ ,#+RESULTS:
+ : hello
+ : bye
+ #+end_example
+
+ In the above non-session mode, the "2" is not printed; so it does
+ not appear in results.
+
+ #+begin_example
+ ,#+BEGIN_SRC python :results output :session
+ print "hello"
+ 2
+ print "bye"
+ ,#+END_SRC
+
+ ,#+RESULTS:
+ : hello
+ : 2
+ : bye
+ #+end_example
+
+ In the above session, the interactive interpreter receives and
+ prints "2". Results show that.
*** Type
:PROPERTIES:
@@ -17180,105 +17092,103 @@ default behavior is to automatically determine the result type.
#+attr_texinfo: :sep ,
- =table=, =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: =: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 =hlines= argument with the default =no= value strips such
- lines from the input table. For most code, this is desirable, or
- else those =hline= symbols raise unbound variable errors.
- A =yes= accepts such lines, as demonstrated in the following
- example.
-
- #+begin_example
- ,#+NAME: many-cols
- | a | b | c |
- |---+---+---|
- | d | e | f |
- |---+---+---|
- | g | h | i |
-
- ,#+NAME: no-hline
- ,#+BEGIN_SRC python :var tab=many-cols :hlines no
- return tab
- ,#+END_SRC
-
- ,#+RESULTS: no-hline
- | a | b | c |
- | d | e | f |
- | g | h | i |
-
- ,#+NAME: hlines
- ,#+BEGIN_SRC python :var tab=many-cols :hlines yes
- return tab
- ,#+END_SRC
-
- ,#+RESULTS: hlines
- | a | b | c |
- |---+---+---|
- | d | e | f |
- |---+---+---|
- | g | h | i |
- #+end_example
+ 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:
+ =: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 =hlines= argument with the default =no= value strips such lines
+ from the input table. For most code, this is desirable, or else
+ those =hline= symbols raise unbound variable errors. A =yes=
+ accepts such lines, as demonstrated in the following example.
+
+ #+begin_example
+ ,#+NAME: many-cols
+ | a | b | c |
+ |---+---+---|
+ | d | e | f |
+ |---+---+---|
+ | g | h | i |
+
+ ,#+NAME: no-hline
+ ,#+BEGIN_SRC python :var tab=many-cols :hlines no
+ return tab
+ ,#+END_SRC
+
+ ,#+RESULTS: no-hline
+ | a | b | c |
+ | d | e | f |
+ | g | h | i |
+
+ ,#+NAME: hlines
+ ,#+BEGIN_SRC python :var tab=many-cols :hlines yes
+ return tab
+ ,#+END_SRC
+
+ ,#+RESULTS: hlines
+ | a | b | c |
+ |---+---+---|
+ | d | e | f |
+ |---+---+---|
+ | g | h | i |
+ #+end_example
- =list= ::
- Interpret the results as an Org list. If the result is a single
- value, create a list of one element.
+ Interpret the results as an Org list. If the result is a single
+ value, create a list of one element.
- =scalar=, =verbatim= ::
- Interpret literally and insert as quoted text. Do not create
- a table. Usage example: =:results value verbatim=.
+ Interpret literally and insert as quoted text. Do not create
+ a table. Usage example: =:results value verbatim=.
- =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.
-
- #+cindex: @samp{file}, header argument
- #+cindex: @samp{output-dir}, header argument
- Org first tries to generate the filename from the value of the
- =file= header argument and the directory specified using the
- =output-dir= header arguments. If =output-dir= is not specified,
- Org assumes it is the current directory.
-
- #+begin_example
- ,#+BEGIN_SRC asymptote :results value file :file circle.pdf :output-dir img/
- size(2cm);
- draw(unitcircle);
- ,#+END_SRC
- #+end_example
-
- #+cindex: @samp{file-ext}, header argument
- If =file= is missing, Org generates the base name of the output
- file from the name of the code block, and its extension from the
- =file-ext= header argument. In that case, both the name and the
- extension are mandatory[fn:141].
-
- #+begin_example
- ,#+name: circle
- ,#+BEGIN_SRC asymptote :results value file :file-ext pdf
- size(2cm);
- draw(unitcircle);
- ,#+END_SRC
- #+end_example
-
- #+cindex: @samp{file-desc}, header argument
- The =file-desc= header argument defines the description (see
- [[*Link Format]]) for the link. If =file-desc= has no value, Org
- uses the generated file name for both the "link" and
- "description" parts of the link.
-
- #+cindex: @samp{sep}, header argument
- By default, Org assumes that a table written to a file has
- TAB-delimited output. You can choose a different separator with
- the =sep= header argument.
+ 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
+ Org first tries to generate the filename from the value of the
+ =file= header argument and the directory specified using the
+ =output-dir= header arguments. If =output-dir= is not specified,
+ Org assumes it is the current directory.
+
+ #+begin_example
+ ,#+BEGIN_SRC asymptote :results value file :file circle.pdf :output-dir img/
+ size(2cm);
+ draw(unitcircle);
+ ,#+END_SRC
+ #+end_example
+
+ #+cindex: @samp{file-ext}, header argument
+ If =file= is missing, Org generates the base name of the output
+ file from the name of the code block, and its extension from the
+ =file-ext= header argument. In that case, both the name and the
+ extension are mandatory[fn:141].
+
+ #+begin_example
+ ,#+name: circle
+ ,#+BEGIN_SRC asymptote :results value file :file-ext pdf
+ size(2cm);
+ draw(unitcircle);
+ ,#+END_SRC
+ #+end_example
+
+ #+cindex: @samp{file-desc}, header argument
+ The =file-desc= header argument defines the description (see
+ [[*Link Format]]) for the link. If =file-desc= has no value, Org
+ uses the generated file name for both the "link" and
+ "description" parts of the link.
+
+ #+cindex: @samp{sep}, header argument
+ By default, Org assumes that a table written to a file has
+ TAB-delimited output. You can choose a different separator with
+ the =sep= header argument.
*** Format
:PROPERTIES:
@@ -17292,54 +17202,54 @@ follows from the type specified above.
#+attr_texinfo: :sep ,
- =code= ::
- Result enclosed in a code block. Useful for parsing. Usage
- example: =:results value code=.
+ Result enclosed in a code block. Useful for parsing. Usage
+ example: =:results value code=.
- =drawer= ::
- Result wrapped in a =RESULTS= drawer. Useful for containing
- =raw= or =org= results for later scripting and automated
- processing. Usage example: =:results value drawer=.
+ Result wrapped in a =RESULTS= drawer. Useful for containing =raw=
+ or =org= results for later scripting and automated processing.
+ Usage example: =:results value drawer=.
- =html= ::
- Results enclosed in a =BEGIN_EXPORT html= block. Usage example:
- =:results value html=.
+ Results enclosed in a =BEGIN_EXPORT html= block. Usage example:
+ =:results value html=.
- =latex= ::
- Results enclosed in a =BEGIN_EXPORT latex= block. Usage example:
- =:results value latex=.
+ Results enclosed in a =BEGIN_EXPORT latex= block. Usage example:
+ =:results value latex=.
- =link=, =graphics= ::
- Result is a link to the file specified in =:file= header
- argument. However, unlike plain =: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 =:file= header argument.
+ However, unlike plain =:file=, nothing is written to the disk. The
+ block is used for its side-effects only, as in the following
+ example:
- #+begin_example
- ,#+begin_src shell :results link :file "download.tar.gz"
- wget -c "http://example.com/download.tar.gz"
- ,#+end_src
- #+end_example
+ #+begin_example
+ ,#+begin_src shell :results link :file "download.tar.gz"
+ wget -c "http://example.com/download.tar.gz"
+ ,#+end_src
+ #+end_example
- =org= ::
- Results enclosed in a =BEGIN_SRC org= block. For comma-escape,
- either {{{kbd(TAB)}}} in the block, or export the file. Usage
- example: =:results value org=.
+ Results enclosed in a =BEGIN_SRC org= block. For comma-escape,
+ either {{{kbd(TAB)}}} in the block, or export the file. Usage
+ example: =:results value org=.
- =pp= ::
- Result converted to pretty-print source code. Enclosed in a code
- block. Languages supported: Emacs Lisp, Python, and Ruby. Usage
- example: =:results value pp=.
+ Result converted to pretty-print source code. Enclosed in a code
+ block. Languages supported: Emacs Lisp, Python, and Ruby. Usage
+ example: =:results value pp=.
- =raw= ::
- Interpreted as raw Org mode. Inserted directly into the buffer.
- Aligned if it is a table. Usage example: =:results value raw=.
+ Interpreted as raw Org mode. Inserted directly into the buffer.
+ Aligned if it is a table. Usage example: =:results value raw=.
#+cindex: @samp{wrap}, header argument
The =wrap= header argument unconditionnally marks the results block by
@@ -17368,25 +17278,25 @@ Handling options after collecting the results.
- =silent= ::
- Do not insert results in the Org mode buffer, but echo them in
- the minibuffer. Usage example: =:results output silent=.
+ Do not insert results in the Org mode buffer, but echo them in the
+ minibuffer. Usage example: =:results output silent=.
- =replace= ::
- Default. Insert results in the Org buffer. Remove previous
- results. Usage example: =:results output replace=.
+ Default. Insert results in the Org buffer. Remove previous
+ results. Usage example: =:results output replace=.
- =append= ::
- Append results to the Org buffer. Latest results are at the
- bottom. Does not remove previous results. Usage example:
- =:results output append=.
+ Append results to the Org buffer. Latest results are at the bottom.
+ Does not remove previous results. Usage example: =:results output
+ append=.
- =prepend= ::
- Prepend results to the Org buffer. Latest results are at the
- top. Does not remove previous results. Usage example: =:results
- output prepend=.
+ Prepend results to the Org buffer. Latest results are at the top.
+ Does not remove previous results. Usage example: =:results output
+ prepend=.
*** Post-processing
:PROPERTIES:
@@ -17476,24 +17386,24 @@ file is exported to, say, HTML or LaTeX formats.
- =code= ::
- The default. The body of code is included into the exported
- file. Example: =:exports code=.
+ The default. The body of code is included into the exported file.
+ Example: =:exports code=.
- =results= ::
- The results of evaluation of the code is included in the exported
- file. Example: =:exports results=.
+ The results of evaluation of the code is included in the exported
+ file. Example: =:exports results=.
- =both= ::
- Both the code and results of evaluation are included in the
- exported file. Example: =:exports both=.
+ Both the code and results of evaluation are included in the exported
+ file. Example: =:exports both=.
- =none= ::
- Neither the code nor the results of evaluation is included in the
- exported file. Whether the code is evaluated at all depends on
- other options. Example: =:exports none=.
+ Neither the code nor the results of evaluation is included in the
+ exported file. Whether the code is evaluated at all depends on
+ other options. Example: =:exports none=.
#+vindex: org-export-use-babel
To stop Org from evaluating code blocks to speed exports, use the
@@ -17548,22 +17458,22 @@ to source file(s).
- =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: =: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: =:tangle yes=.
- =no= ::
- The default. Do not extract the code in a source code file.
- Example: =:tangle no=.
+ The default. Do not extract the code in a source code file.
+ Example: =:tangle no=.
- {{{var(FILENAME)}}} ::
- Export the code block to source file whose file name is derived
- from any string passed to the =tangle= header argument. Org
- derives the file name as being relative to the directory of the
- Org file's location. Example: =:tangle FILENAME=.
+ Export the code block to source file whose file name is derived from
+ any string passed to the =tangle= header argument. Org derives the
+ file name as being relative to the directory of the Org file's
+ location. Example: =:tangle FILENAME=.
#+cindex: @samp{mkdirp}, header argument
The =mkdirp= header argument creates parent directories for tangled
@@ -17577,32 +17487,32 @@ already exist in the code block.
- =no= ::
- The default. Do not insert any extra comments during tangling.
+ The default. Do not insert any extra comments during tangling.
- =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.
- =yes= ::
- Kept for backward compatibility; same as =link=.
+ Kept for backward compatibility; same as =link=.
- =org= ::
- Nearest headline text from Org file is inserted as comment. The
- exact text that is inserted is picked from the leading context of
- the source block.
+ Nearest headline text from Org file is inserted as comment. The
+ exact text that is inserted is picked from the leading context of
+ the source block.
- =both= ::
- Includes both =link= and =org= options.
+ Includes both =link= and =org= options.
- =noweb= ::
- Includes =link= option, expands Noweb references (see [[*Noweb
- Reference Syntax]]), and wraps them in link comments inside the
- body of the code block.
+ Includes =link= option, expands Noweb references (see [[*Noweb
+ Reference Syntax]]), and wraps them in link comments inside the body
+ of the code block.
#+cindex: @samp{padline}, header argument
The =padline= header argument controls insertion of newlines to pad
@@ -17610,12 +17520,12 @@ source code in the tangled file.
- =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.
- =no= ::
- Do not insert newlines to pad the tangled code blocks.
+ Do not insert newlines to pad the tangled code blocks.
#+cindex: @samp{shebang}, header argument
The =shebang= header argument can turn results into executable script
@@ -17652,17 +17562,17 @@ expanded anyway.
- ~org-babel-tangle~ ::
- #+findex: org-babel-tangle
- #+kindex: C-c C-v t
- Tangle the current file. Bound to {{{kbd(C-c C-v t)}}}.
+ #+findex: org-babel-tangle
+ #+kindex: C-c C-v t
+ Tangle the current file. Bound to {{{kbd(C-c C-v t)}}}.
- With prefix argument only tangle the current code block.
+ With prefix argument only tangle the current code block.
- ~org-babel-tangle-file~ ::
- #+findex: org-babel-tangle-file
- #+kindex: C-c C-v f
- Choose a file to tangle. Bound to {{{kbd(C-c C-v f)}}}.
+ #+findex: org-babel-tangle-file
+ #+kindex: C-c C-v f
+ Choose a file to tangle. Bound to {{{kbd(C-c C-v f)}}}.
*** Hooks
:PROPERTIES:
@@ -17671,10 +17581,10 @@ expanded anyway.
- ~org-babel-post-tangle-hook~ ::
- #+vindex: org-babel-post-tangle-hook
- This hook is run from within code files tangled by
- ~org-babel-tangle~, making it suitable for post-processing,
- compilation, and evaluation of code in the tangled files.
+ #+vindex: org-babel-post-tangle-hook
+ This hook is run from within code files tangled by
+ ~org-babel-tangle~, making it suitable for post-processing,
+ compilation, and evaluation of code in the tangled files.
*** Jumping between code and Org
:PROPERTIES:
@@ -17783,34 +17693,34 @@ group ~org-edit-structure~.
- ~org-src-lang-modes~ ::
- #+vindex: org-src-lang-modes
- If an Emacs major-mode named ~<LANG>-mode~ exists, where
- {{{var(<LANG>)}}} is the language identifier from code block's
- header line, then the edit buffer uses that major mode. Use this
- variable to arbitrarily map language identifiers to major modes.
+ #+vindex: org-src-lang-modes
+ If an Emacs major-mode named ~<LANG>-mode~ exists, where
+ {{{var(<LANG>)}}} is the language identifier from code block's
+ header line, then the edit buffer uses that major mode. Use this
+ variable to arbitrarily map language identifiers to major modes.
- ~org-src-window-setup~ ::
- #+vindex: org-src-window-setup
- For specifying Emacs window arrangement when the new edit buffer
- is created.
+ #+vindex: org-src-window-setup
+ For specifying Emacs window arrangement when the new edit buffer is
+ created.
- ~org-src-preserve-indentation~ ::
- #+cindex: indentation, in code blocks
- #+vindex: org-src-preserve-indentation
- Default is ~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-~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.
+ #+cindex: indentation, in code blocks
+ #+vindex: org-src-preserve-indentation
+ Default is ~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-~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.
- ~org-src-ask-before-returning-to-edit-buffer~ ::
- #+vindex: org-src-ask-before-returning-to-edit-buffer
- When ~nil~, Org returns to the edit buffer without further
- prompts. The default prompts for a confirmation.
+ #+vindex: org-src-ask-before-returning-to-edit-buffer
+ When ~nil~, Org returns to the edit buffer without further prompts.
+ The default prompts for a confirmation.
#+vindex: org-src-fontify-natively
#+vindex: org-src-block-faces
@@ -17854,34 +17764,34 @@ tangled, or exported.
- =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.
- =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.
- =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.
- =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.
- =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.
- =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.
In the following example,
@@ -18270,40 +18180,39 @@ have become an integral part of Emacs and Org provides several
shortcuts.
- {{{kbd(M-TAB)}}} ::
- #+kindex: M-TAB
+ #+kindex: M-TAB
- Complete word at point.
+ Complete word at point.
- - At the beginning of a headline, complete TODO keywords.
+ - At the beginning of a headline, complete TODO keywords.
- - After =\=, complete TeX symbols supported by the exporter.
+ - After =\=, complete TeX symbols supported by the exporter.
- - After =*=, complete headlines in the current buffer so that
- they can be used in search links like:
+ - After =*=, complete headlines in the current buffer so that they
+ can be used in search links like:
- : [[*find this headline]]
+ : [[*find this headline]]
- - After =:= in a headline, complete tags. Org deduces the list
- of tags from the =TAGS= in-buffer option (see [[*Setting Tags]]),
- the variable ~org-tag-alist~, or from all tags used in the
- current buffer.
+ - After =:= in a headline, complete tags. Org deduces the list of
+ tags from the =TAGS= in-buffer option (see [[*Setting Tags]]), the
+ variable ~org-tag-alist~, or from all tags used in the current
+ buffer.
- - After =:= and not in a headline, complete property keys. The
- list of keys is constructed dynamically from all keys used in
- the current buffer.
+ - After =:= and not in a headline, complete property keys. The list
+ of keys is constructed dynamically from all keys used in the
+ current buffer.
- - After =[=, complete link abbreviations (see [[*Link
- Abbreviations]]).
+ - After =[=, complete link abbreviations (see [[*Link Abbreviations]]).
- - After =#+=, complete the special keywords like =TYP_TODO= or
- file-specific =OPTIONS=. After option keyword is complete,
- pressing {{{kbd(M-TAB)}}} again inserts example settings for
- this keyword.
+ - After =#+=, complete the special keywords like =TYP_TODO= or
+ file-specific =OPTIONS=. After option keyword is complete,
+ pressing {{{kbd(M-TAB)}}} again inserts example settings for this
+ keyword.
- - After =STARTUP= keyword, complete startup items.
+ - After =STARTUP= keyword, complete startup items.
- - When point is anywhere else, complete dictionary words using
- Ispell.
+ - When point is anywhere else, complete dictionary words using
+ Ispell.
** Structure Templates
:PROPERTIES:
@@ -18318,14 +18227,13 @@ text in such a block.
- {{{kbd(C-c C-\,)}}} (~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(TAB)}}}, {{{kbd(RET)}}}, or {{{kbd(SPC)}}}, the user is
- prompted to enter a block type.
+ #+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(TAB)}}}, {{{kbd(RET)}}},
+ or {{{kbd(SPC)}}}, the user is prompted to enter a block type.
#+vindex: org-structure-template-alist
Available structure types are defined in
@@ -18422,56 +18330,54 @@ Org evaluates code in the following circumstances:
- /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.
-
- #+attr_texinfo: :options org-confirm-babel-evaluate
- #+begin_defopt
- When ~t~, Org prompts the user for confirmation before executing
- each code block. When ~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 ~t~ or ~nil~,
- which determines if the user is prompted. Each source code
- language can be handled separately through this function
- argument.
- #+end_defopt
-
- For example, here is how to execute ditaa code blocks without
- prompting:
-
- #+begin_src emacs-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_src
+ 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.
+
+ #+attr_texinfo: :options org-confirm-babel-evaluate
+ #+begin_defopt
+ When ~t~, Org prompts the user for confirmation before executing
+ each code block. When ~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 ~t~ or ~nil~, which
+ determines if the user is prompted. Each source code language can
+ be handled separately through this function argument.
+ #+end_defopt
+
+ For example, here is how to execute ditaa code blocks without
+ prompting:
+
+ #+begin_src emacs-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_src
- /Following =shell= and =elisp= links/ ::
- Org has two link types that can directly evaluate code (see
- [[*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:
+ Org has two link types that can directly evaluate code (see
+ [[*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:
- #+attr_texinfo: :options org-confirm-shell-link-function
- #+begin_defopt
- Function that prompts the user before executing a shell link.
- #+end_defopt
+ #+attr_texinfo: :options org-confirm-shell-link-function
+ #+begin_defopt
+ Function that prompts the user before executing a shell link.
+ #+end_defopt
- #+attr_texinfo: :options org-confirm-elisp-link-function
- #+begin_defopt
- Function that prompts the user before executing an Emacs Lisp link.
- #+end_defopt
+ #+attr_texinfo: :options org-confirm-elisp-link-function
+ #+begin_defopt
+ Function that prompts the user before executing an Emacs Lisp link.
+ #+end_defopt
- /Formulas in tables/ ::
- Formulas in tables (see [[*The Spreadsheet]]) are code that is
- evaluated either by the Calc interpreter, or by the Emacs Lisp
- interpreter.
+ Formulas in tables (see [[*The Spreadsheet]]) are code that is evaluated
+ either by the Calc interpreter, or by the Emacs Lisp interpreter.
** Customization
:PROPERTIES:
@@ -18509,358 +18415,359 @@ changes.
#+attr_texinfo: :sep ,
- =#+ARCHIVE: %s_done= ::
- #+cindex: @samp{ARCHIVE}, keyword
- #+vindex: org-archive-location
- Sets the archive location of the agenda file. The corresponding
- variable is ~org-archive-location~.
+ #+cindex: @samp{ARCHIVE}, keyword
+ #+vindex: org-archive-location
+ Sets the archive location of the agenda file. The corresponding
+ variable is ~org-archive-location~.
- =#+CATEGORY= ::
- #+cindex: @samp{CATEGORY}, keyword
- Sets the category of the agenda file, which applies to the entire
- document.
+ #+cindex: @samp{CATEGORY}, keyword
+ Sets the category of the agenda file, which applies to the entire
+ document.
- =#+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 =COLUMNS=
- property applies.
+ #+cindex: @samp{COLUMNS}, property
+ Set the default format for columns view. This format applies when
+ columns view is invoked in locations where no =COLUMNS= property
+ applies.
- =#+CONSTANTS: name1=value1 ...= ::
- #+cindex: @samp{CONSTANTS}, keyword
- #+vindex: org-table-formula-constants
- #+vindex: org-table-formula
- Set file-local values for constants that table formulas can use.
- This line sets the local variable
- ~org-table-formula-constants-local~. The global version of this
- variable is ~org-table-formula-constants~.
+ #+cindex: @samp{CONSTANTS}, keyword
+ #+vindex: org-table-formula-constants
+ #+vindex: org-table-formula
+ Set file-local values for constants that table formulas can use.
+ This line sets the local variable
+ ~org-table-formula-constants-local~. The global version of this
+ variable is ~org-table-formula-constants~.
- =#+FILETAGS: :tag1:tag2:tag3:= ::
- #+cindex: @samp{FILETAGS}, keyword
- Set tags that all entries in the file inherit from, including the
- top-level entries.
+ #+cindex: @samp{FILETAGS}, keyword
+ Set tags that all entries in the file inherit from, including the
+ top-level entries.
- =#+LINK: linkword replace= ::
- #+cindex: @samp{LINK}, keyword
- #+vindex: org-link-abbrev-alist
- Each line specifies one abbreviation for one link. Use multiple
- =LINK= keywords for more, see [[*Link Abbreviations]]. The
- corresponding variable is ~org-link-abbrev-alist~.
+ #+cindex: @samp{LINK}, keyword
+ #+vindex: org-link-abbrev-alist
+ Each line specifies one abbreviation for one link. Use multiple
+ =LINK= keywords for more, see [[*Link Abbreviations]]. The
+ corresponding variable is ~org-link-abbrev-alist~.
- =#+PRIORITIES: highest lowest default= ::
- #+cindex: @samp{PRIORITIES}, keyword
- #+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.
+ #+cindex: @samp{PRIORITIES}, keyword
+ #+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.
- =#+PROPERTY: Property_Name Value= ::
- #+cindex: @samp{PROPERTY}, keyword
- This line sets a default inheritance value for entries in the
- current buffer, most useful for specifying the allowed values of
- a property.
+ #+cindex: @samp{PROPERTY}, keyword
+ This line sets a default inheritance value for entries in the
+ current buffer, most useful for specifying the allowed values of
+ a property.
- =#+SETUPFILE: file= ::
- #+cindex: @samp{SETUPFILE}, keyword
- The setup file or a URL pointing to such file is for additional
- 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.
+ #+cindex: @samp{SETUPFILE}, keyword
+ The setup file or a URL pointing to such file is for additional
+ 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.
- =#+STARTUP:= ::
- #+cindex: @samp{STARTUP}, keyword
- Startup options Org uses when first visiting a file.
+ #+cindex: @samp{STARTUP}, keyword
+ 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 ~org-startup-folded~ with a default value of ~t~,
- which is the same as ~overview~.
+ #+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 ~org-startup-folded~ with a default value of ~t~, which
+ is the same as ~overview~.
- - =overview= ::
+ - =overview= ::
- Top-level headlines only.
+ Top-level headlines only.
- - =content= ::
+ - =content= ::
- All headlines.
+ All headlines.
- - =showall= ::
+ - =showall= ::
- No folding on any entry.
+ No folding on any entry.
- - =showeverything= ::
+ - =showeverything= ::
- Show even drawer contents.
+ Show even drawer contents.
- #+vindex: org-startup-indented
- Dynamic virtual indentation is controlled by the variable
- ~org-startup-indented~[fn:146].
+ #+vindex: org-startup-indented
+ Dynamic virtual indentation is controlled by the variable
+ ~org-startup-indented~[fn:146].
- - =indent= ::
+ - =indent= ::
- Start with ~org-indent-mode~ turned on.
+ Start with ~org-indent-mode~ turned on.
- - =noindent= ::
+ - =noindent= ::
- Start with ~org-indent-mode~ turned off.
+ Start with ~org-indent-mode~ turned off.
- #+vindex: org-startup-align-all-tables
- Aligns tables consistently upon visiting a file. The corresponding
- variable is ~org-startup-align-all-tables~ with ~nil~ as default
- value.
+ #+vindex: org-startup-align-all-tables
+ Aligns tables consistently upon visiting a file. The
+ corresponding variable is ~org-startup-align-all-tables~ with
+ ~nil~ as default value.
- - =align= ::
+ - =align= ::
- Align all tables.
+ Align all tables.
- - =noalign= ::
+ - =noalign= ::
- Do not align tables on startup.
+ Do not align tables on startup.
- #+vindex: org-startup-shrink-all-tables
- Shrink table columns with a width cookie. The corresponding
- variable is ~org-startup-shrink-all-tables~ with ~nil~ as default
- value.
+ #+vindex: org-startup-shrink-all-tables
+ Shrink table columns with a width cookie. The corresponding
+ variable is ~org-startup-shrink-all-tables~ with ~nil~ as
+ default value.
- #+vindex: org-startup-with-inline-images
- When visiting a file, inline images can be automatically displayed.
- The corresponding variable is ~org-startup-with-inline-images~,
- with a default value ~nil~ to avoid delays when visiting a file.
+ #+vindex: org-startup-with-inline-images
+ When visiting a file, inline images can be automatically
+ displayed. The corresponding variable is
+ ~org-startup-with-inline-images~, with a default value ~nil~ to
+ avoid delays when visiting a file.
- - =inlineimages= ::
+ - =inlineimages= ::
- Show inline images.
+ Show inline images.
- - =noinlineimages= ::
+ - =noinlineimages= ::
- Do not show inline images on startup.
+ Do not show inline images on startup.
- #+vindex: org-log-done
- #+vindex: org-log-note-clock-out
- #+vindex: org-log-repeat
- Logging the closing and reopening of TODO items and clock
- intervals can be configured using these options (see variables
- ~org-log-done~, ~org-log-note-clock-out~, and ~org-log-repeat~).
+ #+vindex: org-log-done
+ #+vindex: org-log-note-clock-out
+ #+vindex: org-log-repeat
+ Logging the closing and reopening of TODO items and clock
+ intervals can be configured using these options (see variables
+ ~org-log-done~, ~org-log-note-clock-out~, and ~org-log-repeat~).
- - =logdone= ::
+ - =logdone= ::
- Record a timestamp when an item is marked DONE.
+ Record a timestamp when an item is marked DONE.
- - =lognotedone= ::
+ - =lognotedone= ::
- Record timestamp and a note when DONE.
+ Record timestamp and a note when DONE.
- - =nologdone= ::
+ - =nologdone= ::
- Do not record when items are marked DONE.
+ Do not record when items are marked DONE.
- - =logrepeat= ::
+ - =logrepeat= ::
- Record a time when reinstating a repeating item.
+ Record a time when reinstating a repeating item.
- - =lognoterepeat= ::
+ - =lognoterepeat= ::
- Record a note when reinstating a repeating item.
+ Record a note when reinstating a repeating item.
- - =nologrepeat= ::
+ - =nologrepeat= ::
- Do not record when reinstating repeating item.
+ Do not record when reinstating repeating item.
- - =lognoteclock-out= ::
+ - =lognoteclock-out= ::
- Record a note when clocking out.
+ Record a note when clocking out.
- - =nolognoteclock-out= ::
+ - =nolognoteclock-out= ::
- Do not record a note when clocking out.
+ Do not record a note when clocking out.
- - =logreschedule= ::
+ - =logreschedule= ::
- Record a timestamp when scheduling time changes.
+ Record a timestamp when scheduling time changes.
- - =lognotereschedule= ::
+ - =lognotereschedule= ::
- Record a note when scheduling time changes.
+ Record a note when scheduling time changes.
- - =nologreschedule= ::
+ - =nologreschedule= ::
- Do not record when a scheduling date changes.
+ Do not record when a scheduling date changes.
- - =logredeadline= ::
+ - =logredeadline= ::
- Record a timestamp when deadline changes.
+ Record a timestamp when deadline changes.
- - =lognoteredeadline= ::
+ - =lognoteredeadline= ::
- Record a note when deadline changes.
+ Record a note when deadline changes.
- - =nologredeadline= ::
+ - =nologredeadline= ::
- Do not record when a deadline date changes.
+ Do not record when a deadline date changes.
- - =logrefile= ::
+ - =logrefile= ::
- Record a timestamp when refiling.
+ Record a timestamp when refiling.
- - =lognoterefile= ::
+ - =lognoterefile= ::
- Record a note when refiling.
+ Record a note when refiling.
- - =nologrefile= ::
+ - =nologrefile= ::
- Do not record when refiling.
+ Do not record when refiling.
- #+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
- ~org-hide-leading-stars~ and ~org-odd-levels-only~, both with
- a default setting ~nil~ (meaning =showstars= and =oddeven=).
+ #+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 ~org-hide-leading-stars~ and
+ ~org-odd-levels-only~, both with a default setting ~nil~
+ (meaning =showstars= and =oddeven=).
- - =hidestars= ::
+ - =hidestars= ::
- Make all but one of the stars starting a headline invisible.
+ Make all but one of the stars starting a headline invisible.
- - =showstars= ::
+ - =showstars= ::
- Show all stars starting a headline.
+ Show all stars starting a headline.
- - =indent= ::
+ - =indent= ::
- Virtual indentation according to outline level.
+ Virtual indentation according to outline level.
- - =noindent= ::
+ - =noindent= ::
- No virtual indentation according to outline level.
+ No virtual indentation according to outline level.
- - =odd= ::
+ - =odd= ::
- Allow only odd outline levels (1, 3, ...).
+ Allow only odd outline levels (1, 3, ...).
- - =oddeven= ::
+ - =oddeven= ::
- Allow all outline levels.
+ Allow all outline levels.
- #+vindex: org-put-time-stamp-overlays
- #+vindex: org-time-stamp-overlay-formats
- To turn on custom format overlays over timestamps (variables
- ~org-put-time-stamp-overlays~ and ~org-time-stamp-overlay-formats~),
- use:
+ #+vindex: org-put-time-stamp-overlays
+ #+vindex: org-time-stamp-overlay-formats
+ To turn on custom format overlays over timestamps (variables
+ ~org-put-time-stamp-overlays~ and
+ ~org-time-stamp-overlay-formats~), use:
- - =customtime= ::
+ - =customtime= ::
- Overlay custom time format.
+ Overlay custom time format.
- #+vindex: constants-unit-system
- The following options influence the table spreadsheet (variable
- ~constants-unit-system~).
+ #+vindex: constants-unit-system
+ The following options influence the table spreadsheet (variable
+ ~constants-unit-system~).
- - =constcgs= ::
+ - =constcgs= ::
- =constants.el= should use the c-g-s unit system.
+ =constants.el= should use the c-g-s unit system.
- - =constSI= ::
+ - =constSI= ::
- =constants.el= should use the SI unit system.
+ =constants.el= should use the SI unit system.
- #+vindex: org-footnote-define-inline
- #+vindex: org-footnote-auto-label
- #+vindex: org-footnote-auto-adjust
- To influence footnote settings, use the following keywords. The
- corresponding variables are ~org-footnote-define-inline~,
- ~org-footnote-auto-label~, and ~org-footnote-auto-adjust~.
+ #+vindex: org-footnote-define-inline
+ #+vindex: org-footnote-auto-label
+ #+vindex: org-footnote-auto-adjust
+ To influence footnote settings, use the following keywords. The
+ corresponding variables are ~org-footnote-define-inline~,
+ ~org-footnote-auto-label~, and ~org-footnote-auto-adjust~.
- - =fninline= ::
+ - =fninline= ::
- Define footnotes inline.
+ Define footnotes inline.
- - =fnnoinline= ::
+ - =fnnoinline= ::
- Define footnotes in separate section.
+ Define footnotes in separate section.
- - =fnlocal= ::
+ - =fnlocal= ::
- Define footnotes near first reference, but not inline.
+ Define footnotes near first reference, but not inline.
- - =fnprompt= ::
+ - =fnprompt= ::
- Prompt for footnote labels.
+ Prompt for footnote labels.
- - =fnauto= ::
+ - =fnauto= ::
- Create =[fn:1]=-like labels automatically (default).
+ Create =[fn:1]=-like labels automatically (default).
- - =fnconfirm= ::
+ - =fnconfirm= ::
- Offer automatic label for editing or confirmation.
+ Offer automatic label for editing or confirmation.
- - =fnadjust= ::
+ - =fnadjust= ::
- Automatically renumber and sort footnotes.
+ Automatically renumber and sort footnotes.
- - =nofnadjust= ::
+ - =nofnadjust= ::
- Do not renumber and sort automatically.
+ Do not renumber and sort automatically.
- #+vindex: org-hide-block-startup
- To hide blocks on startup, use these keywords. The corresponding
- variable is ~org-hide-block-startup~.
+ #+vindex: org-hide-block-startup
+ To hide blocks on startup, use these keywords. The
+ corresponding variable is ~org-hide-block-startup~.
- - =hideblocks= ::
+ - =hideblocks= ::
- Hide all begin/end blocks on startup.
+ Hide all begin/end blocks on startup.
- - =nohideblocks= ::
+ - =nohideblocks= ::
- Do not hide blocks on startup.
+ Do not hide blocks on startup.
- #+vindex: org-pretty-entities
- The display of entities as UTF-8 characters is governed by the
- variable ~org-pretty-entities~ and the keywords
+ #+vindex: org-pretty-entities
+ The display of entities as UTF-8 characters is governed by the
+ variable ~org-pretty-entities~ and the keywords
- - =entitiespretty= ::
+ - =entitiespretty= ::
- Show entities as UTF-8 characters where possible.
+ Show entities as UTF-8 characters where possible.
- - =entitiesplain= ::
+ - =entitiesplain= ::
- Leave entities plain.
+ Leave entities plain.
- =#+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 /fast tag
- selection/ keys. The corresponding variable is ~org-tag-alist~.
+ #+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 /fast tag
+ selection/ keys. The corresponding variable is ~org-tag-alist~.
- =#+TODO:=, =#+SEQ_TODO:=, =#+TYP_TODO:= ::
- #+cindex: @samp{SEQ_TODO}, keyword
- #+cindex: @samp{TODO}, keyword
- #+cindex: @samp{TYP_TODO}, keyword
- #+vindex: org-todo-keywords
- These lines set the TODO keywords and their interpretation in the
- current file. The corresponding variable is ~org-todo-keywords~.
+ #+cindex: @samp{SEQ_TODO}, keyword
+ #+cindex: @samp{TODO}, keyword
+ #+cindex: @samp{TYP_TODO}, keyword
+ #+vindex: org-todo-keywords
+ These lines set the TODO keywords and their interpretation in the
+ current file. The corresponding variable is ~org-todo-keywords~.
** The Very Busy {{{kbd(C-c C-c)}}} Key
:PROPERTIES:
@@ -18969,62 +18876,62 @@ headings as shown in examples below.
- /Indentation of text below headlines/ ::
- Indent text to align with the headline.
+ Indent text to align with the headline.
- #+begin_example
- ,*** Third level
- more text, now indented
- #+end_example
+ #+begin_example
+ ,*** Third level
+ more text, now indented
+ #+end_example
- #+vindex: org-adapt-indentation
- Org supports this with paragraph filling, line wrapping, and
- structure editing, preserving or adapting the indentation as
- appropriate[fn:148].
+ #+vindex: org-adapt-indentation
+ Org supports this with paragraph filling, line wrapping, and
+ structure editing, preserving or adapting the indentation as
+ appropriate[fn:148].
- /Hiding leading stars/ ::
- #+vindex: org-hide-leading-stars
- Org can make leading stars invisible. For global preference,
- configure the variable ~org-hide-leading-stars~. For per-file
- preference, use these file =STARTUP= options:
+ #+vindex: org-hide-leading-stars
+ Org can make leading stars invisible. For global preference,
+ configure the variable ~org-hide-leading-stars~. For per-file
+ preference, use these file =STARTUP= options:
- #+begin_example
- ,#+STARTUP: hidestars
- ,#+STARTUP: showstars
- #+end_example
+ #+begin_example
+ ,#+STARTUP: hidestars
+ ,#+STARTUP: showstars
+ #+end_example
- With stars hidden, the tree is shown as:
+ With stars hidden, the tree is shown as:
- #+begin_example
- ,* Top level headline
- ,* Second level
- ,* Third level
- ...
- #+end_example
+ #+begin_example
+ ,* Top level headline
+ ,* Second level
+ ,* Third level
+ ...
+ #+end_example
- #+vindex: org-hide, face
- Because Org makes the font color the same as the background color
- to hide to stars, sometimes ~org-hide~ face may need tweaking to
- get the effect right. For some black and white combinations,
- ~grey90~ on a white background might mask the stars better.
+ #+vindex: org-hide, face
+ Because Org makes the font color the same as the background color
+ to hide to stars, sometimes ~org-hide~ face may need tweaking to
+ get the effect right. For some black and white combinations,
+ ~grey90~ on a white background might mask the stars better.
- /Odd levels/ ::
- #+vindex: org-odd-levels-only
- Using stars for only odd levels, 1, 3, 5, ..., can also clean up
- the clutter. This removes two stars from each level[fn:149].
- For Org to properly handle this cleaner structure during edits
- and exports, configure the variable ~org-odd-levels-only~. To
- set this per-file, use either one of the following lines:
+ #+vindex: org-odd-levels-only
+ Using stars for only odd levels, 1, 3, 5, ..., can also clean up the
+ clutter. This removes two stars from each level[fn:149]. For Org
+ to properly handle this cleaner structure during edits and exports,
+ configure the variable ~org-odd-levels-only~. To set this per-file,
+ use either one of the following lines:
- #+begin_example
- ,#+STARTUP: odd
- ,#+STARTUP: oddeven
- #+end_example
+ #+begin_example
+ ,#+STARTUP: odd
+ ,#+STARTUP: oddeven
+ #+end_example
- 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)}}}.
+ 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)}}}.
** Dynamic Headline Numbering
:PROPERTIES:
@@ -19126,84 +19033,83 @@ packages are documented here.
:END:
- =calc.el= by Dave Gillespie ::
- #+cindex: @file{calc.el}
+ #+cindex: @file{calc.el}
- Org uses the Calc package for implementing spreadsheet
- functionality in its tables (see [[*The Spreadsheet]]). Org also
- uses Calc for embedded calculations. See [[info:calc::Embedded%20Mode][GNU Emacs Calc Manual]].
+ Org uses the Calc package for implementing spreadsheet functionality
+ in its tables (see [[*The Spreadsheet]]). Org also uses Calc for
+ embedded calculations. See [[info:calc::Embedded%20Mode][GNU Emacs Calc Manual]].
- =constants.el= by Carsten Dominik ::
- #+cindex: @file{constants.el}
- #+vindex: org-table-formula-constants
+ #+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 =M= for =Mega=.
- For a standard collection of such constants, install the
- =constants= package. Install version 2.0 of this package,
- available at [[http://www.astro.uva.nl/~dominik/Tools]]. Org checks
- if the function ~constants-get~ has been autoloaded.
- Installation instructions are in the file =constants.el=.
+ Org can use names for constants in formulas in tables. Org can also
+ use calculation suffixes for units, such as =M= for =Mega=. For
+ a standard collection of such constants, install the =constants=
+ package. Install version 2.0 of this package, available at
+ [[http://www.astro.uva.nl/~dominik/Tools]]. Org checks if the function
+ ~constants-get~ has been autoloaded. Installation instructions are
+ in the file =constants.el=.
- =cdlatex.el= by Carsten Dominik ::
- #+cindex: @file{cdlatex.el}
+ #+cindex: @file{cdlatex.el}
- Org mode can make use of the CDLaTeX package to efficiently enter
- LaTeX fragments into Org files. See [[*Using CDLaTeX to enter
- math]].
+ Org mode can make use of the CDLaTeX package to efficiently enter
+ LaTeX fragments into Org files. See [[*Using CDLaTeX to enter math]].
- =imenu.el= by Ake Stenhoff and Lars Lindberg ::
- #+cindex: @file{imenu.el}
+ #+cindex: @file{imenu.el}
- Imenu creates dynamic menus based on an index of items in a file.
- Org mode supports Imenu menus. Enable it with a mode hook as
- follows:
+ Imenu creates dynamic menus based on an index of items in a file.
+ Org mode supports Imenu menus. Enable it with a mode hook as
+ follows:
- #+begin_src emacs-lisp
- (add-hook 'org-mode-hook
- (lambda () (imenu-add-to-menubar "Imenu")))
- #+end_src
+ #+begin_src emacs-lisp
+ (add-hook 'org-mode-hook
+ (lambda () (imenu-add-to-menubar "Imenu")))
+ #+end_src
- #+vindex: org-imenu-depth
- By default the index is two levels deep---you can modify the
- depth using the option ~org-imenu-depth~.
+ #+vindex: org-imenu-depth
+ By default the index is two levels deep---you can modify the
+ depth using the option ~org-imenu-depth~.
- =speedbar.el= by Eric\nbsp{}M.\nbsp{}Ludlam ::
- #+cindex: @file{speedbar.el}
+ #+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.
- =table.el= by Takaaki Ota ::
- #+cindex: table editor, @file{table.el}
- #+cindex: @file{table.el}
-
- 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.
-
- - {{{kbd(C-c ')}}} (~org-edit-special~) ::
-
- #+kindex: C-c '
- #+findex: org-edit-special
- Edit a =table.el= table. Works when point is in
- a =table.el= table.
-
- - {{{kbd(C-c ~​)}}} (~org-table-create-with-table.el~) ::
-
- #+kindex: C-c ~
- #+findex: org-table-create-with-table.el
- Insert a =table.el= table. If there is already a table at
- point, this command converts it between the =table.el=
- format and the Org mode format. See the documentation
- string of the command ~org-convert-table~ for the
- restrictions under which this is possible.
+ #+cindex: table editor, @file{table.el}
+ #+cindex: @file{table.el}
+
+ 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.
+
+ - {{{kbd(C-c ')}}} (~org-edit-special~) ::
+
+ #+kindex: C-c '
+ #+findex: org-edit-special
+ Edit a =table.el= table. Works when point is in a =table.el=
+ table.
+
+ - {{{kbd(C-c ~​)}}} (~org-table-create-with-table.el~) ::
+
+ #+kindex: C-c ~
+ #+findex: org-table-create-with-table.el
+ Insert a =table.el= table. If there is already a table at point,
+ this command converts it between the =table.el= format and the Org
+ mode format. See the documentation string of the command
+ ~org-convert-table~ for the restrictions under which this is
+ possible.
*** Packages that conflict with Org mode
:PROPERTIES:
@@ -19226,112 +19132,111 @@ point moves across a special context.
- =cua.el= by Kim\nbsp{}F.\nbsp{}Storm ::
- #+cindex: @file{cua.el}
- #+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 ~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.
+ #+cindex: @file{cua.el}
+ #+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 ~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.
- #+attr_texinfo: :columns 0.4 0.4
- | {{{kbd(S-UP)}}} \rArr{} {{{kbd(M-p)}}} | {{{kbd(S-DOWN)}}} \rArr{} {{{kbd(M-n)}}} |
- | {{{kbd(S-LEFT)}}} \rArr{} {{{kbd(M--)}}} | {{{kbd(S-RIGHT)}}} \rArr{} {{{kbd(M-+)}}} |
- | {{{kbd(C-S-LEFT)}}} \rArr{} {{{kbd(M-S--)}}} | {{{kbd(C-S-RIGHT)}}} \rArr{} {{{kbd(M-S-+)}}} |
+ #+attr_texinfo: :columns 0.4 0.4
+ | {{{kbd(S-UP)}}} \rArr{} {{{kbd(M-p)}}} | {{{kbd(S-DOWN)}}} \rArr{} {{{kbd(M-n)}}} |
+ | {{{kbd(S-LEFT)}}} \rArr{} {{{kbd(M--)}}} | {{{kbd(S-RIGHT)}}} \rArr{} {{{kbd(M-+)}}} |
+ | {{{kbd(C-S-LEFT)}}} \rArr{} {{{kbd(M-S--)}}} | {{{kbd(C-S-RIGHT)}}} \rArr{} {{{kbd(M-S-+)}}} |
- #+vindex: org-disputed-keys
- Yes, these are unfortunately more difficult to remember. If you
- want to have other replacement keys, look at the variable
- ~org-disputed-keys~.
+ #+vindex: org-disputed-keys
+ Yes, these are unfortunately more difficult to remember. If you
+ want to have other replacement keys, look at the variable
+ ~org-disputed-keys~.
- =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 /not/
- follow the advice to automagically turn on Orgtbl mode in message
- buffers (see [[*The Orgtbl Minor Mode]]), but instead---after
- filling in the message headers---turn on Orgtbl mode manually
- when needed in the messages body.
+ #+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 /not/ follow the advice to automagically
+ turn on Orgtbl mode in message buffers (see [[*The Orgtbl Minor Mode]]),
+ but instead---after filling in the message headers---turn on Orgtbl
+ mode manually when needed in the messages body.
- =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 =filladapt.el= and Org mode, so a safe thing to do is
- to disable filladapt like this:
+ #+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
+ =filladapt.el= and Org mode, so a safe thing to do is to disable
+ filladapt like this:
- #+begin_src emacs-lisp
- (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
- #+end_src
+ #+begin_src emacs-lisp
+ (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
+ #+end_src
- =viper.el= by Michael Kifer ::
- #+cindex: @file{viper.el}
- #+kindex: C-c /
+ #+cindex: @file{viper.el}
+ #+kindex: C-c /
- Viper uses {{{kbd(C-c /)}}} and therefore makes this key not
- access the corresponding Org mode command ~org-sparse-tree~. You
- need to find another key for this command, or override the key in
- ~viper-vi-global-user-map~ with
+ Viper uses {{{kbd(C-c /)}}} and therefore makes this key not access
+ the corresponding Org mode command ~org-sparse-tree~. You need to
+ find another key for this command, or override the key in
+ ~viper-vi-global-user-map~ with
- #+begin_src emacs-lisp
- (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
- #+end_src
+ #+begin_src emacs-lisp
+ (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
+ #+end_src
- =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:
-
- #+begin_src emacs-lisp
- ;; Make windmove work in Org mode:
- (add-hook 'org-shiftup-final-hook 'windmove-up)
- (add-hook 'org-shiftleft-final-hook 'windmove-left)
- (add-hook 'org-shiftdown-final-hook 'windmove-down)
- (add-hook 'org-shiftright-final-hook 'windmove-right)
- #+end_src
+ #+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:
+
+ #+begin_src emacs-lisp
+ ;; Make windmove work in Org mode:
+ (add-hook 'org-shiftup-final-hook 'windmove-up)
+ (add-hook 'org-shiftleft-final-hook 'windmove-left)
+ (add-hook 'org-shiftdown-final-hook 'windmove-down)
+ (add-hook 'org-shiftright-final-hook 'windmove-right)
+ #+end_src
- =yasnippet.el= ::
- #+cindex: @file{yasnippet.el}
- The way Org mode binds the {{{kbd(TAB)}}} key (binding to ~[tab]~
- instead of ~"\t"~) overrules YASnippet's access to this key. The
- following code fixed this problem:
-
- #+begin_src emacs-lisp
- (add-hook 'org-mode-hook
- (lambda ()
- (setq-local yas/trigger-key [tab])
- (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
- #+end_src
-
- The latest version of YASnippet does not play well with Org mode.
- If the above code does not fix the conflict, start by defining
- the following function:
-
- #+begin_src emacs-lisp
- (defun yas/org-very-safe-expand ()
- (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
- #+end_src
-
- Then, tell Org mode to use that function:
-
- #+begin_src emacs-lisp
- (add-hook 'org-mode-hook
- (lambda ()
- (make-variable-buffer-local 'yas/trigger-key)
- (setq yas/trigger-key [tab])
- (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
- (define-key yas/keymap [tab] 'yas/next-field)))
- #+end_src
+ #+cindex: @file{yasnippet.el}
+ The way Org mode binds the {{{kbd(TAB)}}} key (binding to ~[tab]~
+ instead of ~"\t"~) overrules YASnippet's access to this key. The
+ following code fixed this problem:
+
+ #+begin_src emacs-lisp
+ (add-hook 'org-mode-hook
+ (lambda ()
+ (setq-local yas/trigger-key [tab])
+ (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
+ #+end_src
+
+ The latest version of YASnippet does not play well with Org mode.
+ If the above code does not fix the conflict, start by defining
+ the following function:
+
+ #+begin_src emacs-lisp
+ (defun yas/org-very-safe-expand ()
+ (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
+ #+end_src
+
+ Then, tell Org mode to use that function:
+
+ #+begin_src emacs-lisp
+ (add-hook 'org-mode-hook
+ (lambda ()
+ (make-variable-buffer-local 'yas/trigger-key)
+ (setq yas/trigger-key [tab])
+ (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
+ (define-key yas/keymap [tab] 'yas/next-field)))
+ #+end_src
** Org Crypt
:PROPERTIES:
@@ -19497,13 +19402,13 @@ data in an inbox file format, through the following steps:
- {{{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 =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
+ =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.
#+kindex: ? @r{(Agenda dispatcher)}
From the agenda dispatcher, {{{kbd(?)}}} returns to the view to finish
@@ -19780,15 +19685,15 @@ called:
- =: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.
- =:skipcols (n1 n2 ...)= ::
- List of columns to be skipped. First Org automatically discards
- columns with calculation marks and then sends the table to the
- translator function, which then skips columns as specified in
- =skipcols=.
+ List of columns to be skipped. First Org automatically discards
+ columns with calculation marks and then sends the table to the
+ translator function, which then skips columns as specified in
+ =skipcols=.
To keep the source table intact in the buffer without being disturbed
when the source file is compiled or otherwise being worked on, use one
@@ -19881,30 +19786,28 @@ control output, see [[*Translator functions]]:
- =:splice BOOLEAN= ::
- When {{{var(BOOLEAN}}} is non-~nil~, return only table body
- lines; i.e., not wrapped in =tabular= environment. Default is
- ~nil~.
+ When {{{var(BOOLEAN}}} is non-~nil~, return only table body lines;
+ i.e., not wrapped in =tabular= environment. Default is ~nil~.
- =:fmt FMT= ::
- Format string to warp each field. It should contain =%s= for the
- original field value. For example, to wrap each field value in
- dollar symbol, you could use =:fmt "$%s$"=. Format can also wrap
- a property list with column numbers and formats, for example
- =: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.
+ Format string to warp each field. It should contain =%s= for the
+ original field value. For example, to wrap each field value in
+ dollar symbol, you could use =:fmt "$%s$"=. Format can also wrap
+ a property list with column numbers and formats, for example =: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.
- =:efmt EFMT= ::
- Format numbers as exponentials. The spec should have =%s= twice
- for inserting mantissa and exponent, for example ="%s\\times10^{%s}"=.
- This may also be a property list with column numbers and formats,
- for example =: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.
+ Format numbers as exponentials. The spec should have =%s= twice for
+ inserting mantissa and exponent, for example ="%s\\times10^{%s}"=. This
+ may also be a property list with column numbers and formats, for
+ example =: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.
*** Translator functions
:PROPERTIES:
@@ -19995,14 +19898,14 @@ These commands update dynamic blocks:
- {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) ::
- #+kindex: C-c C-x C-u
- #+findex: org-dblock-update
- Update dynamic block at point.
+ #+kindex: C-c C-x C-u
+ #+findex: org-dblock-update
+ Update dynamic block at point.
- {{{kbd(C-u C-c C-x C-u)}}} ::
- #+kindex: C-u C-c C-x C-u
- Update all dynamic blocks in the current file.
+ #+kindex: C-u C-c C-x C-u
+ Update all dynamic blocks in the current file.
Before updating a dynamic block, Org removes content between the
=BEGIN= and =END= markers. Org then reads the parameters on the
@@ -20101,45 +20004,44 @@ accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and
- =(org-agenda-skip-entry-if 'scheduled)= ::
- Skip current entry if it has been scheduled.
+ Skip current entry if it has been scheduled.
- =(org-agenda-skip-entry-if 'notscheduled)= ::
- Skip current entry if it has not been scheduled.
+ Skip current entry if it has not been scheduled.
- =(org-agenda-skip-entry-if 'deadline)= ::
- Skip current entry if it has a deadline.
+ Skip current entry if it has a deadline.
- =(org-agenda-skip-entry-if 'scheduled 'deadline)= ::
- Skip current entry if it has a deadline, or if it is scheduled.
+ Skip current entry if it has a deadline, or if it is scheduled.
- =(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))= ::
- Skip current entry if the TODO keyword is TODO or WAITING.
+ Skip current entry if the TODO keyword is TODO or WAITING.
- =(org-agenda-skip-entry-if 'todo 'done)= ::
- Skip current entry if the TODO keyword marks a DONE state.
+ Skip current entry if the TODO keyword marks a DONE state.
- =(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.
- =(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.
- =(org-agenda-skip-entry-if 'notregexp "regular expression")= ::
- Skip current entry unless the regular expression matches.
+ Skip current entry unless the regular expression matches.
- =(org-agenda-skip-subtree-if 'regexp "regular expression")= ::
- Same as above, but check and skip the entire subtree.
+ Same as above, but check and skip the entire subtree.
The following is an example of a search for =waiting= without the
special function:
@@ -20252,16 +20154,16 @@ with the following fields:
- head :: The headline, without TODO keyword, TAGS and PRIORITY
- type :: The type of the agenda entry, can be
- | ~todo~ | selected in TODO match |
- | ~tagsmatch~ | selected in tags match |
- | ~diary~ | imported from diary |
- | ~deadline~ | a deadline |
- | ~scheduled~ | scheduled |
- | ~timestamp~ | appointment, selected by timestamp |
- | ~closed~ | entry was closed on date |
- | ~upcoming-deadline~ | warning about nearing deadline |
- | ~past-scheduled~ | forwarded scheduled item |
- | ~block~ | entry has date block including date |
+ | ~todo~ | selected in TODO match |
+ | ~tagsmatch~ | selected in tags match |
+ | ~diary~ | imported from diary |
+ | ~deadline~ | a deadline |
+ | ~scheduled~ | scheduled |
+ | ~timestamp~ | appointment, selected by timestamp |
+ | ~closed~ | entry was closed on date |
+ | ~upcoming-deadline~ | warning about nearing deadline |
+ | ~past-scheduled~ | forwarded scheduled item |
+ | ~block~ | entry has date block including date |
- todo :: The TODO keyword, if any
- tags :: All tags including inherited ones, separated by colons
@@ -20444,35 +20346,35 @@ of:
- ~nil~ ::
- The current buffer, respecting the restriction, if any.
+ The current buffer, respecting the restriction, if any.
- ~tree~ ::
- The subtree started with the entry at point.
+ The subtree started with the entry at point.
- ~region~ ::
- The entries within the active region, if any.
+ The entries within the active region, if any.
- ~file~ ::
- The current buffer, without restriction.
+ The current buffer, without restriction.
- ~file-with-archives~ ::
- The current buffer, and any archives associated with it.
+ The current buffer, and any archives associated with it.
- ~agenda~ ::
- All agenda files.
+ All agenda files.
- ~agenda-with-archives~ ::
- All agenda files with any archive files associated with them.
+ All agenda files with any archive files associated with them.
- list of filenames ::
- If this is a list, all files in the list are scanned.
+ If this is a list, all files in the list are scanned.
#+texinfo: @noindent
The remaining arguments are treated as settings for the scanner's
@@ -20480,18 +20382,18 @@ skipping facilities. Valid arguments are:
- ~archive~ ::
- Skip trees with the =ARCHIVE= tag.
+ Skip trees with the =ARCHIVE= tag.
- ~comment~ ::
- Skip trees with the COMMENT keyword.
+ Skip trees with the COMMENT keyword.
- function or Lisp form ::
- #+vindex: org-agenda-skip-function
- Used as value for ~org-agenda-skip-function~, so whenever the
- function returns ~t~, {{{var(FUNC)}}} is called for that entry
- and search continues from the point where the function leaves it.
+ #+vindex: org-agenda-skip-function
+ Used as value for ~org-agenda-skip-function~, so whenever the
+ function returns ~t~, {{{var(FUNC)}}} is called for that entry and
+ search continues from the point where the function leaves it.
#+end_defun
The mapping routine can call any arbitrary function, even functions
@@ -20584,40 +20486,38 @@ Before I get to this list, a few special mentions are in order:
- 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.
+ 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.
- 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.
- John Wiegley ::
- John has contributed a number of great ideas and patches directly
- to Org, including the attachment system (=org-attach.el=),
- integration with Apple Mail (=org-mac-message.el=), hierarchical
- dependencies of TODO items, habit tracking (=org-habits.el=), and
- encryption (=org-crypt.el=). Also, the capture system is really
- an extended copy of his great =remember.el=.
+ John has contributed a number of great ideas and patches directly to
+ Org, including the attachment system (=org-attach.el=), integration
+ with Apple Mail (=org-mac-message.el=), hierarchical dependencies of
+ TODO items, habit tracking (=org-habits.el=), and encryption
+ (=org-crypt.el=). Also, the capture system is really an extended
+ copy of his great =remember.el=.
- 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
- =org-info.js=, a Java script for displaying webpages derived from
- Org using an Info-like or a folding interface with single-key
- navigation.
+ 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 =org-info.js=,
+ a Java script for displaying webpages derived from Org using an
+ Info-like or a folding interface with single-key navigation.
See below for the full list of contributions! Again, please let me
know what I am missing here!
@@ -20644,34 +20544,32 @@ considered co-maintainers, either of the code or the community:
- 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.
+ 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.
- Nicolas Goaziou ::
- Nicolas is maintaining the consistency of the deepest parts of
- Org. His work on =org-element.el= and =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 =org-element.el= and =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.
- Achim Gratz ::
- Achim rewrote the building process of Org, turning some /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.
+ Achim rewrote the building process of Org, turning some /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.
- 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.
+ 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.
I received support from so many users that it is clearly impossible to
be fair when shortlisting a few of them, but Org's history would not