From da95b4b3548f49512c3347e00ab1454c203b1ba7 Mon Sep 17 00:00:00 2001 From: Nicolas Goaziou Date: Tue, 17 May 2016 00:53:59 +0200 Subject: [PATCH] orgmanual: Use dedicated index keywords --- contrib/orgmanual.org | 3890 ++++++++++++++++++++--------------------- 1 file changed, 1941 insertions(+), 1949 deletions(-) diff --git a/contrib/orgmanual.org b/contrib/orgmanual.org index b73fcf3b0..ce425ddca 100644 --- a/contrib/orgmanual.org +++ b/contrib/orgmanual.org @@ -35,15 +35,6 @@ # # Macros for simplifying export -# Indexing macros. index is generic, the rest are for the specific -# default indexes. -#+MACRO: index @@info:@$1index $2@@ -#+MACRO: cindex {{{index(c,$1)}}} -#+MACRO: pindex {{{index(p,$1)}}} -#+MACRO: findex {{{index(f,$1)}}} -#+MACRO: vindex {{{index(v,$1)}}} -#+MACRO: kindex {{{index(k,$1)}}} - # Markup macros. In texinfo export they will be marked up, otherwise # they will be inserted verbatim. markup is the generic form that can # be used to insert any @-command with the second variable being the @@ -80,13 +71,13 @@ :TITLE: Introduction :DESCRIPTION: Getting started :END: -{{{cindex(introduction)}}} +#+cindex: introduction ** Summary :PROPERTIES: :DESCRIPTION: Brief summary of what Org-mode does :END: -{{{cindex(summary)}}} +#+cindex: summary Org is a mode for keeping notes, maintaining TODO lists, and doing project planning with a fast and effective plain-text system. @@ -130,19 +121,19 @@ different ends, for example: - an ASCII system and table editor for taking structured notes - a TODO list editor - a full agenda and planner with deadlines and work scheduling - {{{pindex(GTD\\\, Getting Things Done)}}} + #+pindex: GTD, Getting Things Done - an environment in which to implement David Allen's GTD system - a simple hypertext system, with HTML and LaTeX export - a publishing tool to create a set of interlinked web pages - an environment for literate programming -{{{cindex(FAQ)}}} +#+cindex: FAQ There is a [[http://orgmode.org][website for Org]] that provides links to the newest version of Org, as well as additional information, frequently asked questions (FAQ), links to tutorials, etc. -{{{cindex(print edition)}}} +#+cindex: print edition Version 7.3 of this manual is available as a [[http://www.network-theory.co.uk/org/manual/][paperback book from Network Theory Ltd.]] @@ -154,8 +145,8 @@ Network Theory Ltd.]] :DESCRIPTION: How to install a downloaded version of Org-mode :END: -{{{cindex(installation)}}} -{{{cindex(XEmacs)}}} +#+cindex: installation +#+cindex: XEmacs *Important:* If you have the version of Org that comes with Emacs or as a XEmacs package, please skip this section and go directly to @@ -269,15 +260,15 @@ Do not forget to activate Org as described in the following section. :PROPERTIES: :DESCRIPTION: How to activate Org-mode for certain buffers :END: -{{{cindex(activation)}}} -{{{cindex(autoload)}}} -{{{cindex(ELPA)}}} -{{{cindex(global key bindings)}}} -{{{cindex(key bindings\\\, global)}}} -{{{findex(org-agenda)}}} -{{{findex(org-capture)}}} -{{{findex(org-store-link)}}} -{{{findex(org-iswitchb)}}} +#+cindex: activation +#+cindex: autoload +#+cindex: ELPA +#+cindex: global key bindings +#+cindex: key bindings, global +#+findex: org-agenda +#+findex: org-capture +#+findex: org-store-link +#+findex: org-iswitchb Since Emacs 22.2, files with the {{{file(.org)}}} extension use Org mode by default. If you are using an earlier version of Emacs, add this line to your @@ -311,7 +302,7 @@ liking. (global-set-key "\C-cb" 'org-iswitchb) #+end_src -{{{cindex(Org mode\\\, turning on)}}} +#+cindex: Org mode, turning on With this setup, all files with extension {{{samp(.org)}}} will be put into Org mode. As an alternative, make the first line of a file look like this: @@ -320,7 +311,7 @@ like this: MY PROJECTS -*- mode: org; -*- #+end_example -{{{vindex(org-insert-mode-line-in-empty-file)}}} +#+vindex: org-insert-mode-line-in-empty-file {{{noindent}}} which will select Org mode for this buffer no matter what the file's name is. See also the variable @@ -345,10 +336,10 @@ pressing {{{kbdkey(C-,SPC)}}} twice before moving the cursor. :PROPERTIES: :DESCRIPTION: Bug reports, ideas, patches, etc. :END: -{{{cindex(feedback)}}} -{{{cindex(bug reports)}}} -{{{cindex(maintainer)}}} -{{{cindex(author)}}} +#+cindex: feedback +#+cindex: bug reports +#+cindex: maintainer +#+cindex: author If you find problems with Org, or if you have questions, remarks, or ideas about it, please mail to the Org mailing list @@ -415,7 +406,7 @@ with clear information about: :DESCRIPTION: The best way to report an error :END: -{{{cindex(backtrace of an error)}}} +#+cindex: backtrace of an error If working with Org produces an error with a message you don't understand, you may have hit a bug. The best way to report this is by @@ -472,10 +463,10 @@ its readability, but you can use lowercase in your Org files.[fn:7] :DESCRIPTION: Bind useful commands to keys :END: -{{{kindex(C-c a)}}} -{{{findex(org-agenda)}}} -{{{kindex(C-c c)}}} -{{{findex(org-capture)}}} +#+kindex: C-c a +#+findex: org-agenda +#+kindex: C-c c +#+findex: org-capture The manual suggests two global keybindings: {{{kbd(C-c a)}}} for ~org-agenda~ and {{{kbd(C-c c)}}} for ~org-capture~. These are only @@ -499,8 +490,8 @@ call ~org-table-move-column-right~. :DESCRIPTION: A tree works like your brain :OPTIONAL_TITLE: Document Structure :END: -{{{cindex(document structure)}}} -{{{cindex(structure of document)}}} +#+cindex: document structure +#+cindex: structure of document Org is based on Outline mode and provides flexible commands to edit the structure of the document. @@ -509,8 +500,8 @@ edit the structure of the document. :PROPERTIES: :DESCRIPTION: Org mode is based on Outline mode :END: -{{{cindex(outlines)}}} -{{{cindex(Outline mode)}}} +#+cindex: outlines +#+cindex: Outline mode Org is implemented on top of Outline mode. Outlines allow a document to be organized in a hierarchical structure, which (at least for me) @@ -525,11 +516,11 @@ compressing the entire show/hide functionality into a single command, :PROPERTIES: :DESCRIPTION: How to typeset Org tree headlines :END: -{{{cindex(headlines)}}} -{{{cindex(outline tree)}}} -{{{vindex(org-special-ctrl-a/e)}}} -{{{vindex(org-special-ctrl-k)}}} -{{{vindex(org-ctrl-k-protect-subtree)}}} +#+cindex: headlines +#+cindex: outline tree +#+vindex: org-special-ctrl-a/e +#+vindex: org-special-ctrl-k +#+vindex: org-ctrl-k-protect-subtree Headlines define the structure of an outline tree. The headlines in Org start with one or more stars, on the left margin.[fn:8] For example: @@ -549,7 +540,7 @@ prefer an outline that has whitespace followed by a single star as headline starters. A setup to realize this is described in the section, [[Clean view]]. -{{{vindex(org-cycle-separator-lines)}}} +#+vindex: org-cycle-separator-lines An empty line after the end of a subtree is considered part of it and will be hidden when the subtree is folded. However, if you leave at least two empty lines, one empty line will remain visible after folding @@ -561,35 +552,35 @@ variable ~org-cycle-separator-lines~ to modify this behavior. :DESCRIPTION: Show and hide, much simplified :OPTIONAL_TITLE: Visibility cycling :END: -{{{cindex(cycling\\\, visibility)}}} -{{{cindex(visibility cycling)}}} -{{{cindex(trees\\\, visibility)}}} -{{{cindex(show hidden text)}}} -{{{cindex(hide text)}}} +#+cindex: cycling, visibility +#+cindex: visibility cycling +#+cindex: trees, visibility +#+cindex: show hidden text +#+cindex: hide text Outlines make it possible to hide parts of the text in the buffer. Org uses just two commands, bound to {{{key(TAB)}}} and {{{kbdkey(S-,TAB)}}} to change the visibility in the buffer. -{{{cindex(subtree visibility states)}}} -{{{cindex(subtree cycling)}}} -{{{cindex(folded\\\, subtree visibility state)}}} -{{{cindex(children\\\, subtree visibility state)}}} -{{{cindex(subtree\\\, subtree visibility state)}}} +#+cindex: subtree visibility states +#+cindex: subtree cycling +#+cindex: folded, subtree visibility state +#+cindex: children, subtree visibility state +#+cindex: subtree, subtree visibility state #+attr_texinfo: :table-type "table" :indic "@asis" - {{{key(TAB)}}}, ~org-cycle~ :: Subtrees can be cycled through three states: - {{{kindex(TAB)}}} - {{{findex(org-cycle)}}} + #+kindex: TAB + #+findex: org-cycle #+begin_src example ,-> FOLDED -> CHILDREN -> SUBTREE --. '-----------------------------------' #+end_src - {{{vindex(org-cycle-emulate-tab )}}} - {{{vindex(org-cycle-global-at-bob )}}} + #+vindex: org-cycle-emulate-tab + #+vindex: org-cycle-global-at-bob By default, the cursor must be on a headline for this to work, but this behavior can be modified with the @@ -602,14 +593,14 @@ Org uses just two commands, bound to {{{key(TAB)}}} and - {{{kbdkey(S-,TAB)}}} or {{{kbdspckey(C-u,TAB)}}}, ~org-global-cycle~ :: Global cycling: Rotate the entire buffer among the states - {{{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)}}} + #+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 #+begin_example ,-> OVERVIEW -> CONTENTS -> SHOW ALL --. @@ -624,9 +615,9 @@ Org uses just two commands, bound to {{{key(TAB)}}} and - {{{kbdspckey(C-u C-u C-u,TAB)}}}, ~show-all~ :: Show all, including drawers. - {{{kindex(C-u C-u C-u TAB)}}} - {{{findex(show-all)}}} - {{{cindex(show all\\\, command)}}} + #+kindex: C-u C-u C-u TAB + #+findex: show-all + #+cindex: show all, command - {{{kbd(C-c C-r)}}}, ~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 @@ -635,22 +626,22 @@ Org uses just two commands, bound to {{{key(TAB)}}} and 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)}}} + #+cindex: revealing context + #+kindex: C-c C-r + #+findex: org-reveal - {{{kbd(C-c C-k)}}}, ~show-branches~ :: Expose all the headings of the subtree, CONTENT view for just one subtree. - {{{kindex(C-c C-k)}}} - {{{findex(show-branches)}}} - {{{cindex(show branches\\\, command)}}} + #+kindex: C-c C-k + #+findex: show-branches + #+cindex: show branches, command - {{{kbdspckey(C-c,TAB)}}}, ~show-children~ :: Expose all direct children of the subtree. With a numeric prefix argument, ~N~, expose all children down to level N. - {{{kindex(C-c TAB)}}} - {{{findex(show-children)}}} - {{{cindex(show children\\\, command)}}} + #+kindex: C-c TAB + #+findex: show-children + #+cindex: show children, command - {{{kbd(C-c C-x b)}}}, ~org-tree-to-indirect-buffer~ :: Show the current subtree in an indirect buffer.[fn:10] With a numeric prefix argument, ~N~, go up to level N and then take that tree. @@ -658,16 +649,16 @@ Org uses just two commands, bound to {{{key(TAB)}}} and {{{kbd(C-u)}}} prefix, do not remove the previously used indirect buffer. - {{{kindex(C-c C-x b)}}} - {{{findex(org-tree-to-indirect-buffer)}}} + #+kindex: C-c C-x b + #+findex: org-tree-to-indirect-buffer - {{{kbd(C-c C-x v)}}}, ~org-copy-visible~ :: Copy the /visible/ text in the region into the kill ring. -{{{vindex(org-startup-folded)}}} -{{{cindex(~overview~\\\, STARTUP keyword)}}} -{{{cindex(~content~\\\, STARTUP keyword)}}} -{{{cindex(~showall~\\\, STARTUP keyword)}}} -{{{cindex(~showeverything~\\\, STARTUP keyword)}}} +#+vindex: org-startup-folded +#+cindex: ~overview~, STARTUP keyword +#+cindex: ~content~, STARTUP keyword +#+cindex: ~showall~, STARTUP keyword +#+cindex: ~showeverything~, STARTUP keyword When Emacs first visits an Org file, the global state is set to OVERVIEW, i.e., only the top level headlines are visible. This can be @@ -682,7 +673,7 @@ buffer: ,#+STARTUP: showeverything #+end_src -{{{cindex(property\\\, VISIBILITY)}}} +#+cindex: property, VISIBILITY {{{noindent}}} Furthermore, any entries with a {{{samp(VISIBILITY)}}} property (see [[Properties and columns]]) will get their visibility @@ -699,35 +690,35 @@ adapted accordingly. Allowed values for this property are ~folded~, :PROPERTIES: :DESCRIPTION: Jumping to other headlines :END: -{{{cindex(motion\\\, between headlines)}}} -{{{cindex(jumping\\\, to headlines)}}} -{{{cindex(headline navigation)}}} +#+cindex: motion, between headlines +#+cindex: jumping, to headlines +#+cindex: headline navigation The following commands jump to other headlines in the buffer. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-n)}}}, ~outline-next-visible-heading~ :: Next heading. - {{{kindex(C-c C-n)}}} - {{{findex(outline-next-visible-heading)}}} + #+kindex: C-c C-n + #+findex: outline-next-visible-heading - {{{kbd(C-c C-p)}}}, ~outline-previous-visible-heading~ :: Previous heading. - {{{kindex(C-c C-p)}}} - {{{findex(outline-previous-visible-heading)}}} + #+kindex: C-c C-p + #+findex: outline-previous-visible-heading - {{{kbd(C-c C-f)}}}, ~org-forward-same-level~ :: Next heading same level. - {{{kindex(C-c C-f)}}} - {{{findex(org-forward-same-level)}}} + #+kindex: C-c C-f + #+findex: org-forward-same-level - {{{kbd(C-c C-b)}}}, ~org-backward-same-level~ :: Previous heading same level. - {{{kindex(C-c C-b)}}} - {{{findex(org-backward-same-level)}}} + #+kindex: C-c C-b + #+findex: org-backward-same-level - {{{kbd(C-c C-u)}}}, ~outline-up-heading~ :: Backward to higher level heading. - {{{kindex(C-c C-u)}}} - {{{findex(outline-up-heading)}}} + #+kindex: C-c C-u + #+findex: outline-up-heading - {{{kbd(C-c C-j)}}}, ~org-goto~ :: 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: - {{{kindex(C-c C-j)}}} - {{{findex(org-goto)}}} - {{{vindex(org-goto-auto-isearch)}}} + #+kindex: C-c C-j + #+findex: org-goto + #+vindex: org-goto-auto-isearch - {{{key(TAB)}}} :: Cycle visibility. - {{{key(down)}}} / {{{key(up)}}} :: Next/previous visible headline. - {{{key(RET)}}} :: Select this location. @@ -739,7 +730,7 @@ The following commands jump to other headlines in the buffer. - 0--9 :: Digit argument. - q :: Quit. -{{{vindex(org-goto-interface)}}} +#+vindex: org-goto-interface {{{noindent}}} See also the variable ~org-goto-interface~. ** Structure editing @@ -747,16 +738,16 @@ The following commands jump to other headlines in the buffer. :DESCRIPTION: Changing sequence and level of headlines :OPTIONAL_TITLE: Structure editing :END: -{{{cindex(structure editing)}}} -{{{cindex(headline\\\, promotion and demotion)}}} -{{{cindex(promotion\\\, of subtrees)}}} -{{{cindex(demotion\\\, of subtrees)}}} -{{{cindex(subtree\\\, cut and paste)}}} -{{{cindex(pasting\\\, of subtrees)}}} -{{{cindex(cutting\\\, of subtrees)}}} -{{{cindex(copying\\\, of subtrees)}}} -{{{cindex(sorting\\\, of subtrees)}}} -{{{cindex(subtrees\\\, cut and paste)}}} +#+cindex: structure editing +#+cindex: headline, promotion and demotion +#+cindex: promotion, of subtrees +#+cindex: demotion, of subtrees +#+cindex: subtree, cut and paste +#+cindex: pasting, of subtrees +#+cindex: cutting, of subtrees +#+cindex: copying, of subtrees +#+cindex: sorting, of subtrees +#+cindex: subtrees, cut and paste #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbdkey(M-,RET)}}}, ~org-insert-heading~ :: Insert new heading @@ -773,89 +764,89 @@ The following commands jump to other headlines in the buffer. then a headline like the current one will be inserted after the end of the subtree. - {{{kindex(M-RET)}}} - {{{findex(org-insert-heading)}}} - {{{vindex(org-M-RET-may-split-line )}}} + #+kindex: M-RET + #+findex: org-insert-heading + #+vindex: org-M-RET-may-split-line - {{{kbdkey(C-,RET)}}}, ~org-insert-heading-respect-content~ :: Just like {{{kbdkey(M-,RET)}}}, except when adding a new heading below the current heading, the new heading is placed after the body instead of before it. This command works from anywhere in the entry. - {{{kindex(C-RET)}}} - {{{findex(org-insert-heading-respect-content)}}} + #+kindex: C-RET + #+findex: org-insert-heading-respect-content - {{{kbdkey(M-S-,RET)}}}, ~org-insert-todo-heading~ :: 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)}}} + #+kindex: M-S-RET + #+findex: org-insert-todo-heading + #+vindex: org-treat-insert-todo-heading-as-state-change - {{{kbdkey(C-S-,RET)}}}, ~org-insert-todo-heading-respect-content~ :: Insert new TODO entry with same level as current heading. Like {{{kbdkey(C-,RET)}}}, the new headline will be inserted after the current subtree. - {{{kindex(C-S-RET)}}} - {{{findex(org-insert-todo-heading-respect-content)}}} + #+kindex: C-S-RET + #+findex: org-insert-todo-heading-respect-content - {{{key(TAB)}}}, ~org-cycle~ :: In a new entry with no text yet, the first {{{key(TAB)}}} demotes the entry to become a child of the previous one. The next {{{key(TAB)}}} makes it a parent, and so on, all the way to top level. Yet another {{{key(TAB)}}}, and you are back to the initial level. - {{{kindex(@key{TAB})}}} - {{{findex(org-cycle)}}} + #+kindex: @key{TAB} + #+findex: org-cycle - {{{kbdkey(M-,left)}}}, ~org-do-promote~ :: Promote current heading by one level. - {{{kindex(M-,left)}}} - {{{findex(org-do-promote)}}} + #+kindex: M-left + #+findex: org-do-promote - {{{kbdkey(M-,right)}}}, ~org-do-demote~ :: Demote current heading by one level. - {{{kindex(M-,right)}}} - {{{findex(org-do-demote)}}} + #+kindex: M-right + #+findex: org-do-demote - {{{kbdkey(M-S-,left)}}}, ~org-promote-subtree~ :: Promote the current subtree by one level. - {{{kindex(M-S-,left)}}} - {{{findex(org-promote-subtree)}}} + #+kindex: M-S-left + #+findex: org-promote-subtree - {{{kbdkey(M-S-,right)}}}, ~org-demote-subtree~ :: Demote the current subtree by one level. - {{{kindex(M-S-,right)}}} - {{{findex(org-demote-subtree)}}} + #+kindex: M-S-right + #+findex: org-demote-subtree - {{{kbdkey(M-S-,up)}}}, ~org-move-subtree-up~ :: Move subtree up (swap with previous subtree of same level). - {{{kindex(M-S-,up)}}} - {{{findex(org-move-subtree-up)}}} + #+kindex: M-S-up + #+findex: org-move-subtree-up - {{{kbdkey(M-S-,down)}}}, ~org-move-subtree-down~ :: Move subtree down (swap with next subtree of same level). - {{{kindex(M-S-,down)}}} - {{{findex(org-move-subtree-down)}}} + #+kindex: M-S-,down + #+findex: org-move-subtree-down - {{{kbd(C-c C-x C-w)}}}, ~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)}}} + #+kindex: C-c C-x C-w + #+findex: org-cut-subtree - {{{kbd(C-c C-x M-w)}}}, ~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)}}} + #+kindex: C-c C-x M-w + #+findex: org-copy-subtree - {{{kbd(C-c C-x C-y)}}}, ~org-paste-subtree~ :: Yank subtree from kill ring. This does modify the level of the subtree to make sure the tree fits in nicely at the yank position. The yank level can also be specified with a numeric prefix argument, or by yanking after a headline marker like {{{samp(****)}}}. - {{{kindex(C-c C-x C-y)}}} - {{{findex(org-paste-subtree)}}} + #+kindex: C-c C-x C-y + #+findex: org-paste-subtree - {{{kbd(C-y)}}}, ~org-yank~ :: Depending on the variables ~org-yank-adjusted-subtrees~ and ~org-yank-folded-subtrees~, Org's internal ~yank~ command will paste subtrees folded and in @@ -869,10 +860,10 @@ The following commands jump to other headlines in the buffer. will yank previous kill items plainly, without adjustment and folding. - {{{kindex(C-y)}}} - {{{findex(org-yank)}}} - {{{vindex(org-yank-adjusted-subtrees)}}} - {{{vindex(org-yank-folded-subtrees)}}} + #+kindex: C-y + #+findex: org-yank + #+vindex: org-yank-adjusted-subtrees + #+vindex: org-yank-folded-subtrees - {{{kbd(C-c C-x c)}}}, ~org-clone-subtree-with-time-shift~ :: Clone a subtree by making a number of sibling copies of it. You will be prompted for the number of copies to make, and you can also @@ -881,13 +872,13 @@ The following commands jump to other headlines in the buffer. 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)}}} + #+kindex: C-c C-x c + #+findex: org-clone-subtree-with-time-shift - {{{kbd(C-c C-w)}}}, ~org-refile~ :: Refile entry or region to a different location. See [[Refile and copy]]. - {{{kindex(C-c C-w)}}} - {{{findex(org-refile)}}} + #+kindex: C-c C-w + #+findex: org-refile - {{{kbd(C-c ^)}}}, ~org-sort~ :: Sort same-level entries. When there is an active region, all entries in the region will be sorted. Otherwise the children of the current headline are @@ -900,22 +891,22 @@ The following commands jump to other headlines in the buffer. supply your own function to extract the sorting key. With a {{{kbd(C-u)}}} prefix, sorting will be case-sensitive. - {{{kindex(C-c ^)}}} - {{{findex(org-sort)}}} + #+kindex: C-c ^ + #+findex: org-sort - {{{kbd(C-x n s)}}}, ~org-narrow-to-subtree~ :: Narrow buffer to current subtree. - {{{kindex(C-x n s)}}} - {{{findex(org-narrow-to-subtree)}}} + #+kindex: C-x n s + #+findex: org-narrow-to-subtree - {{{kbd(C-x n b)}}}, ~org-narrow-to-block~ :: Narrow buffer to current block. - {{{kindex(C-x n b)}}} - {{{findex(org-narrow-to-block)}}} + #+kindex: C-x n b + #+findex: org-narrow-to-block - {{{kbd(C-x n w)}}}, ~widen~ :: Widen buffer to remove narrowing. - {{{kindex(C-x n w)}}} - {{{findex(widen)}}} + #+kindex: C-x n w + #+findex: widen - {{{kbd(C-c *)}}}, ~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 @@ -925,12 +916,12 @@ The following commands jump to other headlines in the buffer. 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)}}} + #+kindex: C-c * + #+findex: org-toggle-heading -{{{cindex(region\\\, active)}}} -{{{cindex(active region)}}} -{{{cindex(transient mark mode)}}} +#+cindex: region, active +#+cindex: active region +#+cindex: transient mark mode When there is an active region (Transient Mark mode), promotion and demotion work on all headlines in the region. To select a region of @@ -945,14 +936,14 @@ different functionality. :DESCRIPTION: Matches embedded in context :OPTIONAL_TITLE: Sparse trees :END: -{{{cindex(sparse trees)}}} -{{{cindex(trees\\\, sparse)}}} -{{{cindex(folding\\\, sparse trees)}}} -{{{cindex(occur\\\, command)}}} -{{{vindex(org-show-hierarchy-above)}}} -{{{vindex(org-show-following-heading)}}} -{{{vindex(org-show-siblings)}}} -{{{vindex(org-show-entry-below)}}} +#+cindex: sparse trees +#+cindex: trees, sparse +#+cindex: folding, sparse trees +#+cindex: occur, command +#+vindex: org-show-hierarchy-above +#+vindex: org-show-following-heading +#+vindex: org-show-siblings +#+vindex: org-show-entry-below An important feature of Org mode is the ability to construct /sparse trees/ for selected information in an outline tree, so that the entire @@ -967,8 +958,8 @@ commands can be accessed through a dispatcher: - {{{kbd(C-c /)}}}, ~org-sparse-tree~ :: This prompts for an extra key to select a sparse-tree creating command. - {{{kindex(C-c /)}}} - {{{findex(org-sparse-tree)}}} + #+kindex: C-c / + #+findex: org-sparse-tree - {{{kbd(C-c / r)}}}, ~org-occur~ :: 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 @@ -981,26 +972,26 @@ commands can be accessed through a dispatcher: prefix argument, previous highlights are kept, so several calls to this command can be stacked. - {{{kindex(C-c / r)}}} - {{{findex(org-occur)}}} - {{{vindex(org-remove-highlights-with-change)}}} + #+kindex: C-c / r + #+findex: org-occur + #+vindex: org-remove-highlights-with-change - {{{kbd(M-g n)}}}, ~next-error~ :: @@info:@itemx@@ {{{kbd(M-g M-n)}}} Jump to the next sparse tree match in this buffer. - {{{kindex(M-g n)}}} - {{{kindex(M-g M-n)}}} - {{{findex(next-error)}}} + #+kindex: M-g n + #+kindex: M-g M-n + #+findex: next-error - {{{kbd(M-g p)}}}, ~previous-error~ :: @@info:@itemx@@ {{{kbd(M-g M-p)}}} Jump to the previous sparse tree match in this buffer. - {{{kindex(M-g p)}}} - {{{kindex(M-g M-p)}}} - {{{findex(previous-error)}}} -{{{vindex(org-agenda-custom-commands)}}} + #+kindex: M-g p + #+kindex: M-g M-p + #+findex: previous-error +#+vindex: org-agenda-custom-commands {{{noindent}}} For frequently used sparse trees of specific search strings, you can use the variable ~org-agenda-custom-commands~ to @@ -1022,9 +1013,9 @@ shortcut for creating a sparse tree matching the string The other sparse tree commands select headings based on TODO keywords, tags, or properties and will be discussed later in this manual. -{{{kindex(C-c C-e v)}}} -{{{cindex(printing sparse trees)}}} -{{{cindex(visible text\\\, printing )}}} +#+kindex: C-c C-e v +#+cindex: printing sparse trees +#+cindex: visible text, printing To print a sparse tree, you can use the Emacs command ~ps-print-buffer-with-faces~ which does not print @@ -1037,10 +1028,10 @@ document and print the resulting file. :DESCRIPTION: Additional structure within an entry :OPTIONAL_TITLE: Plain lists :END: -{{{cindex(plain lists)}}} -{{{cindex(lists\\\, plain)}}} -{{{cindex(lists\\\, ordered)}}} -{{{cindex(ordered lists)}}} +#+cindex: plain lists +#+cindex: lists, plain +#+cindex: lists, ordered +#+cindex: ordered lists Within an entry of the outline tree, hand-formatted lists can provide additional structure. They also provide a way to create lists of @@ -1060,8 +1051,8 @@ Org knows ordered lists, unordered lists, and description lists. item with ~[@20]~.[fn:17] Those constructs can be used in any item of the list in order to enforce a particular numbering. - {{{vindex(org-plain-list-ordered-item-terminator)}}} - {{{vindex(org-alphabetical-lists)}}} + #+vindex: org-plain-list-ordered-item-terminator + #+vindex: org-alphabetical-lists - /Description/ list items are unordered list items, and contain the separator {{{samp( :: )}}} to distinguish the description @@ -1074,7 +1065,7 @@ first line. In particular, if an ordered list reaches number left-aligned with the other numbers in the list. An item ends before the next line that is less or equally indented than its bullet/number. -{{{vindex(org-empty-line-terminates-plain-lists)}}} +#+vindex: org-empty-line-terminates-plain-lists A list ends whenever every item has ended, which means before any line less or equally indented than items at top level. It also ends before two blank lines.[fn:171] In that case, all items are closed. Here is an example: @@ -1104,15 +1095,15 @@ what governs the structure of these lists, many structural constructs like ~#+BEGIN_ ...~ blocks can be indented to signal that they belong to a particular item. -{{{vindex(org-list-demote-modify-bullet)}}} -{{{vindex(org-list-indent-offset)}}} +#+vindex: org-list-demote-modify-bullet +#+vindex: org-list-indent-offset If you find that using a different bullet for a sub-list (than that used for the current list-level) improves readability, customize the variable ~org-list-demote-modify-bullet~. To get a greater difference of indentation between items and theirs sub-items, customize ~org-list-indent-offset~. -{{{vindex(org-list-automatic-rules)}}} +#+vindex: org-list-automatic-rules The following commands act on items when the cursor is in the first line of an item (the line with the bullet or number). Some of them imply the application of automatic rules to keep list structure intact. If some of @@ -1122,10 +1113,10 @@ to disable them individually. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{key(TAB)}}}, ~org-cycle~ :: - {{{cindex(cycling\\\, in plain lists)}}} - {{{kindex(TAB)}}} - {{{findex(org-cycle)}}} - {{{vindex(org-cycle-include-plain-lists)}}} + #+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 the cursor is on a plain list item. For more @@ -1141,10 +1132,10 @@ to disable them individually. initial position. - {{{kbdkey(M-,RET)}}}, ~org-insert-heading~ :: - {{{kindex(M-RET)}}} - {{{findex(org-insert-heading)}}} - {{{vindex(org-M-RET-may-split-line)}}} - {{{vindex(org-list-automatic-rules)}}} + #+kindex: M-RET + #+findex: org-insert-heading + #+vindex: org-M-RET-may-split-line + #+vindex: org-list-automatic-rules Insert new item at current level. With a prefix argument, force a new heading (see [[Structure editing]]). If this command is used @@ -1154,7 +1145,7 @@ to disable them individually. the current one. - {{{kbdkey(M-S-,RET)}}} :: - {{{kindex(M-S-RET)}}} + #+kindex: M-S-RET Insert a new item with a checkbox (see [[Checkboxes]]). @@ -1166,11 +1157,11 @@ to disable them individually. still use paragraph jumping commands like {{{kbdkey(C-,up)}}} and {{{kbdkey(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)}}} + #+kindex: S-up + #+kindex: S-down + #+cindex: shift-selection-mode + #+vindex: org-support-shift-select + #+vindex: org-list-use-circular-motion - {{{kbdkey(M-,up)}}} :: @@info:@itemx@@ {{{kbdkey(M-,down)}}} @@ -1178,16 +1169,16 @@ to disable them individually. previous/next item of same indentation).[fn:21] If the list is ordered, renumbering is automatic. - {{{kindex(M-up)}}} - {{{kindex(M-down)}}} + #+kindex: M-up + #+kindex: M-down - {{{kbdkey(M-,left)}}} :: @@info:@itemx@@ {{{kbdkey(M-,right)}}} Decrease/increase the indentation of an item, leaving children alone. - {{{kindex(M-left)}}} - {{{kindex(M-right)}}} + #+kindex: M-left + #+kindex: M-right - {{{kbdkey(M-S-,left)}}} :: @@info:@itemx@@ {{{kbdkey(M-S-,right)}}} @@ -1199,8 +1190,8 @@ to disable them individually. hierarchy. To use the new hierarchy, break the command chain with a cursor motion or so. - {{{kindex(M-S-left)}}} - {{{kindex(M-S-right)}}} + #+kindex: M-S-left + #+kindex: M-S-right As a special case, using this command on the very first item of a list will move the whole list. This behavior can be disabled @@ -1211,7 +1202,7 @@ to disable them individually. 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)}}} + #+kindex: C-c C-c - {{{kbd(C-c -)}}} :: Cycle the entire list level through the different itemize/enumerate bullets ({{{samp(-)}}}, {{{samp(+)}}}, {{{samp(*)}}}, {{{samp(1.)}}}, {{{samp(1))}}}) @@ -1225,42 +1216,42 @@ to disable them individually. be removed from the list. Finally, even without an active region, a normal line will be converted into a list item. - {{{kindex(C-c -)}}} - {{{vindex(org-plain-list-ordered-item-terminator)}}} + #+kindex: C-c - + #+vindex: org-plain-list-ordered-item-terminator - {{{kbd(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 *)}}} + #+kindex: C-c * - {{{kbd(C-c C-*)}}} :: Turn the whole plain list into a subtree of the current heading. Checkboxes (see [[Checkboxes]]) will become TODO (resp. DONE) keywords when unchecked (resp. checked). - {{{kindex(C-c C-*)}}} + #+kindex: C-c C-* - {{{kbd(S-left/right)}}} :: This command also cycles bullet styles when the cursor 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)}}} + #+vindex: org-support-shift-select + #+kindex: S-left + #+kindex: S-right - {{{kbd(C-c ^)}}} :: Sort the plain list. You will be prompted for the sorting method: numerically, alphabetically, by time, or by custom function. - {{{kindex(C-c ^)}}} + #+kindex: C-c ^ ** Drawers :PROPERTIES: :DESCRIPTION: Tucking stuff away :END: -{{{cindex(drawers)}}} -{{{cindex(#+DRAWERS)}}} -{{{cindex(visibility cycling\\\, drawers)}}} +#+cindex: drawers +#+cindex: #+DRAWERS +#+cindex: visibility cycling, drawers -{{{vindex(org-drawers)}}} -{{{cindex(org-insert-drawer)}}} -{{{kindex(C-c C-x d)}}} +#+vindex: org-drawers +#+cindex: org-insert-drawer +#+kindex: C-c C-x d Sometimes you want to keep information associated with an entry, but you normally don't want to see it. For this, Org mode has /drawers/. Drawers need to be configured with the variable @@ -1300,14 +1291,14 @@ drawer, in a similar way to state changes, use - {{{kbd(C-c C-z)}}} :: Add a time-stamped note to the LOGBOOK drawer. - {{{kindex(C-c C-z)}}} + #+kindex: C-c C-z ** Blocks :PROPERTIES: :DESCRIPTION: Folding blocks :END: -{{{vindex(org-hide-block-startup)}}} -{{{cindex(blocks\\\, folding)}}} +#+vindex: org-hide-block-startup +#+cindex: blocks, folding Org mode uses ~begin~ ... ~end~ blocks for various purposes from including source code examples (see [[Literal examples]]) to capturing time logging @@ -1316,8 +1307,8 @@ and unfolded by pressing TAB in the begin line. You can also get all blocks folded at startup by configuring the variable ~org-hide-block-startup~ or on a per-file basis by using -{{{cindex(@code{hideblocks}\\\, STARTUP keyword)}}} -{{{cindex(@code{nohideblocks}\\\, STARTUP keyword)}}} +#+cindex: @code{hideblocks}, STARTUP keyword +#+cindex: @code{nohideblocks}, STARTUP keyword #+begin_src org ,#+STARTUP: hideblocks ,#+STARTUP: nohideblocks @@ -1327,7 +1318,7 @@ blocks folded at startup by configuring the variable :PROPERTIES: :DESCRIPTION: Define footnotes in Org syntax :END: -{{{cindex(footnotes)}}} +#+cindex: footnotes Org mode supports the creation of footnotes. In contrast to the {{{file(footnote.el)}}} package, Org mode's footnotes are designed for @@ -1370,7 +1361,7 @@ the valid references: ~[fn:name]~ to create additional references. -{{{vindex(org-footnote-auto-label)}}} +#+vindex: org-footnote-auto-label Footnote labels can be created automatically, or you can create names yourself. This is handled by the variable ~org-footnote-auto-label~ and its corresponding @@ -1381,15 +1372,15 @@ details. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x f)}}} :: The footnote action command. - {{{kindex(C-c C-x f)}}} + #+kindex: C-c C-x f When the cursor 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)}}} - {{{vindex(org-footnote-auto-adjust)}}} + #+vindex: org-footnote-define-inline + #+vindex: org-footnote-section + #+vindex: org-footnote-auto-adjust Otherwise, create a new footnote. Depending on the variable ~org-footnote-define-inline~, the @@ -1430,23 +1421,23 @@ details. 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)}}} + #+kindex: C-c C-c - {{{kbd(C-c C-o)}}} or {{{kbd(mouse-1/2)}}} :: Footnote labels are also links to the corresponding definition/reference, and you can use the usual commands to follow these links. - {{{kindex(C-c C-o)}}} - {{{kindex(mouse-1)}}} - {{{kindex(mouse-2)}}} + #+kindex: C-c C-o + #+kindex: mouse-1 + #+kindex: mouse-2 ** Orgstruct mode :PROPERTIES: :DESCRIPTION: Structure editing outside Org :OPTIONAL_TITLE: Orgstruct mode :END: -{{{cindex(Orgstruct mode)}}} -{{{cindex(minor mode for structure editing)}}} +#+cindex: Orgstruct mode +#+cindex: minor mode for structure editing If you like the intuitive way the Org mode structure editing and list formatting works, you might want to use these commands in other modes @@ -1474,8 +1465,8 @@ detect item context after the first line of an item. :PROPERTIES: :DESCRIPTION: Pure magic for quick formatting :END: -{{{cindex(tables)}}} -{{{cindex(editing tables)}}} +#+cindex: tables +#+cindex: editing tables Org comes with a fast and intuitive table editor. Spreadsheet-like calculations are supported using the Emacs {{{file(calc)}}} package @@ -1485,7 +1476,7 @@ calculations are supported using the Emacs {{{file(calc)}}} package :PROPERTIES: :DESCRIPTION: Simple tables :END: -{{{cindex(table editor\\\, built-in)}}} +#+cindex: table editor, built-in Org makes it easy to format tables in plain ASCII. Any line with {{{samp(|)}}} as the first non-whitespace character is considered part @@ -1520,8 +1511,8 @@ only type start filling in fields. Even faster would be to type ~|Name|Phone|Age~ followed by {{{kbdspckey(C-c,RET)}}}. -{{{vindex(org-enable-table-editor)}}} -{{{vindex(org-table-auto-blank-field)}}} +#+vindex: org-enable-table-editor +#+vindex: org-table-auto-blank-field When typing text into a field, Org treats {{{key(DEL)}}}, {{{key(Backspace)}}}, and all character keys in a special way, so that @@ -1550,8 +1541,8 @@ you, configure the variables ~org-enable-table-editor~ and typing, like {{{kbdspckey(|Name|Phone|Age,RET)}}} {{{kbdkey(|- ,TAB)}}}. - {{{kindex(C-c |)}}} - {{{findex(org-table-create-or-convert-from-region)}}} + #+kindex: C-c | + #+findex: org-table-create-or-convert-from-region *** Re-aligning and field motion :PROPERTIES: @@ -1561,35 +1552,35 @@ you, configure the variables ~org-enable-table-editor~ and - {{{kbd(C-c C-c)}}}, ~org-table-align~ :: Re-align the table without moving the cursor. - {{{kindex(C-c C-c)}}} - {{{findex(org-table-align)}}} + #+kindex: C-c C-c + #+findex: org-table-align - {{{kbd()}}}, ~org-table-next-field~ :: Re-align the table, move to the next field. Creates a new row if necessary. - {{{kindex()}}} - {{{findex(org-table-next-field)}}} + #+kindex: + #+findex: org-table-next-field - {{{kbdkey(S-,TAB)}}}, ~org-table-previous-field~ :: Re-align, move to previous field. - {{{kindex(S-TAB)}}} - {{{findex(org-table-previous-field)}}} + #+kindex: S-TAB + #+findex: org-table-previous-field - {{{key(RET)}}}, ~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, {{{key(RET)}}} still does NEWLINE, so it can be used to split a table. - {{{kindex(RET)}}} - {{{findex(org-table-next-row)}}} + #+kindex: RET + #+findex: org-table-next-row - {{{kbd(M-a)}}}, ~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)}}} + #+kindex: M-a + #+findex: org-table-beginning-of-field - {{{kbd(M-e)}}}, ~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)}}} + #+kindex: M-e + #+findex: org-table-end-of-field *** Column and row editing :PROPERTIES: @@ -1597,67 +1588,67 @@ you, configure the variables ~org-enable-table-editor~ and :END: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbdkey(M-,left)}}}, ~org-table-move-column-left~ :: - {{{kindex(M-left)}}} - {{{findex(org-table-move-column-left)}}} + #+kindex: M-left + #+findex: org-table-move-column-left Move the current column left. - {{{kbdkey(M-,right)}}}, ~org-table-move-column-right~ :: - {{{kindex(M-right)}}} - {{{findex(org-table-move-column-right)}}} + #+kindex: M-right + #+findex: org-table-move-column-right Move the current column right. - {{{kbdkey(M-S-,left)}}}, ~org-table-delete-column~ :: - {{{kindex(M-S-left)}}} - {{{findex(org-table-delete-column)}}} + #+kindex: M-S-left + #+findex: org-table-delete-column Kill the current column. - {{{kbdkey(M-S-,right)}}}, ~org-table-insert-column~ :: - {{{kindex(M-S-right)}}} - {{{findex(org-table-insert-column)}}} + #+kindex: M-S-right + #+findex: org-table-insert-column Insert a new column to the left of the cursor position. - {{{kbdkey(M-,up)}}}, ~org-table-move-row-up~ :: - {{{kindex(M-up)}}} - {{{findex(org-table-move-row-up)}}} + #+kindex: M-up + #+findex: org-table-move-row-up Move the current row up. - {{{kbdkey(M-,down)}}}, ~org-table-move-row-down~ - {{{kindex(M-down)}}} - {{{findex(org-table-move-row-down)}}} + #+kindex: M-down + #+findex: org-table-move-row-down Move the current row down. - {{{kbdkey(M-S-,up)}}}, ~org-table-kill-row~ :: Kill the current row or horizontal line. - {{{kindex(M-S-up)}}} - {{{findex(org-table-kill-row)}}} + #+kindex: M-S-up + #+findex: org-table-kill-row - {{{kbdkey(M-S-,down)}}}, ~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)}}} + #+kindex: M-S-down + #+findex: org-table-insert-row - {{{kbd(C-c -)}}}, ~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)}}} + #+kindex: C-c - + #+findex: org-table-insert-hline - {{{kbdspckey(C-c,RET)}}}, ~org-table-hline-and-move~ :: Insert a horizontal line below current row, and move the cursor into the row below that line. - {{{kindex(C-c RET)}}} - {{{findex(org-table-hline-and-move)}}} + #+kindex: C-c RET + #+findex: org-table-hline-and-move - {{{kbd(C-c ^)}}}, ~org-table-sort-lines~ :: Sort the table lines in the region. The position of point indicates the column to be @@ -1671,8 +1662,8 @@ you, configure the variables ~org-enable-table-editor~ and time). When called with a prefix argument, alphabetic sorting will be case-sensitive. - {{{kindex(C-c ^)}}} - {{{findex(org-table-sort-lines)}}} + #+kindex: C-c ^ + #+findex: org-table-sort-lines *** Regions :PROPERTIES: :DESCRIPTION: Manipulate parts of a table @@ -1684,14 +1675,14 @@ you, configure the variables ~org-enable-table-editor~ and region, copy just the current field. The process ignores horizontal separator lines. - {{{kindex(C-c C-x M-w)}}} - {{{findex(org-table-copy-region)}}} + #+kindex: C-c C-x M-w + #+findex: org-table-copy-region - {{{kbd(C-c C-x C-w)}}}, ~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)}}} + #+kindex: C-c C-x C-w + #+findex: org-table-cut-region - {{{kbd(C-c C-x C-y)}}}, ~org-table-paste-rectangle~ :: Paste a rectangular region into a table. The upper left corner ends up in the current field. All involved fields will be overwritten. @@ -1699,8 +1690,8 @@ you, configure the variables ~org-enable-table-editor~ and is enlarged as needed. The process ignores horizontal separator lines. - {{{kindex(C-c C-x C-y)}}} - {{{findex(org-table-paste-rectangle)}}} + #+kindex: C-c C-x C-y + #+findex: org-table-paste-rectangle - {{{kbdkey(M-,RET)}}}, ~org-table-wrap-region~ :: Split the current field at the cursor position and move the rest to the line below. If there is an active region, and both point and mark are in the @@ -1710,17 +1701,17 @@ you, configure the variables ~org-enable-table-editor~ and 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)}}} + #+kindex: M-RET + #+findex: org-table-wrap-region *** Calculations :PROPERTIES: :DESCRIPTION: Sum and copy :END: -{{{cindex(formula\\\, in tables)}}} -{{{cindex(calculations\\\, in tables)}}} -{{{cindex(region\\\, active)}}} -{{{cindex(active region)}}} -{{{cindex(transient mark mode)}}} +#+cindex: formula, in tables +#+cindex: calculations, in tables +#+cindex: region, active +#+cindex: active region +#+cindex: transient mark mode #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c +)}}}, ~org-table-sum~ :: Sum the numbers in the current @@ -1728,8 +1719,8 @@ you, configure the variables ~org-enable-table-editor~ and result is shown in the echo area and can be inserted with {{{kbd(C-y)}}}. - {{{kindex(C-c +)}}} - {{{findex(org-table-sum)}}} + #+kindex: C-c + + #+findex: org-table-sum - {{{kbdkey(S-,RET)}}}, ~org-table-copy-down~ :: When current field is empty, copy from first non-empty field above. When not empty, copy current field down to next row and move cursor along with @@ -1739,9 +1730,9 @@ you, configure the variables ~org-enable-table-editor~ and argument temporarily disables the increment. This key is also used by shift-selection and related modes (see [[Conflicts]]). - {{{kindex(S-RET)}}} - {{{findex(org-table-copy-down)}}} - {{{vindex(org-table-copy-increment)}}} + #+kindex: S-RET + #+findex: org-table-copy-down + #+vindex: org-table-copy-increment *** Misc :PROPERTIES: @@ -1758,8 +1749,8 @@ you, configure the variables ~org-enable-table-editor~ and automatically when the cursor 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)}}} + #+kindex: C-c ` + #+findex: org-table-edit-field - {{{kbd(M-x 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 @@ -1773,8 +1764,8 @@ you, configure the variables ~org-enable-table-editor~ and 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)}}} + #+kindex: C-c | + #+findex: org-table-create-or-convert-from-region - {{{kbd(M-x org-table-export)}}} :: 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 @@ -1786,8 +1777,8 @@ you, configure the variables ~org-enable-table-editor~ and 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)}}} + #+findex: org-table-export + #+vindex: org-table-export-default-format If you don't like the automatic table editor because it gets in your way on lines which you would like to start with {{{samp(|)}}}, you can @@ -1807,8 +1798,8 @@ turn it off with :PROPERTIES: :DESCRIPTION: Overrule the automatic settings :END: -{{{cindex(narrow columns in tables)}}} -{{{cindex(alignment in tables)}}} +#+cindex: narrow columns in tables +#+cindex: alignment in tables The width of columns is automatically determined by the table editor. And also the alignment of a column is determined automatically from @@ -1841,7 +1832,7 @@ field, use the command {{{kbd(C-c `)}}} (that is {{{kbd(C-c)}}} followed by the backquote). This will open a new window with the full field. Edit it and finish with {{{kbd(C-c C-c)}}}. -{{{vindex(org-startup-align-all-tables)}}} +#+vindex: org-startup-align-all-tables When visiting a file containing a table with narrowed columns, the necessary character hiding has not yet happened, and the table needs @@ -1867,7 +1858,7 @@ automatically when exporting the document. :PROPERTIES: :DESCRIPTION: Grouping to trigger vertical lines :END: -{{{cindex(grouping columns in tables)}}} +#+cindex: grouping columns in tables When Org exports tables, it does so by default without vertical lines because that is visually more satisfying in general. Occasionally @@ -1906,8 +1897,8 @@ every vertical line you would like to have: :DESCRIPTION: The table editor as minor mode :OPTIONAL_TITLE: Ogtbl mode :END: -{{{cindex(Orgtbl mode)}}} -{{{cindex(minor mode for tables)}}} +#+cindex: Orgtbl mode +#+cindex: minor mode for tables If you like the intuitive way the Org table editor works, you might also want to use it in other modes like Text mode or Mail mode. The @@ -1931,9 +1922,9 @@ details, see [[Tables in arbitrary syntax]]. :PROPERTIES: :DESCRIPTION: The table editor has spreadsheet capabilities :END: -{{{cindex(calculations\\\, in tables)}}} -{{{cindex(spreadsheet capabilities)}}} -{{{cindex(@file{calc} package)}}} +#+cindex: calculations, in tables +#+cindex: spreadsheet capabilities +#+cindex: @file{calc} package The table editor makes use of the Emacs {{{file(calc)}}} package to implement spreadsheet-like capabilities. It can also evaluate Emacs @@ -1950,7 +1941,7 @@ moving these references by arrow keys :PROPERTIES: :DESCRIPTION: How to refer to another field or range :END: -{{{cindex(references)}}} +#+cindex: references To compute fields in the table from other fields, formulas must reference other fields or ranges. In Org, fields can be referenced by @@ -1963,15 +1954,17 @@ grid. :PROPERTIES: :DESCRIPTION: Refer to a particular field :END: -{{{cindex(field references)}}} -{{{cindex(references\\\, to fields)}}} +#+cindex: field references +#+cindex: references, to fields Formulas can reference the value of another field in two ways. Like in any other spreadsheet, you may reference fields with a letter/number combination like ~B3~, meaning the 2nd field in the 3rd -row. {{{vindex(org-table-use-standard-references)}}} However, Org -prefers to use another, more general representation that looks -like this:[fn:25] +row. + +#+vindex: org-table-use-standard-references +However, Org prefers to use another, more general representation that +looks like this:[fn:25] #+begin_example @ROW$COLUMN @@ -2020,8 +2013,8 @@ Here are a few examples: :PROPERTIES: :DESCRIPTION: Refer to a range of fields :END: -{{{cindex(range references)}}} -{{{cindex(references\\\, to ranges)}}} +#+cindex: range references +#+cindex: references, to ranges You may reference a rectangular range of fields by specifying two field references connected by two dots ~..~. If both fields are in @@ -2051,10 +2044,10 @@ see the ~E~ mode switch below). If there are no non-empty fields, :PROPERTIES: :DESCRIPTION: Refer to fields in Lisp or Calc :END: -{{{cindex(field coordinates)}}} -{{{cindex(coordinates\\\, of field)}}} -{{{cindex(row\\\, of field coordinates)}}} -{{{cindex(column\\\, of field coordinates)}}} +#+cindex: field coordinates +#+cindex: coordinates, of field +#+cindex: row, of field coordinates +#+cindex: column, of field coordinates For Calc formulas and Lisp formulas ~@#~ and ~$#~ can be used to get the row or column number of the field where the formula result goes. @@ -2074,12 +2067,12 @@ large number of rows.[fn:27] :PROPERTIES: :DESCRIPTION: Name columns or constants :END: -{{{cindex(named references)}}} -{{{cindex(references\\\, named)}}} -{{{cindex(name\\\, of column or field)}}} -{{{cindex(constants\\\, in calculations)}}} -{{{cindex(#+CONSTANTS)}}} -{{{vindex(org-table-formula-constants)}}} +#+cindex: named references +#+cindex: references, named +#+cindex: name, of column or field +#+cindex: constants, in calculations +#+cindex: #+CONSTANTS +#+vindex: org-table-formula-constants {{{samp($name)}}} is interpreted as the name of a column, parameter or constant. Constants are defined globally through the variable @@ -2090,9 +2083,9 @@ line like this example: ,#+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6 #+end_src -{{{noindent}}} -{{{vindex(constants-unit-system)}}} -{{{pindex(constants.el)}}} +{{{noindent}}} +#+vindex: constants-unit-system +#+pindex: constants.el Also, properties (see [[Properties and columns]]) can be used as constants in table formulas: for a property ~:Xyz:~ use the name ~$PROP_Xyz~, @@ -2109,12 +2102,12 @@ numbers.[fn:175] :PROPERTIES: :DESCRIPTION: Refer to information in other tables :END: -{{{cindex(remote references)}}} -{{{cindex(references\\\, remote)}}} -{{{cindex(references\\\, to a different table)}}} -{{{cindex(name\\\, of column or field)}}} -{{{cindex(constants\\\, in calculations)}}} -{{{cindex(#+TBLNAME)}}} +#+cindex: remote references +#+cindex: references, remote +#+cindex: references, to a different table +#+cindex: name, of column or field +#+cindex: constants, in calculations +#+cindex: #+TBLNAME You may also reference constants, fields and ranges from a different table, either in the current file or even in a different file. The @@ -2135,20 +2128,21 @@ or range reference as described above for example ~@3$3~ or :PROPERTIES: :DESCRIPTION: Using Calc to compute stuff :END: -{{{cindex(formula syntax\\\, Calc)}}} -{{{cindex(syntax\\\, of formulas)}}} +#+cindex: formula syntax, Calc +#+cindex: syntax, of formulas A formula can be any algebraic expression understood by the Emacs -{{{file(Calc)}}} package.[fn:28] Before evaluation by -~calc-eval~ (see [[info:calc#Calling Calc from Your Programs][Calling Calc from Your Lisp Programs]]), variable -substitution takes place according to the rules described above. -{{{cindex(vectors\\\, in table calculations)}}} The range vectors can -be directly fed into the Calc vector functions like ~vmean~ and -~vsum~. +{{{file(Calc)}}} package.[fn:28] Before evaluation by ~calc-eval~ (see +[[info:calc#Calling Calc from Your Programs][Calling Calc from Your Lisp Programs]]), variable substitution takes +place according to the rules described above. -{{{cindex(format specifier)}}} -{{{cindex(mode\\\, for @file{calc})}}} -{{{vindex(org-calc-default-modes)}}} +#+cindex: vectors, in table calculations +The range vectors can be directly fed into the Calc vector functions +like ~vmean~ and ~vsum~. + +#+cindex: format specifier +#+cindex: mode, for @file{calc} +#+vindex: org-calc-default-modes A formula can contain an optional mode string after a semicolon. This string consists of flags to influence Calc and other modes during @@ -2208,7 +2202,7 @@ You can add your own Calc functions defined in Emacs Lisp with :DESCRIPTION: Writing formulas in Emacs Lisp :OPTIONAL_TITLE: Formula syntax for Lisp :END: -{{{cindex(Lisp forms\\\, as table formulas)}}} +#+cindex: Lisp forms, as table formulas It is also possible to write a formula in Emacs Lisp. This can be useful for string manipulation and control structures, if Calc's @@ -2260,9 +2254,9 @@ Compute the sum of columns 1-4, like Calc's ~vsum($1..$4)~}: :PROPERTIES: :DESCRIPTION: How to compute duration and time values :END: -{{{cindex(Duration\\\, computing)}}} -{{{cindex(Time\\\, computing)}}} -{{{vindex(org-table-duration-custom-format)}}} +#+cindex: Duration, computing +#+cindex: Time, computing +#+vindex: org-table-duration-custom-format If you want to compute time values use the ~T~ flag, either in Calc formulas or Elisp formulas: @@ -2290,10 +2284,10 @@ be considered as seconds in addition and subtraction. :PROPERTIES: :DESCRIPTION: Formulas for specific (ranges of) fields :END: -{{{cindex(field formula)}}} -{{{cindex(range formula)}}} -{{{cindex(formula\\\, for individual table field)}}} -{{{cindex(formula\\\, for range of fields)}}} +#+cindex: field formula +#+cindex: range formula +#+cindex: formula, for individual table field +#+cindex: formula, for range of fields To assign a formula to a particular field, type it directly into the field, preceded by ~:=~, for example ~vsum(@II..III)~. When you press @@ -2302,8 +2296,7 @@ still in the field, the formula will be stored as the formula for this field, evaluated, and the current field will be replaced with the result. -{{{cindex(#+TBLFM)}}} - +#+cindex: #+TBLFM Formulas are stored in a special line starting with ~#+TBLFM:~ directly below the table. If you type the equation in the fourth field of the third data line in the table, the formula will look like @@ -2326,8 +2319,8 @@ following command formula with default taken from the {{{samp(#+TBLFM:)}}} line, applies it to the current field, and stores it. - {{{kindex(C-u C-c =)}}} - {{{findex(org-table-eval-formula)}}} + #+kindex: C-u C-c = + #+findex: org-table-eval-formula 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 @@ -2350,8 +2343,8 @@ the formula editor (see [[Editing and debugging formulas]]) or edit the :PROPERTIES: :DESCRIPTION: Formulas valid for an entire column :END: -{{{cindex(column formula)}}} -{{{cindex(formula\\\, for table column)}}} +#+cindex: column formula +#+cindex: formula, for table column When you assign a formula to a simple column reference like ~$3=~, the same formula will be used in all fields of that column, with the @@ -2394,14 +2387,14 @@ following command: argument(e.g., {{{kbd(C-5 C-c =)}}}) the command will apply it to that many consecutive fields in the current column. - {{{kindex(C-c =)}}} - {{{findex(org-table-eval-formula)}}} + #+kindex: C-c = + #+findex: org-table-eval-formula *** Lookup functions :PROPERTIES: :DESCRIPTION: Lookup functions for searching tables :END: -{{{cindex(lookup functions in tables)}}} -{{{cindex(table lookup functions)}}} +#+cindex: lookup functions in tables +#+cindex: table lookup functions Org has three predefined Emacs Lisp functions for lookups in tables. @@ -2409,7 +2402,7 @@ Org has three predefined Emacs Lisp functions for lookups in tables. - (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE) :: Searches for the first element ~S~ in list ~S-LIST~ for which - {{{findex(org-lookup-first)}}} + #+findex: org-lookup-first #+header: :exports code #+header: :eval no @@ -2426,7 +2419,7 @@ Org has three predefined Emacs Lisp functions for lookups in tables. to ~org-lookup-first~ above, but searches for the /last/ element for which ~PREDICATE~ is ~t~. - {{{findex(org-lookup-last)}}} + #+findex: org-lookup-last - (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE) :: Similar to ~org-lookup-first~, but searches for /all/ elements for which ~PREDICATE~ is ~t~, and returns /all/ corresponding @@ -2435,7 +2428,7 @@ Org has three predefined Emacs Lisp functions for lookups in tables. can be built when this function is combined with other Emacs Lisp functions. - {{{findex(org-lookup-all)}}} + #+findex: org-lookup-all If the ranges used in these functions contain empty fields, the ~E~ mode for the formula should usually be specified: otherwise empty @@ -2451,10 +2444,10 @@ examples see [[http://orgmode.org/worg/org-tutorials/org-lookups.html][this tuto :PROPERTIES: :DESCRIPTION: Fixing formulas :END: -{{{cindex(formula editing)}}} -{{{cindex(editing\\\, of table formulas)}}} +#+cindex: formula editing +#+cindex: editing, of table formulas -{{{vindex(org-table-use-standard-references)}}} You can edit +#+vindex: org-table-use-standard-references You can edit individual formulas in the minibuffer or directly in the field. Org can also prepare a special buffer with all active formulas of a table. When offering a formula for editing, Org converts references to the @@ -2468,24 +2461,24 @@ the variable ~org-table-use-standard-references~. 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)}}} + #+kindex: C-c = + #+kindex: C-u C-c = + #+findex: org-table-eval-formula - {{{kbd(C-u C-u C-c =)}}}, ~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)}}} + #+kindex: C-u C-u C-c = + #+findex: org-table-eval-formula - {{{kbd(C-c ?)}}}, ~org-table-field-info~ :: While editing a formula in a table field, highlight the field(s) referenced by the reference at the cursor position in the formula. - {{{kindex(C-c ?)}}} - {{{findex(org-table-field-info)}}} + #+kindex: C-c ? + #+findex: org-table-field-info - {{{kbd(C-c })}}}, ~org-table-toggle-coordinate-overlays~ :: Toggle the display of row and column numbers for a table, using @@ -2493,14 +2486,14 @@ the variable ~org-table-use-standard-references~. 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)}}} + #+kindex: C-c @} + #+findex: org-table-toggle-coordinate-overlays - {{{kbd(C-c {)}}}, ~org-table-toggle-formula-debugger~ :: Toggle the formula debugger on and off. See below. - {{{kindex(C-c @{)}}} - {{{findex(org-table-toggle-formula-debugger)}}} + {{{kindex: C-c#+ + #+findex: org-table-toggle-formula-debugger - {{{kbd(C-c ')}}}, ~org-table-edit-formulas~ :: Edit all formulas for the current table in a special buffer, where the formulas @@ -2511,8 +2504,8 @@ the variable ~org-table-use-standard-references~. You may edit, remove and add formulas, and use the following commands: - {{{kindex(C-c ')}}} - {{{findex(org-table-edit-formulas)}}} + #+kindex: C-c ' + #+findex: org-table-edit-formulas #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-c)}}} or {{{kbd(C-x C-s)}}}, ~org-table-fedit-finish~ :: @@ -2521,20 +2514,20 @@ the variable ~org-table-use-standard-references~. {{{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)}}} + #+kindex: C-x C-s + #+kindex: C-c C-c + #+findex: org-table-fedit-finish - {{{kbd(C-c C-q)}}}, ~org-table-fedit-abort~ :: Exit the formula editor without installing changes. - {{{kindex(C-c C-q)}}} - {{{findex(org-table-fedit-abort)}}} + #+kindex: C-c C-q + #+findex: org-table-fedit-abort - {{{kbd(C-c C-r)}}}, ~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)}}} + #+kindex: C-c C-r + #+findex: org-table-fedit-toggle-ref-type - {{{key(TAB)}}}, ~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. @@ -2542,60 +2535,60 @@ the variable ~org-table-use-standard-references~. the open formula, {{{key(TAB)}}} re-indents just like in Emacs Lisp mode. - {{{kindex(TAB)}}} - {{{findex(org-table-fedit-lisp-indent)}}} + #+kindex: TAB + #+findex: org-table-fedit-lisp-indent - {{{kbdkey(M-,TAB)}}}, ~lisp-complete-symbol~ :: Complete Lisp symbols, just like in Emacs Lisp mode. - {{{kindex(M-TAB)}}} - {{{findex(lisp-complete-symbol)}}} + #+kindex: M-TAB + #+findex: lisp-complete-symbol - {{{kbdkey(S-,up)}}}/{{{key(down)}}}/{{{key(left)}}}/{{{key(right)}}} :: Shift the reference at point. For example, if the reference is ~B3~ and you press {{{kbdkey(S-,right)}}}, it will become ~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)}}} + #+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 - {{{kbdkey(M-S-,up)}}}, ~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)}}} + #+kindex: M-S-up + #+findex: org-table-fedit-line-up - {{{kbdkey(M-S-,down)}}}, ~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)}}} + #+kindex: M-S-down + #+findex: org-table-fedit-line-down - {{{kbdkey(M-,up)}}}, ~org-table-fedit-scroll-up~ :: Scroll up the window displaying the table. - {{{kindex(M-up)}}} - {{{findex(org-table-fedit-scroll-up)}}} + #+kindex: M-up + #+findex: org-table-fedit-scroll-up - {{{kbdkey(M-,down)}}}, ~org-table-fedit-scroll-down~ :: Scroll down the window displaying the table. - {{{kindex(M-down)}}} - {{{findex(org-table-fedit-scroll-down)}}} + #+kindex: M-down + #+findex: org-table-fedit-scroll-down - {{{kbd(C-c })}}} :: Turn the coordinate grid in the table on and off. - {{{kindex(C-c @})}}} - {{{findex(org-table-toggle-coordinate-overlays)}}} + #+kindex: C-c @@ + #+findex: org-table-toggle-coordinate-overlays Making a table field blank does not remove the formula associated with the field, because that is stored in a different line (the @@ -2604,7 +2597,7 @@ will be filled again. To remove a formula from a field, you have to give an empty reply when prompted for the formula, or to edit the {{{samp(#+TBLFM)}}} line. -{{{kindex(C-c C-c)}}} +#+kindex: C-c C-c You may edit the {{{samp(#+TBLFM)}}} directly and re-apply the changed equations with {{{kbd(C-c C-c)}}} in that line or with the normal recalculation commands in the table. @@ -2614,8 +2607,8 @@ recalculation commands in the table. :DESCRIPTION: Help fixing formulas :END: -{{{cindex(formula debugging)}}} -{{{cindex(debugging\\\, of table formulas)}}} +#+cindex: formula debugging +#+cindex: debugging, of table formulas When the evaluation of a formula leads to an error, the field content becomes the string {{{samp(#ERROR)}}}. If you would like see what is @@ -2628,8 +2621,8 @@ in a field. Detailed information will be displayed. :PROPERTIES: :DESCRIPTION: Recomputing all dependent fields :END: -{{{cindex(recomputing table fields)}}} -{{{cindex(updating\\\, table)}}} +#+cindex: recomputing table fields +#+cindex: updating, table Recalculation of a table is normally not automatic, but needs to be triggered by a command. See [[Advanced features]], for a way to make @@ -2643,15 +2636,15 @@ following commands: 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)}}} + #+kindex: C-c * + #+findex: org-table-recalculate - {{{kbd(C-u C-c *)}}} or {{{kbd(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)}}} + #+kindex: C-u C-c * + #+kindex: C-u C-c C-c - {{{kbd(C-u C-u C-c *)}}} or {{{kbd(C-u C-u C-c C-c)}}}, ~org-table-iterate~ :: Iterate the table by recomputing it until no further changes @@ -2659,18 +2652,18 @@ following commands: 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)}}} + #+kindex: C-u C-u C-c * + #+kindex: C-u C-u C-c C-c + #+findex: org-table-iterate - {{{kbd(M-x org-table-recalculate-buffer-tables)}}} :: Recompute all tables in the current buffer. - {{{findex(org-table-recalculate-buffer-tables)}}} + #+findex: org-table-recalculate-buffer-tables - {{{kbd(M-x 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)}}} + #+findex: org-table-iterate-buffer-tables *** Advanced features :PROPERTIES: :DESCRIPTION: Field and column names, parameters, and automatic recalc @@ -2686,8 +2679,8 @@ characters.[fn:30] {{{samp($)}}}. When there is an active region, change all marks in the region. - {{{kindex(C-#)}}} - {{{findex(org-table-rotate-recalc-marks)}}} + #+kindex: C-# + #+findex: org-table-rotate-recalc-marks Here is an example of a table that collects exam results of students and makes use of these features: @@ -2715,7 +2708,7 @@ rows that are marked ~#~ or ~*~, and fields that have a formula assigned to the field itself. The column formulas are not applied in rows with empty first field. -{{{cindex(marking characters\\\, tables)}}} +#+cindex: marking characters, tables The marking characters have the following meaning: #+attr_texinfo: :table-type "table" :indic "@samp" - ! :: The fields in this line define names for the columns, so that @@ -2770,9 +2763,9 @@ functions. :PROPERTIES: :DESCRIPTION: Plotting from Org tables :END: -{{{cindex(graph\\\, in tables)}}} -{{{cindex(plot tables using Gnuplot)}}} -{{{cindex(#+PLOT)}}} +#+cindex: graph, in tables +#+cindex: plot tables using Gnuplot +#+cindex: #+PLOT Org-Plot can produce 2D and 3D graphs of information stored in org tables using [[http://www.gnuplot.info/][Gnuplot]] and [[http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html][gnuplot-mode]]. To see this in action, ensure @@ -2837,7 +2830,7 @@ Org-Plot recognizes the following options: :DESCRIPTION: Notes in context :ORDERED: t :END: -{{{cindex(hyperlinks)}}} +#+cindex: hyperlinks Like HTML, Org provides links inside a file, external links to other files, Usenet articles, emails, and much more. @@ -2846,8 +2839,8 @@ other files, Usenet articles, emails, and much more. :PROPERTIES: :DESCRIPTION: How links in Org are formatted :END: -{{{cindex(link format)}}} -{{{cindex(format\\\, of links)}}} +#+cindex: link format +#+cindex: format, of links Org will recognize plain URL-like links and activate them as clickable links. The general link format, however, looks like this: @@ -2880,10 +2873,10 @@ links~. :PROPERTIES: :DESCRIPTION: Links to other places in the current file :END: -{{{cindex(internal links)}}} -{{{cindex(links\\\, internal)}}} -{{{cindex(targets\\\, for links)}}} -{{{cindex(property\\\, CUSTOM_ID)}}} +#+cindex: internal links +#+cindex: links, internal +#+cindex: targets, for links +#+cindex: property, CUSTOM_ID If the link does not look like a URL, it is considered to be internal in the current file. The most important case is a link like @@ -2930,9 +2923,9 @@ recorded earlier. :PROPERTIES: :DESCRIPTION: Automatically create internal links :END: -{{{cindex(radio targets)}}} -{{{cindex(targets\\\, radio)}}} -{{{cindex(links\\\, radio targets)}}} +#+cindex: radio targets +#+cindex: targets, radio +#+cindex: links, radio targets Org can automatically turn any occurrences of certain target names in normal text into a link. So without explicitly creating a link, the @@ -2948,22 +2941,22 @@ into Emacs. To update the target list during editing, press :PROPERTIES: :DESCRIPTION: URL-like links to the world :END: -{{{cindex(links\\\, external)}}} -{{{cindex(external links)}}} -{{{cindex(links\\\, external)}}} -{{{cindex(Gnus links)}}} -{{{cindex(BBDB links)}}} -{{{cindex(IRC links)}}} -{{{cindex(URL links)}}} -{{{cindex(file links)}}} -{{{cindex(VM links)}}} -{{{cindex(RMAIL links)}}} -{{{cindex(WANDERLUST links)}}} -{{{cindex(MH-E links)}}} -{{{cindex(USENET links)}}} -{{{cindex(SHELL links)}}} -{{{cindex(Info links)}}} -{{{cindex(Elisp links)}}} +#+cindex: links, external +#+cindex: external links +#+cindex: links, external +#+cindex: Gnus links +#+cindex: BBDB links +#+cindex: IRC links +#+cindex: URL links +#+cindex: file links +#+cindex: VM links +#+cindex: RMAIL links +#+cindex: WANDERLUST links +#+cindex: MH-E links +#+cindex: USENET links +#+cindex: SHELL links +#+cindex: Info links +#+cindex: Elisp links Org supports links to files, websites, Usenet and email messages, BBDB database entries and links to both IRC conversations and their logs. @@ -3027,8 +3020,8 @@ clickable button. If there is no description at all and the link points to an image, that image will be inlined into the exported HTML file. -{{{cindex(square brackets\\\, around links)}}} -{{{cindex(plain text external links)}}} +#+cindex: square brackets, around links +#+cindex: plain text external links Org also finds external links in the normal text and activates them as links. If spaces must be part of the link (for example in @@ -3040,7 +3033,7 @@ brackets. :PROPERTIES: :DESCRIPTION: URL-like links to the world :END: -{{{cindex(links\\\, handling)}}} +#+cindex: links, handling Org provides methods to create a link in the correct syntax, to insert it into an Org file, and to follow the link. @@ -3053,17 +3046,17 @@ insert it into an Org file, and to follow the link. buffer (see below). What kind of link will be created depends on the current buffer: - {{{cindex(storing links)}}} - {{{kindex(C-c l)}}} - {{{findex(org-store-link)}}} + #+cindex: storing links + #+kindex: C-c l + #+findex: org-store-link - Org mode buffers :: For Org files, if there is a ~<>~ at the cursor, the link points to the target. Otherwise it points to the current headline, which will also be the description.[fn:34] - {{{vindex(org-link-to-org-use-id)}}} - {{{cindex(property\\\, CUSTOM_ID)}}} - {{{cindex(property\\\, ID)}}} + #+vindex: org-link-to-org-use-id + #+cindex: property, CUSTOM_ID + #+cindex: property, ID If the headline has a ~CUSTOM_ID~ property, a link to this custom ID will be stored. In addition or alternatively @@ -3093,7 +3086,7 @@ insert it into an Org file, and to follow the link. ~irc:/~ style link to the user/channel/server under the point will be stored. - {{{vindex(org-irc-link-to-logs)}}} + #+vindex: org-irc-link-to-logs - Other files :: For any other files, the link will point to the file, with a search string (see [[Search options]]) @@ -3119,12 +3112,12 @@ insert it into an Org file, and to follow the link. descriptive text.[fn:36] If some text was selected when this command is called, the selected text becomes the default description. - {{{cindex(link completion)}}} - {{{cindex(completion\\\, of links)}}} - {{{cindex(inserting links)}}} - {{{vindex(org-keep-stored-link-after-insertion)}}} - {{{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 + #+kindex: C-c C-l + #+findex: org-insert-link - Inserting stored links :: All links stored during the current session are part of the history for this prompt, so you can access them with {{{key(up)}}} and {{{key(down)}}} (or @@ -3153,15 +3146,15 @@ insert it into an Org file, and to follow the link. possible with {{{samp(~/)}}} 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)}}} + #+cindex: file name completion + #+cindex: completion, of file names + #+kindex: C-u C-c C-l - {{{kbd(C-c C-l)}}} (with cursor on existing link) :: When the cursor 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)}}} + #+cindex: following links - {{{kbd(C-c C-o)}}}, ~org-open-at-point~ :: Open link at point. This will launch a web browser for URLs (using @@ -3184,36 +3177,36 @@ insert it into an Org file, and to follow the link. the frame configuration for following links, customize ~org-link-frame-setup~. - {{{vindex(org-file-apps)}}} - {{{vindex(org-link-frame-setup)}}} - {{{kindex(C-c C-o)}}} - {{{findex(org-open-at-point)}}} + #+vindex: org-file-apps + #+vindex: org-link-frame-setup + #+kindex: C-c C-o + #+findex: org-open-at-point - {{{key(RET)}}} :: When ~org-return-follows-link~ is set, {{{key(RET)}}} will also follow the link at point. - {{{vindex(org-return-follows-link)}}} - {{{kindex(RET)}}} + #+vindex: org-return-follows-link + #+kindex: RET - {{{key(mouse-2)}}} or {{{key(mouse-1)}}} :: On links, {{{kbd(mouse-2)}}} will open the link just as {{{kbd(C-c C-o)}}} would. Under Emacs 22 and later, {{{kbd(mouse-1)}}} will also follow a link. - {{{kindex(mouse-2)}}} - {{{kindex(mouse-1)}}} + #+kindex: mouse-2 + #+kindex: mouse-1 - {{{key(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:38] - {{{vindex(org-display-internal-link-with-indirect-buffer)}}} - {{{kindex(mouse-3)}}} + #+vindex: org-display-internal-link-with-indirect-buffer + #+kindex: mouse-3 - {{{kbd(C-c C-x C-v)}}}, ~org-toggle-inline-images~ :: - {{{cindex(inlining images)}}} - {{{cindex(images\\\, inlining)}}} - {{{vindex(org-startup-with-inline-images)}}} - {{{cindex(~inlineimages~\\\, STARTUP keyword)}}} - {{{cindex(~noinlineimages~\\\, STARTUP keyword)}}} - {{{kindex(C-c C-x C-v)}}} - {{{findex(org-toggle-inline-images)}}} + #+cindex: inlining images + #+cindex: images, inlining + #+vindex: org-startup-with-inline-images + #+cindex: ~inlineimages~, STARTUP keyword + #+cindex: ~noinlineimages~, STARTUP keyword + #+kindex: C-c C-x C-v + #+findex: org-toggle-inline-images Toggle the inline display of linked images. Normally this will only inline images that have no description part in the @@ -3224,18 +3217,18 @@ insert it into an Org file, and to follow the link. ~org-startup-with-inline-images~.[fn:177] - {{{kbd(C-c %)}}}, ~org-mark-ring-push~ :: - {{{kindex(C-c %)}}} - {{{findex(org-mark-ring-push)}}} - {{{cindex(mark ring)}}} + #+kindex: C-c % + #+findex: org-mark-ring-push + #+cindex: mark ring Push the current position onto the 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)}}} + #+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 @@ -3243,12 +3236,12 @@ insert it into an Org file, and to follow the link. - {{{kbd(C-c C-x C-n)}}}, ~org-next-link~ :: @@info:@itemx@@ {{{kbd(C-c C-x C-p)}}}, ~org-previous-link~ - {{{cindex(links\\\, finding next/previous)}}} + #+cindex: links, finding next/previous - {{{kindex(C-c C-x C-p)}}} - {{{findex(org-previous-link)}}} - {{{kindex(C-c C-x C-n)}}} - {{{findex(org-next-link)}}} + #+kindex: C-c C-x C-p + #+findex: org-previous-link + #+kindex: C-c C-x C-n + #+findex: org-next-link Move forward/backward to the next link in the buffer. At the limit of the buffer, the search fails once, and then wraps @@ -3285,8 +3278,8 @@ commands, like this (please select suitable global keys yourself): :PROPERTIES: :DESCRIPTION: Shortcuts for writing complex links :END: -{{{cindex(link abbreviations)}}} -{{{cindex(abbreviation\\\, links)}}} +#+cindex: link abbreviations +#+cindex: abbreviation, links Long URLs can be cumbersome to type, and often many similar links are needed in a document. For this you can use link abbreviations. An @@ -3296,7 +3289,7 @@ abbreviated link looks like this [[linkword:tag][description]] #+end_src -{{{vindex(org-link-abbrev-alist)}}} +#+vindex: org-link-abbrev-alist {{{noindent}}} where the tag is optional. The /linkword/ must be a word, starting with a letter, followed by letters, numbers, @@ -3338,7 +3331,7 @@ the Org author is doing besides Emacs hacking with ~[[ads:Dominik,C]]~. If you need special abbreviations just for a single Org buffer, you can define them in the file with -{{{cindex(#+LINK)}}} +#+cindex: #+LINK #+begin_src org ,#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= ,#+LINK: google http://www.google.com/search?q=%s @@ -3355,8 +3348,8 @@ link with prefix. :PROPERTIES: :DESCRIPTION: Linking to a specific location :END: -{{{cindex(search option in file links)}}} -{{{cindex(file links\\\, searching)}}} +#+cindex: search option in file links +#+cindex: file links, searching File links can contain additional information to make Emacs jump to a particular location in the file when following a link. This can be a @@ -3403,8 +3396,8 @@ search for ~find me~ in the current file, just as :PROPERTIES: :DESCRIPTION: When the default search is not enough :END: -{{{cindex(custom search strings)}}} -{{{cindex(search strings\\\, custom)}}} +#+cindex: custom search strings +#+cindex: search strings, custom The default mechanism for creating search strings and for doing the actual search related to a file link may not work correctly in all @@ -3413,8 +3406,8 @@ like {{{samp(year="1993")}}} which would not result in good search strings, because the only unique identification for a {{{bibtex}}} entry is the citation key. -{{{vindex(org-create-file-search-functions)}}} -{{{vindex(org-execute-file-search-functions)}}} +#+vindex: org-create-file-search-functions +#+vindex: org-execute-file-search-functions If you come across such a problem, you can write custom functions to set the right search string for a particular file type, and to do the @@ -3431,7 +3424,7 @@ an implementation example. See the file {{{file(org-bibtex.el)}}}. :DESCRIPTION: Every tree branch can be a TODO item :OPTIONAL_TITLE: TODO Items :END: -{{{cindex(TODO items)}}} +#+cindex: TODO items Org mode does not maintain TODO lists as separate documents.[fn:40] Instead, TODO items are an integral part of the notes file, because @@ -3462,8 +3455,8 @@ are: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-t)}}}, ~org-todo~ :: - {{{kindex(C-c C-t)}}} - {{{cindex(cycling\\\, of TODO states)}}} + #+kindex: C-c C-t + #+cindex: cycling, of TODO states Rotate the TODO state of the current item among @@ -3476,19 +3469,19 @@ are: agenda buffers with the {{{kbd(t)}}} command key (see [[Agenda commands]]). - {{{kbd(C-u C-c C-t)}}} :: - {{{kindex(C-u C-c C-t)}}} + #+kindex: C-u C-c C-t Select a specific keyword using completion or (if it has been set up) the fast selection interface. For the latter, you need to assign keys to TODO states, see [[Per-file keywords]], and [[Setting tags]], for more information. - {{{kindex(S-@key{right})}}} - {{{kindex(S-@key{left})}}} + #+kindex: S-@key{right} + #+kindex: S-@key{left} - {{{kbdkey(S-,right)}}} {{{kbdkey(S-,left)}}} :: - {{{vindex(org-treat-S-cursor-todo-selection-as-state-change)}}} + #+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 @@ -3497,10 +3490,10 @@ are: ~org-treat-S-cursor-todo-selection-as-state-change~. - {{{kbd(C-c / t)}}}, ~org-show-todo-tree~ :: - {{{kindex(C-c / t)}}} + #+kindex: C-c / t - {{{cindex(sparse tree\\\, for TODO)}}} - {{{vindex(org-todo-keywords)}}} + #+cindex: sparse tree, for TODO + #+vindex: org-todo-keywords 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 @@ -3513,7 +3506,7 @@ are: arguments, find all TODO states, both un-done and done. - {{{kbd(C-c a t)}}}, ~org-todo-list~ :: - {{{kindex(C-c a t)}}} + #+kindex: C-c a t 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 @@ -3522,13 +3515,13 @@ are: See [[Global TODO list]], for more information. - {{{kbdkey(S-M-,RET)}}}, ~org-insert-todo-heading~ :: - {{{kindex(S-M-@key{RET})}}} + #+kindex: S-M-@key{RET} Insert a new TODO entry below the current one. {{{noindent}}} -{{{vindex(org-todo-state-tags-triggers)}}} +#+vindex: org-todo-state-tags-triggers Changing a TODO state can also trigger tag changes. See the docstring of the option ~org-todo-state-tags-triggers~ for details. @@ -3538,9 +3531,9 @@ option ~org-todo-state-tags-triggers~ for details. :TITLE: Extended use of TODO keywords :END: -{{{cindex(extended TODO keywords)}}} +#+cindex: extended TODO keywords -{{{vindex(org-todo-keywords)}}} +#+vindex: org-todo-keywords By default, marked TODO entries have one of only two states: TODO and DONE. Org mode allows you to classify TODO items in more complex ways @@ -3556,8 +3549,8 @@ TODO items in particular (see [[Tags]]). :DESCRIPTION: From TODO to DONE in steps :TITLE: TODO keywords as workflow states :END: -{{{cindex(TODO workflow)}}} -{{{cindex(workflow states as TODO keywords)}}} +#+cindex: TODO workflow +#+cindex: workflow states as TODO keywords You can use TODO keywords to indicate different /sequential/ states in the process of working on an item, for example:[fn:41] @@ -3574,7 +3567,7 @@ action/) from the DONE states (which need /no further action/). If you don't provide the separator bar, the last state is used as the DONE state. -{{{cindex(completion\\\, of TODO keywords)}}} +#+cindex: completion, of TODO keywords With this setup, the command {{{kbd(C-c C-t)}}} will cycle an entry from TODO to FEEDBACK, then to VERIFY, and finally to DONE and @@ -3593,9 +3586,9 @@ more information. :DESCRIPTION: I do this, Fred does the rest :TITLE: TODO keywords as types :END: -{{{cindex(TODO types)}}} -{{{cindex(names as TODO keywords)}}} -{{{cindex(types as TODO keywords)}}} +#+cindex: TODO types +#+cindex: names as TODO keywords +#+cindex: types as TODO keywords The second possibility is to use TODO keywords to indicate different /types/ of action items. For example, you might want to indicate @@ -3629,7 +3622,7 @@ argument as well when creating the global TODO list: {{{kbd(C-3 C-c a t)}}}. :DESCRIPTION: Mixing it all, and still finding your way :TITLE: Multiple keyword sets in one file :END: -{{{cindex(TODO keyword sets)}}} +#+cindex: TODO keyword sets Sometimes you may want to use different sets of TODO keywords in parallel. For example, you may want to have the basic @@ -3655,9 +3648,9 @@ of which subsequence should be used for a given entry. In this setup, select the correct sequence. Besides the obvious ways like typing a keyword or using completion, you may also apply the following commands: -{{{kindex(C-S-@key{right})}}} -{{{kindex(C-S-@key{left})}}} -{{{kindex(C-u C-u C-c C-t)}}} +#+kindex: C-S-@key{right} +#+kindex: C-S-@key{left} +#+kindex: C-u C-u C-c C-t #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-u C-u C-c C-t)}}} {{{kbdkey(C-S-,right)}}} {{{kbdkey(C-S-,left)}}} :: @@ -3669,8 +3662,8 @@ keyword or using completion, you may also apply the following commands: (see [[Conflicts]]). - {{{kbdkey(S-,right)}}} {{{kbdkey(S-,left)}}} :: - {{{kindex(S-@key{right})}}} - {{{kindex(S-@key{left})}}} + #+kindex: S-@key{right} + #+kindex: S-@key{left} {{{kbdkey(S-,left)}}} and {{{kbdkey(S-,right)}}} walk through /all/ keywords from all sets, so for example {{{kbdkey(S-,right)}}} would switch @@ -3696,7 +3689,7 @@ each keyword, in parentheses.[fn:43] For example: (sequence "|" "CANCELED(c)"))) #+end_src -{{{vindex(org-fast-tag-selection-include-todo)}}} +#+vindex: org-fast-tag-selection-include-todo If you then press {{{kbd(C-c C-t)}}} followed by the selection key, the entry will be switched to this state. {{{kbd(SPC)}}} can be used @@ -3707,11 +3700,11 @@ to remove any TODO keyword from an entry.[fn:44] :DESCRIPTION: Different files, different requirements :TITLE: Setting up keywords for individual files :END: -{{{cindex(keyword options)}}} -{{{cindex(per-file keywords)}}} -{{{cindex(#+TODO)}}} -{{{cindex(#+TYP_TODO)}}} -{{{cindex(#+SEQ_TODO)}}} +#+cindex: keyword options +#+cindex: per-file keywords +#+cindex: #+TODO +#+cindex: #+TYP_TODO +#+cindex: #+SEQ_TODO It can be very useful to use different aspects of the TODO mechanism in different files. For file-local settings, you need to add special lines @@ -3739,12 +3732,12 @@ A setup for using several sets in parallel would be: ,#+TODO: | CANCELED #+end_example -{{{cindex(completion\\\, of option keywords)}}} -{{{kindex(M-@key{TAB})}}} +#+cindex: completion, of option keywords +#+kindex: M-@key{TAB} {{{noindent}}} To make sure you are using the correct keyword, type {{{samp(#+)}}} into the buffer and then use {{{kbdkey(M-,TAB)}}} completion. -{{{cindex(DONE\\\, final TODO keyword)}}} +#+cindex: DONE, final TODO keyword Remember that the keywords after the vertical bar (or the last keyword if no bar is there) must always mean that the item is DONE (although you may use a different word). After changing one of these lines, use @@ -3755,10 +3748,10 @@ known to Org mode.[fn:45] :PROPERTIES: :DESCRIPTION: Highlighting states :END: -{{{cindex(faces\\\, for TODO keywords)}}} -{{{vindex(org-todo @r{(face)})}}} -{{{vindex(org-done @r{(face)})}}} -{{{vindex(org-todo-keyword-faces)}}} +#+cindex: faces, for TODO keywords +#+vindex: org-todo @r{(face)} +#+vindex: org-done @r{(face)} +#+vindex: org-todo-keyword-faces Org mode highlights TODO keywords with special faces: ~org-todo~ for keywords indicating that an item still has to be acted upon, and @@ -3785,10 +3778,10 @@ foreground or a background color. :PROPERTIES: :DESCRIPTION: When one task needs to wait for others :END: -{{{cindex(TODO dependencies)}}} -{{{cindex(dependencies\\\, of TODO states)}}} -{{{vindex(org-enforce-todo-dependencies)}}} -{{{cindex(property\\\, ORDERED)}}} +#+cindex: TODO dependencies +#+cindex: dependencies, of TODO states +#+vindex: org-enforce-todo-dependencies +#+cindex: property, ORDERED The structure of Org files (hierarchy and lists) makes it easy to define TODO dependencies. Usually, a parent TODO task should not be marked DONE until @@ -3817,9 +3810,9 @@ example: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x o)}}}, ~org-toggle-ordered-property~ :: - {{{kindex(C-c C-x o)}}} - {{{vindex(org-track-ordered-property-with-tag)}}} - {{{cindex(property\\\, ORDERED)}}} + #+kindex: C-c C-x o + #+vindex: org-track-ordered-property-with-tag + #+cindex: property, ORDERED 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 @@ -3827,19 +3820,19 @@ example: 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)}}} + #+kindex: C-u C-u C-u C-c C-t Change TODO state, circumventing any state blocking. -{{{vindex(org-agenda-dim-blocked-tasks)}}} +#+vindex: org-agenda-dim-blocked-tasks If you set the variable ~org-agenda-dim-blocked-tasks~, TODO entries that cannot be closed because of such dependencies will be shown in a dimmed font or even made invisible in agenda views (see [[Agenda views]]). -{{{cindex(checkboxes and TODO dependencies)}}} -{{{vindex(org-enforce-todo-dependencies)}}} +#+cindex: checkboxes and TODO dependencies +#+vindex: org-enforce-todo-dependencies You can also block changes of TODO states by looking at checkboxes (see [[Checkboxes]]). If you set the variable @@ -3856,8 +3849,8 @@ module {{{file(org-depend.el)}}}. :PROPERTIES: :DESCRIPTION: Dates and notes for progress :END: -{{{cindex(progress logging)}}} -{{{cindex(logging\\\, of progress)}}} +#+cindex: progress logging +#+cindex: logging, of progress Org mode can automatically record a timestamp and possibly a note when you mark a TODO item as DONE, or even each time you change the state of @@ -3904,10 +3897,10 @@ day, giving you an overview of what has been done. :PROPERTIES: :DESCRIPTION: When did the status change? :END: -{{{cindex(drawer\\\, for state change recording)}}} -{{{vindex(org-log-states-order-reversed)}}} -{{{vindex(org-log-into-drawer)}}} -{{{cindex(property\\\, LOG_INTO_DRAWER)}}} +#+cindex: drawer, for state change recording +#+vindex: org-log-states-order-reversed +#+vindex: org-log-into-drawer +#+cindex: property, LOG_INTO_DRAWER When TODO keywords are used as workflow states (see [[Workflow states]]), you might want to keep track of when a state change occurred @@ -3935,7 +3928,7 @@ keyword. For example, with the setting: #+end_src {{{noindent}}} -{{{vindex(org-log-done)}}} +#+vindex: org-log-done you not only define global TODO keywords and fast access keys, but also request that a time is recorded when the entry is set to @@ -3961,7 +3954,7 @@ to a buffer: ,#+TODO: TODO(t) WAIT(w@/!) | DONE(d!) CANCELED(c@) #+end_example -{{{cindex(property\\\, LOGGING)}}} +#+cindex: property, LOGGING In order to define logging settings that are local to a subtree or a single item, define a LOGGING property in this entry. Any non-empty @@ -3993,7 +3986,7 @@ settings like ~TODO(!)~. For example: :PROPERTIES: :DESCRIPTION: How consistent have you been? :END: -{{{cindex(habits)}}} +#+cindex: habits Org has the ability to track the consistency of a special category of TODOs, called "habits." A habit has the following properties: @@ -4097,7 +4090,7 @@ contexts, for example. :PROPERTIES: :DESCRIPTION: Some things are more important than others :END: -{{{cindex(priorities)}}} +#+cindex: priorities If you use Org mode extensively, you may end up with enough TODO items that it starts to make sense to prioritize them. Prioritizing can be done by @@ -4107,7 +4100,7 @@ placing a /priority cookie/ into the headline of a TODO item, like this: ,*** TODO [#A] Write letter to Sam Fortune #+end_example -{{{vindex(org-priority-faces)}}} +#+vindex: org-priority-faces {{{noindent}}} By default, Org mode supports three priorities: {{{samp(A)}}}, {{{samp(B)}}}, and {{{samp(C)}}}. {{{samp(A)}}} is the highest @@ -4122,11 +4115,11 @@ items. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c XXX)}}} :: - {{{kindex(C-c ,)}}} - #+comment: {{{kindex(@kbd{C-c ,})}}} - #+comment: Preceding line won't export to pdf - {{{findex(org-priority)}}} - #+comment: Should be C-c , + #+kindex: C-c , + # #+kindex: @key{C-c ,} + # Preceding line won't export to pdf + #+findex: org-priority + # Should be C-c , Set the priority of the current headline (~org-priority~). The command prompts for a priority character {{{samp(A)}}}, {{{samp(B)}}} or {{{samp(C)}}}. When you press {{{key(SPC)}}}} instead, the priority @@ -4135,7 +4128,7 @@ items. {{{kbd(,)}}} command (see [[Agenda commands]]). - {{{kbdkey(S-,up)}}}, {{{kbdkey(S-,down)}}}, {{{command(org-priority-up)}}}, {{{command(org-priority-down)}}} :: - {{{vindex(org-priority-start-cycle-with-default)}}} + #+vindex: org-priority-start-cycle-with-default Increase/decrease priority of current headline.[fn:50] Note that these keys are also used to modify timestamps @@ -4143,9 +4136,9 @@ items. discussion of the interaction with ~shift-selection-mode~. -{{{vindex(org-highest-priority)}}} -{{{vindex(org-lowest-priority)}}} -{{{vindex(org-default-priority)}}} +#+vindex: org-highest-priority +#+vindex: org-lowest-priority +#+vindex: org-default-priority You can change the range of allowed priorities by setting the variables ~org-highest-priority~, ~org-lowest-priority~, and @@ -4153,7 +4146,7 @@ variables ~org-highest-priority~, ~org-lowest-priority~, and values (highest, lowest, default) like this (please make sure that the highest priority is earlier in the alphabet than the lowest priority): -{{{cindex(#+PRIORITIES)}}} +#+cindex: #+PRIORITIES #+begin_example ,#+PRIORITIES: A C B @@ -4163,9 +4156,9 @@ highest priority is earlier in the alphabet than the lowest priority): :PROPERTIES: :DESCRIPTION: Splitting a task into manageable pieces :END: -{{{cindex(tasks\\\, breaking down)}}} -{{{cindex(statistics\\\, for TODO items)}}} -{{{vindex(org-agenda-todo-list-sublevels)}}} +#+cindex: tasks, breaking down +#+cindex: statistics, for TODO items +#+vindex: org-agenda-todo-list-sublevels It is often advisable to break down large tasks into smaller, manageable subtasks. You can do this by creating an outline tree below @@ -4185,14 +4178,14 @@ example: ,** DONE Talk to neighbor #+end_example -{{{cindex(property\\\, COOKIE_DATA)}}} +#+cindex: property, COOKIE_DATA If a heading has both checkboxes and TODO children below it, the meaning of the statistics cookie become ambiguous. Set the property ~COOKIE_DATA~ to either {{{samp(checkbox)}}} or {{{samp(todo)}}} to resolve this issue. -{{{vindex(org-hierarchical-todo-statistics)}}} +#+vindex: org-hierarchical-todo-statistics If you would like to have the statistics cookie count any TODO entries in the subtree (not just direct children), configure the variable @@ -4229,8 +4222,8 @@ of) a large number of subtasks (see [[Checkboxes]]). :DESCRIPTION: Tick-off lists :END: -{{{cindex(checkboxes)}}} -{{{vindex(org-list-automatic-rules)}}} +#+cindex: checkboxes +#+vindex: org-list-automatic-rules Every item in a plain list (see [[Plain lists]]) can be made into a checkbox by starting it with the string {{{samp([ ])}}}.[fn:52] This @@ -4259,10 +4252,10 @@ that are checkboxes, toggling one of the children checkboxes will make the parent checkbox reflect if none, some, or all of the children are checked. -{{{cindex(statistics\\\, for checkboxes)}}} -{{{cindex(checkbox statistics)}}} -{{{cindex(property\\\, COOKIE_DATA)}}} -{{{vindex(org-hierarchical-checkbox-statistics)}}} +#+cindex: statistics, for checkboxes +#+cindex: checkbox statistics +#+cindex: property, COOKIE_DATA +#+vindex: org-hierarchical-checkbox-statistics The {{{samp([2/4])}}} and {{{samp([1/3])}}} in the first and second line are cookies indicating how many checkboxes present in this entry @@ -4282,9 +4275,9 @@ of children, and it will display whatever was changed last. Set the property ~COOKIE_DATA~ to either {{{samp(checkbox)}}} or {{{samp(todo)}}} to resolve this issue. -{{{cindex(blocking\\\, of checkboxes)}}} -{{{cindex(checkbox blocking)}}} -{{{cindex(property\\\, ORDERED)}}} +#+cindex: blocking, of checkboxes +#+cindex: checkbox blocking +#+cindex: property, ORDERED If the current outline node has an ~ORDERED~ property, checkboxes must be checked off in sequence, and an error will be thrown if you try to @@ -4319,9 +4312,9 @@ check off a box while there are unchecked boxes above it. a plain list item (see [[Plain lists]]). - {{{kbd(C-c C-x o)}}}, ~org-toggle-ordered-property~ :: - {{{kindex(C-c C-x o)}}} - {{{vindex(org-track-ordered-property-with-tag)}}} - {{{cindex(property\\\, ORDERED)}}} + #+kindex: C-c C-x o + #+vindex: org-track-ordered-property-with-tag + #+cindex: property, ORDERED Toggle the ~ORDERED~ property of the entry, to toggle if checkboxes must be checked off in sequence. A property is used for this @@ -4331,7 +4324,7 @@ check off a box while there are unchecked boxes above it. customize the variable ~org-track-ordered-property-with-tag~. - {{{kbd(C-c #)}}}, ~org-update-statistics-cookies~ :: - {{{kindex(C-c #)}}} + #+kindex: C-c # Update the statistics cookie in the current outline entry. When called with a {{{kbd(C-u)}}} prefix, update the entire file. @@ -4345,16 +4338,16 @@ check off a box while there are unchecked boxes above it. :PROPERTIES: :DESCRIPTION: Tagging headlines and matching sets of tags :END: -{{{cindex(tags)}}} -{{{cindex(headline tagging)}}} -{{{cindex(matching\\\, tags)}}} -{{{cindex(sparse tree\\\, tag based)}}} +#+cindex: tags +#+cindex: headline tagging +#+cindex: matching, tags +#+cindex: sparse tree, tag based An excellent way to implement labels and contexts for cross-correlating information is to assign /tags/ to headlines. Org mode has extensive support for tags. -{{{vindex(org-tag-faces)}}} +#+vindex: org-tag-faces Every headline can contain a list of tags; they occur at the end of the headline. Tags are normal words containing letters, numbers, @@ -4369,9 +4362,9 @@ the same way as you can for TODO keywords (see [[Faces for TODO keywords]]). :PROPERTIES: :DESCRIPTION: Tags use the tree structure of an outline :END: -{{{cindex(tag inheritance)}}} -{{{cindex(inheritance\\\, of tags)}}} -{{{cindex(sublevels\\\, inclusion into tags match)}}} +#+cindex: tag inheritance +#+cindex: inheritance, of tags +#+cindex: sublevels, inclusion into tags match /Tags/ make use of the hierarchical structure of outline trees. If a heading has a certain tag, all subheadings will inherit the tag as @@ -4391,19 +4384,19 @@ file should inherit just as if these tags were defined in a hypothetical level zero that surrounds the entire file. Use a line like this:[fn:55] -{{{cindex(#+FILETAGS)}}} +#+cindex: #+FILETAGS #+begin_example ,#+FILETAGS: :Peter:Boss:Secret: #+end_example -{{{vindex(org-use-tag-inheritance)}}} -{{{vindex(org-tags-exclude-from-inheritance)}}} +#+vindex: org-use-tag-inheritance +#+vindex: org-tags-exclude-from-inheritance {{{noindent}}} To limit tag inheritance to specific tags, or to turn it off entirely, use the variables ~org-use-tag-inheritance~ and ~org-tags-exclude-from-inheritance~. -{{{vindex(org-tags-match-list-sublevels)}}} +#+vindex: org-tags-match-list-sublevels When a headline matches during a tags search while tag inheritance is turned on, all the sublevels in the same tree will (for a simple match @@ -4416,10 +4409,10 @@ recommended). :PROPERTIES: :DESCRIPTION: How to assign tags to a headline :END: -{{{cindex(setting tags)}}} -{{{cindex(tags\\\, setting)}}} +#+cindex: setting tags +#+cindex: tags, setting -{{{kindex(M-@key{TAB})}}} +{{{kindex: M-@k#+TAB} Tags can simply be typed into the buffer at the end of a headline. After a colon, {{{kbdkey(M-,TAB)}}} offers completion on tags. There is @@ -4427,10 +4420,10 @@ also a special command for inserting tags: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-q)}}}, ~org-set-tags-command~ :: - {{{kindex(C-c C-q)}}} + #+kindex: C-c C-q - {{{cindex(completion\\\, of tags)}}} - {{{vindex(org-tags-column)}}} + #+cindex: completion, of tags + #+vindex: org-tags-column Enter new tags for the current headline. Org mode will either offer completion or a special single-key interface for setting tags, see @@ -4441,12 +4434,12 @@ also a special command for inserting tags: demotion, and TODO state changes (see [[TODO basics]]). - {{{kbd(C-c C-c)}}}, ~org-set-tags-command~ :: - {{{kindex(C-c C-c)}}} + #+kindex: C-c C-c When the cursor is in a headline, this does the same as {{{kbd(C-c C-q)}}}. -{{{vindex(org-tag-alist)}}} +#+vindex: org-tag-alist Org supports tag insertion based on a /list of tags/. By default this list is constructed dynamically, containing all tags currently used in @@ -4454,7 +4447,7 @@ the buffer. You may also globally specify a hard list of tags with the variable ~org-tag-alist~. Finally you can set the default tags for a given file with lines like -{{{cindex(#+TAGS)}}} +#+cindex: #+TAGS #+begin_example ,#+TAGS: @work @home @tennisclub ,#+TAGS: laptop car pc sailboat @@ -4468,7 +4461,7 @@ in a specific file, add an empty TAGS option line to that file: ,#+TAGS: #+end_example -{{{vindex(org-tag-persistent-alist)}}} +#+vindex: org-tag-persistent-alist If you have a preferred set of tags that you would like to use in every file, in addition to those defined on a per-file basis by TAGS @@ -4557,26 +4550,26 @@ keys: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(a-z...)}}} :: - {{{kindex(a-z...)}}} + #+kindex: a-z... Pressing keys assigned to tags will add or remove them from the list of tags in the current line. Selecting a tag in a group of mutually exclusive tags will turn off any other tags from that group. - {{{key(TAB)}}} :: - {{{kindex(@key{TAB})}}} + {{{kindex: @k#+TAB} Enter a tag in the minibuffer, even if the tag is not in the predefined list. You will be able to complete on all tags present in the buffer. You can also add several tags: just separate them with a comma. - {{{key(SPC)}}} :: - {{{kindex(@key{SPC})}}} + {{{kindex: @k#+SPC} Clear all tags for this line. - {{{key(RET)}}} :: - {{{kindex(@key{RET})}}} + {{{kindex: @k#+RET} Accept the modified set. @@ -4609,7 +4602,7 @@ alternatively with {{{kbd(C-c C-c C-c w)}}}. Adding the non-predefined tag {{{samp(Sarah)}}} could be done with {{{ksksksksk(C-c C-c,TAB,S a r a h,RET,RET)}}}. -{{{vindex(org-fast-tag-selection-single-key)}}} +#+vindex: org-fast-tag-selection-single-key If you find that most of the time you need only a single key press to modify your list of tags, set the variable @@ -4626,8 +4619,8 @@ selection, it comes up only when you press an extra {{{kbd(C-c)}}}. :PROPERTIES: :DESCRIPTION: Searching for combinations of tags :END: -{{{cindex(tag searches)}}} -{{{cindex(searching for tags)}}} +#+cindex: tag searches +#+cindex: searching for tags Once a system of tags has been set up, it can be used to collect related information into special lists. @@ -4640,14 +4633,14 @@ information into special lists. line. - {{{kbd(C-c a m)}}}, ~org-tags-view~ :: - {{{kindex(C-c a m)}}} + #+kindex: C-c a m Create a global list of tag matches from all agenda files. See [[Matching tags and properties]]. - {{{kbd(C-c a M)}}}, ~org-tags-view~ :: - {{{kindex(C-c a M)}}} - {{{vindex(org-tags-match-list-sublevels)}}} + #+kindex: C-c a M + #+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 variable @@ -4668,7 +4661,7 @@ with many examples, see [[Matching tags and properties]]. :DESCRIPTION: Storing information about an entry :OPTIONAL_TITLE: Properties and Columns :END: -{{{cindex(properties)}}} +#+cindex: properties A property is a key-value pair associated with an entry. Properties can be set so they are associated with a single entry, with every @@ -4691,8 +4684,8 @@ Properties can be conveniently edited and viewed in column view :PROPERTIES: :DESCRIPTION: How properties are spelled out :END: -{{{cindex(property syntax)}}} -{{{cindex(drawer\\\, for properties)}}} +#+cindex: property syntax +#+cindex: drawer, for properties Properties are key-value pairs. When they are associated with a single entry or with a tree they need to be inserted into a special drawer @@ -4736,8 +4729,8 @@ predefine publishers and the number of disks in a box like this: If you want to set properties that can be inherited by any entry in a file, use a line like: -{{{cindex(property\\\, _ALL)}}} -{{{cindex(#+PROPERTY)}}} +#+cindex: property, _ALL +#+cindex: #+PROPERTY #+begin_example ,#+PROPERTY: NDisks_ALL 1 2 3 4 #+end_example @@ -4746,7 +4739,7 @@ If you want to add to the value of an existing property, append a ~+~ to the property name. The following results in the property ~var~ having the value ``foo=1 bar=2''. -{{{cindex(property\\\, +)}}} +#+cindex: property, + #+begin_example ,#+PROPERTY: var foo=1 ,#+PROPERTY: var+ bar=2 @@ -4756,7 +4749,7 @@ It is also possible to add to the values of inherited properties. The following results in the ~genres~ property having the value ``Classic Baroque'' under the ~Goldberg Variations~ subtree. -{{{cindex(property\\\, +)}}} +#+cindex: property, + #+begin_example ,* CD collection ,** Classic @@ -4775,7 +4768,7 @@ Baroque'' under the ~Goldberg Variations~ subtree. #+end_example Note that a property can only have one entry per Drawer. -{{{vindex(org-global-properties)}}} +#+vindex: org-global-properties Property values set with the global variable ~org-global-properties~ can be inherited by all entries in all Org files. @@ -4785,52 +4778,52 @@ The following commands help to work with properties: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbdkey(M-,TAB)}}}, ~pcomplete~ :: - {{{kindex(M-@key{TAB})}}} + #+kindex: M-@key{TAB} After an initial colon in a line, complete property keys. All keys used in the current file will be offered as possible completions. - {{{kbd(C-c C-x p)}}}, ~org-set-property~ :: - {{{kindex(C-c C-x p)}}} + #+kindex: C-c C-x p Set a property. This prompts for a property name and a value. If necessary, the property drawer is created as well. - C-u M-x org-insert-drawer - {{{cindex(org-insert-drawer)}}} + #+cindex: org-insert-drawer Insert a property drawer into the current entry. The drawer will be 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)}}} + #+kindex: C-c C-c With the cursor in a property drawer, this executes property commands. - {{{kbd(C-c C-c s)}}}, ~org-set-property~ :: - {{{kindex(C-c C-c s)}}} + #+kindex: C-c C-c s Set a property in the current entry. Both the property and the value can be inserted using completion. - {{{kbdkey(S-,right)}}} {{{kbdkey(S-,left)}}}, ~org-property-next-allowed-value~ ~org-property-previous-allowed-value~ :: - {{{kindex(S-@key{right})}}} + {{{kindex: S-@k#+right} 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)}}} + #+kindex: C-c C-c d Remove a property from the current entry. - {{{kbd(C-c C-c D)}}}, ~org-delete-property-globally~ :: - {{{kindex(C-c C-c D)}}} + #+kindex: C-c C-c D 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)}}} + #+kindex: C-c C-c c Compute the property at point, using the operator and scope from the nearest column format definition. @@ -4839,7 +4832,7 @@ The following commands help to work with properties: :PROPERTIES: :DESCRIPTION: Access to other Org mode features :END: -{{{cindex(properties\\\, special)}}} +#+cindex: properties, special Special properties provide an alternative access method to Org mode features, like the TODO state or the priority of an entry, discussed @@ -4848,23 +4841,23 @@ include these states in a column view (see [[Column view]]), or to use them in queries. The following property names are special and (except for ~:CATEGORY:~) should not be used as keys in the properties drawer: -{{{cindex(property\\\, special\\\, ID)}}} -{{{cindex(property\\\, special\\\, TODO)}}} -{{{cindex(property\\\, special\\\, TAGS)}}} -{{{cindex(property\\\, special\\\, ALLTAGS)}}} -{{{cindex(property\\\, special\\\, CATEGORY)}}} -{{{cindex(property\\\, special\\\, PRIORITY)}}} -{{{cindex(property\\\, special\\\, DEADLINE)}}} -{{{cindex(property\\\, special\\\, SCHEDULED)}}} -{{{cindex(property\\\, special\\\, CLOSED)}}} -{{{cindex(property\\\, special\\\, TIMESTAMP)}}} -{{{cindex(property\\\, special\\\, TIMESTAMP_IA)}}} -{{{cindex(property\\\, special\\\, CLOCKSUM)}}} -{{{cindex(property\\\, special\\\, CLOCKSUM_T)}}} -{{{cindex(property\\\, special\\\, BLOCKED)}}} +#+cindex: property, special, ID +#+cindex: property, special, TODO +#+cindex: property, special, TAGS +#+cindex: property, special, ALLTAGS +#+cindex: property, special, CATEGORY +#+cindex: property, special, PRIORITY +#+cindex: property, special, DEADLINE +#+cindex: property, special, SCHEDULED +#+cindex: property, special, CLOSED +#+cindex: property, special, TIMESTAMP +#+cindex: property, special, TIMESTAMP_IA +#+cindex: property, special, CLOCKSUM +#+cindex: property, special, CLOCKSUM_T +#+cindex: property, special, BLOCKED # guessing that ITEM is needed in this area; also, should this list be sorted? -{{{cindex(property\\\, special\\\, ITEM)}}} -{{{cindex(property\\\, special\\\, FILE)}}} +#+cindex: property, special, ITEM +#+cindex: property, special, FILE #+attr_texinfo: :columns "0.3 0.7" | ID | A globally unique ID used for synchronization during | @@ -4892,28 +4885,28 @@ for ~:CATEGORY:~) should not be used as keys in the properties drawer: :PROPERTIES: :DESCRIPTION: Matching property values :END: -{{{cindex(properties\\\, searching)}}} -{{{cindex(searching\\\, of properties)}}} +#+cindex: properties, searching +#+cindex: searching, of properties To create sparse trees and special lists with selection based on properties, the same commands are used as for tag searches (see [[Tag searches]]). #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c / m)}}}, ~C-c \~ ~org-match-sparse-tree~ :: - {{{kindex(C-c / m)}}} + #+kindex: C-c / m Create a sparse tree with all matching entries. With a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not a TODO line. - {{{kbd(C-c a m)}}}, ~org-tags-view~ :: - {{{kindex(C-c a m)}}} + #+kindex: C-c a m Create a global list of tag/property matches from all agenda files. See [[Matching tags and properties]]. - {{{kbd(C-c a M)}}}, ~org-tags-view~ :: - {{{kindex(C-c a M)}}} - {{{vindex(org-tags-match-list-sublevels)}}} + #+kindex: C-c a M + #+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 variable @@ -4928,7 +4921,7 @@ single property: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c / p)}}} :: - {{{kindex(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 @@ -4941,10 +4934,10 @@ single property: :PROPERTIES: :DESCRIPTION: Passing values down a tree :END: -{{{cindex(properties\\\, inheritance)}}} -{{{cindex(inheritance\\\, of properties)}}} +#+cindex: properties, inheritance +#+cindex: inheritance, of properties -{{{vindex(org-use-property-inheritance)}}} +#+vindex: org-use-property-inheritance The outline structure of Org mode documents lends itself to an inheritance model of properties: if the parent in a tree has a certain @@ -4965,7 +4958,7 @@ least for the special applications for which they are used: #+attr_texinfo: :table-type "table" :indic "@asis" - ~COLUMNS~ :: - {{{cindex(property\\\, COLUMNS)}}} + #+cindex: property, COLUMNS The ~:COLUMNS:~ property defines the format of column view (see [[Column view]]). It is inherited in the sense that the level where a ~:COLUMNS:~ @@ -4974,19 +4967,19 @@ least for the special applications for which they are used: view is turned on. - ~CATEGORY~ :: - {{{cindex(property\\\, CATEGORY)}}} + #+cindex: property, CATEGORY For agenda view, a category set through a ~:CATEGORY:~ property applies to the entire subtree. - ~ARCHIVE~ :: - {{{cindex(property\\\, ARCHIVE)}}} + #+cindex: property, ARCHIVE For archiving, the ~:ARCHIVE:~ property may define the archive location for the entire subtree (see [[Moving subtrees]]). - ~LOGGING~ :: - {{{cindex(property\\\, LOGGING)}}} + #+cindex: property, LOGGING The LOGGING property may define logging settings for an entry or a subtree (see [[Tracking TODO state changes]]). @@ -5015,8 +5008,8 @@ from a number of files. :PROPERTIES: :DESCRIPTION: The COLUMNS format property :END: -{{{cindex(column view\\\, for properties)}}} -{{{cindex(properties\\\, column view)}}} +#+cindex: column view, for properties +#+cindex: properties, column view Setting up a column view first requires defining the columns. This is done by defining a column format line. @@ -5028,7 +5021,7 @@ done by defining a column format line. To define a column format for an entire file, use a line like: -{{{cindex(#+COLUMNS)}}} +#+cindex: #+COLUMNS #+begin_example ,#+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO #+end_example @@ -5159,8 +5152,8 @@ The following commands turn column view on or off: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x C-c)}}}, ~org-columns~ :: - {{{kindex(C-c C-x C-c)}}} - {{{vindex(org-columns-default-format)}}} + #+kindex: C-c C-x C-c + #+vindex: org-columns-default-format Turn on column view. If the cursor is before the first headline in the file, column view is turned on for the entire file, using the @@ -5174,18 +5167,18 @@ The following commands turn column view on or off: current entry and its subtree. - {{{kbd(r)}}}, ~org-columns-redo~ :: - {{{kindex(r)}}} + #+kindex: r Recreate the column view, to include recent changes made in the buffer. - {{{kbd(g)}}}, ~org-columns-redo~ :: - {{{kindex(g)}}} + #+kindex: g Same as {{{kbd(r)}}}. - {{{kbd(q)}}}, ~org-columns-quit~ :: - {{{kindex(q)}}} + #+kindex: q Exit column view. @@ -5197,25 +5190,25 @@ The following commands let you edit information in column view: Move through the column view from field to field. - {{{kbdkey(S-,left)}}} {{{kbdkey(S-,right)}}} :: - {{{kindex(S-@key{left})}}} - {{{kindex(S-@key{right})}}} + {{{kindex: S-@k#+left} + {{{kindex: S-@k#+right} Switch to the next/previous allowed value of the field. For this, you have to have specified allowed values for a property. - {{{kbd(1..9,0)}}} :: - {{{kindex(1..9,0)}}} + #+kindex: 1..9,0 Directly select the Nth allowed value, {{{kbd(0)}}} selects the 10th value. - {{{kbd(n)}}} {{{kbd(p)}}}, ~org-columns-next-allowed-value~ ~org-columns-previous-allowed-value~ :: - {{{kindex(n)}}} + #+kindex: n Same as {{{kbdkey(S-,left)}}} {{{kbdkey(S-,right)}}} - {{{kbd(e)}}}, ~org-columns-edit-value~ :: - {{{kindex(e)}}} + #+kindex: e Edit the property at point. For the special properties, this will invoke the same interface that you normally use to change that @@ -5223,18 +5216,18 @@ The following commands let you edit information in column view: completion or fast selection interface will pop up. - {{{kbd(C-c C-c)}}}, ~org-columns-set-tags-or-toggle~ :: - {{{kindex(C-c C-c)}}} + #+kindex: C-c C-c When there is a checkbox at point, toggle it. - {{{kbd(v)}}}, ~org-columns-show-value~ :: - {{{kindex(v)}}} + #+kindex: v 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)}}} + #+kindex: a 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 @@ -5246,17 +5239,17 @@ The following commands modify column view on-the-fly: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(<)}}} {{{kbd(>)}}}, ~org-columns-narrow~ ~org-columns-widen~ :: - {{{kindex(<)}}} + #+kindex: < Make the column narrower/wider by one character. - {{{kbdkey(S-M-,right)}}}, ~org-columns-new~ :: - {{{kindex(S-M-@key{right})}}} + {{{kindex: S-M-@k#+right} Insert a new column, to the left of the current column. - {{{kbdkey(S-M-,left)}}}, ~org-columns-delete~ :: - {{{kindex(S-M-@key{left})}}} + {{{kindex: S-M-@k#+left} Delete the current column. @@ -5270,7 +5263,7 @@ exported or printed directly. If you want to capture a column view, use a ~columnview~ dynamic block (see [[Dynamic blocks]]). The frame of this block looks like this: -{{{cindex(#+BEGIN\\\, columnview)}}} +#+cindex: #+BEGIN, columnview #+begin_example ,* The column view ,#+BEGIN: columnview :hlines 1 :id "label" @@ -5288,7 +5281,7 @@ this block looks like this: at a different location in the file. To identify the tree whose view to capture, you can use 4 values: - {{{cindex(property\\\, ID)}}} + #+cindex: property, ID #+attr_texinfo: :columns "0.35 0.65" | Value | Meaning | |---------------------+---------------------------------------------------------------| @@ -5345,19 +5338,19 @@ block: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x i)}}}, ~org-insert-columns-dblock~ :: - {{{kindex(C-c C-x i)}}} + #+kindex: C-c C-x i Insert a dynamic block capturing a column view. You will be prompted 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-c Update dynamic block at point. The cursor 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)}}} + #+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 @@ -5380,8 +5373,8 @@ or a dynamic block. :PROPERTIES: :DESCRIPTION: Properties for Lisp programmers :END: -{{{cindex(properties\\\, API)}}} -{{{cindex(API\\\, for properties)}}} +#+cindex: properties, API +#+cindex: API, for properties There is a full API for accessing and changing properties. This API can be used by Emacs Lisp programs to work with properties and to @@ -5393,10 +5386,10 @@ property API]]. :DESCRIPTION: Making items useful for planning :OPTIONAL_TITLE: Dates and Times :END: -{{{cindex(dates)}}} -{{{cindex(times)}}} -{{{cindex(timestamp)}}} -{{{cindex(date stamp)}}} +#+cindex: dates +#+cindex: times +#+cindex: timestamp +#+cindex: date stamp To assist project planning, TODO items can be labeled with a date and/or a time. The specially formatted string carrying the date and time @@ -5410,11 +5403,11 @@ is used in a much wider sense. :DESCRIPTION: Assigning a time to a tree entry :TITLE: Timestamps, deadlines, and scheduling :END: -{{{cindex(timestamps)}}} -{{{cindex(ranges\\\, time)}}} -{{{cindex(date stamps)}}} -{{{cindex(deadlines)}}} -{{{cindex(scheduling)}}} +#+cindex: timestamps +#+cindex: ranges, time +#+cindex: date stamps +#+cindex: deadlines +#+cindex: scheduling A timestamp is a specification of a date (possibly with a time or a range of times) in a special format, either ~<2003-09-16 Tue>~ or @@ -5425,8 +5418,8 @@ the agenda (see [[Weekly/daily agenda]]). We distinguish: #+attr_texinfo: :table-type "table" :indic "@asis" - Plain timestamp; Event; Appointment :: - {{{cindex(timestamp)}}} - {{{cindex(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 @@ -5441,7 +5434,7 @@ the agenda (see [[Weekly/daily agenda]]). We distinguish: #+end_example - Timestamp with repeater interval :: - {{{cindex(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 @@ -5465,8 +5458,8 @@ the agenda (see [[Weekly/daily agenda]]). We distinguish: #+end_example - Time/Date range :: - {{{cindex(timerange)}}} - {{{cindex(date range)}}} + #+cindex: timerange + #+cindex: date range Two timestamps connected by {{{samp(--)}}} denote a range. The headline will be shown on the first and last day of the range, and on any dates @@ -5478,8 +5471,8 @@ the agenda (see [[Weekly/daily agenda]]). We distinguish: #+end_example - Inactive timestamp :: - {{{cindex(timestamp\\\, inactive)}}} - {{{cindex(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 @@ -5500,7 +5493,7 @@ format. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c .)}}}, ~org-time-stamp~ :: - {{{kindex(C-c .)}}} + #+kindex: C-c . Prompt for a date and insert a corresponding timestamp. When the cursor is at an existing timestamp in the buffer, the command is used @@ -5508,16 +5501,16 @@ format. command is used twice in succession, a time range is inserted. - {{{kbd(C-c !)}}}, ~org-time-stamp-inactive~ :: - {{{kindex(C-c !)}}} + #+kindex: C-c ! Like {{{kbd(C-c .)}}}, but insert an inactive timestamp that will not cause an agenda entry. - {{{kbd(C-u C-c .)}}} {{{kbd(C-u C-c !)}}} - {{{kindex(C-u C-c .)}}} - {{{kindex(C-u C-c .)}}} - {{{kindex(C-u C-c !)}}} - {{{vindex(org-time-stamp-rounding-minutes)}}} + #+kindex: C-u C-c . + #+kindex: C-u C-c . + #+kindex: C-u C-c ! + #+vindex: org-time-stamp-rounding-minutes Like {{{kbd(C-c .)}}} and {{{kbd(C-c !)}}}, but use the alternative format which contains date and time. The default time can be rounded @@ -5525,35 +5518,35 @@ format. ~org-time-stamp-rounding-minutes~. - {{{kbd(C-c C-c)}}} :: - {{{kindex(C-c C-c)}}} + #+kindex: C-c C-c Normalize timestamp, insert/fix day name if missing or wrong. - {{{kbd(C-c <)}}}, ~org-date-from-calendar~ :: - {{{kindex(C-c <)}}} + #+kindex: C-c < Insert a timestamp corresponding to the cursor date in the Calendar. - {{{kbd(C-c >)}}}, ~org-goto-calendar~ :: - {{{kindex(C-c >)}}} + #+kindex: C-c > 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)}}} + #+kindex: C-c C-o Access the agenda for the date given by the timestamp or -range at point (see [[Weekly/daily agenda]]). - {{{kbdkey(S-,left)}}} {{{kbdkey(S-,right)}}}, ~org-timestamp-down-day~ ~org-timestamp-up-day~ :: - {{{kindex(S-@key{left})}}} + #+kindex: S-@key{left} Change date at cursor by one day. These key bindings conflict with shift-selection and related modes (see [[Conflicts]]). - {{{kbdkey(S-,up)}}} {{{kbdkey(S-,down)}}}, ~org-timestamp-up~ ~org-timestamp-down-down~ :: - {{{kindex(S-@key{up})}}} + #+kindex: S-@key{up} Change the item under the cursor in a timestamp. The cursor can be on a year, month, day, hour or minute. When the timestamp contains a time @@ -5565,8 +5558,8 @@ format. with shift-selection and related modes (see [[Conflicts]]). - {{{kbd(C-c C-y)}}}, ~org-evaluate-time-range~ :: - {{{kindex(C-c C-y)}}} - {{{cindex(evaluate time range)}}} + #+kindex: C-c C-y + #+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 @@ -5576,10 +5569,10 @@ format. :PROPERTIES: :DESCRIPTION: How Org mode helps you enter dates and times :END: -{{{cindex(date\\\, reading in minibuffer)}}} -{{{cindex(time\\\, reading in minibuffer)}}} +#+cindex: date, reading in minibuffer +#+cindex: time, reading in minibuffer -{{{vindex(org-read-date-prefer-future)}}} +#+vindex: org-read-date-prefer-future When Org mode prompts for a date/time, the default is shown in default date/time format, and the prompt therefore seems to ask for a specific @@ -5637,14 +5630,14 @@ the Nth such day, e.g.: | +2tue | {{{result}}} second Tuesday from now | -{{{vindex(parse-time-months)}}} -{{{vindex(parse-time-weekdays)}}} +#+vindex: parse-time-months +#+vindex: parse-time-weekdays The function understands English month and weekday abbreviations. If you want to use unabbreviated names and/or other languages, configure the variables ~parse-time-months~ and ~parse-time-weekdays~. -{{{vindex(org-read-date-force-compatible-dates)}}} +#+vindex: org-read-date-force-compatible-dates Not all dates can be represented in a given Emacs implementation. By default Org mode forces dates into the compatibility range 1970--2037 @@ -5663,8 +5656,8 @@ separator in the latter case, e.g.: | 11am--1:15pm | {{{result}}} same as above | | 11am+2:15 | {{{result}}} same as above | -{{{cindex(calendar\\\, for selecting date)}}} -{{{vindex(org-popup-calendar-for-date-prompt)}}} +#+cindex: calendar, for selecting date +#+vindex: org-popup-calendar-for-date-prompt Parallel to the minibuffer prompt, a calendar is popped up.[fn:63] When you exit the date prompt, either by clicking on a date in the @@ -5672,18 +5665,18 @@ calendar, or by pressing {{{key(RET)}}}, the date selected in the calendar will be combined with the information entered at the prompt. You can control the calendar fully from the minibuffer: -{{{kindex(<)}}} -{{{kindex(>)}}} -{{{kindex(M-v)}}} -{{{kindex(C-v)}}} -{{{kindex(mouse-1)}}} -{{{kindex(S-@key{right})}}} -{{{kindex(S-@key{left})}}} -{{{kindex(S-@key{down})}}} -{{{kindex(S-@key{up})}}} -{{{kindex(M-S-@key{right})}}} -{{{kindex(M-S-@key{left})}}} -{{{kindex(@key{RET})}}} +#+kindex: < +#+kindex: > +#+kindex: M-v +#+kindex: C-v +#+kindex: mouse-1 +#+kindex: S-@key{right} +#+kindex: S-@key{left} +#+kindex: S-@key{down} +#+kindex: S-@key{up} +#+kindex: M-S-@key{right} +#+kindex: M-S-@key{left} +#+kindex: @key{RET} #+attr_texinfo: :columns "0.3 0.7" | Key binding | Meaning | @@ -5702,7 +5695,7 @@ You can control the calendar fully from the minibuffer: | {{{kbd(C-v)}}} | Scroll calendar backward by 3 months. | -{{{vindex(org-read-date-display-live)}}} +#+vindex: org-read-date-display-live The actions of the date/time prompt may seem complex, but I assure you they will grow on you, and you will start getting annoyed by pretty much any other @@ -5714,12 +5707,12 @@ minibuffer.[fn:64] :PROPERTIES: :DESCRIPTION: Making dates look different :END: -{{{cindex(custom date/time format)}}} -{{{cindex(time format\\\, custom)}}} -{{{cindex(date format\\\, custom)}}} +#+cindex: custom date/time format +#+cindex: time format, custom +#+cindex: date format, custom -{{{vindex(org-display-custom-times)}}} -{{{vindex(org-time-stamp-custom-formats)}}} +#+vindex: org-display-custom-times +#+vindex: org-time-stamp-custom-formats Org mode uses the standard ISO notation for dates and times as it is defined in ISO 8601. If you cannot get used to this and require @@ -5729,7 +5722,7 @@ it by customizing the variables ~org-display-custom-times~ and #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x C-t)}}}, ~org-toggle-time-stamp-overlays~ :: - {{{kindex(C-c C-x C-t)}}} + #+kindex: C-c C-x C-t Toggle the display of custom formats for dates and times. @@ -5771,12 +5764,12 @@ A timestamp may be preceded by special keywords to facilitate planning: #+attr_texinfo: :table-type "table" :indic "@asis" - ~DEADLINE~ :: - {{{cindex(DEADLINE keyword)}}} + #+cindex: DEADLINE keyword Meaning: the task (most likely a TODO item, though not necessarily) is supposed to be finished on that date. - {{{vindex(org-deadline-warning-days)}}} + #+vindex: org-deadline-warning-days On the deadline date, the task will be listed in the agenda. In addition, the agenda for /today/ will carry a warning about the @@ -5795,12 +5788,12 @@ A timestamp may be preceded by special keywords to facilitate planning: warning period of 5 days ~DEADLINE: <2004-02-29 Sun -5d>~. - ~SCHEDULED~ :: - {{{cindex(SCHEDULED keyword)}}} + #+cindex: SCHEDULED keyword Meaning: you are planning to start working on that task on the given date. - {{{vindex(org-agenda-skip-scheduled-if-done)}}} + #+vindex: org-agenda-skip-scheduled-if-done The headline will be listed under the given date.[fn:65] In addition, a reminder that the scheduled date has passed will be present in the @@ -5845,7 +5838,7 @@ an item:[fn:66] #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-d)}}}, ~org-deadline~ :: - {{{kindex(C-c C-d)}}} + #+kindex: C-c C-d Insert {{{samp(DEADLINE)}}} keyword along with a stamp. The insertion will happen in the line directly following the headline. Any CLOSED @@ -5855,7 +5848,7 @@ an item:[fn:66] deadline.[fn:67] - {{{kbd(C-c C-s)}}}, ~org-schedule~ :: - {{{kindex(C-c C-s)}}} + #+kindex: C-c C-s Insert {{{samp(SCHEDULED)}}} keyword along with a stamp. The insertion will happen in the line directly following the headline. Any @@ -5865,9 +5858,9 @@ an item:[fn:66] 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)}}} + #+kindex: C-c C-x C-k + #+kindex: k a + #+kindex: k s 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 @@ -5875,9 +5868,9 @@ an item:[fn:66] {{{kbd(k s)}}} or {{{kbd(k d)}}} to schedule the marked item. - {{{kbd(C-c / d)}}}, ~org-check-deadlines~ :: - {{{kindex(C-c / d)}}} - {{{cindex(sparse tree\\\, for deadlines)}}} - {{{vindex(org-deadline-warning-days)}}} + #+kindex: C-c / d + #+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 @@ -5886,12 +5879,12 @@ an item:[fn:66] shows all deadlines due tomorrow. - {{{kbd(C-c / b)}}}, ~org-check-before-date~ :: - {{{kindex(C-c / b)}}} + #+kindex: C-c / b Sparse tree for deadlines and scheduled items before a given date. - {{{kbd(C-c / a)}}}, ~org-check-after-date~ :: - {{{kindex(C-c / a)}}} + #+kindex: C-c / a Sparse tree for deadlines and scheduled items after a given date. @@ -5905,8 +5898,8 @@ before any current timestamp. :PROPERTIES: :DESCRIPTION: Items that show up again and again :END: -{{{cindex(tasks\\\, repeated)}}} -{{{cindex(repeated tasks)}}} +#+cindex: tasks, repeated +#+cindex: repeated tasks Some tasks need to be repeated again and again. Org mode helps to organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED, @@ -5925,7 +5918,7 @@ letters. If you need both a repeater and a special warning period in a deadline entry, the repeater should come first and the warning period last: ~DEADLINE: <2005-10-01 Sat +1m -3d>~. -{{{vindex(org-todo-repeat-to-state)}}} +#+vindex: org-todo-repeat-to-state Deadlines and scheduled items produce entries in the agenda when they are over-due, so it is important to be able to mark such an entry as @@ -5944,7 +5937,7 @@ state to DONE would actually switch the date like this: DEADLINE: <2005-11-01 Tue +1m> #+end_example -{{{vindex(org-log-repeat)}}} +#+vindex: org-log-repeat A timestamp will be added under the deadline, to keep a record that you actually acted on the previous instance of this deadline.[fn:70] @@ -5989,8 +5982,8 @@ a task subtree, with dates shifted in each copy. The command :PROPERTIES: :DESCRIPTION: Tracking how long you spend on a task :END: -{{{cindex(clocking time)}}} -{{{cindex(time clocking)}}} +#+cindex: clocking time +#+cindex: time clocking Org mode allows you to clock the time you spend on specific tasks in a project. When you start working on an item, you can start the clock. When @@ -6020,10 +6013,10 @@ about what to do with it.[fn:72] #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x C-i)}}}, ~org-clock-in~ :: - {{{kindex(C-c C-x C-i)}}} - {{{vindex(org-clock-into-drawer)}}} - {{{vindex(org-clock-continuously)}}} - {{{cindex(property\\\, LOG_INTO_DRAWER)}}} + #+kindex: C-c C-x C-i + #+vindex: org-clock-into-drawer + #+vindex: org-clock-continuously + #+cindex: property, LOG_INTO_DRAWER 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 @@ -6039,9 +6032,9 @@ about what to do with it.[fn:72] prefixes, force continuous clocking by starting the clock when the last clock stopped.@* - {{{cindex(property: CLOCK_MODELINE_TOTAL)}}} - {{{cindex(property: LAST_REPEAT)}}} - {{{vindex(org-clock-modeline-total)}}} + #+cindex: property: CLOCK_MODELINE_TOTAL + #+cindex: property: LAST_REPEAT + #+vindex: org-clock-modeline-total While the clock is running, the current clocking time is shown in the mode line, along with the title of the task. The clock time shown will @@ -6058,8 +6051,8 @@ about what to do with it.[fn:72] onto the mode line entry will pop up a menu with clocking options. - {{{kbd(C-c C-x C-o)}}}, ~org-clock-out~ :: - {{{kindex(C-c C-x C-o)}}} - {{{vindex(org-log-note-clock-out)}}} + #+kindex: C-c C-x C-o + #+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 @@ -6069,8 +6062,8 @@ about what to do with it.[fn:72] timestamp.[fn:76] - {{{kbd(C-c C-x C-x)}}}, ~org-clock-in-last~ :: - {{{kindex(C-c C-x C-x)}}} - {{{vindex(org-clock-continuously)}}} + #+kindex: C-c C-x C-x + #+vindex: org-clock-continuously Reclock the last clocked task. With one {{{kbd(C-u)}}} prefix argument, select the task from the clock history. With two @@ -6078,26 +6071,26 @@ about what to do with it.[fn:72] 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)}}} + #+kindex: C-c C-x C-e Update the effort estimate for the current clock task. - {{{kbd(C-c C-c)}}} {{{kbd(C-c C-y)}}}, ~org-evaluate-time-range~ :: - {{{kindex(C-c C-c)}}} - {{{kindex(C-c C-y)}}} - {{{kindex(C-c C-c)}}} + #+kindex: C-c C-c + #+kindex: C-c C-y + #+kindex: C-c C-c 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 {{{kbdkey(S-,cursor)}}} keys, the update is automatic. - {{{kbdkey(C-S-,up)}}} {{{kbdkey(C-S-,down)}}}, ~org-clock-timestamps-up/down~ :: - {{{kindex(C-S-@key{up/down})}}} + #+kindex: C-S-@key{up/down} On ~CLOCK~ log lines, increase/decrease both timestamps so that the clock duration keeps the same. - {{{kbdkey(S-M-,up)}}} {{{kbdkey(S-M-,down)}}}, ~org-timestamp-up/down~ :: - {{{kindex(S-M-@key{up/down})}}} + #+kindex: S-M-@key{up/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 @@ -6106,27 +6099,27 @@ about what to do with it.[fn:72] of the next clock will be increased by five minutes. - {{{kbd(C-c C-t)}}}, ~org-todo~ :: - {{{kindex(C-c C-t)}}} + #+kindex: C-c C-t 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)}}} + #+kindex: C-c C-x C-q 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)}}} + #+kindex: C-c C-x C-j Jump to the headline of the currently clocked in task. With a {{{kbd(C-u)}}} prefix arg, 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)}}} - {{{vindex(org-remove-highlights-with-change)}}} + #+kindex: C-c C-x C-d + #+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 @@ -6148,8 +6141,8 @@ disposition. :PROPERTIES: :DESCRIPTION: Detailed reports :END: -{{{cindex(clocktable\\\, dynamic block)}}} -{{{cindex(report\\\, of clocked time)}}} +#+cindex: clocktable, dynamic block +#+cindex: report, of clocked time Org mode can produce quite complex reports based on the time clocking information. Such a report is called a /clock table/, because it is @@ -6157,7 +6150,7 @@ formatted as one or several Org tables. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x C-r)}}}, ~org-clock-report~ :: - {{{kindex(C-c C-x C-r)}}} + #+kindex: C-c C-x C-r Insert a dynamic block (see [[Dynamic blocks]]) containing a clock report as an Org mode table into the current file. When the cursor is at an @@ -6167,13 +6160,13 @@ formatted as one or several Org tables. tag. - {{{kbd(C-c C-c)}}} {{{kbd(C-c C-x C-u)}}}, ~org-dblock-update~ :: - {{{kindex(C-c C-c)}}} + #+kindex: C-c C-c Update dynamic block at point. The cursor 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)}}} + #+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. @@ -6188,13 +6181,13 @@ formatted as one or several Org tables. 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: -{{{cindex(#+BEGIN\\\, clocktable)}}} +#+cindex: #+BEGIN, clocktable #+begin_example ,#+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file ,#+END: clocktable #+end_example {{{noindent}}} -{{{vindex(org-clocktable-defaults)}}} +#+vindex: org-clocktable-defaults The {{{samp(BEGIN)}}} line and specify a number of options to define the scope, structure, and formatting of the report. Defaults for all these options can be configured in the variable ~org-clocktable-defaults~. @@ -6371,15 +6364,15 @@ last week would be: :TITLE: Resolving idle time and continuous clocking :END: -{{{cindex(resolve idle time)}}} -{{{cindex(idle\\\, resolve\\\, dangling)}}} +#+cindex: resolve idle time +#+cindex: idle, resolve, dangling If you clock in on a work item, and then walk away from your computer---perhaps to take a phone call---you often need to ``resolve'' the time you were away by either subtracting it from the current clock, or applying it to another one. -{{{vindex(org-clock-idle-time)}}} +#+vindex: org-clock-idle-time By customizing the variable ~org-clock-idle-time~ to some integer, such as 10 or 15, Emacs can alert you when you get back to your @@ -6391,7 +6384,7 @@ choices to correct the discrepancy: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(k)}}} :: - {{{kindex(k)}}} + #+kindex: k To keep some or all of the minutes and stay clocked in, press {{{kbd(k)}}}. Org will ask how many of the minutes to keep. Press @@ -6399,7 +6392,7 @@ choices to correct the discrepancy: enter a number to keep that many minutes. - {{{kbd(K)}}} :: - {{{kindex(K)}}} + #+kindex: K If you use the shift key and press {{{kbd(K)}}}, it will keep however many minutes you request and then immediately clock out of that task. @@ -6407,14 +6400,14 @@ choices to correct the discrepancy: of the current task. - {{{kbd(s)}}} :: - {{{kindex(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. - {{{kbd(S)}}} :: - {{{kindex(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 @@ -6422,7 +6415,7 @@ choices to correct the discrepancy: you choose. - {{{kbd(C)}}} :: - {{{kindex(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 @@ -6456,8 +6449,8 @@ dangling clocks at any time using {{{kbd(M-x org-resolve-clocks RET)}}} (or {{{kbd(C-c C-x C-z)}}}). *** Continuous clocking -{{{cindex(continuous clocking)}}} -{{{vindex(org-clock-continuously)}}} +#+cindex: continuous clocking +#+vindex: org-clock-continuously You may want to start clocking from the time when you clocked out the previous task. To enable this systematically, set @@ -6473,9 +6466,9 @@ arguments with ~org-clock-in~ and two {{{kbd(C-u C-u)}}} with :PROPERTIES: :DESCRIPTION: Planning work effort in advance :END: -{{{cindex(effort estimates)}}} -{{{cindex(property\\\, Effort)}}} -{{{vindex(org-effort-property)}}} +#+cindex: effort estimates +#+cindex: property, Effort +#+vindex: org-effort-property If you want to plan your work in a very detailed way, or if you need to produce offers with quotations of the estimated work effort, you @@ -6488,14 +6481,14 @@ the following commands: #+attr_texinfo: :table-type "table" :indic "@kbd" - {{{kbd(C-c C-x e)}}}, ~org-set-effort~ :: - {{{kindex(C-c C-x e)}}} + #+kindex: C-c C-x e Set the effort estimate for the current entry. With a numeric prefix argument, set it to the Nth 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)}}} + #+kindex: C-c C-x C-e Modify the effort estimate of the item currently being clocked. @@ -6511,8 +6504,8 @@ a specific buffer you can use: ,#+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort){:} %CLOCKSUM #+end_example -{{{vindex(org-global-properties)}}} -{{{vindex(org-columns-default-format)}}} +#+vindex: org-global-properties +#+vindex: org-columns-default-format {{{noindent}}} or, even better, you can set up these values globally by customizing the variables ~org-global-properties~ and @@ -6525,7 +6518,7 @@ column mode, and to use {{{kbdkey(S-,right)}}} and immediately be summed up in the hierarchy. In the column next to it, any clocked time will be displayed. -{{{vindex(org-agenda-columns-add-appointments-to-effort-sum)}}} +#+vindex: org-agenda-columns-add-appointments-to-effort-sum If you switch to column view in the daily/weekly agenda, the effort column will summarize the estimated work effort for each day, and you can use this to find space in your schedule. To get @@ -6545,7 +6538,7 @@ available time slot. :DESCRIPTION: Notes with a running timer :TITLE: Taking notes with a relative timer :END: -{{{cindex(relative timer)}}} +#+cindex: relative timer When taking notes during, for example, a meeting or a video viewing, it can be useful to have access to times relative to a starting time. Org provides @@ -6553,41 +6546,41 @@ such a relative timer and make it easy to create timed notes. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x .)}}}, ~org-timer~ :: - {{{kindex(C-c C-x .)}}} + #+kindex: C-c C-x . Insert a relative time into the buffer. The first time you use this, the timer will be started. When called with a prefix argument, the timer is restarted. - {{{kbd(C-c C-x -)}}}, ~org-timer-item~ :: - {{{kindex(C-c C-x -)}}} + #+kindex: C-c C-x - Insert a description list item with the current relative time. With a prefix argument, first reset the timer to 0. - {{{kbdkey(M-,RET)}}}, ~org-insert-heading~ :: - {{{kindex(M-@key{RET})}}} + #+kindex: M-@key{RET} Once the timer list is started, you can also use {{{kbdkey(M-,RET)}}} to insert new timer items. - {{{kbd(C-c C-x ,)}}} :: - {{{kindex(C-c C-x ,)}}} - {{{kindex(C-c C-x ,)}}} + #+kindex: C-c C-x , + #+kindex: C-c C-x , Pause the timer, or continue it if it is already paused ({{{command(org-timer-pause-or-continue)}}}). - {{{kbd(C-u C-c C-x ,)}}} :: - {{{kindex(C-u C-c C-x ,)}}} - {{{kindex(C-u C-c C-x ,)}}} + #+kindex: C-u C-c C-x , + #+kindex: C-u C-c C-x , 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. - {{{kbd(C-c C-x 0)}}}, ~org-timer-start~ :: - {{{kindex(C-c C-x 0)}}} + #+kindex: C-c C-x 0 Reset the timer without inserting anything into the buffer. By default, the timer is reset to 0. When called with a {{{kbd(C-u)}}} @@ -6603,9 +6596,9 @@ such a relative timer and make it easy to create timed notes. :PROPERTIES: :DESCRIPTION: Starting a countdown timer for a task :END: -{{{cindex(Countdown timer)}}} -{{{kindex(C-c C-x ;)}}} -{{{kindex(;)}}} +#+cindex: Countdown timer +#+kindex: C-c C-x ; +#+kindex: ; Calling ~org-timer-set-timer~ from an Org mode buffer runs a countdown timer. Use {{{kbd(;)}}} from agenda buffers, {{{key(C-c C-x ;)}}} @@ -6620,7 +6613,7 @@ default value. :PROPERTIES: :DESCRIPTION: The ins and outs for projects :END: -{{{cindex(capture)}}} +#+cindex: capture An important part of any organization system is the ability to quickly capture new ideas and tasks, and to associate reference material with @@ -6634,7 +6627,7 @@ and fast. :PROPERTIES: :DESCRIPTION: Capturing new stuff :END: -{{{cindex(capture)}}} +#+cindex: capture Org's method for capturing new items is heavily inspired by John Wiegley excellent remember package. Up to version 6.36 Org used a @@ -6664,7 +6657,7 @@ does enhance it with templates and more. The following customization sets a default target file for notes, and defines a global key for capturing new material.[fn:81] -{{{vindex(org-default-notes-file)}}} +#+vindex: org-default-notes-file #+header: :eval no #+header: :exports code #+begin_src emacs-lisp @@ -6679,8 +6672,8 @@ a global key for capturing new material.[fn:81] #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c c)}}}, ~org-capture~ :: - {{{kindex(C-c c)}}} - {{{cindex(date tree)}}} + #+kindex: C-c c + #+cindex: date tree Call the command ~org-capture~. Note that this keybinding is global and not active by default - you need to install it. If you have @@ -6691,7 +6684,7 @@ a global key for capturing new material.[fn:81] the information you want. - {{{kbd(C-c C-c)}}}, ~org-capture-finalize~ :: - {{{kindex(C-c C-c)}}} + #+kindex: C-c C-c Once you have finished entering information into the capture buffer, {{{kbd(C-c C-c)}}} will return you to the window configuration before @@ -6700,7 +6693,7 @@ a global key for capturing new material.[fn:81] jump to the captured item. - {{{kbd(C-c C-w)}}}, ~org-capture-refile~ :: - {{{kindex(C-c C-w)}}} + #+kindex: C-c C-w Finalize the capture process by refiling the note to a different place (see [[Refile and copy]]). Please realize that this is a normal refiling @@ -6711,7 +6704,7 @@ a global key for capturing new material.[fn:81] ~org-refile~ command. - {{{kbd(C-c C-k)}}}, ~org-capture-kill~ :: - {{{kindex(C-c C-k)}}} + #+kindex: C-c C-k Abort the capture process and return to the previous state. @@ -6726,19 +6719,19 @@ prefix commands: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-u C-c c)}}} :: - {{{kindex(C-u C-c c)}}} + #+kindex: C-u C-c c Visit the target location of a capture template. You get to select the template in the usual way. - {{{kbd(C-u C-u C-c c)}}} :: - {{{kindex(C-u C-u C-c c)}}} + #+kindex: C-u C-u C-c c Visit the last stored capture item in its buffer. -{{{vindex(org-capture-bookmark)}}} -{{{cindex(org-capture-last-stored)}}} +#+vindex: org-capture-bookmark +#+cindex: org-capture-last-stored You can also jump to the bookmark ~org-capture-last-stored~, which will automatically be created unless you set ~org-capture-bookmark~ to @@ -6751,7 +6744,7 @@ with a ~C-0~ prefix argument. :PROPERTIES: :DESCRIPTION: Define the outline of different note types :END: -{{{cindex(templates\\\, for Capture)}}} +#+cindex: templates, for Capture You can use templates for different types of capture items, and for different target locations. The easiest way to create such templates @@ -6759,7 +6752,7 @@ is through the customize interface. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c c C)}}} :: - {{{kindex(C-c c C)}}} + #+kindex: C-c c C Customize the variable ~org-capture-templates~. @@ -6870,7 +6863,7 @@ Now lets look at the elements of a template definition. Each entry in Text to be inserted as it is. - target :: - {{{vindex(org-default-notes-file)}}} + #+vindex: org-default-notes-file Specification of where the captured item should be placed. In Org mode files, targets usually define a node. Entries will become children of this @@ -7114,7 +7107,7 @@ here: {{{noindent}}} For specific link types, the following keywords will be defined:[fn:83] -{{{vindex(org-from-is-user-regexp)}}} +#+vindex: org-from-is-user-regexp #+attr_texinfo: :table-type "table" :indic "@asis" @@ -7144,7 +7137,7 @@ defined:[fn:83] :DESCRIPTION: Only show a template in a specific context :END: -{{{vindex(org-capture-templates-contexts)}}} +#+vindex: org-capture-templates-contexts To control whether a capture template should be accessible from a specific context, you can customize ~org-capture-templates-contexts~. @@ -7176,8 +7169,8 @@ more information. :PROPERTIES: :DESCRIPTION: Add files to tasks :END: -{{{cindex(attachments)}}} -{{{vindex(org-attach-directory)}}} +#+cindex: attachments +#+vindex: org-attach-directory It is often useful to associate reference material with an outline node/task. Small chunks of plain text can simply be stored in the @@ -7201,15 +7194,15 @@ subtree uses the same attached directory. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-a)}}}, ~org-attach~ :: - {{{kindex(C-c C-a)}}} + #+kindex: C-c C-a 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)}}} - {{{vindex(org-attach-method)}}} + #+kindex: C-c C-a a + #+vindex: org-attach-method Select a file and move it into the task's attachment directory. The file will be copied, moved, or linked, depending on @@ -7217,27 +7210,27 @@ subtree uses the same attached directory. 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)}}} + #+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(n)}}}, ~org-attach-new~ :: - {{{kindex(C-c C-a n)}}} + #+kindex: C-c C-a n Create a new attachment as an Emacs buffer. - {{{kbd(z)}}}, ~org-attach-sync~ :: - {{{kindex(C-c C-a z)}}} + #+kindex: C-c C-a z 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)}}} - {{{vindex(org-file-apps)}}} + #+kindex: C-c C-a o + #+vindex: org-file-apps Open current task's attachment. If there is more than one, prompt for a file name first. Opening will follow the rules set by @@ -7245,41 +7238,41 @@ subtree uses the same attached directory. hyperlinks (see [[Handling links]]). - {{{kbd(O)}}}, ~org-attach-open-in-emacs~ :: - {{{kindex(C-c C-a O)}}} + #+kindex: C-c C-a O Also open the attachment, but force opening the file in Emacs. - {{{kbd(f)}}}, ~org-attach-reveal~ :: - {{{kindex(C-c C-a f)}}} + #+kindex: C-c C-a f Open the current task's attachment directory. - {{{kbd(F)}}}, ~org-attach-reveal-in-emacs~ :: - {{{kindex(C-c C-a F)}}} + #+kindex: C-c C-a F Also open the directory, but force using @command{dired} in Emacs. - {{{kbd(d)}}}, ~org-attach-delete-one~ :: - {{{kindex(C-c C-a d)}}} + #+kindex: C-c C-a d Select and delete a single attachment. - {{{kbd(D)}}}, ~org-attach-delete-all~ :: - {{{kindex(C-c C-a D)}}} + #+kindex: C-c C-a D Delete all of a task's attachments. A safer way is to open the directory in {{{command(dired)}}} and delete from there. - {{{kbd(s)}}}, ~org-attach-set-directory~ :: - {{{kindex(C-c C-a s)}}} - {{{cindex(property\\\, ATTACH_DIR)}}} + #+kindex: C-c C-a s + #+cindex: property, ATTACH_DIR 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(property\\\, ATTACH_DIR_INHERIT)}}} + #+kindex: C-c C-a i + #+cindex: property, ATTACH_DIR_INHERIT Set the ~ATTACH_DIR_INHERIT~ property, so that children will use the same directory for attachments as the parent does. @@ -7288,8 +7281,8 @@ subtree uses the same attached directory. :PROPERTIES: :DESCRIPTION: Getting input from RSS feeds :END: -{{{cindex(RSS feeds)}}} -{{{cindex(Atom feeds)}}} +#+cindex: RSS feeds +#+cindex: Atom feeds Org can add and change entries based on information found in RSS feeds and Atom feeds. You could use this to make a task out of each new podcast in a @@ -7314,13 +7307,13 @@ whenever the following command is used: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x g)}}}, ~org-feed-update-all~ :: - {{{kindex(C-c C-x g)}}} + #+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)}}} + #+kindex: C-c C-x G Prompt for a feed name and go to the inbox configured for this feed. @@ -7344,8 +7337,8 @@ For more information, including how to read atom feeds, see :TITLE: Protocols for external access :END: -{{{cindex(protocols\\\, for external access)}}} -{{{cindex(emacsserver)}}} +#+cindex: protocols, for external access +#+cindex: emacsserver You can set up Org for handling protocol calls from outside applications that are passed to Emacs through the @@ -7361,8 +7354,8 @@ documentation and setup instructions. :PROPERTIES: :DESCRIPTION: Moving/copying a tree from one place to another :END: -{{{cindex(refiling notes)}}} -{{{cindex(copying notes)}}} +#+cindex: refiling notes +#+cindex: copying notes When reviewing the captured data, you may want to refile or to copy some of the entries into a different list, for example into a project. Cutting, @@ -7371,21 +7364,21 @@ simplify this process, you can use the following special command: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c M-w)}}}, ~org-copy~ :: - {{{kindex(C-c M-w)}}} - {{{findex(org-copy)}}} + #+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)}}} - {{{vindex(org-refile-use-cache)}}} + #+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 + #+vindex: org-refile-use-cache Refile the entry or region at point. This command offers possible locations for refiling the entry and lets you select one with @@ -7406,23 +7399,23 @@ simplify this process, you can use the following special command: an entry has been refiled.[fn:86] - {{{kbd(C-u C-c C-w)}}} :: - {{{kindex(C-u C-c C-w)}}} + #+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)}}} + #+kindex: C-u C-u C-c C-w 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)}}} + #+kindex: C-2 C-c C-w Refile as the child of the item currently being clocked. - {{{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)}}} + #+kindex: C-u C-u C-u C-c C-w + #+kindex: C-0 C-c C-w 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 @@ -7432,7 +7425,7 @@ simplify this process, you can use the following special command: :PROPERTIES: :DESCRIPTION: What to do with finished products :END: -{{{cindex(archiving)}}} +#+cindex: archiving When a project represented by a (sub)tree is finished, you may want to move the tree out of the way and to stop it from contributing to the @@ -7441,8 +7434,8 @@ global searches like the construction of agenda views fast. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x C-a)}}}, ~org-archive-subtree-default~ :: - {{{kindex(C-c C-x C-a)}}} - {{{vindex(org-archive-default-command)}}} + #+kindex: C-c C-x C-a + #+vindex: org-archive-default-command Archive the current entry using the command specified in the variable ~org-archive-default-command~. @@ -7452,22 +7445,22 @@ global searches like the construction of agenda views fast. :DESCRIPTION: Moving a tree to an archive file :TITLE: Moving a tree to an archive file :END: -{{{cindex(external archiving)}}} +#+cindex: external archiving The most common archiving action is to move a project tree to another file, the archive file. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{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 $)}}} - {{{vindex(org-archive-location)}}} + #+kindex: C-c C-x C-s + #+kindex: C-c $ + #+vindex: org-archive-location Archive the subtree starting at the cursor 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)}}} + #+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, each subtree is checked for open TODO @@ -7476,7 +7469,7 @@ the archive file. command is invoked, the level 1 trees will be checked. -{{{cindex(archive locations)}}} +#+cindex: archive locations The default archive location is a file in the same directory as the current file, with the name derived by appending {{{file(_archive)}}} @@ -7489,18 +7482,18 @@ the heading, see the documentation string of the variable There is also an in-buffer option for setting this variable, for example:[fn:87] -{{{cindex(#+ARCHIVE)}}} +#+cindex: #+ARCHIVE #+begin_example ,#+ARCHIVE: %s_done:: #+end_example -{{{cindex(property\\\, ARCHIVE)}}} +#+cindex: property, ARCHIVE {{{noindent}}} If you would like to have a special ARCHIVE location for a single entry or a (sub)tree, give the entry an ~:ARCHIVE:~ property with the location as the value (see [[Properties and columns]]). -{{{vindex(org-archive-save-context-info)}}} +#+vindex: org-archive-save-context-info When a subtree is moved, it receives a number of special properties that record context information like the file from where the entry @@ -7526,13 +7519,13 @@ its location in the outline tree, but behaves in the following way: ~org-cycle-open-archived-trees~. Also normal outline commands like ~show-all~ will open archived subtrees. - {{{vindex(org-cycle-open-archived-trees)}}} + #+vindex: org-cycle-open-archived-trees - During sparse tree construction (see [[Sparse trees]]), matches in archived subtrees are not exposed, unless you configure the option ~org-sparse-tree-open-archived-trees~. - {{{vindex(org-sparse-tree-open-archived-trees)}}} + #+vindex: org-sparse-tree-open-archived-trees - During agenda view construction (see [[Agenda views]]), the content of archived trees is ignored unless you configure the option @@ -7540,32 +7533,32 @@ its location in the outline tree, but behaves in the following way: always be included. In the agenda you can press {{{kbd(v a)}}} to get archives temporarily included. - {{{vindex(org-agenda-skip-archived-trees)}}} + #+vindex: org-agenda-skip-archived-trees - Archived trees are not exported (see [[Exporting]]), only the headline is. Configure the details using the variable ~org-export-with-archived-trees~. - {{{vindex(org-export-with-archived-trees)}}} + #+vindex: org-export-with-archived-trees - Archived trees are excluded from column view unless the variable ~org-columns-skip-archived-trees~ is configured to ~nil~. - {{{vindex(org-columns-skip-archived-trees)}}} + #+vindex: org-columns-skip-archived-trees The following commands help manage the ARCHIVE tag: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x a)}}}, ~org-toggle-archive-tag~ :: - {{{kindex(C-c C-x a)}}} + #+kindex: C-c C-x a 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)}}} + #+kindex: C-u C-c C-x a Check if any direct children of the current headline should be archived. To do this, each subtree is checked for open TODO entries. @@ -7578,7 +7571,7 @@ The following commands help manage the ARCHIVE tag: 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)}}} + #+kindex: C-c C-x A Move the current entry to the /Archive Sibling/. This is a sibling of the entry with the heading {{{samp(Archive)}}} and the tag @@ -7627,8 +7620,8 @@ in a separate buffer. Seven different view types are provided: visit the corresponding locations in the original Org files, and even to edit these files remotely. -{{{vindex(org-agenda-window-setup)}}} -{{{vindex(org-agenda-restore-windows-after-quit)}}} +#+vindex: org-agenda-window-setup +#+vindex: org-agenda-restore-windows-after-quit Two variables control how the agenda buffer is displayed and whether the window configuration is restored when the agenda exits: @@ -7638,9 +7631,9 @@ the window configuration is restored when the agenda exits: :PROPERTIES: :DESCRIPTION: Files being searched for agenda information :END: -{{{cindex(agenda files)}}} -{{{cindex(files for agenda)}}} -{{{vindex(org-agenda-files)}}} +#+cindex: agenda files +#+cindex: files for agenda +#+vindex: org-agenda-files The information to be shown is normally collected from all /agenda files/, the files listed in the variable ~org-agenda-files~.[fn:180] If @@ -7651,29 +7644,29 @@ Thus, even if you only work with a single Org file, that file should be put into the list.[fn:88] You can customize ~org-agenda-files~, but the easiest way to maintain it is through the following commands -{{{cindex(files\\\, adding to agenda list)}}} +#+cindex: files, adding to agenda list #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c [)}}}, ~org-agenda-file-to-front~ :: - {{{kindex(C-c [)}}} + #+kindex: C-c [ 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 ])}}} + #+kindex: C-c ] Remove current file from the list of agenda files. - {{{kbd(C-')}}} {{{kbd(C-)}}}, ~org-cycle-agenda-files~ :: - {{{kindex(C-')}}} - {{{kindex(C-,)}}} - {{{cindex(cycling\\\, of agenda files)}}} + #+kindex: C-' + #+kindex: C-, + #+cindex: cycling, of agenda files Cycle through agenda file list, visiting one file after the other. - {{{kbd(M-x org-iswitchb)}}} :: - {{{findex(org-iswitchb)}}} + #+findex: org-iswitchb Command to use an ~iswitchb~-like interface to switch to and between Org buffers. @@ -7691,7 +7684,7 @@ for an extended period, use the following commands: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x <)}}}, ~org-agenda-set-restriction-lock~ :: - {{{kindex(C-c C-x <)}}} + #+kindex: C-c C-x < Permanently restrict the agenda to the current subtree. When with a prefix argument, or with the cursor before the first headline in a @@ -7702,7 +7695,7 @@ for an extended period, use the following commands: takes effect immediately. - {{{kbd(C-c C-x >)}}}, ~org-agenda-remove-restriction-lock~ :: - {{{kindex(C-c C-x >)}}} + #+kindex: C-c C-x > Remove the permanent restriction created by {{{kbd(C-c C-x <)}}}. @@ -7712,7 +7705,7 @@ the following commands in the Speedbar frame: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(<)}}} in the speedbar frame ~org-speedbar-set-agenda-restriction~ :: - {{{kindex(<)}}} + #+kindex: < Permanently restrict the agenda to the item---either an Org file or a subtree in such a file---at the cursor in the Speedbar frame. If there @@ -7720,7 +7713,7 @@ the following commands in the Speedbar frame: effect immediately. - {{{kbd(>)}}} in the speedbar frame ~org-agenda-remove-restriction-lock~ :: - {{{kindex(>)}}} + #+kindex: > Lift the restriction. @@ -7729,8 +7722,8 @@ the following commands in the Speedbar frame: :DESCRIPTION: Keyboard access to agenda views :TITLE: The agenda dispatcher :END: -{{{cindex(agenda dispatcher)}}} -{{{cindex(dispatching agenda commands)}}} +#+cindex: agenda dispatcher +#+cindex: dispatching agenda commands The views are created through a dispatcher, which should be bound to a global key---for example {{{kbd(C-c a)}}} (see [[Activation]]). In the @@ -7742,37 +7735,37 @@ default commands: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(a)}}} :: - {{{kindex(C-c a a)}}} + #+kindex: C-c a a Create the calendar-like agenda (see [[Weekly/daily agenda]]). - {{{kbd(t)}}} or {{{kbd(T)}}} :: - {{{kindex(C-c a t)}}} - {{{kindex(C-c a T)}}} + #+kindex: C-c a t + #+kindex: C-c a T Create a list of all TODO items (see [[Global TODO list]]). - {{{kbd(m)}}} or {{{kbd(M)}}} :: - {{{kindex(C-c a m)}}} - {{{kindex(C-c a M)}}} + #+kindex: C-c a m + #+kindex: C-c a M Create a list of headlines matching a TAGS expression (see [[Matching tags and properties]]). - {{{kbd(L)}}} :: - {{{kindex(C-c a L)}}} + #+kindex: C-c a L Create the timeline view for the current buffer (see [[Timeline for a single file]]). - {{{kbd(s)}}} :: - {{{kindex(C-c a s)}}} + #+kindex: C-c a s 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(C-c a /)}}} - {{{vindex(org-agenda-text-search-extra-files)}}} + #+kindex: C-c a / + #+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 @@ -7781,19 +7774,19 @@ default commands: 1. - {{{kbd(#)}}} or {{{kbd(!)}}} :: - {{{kindex(C-c a #)}}} - {{{kindex(C-c a !)}}} + #+kindex: C-c a # + #+kindex: C-c a ! Create a list of stuck projects (see [[Stuck projects]]). - {{{kbd(<)}}} :: - {{{kindex(C-c a <)}}} + #+kindex: C-c a < Restrict an agenda command to the current buffer.[fn:89] After pressing {{{kbd(<)}}}, you still need to press the character selecting the command. - {{{kbd(< <)}}} :: - {{{kindex(C-c a < <)}}} + #+kindex: C-c a < < If there is an active region, restrict the following agenda command to the region. Otherwise, restrict it to the current subtree.[fn:90] @@ -7801,8 +7794,8 @@ default commands: selecting the command. - {{{kbd(*)}}} :: - {{{kindex(C-c a *)}}} - {{{vindex(org-agenda-sticky)}}} + #+kindex: C-c a * + #+vindex: org-agenda-sticky Toggle sticky agenda views. By default, Org maintains only a single agenda buffer and rebuilds it each time you change the view, to make @@ -7832,16 +7825,16 @@ In this section we describe the built-in views. :PROPERTIES: :DESCRIPTION: The calendar page with current tasks :END: -{{{cindex(agenda)}}} -{{{cindex(weekly agenda)}}} -{{{cindex(daily agenda)}}} +#+cindex: agenda +#+cindex: weekly agenda +#+cindex: daily agenda The purpose of the weekly/daily /agenda/ is to act like a page of a paper agenda, showing all the tasks for the current week or day. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c a a)}}}, ~org-agenda-list~ :: - {{{cindex(org-agenda, command)}}} + #+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 (like @@ -7849,8 +7842,8 @@ paper agenda, showing all the tasks for the current week or day. displayed.[fn:91] -{{{vindex(org-agenda-span)}}} -{{{vindex(org-agenda-ndays)}}} +#+vindex: org-agenda-span +#+vindex: org-agenda-ndays The default number of days displayed in the agenda is set by the variable ~org-agenda-span~ (or the obsolete ~org-agenda-ndays~). This variable can be set to any number of days you want to see by default in the @@ -7866,9 +7859,9 @@ commands]]. :PROPERTIES: :DESCRIPTION: Integrate the Emacs diary with Org :END: -{{{cindex(calendar integration)}}} -{{{cindex(diary integration)}}} -{{{cindex(Reingold\\\, Edward M.)}}} +#+cindex: calendar integration +#+cindex: diary integration +#+cindex: Reingold, Edward M. Emacs contains the calendar and diary by Edward M. Reingold. The calendar displays a three-month calendar with holidays from different @@ -7919,8 +7912,8 @@ will be made in the agenda:[fn:181] :DESCRIPTION: Integrate Big Brother Database and Org :END: -{{{cindex(BBDB, anniversaries)}}} -{{{cindex(anniversaries, from BBDB)}}} +#+cindex: BBDB, anniversaries +#+cindex: anniversaries, from BBDB If you are using the Big Brothers Database to store your contacts, you will very likely prefer to store anniversaries in BBDB rather than in a @@ -7962,10 +7955,10 @@ be very fast---much faster in fact than a long list of :PROPERTIES: :DESCRIPTION: Integrate the Emacs appointment facility and Org :END: -{{{cindex(@file{appt.el})}}} -{{{cindex(appointment reminders)}}} -{{{cindex(appointment)}}} -{{{cindex(reminders)}}} +{{{cindex: @fi#+appt.el} +#+cindex: appointment reminders +#+cindex: appointment +#+cindex: reminders Org can interact with Emacs appointments notification facility. To add the appointments of your agenda files, use the command ~org-agenda-to-appt~. @@ -7979,8 +7972,8 @@ docstring for details. :PROPERTIES: :DESCRIPTION: All unfinished action items :END: -{{{cindex(global TODO list)}}} -{{{cindex(TODO list, global)}}} +#+cindex: global TODO list +#+cindex: TODO list, global The global TODO list contains all unfinished TODO items formatted and collected into a single place. @@ -7996,8 +7989,8 @@ collected into a single place. - {{{kbd(C-c a T)}}}, ~org-todo-list~ :: - {{{cindex(TODO keyword matching)}}} - {{{vindex(org-todo-keywords)}}} + #+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(C-c a @@ -8006,7 +7999,7 @@ collected into a single place. OR operator. With a numeric prefix, the Nth keyword in ~org-todo-keywords~ is selected. - {{{kindex(r)}}} + #+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, @@ -8021,7 +8014,7 @@ 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 TODO list are described in [[Agenda commands]]. -{{{cindex(sublevels, inclusion into TODO list)}}} +#+cindex: sublevels, inclusion into TODO list Normally the global TODO list simply shows all headlines with TODO keywords. This list can become very long. There are two ways to keep @@ -8036,26 +8029,26 @@ it more compact: ~org-agenda-todo-ignore-with-date~ to exclude such items from the global TODO list. - {{{vindex(org-agenda-todo-ignore-scheduled)}}} - {{{vindex(org-agenda-todo-ignore-deadlines)}}} - {{{vindex(org-agenda-todo-ignore-timestamp)}}} - {{{vindex(org-agenda-todo-ignore-with-date)}}} + #+vindex: org-agenda-todo-ignore-scheduled + #+vindex: org-agenda-todo-ignore-deadlines + #+vindex: org-agenda-todo-ignore-timestamp + #+vindex: org-agenda-todo-ignore-with-date - TODO items may have sublevels to break up the task into subtasks. In such cases it may be enough to list only the highest level TODO headline and omit the sublevels from the global list. Configure the variable ~org-agenda-todo-list-sublevels~ to get this behavior. - {{{vindex(org-agenda-todo-list-sublevels)}}} + #+vindex: org-agenda-todo-list-sublevels *** Matching tags and properties :PROPERTIES: :DESCRIPTION: Structured information with fine-tuned search :END: -{{{cindex(matching, of tags)}}} -{{{cindex(matching, of properties)}}} -{{{cindex(tags view)}}} -{{{cindex(match view)}}} +#+cindex: matching, of tags +#+cindex: matching, of properties +#+cindex: tags view +#+cindex: match view If headlines in the agenda files are marked with /tags/ (see [[Tags]]), or have properties (see [[Properties and columns]]), you can select headlines @@ -8074,8 +8067,8 @@ with {{{kbd(C-c / m)}}}. - {{{kbd(C-c a M)}}}, ~org-tags-view~ :: - {{{vindex(org-tags-match-list-sublevels)}}} - {{{vindex(org-agenda-tags-todo-honor-ignore-options)}}} + #+vindex: org-tags-match-list-sublevels + #+vindex: org-agenda-tags-todo-honor-ignore-options Like {{{kbd(C-c a m)}}}, but only select headlines that are also TODO items in a not-DONE state and force checking subitems (see the variable @@ -8089,7 +8082,7 @@ The commands available in the tags list are described in [[Agenda commands]]. -{{{cindex(Boolean logic\\\, for tag or property searches)}}} +#+cindex: Boolean logic, for tag or property searches A search string can use Boolean operators {{{samp(&)}}} for AND and {{{samp(|)}}} for OR. {{{samp(&)}}} binds more strongly than @@ -8119,17 +8112,17 @@ examples, using only tags. also {{{samp(:night:)}}}. -{{{cindex(regular expressions, with tags search)}}} +#+cindex: regular expressions, with tags search Instead of a tag, you may also specify a regular expression enclosed in curly braces. For example, {{{samp(work+{^boss.*})}}} matches headlines that contain the tag {{{samp(:work:)}}} and any tag /starting/ with {{{samp(boss)}}}. -{{{cindex(TODO keyword matching, with tags search)}}} -{{{cindex(level\\\, require for tags/property match)}}} -{{{cindex(category\\\, require for tags/property match)}}} -{{{vindex(org-odd-levels-only)}}} +#+cindex: TODO keyword matching, with tags search +#+cindex: level, require for tags/property match +#+cindex: category, require for tags/property match +#+vindex: org-odd-levels-only You may also test for properties (see [[Properties and columns]]) at the same time as matching tags. The properties may be real properties, or @@ -8243,8 +8236,8 @@ after the slash with {{{samp(!)}}}. Using {{{kbd(C-c a M)}}} or :OPTIONAL_TITLE: Timeline :END: -{{{cindex(timeline\\\, single file)}}} -{{{cindex(time-sorted view)}}} +#+cindex: timeline, single file +#+cindex: time-sorted view The timeline summarizes all time-stamped items from a single Org mode file in a /time-sorted view/. The main purpose of this command is @@ -8265,9 +8258,9 @@ listed in [[Agenda commands]]. :PROPERTIES: :DESCRIPTION: Find entries by searching for text :END: -{{{cindex(search view)}}} -{{{cindex(text search)}}} -{{{cindex(searching, for text)}}} +#+cindex: search view +#+cindex: text search +#+cindex: searching, for text This agenda view is a general text search facility for Org mode entries. It is particularly useful to find notes. @@ -8292,7 +8285,7 @@ first {{{samp(+)}}} is necessary to turn on word search, other {{{samp(+)}}} characters are optional. For more details, see the docstring of the command ~org-search-view~. -{{{vindex(org-agenda-text-search-extra-files)}}} +#+vindex: org-agenda-text-search-extra-files Note that in addition to the agenda files, this command will also search the files listed in ~org-agenda-text-search-extra-files~. @@ -8301,7 +8294,7 @@ search the files listed in ~org-agenda-text-search-extra-files~. :PROPERTIES: :DESCRIPTION: Find projects you need to review :END: -{{{pindex(GTD\\\, Getting Things Done)}}} +#+pindex: GTD, Getting Things Done If you are following a system like David Allen's GTD to organize your work, one of the "duties" you have is a regular review to make sure @@ -8317,8 +8310,8 @@ projects and define next actions for them. - {{{kbd(C-c a !)}}} :: - {{{vindex(org-stuck-projects)}}} - {{{kindex(C-c a !)}}} + #+vindex: org-stuck-projects + #+kindex: C-c a ! Customize the variable ~org-stuck-projects~ to define what a stuck project is and how to find it. @@ -8355,9 +8348,9 @@ will still be searched for stuck projects. :PROPERTIES: :DESCRIPTION: How agenda items are prepared for display :END: -{{{cindex(presentation\\\, of agenda items)}}} -{{{vindex(org-agenda-prefix-format)}}} -{{{vindex(org-agenda-tags-column)}}} +#+cindex: presentation, of agenda items +#+vindex: org-agenda-prefix-format +#+vindex: org-agenda-tags-column Before displaying items in an agenda view, Org mode visually prepares the items and sorts them. Each item occupies a single line. The line @@ -8373,8 +8366,8 @@ version of the outline headline associated with the item. :DESCRIPTION: Not all tasks are equal :END: -{{{cindex(category)}}} -{{{cindex(#+CATEGORY)}}} +#+cindex: category +#+cindex: #+CATEGORY The category is a broad label assigned to each agenda item. By default, the category is simply derived from the file name, but you @@ -8386,7 +8379,7 @@ this:[fn:93] #+end_example {{{noindent}}} -{{{cindex(property\\\, CATEGORY)}}} +#+cindex: property, CATEGORY If you would like to have a special CATEGORY for a single entry or a (sub)tree, give the entry a ~:CATEGORY:~ property with the special @@ -8397,13 +8390,13 @@ category is not longer than 10 characters. {{{noindent}}} You can set up icons for category by customizing the ~org-agenda-category-icon-alist~ variable. -{{{vindex(org-agenda-category-icon-alist)}}} +#+vindex: org-agenda-category-icon-alist *** Time-of-day specifications :PROPERTIES: :DESCRIPTION: How the agenda knows the time :END: -{{{cindex(time-of-day specification)}}} +#+cindex: time-of-day specification Org mode checks each agenda item for a time-of-day specification. The time can be part of the timestamp that triggered inclusion into the @@ -8428,7 +8421,7 @@ the previous paragraphs would end up in the agenda like this: 20:30-22:15 Marvin escorts the Hitchhikers to the bridge #+end_example -{{{cindex(time grid)}}} +#+cindex: time grid If the agenda is in single-day mode, or for the display of today, the timed entries are embedded in a time grid, like @@ -8447,8 +8440,8 @@ timed entries are embedded in a time grid, like 20:30-22:15 Marvin escorts the Hitchhikers to the bridge #+end_example -{{{vindex(org-agenda-use-time-grid)}}} -{{{vindex(org-agenda-time-grid)}}} +#+vindex: org-agenda-use-time-grid +#+vindex: org-agenda-time-grid The time grid can be turned on and off with the variable ~org-agenda-use-time-grid~, and can be configured with @@ -8458,8 +8451,8 @@ The time grid can be turned on and off with the variable :PROPERTIES: :DESCRIPTION: The order of things :END: -{{{cindex(sorting\\\, of agenda items)}}} -{{{cindex(priorities\\\, of agenda items)}}} +#+cindex: sorting, of agenda items +#+cindex: priorities, of agenda items Before being inserted into a view, the items are sorted. How this is done depends on the type of view. @@ -8474,7 +8467,7 @@ done depends on the type of view. (2000 for priority {{{samp(A)}}}, 1000 for {{{samp(B)}}}, and 0 for {{{samp(C)}}}), plus additional increments for overdue scheduled or deadline items. - {{{vindex(org-agenda-files)}}} + #+vindex: org-agenda-files - For the TODO list, items remain in the order of categories, but within each category, sorting takes place according to priority (see @@ -8486,7 +8479,7 @@ done depends on the type of view. the sequence in which they are found in the agenda files. -{{{vindex(org-agenda-sorting-strategy)}}} +#+vindex: org-agenda-sorting-strategy Sorting can be customized using the variable ~org-agenda-sorting-strategy~, and may also include criteria based on @@ -8497,7 +8490,7 @@ the estimated effort of an entry (see [[Effort estimates]]). :DESCRIPTION: Remote editing of Org trees :TITLE: Commands in the agenda buffer :END: -{{{cindex(commands\\\, in agenda buffer)}}} +#+cindex: commands, in agenda buffer Entries in the agenda buffer are linked back to the Org file or diary file where they originate. You are not allowed to edit the agenda @@ -8510,50 +8503,50 @@ Some commands can be executed with mouse clicks on agenda lines. For the other commands, the cursor needs to be in the desired line. *** FIXME Motion2 -{{{cindex(motion commands in agenda)}}} +#+cindex: motion commands in agenda #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(n)}}}, ~org-agenda-next-line~ :: - {{{kindex(n)}}} + #+kindex: n Next line (same as {{{key(down)}}} and {{{kbd(C-n)}}}). - {{{kbd(p)}}}, ~org-agenda-previous-line~ :: - {{{kindex(p)}}} + #+kindex: p Previous line (same as {{{key(up)}}} and {{{kbd(C-p)}}}). *** View/Go to Org file -{{{cindex(view file commands in agenda)}}} +#+cindex: view file commands in agenda #+attr_texinfo: :table-type "table" :indic "@asis" - {{{key(SPC)}}} or {{{key(mouse-3)}}}, ~org-agenda-show-and-scroll-up~ :: - {{{kindex(@key{SPC})}}} - {{{kindex(mouse-3)}}} + #+kindex: @key{SPC} + #+kindex: mouse-3 Display the original location of the item in another window. With prefix arg, make sure that the entire entry is made visible in the outline, not only the heading. - {{{kbd(L)}}}, ~org-agenda-recenter~ :: - {{{kindex(L)}}} + #+kindex: L Display original location and recenter that window. - {{{key(TAB)}}} or {{{key(mouse-2)}}}, ~org-agenda-goto~ :: - {{{kindex(@key{TAB})}}} - {{{kindex(mouse-2)}}} + #+kindex: @key{TAB} + #+kindex: mouse-2 Go to the original location of the item in another window. - {{{key(RET)}}}, ~org-agenda-switch-to~ :: - {{{kindex(@key{RET})}}} + #+kindex: @key{RET} Go to the original location of the item and delete other windows. - {{{kbd(F)}}}, ~org-agenda-follow-mode~ :: - {{{kindex(F)}}} - {{{vindex(org-agenda-start-with-follow-mode)}}} + #+kindex: F + #+vindex: org-agenda-start-with-follow-mode Toggle Follow mode. In Follow mode, as you move the cursor through the agenda buffer, the other window always shows the corresponding @@ -8562,7 +8555,7 @@ the other commands, the cursor needs to be in the desired line. ~org-agenda-start-with-follow-mode~. - {{{kbd(C-c C-x b)}}}, ~org-agenda-tree-to-indirect-buffer~ :: - {{{kindex(C-c C-x b)}}} + #+kindex: C-c C-x b 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 @@ -8570,32 +8563,32 @@ the other commands, the cursor needs to be in the desired line. prefix, do not remove the previously used indirect buffer. - {{{kbd(C-c C-o)}}}, ~org-agenda-open-link~ :: - {{{kindex(C-c C-o)}}} + #+kindex: C-c C-o Follow a link in the entry. This will offer a selection of any links in the text belonging to the referenced Org node. If there is only one link, it will be followed without a selection prompt. *** Change display -{{{cindex(change agenda display)}}} +#+cindex: change agenda display #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(A)}}} :: - {{{kindex(A)}}} - {{{cindex(display changing\\\, in agenda)}}} + #+kindex: A + #+cindex: display changing, in agenda Interactively select another agenda view and append it to the current view. - {{{kbd(o)}}} :: - {{{kindex(o)}}} + #+kindex: o Delete other windows. - {{{kbd(v d)}}} or short {{{kbd(d)}}}, ~org-agenda-day-view~ :: - {{{kindex(v d)}}} - {{{kindex(d)}}} - {{{vindex(org-agenda-span)}}} + #+kindex: v d + #+kindex: d + #+vindex: org-agenda-span Switch to day view. When switching to day view, this setting becomes the default for subsequent agenda refreshes. A numeric prefix argument @@ -8607,9 +8600,9 @@ the other commands, the cursor needs to be in the desired line. interval 1938-2037. - {{{kbd(v w)}}} or short {{{kbd(w)}}}, ~org-agenda-week-view~ :: - {{{kindex(v w)}}} - {{{kindex(w)}}} - {{{vindex(org-agenda-span)}}} + #+kindex: v w + #+kindex: w + #+vindex: org-agenda-span Switch to week view. When switching week view, this setting becomes the default for subsequent agenda refreshes. A numeric prefix argument @@ -8621,8 +8614,8 @@ the other commands, the cursor needs to be in the desired line. interval 1938-2037. - {{{kbd(v m)}}}, ~org-agenda-month-view~ :: - {{{kindex(v m)}}} - {{{vindex(org-agenda-span)}}} + #+kindex: v m + #+vindex: org-agenda-span Switch to month view. Because month views are slow to create, they do not become the default for subsequent agenda refreshes. A numeric @@ -8633,8 +8626,8 @@ the other commands, the cursor needs to be in the desired line. digits, it will be mapped to the interval 1938-2037. - {{{kbd(v y)}}}, ~org-agenda-year-view~ :: - {{{kindex(v y)}}} - {{{vindex(org-agenda-span)}}} + #+kindex: v y + #+vindex: org-agenda-span Switch to year view. Because year views are slow to create, they do not become the default for subsequent agenda refreshes. A numeric @@ -8642,13 +8635,13 @@ the other commands, the cursor needs to be in the desired line. year. - {{{kbdspckey(v,SPC)}}}, ~org-agenda-reset-view~ :: - {{{kindex(v @key{SPC})}}} - {{{vindex(org-agenda-span)}}} + #+kindex: v @key{SPC} + #+vindex: org-agenda-span Reset ~org-agenda-span~ to the current span. - {{{kbd(f)}}}, ~org-agenda-later~ :: - {{{kindex(f)}}} + #+kindex: f Go forward in time to display the following ~org-agenda-current-span~ days. For example, if the display covers a week, switch to the @@ -8656,36 +8649,36 @@ the other commands, the cursor needs to be in the desired line. ~org-agenda-current-span~ days. - {{{kbd(b)}}}, ~org-agenda-earlier~ :: - {{{kindex(b)}}} + #+kindex: b Go backward in time to display earlier dates. - {{{kbd(.)}}}, ~org-agenda-goto-today~ :: - {{{kindex(.)}}} + #+kindex: . Go to today. - {{{kbd(j)}}}, ~org-agenda-goto-date~ :: - {{{kindex(j)}}} + #+kindex: j Prompt for a date and go there. - {{{kbd(J)}}}, ~org-agenda-clock-goto~ :: - {{{kindex(J)}}} + #+kindex: J Go to the currently clocked-in task /in the agenda buffer/. - {{{kbd(D)}}}, ~org-agenda-toggle-diary~ :: - {{{kindex(D)}}} + #+kindex: D 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)}}} - {{{vindex(org-log-done)}}} - {{{vindex(org-agenda-log-mode-items)}}} + #+kindex: v l + #+kindex: l + #+kindex: v L + #+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 @@ -8698,14 +8691,14 @@ the other commands, the cursor needs to be in the desired line. equivalent to {{{kbd(C-u v l)}}}. - {{{kbd(v [)}}} or short {{{kbd([)}}}, ~org-agenda-manipulate-query-add~ :: - {{{kindex(v [)}}} - {{{kindex([)}}} + #+kindex: v [ + #+kindex: [ Include inactive timestamps into the current view. Only for weekly/daily agenda and timeline views. - {{{kbd(v a)}}}, ~org-agenda-archives-mode~ :: - {{{kindex(v a)}}} + #+kindex: v a Toggle Archives mode. In Archives mode, trees that are marked ~ARCHIVED~ are also scanned when producing the agenda. To exit @@ -8718,10 +8711,10 @@ the other commands, the cursor needs to be in the desired line. archive files. To exit archives mode, press {{{kbd(v a)}}}. - {{{kbd(v R)}}} or short {{{kbd(R)}}}, ~org-agenda-clockreport-mode~ :: - {{{kindex(v R)}}} - {{{kindex(R)}}} - {{{vindex(org-agenda-start-with-clockreport-mode)}}} - {{{vindex(org-clock-report-include-clocking-task)}}} + #+kindex: v R + #+kindex: R + #+vindex: org-agenda-start-with-clockreport-mode + #+vindex: org-clock-report-include-clocking-task Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will always show a table with the clocked times for the timespan and @@ -8734,8 +8727,8 @@ the other commands, the cursor needs to be in the desired line. ~org-clock-report-include-clocking-task~. - {{{kbd(v c)}}} :: - {{{kindex(v c)}}} - {{{vindex(org-agenda-clock-consistency-checks)}}} + #+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 @@ -8746,10 +8739,10 @@ the other commands, the cursor needs to be in the desired line. mode. - {{{kbd(v E)}}} or short {{{kbd(E)}}}, ~org-agenda-entry-text-mode~ :: - {{{kindex(v E)}}} - {{{kindex(E)}}} - {{{vindex(org-agenda-start-with-entry-text-mode)}}} - {{{vindex(org-agenda-entry-text-maxlines)}}} + #+kindex: v E + #+kindex: E + #+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 will be displayed below @@ -8759,15 +8752,15 @@ the other commands, the cursor needs to be in the desired line. value. - {{{kbd(G)}}}, ~org-agenda-toggle-time-grid~ :: - {{{kindex(G)}}} - {{{vindex(org-agenda-use-time-grid)}}} - {{{vindex(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~ :: - {{{kindex(r)}}} + #+kindex: r Recreate the agenda buffer, for example to reflect the changes after modification of the timestamps of items with {{{kbdkey(S-,left)}}} and @@ -8776,20 +8769,20 @@ the other commands, the cursor needs to be in the desired line. keyword. - {{{kbd(g)}}}, ~org-agenda-redo~ :: - {{{kindex(g)}}} + #+kindex: g Same as {{{kbd(r)}}}. - {{{kbd(C-x C-s)}}} or short {{{kbd(s)}}}, ~org-save-all-org-buffers~ :: - {{{kindex(C-x C-s)}}} - {{{kindex(s)}}} + #+kindex: C-x C-s + #+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)}}} - {{{vindex(org-columns-default-format)}}} + #+kindex: C-c C-x C-c + #+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 @@ -8799,22 +8792,22 @@ the other commands, the cursor needs to be in the desired line. ~org-columns-default-format~), will be used in the agenda. - {{{kbd(C-c C-x >)}}}, ~org-agenda-remove-restriction-lock~ :: - {{{kindex(C-c C-x >)}}} + #+kindex: C-c C-x > Remove the restriction lock on the agenda, if it is currently restricted to a file or subtree (see [[Agenda files]]). *** FIXME Secondary filtering and query editing -{{{cindex(filtering, by tag category and effort\\\, in agenda)}}} -{{{cindex(tag filtering\\\, in agenda)}}} -{{{cindex(category filtering\\\, in agenda)}}} -{{{cindex(effort filtering\\\, in agenda)}}} -{{{cindex(query editing\\\, in agenda)}}} +#+cindex: filtering, by tag category and effort, in agenda +#+cindex: tag filtering, in agenda +#+cindex: category filtering, in agenda +#+cindex: effort filtering, in agenda +#+cindex: query editing, in agenda #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(<)}}}, ~org-agenda-filter-by-category~ :: - {{{kindex(<)}}} - {{{vindex(org-agenda-category-filter-preset)}}} + #+kindex: < + #+vindex: org-agenda-category-filter-preset Filter the current agenda view with respect to the category of the item at point. Pressing {{{kbd(<)}}} another time will remove this @@ -8822,8 +8815,8 @@ the other commands, the cursor needs to be in the desired line. ~org-agenda-category-filter-preset~ (see below). - {{{kbd(/)}}}, ~org-agenda-filter-by-tag~ :: - {{{kindex(/)}}} - {{{vindex(org-agenda-tag-filter-preset)}}} + #+kindex: / + #+vindex: org-agenda-tag-filter-preset Filter the current agenda view with respect to a tag and/or effort estimates. The difference between this and a custom agenda command is @@ -8843,7 +8836,7 @@ the other commands, the cursor needs to be in the desired line. additional tag. Instead of pressing {{{kbd(+)}}} or {{{kbd(-)}}} after {{{kbd(/)}}}, you can also immediately use the ~\~ command. - {{{vindex(org-sort-agenda-noeffort-is-high)}}} + #+vindex: org-sort-agenda-noeffort-is-high In order to filter for effort estimates, you should set up allowed efforts globally, for example: @@ -8894,7 +8887,7 @@ the other commands, the cursor needs to be in the desired line. #+end_src - ~\~ ~org-agenda-filter-by-tag-refine~ :: - {{{kindex(XXX)}}} + #+kindex: XXX #+comment: Should be \ Narrow the current agenda filter by an additional condition. When called with prefix arg, remove the entries that /do/ have the tag, or @@ -8903,10 +8896,10 @@ the other commands, the cursor needs to be in the desired line. {{{kbd(/)}}} command. - {{{kbd([)}}} {{{kbd(])}}} {{{kbd({)}}} {{{kbd(})}}} in search view :: - {{{kindex([)}}} - {{{kindex(])}}} - {{{kindex(@{)}}} - {{{kindex(@})}}} + #+kindex: [ + #+kindex: ] + #+kindex: @{ + #+kindex: @} Add new search words ({{{kbd([)}}} and {{{kbd(])}}}) or new regular expressions ({{{kbd({)}}} and {{{kbd(})}}}) to the query string. The @@ -8916,7 +8909,7 @@ the other commands, the cursor needs to be in the desired line. which /must not/ occur/match in the entry for it to be selected. *** FIXME Remote editing -{{{cindex(remote editing\\\, from agenda)}}} +#+cindex: remote editing, from agenda #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(0--9)}}} :: @@ -8924,32 +8917,32 @@ the other commands, the cursor needs to be in the desired line. Digit argument. - {{{kbd(C-_)}}}, ~org-agenda-undo~ :: - {{{kindex(C-_)}}} - {{{cindex(undoing remote-editing events)}}} - {{{cindex(remote editing\\\, undo)}}} + #+kindex: C-_ + #+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)}}} + #+kindex: t Change the TODO state of the item, both in the agenda and in the original org file. - {{{kbdkey(C-S-,right)}}}, ~org-agenda-todo-nextset~ :: - {{{kindex(C-S-@key{right})}}} + #+kindex: C-S-@key{right} Switch to the next set of TODO keywords. - {{{kbdkey(C-S-,left)}}}, ~org-agenda-todo-previousset~ :: - {{{kindex(C-S-@key{left})}}} + #+kindex: C-S-@key{left} Switch to the previous set of TODO keywords. - {{{kbd(C-k)}}}, ~org-agenda-kill~ :: - {{{kindex(C-k)}}} - {{{vindex(org-agenda-confirm-kill)}}} + #+kindex: C-k + #+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 @@ -8957,101 +8950,100 @@ the other commands, the cursor needs to be in the desired line. variable ~org-agenda-confirm-kill~. - {{{kbd(C-c C-w)}}}, ~org-agenda-refile~ :: - {{{kindex(C-c C-w)}}} + #+kindex: C-c C-w 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)}}} - {{{vindex(org-archive-default-command)}}} + #+kindex: C-c C-x C-a + #+kindex: a + #+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 ~a~ key, confirmation will be required. - {{{kbd(C-c C-x a)}}}, ~org-agenda-toggle-archive-tag~ :: - {{{kindex(C-c C-x a)}}} + #+kindex: C-c C-x a Toggle the ARCHIVE tag for the current headline. - {{{kbd(C-c C-x A)}}}, ~org-agenda-archive-to-archive-sibling~ :: - {{{kindex(C-c C-x A)}}} + #+kindex: C-c C-x A 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($)}}} + #+kindex: C-c C-x C-s + #+kindex: $ Archive the subtree corresponding to the current headline. This means the entry will be moved to the configured archive location, most likely a different file. - {{{kbd(T)}}}, ~org-agenda-show-tags~ :: - {{{kindex(T)}}} - {{{vindex(org-agenda-show-inherited-tags)}}} + #+kindex: T + #+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(:)}}} + #+kindex: : 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(,)}}} :: - {{{kindex(XXX)}}} - # Should be a comma + #+kindex: , Set the priority for the current item (~org-agenda-priority~). Org mode prompts for the priority character. If you reply with {{{key(SPC)}}}, the priority cookie is removed from the entry. - {{{kbd(P)}}}, ~org-agenda-show-priority~ :: - {{{kindex(P)}}} + #+kindex: P Display weighted priority of current item. - {{{kbd(+)}}} {{{kbdkey(S-,up)}}}, ~org-agenda-priority-up~ :: - {{{kindex(+)}}} + #+kindex: + 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(-)}}} {{{kbdkey(S-,down)}}}, ~org-agenda-priority-down~ :: - {{{kindex(-)}}} + #+kindex: - Decrease the priority of the current item. - {{{kbd(z)}}} {{{kbd(C-c C-z)}}}, ~org-agenda-add-note~ :: - {{{kindex(z)}}} - {{{vindex(org-log-into-drawer)}}} + #+kindex: z + #+vindex: org-log-into-drawer Add a note to the entry. This note will be 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)}}} + #+kindex: C-c C-a Dispatcher for all command related to attachments. - {{{kbd(C-c C-s)}}}, ~org-agenda-schedule~ :: - {{{kindex(C-c C-s)}}} + #+kindex: C-c C-s Schedule this item. With prefix arg remove the scheduling timestamp - {{{kbd(C-c C-d)}}}, ~org-agenda-deadline~ :: - {{{kindex(C-c C-d)}}} + #+kindex: C-c C-d Set a deadline for this item. With prefix arg remove the deadline. - {{{kbdkey(S-,right)}}}, ~org-agenda-do-date-later~ :: - {{{kindex(S-@key{right})}}} + #+kindex: S-@key{right} 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 @@ -9066,77 +9058,77 @@ the other commands, the cursor needs to be in the desired line. buffer. - {{{kbdkey(S-,left)}}}, ~org-agenda-do-date-earlier~ :: - {{{kindex(S-@key{left})}}} + #+kindex: S-@key{left} Change the timestamp associated with the current line by one day into the past. - {{{kbd(>)}}}, ~org-agenda-date-prompt~ :: - {{{kindex(>)}}} + #+kindex: > 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)}}} + #+kindex: I 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)}}} + #+kindex: O Stop the previously started clock. - {{{kbd(X)}}}, ~org-agenda-clock-cancel~ :: - {{{kindex(X)}}} + #+kindex: X Cancel the currently running clock. - {{{kbd(J)}}}, ~org-agenda-clock-goto~ :: - {{{kindex(J)}}} + #+kindex: J Jump to the running clock in another window. - {{{kbd(k)}}}, ~org-agenda-capture~ :: - {{{kindex(k)}}} - {{{cindex(capturing\\\, from agenda)}}} - {{{vindex(org-capture-use-agenda-date)}}} + #+kindex: k + #+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 -{{{cindex(remote editing\\\, bulk\\\, from agenda)}}} -{{{vindex(org-agenda-bulk-persistent-marks)}}} -{{{vindex(org-agenda-bulk-custom-functions)}}} +#+cindex: remote editing, bulk, from agenda +#+vindex: org-agenda-bulk-persistent-marks +#+vindex: org-agenda-bulk-custom-functions #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(m)}}}, ~org-agenda-bulk-mark~ :: - {{{kindex(m)}}} + #+kindex: m Mark the entry at point for bulk action. With prefix arg, mark that many successive entries. - {{{kbd(%)}}}, ~org-agenda-bulk-mark-regexp~ :: - {{{kindex(%)}}} + #+kindex: % Mark entries matching a regular expression for bulk action. - {{{kbd(u)}}}, ~org-agenda-bulk-unmark~ :: - {{{kindex(u)}}} + #+kindex: u Unmark entry for bulk action. - {{{kbd(U)}}}, ~org-agenda-bulk-remove-all-marks~ :: - {{{kindex(U)}}} + #+kindex: U Unmark all marked entries for bulk action. - {{{kbd(B)}}}, ~org-agenda-bulk-action~ :: - {{{kindex(B)}}} + #+kindex: B Bulk action: act on all marked entries in the agenda. This will prompt for another key to select the action to be applied. The prefix arg to @@ -9216,24 +9208,24 @@ the other commands, the cursor needs to be in the desired line. #+end_src *** Calendar commands -{{{cindex(calendar commands\\\, from agenda)}}} +#+cindex: calendar commands, from agenda #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(c)}}}, ~org-agenda-goto-calendar~ :: - {{{kindex(c)}}} + #+kindex: c Open the Emacs calendar and move to the date at the agenda cursor. - {{{kbd(c)}}}, ~org-calendar-goto-agenda~ :: - {{{kindex(c)}}} + #+kindex: c When in the calendar, compute and show the Org mode agenda for the date at the cursor. - {{{kbd(i)}}}, ~org-agenda-diary-entry~ :: - {{{kindex(i)}}} - {{{vindex(org-agenda-diary-file)}}} - {{{cindex(diary entries\\\, creating from agenda)}}} + #+kindex: i + #+vindex: org-agenda-diary-file + #+cindex: diary entries, creating from agenda Insert a new entry into the diary, using the date at the cursor and (for block entries) the date at the mark. This will add to the Emacs @@ -9254,24 +9246,24 @@ the other commands, the cursor needs to be in the desired line. there. See also the {{{kbd(k r)}}} command. - {{{kbd(M)}}}, ~org-agenda-phases-of-moon~ :: - {{{kindex(M)}}} + #+kindex: M Show the phases of the moon for the three months around current date. - {{{kbd(S)}}}, ~org-agenda-sunrise-sunset~ :: - {{{kindex(S)}}} + #+kindex: S 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)}}} + #+kindex: C Convert the date at cursor into many other cultural and historic calendars. - {{{kbd(H)}}}, ~org-agenda-holidays~ :: - {{{kindex(H)}}} + #+kindex: H Show holidays for three months around the cursor date. @@ -9284,10 +9276,10 @@ the other commands, the cursor needs to be in the desired line. *** Exporting to a file #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-x C-w)}}}, ~org-agenda-write~ :: - {{{kindex(C-x C-w)}}} - {{{cindex(exporting agenda views)}}} - {{{cindex(agenda views\\\, exporting)}}} - {{{vindex(org-agenda-exporter-settings)}}} + #+kindex: C-x C-w + #+cindex: exporting agenda views + #+cindex: agenda views, exporting + #+vindex: org-agenda-exporter-settings Write the agenda view to a file. Depending on the extension of the selected file name, the view will be exported as HTML (extension @@ -9301,13 +9293,13 @@ the other commands, the cursor needs to be in the desired line. *** Quit and exit #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(q)}}}, ~org-agenda-quit~ :: - {{{kindex(q)}}} + #+kindex: q Quit agenda, remove the agenda buffer. - {{{kbd(x)}}}, ~org-agenda-exit~ :: - {{{kindex(x)}}} - {{{cindex(agenda files\\\, removing buffers)}}} + #+kindex: x + #+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 @@ -9317,8 +9309,8 @@ the other commands, the cursor needs to be in the desired line. :PROPERTIES: :DESCRIPTION: Defining special searches and views :END: -{{{cindex(custom agenda views)}}} -{{{cindex(agenda views\\\, custom)}}} +#+cindex: custom agenda views +#+cindex: agenda views, custom Custom agenda commands serve two purposes: to store and quickly access frequently used TODO and tags searches, and to create special composite @@ -9335,8 +9327,8 @@ shortcuts for frequently used searches, either creating an agenda buffer, or a sparse tree (the latter covering of course only the current buffer). -{{{kindex(C-c a C)}}} -{{{vindex(org-agenda-custom-commands)}}} +#+kindex: C-c a C +#+vindex: org-agenda-custom-commands Custom commands are configured in the variable ~org-agenda-custom-commands~. You can customize this variable, for @@ -9411,8 +9403,8 @@ used for the matching. The example above will therefore define: :PROPERTIES: :DESCRIPTION: All the stuff you need in a single buffer :END: -{{{cindex(block agenda)}}} -{{{cindex(agenda\\\, with block views)}}} +#+cindex: block agenda +#+cindex: agenda, with block views Another possibility is the construction of agenda views that comprise the results of /several/ commands, each of which creates a block in @@ -9447,8 +9439,8 @@ provides a similar view for office tasks. :PROPERTIES: :DESCRIPTION: Changing the rules :END: -{{{cindex(options\\\, for custom agenda views)}}} -{{{vindex(org-agenda-custom-commands)}}} +#+cindex: options, for custom agenda views +#+vindex: org-agenda-custom-commands Org mode contains a number of variables regulating agenda construction and display. The global variables define the behavior for all agenda @@ -9481,7 +9473,7 @@ nor the headline following the match will be shown. The command {{{kbd(C-c a N)}}} will do a text search limited to only a single file. -{{{vindex(org-agenda-custom-commands)}}} +#+vindex: org-agenda-custom-commands For command sets creating a block agenda, ~org-agenda-custom-commands~ has two separate spots for setting options. You can add options that @@ -9517,7 +9509,7 @@ this interface, the /values/ are just Lisp expressions. So if the value is a string, you need to add the double-quotes around the value yourself. -{{{vindex(org-agenda-custom-commands-contexts)}}} +#+vindex: org-agenda-custom-commands-contexts To control whether an agenda command should be accessible from a specific context, you can customize @@ -9549,7 +9541,7 @@ See the docstring of the variable for more information. :PROPERTIES: :DESCRIPTION: Writing a view to a file :END: -{{{cindex(agenda views\\\, exporting)}}} +#+cindex: agenda views, exporting If you are away from your computer, it can be very useful to have a printed version of some agenda views to carry around. Org mode can @@ -9560,9 +9552,9 @@ do this only occasionally, use the following command: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-x C-w)}}}, ~org-agenda-write~ :: - {{{cindex(exporting agenda views)}}} - {{{cindex(agenda views\\\, exporting)}}} - {{{vindex(org-agenda-exporter-settings)}}} + #+cindex: exporting agenda views + #+cindex: agenda views, exporting + #+vindex: org-agenda-exporter-settings Write the agenda view to a file. Depending on the extension of the selected file name, the view will be exported as HTML (extension @@ -9572,10 +9564,10 @@ do this only occasionally, use the following command: ~org-agenda-exporter-settings~ to set options for {{{file(ps-print)}}} and for {{{file(htmlize)}}} to be used during export, for example: - {{{vindex(org-agenda-add-entry-text-maxlines)}}} - {{{vindex(htmlize-output-type)}}} - {{{vindex(ps-number-of-columns)}}} - {{{vindex(ps-landscape-mode)}}} + #+vindex: org-agenda-add-entry-text-maxlines + #+vindex: htmlize-output-type + #+vindex: ps-number-of-columns + #+vindex: ps-landscape-mode #+header: :eval no #+header: :exports code @@ -9693,8 +9685,8 @@ more information. :DESCRIPTION: Using column view for collected entries :OPTIONAL_TITLE: Agenda column view :END: -{{{cindex(column view\\\, in agenda)}}} -{{{cindex(agenda\\\, column view)}}} +#+cindex: column view, in agenda +#+cindex: agenda, column view <> Column view (see [[Column view]]) is normally used to view and edit @@ -9722,8 +9714,8 @@ This causes the following issues: not have a specific format (defined in a property, or in its file), it uses ~org-columns-default-format~. - {{{vindex(org-columns-default-format)}}} - {{{vindex(org-overriding-columns-format)}}} + #+vindex: org-columns-default-format + #+vindex: org-overriding-columns-format 2. If any of the columns has a summary type defined (see [[Column attributes]]), turning on column view in the agenda will visit all @@ -9738,7 +9730,7 @@ This causes the following issues: /child/). In these cases, the summation in the agenda will lead to incorrect results because some values will count double. - {{{cindex(property, special, CLOCKSUM)}}} + #+cindex: property, special, CLOCKSUM 3. When the column view in the agenda shows the ~CLOCKSUM~, that is always the entire clocked time for this item. So even in the @@ -9756,7 +9748,7 @@ This causes the following issues: you compare the time you spent on a task for today, with the time already spent (via ~CLOCKSUM~) and with the planned total effort for it. - {{{cindex(property, special, CLOCKSUM_T)}}} + #+cindex: property, special, CLOCKSUM_T * FIXME Markup for rich export :PROPERTIES: @@ -9779,12 +9771,12 @@ This section summarizes the markup rules used in an Org mode buffer. :PROPERTIES: :DESCRIPTION: Where the title is taken from :END: -{{{cindex(document title\\\, markup rules)}}} +#+cindex: document title, markup rules {{{noindent}}} The title of the exported document is taken from the special line: -{{{cindex(#+TITLE)}}} +#+cindex: #+TITLE #+begin_example ,#+TITLE: This is the title of the document #+end_example @@ -9795,7 +9787,7 @@ exists, or if you have turned off exporting of the text before the first headline (see below), the title will be the file name without extension. -{{{cindex(property\\\, EXPORT_TITLE)}}} +#+cindex: property, EXPORT_TITLE If you are exporting only a subtree by marking is as the region, the heading of the subtree will become the title of the document. If the @@ -9805,9 +9797,9 @@ subtree has a property ~EXPORT_TITLE~, that will take precedence. :PROPERTIES: :DESCRIPTION: The document structure as seen by the exporter :END: -{{{cindex(headings and sections\\\, markup rules)}}} +#+cindex: headings and sections, markup rules -{{{vindex(org-export-headline-levels)}}} +#+vindex: org-export-headline-levels The outline structure of the document as described in [[Document structure]], forms the basis for defining sections of the exported @@ -9817,7 +9809,7 @@ used as headings. Deeper levels will become itemized lists. You can change the location of this switch globally by setting the variable ~org-export-headline-levels~, or on a per-file basis with the ~H~ option: -{{{cindex(#+OPTIONS)}}} +#+cindex: #+OPTIONS #+begin_example ,#+OPTIONS: H:4 #+end_example @@ -9826,9 +9818,9 @@ change the location of this switch globally by setting the variable :PROPERTIES: :DESCRIPTION: The if and where of the table of contents :END: -{{{cindex(table of contents\\\, markup rules)}}} +#+cindex: table of contents, markup rules -{{{vindex(org-export-with-toc)}}} +#+vindex: org-export-with-toc The table of contents is normally inserted directly before the first headline of the file. If you would like to get it to a different @@ -9849,15 +9841,15 @@ with the ~toc~ option: :DESCRIPTION: Text before the first heading? :TITLE: Text before the first headline :END: -{{{cindex(text before first headline\\\, markup rules)}}} -{{{cindex(#+TEXT)}}} +#+cindex: text before first headline, markup rules +#+cindex: #+TEXT Org mode normally exports the text before the first headline, and even uses the first line as the document title. The text will be fully marked up. If you need to include literal HTML, LaTeX, or DocBook code, use the special constructs described below in the sections for the individual exporters. -{{{vindex(org-export-skip-text-before-1st-heading)}}} +#+vindex: org-export-skip-text-before-1st-heading Some people like to use the space before the first headline for setup and internal links and therefore would like to control the exported @@ -9882,7 +9874,7 @@ If you still want to have some text before the first headline, use the :PROPERTIES: :DESCRIPTION: Lists :END: -{{{cindex(lists\\\, markup rules)}}} +#+cindex: lists, markup rules Plain lists as described in [[Plain lists]], are translated to the backend's syntax for such lists. Most backends support unordered, @@ -9892,7 +9884,7 @@ ordered, and description lists. :PROPERTIES: :DESCRIPTION: Paragraphs :END: -{{{cindex(paragraphs\\\, markup rules)}}} +#+cindex: paragraphs, markup rules Paragraphs are separated by at least one empty line. If you need to enforce a line break within a paragraph, use ~\\~ at the end @@ -9902,7 +9894,7 @@ To keep the line breaks in a region, but otherwise use normal formatting, you can use ~VERSE~ blocks, which can also be used to format poetry: -{{{cindex(#+BEGIN_VERSE)}}} +#+cindex: #+BEGIN_VERSE #+begin_example #+BEGIN_VERSE Great clouds overhead @@ -9918,7 +9910,7 @@ format this as a paragraph that is indented on both the left and the right margin. You can include quotations in Org mode documents like this: -{{{cindex(#+BEGIN_QUOTE)}}} +#+cindex: #+BEGIN_QUOTE #+begin_example #+BEGIN_QUOTE Everything should be made as simple as possible, @@ -9927,7 +9919,7 @@ this: #+end_example If you would like to center some text, do it like this: -{{{cindex(#+BEGIN_CENTER)}}} +#+cindex: #+BEGIN_CENTER #+begin_example #+BEGIN_CENTER Everything should be made as simple as possible, \\ @@ -9939,8 +9931,8 @@ If you would like to center some text, do it like this: :PROPERTIES: :DESCRIPTION: Footnotes :END: -{{{cindex(footnotes\\\, markup rules)}}} -{{{cindex(@file{footnote.el})}}} +#+cindex: footnotes, markup rules +#+cindex: @file{footnote.el} Footnotes defined in the way described in [[Creating footnotes]], will be exported by all backends. Org allows multiple references to the same note, and @@ -9951,12 +9943,12 @@ multiple footnotes side by side. :DESCRIPTION: Bold, italic, etc. :END: -{{{cindex(underlined text\\\, markup rules)}}} -{{{cindex(bold text\\\, markup rules)}}} -{{{cindex(italic text\\\, markup rules)}}} -{{{cindex(verbatim text\\\, markup rules)}}} -{{{cindex(code text\\\, markup rules)}}} -{{{cindex(strike-through text\\\, markup rules)}}} +#+cindex: underlined text, markup rules +#+cindex: bold text, markup rules +#+cindex: italic text, markup rules +#+cindex: verbatim text, markup rules +#+cindex: code text, markup rules +#+cindex: strike-through text, markup rules You can make words **bold**, //italic//, _underlined_, ~=code=~ and ~~verbatim~~, and, if you must, {{{samp(+strike-through+)}}}. Text @@ -9967,7 +9959,7 @@ syntax; it is exported verbatim. :PROPERTIES: :DESCRIPTION: Make a line :END: -{{{cindex(horizontal rules\\\, markup rules)}}} +#+cindex: horizontal rules, markup rules A line consisting of only dashes, and at least 5 of them, will be exported as a horizontal line (~
~ in HTML and ~\hrule~ @@ -9977,9 +9969,9 @@ in LaTeX). :PROPERTIES: :DESCRIPTION: What will *not* be exported :END: -{{{cindex(comment lines)}}} -{{{cindex(exporting\\\, not)}}} -{{{cindex(#+BEGIN_COMMENT)}}} +#+cindex: comment lines +#+cindex: exporting, not +#+cindex: #+BEGIN_COMMENT Lines starting with zero or more whitespace characters followed by one {{{samp(#)}}} and a whitespace are treated as comments and will never @@ -9990,7 +9982,7 @@ surrounded by {{{samp(#+BEGIN_COMMENT)}}} ... #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c ;)}}} :: - {{{kindex(C-c ;)}}} + #+kindex: C-c ; Toggle the COMMENT keyword at the beginning of an entry. @@ -9999,9 +9991,9 @@ surrounded by {{{samp(#+BEGIN_COMMENT)}}} ... :DESCRIPTION: Tables and images can be exported :END: -{{{cindex(tables\\\, markup rules)}}} -{{{cindex(#+CAPTION)}}} -{{{cindex(#+LABEL)}}} +#+cindex: tables, markup rules +#+cindex: #+CAPTION +#+cindex: #+LABEL Both the native Org mode tables (see [[Tables]]) and tables formatted with the {{{file(table.el)}}} package will be exported properly. For Org @@ -10023,7 +10015,7 @@ Optionally, the caption can take the form: #+CAPTION: [Caption for list of figures]{Caption for table (or link).} #+end_example -{{{cindex(inlined images\\\, markup rules)}}} +#+cindex: inlined images, markup rules Some backends (HTML, LaTeX, and DocBook) allow you to directly include images into the exported document. Org does this, if a link to @@ -10049,13 +10041,13 @@ See [[Handling links][the discussion of image links]]. :PROPERTIES: :DESCRIPTION: Source code examples with special formatting :END: -{{{cindex(literal examples\\\, markup rules)}}} -{{{cindex(code line references\\\, markup rules)}}} +#+cindex: literal examples, markup rules +#+cindex: code line references, markup rules You can include literal examples that should not be subjected to markup. Such examples will be typeset in monospace, so this is well suited for source code and similar examples. -{{{cindex(#+BEGIN_EXAMPLE)}}} +#+cindex: #+BEGIN_EXAMPLE #+begin_example ,#+BEGIN_EXAMPLE @@ -10074,7 +10066,7 @@ additional whitespace before the colon: : Some example from a text file. #+end_example -{{{cindex(formatting source code\\\, markup rules)}}} +#+cindex: formatting source code, markup rules If the example is source code from a programming language, or any other text that can be marked up by font-lock in Emacs, you can ask @@ -10083,7 +10075,7 @@ is done with the {{{samp(src)}}} block, where you also need to specify the name of the major mode that should be used to fontify the example, see [[Easy templates]] for shortcuts to easily insert code blocks.[fn:103] -{{{cindex(#+BEGIN_SRC)}}} +#+cindex: #+BEGIN_SRC #+begin_example #+BEGIN_SRC emacs-lisp @@ -10117,7 +10109,7 @@ links will use the labels with no parentheses. Here is an example: jumps to point-min. #+end_example -{{{vindex(org-coderef-label-format)}}} +#+vindex: org-coderef-label-format If the syntax for the label format conflicts with the language syntax, use a ~-l~ switch to change the format, for example @@ -10133,7 +10125,7 @@ often, shortcuts are provided using the Easy Templates facility (see #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c ')}}} :: - {{{kindex(C-c ')}}} + #+kindex: C-c ' 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 @@ -10145,7 +10137,7 @@ often, shortcuts are provided using the Easy Templates facility (see fixed-width region. - {{{kbd(C-c l)}}} :: - {{{kindex(C-c l)}}} + #+kindex: C-c l Calling ~org-store-link~ while editing a source code example in a temporary buffer created with {{{kbd(C-c ')}}} will prompt for a @@ -10158,12 +10150,12 @@ often, shortcuts are provided using the Easy Templates facility (see :PROPERTIES: :DESCRIPTION: Include additional files into a document :END: -{{{cindex(include files\\\, markup rules)}}} +#+cindex: include files, markup rules During export, you can include the content of another file. For example, to include your {{{file(.emacs)}}} file, you could use: -{{{cindex(#+INCLUDE)}}} +#+cindex: #+INCLUDE #+begin_example ,#+INCLUDE: "~/.emacs" src emacs-lisp @@ -10205,7 +10197,7 @@ omitted to use the obvious defaults. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c ')}}} - {{{kindex(C-c ')}}} + #+kindex: C-c ' Visit the include file at point. @@ -10213,7 +10205,7 @@ omitted to use the obvious defaults. :PROPERTIES: :DESCRIPTION: Making an index :END: -{{{cindex(index entries\\\, for publishing)}}} +#+cindex: index entries, for publishing You can specify entries that will be used for generating an index during publishing. This is done by lines starting with ~#+INDEX~. An @@ -10230,8 +10222,8 @@ entry the contains an exclamation mark will create a sub item. See :PROPERTIES: :DESCRIPTION: Use macros to create complex output :END: -{{{cindex(macro replacement\\\, during export)}}} -{{{cindex(#+MACRO)}}} +#+cindex: macro replacement, during export +#+cindex: #+MACRO You can define text snippets with a macro: @@ -10257,8 +10249,8 @@ construct complex HTML code. :DESCRIPTION: LaTeX can be freely used inside Org documents :OPTIONAL_TITLE: Embedded Latex :END: -{{{cindex(@TeX{} interpretation)}}} -{{{cindex(@LaTeX{} interpretation)}}} +{{{cindex: @T#+} interpretation +{{{cindex: @LaT#+} interpretation Plain ASCII is normally sufficient for almost all note taking. Exceptions include scientific notes, which often require mathematical @@ -10272,12 +10264,12 @@ to produce pretty output for a number of export backends. :PROPERTIES: :DESCRIPTION: Greek letters and other symbols :END: -{{{cindex(math symbols)}}} -{{{cindex(special symbols)}}} -{{{cindex(@TeX{} macros)}}} -{{{cindex(@LaTeX{} fragments, markup rules)}}} -{{{cindex(HTML entities)}}} -{{{cindex(@LaTeX{} entities)}}} +#+cindex: math symbols +#+cindex: special symbols +#+cindex: @TeX{} macros +#+cindex: @LaTeX{} fragments, markup rules +#+cindex: HTML entities +#+cindex: @LaTeX{} entities You can use LaTeX macros to insert special symbols like ~\alpha~ to indicate the Greek letter, or ~\to~ to @@ -10291,7 +10283,7 @@ example: Angles are written as Greek letters \alpha, \beta and \gamma. #+end_example -{{{vindex(org-entities)}}} +#+vindex: org-entities During export, these symbols will be transformed into the native format of the exporter backend. Strings like ~\alpha~ will be exported @@ -10312,7 +10304,7 @@ following command:[fn:108] #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x XXX)}}} :: - {{{kindex(C-c C-x XXX)}}} + #+kindex: C-c C-x XXX # Should be \ Toggle display of entities as UTF-8 characters. This does not change the buffer content which remains plain ASCII, but it overlays the @@ -10322,8 +10314,8 @@ following command:[fn:108] :PROPERTIES: :DESCRIPTION: Simple syntax for raising/lowering text :END: -{{{cindex(subscript)}}} -{{{cindex(superscript)}}} +#+cindex: subscript +#+cindex: superscript Just like in LaTeX, {{{samp(^)}}} and {{{samp(_)}}} are used to indicate super- and subscripts. Again, these can be used without @@ -10336,7 +10328,7 @@ sub- and superscripts with curly braces. For example the sun is R_{sun} = 6.96 x 10^8 m. #+end_example -{{{vindex(org-export-with-sub-superscripts)}}} +#+vindex: org-export-with-sub-superscripts To avoid interpretation as raised or lowered text, you can quote {{{kbd(^)}}} and {{{kbd(_)}}} with a backslash: ~\^~ and ~\_~. If you @@ -10355,7 +10347,7 @@ subscript, but ~a_{b}~ will. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x XXX)}}} :: - {{{kindex(C-c C-x XXX)}}} + #+kindex: C-c C-x XXX # Should be \ In addition to showing entities as UTF-8 characters, this command will also format sub- and superscripts in a WYSIWYM way. @@ -10364,8 +10356,8 @@ subscript, but ~a_{b}~ will. :PROPERTIES: :DESCRIPTION: Complex formulas made easy :END: -{{{cindex(@LaTeX{} fragments)}}} -{{{vindex(org-format-latex-header)}}} +#+cindex: @LaTeX{} fragments +#+vindex: org-format-latex-header Going beyond symbols and sub- and superscripts, a full formula language is needed. Org mode can contain LaTeX math fragments, and @@ -10404,14 +10396,14 @@ snippets will be identified as LaTeX source code: #+end_example {{{noindent}}} -{{{vindex(org-format-latex-options)}}} +#+vindex: org-format-latex-options If you need any of the delimiter ASCII sequences for other purposes, you can configure the option ~org-format-latex-options~ to deselect the ones you do not wish to have interpreted by the LaTeX converter. -{{{vindex(org-export-with-LaTeX-fragments)}}} +#+vindex: org-export-with-LaTeX-fragments LaTeX processing can be configured with the variable ~org-export-with-LaTeX-fragments~. The default setting is ~t~ which @@ -10440,14 +10432,14 @@ per-file basis using one of these lines: :PROPERTIES: :DESCRIPTION: What will this snippet look like? :END: -{{{cindex(@LaTeX{} fragments, preview)}}} +#+cindex: @LaTeX{} fragments, preview If you have {{{file(dvipng)}}} installed, LaTeX fragments can be processed to produce preview images of the typeset expressions: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x C-l)}}} :: - {{{kindex(C-c C-x C-l)}}} + #+kindex: C-c C-x C-l 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 @@ -10457,12 +10449,12 @@ processed to produce preview images of the typeset expressions: process the entire buffer. - {{{kbd(C-c C-c)}}} :: - {{{kindex(C-c C-c)}}} + #+kindex: C-c C-c Remove the overlay preview images. -{{{vindex(org-format-latex-options)}}} +#+vindex: org-format-latex-options You can customize the variable ~org-format-latex-options~ to influence some aspects of the preview. In particular, the ~:scale~ (and for HTML @@ -10474,7 +10466,7 @@ preview images. :DESCRIPTION: Speed up entering of formulas :TITLE: Using CDLaTeX to enter math :END: -{{{cindex(CD@LaTeX{})}}} +#+cindex: CD@LaTeX{} CDLaTeX mode is a minor mode that is normally used in combination with a major LaTeX mode like AUCTeX in order to speed-up @@ -10499,12 +10491,12 @@ details see the documentation of CDLaTeX mode): #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c {)}}} :: - {{{kindex(C-c @{)}}} + #+kindex: C-c @{ Insert an environment template. - {{{key(TAB)}}} :: - {{{kindex(@key{TAB})}}} + #+kindex: @key{TAB} Expand a template if the cursor is inside a LaTeX fragment.[fn:112] For example, {{{key(TAB)}}} will expand ~fr~ to ~\frac{}{}~ and @@ -10517,9 +10509,9 @@ details see the documentation of CDLaTeX mode): 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 will insert these characters together with a pair of braces. If you use @@ -10528,14 +10520,14 @@ details see the documentation of CDLaTeX mode): 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 will pop 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 @@ -10547,7 +10539,7 @@ details see the documentation of CDLaTeX mode): :PROPERTIES: :DESCRIPTION: Sharing and publishing notes :END: -{{{cindex(exporting)}}} +#+cindex: exporting Org mode documents can be exported into a variety of other formats. For printing and sharing of notes, ASCII export produces a readable @@ -10572,10 +10564,10 @@ enabled (default in Emacs 23). :PROPERTIES: :DESCRIPTION: Using tags to select and exclude trees :END: -{{{cindex(export\\\, selective by tags or TODO keyword)}}} -{{{vindex(org-export-select-tags)}}} -{{{vindex(org-export-exclude-tags)}}} -{{{cindex(org-export-with-tasks)}}} +#+cindex: export, selective by tags or TODO keyword +#+vindex: org-export-select-tags +#+vindex: org-export-exclude-tags +#+cindex: org-export-with-tasks You may use tags to select the parts of a document that should be exported, or to exclude parts from export. This behavior is governed by two variables: @@ -10603,8 +10595,8 @@ variable for more information. :PROPERTIES: :DESCRIPTION: Per-file export settings :END: -{{{cindex(options\\\, for export)}}} -{{{cindex(completion\\\, of option keywords)}}} +#+cindex: options, for export +#+cindex: completion, of option keywords The exporter recognizes special lines in the buffer which provide additional information. These lines may be put anywhere in the file. @@ -10618,31 +10610,31 @@ a separate file which can be included using ~#+SETUPFILE~. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e t)}}}, ~org-insert-export-options-template~ :: - {{{kindex(C-c C-e t)}}} + #+kindex: C-c C-e t Insert template with export options, see example below. -{{{cindex(#+TITLE)}}} -{{{cindex(#+AUTHOR)}}} -{{{cindex(#+DATE)}}} -{{{cindex(#+EMAIL)}}} -{{{cindex(#+DESCRIPTION)}}} -{{{cindex(#+KEYWORDS)}}} -{{{cindex(#+LANGUAGE)}}} -{{{cindex(#+TEXT)}}} -{{{cindex(#+OPTIONS)}}} -{{{cindex(#+BIND)}}} -{{{cindex(#+LINK_UP)}}} -{{{cindex(#+LINK_HOME)}}} -{{{cindex(#+EXPORT_SELECT_TAGS)}}} -{{{cindex(#+EXPORT_EXCLUDE_TAGS)}}} -{{{cindex(#+XSLT)}}} -{{{cindex(#+LaTeX_HEADER)}}} -{{{vindex(user-full-name)}}} -{{{vindex(user-mail-address)}}} -{{{vindex(org-export-default-language)}}} -{{{vindex(org-export-date-timestamp-format)}}} +#+cindex: #+TITLE +#+cindex: #+AUTHOR +#+cindex: #+DATE +#+cindex: #+EMAIL +#+cindex: #+DESCRIPTION +#+cindex: #+KEYWORDS +#+cindex: #+LANGUAGE +#+cindex: #+TEXT +#+cindex: #+OPTIONS +#+cindex: #+BIND +#+cindex: #+LINK_UP +#+cindex: #+LINK_HOME +#+cindex: #+EXPORT_SELECT_TAGS +#+cindex: #+EXPORT_EXCLUDE_TAGS +#+cindex: #+XSLT +#+cindex: #+LaTeX_HEADER +#+vindex: user-full-name +#+vindex: user-mail-address +#+vindex: org-export-default-language +#+vindex: org-export-date-timestamp-format #+attr_texinfo: :table-type "table" :indic "@asis" - #+TITLE: :: @@ -10720,26 +10712,26 @@ a separate file which can be included using ~#+SETUPFILE~. {{{noindent}}} The ~#+OPTIONS~ line is a compact form to specify export settings.[fn:114] Here you can: -{{{cindex(headline levels)}}} -{{{cindex(section-numbers)}}} -{{{cindex(table of contents)}}} -{{{cindex(line-break preservation)}}} -{{{cindex(quoted HTML tags)}}} -{{{cindex(fixed-width sections)}}} -{{{cindex(tables)}}} -{{{cindex(@TeX{}-like syntax for sub- and superscripts)}}} -{{{cindex(footnotes)}}} -{{{cindex(special strings)}}} -{{{cindex(emphasized text)}}} -{{{cindex(@TeX{} macros)}}} -{{{cindex(@LaTeX{} fragments)}}} -{{{cindex(author info\\\, in export)}}} -{{{cindex(time info\\\, in export)}}} -{{{vindex(org-export-plist-vars)}}} -{{{vindex(org-export-author-info)}}} -{{{vindex(org-export-creator-info)}}} -{{{vindex(org-export-email-info)}}} -{{{vindex(org-export-time-stamp-file)}}} +#+cindex: headline levels +#+cindex: section-numbers +#+cindex: table of contents +#+cindex: line-break preservation +#+cindex: quoted HTML tags +#+cindex: fixed-width sections +#+cindex: tables +#+cindex: @TeX{}-like syntax for sub- and superscripts +#+cindex: footnotes +#+cindex: special strings +#+cindex: emphasized text +#+cindex: @TeX{} macros +#+cindex: @LaTeX{} fragments +#+cindex: author info, in export +#+cindex: time info, in export +#+vindex: org-export-plist-vars +#+vindex: org-export-author-info +#+vindex: org-export-creator-info +#+vindex: org-export-email-info +#+vindex: org-export-time-stamp-file #+attr_texinfo: :table-type "table" :indic "@code" - H: :: @@ -10861,7 +10853,7 @@ overrule some of the file's export settings with properties :PROPERTIES: :DESCRIPTION: How to access exporter commands :END: -{{{cindex(dispatcher\\\, for export commands)}}} +#+cindex: dispatcher, for export commands All export commands can be reached using the export dispatcher, which is a prefix key that prompts for an additional key specifying the @@ -10871,8 +10863,8 @@ used as document title and the subtrees are exported. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e)}}}, ~org-export~ :: - {{{kindex(C-c C-e)}}} - {{{vindex(org-export-run-in-background)}}} + #+kindex: C-c C-e + #+vindex: org-export-run-in-background Dispatcher for export and publishing commands. Displays a help-window listing the additional key(s) needed to launch an export or publishing @@ -10881,14 +10873,14 @@ used as document title and the subtrees are exported. background, in a separate Emacs process.[fn:115] - {{{kbd(C-c C-e v)}}}, ~org-export-visible~ :: - {{{kindex(C-c C-e v)}}} + #+kindex: C-c C-e v Like {{{kbd(C-c C-e)}}}, but only export the text that is currently visible (i.e., not hidden by outline visibility). - {{{kbd(C-u C-u C-c C-e)}}}, ~org-export~ :: - {{{kindex(C-u C-u C-c C-e)}}} - {{{vindex(org-export-run-in-background)}}} + #+kindex: C-u C-u C-c C-e + #+vindex: org-export-run-in-background Call the exporter, but reverse the setting of ~org-export-run-in-background~, i.e., request background processing if @@ -10898,23 +10890,23 @@ used as document title and the subtrees are exported. :PROPERTIES: :DESCRIPTION: Exporting to flat files with encoding :END: -{{{cindex(ASCII export)}}} -{{{cindex(Latin-1 export)}}} -{{{cindex(UTF-8 export)}}} +#+cindex: ASCII export +#+cindex: Latin-1 export +#+cindex: UTF-8 export ASCII export produces a simple and very readable version of an Org mode file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file with special characters and symbols available in these encodings. -{{{cindex(region\\\, active)}}} -{{{cindex(active region)}}} -{{{cindex(transient-mark-mode)}}} +#+cindex: region, active +#+cindex: active region +#+cindex: transient-mark-mode #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e a)}}}, ~org-export-as-ascii~ :: - {{{kindex(C-c C-e a)}}} - {{{cindex(property\\\, EXPORT_FILE_NAME)}}} + #+kindex: C-c C-e a + #+cindex: property, EXPORT_FILE_NAME Export as an ASCII file. For an Org file, {{{file(myfile.org)}}}, the ASCII file will be {{{file(myfile.txt)}}}. The file will be @@ -10925,40 +10917,40 @@ these encodings. name will be used for the export. - {{{kbd(C-c C-e A)}}}, ~org-export-as-ascii-to-buffer~ :: - {{{kindex(C-c C-e A)}}} + #+kindex: C-c C-e A Export to a temporary buffer. Do not create a file. - {{{kbd(C-c C-e n)}}}, ~org-export-as-latin1~ :: - {{{kindex(C-c C-e n)}}} + #+kindex: C-c C-e n Like {{{kbd(C-c C-e a)}}}, but use Latin-1 encoding. - {{{kbd(C-c C-e N)}}}, ~org-export-as-latin1-to-buffer~ :: - {{{kindex(C-c C-e N)}}} + #+kindex: C-c C-e N Like {{{kbd(C-c C-e A)}}}, but use Latin-1 encoding. - {{{kbd(C-c C-e u)}}}, ~org-export-as-utf8~ :: - {{{kindex(C-c C-e u)}}} + #+kindex: C-c C-e u Like {{{kbd(C-c C-e a)}}}, but use UTF-8 encoding. - {{{kbd(C-c C-e U)}}}, ~org-export-as-utf8-to-buffer~ :: - {{{kindex(C-c C-e U)}}} + #+kindex: C-c C-e U Like {{{kbd(C-c C-e A)}}}, but use UTF-8 encoding. - {{{kbd(C-c C-e v a/n/u)}}} :: - {{{kindex(C-c C-e v a)}}} - {{{kindex(C-c C-e v n)}}} - {{{kindex(C-c C-e v u)}}} + #+kindex: C-c C-e v a + #+kindex: C-c C-e v n + #+kindex: C-c C-e v u Export only the visible part of the document. -{{{cindex(headline levels\\\, for exporting)}}} +#+cindex: headline levels, for exporting In the exported version, the first 3 outline levels will become headlines, defining a general document structure. Additional levels @@ -10978,7 +10970,7 @@ indentation larger than this is adjusted to preserve the layout relative to the first line. Should there be lines with less indentation than the first one, these are left alone. -{{{vindex(org-export-ascii-links-to-notes)}}} +#+vindex: org-export-ascii-links-to-notes Links will be exported in a footnote-like style, with the descriptive part in the text and the link in a note before the next heading. See @@ -10989,8 +10981,8 @@ options. :PROPERTIES: :DESCRIPTION: Exporting to HTML :END: -{{{cindex(HTML export)}}} -{{{cindex(Gruber\\\, John)}}} +#+cindex: HTML export +#+cindex: Gruber, John Org mode contains a HTML (XHTML 1.0 strict) exporter with extensive HTML formatting, in ways similar to John Gruber's /markdown/ language, @@ -11000,14 +10992,14 @@ but with additional support for tables. :PROPERTIES: :DESCRIPTION: How to invoke HTML export :END: -{{{cindex(region\\\, active)}}} -{{{cindex(active region)}}} -{{{cindex(transient-mark-mode)}}} +#+cindex: region, active +#+cindex: active region +#+cindex: transient-mark-mode #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e h)}}}, ~org-export-as-html~ :: - {{{kindex(C-c C-e h)}}} - {{{cindex(property\\\, EXPORT_FILE_NAME)}}} + #+kindex: C-c C-e h + #+cindex: property, EXPORT_FILE_NAME Export as an HTML file. For an Org file {{{file(myfile.org)}}}, the HTML file will be {{{file(myfile.html)}}}. The file will be @@ -11018,17 +11010,17 @@ but with additional support for tables. that name will be used for the export. - {{{kbd(C-c C-e b)}}}, ~org-export-as-html-and-open~ :: - {{{kindex(C-c C-e b)}}} + #+kindex: C-c C-e b Export as a HTML file and immediately open it with a browser. - {{{kbd(C-c C-e H)}}}, ~org-export-as-html-to-buffer~ :: - {{{kindex(C-c C-e H)}}} + #+kindex: C-c C-e H Export to a temporary buffer. Do not create a file. - {{{kbd(C-c C-e R)}}}, ~org-export-region-as-html~ :: - {{{kindex(C-c C-e R)}}} + #+kindex: C-c C-e R Export the active region to a temporary buffer. With a prefix argument, do not produce the file header and footer, but just the @@ -11036,10 +11028,10 @@ but with additional support for tables. operations. - {{{kbd(C-c C-e v h/b/H/R)}}} :: - {{{kindex(C-c C-e v h)}}} - {{{kindex(C-c C-e v b)}}} - {{{kindex(C-c C-e v H)}}} - {{{kindex(C-c C-e v R)}}} + #+kindex: C-c C-e v h + #+kindex: C-c C-e v b + #+kindex: C-c C-e v H + #+kindex: C-c C-e v R Export only the visible part of the document. @@ -11055,7 +11047,7 @@ but with additional support for tables. code. -{{{cindex(headline levels\\\, for exporting)}}} +#+cindex: headline levels, for exporting In the exported version, the first three outline levels will become headlines, defining a general document structure. Additional levels @@ -11074,15 +11066,15 @@ the rest as list items. :PROPERTIES: :DESCRIPTION: How to insert a preamble and postamble :END: -{{{vindex(org-export-html-preamble)}}} -{{{vindex(org-export-html-postamble)}}} -{{{vindex(org-export-html-preamble-format)}}} -{{{vindex(org-export-html-postamble-format)}}} -{{{vindex(org-export-html-validation-link)}}} -{{{vindex(org-export-author-info)}}} -{{{vindex(org-export-email-info)}}} -{{{vindex(org-export-creator-info)}}} -{{{vindex(org-export-time-stamp-file)}}} +#+vindex: org-export-html-preamble +#+vindex: org-export-html-postamble +#+vindex: org-export-html-preamble-format +#+vindex: org-export-html-postamble-format +#+vindex: org-export-html-validation-link +#+vindex: org-export-author-info +#+vindex: org-export-email-info +#+vindex: org-export-creator-info +#+vindex: org-export-time-stamp-file The HTML exporter lets you define a preamble and a postamble. @@ -11119,14 +11111,14 @@ them with {{{samp(@)}}} as in {{{samp(@bold text@)}}}. Note that this really works only for simple tags. For more extensive HTML that should be copied verbatim to the exported file use either ~#+HTML~: -{{{cindex(#+HTML)}}} -{{{cindex(#+BEGIN_HTML)}}} +#+cindex: #+HTML +#+cindex: #+BEGIN_HTML #+begin_example ,#+HTML: Literal HTML code for export #+end_example {{{noindent}}} or an HTML block: -{{{cindex(#+BEGIN_HTML)}}} +#+cindex: #+BEGIN_HTML #+begin_example #+BEGIN_HTML @@ -11138,9 +11130,9 @@ that should be copied verbatim to the exported file use either ~#+HTML~: :PROPERTIES: :DESCRIPTION: How links will be interpreted and formatted :END: -{{{cindex(links\\\, in HTML export)}}} -{{{cindex(internal links\\\, in HTML export)}}} -{{{cindex(external links\\\, in HTML export)}}} +#+cindex: links, in HTML export +#+cindex: internal links, in HTML export +#+cindex: external links, in HTML export Internal links (see [[Internal links]]) will continue to work in HTML. This includes automatic links created by radio targets (see [[Radio @@ -11158,7 +11150,7 @@ special ~#+ATTR_HTML~ line to define attributes that will be added to the ~~ or ~~ tags. Here is an example that sets ~title~ and ~style~ attributes for a link: -{{{cindex(#+ATTR_HTML)}}} +#+cindex: #+ATTR_HTML #+begin_example ,#+ATTR_HTML: title="The Org mode homepage" style="color:red;" ,[[http://orgmode.org]] @@ -11168,8 +11160,8 @@ the ~~ or ~~ tags. Here is an example that sets ~title~ and :PROPERTIES: :DESCRIPTION: How to modify the formatting of tables :END: -{{{cindex(tables\\\, in HTML)}}} -{{{vindex(org-export-html-table-tag)}}} +#+cindex: tables, in HTML +#+vindex: org-export-html-table-tag Org mode tables are exported to HTML using the table tag defined in ~org-export-html-table-tag~. The default setting makes tables without @@ -11177,8 +11169,8 @@ cell borders and frame. If you would like to change this for individual tables, place something like the following before the table: -{{{cindex(#+CAPTION)}}} -{{{cindex(#+ATTR_HTML)}}} +#+cindex: #+CAPTION +#+cindex: #+ATTR_HTML #+begin_example ,#+CAPTION: This is a table with lines around and between cells ,#+ATTR_HTML: border="2" rules="all" frame="border" @@ -11188,9 +11180,9 @@ table: :PROPERTIES: :DESCRIPTION: How to insert figures into HTML output :END: -{{{cindex(images\\\, inline in HTML)}}} -{{{cindex(inlining images in HTML)}}} -{{{vindex(org-export-html-inline-images)}}} +#+cindex: images, inline in HTML +#+cindex: inlining images in HTML +#+vindex: org-export-html-inline-images HTML export can inline images given as links in the Org file, and it can make an image the clickable part of a link. By default, images are @@ -11210,8 +11202,8 @@ If you need to add attributes to an inlined image, use a ~#+ATTR_HTML~. In the example below we specify the ~alt~ and ~title~ attributes to support text viewers and accessibility, and align it to the right. -{{{cindex(#+CAPTION)}}} -{{{cindex(#+ATTR_HTML)}}} +#+cindex: #+CAPTION +#+cindex: #+ATTR_HTML #+begin_example ,#+CAPTION: A black cat stalking a spider ,#+ATTR_HTML: alt="cat/spider image" title="Action!" align="right" @@ -11224,8 +11216,8 @@ support text viewers and accessibility, and align it to the right. :PROPERTIES: :DESCRIPTION: Beautiful math also on the web :END: -{{{cindex(MathJax)}}} -{{{cindex(dvipng)}}} +#+cindex: MathJax +#+cindex: dvipng LaTeX math snippets (see [[LaTeX fragments]]) can be displayed in two different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax system]] @@ -11259,7 +11251,7 @@ with the following option: :PROPERTIES: :DESCRIPTION: An alternate way to show an example :END: -{{{cindex(text areas\\\, in HTML)}}} +#+cindex: text areas, in HTML An alternative way to publish literal code examples in HTML is to use text areas, where the example can even be edited before pasting it @@ -11282,10 +11274,10 @@ text area, which default to the number of lines in the example, and :PROPERTIES: :DESCRIPTION: Changing the appearance of the output :END: -{{{cindex(CSS\\\, for HTML export)}}} -{{{cindex(HTML export\\\, CSS)}}} -{{{vindex(org-export-html-todo-kwd-class-prefix)}}} -{{{vindex(org-export-html-tag-class-prefix)}}} +#+cindex: CSS, for HTML export +#+cindex: HTML export, CSS +#+vindex: org-export-html-todo-kwd-class-prefix +#+vindex: org-export-html-tag-class-prefix You can also give style information for the exported file. The HTML exporter assigns the following special CSS classes to appropriate @@ -11322,11 +11314,11 @@ etc.[fn:122] - .footnum :: footnote number in footnote definition (always ) -{{{vindex(org-export-html-style-default)}}} -{{{vindex(org-export-html-style-include-default)}}} -{{{vindex(org-export-html-style)}}} -{{{vindex(org-export-html-extra)}}} -{{{vindex(org-export-html-style-default)}}} +#+vindex: org-export-html-style-default +#+vindex: org-export-html-style-include-default +#+vindex: org-export-html-style +#+vindex: org-export-html-extra +#+vindex: org-export-html-style-default Each exported file contains a compact default style that defines these classes in a basic way.[fn:123] You may overwrite these @@ -11335,7 +11327,7 @@ settings, or add to them by using the variables ~org-export-html-style~ fine-grained settings, like file-local settings). To set the latter variable individually for each file, you can use a ~#+STYLE:~ line: -{{{cindex(#+STYLE)}}} +#+cindex: #+STYLE #+begin_example ,#+STYLE: #+end_example @@ -11356,7 +11348,7 @@ for a particular headline, you can use the id specified in a :PROPERTIES: :DESCRIPTION: Info and folding in a web browser :END: -{{{cindex(Rose\\\, Sebastian)}}} +#+cindex: Rose, Sebastian Sebastian Rose has written a JavaScript program especially designed to enhance the web viewing experience of HTML files created with Org. This @@ -11377,7 +11369,7 @@ default, but you can try {{{ksksksk(M-x customize-variable,RET,org-modules,RET)} to convince yourself that this is indeed the case. All it then takes to make use of the program is adding a single line to the Org file: -{{{cindex(#+INFOJS_OPT)}}} +#+cindex: #+INFOJS_OPT #+begin_example ,#+INFOJS_OPT: view:info toc:nil #+end_example @@ -11442,8 +11434,8 @@ line above, you can set the following viewing options: only one such button will be present. -{{{vindex(org-infojs-options)}}} -{{{vindex(org-export-html-use-infojs)}}} +#+vindex: org-infojs-options +#+vindex: org-export-html-use-infojs {{{noindent}}} You can choose default values for these options by customizing the variable ~org-infojs-options~. If you always want to @@ -11454,9 +11446,9 @@ apply the script to your pages, configure the variable :PROPERTIES: :DESCRIPTION: Exporting to LaTeX and processing to PDF :END: -{{{cindex(@LaTeX{} export)}}} -{{{cindex(PDF export)}}} -{{{cindex(Guerry\\\, Bastien)}}} +#+cindex: @LaTeX{} export +#+cindex: PDF export +#+cindex: Guerry, Bastien Org mode contains a LaTeX exporter written by Bastien Guerry. With further processing, this backend is also used to produce PDF @@ -11470,14 +11462,14 @@ hierarchy of sections. :PROPERTIES: :DESCRIPTION: Invoking export to LaTeX/PDF :END: -{{{cindex(region\\\, active)}}} -{{{cindex(active region)}}} -{{{cindex(transient-mark-mode)}}} +#+cindex: region, active +#+cindex: active region +#+cindex: transient-mark-mode #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e l)}}}, ~org-export-as-latex~ :: - {{{kindex(C-c C-e l)}}} - {{{cindex(property EXPORT_FILE_NAME)}}} + #+kindex: C-c C-e l + #+cindex: property EXPORT_FILE_NAME Export as a LaTeX file. For an Org file {{{file(myfile.org)}}}, the LaTeX file will be {{{file(myfile.tex)}}}. The file will be @@ -11488,7 +11480,7 @@ hierarchy of sections. that name will be used for the export. - {{{kbd(C-c C-e L)}}}, ~org-export-as-latex-to-buffer~ :: - {{{kindex(C-c C-e L)}}} + #+kindex: C-c C-e L Export to a temporary buffer. Do not create a file. @@ -11508,19 +11500,19 @@ hierarchy of sections. LaTeX code. - {{{kbd(C-c C-e p)}}}, ~org-export-as-pdf~ :: - {{{kindex(C-c C-e p)}}} + #+kindex: C-c C-e p Export as LaTeX and then process to PDF. - {{{kbd(C-c C-e d)}}}, ~org-export-as-pdf-and-open~ :: - {{{kindex(C-c C-e d)}}} + #+kindex: C-c C-e d Export as LaTeX and then process to PDF, then open the resulting PDF file. -{{{cindex(headline levels\\\, for exporting)}}} -{{{vindex(org-latex-low-levels)}}} +#+cindex: headline levels, for exporting +#+vindex: org-latex-low-levels In the exported version, the first 3 outline levels will become headlines, defining a general document structure. Additional levels @@ -11542,23 +11534,23 @@ exports the rest as list items. :DESCRIPTION: Setting up the export file structure :TITLE: Header and sectioning structure :END: -{{{cindex(@LaTeX{} class)}}} -{{{cindex(@LaTeX{} sectioning structure)}}} -{{{cindex(@LaTeX{} header)}}} -{{{cindex(header\\\, for @LaTeX{} files)}}} -{{{cindex(sectioning structure\\\, for @LaTeX{} export)}}} +#+cindex: @LaTeX{} class +#+cindex: @LaTeX{} sectioning structure +#+cindex: @LaTeX{} header +#+cindex: header, for @LaTeX{} files +#+cindex: sectioning structure, for @LaTeX{} export By default, the LaTeX output uses the class ~article~. -{{{vindex(org-export-latex-default-class)}}} -{{{vindex(org-export-latex-classes)}}} -{{{vindex(org-export-latex-default-packages-alist)}}} -{{{vindex(org-export-latex-packages-alist)}}} -{{{cindex(#+LaTeX_HEADER)}}} -{{{cindex(#+LaTeX_CLASS)}}} -{{{cindex(#+LaTeX_CLASS_OPTIONS)}}} -{{{cindex(property\\\, LaTeX_CLASS)}}} -{{{cindex(property\\\, LaTeX_CLASS_OPTIONS)}}} +#+vindex: org-export-latex-default-class +#+vindex: org-export-latex-classes +#+vindex: org-export-latex-default-packages-alist +#+vindex: org-export-latex-packages-alist +#+cindex: #+LaTeX_HEADER +#+cindex: #+LaTeX_CLASS +#+cindex: #+LaTeX_CLASS_OPTIONS +#+cindex: property, LaTeX_CLASS +#+cindex: property, LaTeX_CLASS_OPTIONS You can change this globally by setting a different value for ~org-export-latex-default-class~ or locally by adding an option like @@ -11595,15 +11587,15 @@ inserted into the LaTeX file. This includes simple macros like you can add special code that should only be present in LaTeX export with the following constructs: -{{{cindex(#+LaTeX)}}} -{{{cindex(#+BEGIN_LaTeX)}}} +#+cindex: #+LaTeX +#+cindex: #+BEGIN_LaTeX #+begin_example ,#+LaTeX: Literal LaTeX code for export #+end_example {{{noindent}}} or -{{{cindex(#+BEGIN_LaTeX)}}} +#+cindex: #+BEGIN_LaTeX #+begin_example ,#+BEGIN_LaTeX @@ -11615,7 +11607,7 @@ with the following constructs: :PROPERTIES: :DESCRIPTION: Options for exporting tables to LaTeX :END: -{{{cindex(tables\\\, in @LaTeX{} export)}}} +#+cindex: tables, in @LaTeX{} export For LaTeX export of a table, you can specify a label, a caption and placement options (see [[Images and tables]]). You can also use the @@ -11626,9 +11618,9 @@ tabular environment to ~tabularx~ or ~tabulary~. Finally, you can set the alignment string, and (with ~tabularx~ or ~tabulary~) the width: -{{{cindex(#+CAPTION)}}} -{{{cindex(#+LABEL)}}} -{{{cindex(#+ATTR_LaTeX)}}} +#+cindex: #+CAPTION +#+cindex: #+LABEL +#+cindex: #+ATTR_LaTeX #+begin_example ,#+CAPTION: A long table ,#+LABEL: tbl:long @@ -11639,9 +11631,9 @@ width: or to specify a multicolumn table with ~tabulary~: -{{{cindex(#+CAPTION)}}} -{{{cindex(#+LABEL)}}} -{{{cindex(#+ATTR_LaTeX)}}} +#+cindex: #+CAPTION +#+cindex: #+LABEL +#+cindex: #+ATTR_LaTeX #+begin_example ,#+CAPTION: A wide table with tabulary ,#+LABEL: tbl:wide @@ -11654,8 +11646,8 @@ or to specify a multicolumn table with ~tabulary~: :PROPERTIES: :DESCRIPTION: How to insert figures into LaTeX output :END: -{{{cindex(images\\\, inline in @LaTeX{})}}} -{{{cindex(inlining images in @LaTeX{})}}} +{{{cindex: images, inline in @LaT#+} +{{{cindex: inlining images in @LaT#+} Images that are linked to without a description part in the link, like {{{samp([[file:img.jpg]])}}} or {{{samp([[./img.jpg]])}}} will be inserted @@ -11680,9 +11672,9 @@ field will be the set of additional arguments needed by the image, you need to use compatible settings for ~\includegraphics~ and ~wrapfigure~. -{{{cindex(#+CAPTION)}}} -{{{cindex(#+LABEL)}}} -{{{cindex(#+ATTR_LaTeX)}}} +#+cindex: #+CAPTION +#+cindex: #+LABEL +#+cindex: #+ATTR_LaTeX #+begin_example ,#+CAPTION: The black-body emission of the disk around HR 4049 ,#+LABEL: fig:SED-HR4049 @@ -11791,7 +11783,7 @@ support with the following line: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-b)}}}, ~org-beamer-select-environment~ :: - {{{kindex(C-c C-b)}}} + #+kindex: C-c C-b In ~org-beamer-mode~, this key offers fast selection of a beamer environment or the ~BEAMER_col~ property. @@ -11845,9 +11837,9 @@ For more information, see the documentation on Worg. :PROPERTIES: :DESCRIPTION: Exporting to DocBook :END: -{{{cindex(DocBook export)}}} -{{{cindex(PDF export)}}} -{{{cindex(Cui\\\, Baoqiu)}}} +#+cindex: DocBook export +#+cindex: PDF export +#+cindex: Cui, Baoqiu Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is exported to DocBook format, it can be further processed to produce other @@ -11860,14 +11852,14 @@ Currently DocBook exporter only supports DocBook V5.0. :PROPERTIES: :DESCRIPTION: How to invoke DocBook export :END: -{{{cindex(region\\\, active)}}} -{{{cindex(active region)}}} -{{{cindex(transient-mark-mode)}}} +#+cindex: region, active +#+cindex: active region +#+cindex: transient-mark-mode #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e D)}}}, ~org-export-as-docbook~ :: - {{{kindex(C-c C-e D)}}} - {{{cindex(property EXPORT_FILE_NAME)}}} + #+kindex: C-c C-e D + #+cindex: property EXPORT_FILE_NAME Export as a DocBook file. For an Org file, {{{file(myfile.org)}}}, the DocBook XML file will be {{{file(myfile.xml)}}}. The file will be @@ -11878,13 +11870,13 @@ Currently DocBook exporter only supports DocBook V5.0. name will be used for the export. - {{{kbd(C-c C-e V)}}}, ~org-export-as-docbook-pdf-and-open~ :: - {{{kindex(C-c C-e V)}}} + #+kindex: C-c C-e V Export as a DocBook file, process to PDF, then open the resulting PDF file. - {{{vindex(org-export-docbook-xslt-proc-command)}}} - {{{vindex(org-export-docbook-xsl-fo-proc-command)}}} + #+vindex: org-export-docbook-xslt-proc-command + #+vindex: org-export-docbook-xsl-fo-proc-command Note that, in order to produce PDF output based on an exported DocBook file, you need to have XSLT processor and XSL-FO processor software @@ -11892,7 +11884,7 @@ Currently DocBook exporter only supports DocBook V5.0. ~org-export-docbook-xslt-proc-command~ and ~org-export-docbook-xsl-fo-proc-command~. - {{{vindex(org-export-docbook-xslt-stylesheet)}}} + #+vindex: org-export-docbook-xslt-stylesheet The stylesheet argument ~%s~ in variable ~org-export-docbook-xslt-proc-command~ is replaced by the value of @@ -11901,7 +11893,7 @@ Currently DocBook exporter only supports DocBook V5.0. adding an in-buffer setting ~#+XSLT:~ to the Org file. - {{{kbd(C-c C-e v D)}}} :: - {{{kindex(C-c C-e v D)}}} + #+kindex: C-c C-e v D Export only the visible part of the document. @@ -11912,14 +11904,14 @@ Currently DocBook exporter only supports DocBook V5.0. You can quote DocBook code in Org files and copy it verbatim into exported DocBook file with the following constructs: -{{{cindex(#+DOCBOOK)}}} -{{{cindex(#+BEGIN_DOCBOOK)}}} +#+cindex: #+DOCBOOK +#+cindex: #+BEGIN_DOCBOOK #+begin_example ,#+DOCBOOK: Literal DocBook code for export #+end_example {{{noindent}}} or -{{{cindex(#+BEGIN_DOCBOOK)}}} +#+cindex: #+BEGIN_DOCBOOK #+begin_example ,#+BEGIN_DOCBOOK @@ -11947,7 +11939,7 @@ exported DocBook XML files invalid by not quoting DocBook code correctly. :PROPERTIES: :DESCRIPTION: Recursive sections in DocBook :END: -{{{cindex(DocBook recursive sections)}}} +#+cindex: DocBook recursive sections DocBook exporter exports Org files as articles using the ~article~ element in DocBook. Recursive sections, i.e., ~section~ elements, are @@ -11963,7 +11955,7 @@ DocBook code in other DocBook document types like ~book~ or ~set~. :PROPERTIES: :DESCRIPTION: Tables are exported as HTML tables :END: -{{{cindex(tables\\\, in DocBook export)}}} +#+cindex: tables, in DocBook export Tables in Org files are exported as HTML tables, which have been supported since DocBook V4.3. @@ -11976,8 +11968,8 @@ generated using the ~table~ element. :PROPERTIES: :DESCRIPTION: How to insert figures into DocBook output :END: -{{{cindex(images\\\, inline in DocBook)}}} -{{{cindex(inlining images in DocBook)}}} +#+cindex: images, inline in DocBook +#+cindex: inlining images in DocBook Images that are linked to without a description part in the link, like {{{samp([[file:img.jpg]])}}} or {{{samp([[./img.jpg]])}}}, will be exported to @@ -11988,7 +11980,7 @@ tables]], a ~caption~ element will be added in ~mediaobject~. If a label is also specified, it will be exported as an ~xml:id~ attribute of the ~mediaobject~ element. -{{{vindex(org-export-docbook-default-image-attributes)}}} +#+vindex: org-export-docbook-default-image-attributes Image attributes supported by the ~imagedata~ element, like ~align~ or ~width~, can be specified in two ways: you can either customize @@ -12005,9 +11997,9 @@ variable ~org-export-docbook-default-image-attributes~, the former takes precedence. Here is an example about how image attributes can be set: -{{{cindex(#+CAPTION)}}} -{{{cindex(#+LABEL)}}} -{{{cindex(#+ATTR_DOCBOOK)}}} +#+cindex: #+CAPTION +#+cindex: #+LABEL +#+cindex: #+ATTR_DOCBOOK #+begin_example ,#+CAPTION: The logo of Org mode ,#+LABEL: unicorn-svg @@ -12015,7 +12007,7 @@ set: [[./img/org-mode-unicorn.svg]] #+end_example -{{{vindex(org-export-docbook-inline-image-extensions)}}} +#+vindex: org-export-docbook-inline-image-extensions By default, DocBook exporter recognizes the following image file types: {{{file(jpeg)}}}, {{{file(jpg)}}}, {{{file(png)}}}, @@ -12028,8 +12020,8 @@ list as long as DocBook supports them. :DESCRIPTION: How to handle special characters :TITLE: Special characters in DocBook export :END: -{{{vindex(org-export-docbook-doctype)}}} -{{{vindex(org-entities)}}} +#+vindex: org-export-docbook-doctype +#+vindex: org-entities Special characters that are written in TeX-like syntax, such as ~\alpha~, ~\Gamma~, and ~\Zeta~, are supported by DocBook exporter. @@ -12058,13 +12050,13 @@ special characters included in XHTML entities: :PROPERTIES: :DESCRIPTION: Exporting to OpenDocument Text :END: -{{{cindex(K\\\, Jambunathan)}}} -{{{cindex(ODT)}}} -{{{cindex(OpenDocument)}}} -{{{cindex(export\\\, OpenDocument)}}} -{{{cindex(LibreOffice)}}} -{{{cindex(org-odt.el)}}} -{{{cindex(org-modules)}}} +#+cindex: K, Jambunathan +#+cindex: ODT +#+cindex: OpenDocument +#+cindex: export, OpenDocument +#+cindex: LibreOffice +#+cindex: org-odt.el +#+cindex: org-modules Org Mode supports export to OpenDocument Text (ODT) format using the {{{file(org-odt.el)}}} module.[fn:131] Documents created by this @@ -12075,7 +12067,7 @@ are compatible with LibreOffice 3.4.[fn:132] :PROPERTIES: :DESCRIPTION: What packages ODT exporter relies on :END: -{{{cindex(zip)}}} +#+cindex: zip The ODT exporter relies on the {{{file(zip)}}} program to create the final output. Check the availability of this program before proceeding @@ -12088,18 +12080,18 @@ further. :END: <> -{{{cindex(region\\\, active)}}} -{{{cindex(active region)}}} -{{{cindex(transient-mark-mode)}}} +#+cindex: region, active +#+cindex: active region +#+cindex: transient-mark-mode #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e o)}}}, ~org-export-as-odt~ :: - {{{kindex(C-c C-e o)}}} - {{{cindex(property EXPORT_FILE_NAME)}}} + #+kindex: C-c C-e o + #+cindex: property EXPORT_FILE_NAME Export as OpenDocument Text file. - {{{vindex(org-export-odt-preferred-output-format)}}} + #+vindex: org-export-odt-preferred-output-format If ~org-export-odt-preferred-output-format~ is specified, automatically convert the exported file to that format. See @@ -12114,11 +12106,11 @@ further. used for the export. - {{{kbd(C-c C-e O)}}}, ~org-export-as-odt-and-open~ :: - {{{kindex(C-c C-e O)}}} + #+kindex: C-c C-e O Export as an OpenDocument Text file and open the resulting file. - {{{vindex(org-export-odt-preferred-output-format)}}} + #+vindex: org-export-odt-preferred-output-format If ~org-export-odt-preferred-output-format~ is specified, open the converted file instead. See [[x-export-to-other-formats][Automatically exporting to other formats]]. @@ -12134,8 +12126,8 @@ use it to export to formats like {{{samp(doc)}}} or convert a document from one format (say {{{samp(csv)}}}) to another format (say {{{samp(ods)}}} or {{{samp(xls)}}}). -{{{cindex(@file{unoconv})}}} -{{{cindex(LibreOffice)}}} +#+cindex: @file{unoconv} +#+cindex: LibreOffice If you have a working installation of LibreOffice, a document converter is pre-configured for you and you can use it right away. If @@ -12151,7 +12143,7 @@ default settings of the {{{file(LibreOffice)}}} and :END: <> -{{{vindex(org-export-odt-preferred-output-format)}}} +#+vindex: org-export-odt-preferred-output-format Very often, you will find yourself exporting to ODT format, only to immediately save the exported document to other formats like @@ -12176,7 +12168,7 @@ with it using the following command. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(M-x org-export-odt-convert)}}} :: - {{{vindex(org-export-odt-convert)}}} + #+vindex: org-export-odt-convert Convert an existing document from one format to another. With a prefix argument, also open the newly produced file. @@ -12185,8 +12177,8 @@ with it using the following command. :PROPERTIES: :DESCRIPTION: How to apply custom styles to the output :END: -{{{cindex(styles\\\, custom)}}} -{{{cindex(template\\\, custom)}}} +#+cindex: styles, custom +#+cindex: template, custom The ODT exporter ships with a set of OpenDocument styles (see [[Working with OpenDocument style files]]) that ensure a well-formatted output. @@ -12216,8 +12208,8 @@ Custom styles can be applied in three easy steps: the newly created file. For additional configuration options see [[x-overriding-factory-styles][Overriding factory styles]]. - {{{cindex(#+ODT_STYLES_FILE)}}} - {{{vindex(org-export-odt-styles-file)}}} + #+cindex: #+ODT_STYLES_FILE + #+vindex: org-export-odt-styles-file If you would like to choose a style on a per-file basis, you can use the ~#+ODT_STYLES_FILE~ option. A typical setting will look like @@ -12244,7 +12236,7 @@ templates that are directly derived from the factory settings. :PROPERTIES: :DESCRIPTION: How links will be interpreted and formatted :END: -{{{cindex(tables\\\, in DocBook export)}}} +#+cindex: tables, in DocBook export ODT exporter creates native cross-references for internal links. It creates Internet-style links for all other links. @@ -12262,7 +12254,7 @@ with a cross-reference and sequence number of the labeled entity. See :DESCRIPTION: How tables are exported :END: -{{{cindex(tables\\\, in DocBook export)}}} +#+cindex: tables, in DocBook export Export of native Org mode tables (see [[Tables]]) and simple {{{file(table.el)}}} tables is supported. However, export of complex @@ -12276,7 +12268,7 @@ Furthermore, all tables are typeset to occupy the same width. If the table specifies alignment and relative width for its columns (see [[Column width and alignment]]) then these are honored on export.[fn:135] -{{{cindex(#+ATTR_ODT)}}} +#+cindex: #+ATTR_ODT You can control the width of the table by specifying ~:rel-width~ property using an ~#+ATTR_ODT~ line. @@ -12312,8 +12304,8 @@ create custom table styles and associate them with a table using the :PROPERTIES: :DESCRIPTION: How to insert images :END: -{{{cindex(images\\\, embedding in ODT)}}} -{{{cindex(embedding images in ODT)}}} +#+cindex: images, embedding in ODT +#+cindex: embedding images in ODT You can embed images within the exported document by providing a link to the desired image file with no link description. For example, to embed @@ -12336,13 +12328,13 @@ is a link to an image file. For example, to embed an image [[http://orgmode.org][./org-mode-unicorn.png]] #+end_example -{{{cindex(#+ATTR_ODT)}}} +#+cindex: #+ATTR_ODT You can control the size and scale of the embedded images using the ~#+ATTR_ODT~ attribute. -{{{cindex(identify\\\, ImageMagick)}}} -{{{vindex(org-export-odt-pixels-per-inch)}}} +#+cindex: identify, ImageMagick +#+vindex: org-export-odt-pixels-per-inch The exporter specifies the desired size of the image in the final document in units of centimeters. In order to scale the embedded @@ -12396,7 +12388,7 @@ The examples below illustrate the various possibilities. [[./img.png]] #+end_example -{{{cindex(#+ATTR_ODT)}}} +#+cindex: #+ATTR_ODT You can control the manner in which an image is anchored by setting the ~:anchor~ property of it's ~#+ATTR_ODT~ line. You can specify one @@ -12425,7 +12417,7 @@ The ODT exporter has special support for handling math. LaTeX math snippets (see [[LaTeX fragments]]) can be embedded in the ODT document in one of the following ways: -{{{cindex(MathML)}}} +#+cindex: MathML #+attr_texinfo: :table-type "table" :indic "@asis" - MathML :: @@ -12440,8 +12432,8 @@ document in one of the following ways: 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)}}} + #+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 @@ -12474,7 +12466,7 @@ document in one of the following ways: system-registered application. - PNG images :: - {{{cindex(dvipng)}}} + #+cindex: dvipng This option is activated on a per-file basis with @@ -12535,7 +12527,7 @@ It could be rendered as shown below in the exported document. Figure 2: Bell curve #+end_example -{{{vindex(org-export-odt-category-strings)}}} +#+vindex: org-export-odt-category-strings You can modify the category component of the caption by customizing the variable ~org-export-odt-category-strings~. For example, to tag @@ -12568,13 +12560,13 @@ for a fancy listing.[fn:138] The auto-generated styles have {{{samp(OrgSrc)}}} as prefix and inherit their color from the faces used by Emacs ~font-lock~ library for the source language. -{{{vindex(org-export-odt-fontify-srcblocks)}}} +#+vindex: org-export-odt-fontify-srcblocks If you prefer to use your own custom styles for fontification, you can do so by customizing the variable ~org-export-odt-create-custom-styles-for-srcblocks~. -{{{vindex(org-export-odt-create-custom-styles-for-srcblocks)}}} +#+vindex: org-export-odt-create-custom-styles-for-srcblocks You can turn off fontification of literal examples by customizing the variable ~org-export-odt-fontify-srcblocks~. @@ -12592,9 +12584,9 @@ features that would be of interest to power users. :PROPERTIES: :DESCRIPTION: How to register a document converter :END: -{{{cindex(convert)}}} -{{{cindex(doc\\\, docx\\\, rtf)}}} -{{{cindex(converter)}}} +#+cindex: convert +#+cindex: doc, docx, rtf +#+cindex: converter The ODT exporter can work with popular converters with little or no extra configuration from your side. See [[Extending ODT export]]. If you @@ -12604,7 +12596,7 @@ like to tweak the default converter settings, proceed as below. #+attr_texinfo: :table-type "table" :indic "@asis" - Register the converter :: - {{{vindex(org-export-odt-convert-processes)}}} + #+vindex: org-export-odt-convert-processes Name your converter and add it to the list of known converters by customizing the variable ~org-export-odt-convert-processes~. Also @@ -12613,7 +12605,7 @@ like to tweak the default converter settings, proceed as below. - Configure its capabilities :: - {{{vindex(org-export-odt-convert-capabilities)}}} + #+vindex: org-export-odt-convert-capabilities # <> Specify the set of formats the converter can handle by customizing the @@ -12625,7 +12617,7 @@ like to tweak the default converter settings, proceed as below. - Choose the converter :: - {{{vindex(org-export-odt-convert-process)}}} + #+vindex: org-export-odt-convert-process Select the newly added converter as the preferred one by customizing the variable ~org-export-odt-convert-process~. @@ -12634,8 +12626,8 @@ like to tweak the default converter settings, proceed as below. :PROPERTIES: :DESCRIPTION: Explore the internals :END: -{{{cindex(styles\\\, custom)}}} -{{{cindex(template\\\, custom)}}} +#+cindex: styles, custom +#+cindex: template, custom This section explores the internals of the ODT exporter and the means by which it produces styled documents. Read this section if you are @@ -12788,8 +12780,8 @@ couple of examples. :PROPERTIES: :DESCRIPTION: How to define and use table templates :END: -{{{cindex(tables\\\, in ODT export)}}} -{{{cindex(#+ATTR_ODT)}}} +#+cindex: tables, in ODT export +#+cindex: #+ATTR_ODT You can override the default formatting of the table by specifying a custom table style with the ~#+ATTR_ODT~ line. For a discussion on @@ -12879,7 +12871,7 @@ To use this feature proceed as follows: - Define a table style[fn:141] :: - {{{vindex(org-export-odt-table-styles)}}} + #+vindex: org-export-odt-table-styles To define a table style, create an entry for the style in the variable ~org-export-odt-table-styles~ and specify the following: @@ -12933,7 +12925,7 @@ OpenDocument RELAX NG Compact Syntax (RNC) schema. For de-compressing the {{{file(.odt)}}} file: [[info:emacs#File%20Archives][info:emacs#File Archives]].[fn:142] For general help with validation (and schema-sensitive editing) of XML files: [[info:nxml-mode#Introduction]]. -{{{vindex(org-export-odt-schema-dir)}}} +#+vindex: org-export-odt-schema-dir If you have ready access to OpenDocument {{{file(.rnc)}}} files and the needed schema-locating rules in a single folder, you can customize @@ -12945,8 +12937,8 @@ The ODT exporter will take care of updating the :PROPERTIES: :DESCRIPTION: Exporting to TaskJuggler :END: -{{{cindex(TaskJuggler export)}}} -{{{cindex(Project management)}}} +#+cindex: TaskJuggler export +#+cindex: Project management [[http://www.taskjuggler.org/][TaskJuggler]] is a project management tool. It provides an optimizing scheduler that computes your project time lines and resource @@ -12970,12 +12962,12 @@ and the attributes defined in all the nodes. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e j)}}}, ~org-export-as-taskjuggler~ :: - {{{kindex(C-c C-e j)}}} + #+kindex: C-c C-e j Export as a TaskJuggler file. - {{{kbd(C-c C-e J)}}}, ~org-export-as-taskjuggler-and-open~ :: - {{{kindex(C-c C-e J)}}} + #+kindex: C-c C-e J Export as a TaskJuggler file and then open the file with TaskJugglerUI (only for TaskJugglerUI 2.x). @@ -12984,7 +12976,7 @@ and the attributes defined in all the nodes. :PROPERTIES: :DESCRIPTION: Marking tasks for TaskJuggler export :END: -{{{vindex(org-export-taskjuggler-project-tag)}}} +#+vindex: org-export-taskjuggler-project-tag Create your tasks as you usually do with Org mode. Assign efforts to each task using properties (it is easiest to do this in the column @@ -13001,7 +12993,7 @@ project plan and open a gantt chart in TaskJugglerUI. :PROPERTIES: :DESCRIPTION: Define TaskJuggler resources :END: -{{{vindex(org-export-taskjuggler-resource-tag)}}} +#+vindex: org-export-taskjuggler-resource-tag Next you can define resources and assign those to work on specific tasks. You can group your resources hierarchically. Tag the top node @@ -13090,7 +13082,7 @@ appending it. The following examples should illustrate this: :PROPERTIES: :DESCRIPTION: Gantt charts, etc. :END: -{{{vindex(org-export-taskjuggler-default-reports)}}} +#+vindex: org-export-taskjuggler-default-reports TaskJuggler can produce many kinds of reports (e.g., gantt chart, resource allocation, etc). The user defines what kind of reports @@ -13118,14 +13110,14 @@ For more information and examples see the Org-taskjuggler tutorial at :PROPERTIES: :DESCRIPTION: Exporting to Freemind mind maps :END: -{{{cindex(Freemind export)}}} -{{{cindex(mind map)}}} +#+cindex: Freemind export +#+cindex: mind map The Freemind exporter was written by Lennart Borgman. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e m)}}}, ~org-export-as-freemind~ :: - {{{kindex(C-c C-e m)}}} + #+kindex: C-c C-e m Export as a Freemind mind map. For an Org file {{{file(myfile.org)}}}, the Freemind file will be {{{file(myfile.mm)}}}. @@ -13134,7 +13126,7 @@ The Freemind exporter was written by Lennart Borgman. :PROPERTIES: :DESCRIPTION: Exporting to XOXO :END: -{{{cindex(XOXO export)}}} +#+cindex: XOXO export Org mode contains an exporter that produces XOXO-style output. Currently, this exporter only handles the general outline structure @@ -13142,13 +13134,13 @@ and does not interpret any additional Org mode features. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e x)}}}, ~org-export-as-xoxo~ :: - {{{kindex(C-c C-e x)}}} + #+kindex: C-c C-e x Export as an XOXO file. For an Org file {{{file(myfile.org)}}}, the XOXO file will be {{{file(myfile.html)}}}. - {{{kbd(C-c C-e v x)}}} :: - {{{kindex(C-c C-e v x)}}} + #+kindex: C-c C-e v x Export only the visible part of the document. @@ -13156,13 +13148,13 @@ and does not interpret any additional Org mode features. :PROPERTIES: :DESCRIPTION: Exporting to iCalendar format :END: -{{{cindex(iCalendar export)}}} +#+cindex: iCalendar export -{{{vindex(org-icalendar-include-todo)}}} -{{{vindex(org-icalendar-use-deadline)}}} -{{{vindex(org-icalendar-use-scheduled)}}} -{{{vindex(org-icalendar-categories)}}} -{{{vindex(org-icalendar-alarm-time)}}} +#+vindex: org-icalendar-include-todo +#+vindex: org-icalendar-use-deadline +#+vindex: org-icalendar-use-scheduled +#+vindex: org-icalendar-categories +#+vindex: org-icalendar-alarm-time Some people use Org mode for keeping track of projects, but still prefer a standard calendar application for anniversaries and @@ -13179,8 +13171,8 @@ locally defined in the heading, and the file/tree category.[fn:144] See the variable ~org-icalendar-alarm-time~ for a way to assign alarms to entries with a time. -{{{vindex(org-icalendar-store-UID)}}} -{{{cindex(property\\\, ID)}}} +#+vindex: org-icalendar-store-UID +#+cindex: property, ID The iCalendar standard requires each entry to have a globally unique identifier (UID). Org creates these identifiers during export. If you @@ -13195,33 +13187,33 @@ different instances originate. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e i)}}}, ~org-export-icalendar-this-file~ :: - {{{kindex(C-c C-e i)}}} + #+kindex: C-c C-e i Create iCalendar entries for the current file and store them in the same directory, using a file extension {{{file(.ics)}}}. - {{{kbd(C-c C-e I)}}}, ~ org-export-icalendar-all-agenda-files~ :: - {{{kindex(C-c C-e I)}}} - {{{vindex(org-agenda-files)}}} + #+kindex: C-c C-e I + #+vindex: org-agenda-files Like {{{kbd(C-c C-e i)}}}, but do this for all files in ~org-agenda-files~. For each of these files, a separate iCalendar file will be written. - {{{kbd(C-c C-e c)}}}, ~org-export-icalendar-combine-agenda-files~ :: - {{{kindex(C-c C-e c)}}} - {{{vindex(org-combined-agenda-icalendar-file)}}} + #+kindex: C-c C-e c + #+vindex: org-combined-agenda-icalendar-file Create a single large iCalendar file from all files in ~org-agenda-files~ and write it to the file given by ~org-combined-agenda-icalendar-file~. -{{{vindex(org-use-property-inheritance)}}} -{{{vindex(org-icalendar-include-body)}}} -{{{cindex(property\\\, SUMMARY)}}} -{{{cindex(property\\\, DESCRIPTION)}}} -{{{cindex(property\\\, LOCATION)}}} +#+vindex: org-use-property-inheritance +#+vindex: org-icalendar-include-body +#+cindex: property, SUMMARY +#+cindex: property, DESCRIPTION +#+cindex: property, LOCATION The export will honor SUMMARY, DESCRIPTION and LOCATION properties if the selected entries have them.[fn:145] If not, the summary will be @@ -13235,8 +13227,8 @@ you are using. The FAQ covers this issue. :PROPERTIES: :DESCRIPTION: Create a web site of linked Org files :END: -{{{cindex(publishing)}}} -{{{cindex(O'Toole\\\, David)}}} +#+cindex: publishing +#+cindex: O'Toole, David Org includes a publishing management system that allows you to configure automatic HTML conversion of /projects/ composed of @@ -13262,9 +13254,9 @@ destination and many other properties of a project. :DESCRIPTION: The central configuration variable :TITLE: The variable ~org-publish-project-alist~ :END: -{{{cindex(org-publish-project-alist)}}} -{{{cindex(projects\\\, for publishing)}}} -{{{vindex(org-publish-project-alist)}}} +#+cindex: org-publish-project-alist +#+cindex: projects, for publishing +#+vindex: org-publish-project-alist Publishing is configured almost entirely through setting the value of one variable, called ~org-publish-project-alist~. Each element of the @@ -13300,7 +13292,7 @@ published, in the sequence given. :DESCRIPTION: From here to there :TITLE: Sources and destinations for files :END: -{{{cindex(directories\\\, for publishing)}}} +#+cindex: directories, for publishing Most properties are optional, but some should always be set. In particular, Org needs to know where to look for source files, and @@ -13337,7 +13329,7 @@ where to put published files. :PROPERTIES: :DESCRIPTION: What files are part of the project? :END: -{{{cindex(files\\\, selecting for publishing)}}} +#+cindex: files, selecting for publishing By default, all files with extension {{{file(.org)}}} in the base directory are considered part of the project. This can be modified by setting the @@ -13368,7 +13360,7 @@ following properties: :PROPERTIES: :DESCRIPTION: Setting the function doing the publishing :END: -{{{cindex(action\\\, for publishing)}}} +#+cindex: action, for publishing Publishing means that a file is copied to the destination directory and possibly transformed in the process. The default transformation is to export @@ -13411,7 +13403,7 @@ folder. :PROPERTIES: :DESCRIPTION: Tweaking HTML/LaTeX export :END: -{{{cindex(options\\\, for publishing)}}} +#+cindex: options, for publishing The property list can be used to set many export options for the HTML and LaTeX exporters. In most cases, these properties correspond to user @@ -13419,54 +13411,54 @@ variables in Org. The table below lists these properties along with the variable they belong to. See the documentation string for the respective variable for details. -{{{vindex(org-export-html-link-up)}}} -{{{vindex(org-export-html-link-home)}}} -{{{vindex(org-export-default-language)}}} -{{{vindex(org-display-custom-times)}}} -{{{vindex(org-export-headline-levels)}}} -{{{vindex(org-export-with-section-numbers)}}} -{{{vindex(org-export-section-number-format)}}} -{{{vindex(org-export-with-toc)}}} -{{{vindex(org-export-preserve-breaks)}}} -{{{vindex(org-export-with-archived-trees)}}} -{{{vindex(org-export-with-emphasize)}}} -{{{vindex(org-export-with-sub-superscripts)}}} -{{{vindex(org-export-with-special-strings)}}} -{{{vindex(org-export-with-footnotes)}}} -{{{vindex(org-export-with-drawers)}}} -{{{vindex(org-export-with-tags)}}} -{{{vindex(org-export-with-todo-keywords)}}} -{{{vindex(org-export-with-tasks)}}} -{{{vindex(org-export-with-done-tasks)}}} -{{{vindex(org-export-with-priority)}}} -{{{vindex(org-export-with-TeX-macros)}}} -{{{vindex(org-export-with-LaTeX-fragments)}}} -{{{vindex(org-export-skip-text-before-1st-heading)}}} -{{{vindex(org-export-with-fixed-width)}}} -{{{vindex(org-export-with-timestamps)}}} -{{{vindex(org-export-author-info)}}} -{{{vindex(org-export-email-info)}}} -{{{vindex(org-export-creator-info)}}} -{{{vindex(org-export-time-stamp-file)}}} -{{{vindex(org-export-with-tables)}}} -{{{vindex(org-export-highlight-first-table-line)}}} -{{{vindex(org-export-html-style-include-default)}}} -{{{vindex(org-export-html-style-include-scripts)}}} -{{{vindex(org-export-html-style)}}} -{{{vindex(org-export-html-style-extra)}}} -{{{vindex(org-export-html-link-org-files-as-html)}}} -{{{vindex(org-export-html-inline-images)}}} -{{{vindex(org-export-html-extension)}}} -{{{vindex(org-export-html-table-tag)}}} -{{{vindex(org-export-html-expand)}}} -{{{vindex(org-export-html-with-timestamp)}}} -{{{vindex(org-export-publishing-directory)}}} -{{{vindex(org-export-html-preamble)}}} -{{{vindex(org-export-html-postamble)}}} -{{{vindex(user-full-name)}}} -{{{vindex(user-mail-address)}}} -{{{vindex(org-export-select-tags)}}} -{{{vindex(org-export-exclude-tags)}}} +#+vindex: org-export-html-link-up +#+vindex: org-export-html-link-home +#+vindex: org-export-default-language +#+vindex: org-display-custom-times +#+vindex: org-export-headline-levels +#+vindex: org-export-with-section-numbers +#+vindex: org-export-section-number-format +#+vindex: org-export-with-toc +#+vindex: org-export-preserve-breaks +#+vindex: org-export-with-archived-trees +#+vindex: org-export-with-emphasize +#+vindex: org-export-with-sub-superscripts +#+vindex: org-export-with-special-strings +#+vindex: org-export-with-footnotes +#+vindex: org-export-with-drawers +#+vindex: org-export-with-tags +#+vindex: org-export-with-todo-keywords +#+vindex: org-export-with-tasks +#+vindex: org-export-with-done-tasks +#+vindex: org-export-with-priority +#+vindex: org-export-with-TeX-macros +#+vindex: org-export-with-LaTeX-fragments +#+vindex: org-export-skip-text-before-1st-heading +#+vindex: org-export-with-fixed-width +#+vindex: org-export-with-timestamps +#+vindex: org-export-author-info +#+vindex: org-export-email-info +#+vindex: org-export-creator-info +#+vindex: org-export-time-stamp-file +#+vindex: org-export-with-tables +#+vindex: org-export-highlight-first-table-line +#+vindex: org-export-html-style-include-default +#+vindex: org-export-html-style-include-scripts +#+vindex: org-export-html-style +#+vindex: org-export-html-style-extra +#+vindex: org-export-html-link-org-files-as-html +#+vindex: org-export-html-inline-images +#+vindex: org-export-html-extension +#+vindex: org-export-html-table-tag +#+vindex: org-export-html-expand +#+vindex: org-export-html-with-timestamp +#+vindex: org-export-publishing-directory +#+vindex: org-export-html-preamble +#+vindex: org-export-html-postamble +#+vindex: user-full-name +#+vindex: user-mail-address +#+vindex: org-export-select-tags +#+vindex: org-export-exclude-tags #+attr_texinfo: :table-type "table" :indic "@asis" - ~:link-up~ :: ~org-export-html-link-up~ @@ -13525,7 +13517,7 @@ HTML and LaTeX exporters, except for ~:TeX-macros~ and ~:LaTeX-fragments~ options, respectively ~nil~ and ~t~ in the LaTeX export. See ~org-export-plist-vars~ to check this list of options. -{{{vindex(org-publish-project-alist)}}} +#+vindex: org-publish-project-alist When a property is given a value in ~org-publish-project-alist~, its setting overrides the value of the corresponding user variable (if @@ -13536,7 +13528,7 @@ options]]), however, override everything. :PROPERTIES: :DESCRIPTION: Which links keep working after publishing? :END: -{{{cindex(links\\\, publishing)}}} +#+cindex: links, publishing To create a link from one Org file to another, you would use something like ~[[file:foo.org][The foo]]~ or simply ~[[file:foo.org]]~ (see @@ -13576,7 +13568,7 @@ which checks if the given file is part of any project in :DESCRIPTION: Generating a list of all pages :TITLE: Generating a sitemap :END: -{{{cindex(sitemap\\\, of published pages)}}} +#+cindex: sitemap, of published pages The following properties may be used to control publishing of a map of files for a given project. @@ -13646,7 +13638,7 @@ a map of files for a given project. :PROPERTIES: :DESCRIPTION: An index that reaches across pages :END: -{{{cindex(index\\\, in a publishing project)}}} +#+cindex: index, in a publishing project Org mode can generate an index across the files of a publishing project. @@ -13666,8 +13658,8 @@ include statement by adding a title, style information, etc. :PROPERTIES: :DESCRIPTION: How to get files up on the server :END: -{{{cindex(rsync)}}} -{{{cindex(unison)}}} +#+cindex: rsync +#+cindex: unison For those people already utilizing third party sync tools such as {{{command(rsync)}}} or {{{command(unison)}}}, it might be preferable @@ -13793,27 +13785,27 @@ Once properly configured, Org can publish with the following commands: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-e X)}}}, ~org-publish~ :: - {{{kindex(C-c C-e X)}}} + #+kindex: C-c C-e X 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)}}} + #+kindex: C-c C-e P Publish the project containing the current file. - {{{kbd(C-c C-e F)}}}, ~org-publish-current-file~ :: - {{{kindex(C-c C-e F)}}} + #+kindex: C-c C-e F Publish only the current file. - {{{kbd(C-c C-e E)}}}, ~org-publish-all~ :: - {{{kindex(C-c C-e E)}}} + #+kindex: C-c C-e E Publish every project. -{{{vindex(org-publish-use-timestamps-flag)}}} +#+vindex: org-publish-use-timestamps-flag Org uses timestamps to track when a file has changed. The above functions normally only publish changed files. You can override this @@ -13827,9 +13819,9 @@ if files include other files via ~#+SETUPFILE:~ or ~#+INCLUDE:~. :DESCRIPTION: Export, evaluate, and tangle code blocks :OPTIONAL_TITLE: Working With Source Code :END: -{{{cindex(Schulte\\\, Eric)}}} -{{{cindex(Davison\\\, Dan)}}} -{{{cindex(source code\\\, working with)}}} +#+cindex: Schulte, Eric +#+cindex: Davison, Dan +#+cindex: source code, working with Source code can be included in Org mode documents using a {{{samp(src)}}} block, e.g.: @@ -13856,10 +13848,10 @@ The following sections describe Org mode's code block handling facilities. :PROPERTIES: :DESCRIPTION: Code block syntax described :END: -{{{cindex(code block\\\, structure)}}} -{{{cindex(source code\\\, block structure)}}} -{{{cindex(#+NAME)}}} -{{{cindex(#+BEGIN_SRC)}}} +#+cindex: code block, structure +#+cindex: source code, block structure +#+cindex: #+NAME +#+cindex: #+BEGIN_SRC Live code blocks can be specified with a {{{samp(src)}}} block or inline.[fn:147] The structure of a {{{samp(src)}}} block is shown in @@ -13875,7 +13867,7 @@ the following example: The ~#+NAME:~ line is optional, and can be used to name the code block. Live code blocks require that a language be specified on the ~#+BEGIN_SRC~ line. Switches and header arguments are optional. -{{{cindex(source code\\\, inline)}}} +#+cindex: source code, inline Live code blocks can also be specified inline using the following syntax: @@ -13892,7 +13884,7 @@ or #+attr_texinfo: :table-type "table" :indic "@asis" - ~<#+NAME: name>~ :: - {{{cindex(#+NAME)}}} + #+cindex: #+NAME This line associates a name with the code block. This is similar to the ~#+TBLNAME: NAME~ lines that can be used to name tables in Org @@ -13903,18 +13895,18 @@ or share the same name is undefined. - ~~ :: - {{{cindex(source code\\\, language)}}} + #+cindex: source code, language The language of the code in the block (see [[Languages]]). - ~~ :: - {{{cindex(source code\\\, switches)}}} + #+cindex: source code, switches Optional switches control code block export (see the discussion of switches in [[Literal examples]]). - ~
~ :: - {{{cindex(source code\\\, header arguments)}}} + #+cindex: source code, header arguments Optional header arguments control many aspects of evaluation, export and tangling of code blocks (see [[Header arguments]]). Header arguments @@ -13928,9 +13920,9 @@ or :PROPERTIES: :DESCRIPTION: Language major-mode editing :END: -{{{cindex(code block\\\, editing)}}} -{{{cindex(source code\\\, editing)}}} -{{{kindex(C-c ')}}} +#+cindex: code block, editing +#+cindex: source code, editing +#+kindex: C-c ' Use {{{kbd(C-c ')}}} to edit the current code block. This brings up a language major-mode edit buffer containing the body of the code block. @@ -13973,8 +13965,8 @@ the variable ~org-src-fontify-natively~. :PROPERTIES: :DESCRIPTION: Export contents and/or results :END: -{{{cindex(code block\\\, exporting)}}} -{{{cindex(source code\\\, exporting)}}} +#+cindex: code block, exporting +#+cindex: source code, exporting It is possible to export the /code/ of code blocks, the /results/ of code block evaluation, /both/ the code and the results of code block @@ -14020,9 +14012,9 @@ used as the markup language for a wiki. :PROPERTIES: :DESCRIPTION: Create pure source code files :END: -{{{cindex(tangling)}}} -{{{cindex(source code\\\, extracting)}}} -{{{cindex(code block\\\, extracting source code)}}} +#+cindex: tangling +#+cindex: source code, extracting +#+cindex: code block, extracting source code Creating pure source code files by extracting code from source blocks is referred to as "tangling"---a term adopted from the literate @@ -14049,14 +14041,14 @@ variable and ``noweb'' style references (see [[Noweb reference syntax]]). *** Functions for tangling #+attr_texinfo: :table-type "table" :indic "@asis" - ~org-babel-tangle~ :: - {{{kindex(C-c C-v t)}}} + #+kindex: C-c C-v t Tangle the current file. Bound to {{{kbd(C-c C-v t)}}}. With a prefix argument only tangle the current code block. - ~org-babel-tangle-file~ :: - {{{kindex(C-c C-v f)}}} + #+kindex: C-c C-v f Choose a file to tangle. Bound to {{{kbd(C-c C-v f)}}}. @@ -14072,9 +14064,9 @@ variable and ``noweb'' style references (see [[Noweb reference syntax]]). :PROPERTIES: :DESCRIPTION: Place results in the Org buffer :END: -{{{cindex(code block\\\, evaluating)}}} -{{{cindex(source code\\\, evaluating)}}} -{{{cindex(#+RESULTS)}}} +#+cindex: code block, evaluating +#+cindex: source code, evaluating +#+cindex: #+RESULTS Code blocks can be evaluated and the results of evaluation optionally placed in the Org mode buffer.[fn:148] The results of evaluation are @@ -14089,8 +14081,8 @@ languages can be evaluated within Org mode (see [[Languages]] for a list of supported languages and [[Structure of code blocks]] for information on the syntax used to define a code block). -{{{kindex(C-c C-c)}}} -{{{kindex(C-c C-v e)}}} +#+kindex: C-c C-c +#+kindex: C-c C-v e There are a number of ways to evaluate code blocks. The simplest is to press {{{kbd(C-c C-c)}}} or {{{kbd(C-c C-v e)}}} with the point on a @@ -14098,7 +14090,7 @@ code block.[fn:149] This will call the ~org-babel-execute-src-block~ function to evaluate the block and insert its results into the Org mode buffer. -{{{cindex(#+CALL)}}} +#+cindex: #+CALL It is also possible to evaluate named code blocks from anywhere in an Org mode buffer or an Org mode table. Live code blocks located in the @@ -14160,9 +14152,9 @@ For more examples of passing header arguments to ~#+CALL:~ lines see :PROPERTIES: :DESCRIPTION: Use and contribute to a source code library :END: -{{{cindex(babel\\\, library of)}}} -{{{cindex(source code\\\, library)}}} -{{{cindex(code block\\\, library)}}} +#+cindex: babel, library of +#+cindex: source code, library +#+cindex: code block, library The ``Library of Babel'' consists of code blocks that can be called from any Org mode file. Code blocks defined in the ``Library of @@ -14179,7 +14171,7 @@ Users can add code blocks they believe to be generally useful to their ``Library of Babel.'' The code blocks can be stored in any Org mode file and then loaded into the library with ~org-babel-lob-ingest~. -{{{kindex(C-c C-v i)}}} +#+kindex: C-c C-v i Code blocks located in any Org mode file can be loaded into the ``Library of Babel'' with the ~org-babel-lob-ingest~ function, bound @@ -14189,9 +14181,9 @@ to {{{kbd(C-c C-v i)}}}. :PROPERTIES: :DESCRIPTION: Supported code block languages :END: -{{{cindex(babel\\\, languages)}}} -{{{cindex(source code\\\, languages)}}} -{{{cindex(code block\\\, languages)}}} +#+cindex: babel, languages +#+cindex: source code, languages +#+cindex: code block, languages Code blocks in the following languages are supported. @@ -14253,8 +14245,8 @@ related elisp file with ~require~. :PROPERTIES: :DESCRIPTION: Configure code block functionality :END: -{{{cindex(code block\\\, header arguments)}}} -{{{cindex(source code\\\, block header arguments)}}} +#+cindex: code block, header arguments +#+cindex: source code, block header arguments Code block functionality can be configured with header arguments. This section provides an overview of the use of header arguments, and then @@ -14272,7 +14264,7 @@ more specific (and having higher priority) than the last. :PROPERTIES: :DESCRIPTION: Set global default values :END: -{{{vindex(org-babel-default-header-args)}}} +#+vindex: org-babel-default-header-args System-wide values of header arguments can be specified by customizing the ~org-babel-default-header-args~ variable: @@ -14354,7 +14346,7 @@ is as follows: ,#+PROPERTY: tangle yes #+end_example -{{{vindex(org-use-property-inheritance)}}} +#+vindex: org-use-property-inheritance When properties are used to set default header arguments, they are looked up with inheritance, regardless of the value of @@ -14369,8 +14361,8 @@ in the subtree rooted at the following heading: ,:END: #+end_example -{{{kindex(C-c C-x p)}}} -{{{vindex(org-babel-default-header-args)}}} +#+kindex: C-c C-x p +#+vindex: org-babel-default-header-args Properties defined in this way override the properties set in ~org-babel-default-header-args~. It is convenient to use the @@ -14411,8 +14403,8 @@ Code block header arguments can span multiple lines using ~#+HEADER:~ or ~#+HEADERS:~ lines preceding a code block or nested between the ~#+NAME:~ line and the ~#+BEGIN_SRC~ line of a named code block. -{{{cindex(#+HEADER:)}}} -{{{cindex(#+HEADERS:)}}} +#+cindex: #+HEADER: +#+cindex: #+HEADERS: This is an example of multi-line header arguments on an un-named code block: @@ -15326,7 +15318,7 @@ changed since it was last run. :PROPERTIES: :DESCRIPTION: Delimiter for writing tabular results outside Org :END: -{{{kindex(C-c C-o)}}} +#+kindex: C-c C-o The ~:sep~ header argument can be used to control the delimiter used when writing tabular results out to files external to Org mode. This @@ -15548,8 +15540,8 @@ wrapped in a ~#+BEGIN/END_RESULTS~ block. :PROPERTIES: :DESCRIPTION: How evaluation results are handled :END: -{{{cindex(code block\\\, results of evaluation)}}} -{{{cindex(source code\\\, results of evaluation)}}} +#+cindex: code block, results of evaluation +#+cindex: source code, results of evaluation The way in which results are handled depends on whether a session is invoked, as well as on whether ~:results value~ or ~:results output~ @@ -15650,9 +15642,9 @@ two-dimensional vector of strings or numbers) when appropriate. :PROPERTIES: :DESCRIPTION: Literate programming in Org mode :END: -{{{cindex(code block\\\, noweb reference)}}} -{{{cindex(syntax\\\, noweb)}}} -{{{cindex(source code\\\, noweb reference)}}} +#+cindex: code block, noweb reference +#+cindex: syntax, noweb +#+cindex: source code, noweb reference The ``noweb'' (see [[http://www.cs.tufts.edu/~nr/noweb/]]) Literate Programming system allows named blocks of code to be referenced using @@ -15694,17 +15686,17 @@ expense of not correctly resolving inherited values of the :PROPERTIES: :DESCRIPTION: Work quickly with code blocks :END: -{{{cindex(code block\\\, key bindings)}}} +#+cindex: code block, key bindings Many common Org mode key sequences are re-bound depending on the context. Within a code block, the following key bindings are active: -{{{kindex(C-c C-c)}}} -{{{kindex(C-c C-o)}}} -{{{kindex(C-up)}}} -{{{kindex(M-down)}}} +#+kindex: C-c C-c +#+kindex: C-c C-o +#+kindex: C-up +#+kindex: M-down #+attr_texinfo: :columns "0.2 0.55" | Key binding | Function | @@ -15717,50 +15709,50 @@ are active: In an Org mode buffer, the following key bindings are active: -{{{kindex(C-c C-v p)}}} -{{{kindex(C-c C-v C-p)}}} -{{{kindex(C-c C-v n)}}} -{{{kindex(C-c C-v C-n)}}} -{{{kindex(C-c C-v e)}}} -{{{kindex(C-c C-v C-e)}}} -{{{kindex(C-c C-v o)}}} -{{{kindex(C-c C-v C-o)}}} -{{{kindex(C-c C-v v)}}} -{{{kindex(C-c C-v C-v)}}} -{{{kindex(C-c C-v u)}}} -{{{kindex(C-c C-v C-u)}}} -{{{kindex(C-c C-v g)}}} -{{{kindex(C-c C-v C-g)}}} -{{{kindex(C-c C-v r)}}} -{{{kindex(C-c C-v C-r)}}} -{{{kindex(C-c C-v b)}}} -{{{kindex(C-c C-v C-b)}}} -{{{kindex(C-c C-v s)}}} -{{{kindex(C-c C-v C-s)}}} -{{{kindex(C-c C-v d)}}} -{{{kindex(C-c C-v C-d)}}} -{{{kindex(C-c C-v t)}}} -{{{kindex(C-c C-v C-t)}}} -{{{kindex(C-c C-v f)}}} -{{{kindex(C-c C-v C-f)}}} -{{{kindex(C-c C-v c)}}} -{{{kindex(C-c C-v C-c)}}} -{{{kindex(C-c C-v j)}}} -{{{kindex(C-c C-v C-j)}}} -{{{kindex(C-c C-v l)}}} -{{{kindex(C-c C-v C-l)}}} -{{{kindex(C-c C-v i)}}} -{{{kindex(C-c C-v C-i)}}} -{{{kindex(C-c C-v I)}}} -{{{kindex(C-c C-v C-I)}}} -{{{kindex(C-c C-v z)}}} -{{{kindex(C-c C-v C-z)}}} -{{{kindex(C-c C-v a)}}} -{{{kindex(C-c C-v C-a)}}} -{{{kindex(C-c C-v h)}}} -{{{kindex(C-c C-v C-h)}}} -{{{kindex(C-c C-v x)}}} -{{{kindex(C-c C-v C-x)}}} +#+kindex: C-c C-v p +#+kindex: C-c C-v C-p +#+kindex: C-c C-v n +#+kindex: C-c C-v C-n +#+kindex: C-c C-v e +#+kindex: C-c C-v C-e +#+kindex: C-c C-v o +#+kindex: C-c C-v C-o +#+kindex: C-c C-v v +#+kindex: C-c C-v C-v +#+kindex: C-c C-v u +#+kindex: C-c C-v C-u +#+kindex: C-c C-v g +#+kindex: C-c C-v C-g +#+kindex: C-c C-v r +#+kindex: C-c C-v C-r +#+kindex: C-c C-v b +#+kindex: C-c C-v C-b +#+kindex: C-c C-v s +#+kindex: C-c C-v C-s +#+kindex: C-c C-v d +#+kindex: C-c C-v C-d +#+kindex: C-c C-v t +#+kindex: C-c C-v C-t +#+kindex: C-c C-v f +#+kindex: C-c C-v C-f +#+kindex: C-c C-v c +#+kindex: C-c C-v C-c +#+kindex: C-c C-v j +#+kindex: C-c C-v C-j +#+kindex: C-c C-v l +#+kindex: C-c C-v C-l +#+kindex: C-c C-v i +#+kindex: C-c C-v C-i +#+kindex: C-c C-v I +#+kindex: C-c C-v C-I +#+kindex: C-c C-v z +#+kindex: C-c C-v C-z +#+kindex: C-c C-v a +#+kindex: C-c C-v C-a +#+kindex: C-c C-v h +#+kindex: C-c C-v C-h +#+kindex: C-c C-v x +#+kindex: C-c C-v C-x #+attr_texinfo: :columns "0.4 0.6" | Key binding | Function | @@ -15807,8 +15799,8 @@ In an Org mode buffer, the following key bindings are active: :PROPERTIES: :DESCRIPTION: Call functions from the command line :END: -{{{cindex(code block\\\, batch execution)}}} -{{{cindex(source code\\\, batch execution)}}} +#+cindex: code block, batch execution +#+cindex: source code, batch execution It is possible to call functions from the command line. This shell script calls ~org-babel-tangle~ on every one of its arguments. @@ -15849,19 +15841,19 @@ Be sure to adjust the paths to fit your system. :PROPERTIES: :DESCRIPTION: M-TAB knows what you need :END: -{{{cindex(completion\\\, of @TeX{} symbols)}}} -{{{cindex(completion\\\, of TODO keywords)}}} -{{{cindex(completion\\\, of dictionary words)}}} -{{{cindex(completion\\\, of option keywords)}}} -{{{cindex(completion\\\, of tags)}}} -{{{cindex(completion\\\, of property keys)}}} -{{{cindex(completion\\\, of link abbreviations)}}} -{{{cindex(@TeX{} symbol completion)}}} -{{{cindex(TODO keywords completion)}}} -{{{cindex(dictionary word completion)}}} -{{{cindex(option keyword completion)}}} -{{{cindex(tag completion)}}} -{{{cindex(link abbreviations\\\, completion of)}}} +#+cindex: completion, of @TeX{} symbols +#+cindex: completion, of TODO keywords +#+cindex: completion, of dictionary words +#+cindex: completion, of option keywords +#+cindex: completion, of tags +#+cindex: completion, of property keys +#+cindex: completion, of link abbreviations +#+cindex: @TeX{} symbol completion +#+cindex: TODO keywords completion +#+cindex: dictionary word completion +#+cindex: option keyword completion +#+cindex: tag completion +#+cindex: link abbreviations, completion of Emacs would not be Emacs without completion, and Org mode uses it whenever it makes sense. If you prefer an iswitchb- or ido-like @@ -15875,7 +15867,7 @@ buffer and use the {{{key(TAB)}}} key to complete text right there. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbdkey(M-,TAB)}}} :: - {{{kindex(M-@key{TAB})}}} + #+kindex: M-@key{TAB} Complete word at point. @@ -15931,8 +15923,8 @@ buffer and use the {{{key(TAB)}}} key to complete text right there. :PROPERTIES: :DESCRIPTION: Quick insertion of structural elements :END: -{{{cindex(template insertion)}}} -{{{cindex(insertion\\\, of templates)}}} +#+cindex: template insertion +#+cindex: insertion, of templates Org mode supports insertion of empty structural elements (like ~#+BEGIN_SRC~ and ~#+END_SRC~ pairs) with just a few key strokes. This @@ -15945,19 +15937,19 @@ template selector and {{{kbdkey(,TAB)}}}. Completion takes effect only when the above keystrokes are typed on a line by itself. The following template selectors are currently supported: -{{{kindex(s)}}} -{{{kindex(e)}}} -{{{kindex(q)}}} -{{{kindex(v)}}} -{{{kindex(c)}}} -{{{kindex(l)}}} -{{{kindex(L)}}} -{{{kindex(h)}}} -{{{kindex(H)}}} -{{{kindex(a)}}} -{{{kindex(A)}}} -{{{kindex(i)}}} -{{{kindex(I)}}} +#+kindex: s +#+kindex: e +#+kindex: q +#+kindex: v +#+kindex: c +#+kindex: l +#+kindex: L +#+kindex: h +#+kindex: H +#+kindex: a +#+kindex: A +#+kindex: i +#+kindex: I #+attr_texinfo: :columns "0.2 0.7" | Selector | Template | @@ -15987,9 +15979,9 @@ additional details. :PROPERTIES: :DESCRIPTION: Electric commands at the beginning of a headline :END: -{{{cindex(speed keys)}}} -{{{vindex(org-use-speed-commands)}}} -{{{vindex(org-speed-commands-user)}}} +#+cindex: speed keys +#+vindex: org-use-speed-commands +#+vindex: org-speed-commands-user Single keys can be made to execute commands when the cursor is at the beginning of a headline, i.e., before the first star. Configure the @@ -16079,9 +16071,9 @@ Code evaluation can happen under the following circumstances: :PROPERTIES: :DESCRIPTION: Adapting Org to your taste :END: -{{{cindex(customization)}}} -{{{cindex(options\\\, for customization)}}} -{{{cindex(variables\\\, for customization)}}} +#+cindex: customization +#+cindex: options, for customization +#+cindex: variables, for customization There are more than 500 variables that can be used to customize Org. For the sake of compactness of the manual, I am not describing the @@ -16096,8 +16088,8 @@ buffer (see [[In-buffer settings]]). :DESCRIPTION: Overview of the #+KEYWORDS :TITLE: Summary of in-buffer settings :END: -{{{cindex(in-buffer settings)}}} -{{{cindex(special keywords)}}} +#+cindex: in-buffer settings +#+cindex: special keywords Org mode uses special lines in the buffer to define settings on a per-file basis. These lines start with a {{{samp(#+)}}} followed by a @@ -16109,7 +16101,7 @@ lines in the buffer, press {{{kbd(C-c C-c)}}} with the cursor still in the line to activate the changes immediately. Otherwise they become effective only when the file is visited again in a new Emacs session. -{{{vindex(org-archive-location)}}} +#+vindex: org-archive-location #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(#+ARCHIVE: %s_done)}}} :: @@ -16126,15 +16118,15 @@ effective only when the file is visited again in a new Emacs session. before it. - {{{kbd(#+COLUMNS: %25ITEM ...)}}} :: - {{{cindex(property\\\, COLUMNS)}}} + #+cindex: property, COLUMNS Set the default format for columns view. This format applies when columns view is invoked in locations where no ~COLUMNS~ property applies. - {{{kbd(#+CONSTANTS: name1=value1 ...)}}} :: - {{{vindex(org-table-formula-constants)}}} - {{{vindex(org-table-formula)}}} + #+vindex: org-table-formula-constants + #+vindex: org-table-formula Set file-local values for constants to be used in table formulas. This line sets the local variable ~org-table-formula-constants-local~. The @@ -16146,21 +16138,21 @@ effective only when the file is visited again in a new Emacs session. top-level entries. - {{{kbd(#+DRAWERS: NAME1 ...)}}} :: - {{{vindex(org-drawers)}}} + #+vindex: org-drawers Set the file-local set of additional drawers. The corresponding global variable is ~org-drawers~. - {{{kbd(#+LINK: linkword replace)}}} :: - {{{vindex(org-link-abbrev-alist)}}} + #+vindex: org-link-abbrev-alist These lines (several are allowed) specify link abbreviations. See [[Link abbreviations]]. The corresponding variable is ~org-link-abbrev-alist~. - {{{kbd(#+PRIORITIES: highest lowest default)}}} :: - {{{vindex(org-highest-priority)}}} - {{{vindex(org-lowest-priority)}}} - {{{vindex(org-default-priority)}}} + #+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 @@ -16172,7 +16164,7 @@ effective only when the file is visited again in a new Emacs session. buffer, most useful for specifying the allowed values of a property. - {{{kbd(#+SETUPFILE: file)}}} :: - {{{cindex(#+SETUPFILE)}}} + #+cindex: #+SETUPFILE This line defines a file that holds more in-buffer setup. Normally this is entirely ignored. Only when the buffer is parsed for @@ -16184,7 +16176,7 @@ effective only when the file is visited again in a new Emacs session. with {{{kbd(C-c ')}}}. - {{{kbd(#+STARTUP:)}}} :: - {{{cindex(#+STARTUP:)}}} + #+cindex: #+STARTUP: This line sets options to be used at startup of Org mode, when an Org file is being visited. @@ -16194,11 +16186,11 @@ effective only when the file is visited again in a new Emacs session. is ~org-startup-folded~, with a default value ~t~, which means ~overview~. - {{{vindex(org-startup-folded)}}} - {{{cindex(@code{overview}\\\, STARTUP keyword)}}} - {{{cindex(@code{content}\\\, STARTUP keyword)}}} - {{{cindex(@code{showall}\\\, STARTUP keyword)}}} - {{{cindex(@code{showeverything}\\\, STARTUP keyword)}}} + #+vindex: org-startup-folded + #+cindex: @code{overview}, STARTUP keyword + #+cindex: @code{content}, STARTUP keyword + #+cindex: @code{showall}, STARTUP keyword + #+cindex: @code{showeverything}, STARTUP keyword #+attr_texinfo: :table-type "table" :indic "@asis" - ~overview~ :: top-level headlines only @@ -16206,9 +16198,9 @@ effective only when the file is visited again in a new Emacs session. - ~showall~ :: no folding of any entries - ~showeverything~ :: show even drawer contents - {{{vindex(org-startup-indented)}}} - {{{cindex(@code{indent}\\\, STARTUP keyword)}}} - {{{cindex(@code{noindent}\\\, STARTUP keyword)}}} + #+vindex: org-startup-indented + #+cindex: @code{indent}, STARTUP keyword + #+cindex: @code{noindent}, STARTUP keyword Dynamic virtual indentation is controlled by the variable ~org-startup-indented~.[fn:182] @@ -16217,58 +16209,58 @@ effective only when the file is visited again in a new Emacs session. - ~indent~ :: start with ~org-indent-mode~ turned on - ~noindent~ :: start with ~org-indent-mode~ turned off - {{{vindex(org-startup-align-all-tables)}}} + #+vindex: org-startup-align-all-tables Then there are options for aligning tables upon visiting a file. This is useful in files containing narrowed table columns. The corresponding variable is ~org-startup-align-all-tables~, with a default value ~nil~. - {{{cindex(@code{align}\\\, STARTUP keyword)}}} - {{{cindex(@code{noalign}\\\, STARTUP keyword)}}} + {{{cindex: @co#+align}, STARTUP keyword + {{{cindex: @co#+noalign}, STARTUP keyword #+attr_texinfo: :table-type "table" :indic "@asis" - ~align~ :: align all tables - ~noalign~ :: don't align tables on startup - {{{vindex(org-startup-with-inline-images)}}} + #+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. - {{{cindex(@code{inlineimages}\\\, STARTUP keyword)}}} - {{{cindex(@code{noinlineimages}\\\, STARTUP keyword)}}} + #+cindex: @code{inlineimages}, STARTUP keyword + #+cindex: @code{noinlineimages}, STARTUP keyword #+attr_texinfo: :table-type "table" :indic "@asis" - ~inlineimages~ show inline images - ~noinlineimages~ don't show inline images on startup - {{{vindex(org-log-done)}}} - {{{vindex(org-log-note-clock-out)}}} - {{{vindex(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~). - {{{cindex(@code{logdone}\\\, STARTUP keyword)}}} - {{{cindex(@code{lognotedone}\\\, STARTUP keyword)}}} - {{{cindex(@code{nologdone}\\\, STARTUP keyword)}}} - {{{cindex(@code{lognoteclock-out}\\\, STARTUP keyword)}}} - {{{cindex(@code{nolognoteclock-out}\\\, STARTUP keyword)}}} - {{{cindex(@code{logrepeat}\\\, STARTUP keyword)}}} - {{{cindex(@code{lognoterepeat}\\\, STARTUP keyword)}}} - {{{cindex(@code{nologrepeat}\\\, STARTUP keyword)}}} - {{{cindex(@code{logreschedule}\\\, STARTUP keyword)}}} - {{{cindex(@code{lognotereschedule}\\\, STARTUP keyword)}}} - {{{cindex(@code{nologreschedule}\\\, STARTUP keyword)}}} - {{{cindex(@code{logredeadline}\\\, STARTUP keyword)}}} - {{{cindex(@code{lognoteredeadline}\\\, STARTUP keyword)}}} - {{{cindex(@code{nologredeadline}\\\, STARTUP keyword)}}} - {{{cindex(@code{logrefile}\\\, STARTUP keyword)}}} - {{{cindex(@code{lognoterefile}\\\, STARTUP keyword)}}} - {{{cindex(@code{nologrefile}\\\, STARTUP keyword)}}} + #+cindex: @code{logdone}, STARTUP keyword + #+cindex: @code{lognotedone}, STARTUP keyword + #+cindex: @code{nologdone}, STARTUP keyword + #+cindex: @code{lognoteclock-out}, STARTUP keyword + #+cindex: @code{nolognoteclock-out}, STARTUP keyword + #+cindex: @code{logrepeat}, STARTUP keyword + #+cindex: @code{lognoterepeat}, STARTUP keyword + #+cindex: @code{nologrepeat}, STARTUP keyword + #+cindex: @code{logreschedule}, STARTUP keyword + #+cindex: @code{lognotereschedule}, STARTUP keyword + #+cindex: @code{nologreschedule}, STARTUP keyword + #+cindex: @code{logredeadline}, STARTUP keyword + #+cindex: @code{lognoteredeadline}, STARTUP keyword + #+cindex: @code{nologredeadline}, STARTUP keyword + #+cindex: @code{logrefile}, STARTUP keyword + #+cindex: @code{lognoterefile}, STARTUP keyword + #+cindex: @code{nologrefile}, STARTUP keyword #+attr_texinfo: :table-type "table" :indic "@asis" - ~logdone~ :: record a timestamp when an item is marked DONE @@ -16289,18 +16281,18 @@ effective only when the file is visited again in a new Emacs session. - ~lognoterefile~ :: record a note when refiling - ~nologrefile~ :: do not record when refiling - {{{vindex(org-hide-leading-stars)}}} - {{{vindex(org-odd-levels-only)}}} + #+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~). - {{{cindex(@code{hidestars}\\\, STARTUP keyword)}}} - {{{cindex(@code{showstars}\\\, STARTUP keyword)}}} - {{{cindex(@code{odd}\\\, STARTUP keyword)}}} - {{{cindex(@code{even}\\\, STARTUP keyword)}}} + #+cindex: @code{hidestars}, STARTUP keyword + #+cindex: @code{showstars}, STARTUP keyword + #+cindex: @code{odd}, STARTUP keyword + #+cindex: @code{even}, STARTUP keyword #+attr_texinfo: :table-type "table" :indic "@asis" - ~hidestars~ :: make all but one of the stars starting a headline invisible. @@ -16310,47 +16302,47 @@ effective only when the file is visited again in a new Emacs session. - ~odd~ :: allow only odd outline levels (1, 3, ...) - ~oddeven~ :: allow all outline levels - {{{vindex(org-put-time-stamp-overlays)}}} - {{{vindex(org-time-stamp-overlay-formats)}}} + #+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: - {{{cindex(@code{customtime}\\\, STARTUP keyword)}}} + #+cindex: @code{customtime}, STARTUP keyword #+attr_texinfo: :table-type "table" :indic "@asis" - ~customtime~ :: overlay custom time format - {{{vindex(constants-unit-system)}}} + #+vindex: constants-unit-system The following options influence the table spreadsheet (variable ~constants-unit-system~). - {{{cindex(@code{constcgs}\\\, STARTUP keyword)}}} - {{{cindex(@code{constSI}\\\, STARTUP keyword)}}} + #+cindex: @code{constcgs}, STARTUP keyword + #+cindex: @code{constSI}, STARTUP keyword #+attr_texinfo: :table-type "table" :indic "@asis" - ~constcgs~ :: {{{file(constants.el)}}} should use the c-g-s unit system - ~constSI~ :: {{{file(constants.el)}}} should use the SI unit system - {{{vindex(org-footnote-define-inline)}}} - {{{vindex(org-footnote-auto-label)}}} - {{{vindex(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~. - {{{cindex(@code{fninline}\\\, STARTUP keyword)}}} - {{{cindex(@code{nofninline}\\\, STARTUP keyword)}}} - {{{cindex(@code{fnlocal}\\\, STARTUP keyword)}}} - {{{cindex(@code{fnprompt}\\\, STARTUP keyword)}}} - {{{cindex(@code{fnauto}\\\, STARTUP keyword)}}} - {{{cindex(@code{fnconfirm}\\\, STARTUP keyword)}}} - {{{cindex(@code{fnplain}\\\, STARTUP keyword)}}} - {{{cindex(@code{fnadjust}\\\, STARTUP keyword)}}} - {{{cindex(@code{nofnadjust}\\\, STARTUP keyword)}}} + #+cindex: @code{fninline}, STARTUP keyword + #+cindex: @code{nofninline}, STARTUP keyword + #+cindex: @code{fnlocal}, STARTUP keyword + #+cindex: @code{fnprompt}, STARTUP keyword + #+cindex: @code{fnauto}, STARTUP keyword + #+cindex: @code{fnconfirm}, STARTUP keyword + #+cindex: @code{fnplain}, STARTUP keyword + #+cindex: @code{fnadjust}, STARTUP keyword + #+cindex: @code{nofnadjust}, STARTUP keyword #+attr_texinfo: :table-type "table" :indic "@asis" - ~fninline~ :: define footnotes inline @@ -16363,32 +16355,32 @@ effective only when the file is visited again in a new Emacs session. - ~fnadjust~ :: automatically renumber and sort footnotes - ~nofnadjust~ :: do not renumber and sort automatically - {{{cindex(org-hide-block-startup)}}} + #+cindex: org-hide-block-startup To hide blocks on startup, use these keywords. The corresponding variable is ~org-hide-block-startup~. - {{{cindex(@code{hideblocks}\\\, STARTUP keyword)}}} - {{{cindex(@code{nohideblocks}\\\, STARTUP keyword)}}} + #+cindex: @code{hideblocks}, STARTUP keyword + #+cindex: @code{nohideblocks}, STARTUP keyword #+attr_texinfo: :table-type "table" :indic "@asis" - ~hideblocks~ :: Hide all begin/end blocks on startup - ~nohideblocks~ :: Do not hide blocks on startup - {{{cindex(org-pretty-entities)}}} + #+cindex: org-pretty-entities The display of entities as UTF-8 characters is governed by the variable ~org-pretty-entities~ and the keywords - {{{cindex(@code{entitiespretty}\\\, STARTUP keyword)}}} - {{{cindex(@code{entitiesplain}\\\, STARTUP keyword)}}} + #+cindex: @code{entitiespretty}, STARTUP keyword + #+cindex: @code{entitiesplain}, STARTUP keyword #+attr_texinfo: :table-type "table" :indic "@asis" - ~entitiespretty~ :: Show entities as UTF-8 characters where possible - ~entitiesplain~ :: Leave entities plain - {{{kbd(#+TAGS: TAG1(c1) TAG2(c2))}}} :: - {{{vindex(org-tag-alist)}}} + #+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/ @@ -16404,7 +16396,7 @@ effective only when the file is visited again in a new Emacs session. [[Export options]]. - {{{kbd(#+TODO:)}}}, {{{kbd(#+SEQ_TODO:)}}}, {{{kbd(#+TYP_TODO:)}}} :: - {{{vindex(org-todo-keywords)}}} + #+vindex: org-todo-keywords These lines set the TODO keywords and their interpretation in the current file. The corresponding variable is ~org-todo-keywords~. @@ -16414,8 +16406,8 @@ effective only when the file is visited again in a new Emacs session. :DESCRIPTION: When in doubt, press C-c C-c :TITLE: The very busy C-c C-c key :END: -{{{kindex(C-c C-c)}}} -{{{cindex(C-c C-c\\\, overview)}}} +#+kindex: C-c C-c +#+cindex: C-c C-c, overview The key {{{kbd(C-c C-c)}}} has many purposes in Org, which are all mentioned scattered throughout this manual. One specific function of @@ -16456,10 +16448,10 @@ what this means in different contexts. :DESCRIPTION: Getting rid of leading stars in the outline :TITLE: A cleaner outline view :END: -{{{cindex(hiding leading stars)}}} -{{{cindex(dynamic indentation)}}} -{{{cindex(odd-levels-only outlines)}}} -{{{cindex(clean outline view)}}} +#+cindex: hiding leading stars +#+cindex: dynamic indentation +#+cindex: odd-levels-only outlines +#+cindex: clean outline view Some people find it noisy and distracting that the Org headlines start with a potentially large number of stars, and that text below the @@ -16510,14 +16502,14 @@ display, Org supports you in the following way: more text, now indented #+end_example - {{{vindex(org-adapt-indentation)}}} + #+vindex: org-adapt-indentation Org supports this with paragraph filling, line wrapping, and structure editing, preserving or adapting the indentation as appropriate.[fn:157] - Hiding leading stars :: - {{{vindex(org-hide-leading-stars)}}} + #+vindex: org-hide-leading-stars You can modify the display in such a way that all leading stars become invisible. To do this in a global way, configure the variable @@ -16537,7 +16529,7 @@ display, Org supports you in the following way: ... #+end_example - {{{vindex(org-hide @r{(face)})}}} + #+vindex: org-hide @r{(face)} {{{noindent}}} The leading stars are not truly replaced by whitespace, they are only fontified with the face ~org-hide~ that uses the @@ -16547,7 +16539,7 @@ display, Org supports you in the following way: extra stars are /almost/ invisible, for example using the color ~grey90~ on a white background. - Odd levels :: - {{{vindex(org-odd-levels-only)}}} + #+vindex: org-odd-levels-only Things become cleaner still if you skip all the even levels and use only odd levels 1, 3, 5, ..., effectively adding two stars to go from @@ -16614,7 +16606,7 @@ the timestamp. :DESCRIPTION: Other Emacs packages :TITLE: Interaction with other packages :END: -{{{cindex(packages\\\, interaction with other)}}} +#+cindex: packages, interaction with other Org lives in the world of GNU Emacs and interacts in various ways with other code out there. @@ -16626,8 +16618,8 @@ with other code out there. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{file(calc.el)}}} by Dave Gillespie :: - {{{cindex(@file{calc.el})}}} - {{{cindex(Gillespie\\\, Dave)}}} + #+cindex: @file{calc.el} + #+cindex: Gillespie, Dave Org uses the Calc package for implementing spreadsheet functionality in its tables (see [[The spreadsheet]]). Org checks for the availability @@ -16638,9 +16630,9 @@ with other code out there. calculations. See [[info:calc:Embedded Mode][GNU Emacs Calc Manual]]. - {{{file(constants.el)}}} by Carsten Dominik :: - {{{cindex(@file{constants.el})}}} - {{{cindex(Dominik\\\, Carsten)}}} - {{{vindex(org-table-formula-constants)}}} + #+cindex: @file{constants.el} + #+cindex: Dominik, Carsten + #+vindex: org-table-formula-constants In a table formula (see [[The spreadsheet]]), it is possible to use names for natural constants or units. Instead of defining your own constants @@ -16654,16 +16646,16 @@ with other code out there. {{{file(constants.el)}}}. - {{{file(cdlatex.el)}}} by Carsten Dominik :: - {{{cindex(@file{cdlatex.el})}}} - {{{cindex(Dominik\\\, Carsten)}}} + #+cindex: @file{cdlatex.el} + #+cindex: Dominik, Carsten Org mode can make use of the CDLaTeX package to efficiently enter LaTeX fragments into Org files. See [[CDLaTeX mode]]. - {{{file(imenu.el)}}} by Ake Stenhoff and Lars Lindberg :: - {{{cindex(@file{imenu.el})}}} - {{{cindex(Stenhoff\\\, Ake)}}} - {{{cindex(Lindberg\\\, Lars)}}} + #+cindex: @file{imenu.el} + #+cindex: Stenhoff, Ake + #+cindex: Lindberg, Lars Imenu allows menu access to an index of items in a file. Org mode supports Imenu---all you need to do to get the index is the following: @@ -16673,20 +16665,20 @@ with other code out there. (lambda () (imenu-add-to-menubar "Imenu"))) #+end_src - {{{vindex(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~. - {{{file(remember.el)}}} by John Wiegley :: - {{{cindex(@file{remember.el})}}} - {{{cindex(Wiegley\\\, John)}}} + #+cindex: @file{remember.el} + #+cindex: Wiegley, John Org used to use this package for capture, but no longer does. - {{{file(speedbar.el)}}} by Eric M. Ludlam :: - {{{cindex(@file{speedbar.el})}}} - {{{cindex(Ludlam\\\, Eric M.)}}} + #+cindex: @file{speedbar.el} + #+cindex: Ludlam, Eric M. Speedbar is a package that creates a special frame displaying files and index items in files. Org mode supports Speedbar and allows you to @@ -16695,10 +16687,10 @@ with other code out there. the command {{{kbd(<)}}} in the Speedbar frame. - {{{file(table.el)}}} by Takaaki Ota :: - {{{kindex(C-c C-c)}}} - {{{cindex(table editor\\\, @file{table.el})}}} - {{{cindex(@file{table.el})}}} - {{{cindex(Ota\\\, Takaaki)}}} + #+kindex: C-c C-c + #+cindex: table editor, @file{table.el} + #+cindex: @file{table.el} + #+cindex: Ota, Takaaki Complex ASCII tables with automatic line wrapping, column- and row-spanning, and alignment can be created using the Emacs table package by Takaaki Ota @@ -16709,13 +16701,13 @@ with other code out there. {{{kbd(C-c ')}}} to edit them, similar to source code snippets. - {{{kbd(C-c ')}}}, ~org-edit-special~ :: - {{{kindex(C-c ')}}} + #+kindex: C-c ' Edit a {{{file(table.el)}}} table. Works when the cursor is in a table.el table. - {{{kbd(C-c XXX)}}}, ~org-table-create-with-table.el~ :: - {{{kindex(C-c ~)}}} + #+kindex: C-c ~ # Should be ~ Insert a {{{file(table.el)}}} table. If there is already a table at point, this command converts it between the {{{file(table.el)}}} @@ -16726,8 +16718,8 @@ with other code out there. {{{file(table.el)}}} is part of Emacs since Emacs 22. - {{{file(footnote.el)}}} by Steven L. Baur :: - {{{cindex(@file{footnote.el})}}} - {{{cindex(Baur\\\, Steven L.)}}} + #+cindex: @file{footnote.el} + #+cindex: Baur, Steven L. Org mode recognizes numerical footnotes as provided by this package. However, Org mode also has its own footnote support (see [[Creating footnotes]]), @@ -16739,8 +16731,8 @@ with other code out there. :OPTIONAL_TITLE: Packages that lead to conflicts with Org mode :END: -{{{cindex(@code{shift-selection-mode})}}} -{{{vindex(org-support-shift-select)}}} +#+cindex: @code{shift-selection-mode} +#+vindex: org-support-shift-select In Emacs 23, ~shift-selection-mode~ is on by default, meaning that cursor motions combined with the shift key should start or enlarge @@ -16756,9 +16748,9 @@ region even if the cursor moves across a special context. #+attr_texinfo: :table-type "table" :indic "@asis" - {{{file(CUA.el)}}} by Kim. F. Storm :: - {{{cindex(@file{CUA.el})}}} - {{{cindex(Storm\\\, Kim. F.)}}} - {{{vindex(org-replace-disputed-keys)}}} + #+cindex: @file{CUA.el} + #+cindex: Storm, Kim. F. + #+vindex: org-replace-disputed-keys Key bindings in Org conflict with the {{{kbdkey(S-,)}}} keys used by CUA mode (as well as ~pc-select-mode~ and ~s-region-mode~) to @@ -16775,15 +16767,15 @@ region even if the cursor moves across a special context. | S-LEFT {{{result}}} M-- | S-RIGHT {{{result}}} M-+ | | C-S-LEFT {{{result}}} M-S-- | C-S-RIGHT {{{result}}} M-S-+ | - {{{vindex(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~. - {{{file(filladapt.el)}}} by Kyle Jones :: - {{{cindex(@file{filladapt.el})}}} - {{{cindex(Jones\\\, Kyle)}}} + #+cindex: @file{filladapt.el} + #+cindex: Jones, Kyle Org mode tries to do the right thing when filling paragraphs, list items and other elements. Many users reported they had problems using @@ -16795,7 +16787,7 @@ region even if the cursor moves across a special context. #+end_src - {{{file(yasnippet.el)}}} :: - {{{cindex(@file{yasnippet.el})}}} + #+cindex: @file{yasnippet.el} The way Org mode binds the {{{key(TAB)}}} key (binding to ~[tab]~ instead of ~"\t"~) overrules YASnippet's access to this key. The @@ -16829,8 +16821,8 @@ region even if the cursor moves across a special context. #+end_src - {{{file(windmove.el)}}} by Hovav Shacham :: - {{{cindex(@file{windmove.el})}}} - {{{cindex(Shacham\\\, Hovav)}}} + #+cindex: @file{windmove.el} + #+cindex: Shacham, Hovav This package also uses the {{{kbd(S-)}}} keys, so everything written in the paragraph above about CUA mode also applies here. If @@ -16847,9 +16839,9 @@ region even if the cursor moves across a special context. #+end_src - {{{file(viper.el)}}} by Michael Kifer :: - {{{cindex(@file{viper.el})}}} - {{{cindex(Kifer\\\, Michael)}}} - {{{kindex(C-c /)}}} + #+cindex: @file{viper.el} + #+cindex: Kifer, Michael + #+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 @@ -16864,8 +16856,8 @@ region even if the cursor moves across a special context. :PROPERTIES: :DESCRIPTION: Encrypting Org files :END: -{{{cindex(@file{org-crypt.el})}}} -{{{cindex(@code{org-decrypt-entry})}}} +#+cindex: @file{+org-crypt.el} +#+cindex: @code{org-decrypt-entry} Org-crypt will encrypt the text of an entry, but not the headline, or properties. Org-crypt uses the Emacs EasyPG library to encrypt and @@ -16908,7 +16900,7 @@ being encrypted again. :DESCRIPTION: How to hack your way around :APPENDIX: Appendix :END: -{{{cindex(hacking)}}} +#+cindex: hacking This appendix describes some ways a user can extend the functionality of Org. @@ -16917,7 +16909,7 @@ of Org. :PROPERTIES: :DESCRIPTION: How to reach into Org's internals :END: -{{{cindex(hooks)}}} +#+cindex: hooks Org has a large number of hook variables that can be used to add functionality. This appendix about hacking is going to illustrate the @@ -16929,7 +16921,7 @@ maintained by the Worg project and can be found at :PROPERTIES: :DESCRIPTION: Available extensions :END: -{{{cindex(add-on packages)}}} +#+cindex: add-on packages A large number of add-on packages have been written by various authors. These packages are not part of Emacs, but they are @@ -16943,7 +16935,7 @@ package, is maintained by the Worg project at :PROPERTIES: :DESCRIPTION: New custom link types :END: -{{{cindex(hyperlinks\\\, adding new types)}}} +#+cindex: hyperlinks, adding new types Org has a large number of hyperlink types built-in (see [[Hyperlinks]]). If you would like to add new link types, Org provides an interface for @@ -17010,7 +17002,7 @@ PATH should be a topic that can be thrown at the man command." #+end_src {{{noindent}}} Let's go through the file and see what it does. -{{{vindex(org-store-link-functions)}}} +#+vindex: org-store-link-functions 1. It does ~(require 'org)~ to make sure that {{{file(org.el)}}} has been loaded. @@ -17055,9 +17047,9 @@ link with prefix. :PROPERTIES: :DESCRIPTION: How to add functionality to such commands :END: -{{{cindex(context-sensitive commands\\\, hooks)}}} -{{{cindex(add-ons\\\, context-sensitive commands)}}} -{{{vindex(org-ctrl-c-ctrl-c-hook)}}} +#+cindex: context-sensitive commands, hooks +#+cindex: add-ons, context-sensitive commands +#+vindex: org-ctrl-c-ctrl-c-hook Org has several commands that act differently depending on context. The most important example is the {{{kbd(C-c C-c)}}} (see [[The very @@ -17097,9 +17089,9 @@ try. :PROPERTIES: :DESCRIPTION: Orgtbl for LaTeX and other programs :END: -{{{cindex(tables\\\, in other modes)}}} -{{{cindex(lists\\\, in other modes)}}} -{{{cindex(Orgtbl mode)}}} +#+cindex: tables, in other modes +#+cindex: lists, in other modes +#+cindex: Orgtbl mode Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a frequent feature request has been to make it work with native tables @@ -17124,7 +17116,7 @@ another format (HTML, LaTeX or Texinfo.) :PROPERTIES: :DESCRIPTION: Sending and receiving radio tables :END: -{{{cindex(radio tables)}}} +#+cindex: radio tables To define the location of the target table, you first need to create two lines that are comments in the current mode, but contain magic @@ -17141,7 +17133,7 @@ example: tells Orgtbl mode how to translate this table and where to install it. For example: -{{{cindex(#+ORGTBL)}}} +#+cindex: #+ORGTBL #+begin_example ,#+ORGTBL: SEND table_name translation_function arguments ... #+end_example @@ -17198,7 +17190,7 @@ LaTeX file. There are a number of different solutions: :DESCRIPTION: Step by step, almost a tutorial :TITLE: A LaTeX example of radio tables :END: -{{{cindex(@LaTeX{}\\\, and Orgtbl mode)}}} +#+cindex: @LaTeX{}, and Orgtbl mode The best way to wrap the source table in LaTeX is to use the ~comment~ environment provided by {{{file(comment.sty)}}}. It has to @@ -17208,7 +17200,7 @@ header. Orgtbl mode can insert a radio table skeleton with the command for a table name, let's say we use {{{samp(salesfigures)}}}. You will then get the following template: -{{{cindex(#+ORGTBL\\\, SEND)}}} +#+cindex: #+ORGTBL, SEND #+begin_example % BEGIN RECEIVE ORGTBL salesfigures % END RECEIVE ORGTBL salesfigures @@ -17218,7 +17210,7 @@ then get the following template: \end{comment} #+end_example -{{{vindex(@LaTeX{}-verbatim-environments)}}} +#+vindex: @LaTeX{}-verbatim-environments {{{noindent}}} The ~#+ORGTBL: SEND~ line tells Orgtbl mode to use the function ~orgtbl-to-latex~ to convert the table into LaTeX and to @@ -17318,8 +17310,8 @@ following parameters (see also see [[Translator functions]]): :PROPERTIES: :DESCRIPTION: Copy and modify :END: -{{{cindex(HTML\\\, and Orgtbl mode)}}} -{{{cindex(translator function)}}} +#+cindex: HTML, and Orgtbl mode +#+cindex: translator function Orgtbl mode has several translator functions built-in: ~orgtbl-to-csv~ (comma-separated values), ~orgtbl-to-tsv~ (TAB-separated values) @@ -17392,8 +17384,8 @@ that others can benefit from your work. :PROPERTIES: :DESCRIPTION: Doing the same for lists :END: -{{{cindex(radio lists)}}} -{{{cindex(org-list-insert-radio-list)}}} +#+cindex: radio lists +#+cindex: org-list-insert-radio-list Sending and receiving radio lists works exactly the same way as sending and receiving radio tables (see [[Radio tables]]). As for radio @@ -17416,7 +17408,7 @@ Here are the differences with radio tables: Here is a LaTeX example. Let's say that you have this in your LaTeX file: -{{{cindex(#+ORGLST)}}} +#+cindex: #+ORGLST #+begin_example % BEGIN RECEIVE ORGLST to-buy % END RECEIVE ORGLST to-buy @@ -17437,7 +17429,7 @@ LaTeX list between the two marker lines. :PROPERTIES: :DESCRIPTION: Automatically filled blocks :END: -{{{cindex(dynamic blocks)}}} +#+cindex: dynamic blocks Org documents can contain /dynamic blocks/. These are specially marked regions that are updated by some user-written function. A good example @@ -17448,7 +17440,7 @@ Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name to the block and can also specify parameters for the function producing the content of the block. -{{{cindex(#+BEGIN:dynamic block)}}} +#+cindex: #+BEGIN:dynamic block #+begin_example ,#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... @@ -17459,12 +17451,12 @@ Dynamic blocks are updated with the following commands: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(C-c C-x C-u)}}}, ~org-dblock-update~ :: - {{{kindex(C-c C-x C-u)}}} + #+kindex: C-c C-x C-u Update dynamic block at point. - {{{kbd(C-u C-c C-x C-u)}}} :: - {{{kindex(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. @@ -17512,9 +17504,9 @@ any other block) with ~org-narrow-to-block~. :PROPERTIES: :DESCRIPTION: Customized views :END: -{{{cindex(agenda views\\\, user-defined)}}} -{{{vindex(org-agenda-skip-function)}}} -{{{vindex(org-agenda-skip-function-global)}}} +#+cindex: agenda views, user-defined +#+vindex: org-agenda-skip-function +#+vindex: org-agenda-skip-function-global Org provides a special hook that can be used to narrow down the selection made by these agenda views: ~agenda~, ~todo~, ~alltodo~, @@ -17563,13 +17555,13 @@ like this: (org-agenda-overriding-header "Projects waiting for something: ")))) #+end_src -{{{vindex(org-agenda-overriding-header)}}} +#+vindex: org-agenda-overriding-header Note that this also binds ~org-agenda-overriding-header~ to get a meaningful header in the agenda view. -{{{vindex(org-odd-levels-only)}}} -{{{vindex(org-agenda-skip-function)}}} +#+vindex: org-odd-levels-only +#+vindex: org-agenda-skip-function A general way to create custom searches is to base them on a search for entries with a certain level limit. If you want to study all @@ -17641,9 +17633,9 @@ like this, even without defining a special function: :PROPERTIES: :DESCRIPTION: Post-processing agenda information :END: -{{{cindex(agenda\\\, pipe)}}} -{{{cindex(Scripts\\\, for agenda processing)}}} -{{{vindex(org-agenda-custom-commands)}}} +#+cindex: agenda, pipe +#+cindex: Scripts, for agenda processing +#+vindex: org-agenda-custom-commands Org provides commands to access agenda information for the command line in Emacs batch mode. This extracted information can be sent @@ -17751,8 +17743,8 @@ foreach $line (split(/\n/,$agenda)) @{ :PROPERTIES: :DESCRIPTION: Writing programs that use entry properties :END: -{{{cindex(API\\\, for properties)}}} -{{{cindex(properties\\\, API)}}} +#+cindex: API, for properties +#+cindex: properties, API Here is a description of the functions that can be used to work with properties. @@ -17768,8 +17760,8 @@ If WHICH is nil or `all', get all properties. If WHICH is `special' or `standard', only get that subclass. {{{enddefun}}} -{{{vindex(org-use-property-inheritance)}}} -{{{findex(org-insert-property-drawer)}}} +#+vindex: org-use-property-inheritance +#+findex: org-insert-property-drawer {{{defun}}} org-entry-get pom property &optional inherit Get value of PROPERTY for entry at point-or-marker POM. By default, @@ -17834,8 +17826,8 @@ responsible for this property. :PROPERTIES: :DESCRIPTION: Mapping over all or selected entries :END: -{{{cindex(API\\\, for mapping)}}} -{{{cindex(mapping entries\\\, API)}}} +#+cindex: API, for mapping +#+cindex: mapping entries, API Org has sophisticated mapping capabilities to find all entries satisfying certain criteria. Internally, this functionality is used to produce agenda @@ -17907,7 +17899,7 @@ SCOPE determines the scope of this command. It can be any of: skipping facilities of the scanner. The following items can be given here: -{{{vindex(org-agenda-skip-function)}}} +#+vindex: org-agenda-skip-function #+attr_texinfo: :table-type "table" :indic "@asis" - ~archive~ :: @@ -17980,10 +17972,10 @@ The following example counts the number of entries with TODO keyword :DESCRIPTION: Viewing and capture on a mobile device :APPENDIX: Appendix :END: -{{{cindex(iPhone)}}} -{{{cindex(MobileOrg)}}} -{{{cindex(Moreland\\\, Richard)}}} -{{{cindex(Jones\\\, Matt)}}} +#+cindex: iPhone +#+cindex: MobileOrg +#+cindex: Moreland, Richard +#+cindex: Jones, Matt MobileOrg is the name of the mobile companion app for Org mode, currently available for iOS and for Android. MobileOrg offers @@ -18091,7 +18083,7 @@ entries. Here is how it works: #+attr_texinfo: :table-type "table" :indic "@asis" - {{{kbd(?)}}} :: - {{{kindex(?)}}} + #+kindex: ? Pressing {{{kbd(?)}}} in that special agenda will display the full flagging note in another window and also push it onto the kill ring. @@ -18103,7 +18095,7 @@ entries. Here is how it works: finished. -{{{kindex(C-c a ?)}}} +#+kindex: C-c a ? If you are not able to process all flagged entries directly, you can always return to this agenda view using {{{kbd(C-c a ?)}}}.[fn:169]