1 #+title: The Org Manual
3 #+texinfo: @insertcopying
7 :DESCRIPTION: Getting started.
13 :DESCRIPTION: Brief summary of what Org does.
17 Org is a mode for keeping notes, maintaining TODO lists, and project
18 planning with a fast and effective plain-text system. It also is an
19 authoring system with unique support for literate programming and
20 reproducible research.
22 Org is implemented on top of Outline mode, which makes it possible to
23 keep the content of large files well structured. Visibility cycling
24 and structure editing help to work with the tree. Tables are easily
25 created with a built-in table editor. Plain text URL-like links
26 connect to websites, emails, Usenet messages, BBDB entries, and any
27 files related to the projects.
29 Org develops organizational tasks around notes files that contain
30 lists or information about projects as plain text. Project planning
31 and task management makes use of metadata which is part of an outline
32 node. Based on this data, specific entries can be extracted in
33 queries and create dynamic /agenda views/ that also integrate the
34 Emacs calendar and diary. Org can be used to implement many different
35 project planning schemes, such as David Allen's GTD system.
37 Org files can serve as a single source authoring system with export to
38 many different formats such as HTML, LaTeX, Open Document, and
39 Markdown. New export backends can be derived from existing ones, or
42 Org files can include source code blocks, which makes Org uniquely
43 suited for authoring technical documents with code examples. Org
44 source code blocks are fully functional; they can be evaluated in
45 place and their results can be captured in the file. This makes it
46 possible to create a single file reproducible research compendium.
48 Org keeps simple things simple. When first fired up, it should feel
49 like a straightforward, easy to use outliner. Complexity is not
50 imposed, but a large amount of functionality is available when needed.
51 Org is a toolbox. Many users actually run only a---very
52 personal---fraction of Org's capabilities, and know that there is more
53 whenever they need it.
55 All of this is achieved with strictly plain text files, the most
56 portable and future-proof file format. Org runs in Emacs. Emacs is
57 one of the most widely ported programs, so that Org mode is available
58 on every major platform.
61 There is a website for Org which provides links to the newest version
62 of Org, as well as additional information, frequently asked questions
63 (FAQ), links to tutorials, etc. This page is located at
64 [[https://orgmode.org]].
66 #+cindex: print edition
67 An earlier version (7.3) of this manual is available as a [[http://www.network-theory.co.uk/org/manual/][paperback
68 book from Network Theory Ltd.]].
72 :DESCRIPTION: Installing Org.
74 #+cindex: installation
76 Org is part of recent distributions of GNU Emacs, so you normally do
77 not need to install it. If, for one reason or another, you want to
78 install Org on top of this pre-packaged version, there are three ways
81 - By using Emacs package system.
82 - By downloading Org as an archive.
83 - By using Org's git repository.
85 We *strongly recommend* to stick to a single installation method.
87 *** Using Emacs packaging system
92 Recent Emacs distributions include a packaging system which lets you
93 install Elisp libraries. You can install Org with {{{kbd(M-x
94 package-install RET org)}}}.
97 *Important*: you need to do this in a session where no =.org= file has
98 been visited, i.e., where no Org built-in function have been loaded.
99 Otherwise autoload Org functions will mess up the installation.
101 Then, to make sure your Org configuration is taken into account,
102 initialize the package system with ~(package-initialize)~ in your
103 Emacs init file before setting any Org option. If you want to use
104 Org's package repository, check out the [[https://orgmode.org/elpa.html][Org ELPA page]].
106 *** Downloading Org as an archive
111 You can download Org latest release from [[https://orgmode.org/][Org's website]]. In this case,
112 make sure you set the load-path correctly in your Emacs init file:
114 #+begin_src emacs-lisp
115 (add-to-list 'load-path "~/path/to/orgdir/lisp")
118 The downloaded archive contains contributed libraries that are not
119 included in Emacs. If you want to use them, add the =contrib/=
120 directory to your load-path:
122 #+begin_src emacs-lisp
123 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
126 Optionally, you can compile the files and/or install them in your
127 system. Run =make help= to list compilation and installation options.
129 *** Using Org's git repository
134 You can clone Org's repository and install Org like this:
138 $ git clone git@code.orgmode.org:bzg/org-mode.git
142 Note that in this case, ~make autoloads~ is mandatory: it defines
143 Org's version in =org-version.el= and Org's autoloads in
146 Remember to add the correct load-path as described in the method
149 You can also compile with =make=, generate the documentation with
150 =make doc=, create a local configuration with =make config= and
151 install Org with =make install=. Please run =make help= to get the
152 list of compilation/installation options.
154 For more detailed explanations on Org's build system, please check the
155 Org Build System page on [[https://orgmode.org/worg/dev/org-build-system.html][Worg]].
159 :DESCRIPTION: How to activate Org for certain buffers.
164 #+cindex: global key bindings
165 #+cindex: key bindings, global
167 Org mode buffers need Font Lock to be turned on: this is the default
170 There are compatibility issues between Org mode and some other Elisp
171 packages (see [[*Packages that conflict with Org mode]]). Please take the
172 time to check the list.
175 #+findex: org-capture
176 #+findex: org-store-link
177 For a better experience, the three Org commands ~org-store-link~,
178 ~org-capture~ and ~org-agenda~ ought to be accessible anywhere in
179 Emacs, not just in Org buffers. To that effect, you need to bind them
180 to globally available keys, like the ones reserved for users (see
181 [[info:elisp::Key%20Binding%20Conventions]]). Here are suggested
182 bindings, please modify the keys to your own liking.
184 #+begin_src emacs-lisp
185 (global-set-key "\C-cl" 'org-store-link)
186 (global-set-key "\C-ca" 'org-agenda)
187 (global-set-key "\C-cc" 'org-capture)
190 #+cindex: Org mode, turning on
191 Files with the =.org= extension use Org mode by default. To turn on
192 Org mode in a file that does not have the extension =.org=, make the
193 first line of a file look like this:
195 : MY PROJECTS -*- mode: org; -*-
197 #+vindex: org-insert-mode-line-in-empty-file
199 which selects Org mode for this buffer no matter what the file's name
200 is. See also the variable ~org-insert-mode-line-in-empty-file~.
202 Many commands in Org work on the region if the region is /active/. To
203 make use of this, you need to have ~transient-mark-mode~ turned on,
204 which is the default. If you do not like ~transient-mark-mode~, you
205 can create an active region by using the mouse to select a region, or
206 pressing {{{kbd(C-SPC)}}} twice before moving the cursor.
210 :DESCRIPTION: Bug reports, ideas, patches, etc.
213 #+cindex: bug reports
214 #+cindex: reporting a bug
218 If you find problems with Org, or if you have questions, remarks, or
219 ideas about it, please mail to the Org mailing list
220 [[mailto:emacs-orgmode@gnu.org]]. You can subscribe to the list [[https://lists.gnu.org/mailman/listinfo/emacs-orgmode][on this
221 web page]]. If you are not a member of the mailing list, your mail will
222 be passed to the list after a moderator has approved it[fn:2].
224 #+findex: org-version
225 #+findex: org-submit-bug-report
226 For bug reports, please first try to reproduce the bug with the latest
227 version of Org available---if you are running an outdated version, it
228 is quite possible that the bug has been fixed already. If the bug
229 persists, prepare a report and provide as much information as
230 possible, including the version information of Emacs ({{{kbd(M-x
231 emacs-version)}}}) and Org ({{{kbd(M-x org-version)}}}), as well as
232 the Org related setup in the Emacs init file. The easiest way to do
233 this is to use the command
235 : M-x org-submit-bug-report <RET>
238 which puts all this information into an Emacs mail buffer so that you
239 only need to add your description. If you are not sending the Email
240 from within Emacs, please copy and paste the content into your Email
243 Sometimes you might face a problem due to an error in your Emacs or
244 Org mode setup. Before reporting a bug, it is very helpful to start
245 Emacs with minimal customizations and reproduce the problem. Doing so
246 often helps you determine if the problem is with your customization or
247 with Org mode itself. You can start a typical minimal session with
248 a command like the example below.
250 : $ emacs -Q -l /path/to/minimal-org.el
252 However if you are using Org mode as distributed with Emacs, a minimal
253 setup is not necessary. In that case it is sufficient to start Emacs
254 as =emacs -Q=. The =minimal-org.el= setup file can have contents as
257 #+begin_src emacs-lisp
258 ;;; Minimal setup to load latest `org-mode'.
260 ;; Activate debugging.
261 (setq debug-on-error t
265 ;; Add latest Org mode to load path.
266 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
267 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
270 If an error occurs, a "backtrace" can be very useful---see below on
271 how to create one. Often a small example file helps, along with clear
274 1. What exactly did you do?
275 2. What did you expect to happen?
276 3. What happened instead?
279 Thank you for helping to improve this program.
281 *** How to create a useful backtrace
286 #+cindex: backtrace of an error
287 If working with Org produces an error with a message you do not
288 understand, you may have hit a bug. The best way to report this is by
289 providing, in addition to what was mentioned above, a backtrace. This
290 is information from the built-in debugger about where and how the
291 error occurred. Here is how to produce a useful backtrace:
293 1. Reload uncompiled versions of all Org mode Lisp files. The
294 backtrace contains much more information if it is produced with
295 uncompiled code. To do this, use
297 : C-u M-x org-reload <RET>
300 or, from the menu: Org \rarr Refresh/Reload \rarr Reload Org uncompiled.
302 2. Then, activate the debugger:
304 : M-x toggle-debug-or-errror <RET>
307 or, from the menu: Options \rarr Enter Debugger on Error.
309 3. Do whatever you have to do to hit the error. Do not forget to
310 document the steps you take.
312 4. When you hit the error, a =*Backtrace*= buffer appears on the
313 screen. Save this buffer to a file---for example using {{{kbd(C-x
314 C-w)}}}---and attach it to your bug report.
316 ** Typesetting Conventions Used in this Manual
318 :DESCRIPTION: Typesetting conventions used in this manual.
319 :ALT_TITLE: Conventions
322 *** TODO keywords, tags, properties, etc.
327 Org uses various syntactical elements: TODO keywords, tags, property
328 names, keywords, blocks, etc. In this manual we use the following
331 #+attr_texinfo: :sep ,
332 - =TODO=, =WAITING= ::
334 TODO keywords are written with all capitals, even if they are
337 - =boss=, =ARCHIVE= ::
339 User-defined tags are written in lowercase; built-in tags with
340 special meaning are written with all capitals.
342 - =Release=, =PRIORITY= ::
344 User-defined properties are capitalized; built-in properties with
345 special meaning are written with all capitals.
347 - =TITLE=, =BEGIN= ... =END= ::
349 Keywords and blocks are written in uppercase to enhance their
350 readability, but you can use lowercase in your Org files.
352 *** Key bindings and commands
357 The manual lists both the keys and the corresponding commands for
358 accessing a functionality. Org mode often uses the same key for
359 different functions, depending on context. The command that is bound
360 to such keys has a generic name, like ~org-metaright~. In the manual
361 we will, wherever possible, give the function that is internally
362 called by the generic command. For example, in the chapter on
363 document structure, {{{kbd(M-RIGHT)}}} will be listed to call
364 ~org-do-demote~, while in the chapter on tables, it will be listed to
365 call ~org-table-move-column-right~.
369 :DESCRIPTION: A tree works like your brain.
371 #+cindex: document structure
372 #+cindex: structure of document
374 Org is based on Outline mode and provides flexible commands to
375 edit the structure of the document.
379 :DESCRIPTION: Org is based on Outline mode.
382 #+cindex: Outline mode
384 Org is implemented on top of Outline mode. Outlines allow a document
385 to be organized in a hierarchical structure, which, least for me, is
386 the best representation of notes and thoughts. An overview of this
387 structure is achieved by folding, i.e., hiding large parts of the
388 document to show only the general document structure and the parts
389 currently being worked on. Org greatly simplifies the use of outlines
390 by compressing the entire show and hide functionalities into a single
391 command, ~org-cycle~, which is bound to the {{{kbd(TAB)}}} key.
395 :DESCRIPTION: How to typeset Org tree headlines.
398 #+cindex: outline tree
399 #+vindex: org-special-ctrl-a/e
400 #+vindex: org-special-ctrl-k
401 #+vindex: org-ctrl-k-protect-subtree
403 Headlines define the structure of an outline tree. The headlines in
404 Org start with one or more stars, on the left margin[fn:3]. For
408 ,* Top level headline
414 ,* Another top level headline
417 #+vindex: org-footnote-section
419 Note that the name defined in ~org-footnote-section~ is reserved. Do
420 not use it as a title for your own headings.
422 Some people find the many stars too noisy and would prefer an outline
423 that has whitespace followed by a single star as headline starters.
424 See [[*A Cleaner Outline View]].
426 #+vindex: org-cycle-separator-lines
427 An empty line after the end of a subtree is considered part of it and
428 is hidden when the subtree is folded. However, if you leave at least
429 two empty lines, one empty line remains visible after folding the
430 subtree, in order to structure the collapsed view. See the variable
431 ~org-cycle-separator-lines~ to modify this behavior.
433 ** Visibility Cycling
435 :DESCRIPTION: Show and hide, much simplified.
437 #+cindex: cycling, visibility
438 #+cindex: visibility cycling
439 #+cindex: trees, visibility
440 #+cindex: show hidden text
443 *** Global and local cycling
445 :DESCRIPTION: Cycling through various visibility states.
447 #+cindex: subtree visibility states
448 #+cindex: subtree cycling
449 #+cindex: folded, subtree visibility state
450 #+cindex: children, subtree visibility state
451 #+cindex: subtree, subtree visibility state
453 Outlines make it possible to hide parts of the text in the buffer.
454 Org uses just two commands, bound to {{{kbd(TAB)}}} and
455 {{{kbd(S-TAB)}}} to change the visibility in the buffer.
457 #+attr_texinfo: :sep ,
458 - {{{kbd(TAB)}}} (~org-cycle~) ::
462 /Subtree cycling/: Rotate current subtree among the states
465 ,-> FOLDED -> CHILDREN -> SUBTREE --.
466 '-----------------------------------'
469 #+vindex: org-cycle-emulate-tab
470 The cursor must be on a headline for this to work[fn:4].
472 - {{{kbd(S-TAB)}}} (~org-global-cycle~), {{{kbd(C-u TAB)}}} ::
474 #+cindex: global visibility states
475 #+cindex: global cycling
476 #+cindex: overview, global visibility state
477 #+cindex: contents, global visibility state
478 #+cindex: show all, global visibility state
481 #+findex: org-global-cycle
482 /Global cycling/: Rotate the entire buffer among the states
485 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
486 '--------------------------------------'
489 When {{{kbd(S-TAB)}}} is called with a numeric prefix argument N,
490 the CONTENTS view up to headlines of level N are shown. Note
491 that inside tables (see [[*Tables]]), {{{kbd(S-TAB)}}} jumps to the
492 previous field instead.
494 #+vindex: org-cycle-global-at-bob
495 You can run global cycling using {{{kbd(TAB)}}} only if point is
496 at the very beginning of the buffer, but not on a headline, and
497 ~org-cycle-global-at-bob~ is set to a non-~nil~ value.
499 - {{{kbd(C-u C-u TAB)}}} (~org-set-startup-visibility~) ::
501 #+cindex: startup visibility
502 #+kindex: C-u C-u TAB
503 #+findex: org-set-startup-visibility
504 Switch back to the startup visibility of the buffer (see [[*Initial
507 - {{{kbd(C-u C-u C-u TAB)}}} (~outline-show-all~) ::
509 #+cindex: show all, command
510 #+kindex: C-u C-u C-u TAB
511 #+findex: outline-show-all
512 Show all, including drawers.
514 - {{{kbd(C-c C-r)}}} (~org-reveal~) ::
516 #+cindex: revealing context
519 Reveal context around point, showing the current entry, the
520 following heading and the hierarchy above. Useful for working
521 near a location that has been exposed by a sparse tree command
522 (see [[*Sparse Trees]]) or an agenda command (see [[*Commands in the
523 Agenda Buffer]]). With a prefix argument show, on each level, all
524 sibling headings. With a double prefix argument, also show the
525 entire subtree of the parent.
527 - {{{kbd(C-c C-k)}}} (~outline-show-branches~) ::
529 #+cindex: show branches, command
531 #+findex: outline-show-branches
532 Expose all the headings of the subtree, CONTENTS view for just
535 - {{{kbd(C-c TAB)}}} (~outline-show-children~) ::
537 #+cindex: show children, command
539 #+findex: outline-show-children
540 Expose all direct children of the subtree. With a numeric prefix
541 argument N, expose all children down to level N.
543 - {{{kbd(C-c C-x b)}}} (~org-tree-to-indirect-buffer~) ::
546 #+findex: org-tree-to-indirect-buffer
547 Show the current subtree in an indirect buffer[fn:5]. With
548 a numeric prefix argument, N, go up to level N and then take that
549 tree. If N is negative then go up that many levels. With
550 a {{{kbd(C-u)}}} prefix, do not remove the previously used
553 - {{{kbd(C-c C-x v)}}} (~org-copy-visible~) ::
556 #+findex: org-copy-visible
557 Copy the /visible/ text in the region into the kill ring.
559 *** Initial visibility
561 :DESCRIPTION: Setting the initial visibility state.
564 #+vindex: org-startup-folded
565 When Emacs first visits an Org file, the global state is set to
566 OVERVIEW, i.e., only the top level headlines are visible[fn:6]. This
567 can be configured through the variable ~org-startup-folded~, or on
568 a per-file basis by adding one of the following lines anywhere in the
571 #+cindex: STARTUP, keyword
576 ,#+STARTUP: showeverything
579 #+cindex: @samp{VISIBILITY}, property
581 Furthermore, any entries with a =VISIBILITY= property (see [[*Properties
582 and Columns]]) get their visibility adapted accordingly. Allowed values
583 for this property are =folded=, =children=, =content=, and ~all~.
585 - {{{kbd(C-u C-u TAB)}}} (~org-set-startup-visibility~) ::
587 #+kindex: C-u C-u TAB
588 #+findex: org-set-startup-visibility
589 Switch back to the startup visibility of the buffer, i.e.,
590 whatever is requested by startup options and =VISIBILITY=
591 properties in individual entries.
593 *** Catching invisible edits
595 :DESCRIPTION: Preventing mistakes when editing invisible parts.
597 #+cindex: edits, catching invisible
599 #+vindex: org-catch-invisible-edits
600 Sometimes you may inadvertently edit an invisible part of the buffer
601 and be confused on what has been edited and how to undo the mistake.
602 Setting ~org-catch-invisible-edits~ to non-~nil~ helps preventing
603 this. See the docstring of this option on how Org should catch
604 invisible edits and process them.
608 :DESCRIPTION: Jumping to other headlines.
610 #+cindex: motion, between headlines
611 #+cindex: jumping, to headlines
612 #+cindex: headline navigation
614 The following commands jump to other headlines in the buffer.
616 - {{{kbd(C-c C-n)}}} (~outline-next-visible-heading~) ::
619 #+findex: outline-next-visible-heading
622 - {{{kbd(C-c C-p)}}} (~outline-previous-visible-heading~) ::
625 #+findex: outline-previous-visible-heading
628 - {{{kbd(C-c C-f)}}} (~org-forward-same-level~) ::
631 #+findex: org-forward-same-level
632 Next heading same level.
634 - {{{kbd(C-c C-b)}}} (~org-backward-same-level~) ::
637 #+findex: org-backward-same-level
638 Previous heading same level.
640 - {{{kbd(C-c C-u)}}} (~outline-up-heading~) ::
643 #+findex: outline-up-heading
644 Backward to higher level heading.
646 - {{{kbd(C-c C-j)}}} (~org-goto~) ::
650 #+vindex: org-goto-auto-isearch
651 Jump to a different place without changing the current outline
652 visibility. Shows the document structure in a temporary buffer,
653 where you can use the following keys to find your destination:
655 #+attr_texinfo: :columns 0.3 0.7
656 | {{{kbd(TAB)}}} | Cycle visibility. |
657 | {{{kbd(DOWN)}}} / {{{kbd(UP)}}} | Next/previous visible headline. |
658 | {{{kbd(RET)}}} | Select this location. |
659 | {{{kbd(/)}}} | Do a Sparse-tree search |
662 The following keys work if you turn off ~org-goto-auto-isearch~
664 #+attr_texinfo: :columns 0.3 0.7
665 | {{{kbd(n)}}} / {{{kbd(p)}}} | Next/previous visible headline. |
666 | {{{kbd(f)}}} / {{{kbd(b)}}} | Next/previous headline same level. |
667 | {{{kbd(u)}}} | One level up. |
668 | {{{kbd(0)}}} ... {{{kbd(9)}}} | Digit argument. |
669 | {{{kbd(q)}}} | Quit. |
671 #+vindex: org-goto-interface
673 See also the variable ~org-goto-interface~.
677 :DESCRIPTION: Changing sequence and level of headlines.
679 #+cindex: structure editing
680 #+cindex: headline, promotion and demotion
681 #+cindex: promotion, of subtrees
682 #+cindex: demotion, of subtrees
683 #+cindex: subtree, cut and paste
684 #+cindex: pasting, of subtrees
685 #+cindex: cutting, of subtrees
686 #+cindex: copying, of subtrees
687 #+cindex: sorting, of subtrees
688 #+cindex: subtrees, cut and paste
690 - {{{kbd(M-RET)}}} (~org-meta-return~) ::
693 #+findex: org-meta-return
694 #+vindex: org-M-RET-may-split-line
695 Insert a new heading, item or row.
697 If the command is used at the /beginning/ of a line, and if there
698 is a heading or a plain list item (see [[*Plain Lists]]) at point,
699 the new heading/item is created /before/ the current line. When
700 used at the beginning of a regular line of text, turn that line
703 When this command is used in the middle of a line, the line is
704 split and the rest of the line becomes the new item or headline.
705 If you do not want the line to be split, customize
706 ~org-M-RET-may-split-line~.
708 Calling the command with a {{{kbd(C-u)}}} prefix unconditionally
709 inserts a new heading at the end of the current subtree, thus
710 preserving its contents. With a double {{{kbd(C-u C-u)}}}
711 prefix, the new heading is created at the end of the parent
714 - {{{kbd(C-RET)}}} (~org-insert-heading-respect-content~) ::
717 #+findex: org-insert-heading-respect-content
718 Insert a new heading at the end of the current subtree.
720 - {{{kbd(M-S-RET)}}} (~org-insert-todo-heading~) ::
723 #+findex: org-insert-todo-heading
724 #+vindex: org-treat-insert-todo-heading-as-state-change
725 Insert new TODO entry with same level as current heading. See
727 ~org-treat-insert-todo-heading-as-state-change~.
729 - {{{kbd(C-S-RET)}}} (~org-insert-todo-heading-respect-content~) ::
732 #+findex: org-insert-todo-heading-respect-content
733 Insert new TODO entry with same level as current heading. Like
734 {{{kbd(C-RET)}}}, the new headline is inserted after the current
737 - {{{kbd(TAB)}}} (~org-cycle~) ::
741 In a new entry with no text yet, the first {{{kbd(TAB)}}} demotes
742 the entry to become a child of the previous one. The next
743 {{{kbd(TAB)}}} makes it a parent, and so on, all the way to top
744 level. Yet another {{{kbd(TAB)}}}, and you are back to the
747 - {{{kbd(M-LEFT)}}} (~org-do-promote~) ::
750 #+findex: org-do-promote
751 Promote current heading by one level.
753 - {{{kbd(M-RIGHT)}}} (~org-do-demote~) ::
756 #+findex: org-do-demote
757 Demote current heading by one level.
759 - {{{kbd(M-S-LEFT)}}} (~org-promote-subtree~) ::
762 #+findex: org-promote-subtree
763 Promote the current subtree by one level.
765 - {{{kbd(M-S-RIGHT)}}} (~org-demote-subtree~) ::
768 #+findex: org-demote-subtree
769 Demote the current subtree by one level.
771 - {{{kbd(M-UP)}}} (~org-move-subtree-up~) ::
774 #+findex: org-move-subtree-up
775 Move subtree up, i.e., swap with previous subtree of same level.
777 - {{{kbd(M-DOWN)}}} (~org-move-subtree-down~) ::
780 #+findex: org-move-subtree-down
781 Move subtree down, i.e., swap with next subtree of same level.
783 - {{{kbd(C-c @)}}} (~org-mark-subtree~) ::
786 #+findex: org-mark-subtree
787 Mark the subtree at point. Hitting repeatedly marks subsequent
788 subtrees of the same level as the marked subtree.
790 - {{{kbd(C-c C-x C-w)}}} (~org-cut-subtree~) ::
792 #+kindex: C-c C-x C-w
793 #+findex: org-cut-subtree
794 Kill subtree, i.e., remove it from buffer but save in kill ring.
795 With a numeric prefix argument N, kill N sequential subtrees.
797 - {{{kbd(C-c C-x M-w)}}} (~org-copy-subtree~) ::
799 #+kindex: C-c C-x M-w
800 #+findex: org-copy-subtree
801 Copy subtree to kill ring. With a numeric prefix argument N,
802 copy the N sequential subtrees.
804 - {{{kbd(C-c C-x C-y)}}} (~org-paste-subtree~) ::
806 #+kindex: C-c C-x C-y
807 #+findex: org-paste-subtree
808 Yank subtree from kill ring. This does modify the level of the
809 subtree to make sure the tree fits in nicely at the yank
810 position. The yank level can also be specified with a numeric
811 prefix argument, or by yanking after a headline marker like
814 - {{{kbd(C-y)}}} (~org-yank~) ::
818 #+vindex: org-yank-adjusted-subtrees
819 #+vindex: org-yank-folded-subtrees
820 Depending on the variables ~org-yank-adjusted-subtrees~ and
821 ~org-yank-folded-subtrees~, Org's internal ~yank~ command pastes
822 subtrees folded and in a clever way, using the same command as
823 {{{kbd(C-c C-x C-y)}}}. With the default settings, no level
824 adjustment takes place, but the yanked tree is folded unless
825 doing so would swallow text previously visible. Any prefix
826 argument to this command forces a normal ~yank~ to be executed,
827 with the prefix passed along. A good way to force a normal yank
828 is {{{kbd(C-u C-y)}}}. If you use ~yank-pop~ after a yank, it
829 yanks previous kill items plainly, without adjustment and
832 - {{{kbd(C-c C-x c)}}} (~org-clone-subtree-with-time-shift~) ::
835 #+findex: org-clone-subtree-with-time-shift
836 Clone a subtree by making a number of sibling copies of it. You
837 are prompted for the number of copies to make, and you can also
838 specify if any timestamps in the entry should be shifted. This
839 can be useful, for example, to create a number of tasks related
840 to a series of lectures to prepare. For more details, see the
841 docstring of the command ~org-clone-subtree-with-time-shift~.
843 - {{{kbd(C-c C-w)}}} (~org-refile~) ::
847 Refile entry or region to a different location. See [[Refile and
850 - {{{kbd(C-c ^)}}} (~org-sort~) ::
854 Sort same-level entries. When there is an active region, all
855 entries in the region are sorted. Otherwise the children of the
856 current headline are sorted. The command prompts for the sorting
857 method, which can be alphabetically, numerically, by time---first
858 timestamp with active preferred, creation time, scheduled time,
859 deadline time---by priority, by TODO keyword---in the sequence
860 the keywords have been defined in the setup---or by the value of
861 a property. Reverse sorting is possible as well. You can also
862 supply your own function to extract the sorting key. With
863 a {{{kbd(C-u)}}} prefix, sorting is case-sensitive.
865 - {{{kbd(C-x n s)}}} (~org-narrow-to-subtree~) ::
868 #+findex: org-narrow-to-subtree
869 Narrow buffer to current subtree.
871 - {{{kbd(C-x n b)}}} (~org-narrow-to-block~) ::
874 #+findex: org-narrow-to-block
875 Narrow buffer to current block.
877 - {{{kbd(C-x n w)}}} (~widen~) ::
881 Widen buffer to remove narrowing.
883 - {{{kbd(C-c *)}}} (~org-toggle-heading~) ::
886 #+findex: org-toggle-heading
887 Turn a normal line or plain list item into a headline---so that
888 it becomes a subheading at its location. Also turn a headline
889 into a normal line by removing the stars. If there is an active
890 region, turn all lines in the region into headlines. If the
891 first line in the region was an item, turn only the item lines
892 into headlines. Finally, if the first line is a headline, remove
893 the stars from all headlines in the region.
895 #+cindex: region, active
896 #+cindex: active region
897 #+cindex: transient mark mode
898 When there is an active region---i.e., when Transient Mark mode is
899 active---promotion and demotion work on all headlines in the region.
900 To select a region of headlines, it is best to place both point and
901 mark at the beginning of a line, mark at the beginning of the first
902 headline, and point at the line just after the last headline to
903 change. Note that when the cursor is inside a table (see [[*Tables]]),
904 the Meta-Cursor keys have different functionality.
908 :DESCRIPTION: Matches embedded in context.
910 #+cindex: sparse trees
911 #+cindex: trees, sparse
912 #+cindex: folding, sparse trees
913 #+cindex: occur, command
915 #+vindex: org-show-context-detail
916 An important feature of Org mode is the ability to construct /sparse
917 trees/ for selected information in an outline tree, so that the entire
918 document is folded as much as possible, but the selected information
919 is made visible along with the headline structure above it[fn:7].
920 Just try it out and you will see immediately how it works.
922 Org mode contains several commands creating such trees, all these
923 commands can be accessed through a dispatcher:
925 - {{{kbd(C-c /)}}} (~org-sparse-tree~) ::
928 #+findex: org-sparse-tree
929 This prompts for an extra key to select a sparse-tree creating
932 - {{{kbd(C-c / r)}}} or {{{kbd(C-c / /)}}} (~org-occur~) ::
937 #+vindex: org-remove-highlights-with-change
938 Prompts for a regexp and shows a sparse tree with all matches.
939 If the match is in a headline, the headline is made visible. If
940 the match is in the body of an entry, headline and body are made
941 visible. In order to provide minimal context, also the full
942 hierarchy of headlines above the match is shown, as well as the
943 headline following the match. Each match is also highlighted;
944 the highlights disappear when the buffer is changed by an editing
945 command, or by pressing {{{kbd(C-c C-c)}}}[fn:8]. When called
946 with a {{{kbd(C-u)}}} prefix argument, previous highlights are
947 kept, so several calls to this command can be stacked.
949 - {{{kbd(M-g n)}}} or {{{kbd(M-g M-n)}}} (~next-error~) ::
954 Jump to the next sparse tree match in this buffer.
956 - {{{kbd(M-g p)}}} or {{{kbd(M-g M-p)}}} (~previous-error~) ::
960 #+findex: previous-error
961 Jump to the previous sparse tree match in this buffer.
963 #+vindex: org-agenda-custom-commands
965 For frequently used sparse trees of specific search strings, you can
966 use the variable ~org-agenda-custom-commands~ to define fast keyboard
967 access to specific sparse trees. These commands will then be
968 accessible through the agenda dispatcher (see [[*The Agenda Dispatcher]]).
971 #+begin_src emacs-lisp
972 (setq org-agenda-custom-commands
973 '(("f" occur-tree "FIXME")))
977 defines the key {{{kbd(f)}}} as a shortcut for creating a sparse tree
978 matching the string =FIXME=.
980 The other sparse tree commands select headings based on TODO keywords,
981 tags, or properties and are discussed later in this manual.
984 #+cindex: printing sparse trees
985 #+cindex: visible text, printing
986 To print a sparse tree, you can use the Emacs command
987 ~ps-print-buffer-with-faces~ which does not print invisible parts of
988 the document. Or you can use the command {{{kbd(C-c C-e v)}}} to
989 export only the visible part of the document and print the resulting
994 :DESCRIPTION: Additional structure within an entry.
996 #+cindex: plain lists
997 #+cindex: lists, plain
998 #+cindex: lists, ordered
999 #+cindex: ordered lists
1001 Within an entry of the outline tree, hand-formatted lists can provide
1002 additional structure. They also provide a way to create lists of
1003 checkboxes (see [[*Checkboxes]]). Org supports editing such lists, and
1004 every exporter (see [[*Exporting]]) can parse and format them.
1006 Org knows ordered lists, unordered lists, and description lists.
1008 #+attr_texinfo: :indic @bullet
1009 - /Unordered/ list items start with =-=, =+=, or =*=[fn:9] as bullets.
1012 #+vindex: org-plain-list-ordered-item-terminator
1013 #+vindex: org-alphabetical-lists
1014 /Ordered/ list items start with a numeral followed by either
1015 a period or a right parenthesis[fn:10], such as =1.= or =1)=[fn:11]
1016 If you want a list to start with a different value---e.g.,
1017 20---start the text of the item with =[@20]=[fn:12]. Those
1018 constructs can be used in any item of the list in order to enforce
1019 a particular numbering.
1021 - /Description/ list items are unordered list items, and contain the
1022 separator =::= to distinguish the description /term/ from the
1025 Items belonging to the same list must have the same indentation on the
1026 first line. In particular, if an ordered list reaches number =10.=,
1027 then the 2-digit numbers must be written left-aligned with the other
1028 numbers in the list. An item ends before the next line that is less
1029 or equally indented than its bullet/number.
1031 A list ends whenever every item has ended, which means before any line
1032 less or equally indented than items at top level. It also ends before
1033 two blank lines. In that case, all items are closed. Here is an
1037 ,* Lord of the Rings
1038 My favorite scenes are (in this order)
1039 1. The attack of the Rohirrim
1040 2. Eowyn's fight with the witch king
1041 + this was already my favorite scene in the book
1042 + I really like Miranda Otto.
1043 3. Peter Jackson being shot by Legolas
1045 He makes a really funny face when it happens.
1046 But in the end, no individual scenes matter but the film as a whole.
1047 Important actors in this film are:
1048 - Elijah Wood :: He plays Frodo
1049 - Sean Astin :: He plays Sam, Frodo's friend. I still remember him
1050 very well from his role as Mikey Walsh in /The Goonies/.
1053 Org supports these lists by tuning filling and wrapping commands to
1054 deal with them correctly, and by exporting them properly (see
1055 [[Exporting]]). Since indentation is what governs the structure of these
1056 lists, many structural constructs like =#+BEGIN_= blocks can be
1057 indented to signal that they belong to a particular item.
1059 #+vindex: org-list-demote-modify-bullet
1060 #+vindex: org-list-indent-offset
1061 If you find that using a different bullet for a sub-list---than that
1062 used for the current list-level---improves readability, customize the
1063 variable ~org-list-demote-modify-bullet~. To get a greater difference
1064 of indentation between items and theirs sub-items, customize
1065 ~org-list-indent-offset~.
1067 #+vindex: org-list-automatic-rules
1068 The following commands act on items when the cursor is in the first
1069 line of an item---the line with the bullet or number. Some of them
1070 imply the application of automatic rules to keep list structure
1071 intact. If some of these actions get in your way, configure
1072 ~org-list-automatic-rules~ to disable them individually.
1074 #+attr_texinfo: :sep ,
1075 - {{{kbd(TAB)}}} (~org-cycle~) ::
1077 #+cindex: cycling, in plain lists
1080 #+vindex: org-cycle-include-plain-lists
1081 Items can be folded just like headline levels. Normally this
1082 works only if the cursor is on a plain list item. For more
1083 details, see the variable ~org-cycle-include-plain-lists~. If
1084 this variable is set to ~integrate~, plain list items are treated
1085 like low-level headlines. The level of an item is then given by
1086 the indentation of the bullet/number. Items are always
1087 subordinate to real headlines, however; the hierarchies remain
1088 completely separated. In a new item with no text yet, the first
1089 {{{kbd(TAB)}}} demotes the item to become a child of the previous
1090 one. Subsequent {{{kbd(TAB)}}}s move the item to meaningful
1091 levels in the list and eventually get it back to its initial
1094 - {{{kbd(M-RET)}}} (~org-insert-heading~) ::
1097 #+findex: org-insert-heading
1098 #+vindex: org-M-RET-may-split-line
1099 Insert new item at current level. With a prefix argument, force
1100 a new heading (see [[*Structure Editing]]). If this command is used
1101 in the middle of an item, that item is /split/ in two, and the
1102 second part becomes the new item[fn:13]. If this command is
1103 executed /before item's body/, the new item is created /before/
1106 - {{{kbd(M-S-RET)}}} ::
1109 Insert a new item with a checkbox (see [[Checkboxes]]).
1111 - {{{kbd(S-UP)}}}, {{{kbd(S-DOWN)}}} ::
1115 #+cindex: shift-selection-mode
1116 #+vindex: org-support-shift-select
1117 #+vindex: org-list-use-circular-motion
1118 Jump to the previous/next item in the current list, but only if
1119 ~org-support-shift-select~ is off[fn:14]. If not, you can
1120 still use paragraph jumping commands like {{{kbd(C-UP)}}}
1121 and {{{kbd(C-DOWN)}}} to quite similar effect.
1123 - {{{kbd(M-UP)}}}, {{{kbd(M-DOWN)}}} ::
1127 Move the item including subitems up/down[fn:15], i.e., swap with
1128 previous/next item of same indentation. If the list is ordered,
1129 renumbering is automatic.
1131 - {{{kbd(M-LEFT)}}}, {{{kbd(M-RIGHT)}}} ::
1135 Decrease/increase the indentation of an item, leaving children
1138 - {{{kbd(M-S-LEFT)}}}, {{{kbd(M-S-RIGHT)}}} ::
1142 Decrease/increase the indentation of the item, including
1143 subitems. Initially, the item tree is selected based on current
1144 indentation. When these commands are executed several times in
1145 direct succession, the initially selected region is used, even if
1146 the new indentation would imply a different hierarchy. To use
1147 the new hierarchy, break the command chain with a cursor motion
1150 As a special case, using this command on the very first item of
1151 a list moves the whole list. This behavior can be disabled by
1152 configuring ~org-list-automatic-rules~. The global indentation
1153 of a list has no influence on the text /after/ the list.
1155 - {{{kbd(C-c C-c)}}} ::
1158 If there is a checkbox (see [[Checkboxes]]) in the item line, toggle
1159 the state of the checkbox. In any case, verify bullets and
1160 indentation consistency in the whole list.
1162 - {{{kbd(C-c -)}}} ::
1165 #+vindex: org-plain-list-ordered-item-terminator
1166 Cycle the entire list level through the different
1167 itemize/enumerate bullets (=-=, =+=, =*=, =1.=, =1)=) or a subset
1168 of them, depending on ~org-plain-list-ordered-item-terminator~,
1169 the type of list, and its indentation. With a numeric prefix
1170 argument N, select the Nth bullet from this list. If there is an
1171 active region when calling this, selected text is changed into an
1172 item. With a prefix argument, all lines are converted to list
1173 items. If the first line already was a list item, any item
1174 marker is removed from the list. Finally, even without an active
1175 region, a normal line is converted into a list item.
1177 - {{{kbd(C-c *)}}} ::
1180 Turn a plain list item into a headline---so that it becomes
1181 a subheading at its location. See [[*Structure Editing]], for
1182 a detailed explanation.
1184 - {{{kbd(C-c C-*)}}} ::
1187 Turn the whole plain list into a subtree of the current heading.
1188 Checkboxes (see [[*Checkboxes]]) become TODO, respectively DONE,
1189 keywords when unchecked, respectively checked.
1191 - {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} ::
1193 #+vindex: org-support-shift-select
1196 This command also cycles bullet styles when the cursor in on the
1197 bullet or anywhere in an item line, details depending on
1198 ~org-support-shift-select~.
1200 - {{{kbd(C-c ^)}}} ::
1203 #+cindex: sorting, of plain list
1204 Sort the plain list. Prompt for the sorting method: numerically,
1205 alphabetically, by time, or by custom function.
1209 :DESCRIPTION: Tucking stuff away.
1212 #+cindex: visibility cycling, drawers
1214 Sometimes you want to keep information associated with an entry, but
1215 you normally do not want to see it. For this, Org mode has /drawers/.
1216 They can contain anything but a headline and another drawer. Drawers
1220 ,** This is a headline
1221 Still outside the drawer
1223 This is inside the drawer.
1229 #+findex: org-insert-drawer
1230 You can interactively insert a drawer at point by calling
1231 ~org-insert-drawer~, which is bound to {{{kbd(C-c C-x d)}}}. With an
1232 active region, this command puts the region inside the drawer. With
1233 a prefix argument, this command calls ~org-insert-property-drawer~,
1234 which creates a =PROPERTIES= drawer right below the current headline.
1235 Org mode uses this special drawer for storing properties (see
1236 [[*Properties and Columns]]). You cannot use it for anything else.
1238 Completion over drawer keywords is also possible using
1239 {{{kbd(M-TAB)}}}[fn:16].
1241 Visibility cycling (see [[*Visibility Cycling]]) on the headline hides and
1242 shows the entry, but keep the drawer collapsed to a single line. In
1243 order to look inside the drawer, you need to move the cursor to the
1244 drawer line and press {{{kbd(TAB)}}} there.
1246 You can also arrange for state change notes (see [[Tracking TODO state
1247 changes]]) and clock times (see [[*Clocking Work Time]]) to be stored in
1248 a =LOGBOOK= drawer. If you want to store a quick note there, in
1249 a similar way to state changes, use
1251 - {{{kbd(C-c C-z)}}} ::
1254 Add a time-stamped note to the =LOGBOOK= drawer.
1258 :DESCRIPTION: Folding blocks.
1260 #+vindex: org-hide-block-startup
1261 #+cindex: blocks, folding
1263 Org mode uses =#+BEGIN= ... =#+END= blocks for various purposes from
1264 including source code examples (see [[*Literal Examples]]) to capturing
1265 time logging information (see [[*Clocking Work Time]]). These blocks can
1266 be folded and unfolded by pressing {{{kbd(TAB)}}} in the =#+BEGIN=
1267 line. You can also get all blocks folded at startup by configuring
1268 the variable ~org-hide-block-startup~ or on a per-file basis by using
1270 #+cindex: STARTUP, keyword
1272 ,#+STARTUP: hideblocks
1273 ,#+STARTUP: nohideblocks
1276 ** Creating Footnotes
1278 :DESCRIPTION: How footnotes are defined in Org's syntax.
1282 Org mode supports the creation of footnotes.
1284 A footnote is started by a footnote marker in square brackets in
1285 column 0, no indentation allowed. It ends at the next footnote
1286 definition, headline, or after two consecutive empty lines. The
1287 footnote reference is simply the marker in square brackets, inside
1288 text. Markers always start with =fn:=. For example:
1291 The Org homepage[fn:1] now looks a lot better than it used to.
1293 [fn:1] The link is: https://orgmode.org
1296 Org mode extends the number-based syntax to /named/ footnotes and
1297 optional inline definition. Here are the valid references:
1301 A named footnote reference, where {{{var(NAME)}}} is a unique
1302 label word, or, for simplicity of automatic creation, a number.
1304 - =[fn:: This is the inline definition of this footnote]= ::
1306 A LaTeX-like anonymous footnote where the definition is given
1307 directly at the reference point.
1309 - =[fn:NAME: a definition]= ::
1311 An inline definition of a footnote, which also specifies a name
1312 for the note. Since Org allows multiple references to the same
1313 note, you can then use =[fn:NAME]= to create additional
1316 #+vindex: org-footnote-auto-label
1317 Footnote labels can be created automatically, or you can create names
1318 yourself. This is handled by the variable ~org-footnote-auto-label~
1319 and its corresponding =STARTUP= keywords. See the docstring of that
1320 variable for details.
1322 #+texinfo: @noindent
1323 The following command handles footnotes:
1325 - {{{kbd(C-c C-x f)}}} ::
1327 The footnote action command.
1330 When the cursor is on a footnote reference, jump to the
1331 definition. When it is at a definition, jump to
1332 the---first---reference.
1334 #+vindex: org-footnote-define-inline
1335 #+vindex: org-footnote-section
1336 Otherwise, create a new footnote. Depending on the variable
1337 ~org-footnote-define-inline~[fn:17], the definition is placed
1338 right into the text as part of the reference, or separately into
1339 the location determined by the variable ~org-footnote-section~.
1341 When this command is called with a prefix argument, a menu of
1342 additional options is offered:
1344 #+attr_texinfo: :columns 0.1 0.9
1345 | {{{kbd(s)}}} | Sort the footnote definitions by reference sequence. |
1346 | {{{kbd(r)}}} | Renumber the simple =fn:N= footnotes. |
1347 | {{{kbd(S)}}} | Short for first {{{kbd(r)}}}, then {{{kbd(s)}}} action. |
1348 | {{{kbd(n)}}} | Rename all footnotes into a =fn:1= ... =fn:n= sequence. |
1349 | {{{kbd(d)}}} | Delete the footnote at point, including definition and references. |
1351 #+vindex: org-footnote-auto-adjust
1352 Depending on the variable ~org-footnote-auto-adjust~[fn:18],
1353 renumbering and sorting footnotes can be automatic after each
1354 insertion or deletion.
1356 - {{{kbd(C-c C-c)}}} ::
1359 If the cursor is on a footnote reference, jump to the definition.
1360 If it is at the definition, jump back to the reference. When
1361 called at a footnote location with a prefix argument, offer the
1362 same menu as {{{kbd(C-c C-x f)}}}.
1364 - {{{kbd(C-c C-o)}}} or {{{kbd(mouse-1/2)}}} ::
1369 Footnote labels are also links to the corresponding definition or
1370 reference, and you can use the usual commands to follow these
1375 :DESCRIPTION: Formal description of Org's syntax.
1378 A reference document providing a formal description of Org's syntax is
1379 available as [[https://orgmode.org/worg/dev/org-syntax.html][a draft on Worg]], written and maintained by Nicolas
1380 Goaziou. It defines Org's core internal concepts such as =headlines=,
1381 =sections=, =affiliated keywords=, =(greater) elements= and =objects=.
1382 Each part of an Org file falls into one of the categories above.
1384 To explore the abstract structure of an Org buffer, run this in
1387 : M-: (org-element-parse-buffer) <RET>
1389 #+texinfo: @noindent
1390 It outputs a list containing the buffer's content represented as an
1391 abstract structure. The export engine relies on the information
1392 stored in this list. Most interactive commands---e.g., for structure
1393 editing---also rely on the syntactic meaning of the surrounding
1396 #+cindex: syntax checker
1399 You can check syntax in your documents using ~org-lint~ command.
1403 :DESCRIPTION: Pure magic for quick formatting.
1406 #+cindex: editing tables
1408 Org comes with a fast and intuitive table editor. Spreadsheet-like
1409 calculations are supported using the Emacs Calc package (see
1412 ** Built-in Table Editor
1414 :DESCRIPTION: Simple tables.
1416 #+cindex: table editor, built-in
1418 Org makes it easy to format tables in plain ASCII. Any line with =|=
1419 as the first non-whitespace character is considered part of a table.
1420 =|= is also the column separator[fn:19]. A table might look like
1424 | Name | Phone | Age |
1425 |-------+-------+-----|
1426 | Peter | 1234 | 17 |
1427 | Anna | 4321 | 25 |
1430 A table is re-aligned automatically each time you press
1431 {{{kbd(TAB)}}}, {{{kbd(RET)}}} or {{{kbd(C-c C-c)}}} inside the table.
1432 {{{kbd(TAB)}}} also moves to the next field---{{{kbd(RET)}}} to the
1433 next row---and creates new table rows at the end of the table or
1434 before horizontal lines. The indentation of the table is set by the
1435 first line. Any line starting with =|-= is considered as a horizontal
1436 separator line and will be expanded on the next re-align to span the
1437 whole table width. So, to create the above table, you would only type
1444 #+texinfo: @noindent
1445 and then press {{{kbd(TAB)}}} to align the table and start filling in
1446 fields. Even faster would be to type =|Name|Phone|Age= followed by
1449 When typing text into a field, Org treats {{{kbd(DEL)}}},
1450 {{{kbd(Backspace)}}}, and all character keys in a special way, so that
1451 inserting and deleting avoids shifting other fields. Also, when
1452 typing /immediately/ after the cursor was moved into a new field with
1453 {{{kbd(TAB)}}}, {{{kbd(S-TAB)}}} or {{{kbd(RET)}}}, the field is
1454 automatically made blank. If this behavior is too unpredictable for
1455 you, configure the option ~org-table-auto-blank-field~.
1457 *** Creation and conversion
1462 - {{{kbd(C-c |)}}} (~org-table-create-or-convert-from-region~) ::
1465 #+findex: org-table-create-or-convert-from-region
1466 Convert the active region to table. If every line contains at
1467 least one {{{kbd(TAB)}}} character, the function assumes that the
1468 material is tab separated. If every line contains a comma,
1469 comma-separated values (CSV) are assumed. If not, lines are
1470 split at whitespace into fields. You can use a prefix argument
1471 to force a specific separator: {{{kbd(C-u)}}} forces CSV,
1472 {{{kbd(C-u C-u)}}} forces {{{kbd(TAB)}}}, {{{kbd(C-u C-u C-u)}}}
1473 prompts for a regular expression to match the separator, and
1474 a numeric argument N indicates that at least N consecutive
1475 spaces, or alternatively a {{{kbd(TAB)}}} will be the separator.
1477 If there is no active region, this command creates an empty Org
1478 table. But it is easier just to start typing, like {{{kbd(|
1479 N a m e | P h o n e | A g e RET | - TAB)}}}.
1481 *** Re-aligning and field motion
1486 - {{{kbd(C-c C-c)}}} (~org-table-align~) ::
1489 #+findex: org-table-align
1490 Re-align the table without moving the cursor.
1492 - {{{kbd(TAB)}}} (~org-table-next-field~) ::
1495 #+findex: org-table-next-field
1496 Re-align the table, move to the next field. Creates a new row if
1499 - {{{kbd(C-c SPC)}}} (~org-table-blank-field~) ::
1502 #+findex: org-table-blank-field
1503 Blank the field at point.
1505 - {{{kbd(S-TAB)}}} (~org-table-previous-field~) ::
1508 #+findex: org-table-previous-field
1509 Re-align, move to previous field.
1511 - {{{kbd(RET)}}} (~org-table-next-row~) ::
1514 #+findex: org-table-next-row
1515 Re-align the table and move down to next row. Creates a new row
1516 if necessary. At the beginning or end of a line, {{{kbd(RET)}}}
1517 still inserts a new line, so it can be used to split a table.
1519 - {{{kbd(M-a)}}} (~org-table-beginning-of-field~) ::
1522 #+findex: org-table-beginning-of-field
1523 Move to beginning of the current table field, or on to the
1526 - {{{kbd(M-e)}}} (~org-table-end-of-field~) ::
1529 #+findex: org-table-end-of-field
1530 Move to end of the current table field, or on to the next field.
1532 *** Column and row editing
1537 - {{{kbd(M-LEFT)}}} (~org-table-move-column-left~) ::
1540 #+findex: org-table-move-column-left
1541 Move the current column left.
1543 - {{{kbd(M-RIGHT)}}} (~org-table-move-column-right~) ::
1546 #+findex: org-table-move-column-right
1547 Move the current column right.
1549 - {{{kbd(M-S-LEFT)}}} (~org-table-delete-column~) ::
1552 #+findex: org-table-delete-column
1553 Kill the current column.
1555 - {{{kbd(M-S-RIGHT)}}} (~org-table-insert-column~) ::
1558 #+findex: org-table-insert-column
1559 Insert a new column to the left of the cursor position.
1561 - {{{kbd(M-UP)}}} (~org-table-move-row-up~) ::
1564 #+findex: org-table-move-row-up
1565 Move the current row up.
1567 - {{{kbd(M-DOWN)}}} (~org-table-move-row-down~) ::
1570 #+findex: org-table-move-row-down
1571 Move the current row down.
1573 - {{{kbd(M-S-UP)}}} (~org-table-kill-row~) ::
1576 #+findex: org-table-kill-row
1577 Kill the current row or horizontal line.
1579 - {{{kbd(M-S-DOWN)}}} (~org-table-insert-row~) ::
1582 #+findex: org-table-insert-row
1583 Insert a new row above the current row. With a prefix argument,
1584 the line is created below the current one.
1586 - {{{kbd(C-c -)}}} (~org-table-insert-hline~) ::
1589 #+findex: org-table-insert-hline
1590 Insert a horizontal line below current row. With a prefix
1591 argument, the line is created above the current line.
1593 - {{{kbd(C-c RET)}}} (~org-table-hline-and-move~) ::
1596 #+findex: org-table-hline-and-move
1597 Insert a horizontal line below current row, and move the cursor
1598 into the row below that line.
1600 - {{{kbd(C-c ^)}}} (~org-table-sort-lines~) ::
1603 #+findex: org-table-sort-lines
1604 Sort the table lines in the region. The position of point
1605 indicates the column to be used for sorting, and the range of
1606 lines is the range between the nearest horizontal separator
1607 lines, or the entire table. If point is before the first column,
1608 you are prompted for the sorting column. If there is an active
1609 region, the mark specifies the first line and the sorting column,
1610 while point should be in the last line to be included into the
1611 sorting. The command prompts for the sorting type,
1612 alphabetically, numerically, or by time. You can sort in normal
1613 or reverse order. You can also supply your own key extraction
1614 and comparison functions. When called with a prefix argument,
1615 alphabetic sorting is case-sensitive.
1622 - {{{kbd(C-c C-x M-w)}}} (~org-table-copy-region~) ::
1624 #+kindex: C-c C-x M-w
1625 #+findex: org-table-copy-region
1626 Copy a rectangular region from a table to a special clipboard.
1627 Point and mark determine edge fields of the rectangle. If there
1628 is no active region, copy just the current field. The process
1629 ignores horizontal separator lines.
1631 - {{{kbd(C-c C-x C-w)}}} (~org-table-cut-region~) ::
1633 #+kindex: C-c C-x C-w
1634 #+findex: org-table-cut-region
1635 Copy a rectangular region from a table to a special clipboard,
1636 and blank all fields in the rectangle. So this is the "cut"
1639 - {{{kbd(C-c C-x C-y)}}} (~org-table-paste-rectangle~) ::
1641 #+kindex: C-c C-x C-y
1642 #+findex: org-table-paste-rectangle
1643 Paste a rectangular region into a table. The upper left corner
1644 ends up in the current field. All involved fields are
1645 overwritten. If the rectangle does not fit into the present
1646 table, the table is enlarged as needed. The process ignores
1647 horizontal separator lines.
1649 - {{{kbd(M-RET)}}} (~org-table-wrap-region~) ::
1652 #+findex: org-table-wrap-region
1653 Split the current field at the cursor position and move the rest
1654 to the line below. If there is an active region, and both point
1655 and mark are in the same column, the text in the column is
1656 wrapped to minimum width for the given number of lines.
1657 A numeric prefix argument may be used to change the number of
1658 desired lines. If there is no region, but you specify a prefix
1659 argument, the current field is made blank, and the content is
1660 appended to the field above.
1667 #+cindex: formula, in tables
1668 #+cindex: calculations, in tables
1670 - {{{kbd(C-c +)}}} (~org-table-sum~) ::
1673 #+findex: org-table-sum
1674 Sum the numbers in the current column, or in the rectangle
1675 defined by the active region. The result is shown in the echo
1676 area and can be inserted with {{{kbd(C-y)}}}.
1678 - {{{kbd(S-RET)}}} (~org-table-copy-down~) ::
1681 #+findex: org-table-copy-down
1682 #+vindex: org-table-copy-increment
1683 When current field is empty, copy from first non-empty field
1684 above. When not empty, copy current field down to next row and
1685 move cursor along with it. Depending on the variable
1686 ~org-table-copy-increment~, integer field values can be
1687 incremented during copy. Integers that are too large are not
1688 incremented, however. Also, a ~0~ prefix argument temporarily
1689 disables the increment. This key is also used by shift-selection
1690 and related modes (see [[*Packages that conflict with Org mode]]).
1697 - {{{kbd(C-c `)}}} (~org-table-edit-field~) ::
1700 #+findex: org-table-edit-field
1701 Edit the current field in a separate window. This is useful for
1702 fields that are not fully visible (see [[*Column Width and
1703 Alignment]]). When called with a {{{kbd(C-u)}}} prefix, just make
1704 the full field visible, so that it can be edited in place. When
1705 called with two {{{kbd(C-u)}}} prefixes, make the editor window
1706 follow the cursor through the table and always show the current
1707 field. The follow mode exits automatically when the cursor
1708 leaves the table, or when you repeat this command with {{{kbd(C-u
1711 - {{{kbd(M-x org-table-import)}}} ::
1713 #+findex: org-table-import
1714 Import a file as a table. The table should be TAB or whitespace
1715 separated. Use, for example, to import a spreadsheet table or
1716 data from a database, because these programs generally can write
1717 TAB-separated text files. This command works by inserting the
1718 file into the buffer and then converting the region to a table.
1719 Any prefix argument is passed on to the converter, which uses it
1720 to determine the separator.
1722 - {{{kbd(C-c |)}}} (~org-table-create-or-convert-from-region~) ::
1725 #+findex: org-table-create-or-convert-from-region
1726 Tables can also be imported by pasting tabular text into the Org
1727 buffer, selecting the pasted text with {{{kbd(C-x C-x)}}} and
1728 then using the {{{kbd(C-c |)}}} command (see [[*Creation and
1731 - {{{kbd(M-x org-table-export)}}} ::
1733 #+findex: org-table-export
1734 #+vindex: org-table-export-default-format
1735 Export the table, by default as a TAB-separated file. Use for
1736 data exchange with, for example, spreadsheet or database
1737 programs. The format used to export the file can be configured
1738 in the variable ~org-table-export-default-format~. You may also
1739 use properties =TABLE_EXPORT_FILE= and =TABLE_EXPORT_FORMAT= to
1740 specify the file name and the format for table export in
1741 a subtree. Org supports quite general formats for exported
1742 tables. The exporter format is the same as the format used by
1743 Orgtbl radio tables, see [[*Translator functions]], for a detailed
1746 ** Column Width and Alignment
1748 :DESCRIPTION: Overrule the automatic settings.
1750 #+cindex: narrow columns in tables
1751 #+cindex: alignment in tables
1753 The width of columns is automatically determined by the table editor.
1754 The alignment of a column is determined automatically from the
1755 fraction of number-like versus non-number fields in the column.
1757 #+vindex: org-table-automatic-realign
1758 Editing a field may modify alignment of the table. Moving
1759 a contiguous row or column---i.e., using {{{kbd(TAB)}}} or
1760 {{{kbd(RET)}}}---automatically re-aligns it. If you want to disable
1761 this behavior, set ~org-table-automatic-realign~ to ~nil~. In any
1762 case, you can always align manually a table:
1764 - {{{kbd(C-c C-c)}}} (~org-table-align~) ::
1767 #+findex: org-table-align
1768 Align the current table.
1770 #+texinfo: @noindent
1771 #+vindex: org-startup-align-all-tables
1772 Setting the option ~org-startup-align-all-tables~ re-aligns all tables
1773 in a file upon visiting it. You can also set this option on
1774 a per-file basis with:
1781 Sometimes a single field or a few fields need to carry more text,
1782 leading to inconveniently wide columns. Maybe you want to hide away
1783 several columns or display them with a fixed width, regardless of
1784 content, as shown in the following example.
1787 |---+---------------------+--------| |---+-------…|…|
1788 | | <6> | | | | <6> …|…|
1789 | 1 | one | some | ----\ | 1 | one …|…|
1790 | 2 | two | boring | ----/ | 2 | two …|…|
1791 | 3 | This is a long text | column | | 3 | This i…|…|
1792 |---+---------------------+--------| |---+-------…|…|
1795 To set the width of a column, one field anywhere in the column may
1796 contain just the string =<N>= where {{{var(N)}}} specifies the width
1797 as a number of characters. You control displayed width of columns
1798 with the following tools:
1800 - {{{kbd(C-c TAB)}}} (~org-table-toggle-column-width~) ::
1803 #+findex: org-table-toggle-column-width
1804 Shrink or expand current column.
1806 If a width cookie specifies a width W for the column, shrinking
1807 it displays the first W visible characters only. Otherwise, the
1808 column is shrunk to a single character.
1810 When called before the first column or after the last one, ask
1811 for a list of column ranges to operate on.
1813 - {{{kbd(C-u C-c TAB)}}} (~org-table-shrink~) ::
1815 #+kindex: C-u C-c TAB
1816 #+findex: org-table-shrink
1817 Shrink all columns with a column width. Expand the others.
1819 - {{{kbd(C-u C-u C-c TAB)}}} (~org-table-expand~) ::
1821 #+kindex: C-u C-u C-c TAB
1822 #+findex: org-table-expand
1825 To see the full text of a shrunk field, hold the mouse over it---a
1826 tool-tip window then shows the full content. Alternatively {{{kbd(C-h
1827 .)}}} (~display-local-help~) reveals the full content. For
1828 convenience, any change to a shrunk column expands it.
1830 #+vindex: org-startup-shrink-all-tables
1831 Setting the option ~org-startup-shrink-all-tables~ shrinks all columns
1832 containing a width cookie in a file the moment it is visited. You can
1833 also set this option on a per-file basis with:
1837 If you would like to overrule the automatic alignment of number-rich
1838 columns to the right and of string-rich columns to the left, you can
1839 use =<r>=, =<c>= or =<l>= in a similar fashion. You may also combine
1840 alignment and field width like this: =<r10>=.
1842 Lines which only contain these formatting cookies are removed
1843 automatically upon exporting the document.
1847 :DESCRIPTION: Grouping to trigger vertical lines.
1849 #+cindex: grouping columns in tables
1851 When Org exports tables, it does so by default without vertical lines
1852 because that is visually more satisfying in general. Occasionally
1853 however, vertical lines can be useful to structure a table into groups
1854 of columns, much like horizontal lines can do for groups of rows. In
1855 order to specify column groups, you can use a special row where the
1856 first field contains only =/=. The further fields can either contain
1857 =<= to indicate that this column should start a group, =>= to indicate
1858 the end of a column, or =<>= (no space between =<= and =>=) to make
1859 a column a group of its own. Upon export, boundaries between column
1860 groups are marked with vertical lines. Here is an example:
1863 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1864 |---+-----+-----+-----+---------+------------|
1865 | / | < | | > | < | > |
1866 | 1 | 1 | 1 | 1 | 1 | 1 |
1867 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1868 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1869 |---+-----+-----+-----+---------+------------|
1870 ,#+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
1873 It is also sufficient to just insert the column group starters after
1874 every vertical line you would like to have:
1877 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1878 |---+-----+-----+-----+---------+------------|
1882 ** The Orgtbl Minor Mode
1884 :DESCRIPTION: The table editor as minor mode.
1885 :ALT_TITLE: Orgtbl Mode
1887 #+cindex: Orgtbl mode
1888 #+cindex: minor mode for tables
1890 #+findex: orgtbl-mode
1891 If you like the intuitive way the Org table editor works, you might
1892 also want to use it in other modes like Text mode or Mail mode. The
1893 minor mode Orgtbl mode makes this possible. You can always toggle the
1894 mode with {{{kbd(M-x orgtbl-mode)}}}. To turn it on by default, for
1895 example in Message mode, use
1897 #+begin_src emacs-lisp
1898 (add-hook 'message-mode-hook 'turn-on-orgtbl)
1901 Furthermore, with some special setup, it is possible to maintain
1902 tables in arbitrary syntax with Orgtbl mode. For example, it is
1903 possible to construct LaTeX tables with the underlying ease and power
1904 of Orgtbl mode, including spreadsheet capabilities. For details, see
1905 [[*Tables in Arbitrary Syntax]].
1909 :DESCRIPTION: The table editor has spreadsheet capabilities.
1911 #+cindex: calculations, in tables
1912 #+cindex: spreadsheet capabilities
1913 #+cindex: Calc package
1915 The table editor makes use of the Emacs Calc package to implement
1916 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms
1917 to derive fields from other fields. While fully featured, Org's
1918 implementation is not identical to other spreadsheets. For example,
1919 Org knows the concept of a /column formula/ that will be applied to
1920 all non-header fields in a column without having to copy the formula
1921 to each relevant field. There is also a formula debugger, and
1922 a formula editor with features for highlighting fields in the table
1923 corresponding to the references at the point in the formula, moving
1924 these references by arrow keys.
1928 :DESCRIPTION: How to refer to another field or range.
1930 #+cindex: references
1932 To compute fields in the table from other fields, formulas must
1933 reference other fields or ranges. In Org, fields can be referenced by
1934 name, by absolute coordinates, and by relative coordinates. To find
1935 out what the coordinates of a field are, press {{{kbd(C-c ?)}}} in
1936 that field, or press {{{kbd(C-c })}}} to toggle the display of a grid.
1938 **** Field references
1943 #+cindex: field references
1944 #+cindex: references, to fields
1945 Formulas can reference the value of another field in two ways. Like
1946 in any other spreadsheet, you may reference fields with
1947 a letter/number combination like =B3=, meaning the second field in the
1948 third row. However, Org prefers to use another, more general
1949 representation that looks like this:[fn:20]
1953 Column specifications can be absolute like =$1=, =$2=, ..., =$N=, or
1954 relative to the current column, i.e., the column of the field which is
1955 being computed, like =$+1= or =$-2=. =$<= and =$>= are immutable
1956 references to the first and last column, respectively, and you can use
1957 =$>>>= to indicate the third column from the right.
1959 The row specification only counts data lines and ignores horizontal
1960 separator lines, or "hlines". Like with columns, you can use absolute
1961 row numbers =@1=, =@2=, ..., =@N=, and row numbers relative to the
1962 current row like =@+3= or =@-1=. =@<= and =@>= are immutable
1963 references the first and last row in the table, respectively. You may
1964 also specify the row relative to one of the hlines: =@I= refers to the
1965 first hline, =@II= to the second, etc. =@-I= refers to the first such
1966 line above the current line, =@+I= to the first such line below the
1967 current line. You can also write =@III+2= which is the second data
1968 line after the third hline in the table.
1970 =@0= and =$0= refer to the current row and column, respectively, i.e.,
1971 to the row/column for the field being computed. Also, if you omit
1972 either the column or the row part of the reference, the current
1973 row/column is implied.
1975 Org's references with /unsigned/ numbers are fixed references in the
1976 sense that if you use the same reference in the formula for two
1977 different fields, the same field is referenced each time. Org's
1978 references with /signed/ numbers are floating references because the
1979 same reference operator can reference different fields depending on
1980 the field being calculated by the formula.
1982 Here are a few examples:
1984 #+attr_texinfo: :columns 0.2 0.8
1985 | =@2$3= | 2nd row, 3rd column (same as =C2=) |
1986 | =$5= | column 5 in the current row (same as =E&=) |
1987 | =@2= | current column, row 2 |
1988 | =@-1$-3= | field one row up, three columns to the left |
1989 | =@-I$2= | field just under hline above current row, column 2 |
1990 | =@>$5= | field in the last row, in column 5 |
1992 **** Range references
1997 #+cindex: range references
1998 #+cindex: references, to ranges
1999 You may reference a rectangular range of fields by specifying two
2000 field references connected by two dots =..=. If both fields are in
2001 the current row, you may simply use =$2..$7=, but if at least one
2002 field is in a different row, you need to use the general =@ROW$COLUMN=
2003 format at least for the first field, i.e., the reference must start
2004 with =@= in order to be interpreted correctly. Examples:
2006 #+attr_texinfo: :columns 0.2 0.8
2007 | =$1..$3= | first three fields in the current row |
2008 | =$P..$Q= | range, using column names (see [[*Advanced features]]) |
2009 | =$<<<..$>>= | start in third column, continue to the last but one |
2010 | =@2$1..@4$3= | six fields between these two fields (same as =A2..C4=) |
2011 | =@-1$-2..@-1= | 3 fields in the row above, starting from 2 columns on the left |
2012 | =@I..II= | between first and second hline, short for =@I..@II= |
2014 #+texinfo: @noindent
2015 Range references return a vector of values that can be fed into Calc
2016 vector functions. Empty fields in ranges are normally suppressed, so
2017 that the vector contains only the non-empty fields. For other options
2018 with the mode switches =E=, =N= and examples, see [[*Formula syntax for
2021 **** Field coordinates in formulas
2026 #+cindex: field coordinates
2027 #+cindex: coordinates, of field
2028 #+cindex: row, of field coordinates
2029 #+cindex: column, of field coordinates
2030 #+vindex: org-table-current-column
2031 #+vindex: org-table-current-dline
2032 One of the very first actions during evaluation of Calc formulas and
2033 Lisp formulas is to substitute =@#= and =$#= in the formula with the
2034 row or column number of the field where the current result will go to.
2035 The traditional Lisp formula equivalents are ~org-table-current-dline~
2036 and ~org-table-current-column~. Examples:
2038 - =if(@# % 2, $#, string(""))= ::
2040 Insert column number on odd rows, set field to empty on even
2043 - =$2 = '(identity remote(FOO, @@#$1))= ::
2045 Copy text or values of each row of column 1 of the table named
2046 {{{var(FOO)}}} into column 2 of the current table.
2048 - =@3 = 2 * remote(FOO, @@1$$#)= ::
2050 Insert the doubled value of each column of row 1 of the table
2051 named {{{var(FOO)}}} into row 3 of the current table.
2053 #+texinfo: @noindent
2054 For the second and third examples, table {{{var(FOO)}}} must have at
2055 least as many rows or columns as the current table. Note that this is
2056 inefficient[fn:21] for large number of rows.
2058 **** Named references
2062 #+cindex: named references
2063 #+cindex: references, named
2064 #+cindex: name, of column or field
2065 #+cindex: constants, in calculations
2066 #+cindex: @samp{CONSTANTS}, keyword
2067 #+vindex: org-table-formula-constants
2069 =$name= is interpreted as the name of a column, parameter or constant.
2070 Constants are defined globally through the variable
2071 ~org-table-formula-constants~, and locally---for the file---through
2072 a line like this example:
2074 : #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2076 #+texinfo: @noindent
2077 #+vindex: constants-unit-system
2078 #+pindex: constants.el
2079 Also, properties (see [[*Properties and Columns]]) can be used as
2080 constants in table formulas: for a property =Xyz= use the name
2081 =$PROP_Xyz=, and the property will be searched in the current outline
2082 entry and in the hierarchy above it. If you have the =constants.el=
2083 package, it will also be used to resolve constants, including natural
2084 constants like =$h= for Planck's constant, and units like =$km= for
2085 kilometers[fn:22]. Column names and parameters can be specified in
2086 special table lines. These are described below, see [[*Advanced
2087 features]]. All names must start with a letter, and further consist of
2088 letters and numbers.
2090 **** Remote references
2095 #+cindex: remote references
2096 #+cindex: references, remote
2097 #+cindex: references, to a different table
2098 #+cindex: name, of column or field
2099 #+cindex: constants, in calculations
2100 #+cindex: @samp{NAME}, keyword
2101 You may also reference constants, fields and ranges from a different
2102 table, either in the current file or even in a different file. The
2107 #+texinfo: @noindent
2108 where {{{var(NAME)}}} can be the name of a table in the current file
2109 as set by a =#+NAME:= line before the table. It can also be the ID of
2110 an entry, even in a different file, and the reference then refers to
2111 the first table in that entry. {{{var(REF)}}} is an absolute field or
2112 range reference as described above for example =@3$3= or =$somename=,
2113 valid in the referenced table.
2115 #+cindex: table indirection
2116 When {{{var(NAME)}}} has the format =@ROW$COLUMN=, it is substituted
2117 with the name or ID found in this field of the current table. For
2118 example =remote($1, @@>$2)= \Rightarrow =remote(year_2013, @@>$1)=. The format
2119 =B3= is not supported because it can not be distinguished from a plain
2122 *** Formula syntax for Calc
2124 :DESCRIPTION: Using Calc to compute stuff.
2126 #+cindex: formula syntax, Calc
2127 #+cindex: syntax, of formulas
2129 A formula can be any algebraic expression understood by the Emacs
2130 =Calc= package. Note that =calc= has the non-standard convention that
2131 =/= has lower precedence than =*=, so that =a/b*c= is interpreted as
2132 =(a/(b*c))=. Before evaluation by ~calc-eval~ (see [[info:calc#Calling Calc from Your Programs][Calling Calc from
2133 Your Lisp Programs]]), variable substitution takes place according to
2134 the rules described above.
2136 #+cindex: vectors, in table calculations
2137 The range vectors can be directly fed into the Calc vector functions
2138 like ~vmean~ and ~vsum~.
2140 #+cindex: format specifier, in spreadsheet
2141 #+cindex: mode, for Calc
2142 #+vindex: org-calc-default-modes
2143 A formula can contain an optional mode string after a semicolon. This
2144 string consists of flags to influence Calc and other modes during
2145 execution. By default, Org uses the standard Calc modes (precision
2146 12, angular units degrees, fraction and symbolic modes off). The
2147 display format, however, has been changed to ~(float 8)~ to keep
2148 tables compact. The default settings can be configured using the
2149 variable ~org-calc-default-modes~.
2153 Set the internal Calc calculation precision to 20 digits.
2155 - =n3=, =s3=, =e2=, =f4= ::
2157 Normal, scientific, engineering or fixed format of the result of
2158 Calc passed back to Org. Calc formatting is unlimited in
2159 precision as long as the Calc calculation precision is greater.
2163 Degree and radian angle modes of Calc.
2167 Fraction and symbolic modes of Calc.
2171 Duration computations in Calc or Lisp, [[*Durations and time
2176 If and how to consider empty fields. Without =E= empty fields in
2177 range references are suppressed so that the Calc vector or Lisp
2178 list contains only the non-empty fields. With =E= the empty
2179 fields are kept. For empty fields in ranges or empty field
2180 references the value =nan= (not a number) is used in Calc
2181 formulas and the empty string is used for Lisp formulas. Add =N=
2182 to use 0 instead for both formula types. For the value of
2183 a field the mode =N= has higher precedence than =E=.
2187 Interpret all fields as numbers, use 0 for non-numbers. See the
2188 next section to see how this is essential for computations with
2189 Lisp formulas. In Calc formulas it is used only occasionally
2190 because there number strings are already interpreted as numbers
2195 Literal, for Lisp formulas only. See the next section.
2197 #+texinfo: @noindent
2198 Unless you use large integer numbers or high-precision calculation and
2199 display for floating point numbers you may alternatively provide
2200 a ~printf~ format specifier to reformat the Calc result after it has
2201 been passed back to Org instead of letting Calc already do the
2202 formatting[fn:23]. A few examples:
2204 | =$1+$2= | Sum of first and second field |
2205 | =$1+$2;%.2f= | Same, format result to two decimals |
2206 | =exp($2)+exp($1)= | Math functions can be used |
2207 | =$0;%.1f= | Reformat current cell to 1 decimal |
2208 | =($3-32)*5/9= | Degrees F \to C conversion |
2209 | =$c/$1/$cm= | Hz \to cm conversion, using =constants.el= |
2210 | =tan($1);Dp3s1= | Compute in degrees, precision 3, display SCI 1 |
2211 | =sin($1);Dp3%.1e= | Same, but use ~printf~ specifier for display |
2212 | =vmean($2..$7)= | Compute column range mean, using vector function |
2213 | =vmean($2..$7);EN= | Same, but treat empty fields as 0 |
2214 | =taylor($3,x=7,2)= | Taylor series of $3, at x=7, second degree |
2216 Calc also contains a complete set of logical operations (see [[info:calc#Logical%20Operations][Logical
2217 Operations]]). For example
2219 - =if($1 < 20, teen, string(""))= ::
2221 ="teen"= if age =$1= is less than 20, else the Org table result
2222 field is set to empty with the empty string.
2224 - =if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1= ::
2226 Sum of the first two columns. When at least one of the input
2227 fields is empty the Org table result field is set to empty. =E=
2228 is required to not convert empty fields to 0. =f-1= is an
2229 optional Calc format string similar to =%.1f= but leaves empty
2232 - =if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E= ::
2234 Mean value of a range unless there is any empty field. Every
2235 field in the range that is empty is replaced by =nan= which lets
2236 =vmean= result in =nan=. Then =typeof == 12= detects the =nan=
2237 from ~vmean~ and the Org table result field is set to empty. Use
2238 this when the sample set is expected to never have missing
2241 - =if("$1..$7" == "[]", string(""), vmean($1..$7))= ::
2243 Mean value of a range with empty fields skipped. Every field in
2244 the range that is empty is skipped. When all fields in the range
2245 are empty the mean value is not defined and the Org table result
2246 field is set to empty. Use this when the sample set can have
2249 - =vmean($1..$7); EN= ::
2251 To complete the example before: Mean value of a range with empty
2252 fields counting as samples with value 0. Use this only when
2253 incomplete sample sets should be padded with 0 to the full size.
2255 You can add your own Calc functions defined in Emacs Lisp with
2256 ~defmath~ and use them in formula syntax for Calc.
2258 *** Emacs Lisp forms as formulas
2260 :DESCRIPTION: Writing formulas in Emacs Lisp.
2261 :ALT_TITLE: Formula syntax for Lisp
2263 #+cindex: Lisp forms, as table formulas
2265 It is also possible to write a formula in Emacs Lisp. This can be
2266 useful for string manipulation and control structures, if Calc's
2267 functionality is not enough.
2269 If a formula starts with a single-quote followed by an opening
2270 parenthesis, then it is evaluated as a Lisp form. The evaluation
2271 should return either a string or a number. Just as with Calc
2272 formulas, you can specify modes and a ~printf~ format after
2275 With Emacs Lisp forms, you need to be conscious about the way field
2276 references are interpolated into the form. By default, a reference is
2277 interpolated as a Lisp string (in double-quotes) containing the field.
2278 If you provide the =N= mode switch, all referenced elements are
2279 numbers---non-number fields will be zero---and interpolated as Lisp
2280 numbers, without quotes. If you provide the =L= flag, all fields are
2281 interpolated literally, without quotes. I.e., if you want a reference
2282 to be interpreted as a string by the Lisp form, enclose the reference
2283 operator itself in double-quotes, like ="$3"=. Ranges are inserted as
2284 space-separated fields, so you can embed them in list or vector
2287 Here are a few examples---note how the =N= mode is used when we do
2288 computations in Lisp:
2290 - ='(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))= ::
2292 Swap the first two characters of the content of column 1.
2296 Add columns 1 and 2, equivalent to Calc's =$1+$2=.
2298 - ='(apply '+ '($1..$4));N= ::
2300 Compute the sum of columns 1 to 4, like Calc's =vsum($1..$4)=.
2302 *** Durations and time values
2304 :DESCRIPTION: How to compute durations and time values.
2306 #+cindex: Duration, computing
2307 #+cindex: Time, computing
2308 #+vindex: org-table-duration-custom-format
2310 If you want to compute time values use the =T=, =t=, or =U= flag,
2311 either in Calc formulas or Elisp formulas:
2314 | Task 1 | Task 2 | Total |
2315 |---------+----------+----------|
2316 | 2:12 | 1:47 | 03:59:00 |
2317 | 2:12 | 1:47 | 03:59 |
2318 | 3:02:20 | -2:07:00 | 0.92 |
2319 ,#+TBLFM: @2$3=$1+$2;T::@3$3=$1+$2;U::@4$3=$1+$2;t
2322 Input duration values must be of the form =HH:MM[:SS]=, where seconds
2323 are optional. With the =T= flag, computed durations are displayed as
2324 =HH:MM:SS= (see the first formula above). With the =U= flag, seconds
2325 are omitted so that the result is only =HH:MM= (see second formula
2326 above). Zero-padding of the hours field depends upon the value of the
2327 variable ~org-table-duration-hour-zero-padding~.
2329 With the =t= flag, computed durations are displayed according to the
2330 value of the option ~org-table-duration-custom-format~, which defaults
2331 to ~hours~ and displays the result as a fraction of hours (see the
2332 third formula in the example above).
2334 Negative duration values can be manipulated as well, and integers are
2335 considered as seconds in addition and subtraction.
2337 *** Field and range formulas
2339 :DESCRIPTION: Formula for specific (ranges of) fields.
2341 #+cindex: field formula
2342 #+cindex: range formula
2343 #+cindex: formula, for individual table field
2344 #+cindex: formula, for range of fields
2346 To assign a formula to a particular field, type it directly into the
2347 field, preceded by =:==, for example =vsum(@II..III)=. When you press
2348 {{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(C-c C-c)}}} with the cursor
2349 still in the field, the formula is stored as the formula for this
2350 field, evaluated, and the current field is replaced with the result.
2352 #+cindex: @samp{TBLFM}, keyword
2353 Formulas are stored in a special =TBLFM= keyword located directly
2354 below the table. If you type the equation in the fourth field of the
2355 third data line in the table, the formula looks like =@3$4=$1+$2=.
2356 When inserting/deleting/swapping column and rows with the appropriate
2357 commands, /absolute references/ (but not relative ones) in stored
2358 formulas are modified in order to still reference the same field. To
2359 avoid this from happening, in particular in range references, anchor
2360 ranges at the table borders (using =@<=, =@>=, =$<=, =$>=), or at
2361 hlines using the =@I= notation. Automatic adaptation of field
2362 references does of course not happen if you edit the table structure
2363 with normal editing commands---then you must fix the equations
2366 Instead of typing an equation into the field, you may also use the
2369 - {{{kbd(C-u C-c =)}}} (~org-table-eval-formula~) ::
2372 #+findex: org-table-eval-formula
2373 Install a new formula for the current field. The command prompts
2374 for a formula with default taken from the =TBLFM= keyword,
2375 applies it to the current field, and stores it.
2377 The left-hand side of a formula can also be a special expression in
2378 order to assign the formula to a number of different fields. There is
2379 no keyboard shortcut to enter such range formulas. To add them, use
2380 the formula editor (see [[*Editing and debugging formulas]]) or edit the
2381 =TBLFM= keyword directly.
2385 Column formula, valid for the entire column. This is so common
2386 that Org treats these formulas in a special way, see [[*Column
2391 Row formula, applies to all fields in the specified row. =@>==
2396 Range formula, applies to all fields in the given rectangular
2397 range. This can also be used to assign a formula to some but not
2398 all fields in a row.
2402 Named field, see [[*Advanced features]].
2406 :DESCRIPTION: Formulas valid for an entire column.
2408 #+cindex: column formula
2409 #+cindex: formula, for table column
2411 When you assign a formula to a simple column reference like =$3==, the
2412 same formula is used in all fields of that column, with the following
2413 very convenient exceptions: (i) If the table contains horizontal
2414 separator hlines with rows above and below, everything before the
2415 first such hline is considered part of the table /header/ and is not
2416 modified by column formulas. Therefore a header is mandatory when you
2417 use column formulas and want to add hlines to group rows, like for
2418 example to separate a total row at the bottom from the summand rows
2419 above. (ii) Fields that already get a value from a field/range
2420 formula are left alone by column formulas. These conditions make
2421 column formulas very easy to use.
2423 To assign a formula to a column, type it directly into any field in
2424 the column, preceded by an equal sign, like ==$1+$2=. When you press
2425 {{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(C-c C-c)}}} with the cursor
2426 still in the field, the formula is stored as the formula for the
2427 current column, evaluated and the current field replaced with the
2428 result. If the field contains only ===, the previously stored formula
2429 for this column is used. For each column, Org only remembers the most
2430 recently used formula. In the =TBLFM= keyword, column formulas look
2431 like =$4=$1+$2=. The left-hand side of a column formula can not be
2432 the name of column, it must be the numeric column reference or =$>=.
2434 Instead of typing an equation into the field, you may also use the
2437 - {{{kbd(C-c =)}}} (~org-table-eval-formula~) ::
2440 #+findex: org-table-eval-formula
2441 Install a new formula for the current column and replace current
2442 field with the result of the formula. The command prompts for
2443 a formula, with default taken from the =TBLFM= keyword, applies
2444 it to the current field and stores it. With a numeric prefix
2445 argument, e.g., {{{kbd(C-5 C-c =)}}}, the command applies it to
2446 that many consecutive fields in the current column.
2448 *** Lookup functions
2450 :DESCRIPTION: Lookup functions for searching tables.
2452 #+cindex: lookup functions in tables
2453 #+cindex: table lookup functions
2455 Org has three predefined Emacs Lisp functions for lookups in tables.
2457 - ~(org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)~ ::
2459 #+findex: org-lookup-first
2460 Searches for the first element {{{var(S)}}} in list
2461 {{{var(S-LIST)}}} for which
2462 #+begin_src emacs-lisp
2465 is non-~nil~; returns the value from the corresponding position
2466 in list {{{var(R-LIST)}}}. The default {{{var(PREDICATE)}}} is
2467 ~equal~. Note that the parameters {{{var(VAL)}}} and
2468 {{{var(S)}}} are passed to {{{var(PREDICATE)}}} in the same order
2469 as the corresponding parameters are in the call to
2470 ~org-lookup-first~, where {{{var(VAL)}}} precedes
2471 {{{var(S-LIST)}}}. If {{{var(R-LIST)}}} is ~nil~, the matching
2472 element {{{var(S)}}} of {{{var(S-LIST)}}} is returned.
2474 - ~(org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)~ ::
2476 #+findex: org-lookup-last
2477 Similar to ~org-lookup-first~ above, but searches for the /last/
2478 element for which {{{var(PREDICATE)}}} is non-~nil~.
2480 - ~(org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)~ ::
2482 #+findex: org-lookup-all
2483 Similar to ~org-lookup-first~, but searches for /all/ elements
2484 for which {{{var(PREDICATE)}}} is non-~nil~, and returns /all/
2485 corresponding values. This function can not be used by itself in
2486 a formula, because it returns a list of values. However,
2487 powerful lookups can be built when this function is combined with
2488 other Emacs Lisp functions.
2490 If the ranges used in these functions contain empty fields, the =E=
2491 mode for the formula should usually be specified: otherwise empty
2492 fields are not included in {{{var(S-LIST)}}} and/or {{{var(R-LIST)}}}
2493 which can, for example, result in an incorrect mapping from an element
2494 of {{{var(S-LIST)}}} to the corresponding element of
2497 These three functions can be used to implement associative arrays,
2498 count matching cells, rank results, group data, etc. For practical
2499 examples see [[https://orgmode.org/worg/org-tutorials/org-lookups.html][this tutorial on Worg]].
2501 *** Editing and debugging formulas
2503 :DESCRIPTION: Fixing formulas.
2505 #+cindex: formula editing
2506 #+cindex: editing, of table formulas
2508 #+vindex: org-table-use-standard-references
2509 You can edit individual formulas in the minibuffer or directly in the
2510 field. Org can also prepare a special buffer with all active formulas
2511 of a table. When offering a formula for editing, Org converts
2512 references to the standard format (like =B3= or =D&=) if possible. If
2513 you prefer to only work with the internal format (like =@3$2= or
2514 =$4=), configure the variable ~org-table-use-standard-references~.
2516 - {{{kbd(C-c =)}}} or {{{kbd(C-u C-c =)}}} (~org-table-eval-formula~) ::
2520 #+findex: org-table-eval-formula
2521 Edit the formula associated with the current column/field in the
2522 minibuffer. See [[*Column formulas]], and [[*Field and range formulas]].
2524 - {{{kbd(C-u C-u C-c =)}}} (~org-table-eval-formula~) ::
2526 #+kindex: C-u C-u C-c =
2527 #+findex: org-table-eval-formula
2528 Re-insert the active formula (either a field formula, or a column
2529 formula) into the current field, so that you can edit it directly
2530 in the field. The advantage over editing in the minibuffer is
2531 that you can use the command {{{kbd(C-c ?)}}}.
2533 - {{{kbd(C-c ?)}}} (~org-table-field-info~) ::
2536 #+findex: org-table-field-info
2537 While editing a formula in a table field, highlight the field(s)
2538 referenced by the reference at the cursor position in the
2541 - {{{kbd(C-c })}}} (~org-table-toggle-coordinate-overlays~) ::
2544 #+findex: org-table-toggle-coordinate-overlays
2545 Toggle the display of row and column numbers for a table, using
2546 overlays. These are updated each time the table is aligned; you
2547 can force it with {{{kbd(C-c C-c)}}}.
2549 - {{{kbd(C-c {)}}} (~org-table-toggle-formula-debugger~) ::
2552 #+findex: org-table-toggle-formula-debugger
2553 Toggle the formula debugger on and off. See below.
2555 - {{{kbd(C-c ')}}} (~org-table-edit-formulas~) ::
2558 #+findex: org-table-edit-formulas
2559 Edit all formulas for the current table in a special buffer,
2560 where the formulas are displayed one per line. If the current
2561 field has an active formula, the cursor in the formula editor
2562 marks it. While inside the special buffer, Org automatically
2563 highlights any field or range reference at the cursor position.
2564 You may edit, remove and add formulas, and use the following
2567 - {{{kbd(C-c C-c)}}} or {{{kbd(C-x C-s)}}} (~org-table-fedit-finish~) ::
2571 #+findex: org-table-fedit-finish
2572 Exit the formula editor and store the modified formulas. With
2573 {{{kbd(C-u)}}} prefix, also apply the new formulas to the
2576 - {{{kbd(C-c C-q)}}} (~org-table-fedit-abort~) ::
2579 #+findex: org-table-fedit-abort
2580 Exit the formula editor without installing changes.
2582 - {{{kbd(C-c C-r)}}} (~org-table-fedit-toggle-ref-type~) ::
2585 #+findex: org-table-fedit-toggle-ref-type
2586 Toggle all references in the formula editor between standard
2587 (like =B3=) and internal (like =@3$2=).
2589 - {{{kbd(TAB)}}} (~org-table-fedit-lisp-indent~) ::
2592 #+findex: org-table-fedit-lisp-indent
2593 Pretty-print or indent Lisp formula at point. When in a line
2594 containing a Lisp formula, format the formula according to
2595 Emacs Lisp rules. Another {{{kbd(TAB)}}} collapses the formula
2596 back again. In the open formula, {{{kbd(TAB)}}} re-indents
2597 just like in Emacs Lisp mode.
2599 - {{{kbd(M-TAB)}}} (~lisp-complete-symbol~) ::
2602 #+findex: lisp-complete-symbol
2603 Complete Lisp symbols, just like in Emacs Lisp mode.
2605 - {{{kbd(S-UP)}}}, {{{kbd(S-DOWN)}}}, {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} ::
2611 #+findex: org-table-fedit-ref-up
2612 #+findex: org-table-fedit-ref-down
2613 #+findex: org-table-fedit-ref-left
2614 #+findex: org-table-fedit-ref-right
2615 Shift the reference at point. For example, if the reference
2616 is =B3= and you press {{{kbd(S-RIGHT)}}}, it becomes =C3=.
2617 This also works for relative references and for hline
2620 - {{{kbd(M-S-UP)}}} (~org-table-fedit-line-up~) ::
2623 #+findex: org-table-fedit-line-up
2624 Move the test line for column formulas up in the Org buffer.
2626 - {{{kbd(M-S-DOWN)}}} (~org-table-fedit-line-down~) ::
2629 #+findex: org-table-fedit-line-down
2630 Move the test line for column formulas down in the Org buffer.
2632 - {{{kbd(M-UP)}}} (~org-table-fedit-scroll-up~) ::
2635 #+findex: org-table-fedit-scroll-up
2636 Scroll up the window displaying the table.
2638 - {{{kbd(M-DOWN)}}} (~org-table-fedit-scroll-down~) ::
2641 #+findex: org-table-fedit-scroll-down
2642 Scroll down the window displaying the table.
2644 - {{{kbd(C-c })}}} ::
2647 #+findex: org-table-toggle-coordinate-overlays
2648 Turn the coordinate grid in the table on and off.
2650 Making a table field blank does not remove the formula associated with
2651 the field, because that is stored in a different line---the =TBLFM=
2652 keyword line. During the next recalculation, the field will be filled
2653 again. To remove a formula from a field, you have to give an empty
2654 reply when prompted for the formula, or to edit the =TBLFM= keyword.
2657 You may edit the =TBLFM= keyword directly and re-apply the changed
2658 equations with {{{kbd(C-c C-c)}}} in that line or with the normal
2659 recalculation commands in the table.
2661 **** Using multiple =TBLFM= lines
2665 #+cindex: multiple formula lines
2666 #+cindex: @samp{TBLFM} keywords, multiple
2667 #+cindex: @samp{TBLFM}, switching
2670 You may apply the formula temporarily. This is useful when you switch
2671 the formula. Place multiple =TBLFM= keywords right after the table,
2672 and then press {{{kbd(C-c C-c)}}} on the formula to apply. Here is an
2684 #+texinfo: @noindent
2685 Pressing {{{kbd(C-c C-c)}}} in the line of =#+TBLFM: $2=$1*2= yields:
2696 #+texinfo: @noindent
2697 Note: If you recalculate this table, with {{{kbd(C-u C-c *)}}}, for
2698 example, you get the following result of applying only the first
2710 **** Debugging formulas
2714 #+cindex: formula debugging
2715 #+cindex: debugging, of table formulas
2717 When the evaluation of a formula leads to an error, the field content
2718 becomes the string =#ERROR=. If you would like to see what is going
2719 on during variable substitution and calculation in order to find
2720 a bug, turn on formula debugging in the Tbl menu and repeat the
2721 calculation, for example by pressing {{{kbd(C-u C-u C-c = RET)}}} in
2722 a field. Detailed information are displayed.
2724 *** Updating the table
2726 :DESCRIPTION: Recomputing all dependent fields.
2728 #+cindex: recomputing table fields
2729 #+cindex: updating, table
2731 Recalculation of a table is normally not automatic, but needs to be
2732 triggered by a command. To make recalculation at least
2733 semi-automatic, see [[*Advanced features]].
2735 In order to recalculate a line of a table or the entire table, use the
2738 - {{{kbd(C-c *)}}} (~org-table-recalculate~) ::
2741 #+findex: org-table-recalculate
2742 Recalculate the current row by first applying the stored column
2743 formulas from left to right, and all field/range formulas in the
2746 - {{{kbd(C-u C-c *)}}} or {{{kbd(C-u C-c C-c)}}} ::
2749 #+kindex: C-u C-c C-c
2750 Recompute the entire table, line by line. Any lines before the
2751 first hline are left alone, assuming that these are part of the
2754 - {{{kbd(C-u C-u C-c *)}}} or {{{kbd(C-u C-u C-c C-c)}}} (~org-table-iterate~) ::
2756 #+kindex: C-u C-u C-c *
2757 #+kindex: C-u C-u C-c C-c
2758 #+findex: org-table-iterate
2759 Iterate the table by recomputing it until no further changes
2760 occur. This may be necessary if some computed fields use the
2761 value of other fields that are computed /later/ in the
2762 calculation sequence.
2764 - {{{kbd(M-x org-table-recalculate-buffer-tables)}}} ::
2766 #+findex: org-table-recalculate-buffer-tables
2767 Recompute all tables in the current buffer.
2769 - {{{kbd(M-x org-table-iterate-buffer-tables)}}} ::
2771 #+findex: org-table-iterate-buffer-tables
2772 Iterate all tables in the current buffer, in order to converge
2773 table-to-table dependencies.
2775 *** Advanced features
2777 :DESCRIPTION: Field and column names, automatic recalculation...
2780 If you want the recalculation of fields to happen automatically, or if
2781 you want to be able to assign /names/[fn:24] to fields and columns,
2782 you need to reserve the first column of the table for special marking
2785 - {{{kbd(C-#)}}} (~org-table-rotate-recalc-marks~) ::
2788 #+findex: org-table-rotate-recalc-marks
2789 Rotate the calculation mark in first column through the states
2790 =#=, =*=, =!=, =$=. When there is an active region, change all
2791 marks in the region.
2793 Here is an example of a table that collects exam results of students
2794 and makes use of these features:
2797 |---+---------+--------+--------+--------+-------+------|
2798 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2799 |---+---------+--------+--------+--------+-------+------|
2800 | ! | | P1 | P2 | P3 | Tot | |
2801 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2802 | ^ | | m1 | m2 | m3 | mt | |
2803 |---+---------+--------+--------+--------+-------+------|
2804 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2805 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2806 |---+---------+--------+--------+--------+-------+------|
2807 | | Average | | | | 25.0 | |
2808 | ^ | | | | | at | |
2809 | $ | max=50 | | | | | |
2810 |---+---------+--------+--------+--------+-------+------|
2811 ,#+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f
2814 #+texinfo: @noindent
2815 *Important*: please note that for these special tables, recalculating
2816 the table with {{{kbd(C-u C-c *)}}} only affects rows that are marked
2817 =#= or =*=, and fields that have a formula assigned to the field
2818 itself. The column formulas are not applied in rows with empty first
2821 #+cindex: marking characters, tables
2822 The marking characters have the following meaning:
2826 The fields in this line define names for the columns, so that you
2827 may refer to a column as =$Tot= instead of =$6=.
2831 This row defines names for the fields /above/ the row. With such
2832 a definition, any formula in the table may use =$m1= to refer to
2833 the value =10=. Also, if you assign a formula to a names field,
2834 it is stored as =$name = ...=.
2838 Similar to =^=, but defines names for the fields in the row
2843 Fields in this row can define /parameters/ for formulas. For
2844 example, if a field in a =$= row contains =max=50=, then formulas
2845 in this table can refer to the value 50 using =$max=. Parameters
2846 work exactly like constants, only that they can be defined on
2851 Fields in this row are automatically recalculated when pressing
2852 {{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(S-TAB)}}} in this row.
2853 Also, this row is selected for a global recalculation with
2854 {{{kbd(C-u C-c *)}}}. Unmarked lines are left alone by this
2859 Selects this line for global recalculation with {{{kbd(C-u C-c
2860 *)}}}, but not for automatic recalculation. Use this when
2861 automatic recalculation slows down editing too much.
2865 Do not export this line. Useful for lines that contain the
2866 narrowing =<N>= markers or column group markers.
2868 Finally, just to whet your appetite for what can be done with the
2869 fantastic Calc package, here is a table that computes the Taylor
2870 series of degree n at location x for a couple of functions.
2873 |---+-------------+---+-----+--------------------------------------|
2874 | | Func | n | x | Result |
2875 |---+-------------+---+-----+--------------------------------------|
2876 | # | exp(x) | 1 | x | 1 + x |
2877 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2878 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2879 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2880 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2881 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2882 |---+-------------+---+-----+--------------------------------------|
2883 ,#+TBLFM: $5=taylor($2,$4,$3);n3
2888 :DESCRIPTION: Plotting from Org tables.
2890 #+cindex: graph, in tables
2891 #+cindex: plot tables using Gnuplot
2893 Org Plot can produce graphs of information stored in Org tables,
2894 either graphically or in ASCII art.
2896 *** Graphical plots using Gnuplot
2901 #+cindex: @samp{PLOT}, keyword
2902 Org Plot can produce 2D and 3D graphs of information stored in Org
2903 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
2904 that you have both Gnuplot and Gnuplot mode installed on your system,
2905 then call {{{kbd(C-c \quot g)}}} or {{{kbd(M-x org-plot/gnuplot)}}} on the
2909 ,#+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2910 | Sede | Max cites | H-index |
2911 |-----------+-----------+---------|
2912 | Chile | 257.72 | 21.39 |
2913 | Leeds | 165.77 | 19.68 |
2914 | Sao Paolo | 71.00 | 11.50 |
2915 | Stockholm | 134.19 | 14.33 |
2916 | Morels | 257.56 | 17.67 |
2919 Notice that Org Plot is smart enough to apply the table's headers as
2920 labels. Further control over the labels, type, content, and
2921 appearance of plots can be exercised through the =PLOT= keyword
2922 preceding a table. See below for a complete list of Org Plot options.
2923 For more information and examples see the [[https://orgmode.org/worg/org-tutorials/org-plot.html][Org Plot tutorial]].
2932 Specify any Gnuplot option to be set when graphing.
2936 Specify the title of the plot.
2940 Specify which column of the table to use as the =x= axis.
2944 Specify the columns to graph as a Lisp style list, surrounded by
2945 parentheses and separated by spaces for example =dep:(3 4)= to
2946 graph the third and fourth columns. Defaults to graphing all
2947 other columns aside from the =ind= column.
2951 Specify whether the plot is =2d=, =3d=, or =grid=.
2955 Specify a =with= option to be inserted for every column being
2956 plotted, e.g., =lines=, =points=, =boxes=, =impulses=. Defaults
2961 If you want to plot to a file, specify
2962 ="path/to/desired/output-file"=.
2966 List of labels to be used for the =deps=. Defaults to the column
2967 headers if they exist.
2971 Specify an entire line to be inserted in the Gnuplot script.
2975 When plotting =3d= or =grid= types, set this to =t= to graph
2976 a flat mapping rather than a =3d= slope.
2980 Specify format of Org mode timestamps as they will be parsed by
2981 Gnuplot. Defaults to =%Y-%m-%d-%H:%M:%S=.
2985 If you want total control, you can specify a script file---place
2986 the file name between double-quotes---which will be used to plot.
2987 Before plotting, every instance of =$datafile= in the specified
2988 script will be replaced with the path to the generated data file.
2989 Note: even if you set this option, you may still want to specify
2990 the plot type, as that can impact the content of the data file.
2997 While the cursor is on a column, typing {{{kbd(C-c " a)}}} or
2998 {{{kbd(M-x orgtbl-ascii-plot)}}} create a new column containing an
2999 ASCII-art bars plot. The plot is implemented through a regular column
3000 formula. When the source column changes, the bar plot may be updated
3001 by refreshing the table, for example typing {{{kbd(C-u C-c *)}}}.
3004 | Sede | Max cites | |
3005 |---------------+-----------+--------------|
3006 | Chile | 257.72 | WWWWWWWWWWWW |
3007 | Leeds | 165.77 | WWWWWWWh |
3008 | Sao Paolo | 71.00 | WWW; |
3009 | Stockholm | 134.19 | WWWWWW: |
3010 | Morelia | 257.56 | WWWWWWWWWWWH |
3011 | Rochefourchat | 0.00 | |
3012 ,#+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)
3015 The formula is an Elisp call.
3017 #+attr_texinfo: :options orgtbl-ascii-draw value min max &optional width
3019 Draw an ASCII bar in a table.
3021 {{{var(VALUE)}}} is the value to plot.
3023 {{{var(MIN)}}} is the value displayed as an empty bar. {{{var(MAX)}}}
3024 is the value filling all the {{{var(WIDTH)}}}. Sources values outside
3025 this range are displayed as =too small= or =too large=.
3027 {{{var(WIDTH)}}} is the number of characters of the bar plot. It
3033 :DESCRIPTION: Notes in context.
3035 #+cindex: hyperlinks
3037 Like HTML, Org provides links inside a file, external links to
3038 other files, Usenet articles, emails, and much more.
3042 :DESCRIPTION: How links in Org are formatted.
3044 #+cindex: link format
3045 #+cindex: format, of links
3047 Org recognizes plain URL-like links and activate them as clickable
3048 links. The general link format, however, looks like this:
3050 : [[LINK][DESCRIPTION]]
3052 #+texinfo: @noindent
3057 #+texinfo: @noindent
3058 Once a link in the buffer is complete (all brackets present), Org
3059 changes the display so that =DESCRIPTION= is displayed instead of
3060 =[[LINK][DESCRIPTION]]= and =LINK= is displayed instead of =[[LINK]]=. Links are be
3061 highlighted in the face ~org-link~, which by default is an underlined
3062 face. You can directly edit the visible part of a link. Note that
3063 this can be either the LINK part, if there is no description, or the
3064 {{{var(DESCRIPTION)}}} part. To edit also the invisible
3065 {{{var(LINK)}}} part, use {{{kbd(C-c C-l)}}} with the cursor on the
3068 If you place the cursor at the beginning or just behind the end of the
3069 displayed text and press {{{kbd(BS)}}}, you remove
3070 the---invisible---bracket at that location. This makes the link
3071 incomplete and the internals are again displayed as plain text.
3072 Inserting the missing bracket hides the link internals again. To show
3073 the internal structure of all links, use the menu: Org \rarr Hyperlinks \rarr
3078 :DESCRIPTION: Links to other places in the current file.
3080 #+cindex: internal links
3081 #+cindex: links, internal
3082 #+cindex: targets, for links
3084 #+cindex: @samp{CUSTOM_ID}, property
3085 If the link does not look like a URL, it is considered to be internal
3086 in the current file. The most important case is a link like
3087 =[[#my-custom-id]]= which links to the entry with the =CUSTOM_ID= property
3088 =my-custom-id=. You are responsible yourself to make sure these
3089 custom IDs are unique in a file.
3091 Links such as =[[My Target]]= or =[[My Target][Find my target]]= lead to a text search in
3094 The link can be followed with {{{kbd(C-c C-o)}}} when the cursor is on
3095 the link, or with a mouse click (see [[*Handling Links]]). Links to
3096 custom IDs point to the corresponding headline. The preferred match
3097 for a text link is a /dedicated target/: the same string in double
3098 angular brackets, like =<<My Target>>=.
3100 #+cindex: @samp{NAME}, keyword
3101 If no dedicated target exists, the link tries to match the exact name
3102 of an element within the buffer. Naming is done with the =NAME=
3103 keyword, which has to be put in the line before the element it refers
3104 to, as in the following example
3113 If none of the above succeeds, Org searches for a headline that is
3114 exactly the link text but may also include a TODO keyword and
3117 During export, internal links are used to mark objects and assign them
3118 a number. Marked objects are then referenced by links pointing to
3119 them. In particular, links without a description appear as the number
3120 assigned to the marked object[fn:26]. In the following excerpt from
3125 2. <<target>>another item
3126 Here we refer to item [[target]].
3129 #+texinfo: @noindent
3130 The last sentence will appear as =Here we refer to item 2= when
3133 In non-Org files, the search looks for the words in the link text. In
3134 the above example the search would be for =target=.
3136 Following a link pushes a mark onto Org's own mark ring. You can
3137 return to the previous position with {{{kbd(C-c &)}}}. Using this
3138 command several times in direct succession goes back to positions
3143 :DESCRIPTION: Make targets trigger links in plain text.
3145 #+cindex: radio targets
3146 #+cindex: targets, radio
3147 #+cindex: links, radio targets
3149 Org can automatically turn any occurrences of certain target names in
3150 normal text into a link. So without explicitly creating a link, the
3151 text connects to the target radioing its position. Radio targets are
3152 enclosed by triple angular brackets. For example, a target =<<<My
3153 Target>>>= causes each occurrence of =my target= in normal text to
3154 become activated as a link. The Org file is scanned automatically for
3155 radio targets only when the file is first loaded into Emacs. To
3156 update the target list during editing, press {{{kbd(C-c C-c)}}} with
3157 the cursor on or at a target.
3161 :DESCRIPTION: URL-like links to the world.
3163 #+cindex: links, external
3164 #+cindex: external links
3165 #+cindex: Gnus links
3166 #+cindex: BBDB links
3169 #+cindex: file links
3170 #+cindex: Rmail links
3171 #+cindex: MH-E links
3172 #+cindex: Usenet links
3173 #+cindex: shell links
3174 #+cindex: Info links
3175 #+cindex: Elisp links
3177 Org supports links to files, websites, Usenet and email messages, BBDB
3178 database entries and links to both IRC conversations and their logs.
3179 External links are URL-like locators. They start with a short
3180 identifying string followed by a colon. There can be no space after
3181 the colon. The following list shows examples for each link type.
3183 | =http://www.astro.uva.nl/=dominik= | on the web |
3184 | =doi:10.1000/182= | DOI for an electronic resource |
3185 | =file:/home/dominik/images/jupiter.jpg= | file, absolute path |
3186 | =/home/dominik/images/jupiter.jpg= | same as above |
3187 | =file:papers/last.pdf= | file, relative path |
3188 | =./papers/last.pdf= | same as above |
3189 | =file:/ssh:me@some.where:papers/last.pdf= | file, path on remote machine |
3190 | =/ssh:me@some.where:papers/last.pdf= | same as above |
3191 | =file:sometextfile::NNN= | file, jump to line number |
3192 | =file:projects.org= | another Org file |
3193 | =file:projects.org::some words= | text search in Org file[fn:27] |
3194 | =file:projects.org::*task title= | heading search in Org file |
3195 | =file+sys:/path/to/file= | open via OS, like double-click |
3196 | =file+emacs:/path/to/file= | force opening by Emacs |
3197 | =docview:papers/last.pdf::NNN= | open in doc-view mode at page |
3198 | =id:B7423F4D-2E8A-471B-8810-C40F074717E9= | Link to heading by ID |
3199 | =news:comp.emacs= | Usenet link |
3200 | =mailto:adent@galaxy.net= | Mail link |
3201 | =mhe:folder= | MH-E folder link |
3202 | =mhe:folder#id= | MH-E message link |
3203 | =rmail:folder= | Rmail folder link |
3204 | =rmail:folder#id= | Rmail message link |
3205 | =gnus:group= | Gnus group link |
3206 | =gnus:group#id= | Gnus article link |
3207 | =bbdb:R.*Stallman= | BBDB link (with regexp) |
3208 | =irc:/irc.com/#emacs/bob= | IRC link |
3209 | =info:org#External links= | Info node link |
3210 | =shell:ls *.org= | A shell command |
3211 | =elisp:org-agenda= | Interactive Elisp command |
3212 | =elisp:(find-file-other-frame "Elisp.org")= | Elisp form to evaluate |
3215 #+cindex: Wanderlust links
3216 On top of these built-in link types, some are available through the
3217 =contrib/= directory (see [[*Installation]]). For example, these links to
3218 VM or Wanderlust messages are available when you load the
3219 corresponding libraries from the =contrib/= directory:
3221 | =vm:folder= | VM folder link |
3222 | =vm:folder#id= | VM message link |
3223 | =vm://myself@some.where.org/folder#id= | VM on remote machine |
3224 | =vm-imap:account:folder= | VM IMAP folder link |
3225 | =vm-imap:account:folder#id= | VM IMAP message link |
3226 | =wl:folder= | Wanderlust folder link |
3227 | =wl:folder#id= | Wanderlust message link |
3229 For customizing Org to add new link types, see [[*Adding Hyperlink
3232 A link should be enclosed in double brackets and may contain
3233 a descriptive text to be displayed instead of the URL (see [[*Link
3234 Format]]), for example:
3236 : [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3238 #+texinfo: @noindent
3239 If the description is a file name or URL that points to an image, HTML
3240 export (see [[*HTML Export]]) inlines the image as a clickable button. If
3241 there is no description at all and the link points to an image, that
3242 image is inlined into the exported HTML file.
3244 #+cindex: square brackets, around links
3245 #+cindex: angular brackets, around links
3246 #+cindex: plain text external links
3247 Org also finds external links in the normal text and activates them as
3248 links. If spaces must be part of the link (for example in
3249 =bbdb:Richard Stallman=), or if you need to remove ambiguities about
3250 the end of the link, enclose them in square or angular brackets.
3254 :DESCRIPTION: Creating, inserting and following.
3256 #+cindex: links, handling
3258 Org provides methods to create a link in the correct syntax, to insert
3259 it into an Org file, and to follow the link.
3261 #+findex: org-store-link
3262 #+cindex: storing links
3263 The main function is ~org-store-link~, called with {{{kbd(M-x
3264 org-store-link)}}}. Because of its importance, we suggest to bind it
3265 to a widely available key (see [[*Activation]]). It stores a link to the
3266 current location. The link is stored for later insertion into an Org
3267 buffer---see below. What kind of link is created depends on the
3270 - /Org mode buffers/ ::
3272 For Org files, if there is a =<<target>>= at the cursor, the link
3273 points to the target. Otherwise it points to the current
3274 headline, which is also the description[fn:28].
3276 #+vindex: org-link-to-org-use-id
3277 #+cindex: @samp{CUSTOM_ID}, property
3278 #+cindex: @samp{ID}, property
3279 If the headline has a =CUSTOM_ID= property, store a link to this
3280 custom ID. In addition or alternatively, depending on the value
3281 of ~org-link-to-org-use-id~, create and/or use a globally unique
3282 ID property for the link[fn:29]. So using this command in Org
3283 buffers potentially creates two links: a human-readable link from
3284 the custom ID, and one that is globally unique and works even if
3285 the entry is moved from file to file. Later, when inserting the
3286 link, you need to decide which one to use.
3288 - /Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus/ ::
3290 Pretty much all Emacs mail clients are supported. The link
3291 points to the current article, or, in some Gnus buffers, to the
3292 group. The description is constructed from the author and the
3295 - /Web browsers: W3, W3M and EWW/ ::
3297 Here the link is the current URL, with the page title as
3300 - /Contacts: BBDB/ ::
3302 Links created in a BBDB buffer point to the current entry.
3306 #+vindex: org-irc-links-to-logs
3307 For IRC links, if the variable ~org-irc-link-to-logs~ is
3308 non-~nil~, create a =file= style link to the relevant point in
3309 the logs for the current conversation. Otherwise store an =irc=
3310 style link to the user/channel/server under the point.
3314 For any other file, the link points to the file, with a search
3315 string (see [[*Search Options in File Links]]) pointing to the
3316 contents of the current line. If there is an active region, the
3317 selected words form the basis of the search string. If the
3318 automatically created link is not working correctly or accurately
3319 enough, you can write custom functions to select the search
3320 string and to do the search for particular file types (see
3321 [[*Custom Searches]]).
3323 You can also define dedicated links to other files. See [[*Adding
3328 When the cursor is in an agenda view, the created link points to
3329 the entry referenced by the current line.
3331 From an Org buffer, the following commands create, navigate or, more
3332 generally, act on links.
3334 #+attr_texinfo: :sep ,
3335 - {{{kbd(C-c C-l)}}} (~org-insert-link~) ::
3338 #+findex: org-insert-link
3339 #+cindex: link completion
3340 #+cindex: completion, of links
3341 #+cindex: inserting links
3342 #+vindex: org-keep-stored-link-after-insertion
3343 Insert a link[fn:30]. This prompts for a link to be inserted
3344 into the buffer. You can just type a link, using text for an
3345 internal link, or one of the link type prefixes mentioned in the
3346 examples above. The link is inserted into the buffer, along with
3347 a descriptive text[fn:31]. If some text was selected at this
3348 time, it becomes the default description.
3350 - /Inserting stored links/ ::
3352 All links stored during the current session are part of the
3353 history for this prompt, so you can access them with
3354 {{{kbd(UP)}}} and {{{kbd(DOWN)}}} (or {{{kbd(M-p)}}},
3357 - /Completion support/ ::
3359 Completion with {{{kbd(TAB)}}} helps you to insert valid link
3360 prefixes like =http= or =ftp=, including the prefixes defined
3361 through link abbreviations (see [[*Link Abbreviations]]). If you
3362 press {{{kbd(RET)}}} after inserting only the prefix, Org
3363 offers specific completion support for some link types[fn:32].
3364 For example, if you type {{{kbd(f i l e RET)}}}---alternative
3365 access: {{{kbd(C-u C-c C-l)}}}, see below---Org offers file
3366 name completion, and after {{{kbd(b b d b RET)}}} you can
3367 complete contact names.
3369 - {{{kbd(C-u C-c C-l)}}} ::
3371 #+cindex: file name completion
3372 #+cindex: completion, of file names
3373 #+kindex: C-u C-c C-l
3374 When {{{kbd(C-c C-l)}}} is called with a {{{kbd(C-u)}}} prefix
3375 argument, insert a link to a file. You may use file name
3376 completion to select the name of the file. The path to the file
3377 is inserted relative to the directory of the current Org file, if
3378 the linked file is in the current directory or in a sub-directory
3379 of it, or if the path is written relative to the current
3380 directory using =../=. Otherwise an absolute path is used, if
3381 possible with =~/= for your home directory. You can force an
3382 absolute path with two {{{kbd(C-u)}}} prefixes.
3384 - {{{kbd(C-c C-l)}}} (with cursor on existing link) ::
3386 #+cindex: following links
3387 When the cursor is on an existing link, {{{kbd(C-c C-l)}}} allows
3388 you to edit the link and description parts of the link.
3390 - {{{kbd(C-c C-o)}}} (~org-open-at-point~) ::
3393 #+findex: org-open-at-point
3394 #+vindex: org-file-apps
3395 Open link at point. This launches a web browser for URL (using
3396 ~browse-url-at-point~), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB
3397 for the corresponding links, and execute the command in a shell
3398 link. When the cursor is on an internal link, this command runs
3399 the corresponding search. When the cursor is on a TAG list in
3400 a headline, it creates the corresponding TAGS view. If the
3401 cursor is on a timestamp, it compiles the agenda for that date.
3402 Furthermore, it visits text and remote files in =file= links with
3403 Emacs and select a suitable application for local non-text files.
3404 Classification of files is based on file extension only. See
3405 option ~org-file-apps~. If you want to override the default
3406 application and visit the file with Emacs, use a {{{kbd(C-u)}}}
3407 prefix. If you want to avoid opening in Emacs, use a {{{kbd(C-u
3410 #+vindex: org-link-frame-setup
3411 If the cursor is on a headline, but not on a link, offer all
3412 links in the headline and entry text. If you want to setup the
3413 frame configuration for following links, customize
3414 ~org-link-frame-setup~.
3418 #+vindex: org-return-follows-link
3420 When ~org-return-follows-link~ is set, {{{kbd(RET)}}} also
3421 follows the link at point.
3423 - {{{kbd(mouse-2)}}} or {{{kbd(mouse-1)}}} ::
3427 On links, {{{kbd(mouse-1)}}} and {{{kbd(mouse-2)}}} opens the
3428 link just as {{{kbd(C-c C-o)}}} does.
3430 - {{{kbd(mouse-3)}}} ::
3432 #+vindex: org-display-internal-link-with-indirect-buffer
3434 Like {{{kbd(mouse-2)}}}, but force file links to be opened with
3435 Emacs, and internal links to be displayed in another
3438 - {{{kbd(C-c C-x C-v)}}} (~org-toggle-inline-images~) ::
3440 #+cindex: inlining images
3441 #+cindex: images, inlining
3442 #+vindex: org-startup-with-inline-images
3443 #+kindex: C-c C-x C-v
3444 #+findex: org-toggle-inline-images
3445 Toggle the inline display of linked images. Normally this only
3446 inlines images that have no description part in the link, i.e.,
3447 images that are inlined during export. When called with a prefix
3448 argument, also display images that do have a link description.
3449 You can ask for inline images to be displayed at startup by
3450 configuring the variable ~org-startup-with-inline-images~[fn:34].
3452 - {{{kbd(C-c %)}}} (~org-mark-ring-push~) ::
3455 #+findex: org-mark-ring-push
3457 Push the current position onto the mark ring, to be able to
3458 return easily. Commands following an internal link do this
3461 - {{{kbd(C-c &)}}} (~org-mark-ring-goto~) ::
3464 #+findex: org-mark-ring-goto
3465 #+cindex: links, returning to
3466 Jump back to a recorded position. A position is recorded by the
3467 commands following internal links, and by {{{kbd(C-c %)}}}.
3468 Using this command several times in direct succession moves
3469 through a ring of previously recorded positions.
3471 - {{{kbd(C-c C-x C-n)}}} (~org-next-link~), {{{kbd(C-c C-x C-p)}}} (~org-previous-link~) ::
3473 #+kindex: C-c C-x C-p
3474 #+findex: org-previous-link
3475 #+kindex: C-c C-x C-n
3476 #+findex: org-next-link
3477 #+cindex: links, finding next/previous
3478 Move forward/backward to the next link in the buffer. At the
3479 limit of the buffer, the search fails once, and then wraps
3480 around. The key bindings for this are really too long; you might
3481 want to bind this also to {{{kbd(M-n)}}} and {{{kbd(M-p)}}}.
3483 #+begin_src emacs-lisp
3484 (add-hook 'org-load-hook
3486 (define-key org-mode-map "\M-n" 'org-next-link)
3487 (define-key org-mode-map "\M-p" 'org-previous-link)))
3490 ** Using Links Outside Org
3492 :DESCRIPTION: Linking from my C source code?
3495 #+findex: org-insert-link-global
3496 #+findex: org-open-at-point-global
3497 You can insert and follow links that have Org syntax not only in Org,
3498 but in any Emacs buffer. For this, Org provides two functions:
3499 ~org-insert-link-global~ and ~org-open-at-point-global~.
3501 You might want to bind them to globally available keys. See
3502 [[*Activation]] for some advice.
3504 ** Link Abbreviations
3506 :DESCRIPTION: Shortcuts for writing complex links.
3508 #+cindex: link abbreviations
3509 #+cindex: abbreviation, links
3511 Long URL can be cumbersome to type, and often many similar links are
3512 needed in a document. For this you can use link abbreviations. An
3513 abbreviated link looks like this
3515 : [[linkword:tag][description]]
3517 #+texinfo: @noindent
3518 #+vindex: org-link-abbrev-alist
3519 where the tag is optional. The /linkword/ must be a word, starting
3520 with a letter, followed by letters, numbers, =-=, and =_=.
3521 Abbreviations are resolved according to the information in the
3522 variable ~org-link-abbrev-alist~ that relates the linkwords to
3523 replacement text. Here is an example:
3525 #+begin_src emacs-lisp
3526 (setq org-link-abbrev-alist
3527 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3528 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3529 ("google" . "http://www.google.com/search?q=")
3530 ("gmap" . "http://maps.google.com/maps?q=%s")
3531 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3532 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3535 If the replacement text contains the string =%s=, it is replaced with
3536 the tag. Using =%h= instead of =%s= percent-encodes the tag (see the
3537 example above, where we need to encode the URL parameter). Using
3538 =%(my-function)= passes the tag to a custom function, and replace it
3539 by the resulting string.
3541 If the replacement text do not contain any specifier, it is simply
3542 appended to the string in order to create the link.
3544 Instead of a string, you may also specify a function that will be
3545 called with the tag as the only argument to create the link.
3547 With the above setting, you could link to a specific bug with
3548 =[[bugzilla:129]]=, search the web for =OrgMode= with =[[google:OrgMode]]=,
3549 show the map location of the Free Software Foundation =[[gmap:51
3550 Franklin Street, Boston]]= or of Carsten office =[[omap:Science Park 904,
3551 Amsterdam, The Netherlands]]= and find out what the Org author is doing
3552 besides Emacs hacking with =[[ads:Dominik,C]]=.
3554 If you need special abbreviations just for a single Org buffer, you
3555 can define them in the file with
3557 #+cindex: @samp{LINK}, keyword
3559 ,#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3560 ,#+LINK: google http://www.google.com/search?q=%s
3563 #+texinfo: @noindent
3564 In-buffer completion (see [[*Completion]]) can be used after =[= to
3565 complete link abbreviations. You may also define a function that
3566 implements special (e.g., completion) support for inserting such
3567 a link with {{{kbd(C-c C-l)}}}. Such a function should not accept any
3568 arguments, and return the full link with prefix. You can set the link
3569 completion function like this:
3571 #+begin_src emacs-lisp
3572 (org-link-set-parameter "type" :complete #'some-completion-function)
3575 ** Search Options in File Links
3577 :DESCRIPTION: Linking to a specific location.
3578 :ALT_TITLE: Search Options
3580 #+cindex: search option in file links
3581 #+cindex: file links, searching
3583 File links can contain additional information to make Emacs jump to
3584 a particular location in the file when following a link. This can be
3585 a line number or a search option after a double colon[fn:35]. For
3586 example, when the command ~org-store-link~ creates a link (see
3587 [[*Handling Links]]) to a file, it encodes the words in the current line
3588 as a search string that can be used to find this line back later when
3589 following the link with {{{kbd(C-c C-o)}}}.
3591 Here is the syntax of the different ways to attach a search to a file
3592 link, together with an explanation:
3595 [[file:~/code/main.c::255]]
3596 [[file:~/xx.org::My Target]]
3597 [[file:~/xx.org::*My Target]]
3598 [[file:~/xx.org::#my-custom-id]]
3599 [[file:~/xx.org::/regexp/]]
3608 Search for a link target =<<My Target>>=, or do a text search for
3609 =my target=, similar to the search in internal links, see
3610 [[*Internal Links]]. In HTML export (see [[*HTML Export]]), such a file
3611 link becomes a HTML reference to the corresponding named anchor
3616 In an Org file, restrict search to headlines.
3618 - =#my-custom-id= ::
3620 Link to a heading with a =CUSTOM_ID= property
3624 Do a regular expression search for {{{var(REGEXP)}}}. This uses
3625 the Emacs command ~occur~ to list all matches in a separate
3626 window. If the target file is in Org mode, ~org-occur~ is used
3627 to create a sparse tree with the matches.
3629 As a degenerate case, a file link with an empty file name can be used
3630 to search the current file. For example, =[[file:::find me]]= does
3631 a search for =find me= in the current file, just as =[[find me]]= would.
3635 :DESCRIPTION: When the default search is not enough.
3637 #+cindex: custom search strings
3638 #+cindex: search strings, custom
3640 The default mechanism for creating search strings and for doing the
3641 actual search related to a file link may not work correctly in all
3642 cases. For example, BibTeX database files have many entries like
3643 ~year="1993"~ which would not result in good search strings, because
3644 the only unique identification for a BibTeX entry is the citation key.
3646 #+vindex: org-create-file-search-functions
3647 #+vindex: org-execute-file-search-functions
3648 If you come across such a problem, you can write custom functions to
3649 set the right search string for a particular file type, and to do the
3650 search for the string in the file. Using ~add-hook~, these functions
3651 need to be added to the hook variables
3652 ~org-create-file-search-functions~ and
3653 ~org-execute-file-search-functions~. See the docstring for these
3654 variables for more information. Org actually uses this mechanism for
3655 BibTeX database files, and you can use the corresponding code as an
3656 implementation example. See the file =org-bibtex.el=.
3660 :DESCRIPTION: Every tree branch can be a TODO item.
3662 #+cindex: TODO items
3664 Org mode does not maintain TODO lists as separate documents[fn:36].
3665 Instead, TODO items are an integral part of the notes file, because
3666 TODO items usually come up while taking notes! With Org mode, simply
3667 mark any entry in a tree as being a TODO item. In this way,
3668 information is not duplicated, and the entire context from which the
3669 TODO item emerged is always present.
3671 Of course, this technique for managing TODO items scatters them
3672 throughout your notes file. Org mode compensates for this by
3673 providing methods to give you an overview of all the things that you
3676 ** Basic TODO Functionality
3678 :DESCRIPTION: Marking and displaying TODO entries.
3679 :ALT_TITLE: TODO Basics
3682 Any headline becomes a TODO item when it starts with the word =TODO=,
3685 : *** TODO Write letter to Sam Fortune
3687 #+texinfo: @noindent
3688 The most important commands to work with TODO entries are:
3690 - {{{kbd(C-c C-t)}}} (~org-todo~) ::
3693 #+cindex: cycling, of TODO states
3694 Rotate the TODO state of the current item among
3697 ,-> (unmarked) -> TODO -> DONE --.
3698 '--------------------------------'
3701 If TODO keywords have fast access keys (see [[*Fast access to
3702 TODO states]]), prompt for a TODO keyword through the fast
3703 selection interface; this is the default behavior when
3704 ~org-use-fast-todo-selection~ is non-~nil~.
3706 The same rotation can also be done "remotely" from the timeline
3707 and agenda buffers with the {{{kbd(t)}}} command key (see
3708 [[*Commands in the Agenda Buffer]]).
3710 - {{{kbd(C-u C-c C-t)}}} ::
3712 #+kindex: C-u C-c C-t
3713 When TODO keywords have no selection keys, select a specific
3714 keyword using completion; otherwise force cycling through TODO
3715 states with no prompt. When ~org-use-fast-todo-selection~ is set
3716 to ~prefix~, use the fast selection interface.
3718 - {{{kbd(S-RIGHT)}}} {{{kbd(S-LEFT)}}} ::
3722 #+vindex: org-treat-S-cursor-todo-selection-as-state-change
3723 Select the following/preceding TODO state, similar to cycling.
3724 Useful mostly if more than two TODO states are possible (see
3725 [[*Extended Use of TODO Keywords]]). See also [[*Packages that
3726 conflict with Org mode]], for a discussion of the interaction with
3727 ~shift-selection-mode~. See also the variable
3728 ~org-treat-S-cursor-todo-selection-as-state-change~.
3730 - {{{kbd(C-c / t)}}} (~org-show-todo-tree~) ::
3733 #+cindex: sparse tree, for TODO
3734 #+vindex: org-todo-keywords
3735 #+findex: org-show-todo-tree
3736 View TODO items in a /sparse tree/ (see [[*Sparse Trees]]). Folds
3737 the entire buffer, but shows all TODO items---with not-DONE
3738 state---and the headings hierarchy above them. With a prefix
3739 argument, or by using {{{kbd(C-c / T)}}}, search for a specific
3740 TODO. You are prompted for the keyword, and you can also give
3741 a list of keywords like =KWD1|KWD2|...= to list entries that
3742 match any one of these keywords. With a numeric prefix argument
3743 N, show the tree for the Nth keyword in the variable
3744 ~org-todo-keywords~. With two prefix arguments, find all TODO
3745 states, both un-done and done.
3747 - {{{kbd(C-c a t)}}} (~org-todo-list~) ::
3750 Show the global TODO list. Collects the TODO items (with
3751 not-DONE states) from all agenda files (see [[*Agenda Views]]) into
3752 a single buffer. The new buffer is in Org Agenda mode, which
3753 provides commands to examine and manipulate the TODO entries from
3754 the new buffer (see [[*Commands in the Agenda Buffer]]). See [[*The
3755 global TODO list]], for more information.
3757 - {{{kbd(S-M-RET)}}} (~org-insert-todo-heading~) ::
3760 #+findex: org-insert-todo-heading
3761 Insert a new TODO entry below the current one.
3763 #+vindex: org-todo-state-tags-triggers
3764 #+texinfo: @noindent
3765 Changing a TODO state can also trigger tag changes. See the docstring
3766 of the option ~org-todo-state-tags-triggers~ for details.
3768 ** Extended Use of TODO Keywords
3770 :DESCRIPTION: Workflow and assignments.
3771 :ALT_TITLE: TODO Extensions
3773 #+cindex: extended TODO keywords
3775 #+vindex: org-todo-keywords
3776 By default, marked TODO entries have one of only two states: TODO and
3777 DONE. Org mode allows you to classify TODO items in more complex ways
3778 with /TODO keywords/ (stored in ~org-todo-keywords~). With special
3779 setup, the TODO keyword system can work differently in different
3782 Note that /tags/ are another way to classify headlines in general and
3783 TODO items in particular (see [[*Tags]]).
3785 *** TODO keywords as workflow states
3787 :DESCRIPTION: From TODO to DONE in steps.
3788 :ALT_TITLE: Workflow states
3790 #+cindex: TODO workflow
3791 #+cindex: workflow states as TODO keywords
3793 You can use TODO keywords to indicate different /sequential/ states in
3794 the process of working on an item, for example[fn:37]:
3796 #+begin_src emacs-lisp
3797 (setq org-todo-keywords
3798 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3801 The vertical bar separates the TODO keywords (states that /need
3802 action/) from the DONE states (which need /no further action/). If
3803 you do not provide the separator bar, the last state is used as the
3806 #+cindex: completion, of TODO keywords
3807 With this setup, the command {{{kbd(C-c C-t)}}} cycles an entry from
3808 =TODO= to =FEEDBACK=, then to =VERIFY=, and finally to =DONE= and
3809 =DELEGATED=. You may also use a numeric prefix argument to quickly
3810 select a specific state. For example {{{kbd(C-3 C-c C-t)}}} changes
3811 the state immediately to =VERIFY=. Or you can use {{{kbd(S-LEFT)}}}
3812 to go backward through the sequence. If you define many keywords, you
3813 can use in-buffer completion (see [[*Completion]]) or even a special
3814 one-key selection scheme (see [[*Fast access to TODO states]]) to insert
3815 these words into the buffer. Changing a TODO state can be logged with
3816 a timestamp, see [[*Tracking TODO state changes]], for more information.
3818 *** TODO keywords as types
3820 :DESCRIPTION: I do this, Fred does the rest.
3821 :ALT_TITLE: TODO types
3823 #+cindex: TODO types
3824 #+cindex: names as TODO keywords
3825 #+cindex: types as TODO keywords
3827 The second possibility is to use TODO keywords to indicate different
3828 /types/ of action items. For example, you might want to indicate that
3829 items are for "work" or "home". Or, when you work with several people
3830 on a single project, you might want to assign action items directly to
3831 persons, by using their names as TODO keywords. This would be set up
3834 #+begin_src emacs-lisp
3835 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3838 In this case, different keywords do not indicate a sequence, but
3839 rather different types. So the normal work flow would be to assign
3840 a task to a person, and later to mark it DONE. Org mode supports this
3841 style by adapting the workings of the command {{{kbd(C-c
3842 C-t)}}}[fn:38]. When used several times in succession, it still
3843 cycles through all names, in order to first select the right type for
3844 a task. But when you return to the item after some time and execute
3845 {{{kbd(C-c C-t)}}} again, it will switch from any name directly to
3846 =DONE=. Use prefix arguments or completion to quickly select
3847 a specific name. You can also review the items of a specific TODO
3848 type in a sparse tree by using a numeric prefix to {{{kbd(C-c / t)}}}.
3849 For example, to see all things Lucy has to do, you would use
3850 {{{kbd(C-3 C-c / t)}}}. To collect Lucy's items from all agenda files
3851 into a single buffer, you would use the numeric prefix argument as
3852 well when creating the global TODO list: {{{kbd(C-3 C-c a t)}}}.
3854 *** Multiple keyword sets in one file
3856 :DESCRIPTION: Mixing it all, still finding your way.
3857 :ALT_TITLE: Multiple sets in one file
3859 #+cindex: TODO keyword sets
3861 Sometimes you may want to use different sets of TODO keywords in
3862 parallel. For example, you may want to have the basic TODO/DONE, but
3863 also a workflow for bug fixing, and a separate state indicating that
3864 an item has been canceled---so it is not DONE, but also does not
3865 require action. Your setup would then look like this:
3867 #+begin_src emacs-lisp
3868 (setq org-todo-keywords
3869 '((sequence "TODO" "|" "DONE")
3870 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3871 (sequence "|" "CANCELED")))
3874 The keywords should all be different, this helps Org mode to keep
3875 track of which subsequence should be used for a given entry. In this
3876 setup, {{{kbd(C-c C-t)}}} only operates within a subsequence, so it
3877 switches from =DONE= to (nothing) to =TODO=, and from =FIXED= to
3878 (nothing) to =REPORT=. Therefore you need a mechanism to initially
3879 select the correct sequence. Besides the obvious ways like typing
3880 a keyword or using completion, you may also apply the following
3883 #+attr_texinfo: :sep ,
3884 - {{{kbd(C-u C-u C-c C-t)}}}, {{{kbd(C-S-RIGHT)}}}, {{{kbd(C-S-LEFT)}}} ::
3888 #+kindex: C-u C-u C-c C-t
3889 These keys jump from one TODO subset to the next. In the above
3890 example, {{{kbd(C-u C-u C-c C-t)}}} or {{{kbd(C-S-RIGHT)}}} would
3891 jump from =TODO= or =DONE= to =REPORT=, and any of the words in
3892 the second row to =CANCELED=. Note that the {{{kbd(C-S-)}}} key
3893 binding conflict with ~shift-selection-mode~ (see [[*Packages
3894 that conflict with Org mode]]).
3896 - {{{kbd(S-RIGHT)}}}, {{{kbd(S-LEFT)}}} ::
3900 {{{kbd(S-LEFT)}}} and {{{kbd(S-RIGHT)}}} walk through /all/
3901 keywords from all sets, so for example {{{kbd(S-RIGHT)}}} would
3902 switch from =DONE= to =REPORT= in the example above. For
3903 a discussion of the interaction with ~shift-selection-mode~, see
3904 [[*Packages that conflict with Org mode]].
3906 *** Fast access to TODO states
3908 :DESCRIPTION: Single letter selection of state.
3911 If you would like to quickly change an entry to an arbitrary TODO
3912 state instead of cycling through the states, you can set up keys for
3913 single-letter access to the states. This is done by adding the
3914 selection character after each keyword, in parentheses[fn:39]. For
3917 #+begin_src emacs-lisp
3918 (setq org-todo-keywords
3919 '((sequence "TODO(t)" "|" "DONE(d)")
3920 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3921 (sequence "|" "CANCELED(c)")))
3924 #+vindex: org-fast-tag-selection-include-todo
3925 If you then press {{{kbd(C-c C-t)}}} followed by the selection key,
3926 the entry is switched to this state. {{{kbd(SPC)}}} can be used to
3927 remove any TODO keyword from an entry[fn:40].
3929 *** Setting up keywords for individual files
3931 :DESCRIPTION: Different files, different requirements.
3932 :ALT_TITLE: Per-file keywords
3934 #+cindex: keyword options
3935 #+cindex: per-file keywords
3936 #+cindex: @samp{TODO}, keyword
3937 #+cindex: @samp{TYP_TODO}, keyword
3938 #+cindex: @samp{SEQ_TODO}, keyword
3940 It can be very useful to use different aspects of the TODO mechanism
3941 in different files. For file-local settings, you need to add special
3942 lines to the file which set the keywords and interpretation for that
3943 file only. For example, to set one of the two examples discussed
3944 above, you need one of the following lines, starting in column zero
3945 anywhere in the file:
3947 : #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3949 #+texinfo: @noindent
3950 you may also write =#+SEQ_TODO= to be explicit about the
3951 interpretation, but it means the same as =#+TODO=, or
3953 : #+TYP_TODO: Fred Sara Lucy Mike | DONE
3955 A setup for using several sets in parallel would be:
3958 ,#+TODO: TODO | DONE
3959 ,#+TODO: REPORT BUG KNOWNCAUSE | FIXED
3963 #+cindex: completion, of option keywords
3965 #+texinfo: @noindent
3966 To make sure you are using the correct keyword, type =#+= into the
3967 buffer and then use {{{kbd(M-TAB)}}} completion.
3969 #+cindex: DONE, final TODO keyword
3970 Remember that the keywords after the vertical bar---or the last
3971 keyword if no bar is there---must always mean that the item is DONE,
3972 although you may use a different word. After changing one of these
3973 lines, use {{{kbd(C-c C-c)}}} with the cursor still in the line to
3974 make the changes known to Org mode[fn:41].
3976 *** Faces for TODO keywords
3978 :DESCRIPTION: Highlighting states.
3980 #+cindex: faces, for TODO keywords
3982 #+vindex: org-todo, face
3983 #+vindex: org-done, face
3984 #+vindex: org-todo-keyword-faces
3985 Org mode highlights TODO keywords with special faces: ~org-todo~ for
3986 keywords indicating that an item still has to be acted upon, and
3987 ~org-done~ for keywords indicating that an item is finished. If you
3988 are using more than two different states, you might want to use
3989 special faces for some of them. This can be done using the variable
3990 ~org-todo-keyword-faces~. For example:
3992 #+begin_src emacs-lisp
3993 (setq org-todo-keyword-faces
3994 '(("TODO" . org-warning) ("STARTED" . "yellow")
3995 ("CANCELED" . (:foreground "blue" :weight bold))))
3998 #+vindex: org-faces-easy-properties
3999 While using a list with face properties as shown for =CANCELED=
4000 /should/ work, this does not always seem to be the case. If
4001 necessary, define a special face and use that. A string is
4002 interpreted as a color. The variable ~org-faces-easy-properties~
4003 determines if that color is interpreted as a foreground or
4006 *** TODO dependencies
4008 :DESCRIPTION: When one task needs to wait for others.
4010 #+cindex: TODO dependencies
4011 #+cindex: dependencies, of TODO states
4013 #+vindex: org-enforce-todo-dependencies
4014 #+cindex: @samp{ORDERED}, property
4015 The structure of Org files---hierarchy and lists---makes it easy to
4016 define TODO dependencies. Usually, a parent TODO task should not be
4017 marked DONE until all subtasks, defined as children tasks, are marked
4018 as DONE. And sometimes there is a logical sequence to a number of
4019 (sub)tasks, so that one task cannot be acted upon before all siblings
4020 above it are done. If you customize the variable
4021 ~org-enforce-todo-dependencies~, Org blocks entries from changing
4022 state to DONE while they have children that are not DONE.
4023 Furthermore, if an entry has a property =ORDERED=, each of its
4024 children is blocked until all earlier siblings are marked DONE. Here
4028 ,* TODO Blocked until (two) is done
4037 ,** TODO b, needs to wait for (a)
4038 ,** TODO c, needs to wait for (a) and (b)
4041 #+cindex: TODO dependencies, NOBLOCKING
4042 #+cindex: NOBLOCKING, property
4043 You can ensure an entry is never blocked by using the =NOBLOCKING=
4047 ,* This entry is never blocked
4053 - {{{kbd(C-c C-x o)}}} (~org-toggle-ordered-property~) ::
4056 #+findex: org-toggle-ordered-property
4057 #+vindex: org-track-ordered-property-with-tag
4058 #+cindex: @samp{ORDERED}, property
4059 Toggle the =ORDERED= property of the current entry. A property
4060 is used for this behavior because this should be local to the
4061 current entry, not inherited like a tag. However, if you would
4062 like to /track/ the value of this property with a tag for better
4063 visibility, customize the variable
4064 ~org-track-ordered-property-with-tag~.
4066 - {{{kbd(C-u C-u C-u C-c C-t)}}} ::
4068 #+kindex: C-u C-u C-u C-c C-t
4069 Change TODO state, circumventing any state blocking.
4071 #+vindex: org-agenda-dim-blocked-tasks
4072 If you set the variable ~org-agenda-dim-blocked-tasks~, TODO entries
4073 that cannot be closed because of such dependencies are shown in
4074 a dimmed font or even made invisible in agenda views (see [[*Agenda
4077 #+cindex: checkboxes and TODO dependencies
4078 #+vindex: org-enforce-todo-dependencies
4079 You can also block changes of TODO states by looking at checkboxes
4080 (see [[*Checkboxes]]). If you set the variable
4081 ~org-enforce-todo-checkbox-dependencies~, an entry that has unchecked
4082 checkboxes is blocked from switching to DONE.
4084 If you need more complex dependency structures, for example
4085 dependencies between entries in different trees or files, check out
4086 the contributed module =org-depend.el=.
4090 :DESCRIPTION: Dates and notes for progress.
4092 #+cindex: progress logging
4093 #+cindex: logging, of progress
4095 Org mode can automatically record a timestamp and possibly a note when
4096 you mark a TODO item as DONE, or even each time you change the state
4097 of a TODO item. This system is highly configurable, settings can be
4098 on a per-keyword basis and can be localized to a file or even
4099 a subtree. For information on how to clock working time for a task,
4100 see [[*Clocking Work Time]].
4104 :DESCRIPTION: When was this entry marked DONE?
4107 The most basic logging is to keep track of /when/ a certain TODO item
4108 was finished. This is achieved with[fn:42]
4110 #+begin_src emacs-lisp
4111 (setq org-log-done 'time)
4114 #+vindex: org-closed-keep-when-no-todo
4115 #+texinfo: @noindent
4116 Then each time you turn an entry from a TODO (not-done) state into any
4117 of the DONE states, a line =CLOSED: [timestamp]= is inserted just
4118 after the headline. If you turn the entry back into a TODO item
4119 through further state cycling, that line is removed again. If you
4120 turn the entry back to a non-TODO state (by pressing {{{kbd(C-c C-t
4121 SPC)}}} for example), that line is also removed, unless you set
4122 ~org-closed-keep-when-no-todo~ to non-~nil~. If you want to record
4123 a note along with the timestamp, use[fn:43]
4125 #+begin_src emacs-lisp
4126 (setq org-log-done 'note)
4129 #+texinfo: @noindent
4130 You are then be prompted for a note, and that note is stored below the
4131 entry with a =Closing Note= heading.
4133 *** Tracking TODO state changes
4135 :DESCRIPTION: When did the status change?
4137 #+cindex: drawer, for state change recording
4139 #+vindex: org-log-states-order-reversed
4140 #+vindex: org-log-into-drawer
4141 #+cindex: @samp{LOG_INTO_DRAWER}, property
4142 When TODO keywords are used as workflow states (see [[*TODO keywords as workflow states][*Workflow states]]),
4143 you might want to keep track of when a state change occurred and maybe
4144 take a note about this change. You can either record just
4145 a timestamp, or a time-stamped note for a change. These records are
4146 inserted after the headline as an itemized list, newest first[fn:44].
4147 When taking a lot of notes, you might want to get the notes out of the
4148 way into a drawer (see [[*Drawers]]). Customize the variable
4149 ~org-log-into-drawer~ to get this behavior---the recommended drawer
4150 for this is called =LOGBOOK=[fn:45]. You can also overrule the
4151 setting of this variable for a subtree by setting a =LOG_INTO_DRAWER=
4154 Since it is normally too much to record a note for every state, Org
4155 mode expects configuration on a per-keyword basis for this. This is
4156 achieved by adding special markers =!= (for a timestamp) or =@= (for
4157 a note with timestamp) in parentheses after each keyword. For
4158 example, with the setting
4160 #+begin_src emacs-lisp
4161 (setq org-todo-keywords
4162 '((sequence "TODO(t)" "WAIT(w@/!)" "|" "DONE(d!)" "CANCELED(c@)")))
4165 To record a timestamp without a note for TODO keywords configured with
4166 =@=, just type {{{kbd(C-c C-c)}}} to enter a blank note when prompted.
4168 #+vindex: org-log-done
4170 you not only define global TODO keywords and fast access keys, but
4171 also request that a time is recorded when the entry is set to =DONE=,
4172 and that a note is recorded when switching to =WAIT= or
4173 =CANCELED=[fn:46]. The setting for =WAIT= is even more special: the
4174 =!= after the slash means that in addition to the note taken when
4175 entering the state, a timestamp should be recorded when /leaving/ the
4176 =WAIT= state, if and only if the /target/ state does not configure
4177 logging for entering it. So it has no effect when switching from
4178 =WAIT= to =DONE=, because =DONE= is configured to record a timestamp
4179 only. But when switching from =WAIT= back to =TODO=, the =/!= in the
4180 =WAIT= setting now triggers a timestamp even though =TODO= has no
4183 You can use the exact same syntax for setting logging preferences local
4186 : #+TODO: TODO(t) WAIT(w@/!) | DONE(d!) CANCELED(c@)
4188 #+cindex: @samp{LOGGING}, property
4189 In order to define logging settings that are local to a subtree or
4190 a single item, define a =LOGGING= property in this entry. Any
4191 non-empty =LOGGING= property resets all logging settings to ~nil~.
4192 You may then turn on logging for this specific tree using =STARTUP=
4193 keywords like =lognotedone= or =logrepeat=, as well as adding state
4194 specific settings like =TODO(!)=. For example:
4197 ,* TODO Log each state with only a time
4199 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4201 ,* TODO Only log when switching to WAIT, and when repeating
4203 :LOGGING: WAIT(@) logrepeat
4205 ,* TODO No logging at all
4211 *** Tracking your habits
4213 :DESCRIPTION: How consistent have you been?
4216 #+cindex: STYLE, property
4218 Org has the ability to track the consistency of a special category of
4219 TODO, called "habits." A habit has the following properties:
4221 1. You have enabled the ~habits~ module by customizing the variable
4224 2. The habit is a TODO item, with a TODO keyword representing an open
4227 3. The property =STYLE= is set to the value =habit=.
4229 4. The TODO has a scheduled date, usually with a =.+= style repeat
4230 interval. A =++= style may be appropriate for habits with time
4231 constraints, e.g., must be done on weekends, or a =+= style for an
4232 unusual habit that can have a backlog, e.g., weekly reports.
4234 5. The TODO may also have minimum and maximum ranges specified by
4235 using the syntax =.+2d/3d=, which says that you want to do the task
4236 at least every three days, but at most every two days.
4238 6. You must also have state logging for the DONE state enabled (see
4239 [[*Tracking TODO state changes]]), in order for historical data to be
4240 represented in the consistency graph. If it is not enabled it is
4241 not an error, but the consistency graphs are largely meaningless.
4243 To give you an idea of what the above rules look like in action, here's an
4244 actual habit with some history:
4248 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4251 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4253 - State "DONE" from "TODO" [2009-10-15 Thu]
4254 - State "DONE" from "TODO" [2009-10-12 Mon]
4255 - State "DONE" from "TODO" [2009-10-10 Sat]
4256 - State "DONE" from "TODO" [2009-10-04 Sun]
4257 - State "DONE" from "TODO" [2009-10-02 Fri]
4258 - State "DONE" from "TODO" [2009-09-29 Tue]
4259 - State "DONE" from "TODO" [2009-09-25 Fri]
4260 - State "DONE" from "TODO" [2009-09-19 Sat]
4261 - State "DONE" from "TODO" [2009-09-16 Wed]
4262 - State "DONE" from "TODO" [2009-09-12 Sat]
4265 What this habit says is: I want to shave at most every 2 days---given
4266 by the =SCHEDULED= date and repeat interval---and at least every
4267 4 days. If today is the 15th, then the habit first appears in the
4268 agenda on Oct 17, after the minimum of 2 days has elapsed, and will
4269 appear overdue on Oct 19, after four days have elapsed.
4271 What's really useful about habits is that they are displayed along
4272 with a consistency graph, to show how consistent you've been at
4273 getting that task done in the past. This graph shows every day that
4274 the task was done over the past three weeks, with colors for each day.
4275 The colors used are:
4277 - Blue :: If the task was not to be done yet on that day.
4278 - Green :: If the task could have been done on that day.
4279 - Yellow :: If the task was going to be overdue the next day.
4280 - Red :: If the task was overdue on that day.
4282 In addition to coloring each day, the day is also marked with an
4283 asterisk if the task was actually done that day, and an exclamation
4284 mark to show where the current day falls in the graph.
4286 There are several configuration variables that can be used to change
4287 the way habits are displayed in the agenda.
4289 - ~org-habit-graph-column~ ::
4291 #+vindex: org-habit-graph-column
4292 The buffer column at which the consistency graph should be drawn.
4293 This overwrites any text in that column, so it is a good idea to
4294 keep your habits' titles brief and to the point.
4296 - ~org-habit-preceding-days~ ::
4298 #+vindex: org-habit-preceding-days
4299 The amount of history, in days before today, to appear in
4302 - ~org-habit-following-days~ ::
4304 #+vindex: org-habit-following-days
4305 The number of days after today that appear in consistency graphs.
4307 - ~org-habit-show-habits-only-for-today~ ::
4309 #+vindex: org-habit-show-habits-only-for-today
4310 If non-~nil~, only show habits in today's agenda view. This is
4311 set to true by default.
4313 Lastly, pressing {{{kbd(K)}}} in the agenda buffer causes habits to
4314 temporarily be disabled and do not appear at all. Press {{{kbd(K)}}}
4315 again to bring them back. They are also subject to tag filtering, if
4316 you have habits which should only be done in certain contexts, for
4321 :DESCRIPTION: Some things are more important than others.
4323 #+cindex: priorities
4324 #+cindex: priority cookie
4326 If you use Org mode extensively, you may end up with enough TODO items
4327 that it starts to make sense to prioritize them. Prioritizing can be
4328 done by placing a /priority cookie/ into the headline of a TODO item,
4331 : *** TODO [#A] Write letter to Sam Fortune
4333 #+vindex: org-priority-faces
4334 #+texinfo: @noindent
4335 By default, Org mode supports three priorities: =A=, =B=, and =C=.
4336 =A= is the highest priority. An entry without a cookie is treated
4337 just like priority =B=. Priorities make a difference only for sorting
4338 in the agenda (see [[*Weekly/daily agenda]]); outside the agenda, they
4339 have no inherent meaning to Org mode. The cookies can be highlighted
4340 with special faces by customizing the variable ~org-priority-faces~.
4342 Priorities can be attached to any outline node; they do not need to be
4345 #+attr_texinfo: :sep ;
4346 - {{{kbd(C-c \,)}}} (~org-priority~) ::
4349 #+findex: org-priority
4350 Set the priority of the current headline. The command prompts
4351 for a priority character =A=, =B= or =C=. When you press
4352 {{{kbd(SPC)}}} instead, the priority cookie is removed from the
4353 headline. The priorities can also be changed "remotely" from the
4354 timeline and agenda buffer with the {{{kbd(\,)}}} command (see
4355 [[*Commands in the Agenda Buffer]]).
4357 - {{{kbd(S-UP)}}} (~org-priority-up~); {{{kbd(S-DOWN)}}} (~org-priority-down~) ::
4361 #+findex: org-priority-up
4362 #+findex: org-priority-down
4363 #+vindex: org-priority-start-cycle-with-default
4364 Increase/decrease priority of current headline[fn:47]. Note that
4365 these keys are also used to modify timestamps (see [[*Creating
4366 Timestamps]]). See also [[*Packages that conflict with Org mode]], for
4367 a discussion of the interaction with ~shift-selection-mode~.
4369 #+vindex: org-highest-priority
4370 #+vindex: org-lowest-priority
4371 #+vindex: org-default-priority
4372 You can change the range of allowed priorities by setting the
4373 variables ~org-highest-priority~, ~org-lowest-priority~, and
4374 ~org-default-priority~. For an individual buffer, you may set these
4375 values (highest, lowest, default) like this (please make sure that the
4376 highest priority is earlier in the alphabet than the lowest priority):
4378 #+cindex: @samp{PRIORITIES}, keyword
4379 : #+PRIORITIES: A C B
4381 ** Breaking Down Tasks into Subtasks
4383 :DESCRIPTION: Splitting a task into manageable pieces.
4384 :ALT_TITLE: Breaking Down Tasks
4386 #+cindex: tasks, breaking down
4387 #+cindex: statistics, for TODO items
4389 #+vindex: org-agenda-todo-list-sublevels
4390 It is often advisable to break down large tasks into smaller,
4391 manageable subtasks. You can do this by creating an outline tree
4392 below a TODO item, with detailed subtasks on the tree[fn:48]. To keep
4393 the overview over the fraction of subtasks that are already completed,
4394 insert either =[/]= or =[%]= anywhere in the headline. These cookies
4395 are updated each time the TODO status of a child changes, or when
4396 pressing {{{kbd(C-c C-c)}}} on the cookie. For example:
4399 ,* Organize Party [33%]
4400 ,** TODO Call people [1/2]
4404 ,** DONE Talk to neighbor
4407 #+cindex: @samp{COOKIE_DATA}, property
4408 If a heading has both checkboxes and TODO children below it, the
4409 meaning of the statistics cookie become ambiguous. Set the property
4410 =COOKIE_DATA= to either =checkbox= or =todo= to resolve this issue.
4412 #+vindex: org-hierarchical-todo-statistics
4413 If you would like to have the statistics cookie count any TODO entries
4414 in the subtree (not just direct children), configure the variable
4415 ~org-hierarchical-todo-statistics~. To do this for a single subtree,
4416 include the word =recursive= into the value of the =COOKIE_DATA=
4420 ,* Parent capturing statistics [2/20]
4422 :COOKIE_DATA: todo recursive
4426 If you would like a TODO entry to automatically change to DONE when
4427 all children are done, you can use the following setup:
4429 #+begin_src emacs-lisp
4430 (defun org-summary-todo (n-done n-not-done)
4431 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4432 (let (org-log-done org-log-states) ; turn off logging
4433 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4435 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4438 Another possibility is the use of checkboxes to identify (a hierarchy
4439 of) a large number of subtasks (see [[*Checkboxes]]).
4443 :DESCRIPTION: Tick-off lists.
4445 #+cindex: checkboxes
4447 #+vindex: org-list-automatic-rules
4448 Every item in a plain list[fn:49] (see [[*Plain Lists]]) can be made into
4449 a checkbox by starting it with the string =[ ]=. This feature is
4450 similar to TODO items (see [[*TODO Items]]), but is more lightweight.
4451 Checkboxes are not included into the global TODO list, so they are
4452 often great to split a task into a number of simple steps. Or you can
4453 use them in a shopping list. To toggle a checkbox, use {{{kbd(C-c
4454 C-c)}}}, or use the mouse (thanks to Piotr Zielinski's
4457 Here is an example of a checkbox list.
4460 ,* TODO Organize party [2/4]
4461 - [-] call people [1/3]
4466 - [ ] think about what music to play
4467 - [X] talk to the neighbors
4470 Checkboxes work hierarchically, so if a checkbox item has children
4471 that are checkboxes, toggling one of the children checkboxes makes the
4472 parent checkbox reflect if none, some, or all of the children are
4475 #+cindex: statistics, for checkboxes
4476 #+cindex: checkbox statistics
4477 #+cindex: @samp{COOKIE_DATA}, property
4478 #+vindex: org-hierarchical-checkbox-statistics
4479 The =[2/4]= and =[1/3]= in the first and second line are cookies
4480 indicating how many checkboxes present in this entry have been checked
4481 off, and the total number of checkboxes present. This can give you an
4482 idea on how many checkboxes remain, even without opening a folded
4483 entry. The cookies can be placed into a headline or into (the first
4484 line of) a plain list item. Each cookie covers checkboxes of direct
4485 children structurally below the headline/item on which the cookie
4486 appears[fn:50]. You have to insert the cookie yourself by typing
4487 either =[/]= or =[%]=. With =[/]= you get an =n out of m= result, as
4488 in the examples above. With =[%]= you get information about the
4489 percentage of checkboxes checked (in the above example, this would be
4490 =[50%]= and =[33%]=, respectively). In a headline, a cookie can count
4491 either checkboxes below the heading or TODO states of children, and it
4492 displays whatever was changed last. Set the property =COOKIE_DATA= to
4493 either =checkbox= or =todo= to resolve this issue.
4495 #+cindex: blocking, of checkboxes
4496 #+cindex: checkbox blocking
4497 #+cindex: @samp{ORDERED}, property
4498 If the current outline node has an =ORDERED= property, checkboxes must
4499 be checked off in sequence, and an error is thrown if you try to check
4500 off a box while there are unchecked boxes above it.
4502 #+texinfo: @noindent
4503 The following commands work with checkboxes:
4505 - {{{kbd(C-c C-c)}}} (~org-toggle-checkbox~) ::
4508 #+findex: org-toggle-checkbox
4509 Toggle checkbox status or---with prefix argument---checkbox
4510 presence at point. With a single prefix argument, add an empty
4511 checkbox or remove the current one[fn:51]. With a double prefix
4512 argument, set it to =[-]=, which is considered to be an
4515 - {{{kbd(C-c C-x C-b)}}} (~org-toggle-checkbox~) ::
4517 #+kindex: C-c C-x C-b
4518 Toggle checkbox status or---with prefix argument---checkbox
4519 presence at point. With double prefix argument, set it to =[-]=,
4520 which is considered to be an intermediate state.
4522 - If there is an active region, toggle the first checkbox in the
4523 region and set all remaining boxes to the same status as the
4524 first. With a prefix argument, add or remove the checkbox for
4525 all items in the region.
4527 - If the cursor is in a headline, toggle checkboxes in the region
4528 between this headline and the next---so /not/ the entire
4531 - If there is no active region, just toggle the checkbox at
4534 - {{{kbd(M-S-RET)}}} (~org-insert-todo-heading~) ::
4537 #+findex: org-insert-todo-heading
4538 Insert a new item with a checkbox. This works only if the cursor
4539 is already in a plain list item (see [[*Plain Lists]]).
4541 - {{{kbd(C-c C-x o)}}} (~org-toggle-ordered-property~) ::
4544 #+findex: org-toggle-ordered-property
4545 #+vindex: org-track-ordered-property-with-tag
4546 Toggle the =ORDERED= property of the entry, to toggle if
4547 checkboxes must be checked off in sequence. A property is used
4548 for this behavior because this should be local to the current
4549 entry, not inherited like a tag. However, if you would like to
4550 /track/ the value of this property with a tag for better
4551 visibility, customize ~org-track-ordered-property-with-tag~.
4553 - {{{kbd(C-c #)}}} (~org-update-statistics-cookies~) ::
4556 #+findex: org-update-statistics-cookies
4557 Update the statistics cookie in the current outline entry. When
4558 called with a {{{kbd(C-u)}}} prefix, update the entire file.
4559 Checkbox statistic cookies are updated automatically if you
4560 toggle checkboxes with {{{kbd(C-c C-c)}}} and make new ones with
4561 {{{kbd(M-S-RET)}}}. TODO statistics cookies update when changing
4562 TODO states. If you delete boxes/entries or add/change them by
4563 hand, use this command to get things back into sync.
4567 :DESCRIPTION: Tagging headlines and matching sets of tags.
4570 #+cindex: headline tagging
4571 #+cindex: matching, tags
4572 #+cindex: sparse tree, tag based
4574 An excellent way to implement labels and contexts for
4575 cross-correlating information is to assign /tags/ to headlines. Org
4576 mode has extensive support for tags.
4578 #+vindex: org-tag-faces
4579 Every headline can contain a list of tags; they occur at the end of
4580 the headline. Tags are normal words containing letters, numbers, =_=,
4581 and =@=. Tags must be preceded and followed by a single colon, e.g.,
4582 =:work:=. Several tags can be specified, as in =:work:urgent:=. Tags
4583 by default are in bold face with the same color as the headline. You
4584 may specify special faces for specific tags using the variable
4585 ~org-tag-faces~, in much the same way as you can for TODO keywords
4586 (see [[*Faces for TODO keywords]]).
4590 :DESCRIPTION: Tags use the tree structure of an outline.
4592 #+cindex: tag inheritance
4593 #+cindex: inheritance, of tags
4594 #+cindex: sublevels, inclusion into tags match
4596 /Tags/ make use of the hierarchical structure of outline trees. If
4597 a heading has a certain tag, all subheadings inherit the tag as well.
4598 For example, in the list
4601 ,* Meeting with the French group :work:
4602 ,** Summary by Frank :boss:notes:
4603 ,*** TODO Prepare slides for him :action:
4606 #+texinfo: @noindent
4607 the final heading has the tags =work=, =boss=, =notes=, and =action=
4608 even though the final heading is not explicitly marked with those
4609 tags. You can also set tags that all entries in a file should inherit
4610 just as if these tags were defined in a hypothetical level zero that
4611 surrounds the entire file. Use a line like this[fn:52]
4613 #+cindex: @samp{FILETAGS}, keyword
4614 : #+FILETAGS: :Peter:Boss:Secret:
4616 #+vindex: org-use-tag-inheritance
4617 #+vindex: org-tags-exclude-from-inheritance
4618 #+texinfo: @noindent
4619 To limit tag inheritance to specific tags, or to turn it off entirely,
4620 use the variables ~org-use-tag-inheritance~ and
4621 ~org-tags-exclude-from-inheritance~.
4623 #+vindex: org-tags-match-list-sublevels
4624 When a headline matches during a tags search while tag inheritance is
4625 turned on, all the sublevels in the same tree---for a simple match
4626 form---match as well[fn:53]. The list of matches may then become
4627 very long. If you only want to see the first tags match in a subtree,
4628 configure the variable ~org-tags-match-list-sublevels~ (not
4631 #+vindex: org-agenda-use-tag-inheritance
4632 Tag inheritance is relevant when the agenda search tries to match
4633 a tag, either in the ~tags~ or ~tags-todo~ agenda types. In other
4634 agenda types, ~org-use-tag-inheritance~ has no effect. Still, you may
4635 want to have your tags correctly set in the agenda, so that tag
4636 filtering works fine, with inherited tags. Set
4637 ~org-agenda-use-tag-inheritance~ to control this: the default value
4638 includes all agenda types, but setting this to ~nil~ can really speed
4639 up agenda generation.
4643 :DESCRIPTION: How to assign tags to a headline.
4645 #+cindex: setting tags
4646 #+cindex: tags, setting
4649 Tags can simply be typed into the buffer at the end of a headline.
4650 After a colon, {{{kbd(M-TAB)}}} offers completion on tags. There is
4651 also a special command for inserting tags:
4653 - {{{kbd(C-c C-q)}}} (~org-set-tags-command~) ::
4656 #+findex: org-set-tags-command
4657 #+cindex: completion, of tags
4658 #+vindex: org-tags-column
4659 Enter new tags for the current headline. Org mode either offers
4660 completion or a special single-key interface for setting tags,
4661 see below. After pressing {{{kbd(RET)}}}, the tags are inserted
4662 and aligned to ~org-tags-column~. When called with
4663 a {{{kbd(C-u)}}} prefix, all tags in the current buffer are
4664 aligned to that column, just to make things look nice. Tags are
4665 automatically realigned after promotion, demotion, and TODO state
4666 changes (see [[*Basic TODO Functionality]]).
4668 - {{{kbd(C-c C-c)}}} (~org-set-tags-command~) ::
4671 When the cursor is in a headline, this does the same as
4674 #+vindex: org-tag-alist
4675 Org supports tag insertion based on a /list of tags/. By default this
4676 list is constructed dynamically, containing all tags currently used in
4677 the buffer. You may also globally specify a hard list of tags with
4678 the variable ~org-tag-alist~. Finally you can set the default tags
4679 for a given file with lines like
4681 #+cindex: @samp{TAGS}, keyword
4683 ,#+TAGS: @work @home @tennisclub
4684 ,#+TAGS: laptop car pc sailboat
4687 If you have globally defined your preferred set of tags using the
4688 variable ~org-tag-alist~, but would like to use a dynamic tag list in
4689 a specific file, add an empty =TAGS= keyword to that file:
4693 #+vindex: org-tag-persistent-alist
4694 If you have a preferred set of tags that you would like to use in
4695 every file, in addition to those defined on a per-file basis by =TAGS=
4696 keyword, then you may specify a list of tags with the variable
4697 ~org-tag-persistent-alist~. You may turn this off on a per-file basis
4698 by adding a =STARTUP= keyword to that file:
4702 By default Org mode uses the standard minibuffer completion facilities
4703 for entering tags. However, it also implements another, quicker, tag
4704 selection method called /fast tag selection/. This allows you to
4705 select and deselect tags with just a single key press. For this to
4706 work well you should assign unique letters to most of your commonly
4707 used tags. You can do this globally by configuring the variable
4708 ~org-tag-alist~ in your Emacs init file. For example, you may find
4709 the need to tag many items in different files with =@home=. In this
4710 case you can set something like:
4712 #+begin_src emacs-lisp
4713 (setq org-tag-alist '(("@work" . ?w) ("@home" . ?h) ("laptop" . ?l)))
4716 #+texinfo: @noindent
4717 If the tag is only relevant to the file you are working on, then you
4718 can instead set the =TAGS= keyword as:
4720 : #+TAGS: @work(w) @home(h) @tennisclub(t) laptop(l) pc(p)
4722 #+texinfo: @noindent
4723 The tags interface shows the available tags in a splash window. If
4724 you want to start a new line after a specific tag, insert =\n= into
4727 : #+TAGS: @work(w) @home(h) @tennisclub(t) \n laptop(l) pc(p)
4729 #+texinfo: @noindent
4730 or write them in two lines:
4733 ,#+TAGS: @work(w) @home(h) @tennisclub(t)
4734 ,#+TAGS: laptop(l) pc(p)
4737 #+texinfo: @noindent
4738 You can also group together tags that are mutually exclusive by using
4741 : #+TAGS: { @work(w) @home(h) @tennisclub(t) } laptop(l) pc(p)
4743 #+texinfo: @noindent
4744 you indicate that at most one of =@work=, =@home=, and =@tennisclub=
4745 should be selected. Multiple such groups are allowed.
4747 #+texinfo: @noindent
4748 Do not forget to press {{{kbd(C-c C-c)}}} with the cursor in one of
4749 these lines to activate any changes.
4751 #+texinfo: @noindent
4752 To set these mutually exclusive groups in the variable
4753 ~org-tags-alist~, you must use the dummy tags ~:startgroup~ and
4754 ~:endgroup~ instead of the braces. Similarly, you can use ~:newline~
4755 to indicate a line break. The previous example would be set globally
4756 by the following configuration:
4758 #+begin_src emacs-lisp
4759 (setq org-tag-alist '((:startgroup . nil)
4760 ("@work" . ?w) ("@home" . ?h)
4761 ("@tennisclub" . ?t)
4763 ("laptop" . ?l) ("pc" . ?p)))
4766 If at least one tag has a selection key then pressing {{{kbd(C-c
4767 C-c)}}} automatically presents you with a special interface, listing
4768 inherited tags, the tags of the current headline, and a list of all
4769 valid tags with corresponding keys[fn:54].
4771 Pressing keys assigned to tags adds or removes them from the list of
4772 tags in the current line. Selecting a tag in a group of mutually
4773 exclusive tags turns off any other tag from that group.
4775 In this interface, you can also use the following special keys:
4780 Enter a tag in the minibuffer, even if the tag is not in the
4781 predefined list. You can complete on all tags present in the
4782 buffer. You can also add several tags: just separate them with
4788 Clear all tags for this line.
4793 Accept the modified set.
4798 Abort without installing changes.
4803 If {{{kbd(q)}}} is not assigned to a tag, it aborts like
4809 Turn off groups of mutually exclusive tags. Use this to (as an
4810 exception) assign several tags from such a group.
4815 Toggle auto-exit after the next change (see below). If you are
4816 using expert mode, the first {{{kbd(C-c)}}} displays the
4819 #+texinfo: @noindent
4820 This method lets you assign tags to a headline with very few keys.
4821 With the above setup, you could clear the current tags and set
4822 =@home=, =laptop= and =pc= tags with just the following keys:
4823 {{{kbd(C-c C-c SPC h l p RET)}}}. Switching from =@home= to =@work=
4824 would be done with {{{kbd(C-c C-c w RET)}}} or alternatively with
4825 {{{kbd(C-c C-c C-c w)}}}. Adding the non-predefined tag =Sarah= could
4826 be done with {{{kbd(C-c C-c TAB S a r a h RET)}}}.
4828 #+vindex: org-fast-tag-selection-single-key
4829 If you find that most of the time you need only a single key press to
4830 modify your list of tags, set the variable
4831 ~org-fast-tag-selection-single-key~. Then you no longer have to press
4832 {{{kbd(RET)}}} to exit fast tag selection---it exits after the first
4833 change. If you then occasionally need more keys, press {{{kbd(C-c)}}}
4834 to turn off auto-exit for the current tag selection process (in
4835 effect: start selection with {{{kbd(C-c C-c C-c)}}} instead of
4836 {{{kbd(C-c C-c)}}}). If you set the variable to the value ~expert~,
4837 the special window is not even shown for single-key tag selection, it
4838 comes up only when you press an extra {{{kbd(C-c)}}}.
4842 :DESCRIPTION: Create a hierarchy of tags.
4844 #+cindex: group tags
4845 #+cindex: tags, groups
4846 #+cindex: tags hierarchy
4848 Tags can be defined in hierarchies. A tag can be defined as a /group
4849 tag/ for a set of other tags. The group tag can be seen as the
4850 "broader term" for its set of tags. Defining multiple group tags and
4851 nesting them creates a tag hierarchy.
4853 One use-case is to create a taxonomy of terms (tags) that can be used
4854 to classify nodes in a document or set of documents.
4856 When you search for a group tag, it return matches for all members in
4857 the group and its subgroups. In an agenda view, filtering by a group
4858 tag displays or hide headlines tagged with at least one of the members
4859 of the group or any of its subgroups. This makes tag searches and
4860 filters even more flexible.
4862 You can set group tags by using brackets and inserting a colon between
4863 the group tag and its related tags---beware that all whitespaces are
4864 mandatory so that Org can parse this line correctly:
4866 : #+TAGS: [ GTD : Control Persp ]
4868 In this example, =GTD= is the group tag and it is related to two other
4869 tags: =Control=, =Persp=. Defining =Control= and =Persp= as group
4870 tags creates an hierarchy of tags:
4873 ,#+TAGS: [ Control : Context Task ]
4874 ,#+TAGS: [ Persp : Vision Goal AOF Project ]
4877 That can conceptually be seen as a hierarchy of tags:
4889 You can use the ~:startgrouptag~, ~:grouptags~ and ~:endgrouptag~
4890 keyword directly when setting ~org-tag-alist~ directly:
4892 #+begin_src emacs-lisp
4893 (setq org-tag-alist '((:startgrouptag)
4907 The tags in a group can be mutually exclusive if using the same group
4908 syntax as is used for grouping mutually exclusive tags together; using
4911 : #+TAGS: { Context : @Home @Work @Call }
4913 When setting ~org-tag-alist~ you can use ~:startgroup~ and ~:endgroup~
4914 instead of ~:startgrouptag~ and ~:endgrouptag~ to make the tags
4917 Furthermore, the members of a group tag can also be regular
4918 expressions, creating the possibility of a more dynamic and rule-based
4919 tag structure. The regular expressions in the group must be specified
4920 within curly brackets. Here is an expanded example:
4923 ,#+TAGS: [ Vision : {V@.+} ]
4924 ,#+TAGS: [ Goal : {G@.+} ]
4925 ,#+TAGS: [ AOF : {AOF@.+} ]
4926 ,#+TAGS: [ Project : {P@.+} ]
4929 Searching for the tag =Project= now lists all tags also including
4930 regular expression matches for =P@.+=, and similarly for tag searches
4931 on =Vision=, =Goal= and =AOF=. For example, this would work well for
4932 a project tagged with a common project-identifier,
4933 e.g. =P@2014_OrgTags=.
4936 #+findex: org-toggle-tags-groups
4937 #+vindex: org-group-tags
4938 If you want to ignore group tags temporarily, toggle group tags
4939 support with ~org-toggle-tags-groups~, bound to {{{kbd(C-c C-x q)}}}.
4940 If you want to disable tag groups completely, set ~org-group-tags~ to
4945 :DESCRIPTION: Searching for combinations of tags.
4947 #+cindex: tag searches
4948 #+cindex: searching for tags
4950 Once a system of tags has been set up, it can be used to collect
4951 related information into special lists.
4953 - {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} (~org-match-sparse-tree~) ::
4957 #+findex: org-match-sparse-tree
4958 Create a sparse tree with all headlines matching a tags search.
4959 With a {{{kbd(C-u)}}} prefix argument, ignore headlines that are
4962 - {{{kbd(C-c a m)}}} (~org-tags-view~) ::
4965 #+findex: org-tags-view
4966 Create a global list of tag matches from all agenda files. See
4967 [[*Matching tags and properties]].
4969 - {{{kbd(C-c a M)}}} (~org-tags-view~) ::
4972 #+vindex: org-tags-match-list-sublevels
4973 Create a global list of tag matches from all agenda files, but
4974 check only TODO items and force checking subitems (see the option
4975 ~org-tags-match-list-sublevels~).
4977 These commands all prompt for a match string which allows basic
4978 Boolean logic like =+boss+urgent-project1=, to find entries with tags
4979 =boss= and =urgent=, but not =project1=, or =Kathy|Sally= to find
4980 entries which are tagged, like =Kathy= or =Sally=. The full syntax of
4981 the search string is rich and allows also matching against TODO
4982 keywords, entry levels and properties. For a complete description
4983 with many examples, see [[*Matching tags and properties]].
4985 * Properties and Columns
4987 :DESCRIPTION: Storing information about an entry.
4989 #+cindex: properties
4991 A property is a key-value pair associated with an entry. Properties
4992 can be set so they are associated with a single entry, with every
4993 entry in a tree, or with every entry in an Org file.
4995 There are two main applications for properties in Org mode. First,
4996 properties are like tags, but with a value. Imagine maintaining
4997 a file where you document bugs and plan releases for a piece of
4998 software. Instead of using tags like =release_1=, =release_2=, you
4999 can use a property, say =Release=, that in different subtrees has
5000 different values, such as =1.0= or =2.0=. Second, you can use
5001 properties to implement (very basic) database capabilities in an Org
5002 buffer. Imagine keeping track of your music CDs, where properties
5003 could be things such as the album, artist, date of release, number of
5006 Properties can be conveniently edited and viewed in column view (see
5011 :DESCRIPTION: How properties are spelled out.
5013 #+cindex: property syntax
5014 #+cindex: drawer, for properties
5016 Properties are key--value pairs. When they are associated with
5017 a single entry or with a tree they need to be inserted into a special
5018 drawer (see [[*Drawers]]) with the name =PROPERTIES=, which has to be
5019 located right below a headline, and its planning line (see [[*Deadlines
5020 and Scheduling]]) when applicable. Each property is specified on
5021 a single line, with the key---surrounded by colons---first, and the
5022 value after it. Keys are case-insensitive. Here is an example:
5027 ,*** Goldberg Variations
5029 :Title: Goldberg Variations
5030 :Composer: J.S. Bach
5032 :Publisher: Deutsche Grammophon
5037 Depending on the value of ~org-use-property-inheritance~, a property
5038 set this way is associated either with a single entry, or with the
5039 sub-tree defined by the entry, see [[*Property Inheritance]].
5041 You may define the allowed values for a particular property =Xyz= by
5042 setting a property =Xyz_ALL=. This special property is /inherited/,
5043 so if you set it in a level 1 entry, it applies to the entire tree.
5044 When allowed values are defined, setting the corresponding property
5045 becomes easier and is less prone to typing errors. For the example
5046 with the CD collection, we can pre-define publishers and the number of
5047 disks in a box like this:
5052 :NDisks_ALL: 1 2 3 4
5053 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5057 If you want to set properties that can be inherited by any entry in
5058 a file, use a line like:
5060 #+cindex: @samp{_ALL} suffix, in properties
5061 #+cindex: @samp{PROPERTY}, keyword
5062 : #+PROPERTY: NDisks_ALL 1 2 3 4
5064 #+cindex: @samp{+} suffix, in properties
5065 If you want to add to the value of an existing property, append a =+=
5066 to the property name. The following results in the property =var=
5067 having the value =foo=1 bar=2=.
5070 ,#+PROPERTY: var foo=1
5071 ,#+PROPERTY: var+ bar=2
5074 It is also possible to add to the values of inherited properties. The
5075 following results in the =Genres= property having the value =Classic
5076 Baroque= under the =Goldberg Variations= subtree.
5084 ,*** Goldberg Variations
5086 :Title: Goldberg Variations
5087 :Composer: J.S. Bach
5089 :Publisher: Deutsche Grammophon
5095 Note that a property can only have one entry per drawer.
5097 #+vindex: org-global-properties
5098 Property values set with the global variable ~org-global-properties~
5099 can be inherited by all entries in all Org files.
5101 #+texinfo: @noindent
5102 The following commands help to work with properties:
5104 #+attr_texinfo: :sep ,
5105 - {{{kbd(M-TAB)}}} (~pcomplete~) ::
5109 After an initial colon in a line, complete property keys. All
5110 keys used in the current file are offered as possible
5113 - {{{kbd(C-c C-x p)}}} (~org-set-property~) ::
5116 #+findex: org-set-property
5117 Set a property. This prompts for a property name and a value.
5118 If necessary, the property drawer is created as well.
5120 - {{{kbd(C-u M-x org-insert-drawer)}}} ::
5122 #+findex: org-insert-drawer
5123 Insert a property drawer into the current entry. The drawer is
5124 inserted early in the entry, but after the lines with planning
5125 information like deadlines.
5127 - {{{kbd(C-c C-c)}}} (~org-property-action~) ::
5130 #+findex: org-property-action
5131 With the cursor in a property drawer, this executes property
5134 - {{{kbd(C-c C-c s)}}} (~org-set-property~) ::
5137 #+findex: org-set-property
5138 Set a property in the current entry. Both the property and the value
5139 can be inserted using completion.
5141 - {{{kbd(S-RIGHT)}}} (~org-property-next-allowed-values~), {{{kbd(S-LEFT)}}} (~org-property-previous-allowed-value~) ::
5145 Switch property at point to the next/previous allowed value.
5147 - {{{kbd(C-c C-c d)}}} (~org-delete-property~) ::
5150 #+findex: org-delete-property
5151 Remove a property from the current entry.
5153 - {{{kbd(C-c C-c D)}}} (~org-delete-property-globally~) ::
5156 #+findex: org-delete-property-globally
5157 Globally remove a property, from all entries in the current file.
5159 - {{{kbd(C-c C-c c)}}} (~org-compute-property-at-point~) ::
5162 #+findex: org-compute-property-at-point
5163 Compute the property at point, using the operator and scope from
5164 the nearest column format definition.
5166 ** Special Properties
5168 :DESCRIPTION: Access to other Org mode features.
5170 #+cindex: properties, special
5172 Special properties provide an alternative access method to Org mode
5173 features, like the TODO state or the priority of an entry, discussed
5174 in the previous chapters. This interface exists so that you can
5175 include these states in a column view (see [[*Column View]]), or to use
5176 them in queries. The following property names are special and should
5177 not be used as keys in the properties drawer:
5179 #+cindex: @samp{ALLTAGS}, special property
5180 #+cindex: @samp{BLOCKED}, special property
5181 #+cindex: @samp{CLOCKSUM}, special property
5182 #+cindex: @samp{CLOCKSUM_T}, special property
5183 #+cindex: @samp{CLOSED}, special property
5184 #+cindex: @samp{DEADLINE}, special property
5185 #+cindex: @samp{FILE}, special property
5186 #+cindex: @samp{ITEM}, special property
5187 #+cindex: @samp{PRIORITY}, special property
5188 #+cindex: @samp{SCHEDULED}, special property
5189 #+cindex: @samp{TAGS}, special property
5190 #+cindex: @samp{TIMESTAMP}, special property
5191 #+cindex: @samp{TIMESTAMP_IA}, special property
5192 #+cindex: @samp{TODO}, special property
5193 | =ALLTAGS= | All tags, including inherited ones. |
5194 | =BLOCKED= | ~t~ if task is currently blocked by children or siblings. |
5195 | =CATEGORY= | The category of an entry. |
5196 | =CLOCKSUM= | The sum of CLOCK intervals in the subtree. ~org-clock-sum~ |
5197 | | must be run first to compute the values in the current buffer. |
5198 | =CLOCKSUM_T= | The sum of CLOCK intervals in the subtree for today. |
5199 | | ~org-clock-sum-today~ must be run first to compute the |
5200 | | values in the current buffer. |
5201 | =CLOSED= | When was this entry closed? |
5202 | =DEADLINE= | The deadline time string, without the angular brackets. |
5203 | =FILE= | The filename the entry is located in. |
5204 | =ITEM= | The headline of the entry. |
5205 | =PRIORITY= | The priority of the entry, a string with a single letter. |
5206 | =SCHEDULED= | The scheduling timestamp, without the angular brackets. |
5207 | =TAGS= | The tags defined directly in the headline. |
5208 | =TIMESTAMP= | The first keyword-less timestamp in the entry. |
5209 | =TIMESTAMP_IA= | The first inactive timestamp in the entry. |
5210 | =TODO= | The TODO keyword of the entry. |
5212 ** Property Searches
5214 :DESCRIPTION: Matching property values.
5216 #+cindex: properties, searching
5217 #+cindex: searching, of properties
5219 To create sparse trees and special lists with selection based on
5220 properties, the same commands are used as for tag searches (see [[*Tag
5223 - {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} (~org-match-sparse-tree~) ::
5227 #+findex: org-match-sparse-tree
5228 Create a sparse tree with all matching entries. With
5229 a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not
5232 - {{{kbd(C-c a m)}}}, ~org-tags-view~ ::
5235 Create a global list of tag/property matches from all agenda
5238 - {{{kbd(C-c a M)}}} (~org-tags-view~) ::
5241 #+findex: org-tags-view
5242 #+vindex: org-tags-match-list-sublevels
5243 Create a global list of tag matches from all agenda files, but
5244 check only TODO items and force checking of subitems (see the
5245 option ~org-tags-match-list-sublevels~).
5247 The syntax for the search string is described in [[*Matching tags and
5250 There is also a special command for creating sparse trees based on a
5253 - {{{kbd(C-c / p)}}} ::
5256 Create a sparse tree based on the value of a property. This
5257 first prompts for the name of a property, and then for a value.
5258 A sparse tree is created with all entries that define this
5259 property with the given value. If you enclose the value in curly
5260 braces, it is interpreted as a regular expression and matched
5261 against the property values.
5263 ** Property Inheritance
5265 :DESCRIPTION: Passing values down a tree.
5267 #+cindex: properties, inheritance
5268 #+cindex: inheritance, of properties
5270 #+vindex: org-use-property-inheritance
5271 The outline structure of Org documents lends itself to an inheritance
5272 model of properties: if the parent in a tree has a certain property,
5273 the children can inherit this property. Org mode does not turn this
5274 on by default, because it can slow down property searches
5275 significantly and is often not needed. However, if you find
5276 inheritance useful, you can turn it on by setting the variable
5277 ~org-use-property-inheritance~. It may be set to ~t~ to make all
5278 properties inherited from the parent, to a list of properties that
5279 should be inherited, or to a regular expression that matches inherited
5280 properties. If a property has the value ~nil~, this is interpreted as
5281 an explicit un-define of the property, so that inheritance search
5282 stops at this value and returns ~nil~.
5284 Org mode has a few properties for which inheritance is hard-coded, at
5285 least for the special applications for which they are used:
5289 #+cindex: @samp{COLUMNS}, property
5290 The =COLUMNS= property defines the format of column view (see
5291 [[*Column View]]). It is inherited in the sense that the level where
5292 a =COLUMNS= property is defined is used as the starting point for
5293 a column view table, independently of the location in the subtree
5294 from where columns view is turned on.
5298 #+cindex: @samp{CATEGORY}, property
5299 For agenda view, a category set through a =CATEGORY= property
5300 applies to the entire subtree.
5304 #+cindex: @samp{ARCHIVE}, property
5305 For archiving, the =ARCHIVE= property may define the archive
5306 location for the entire subtree (see [[*Moving a tree to an archive
5311 #+cindex: @samp{LOGGING}, property
5312 The =LOGGING= property may define logging settings for an entry
5313 or a subtree (see [[*Tracking TODO state changes]]).
5317 :DESCRIPTION: Tabular viewing and editing.
5320 A great way to view and edit properties in an outline tree is /column
5321 view/. In column view, each outline node is turned into a table row.
5322 Columns in this table provide access to properties of the entries.
5323 Org mode implements columns by overlaying a tabular structure over the
5324 headline of each item. While the headlines have been turned into
5325 a table row, you can still change the visibility of the outline tree.
5326 For example, you get a compact table by switching to "contents"
5327 view---{{{kbd(S-TAB)}}} {{{kbd(S-TAB)}}}, or simply {{{kbd(c)}}}
5328 while column view is active---but you can still open, read, and edit
5329 the entry below each headline. Or, you can switch to column view
5330 after executing a sparse tree command and in this way get a table only
5331 for the selected items. Column view also works in agenda buffers (see
5332 [[*Agenda Views]]) where queries have collected selected items, possibly
5333 from a number of files.
5335 *** Defining columns
5337 :DESCRIPTION: The COLUMNS format property.
5339 #+cindex: column view, for properties
5340 #+cindex: properties, column view
5342 Setting up a column view first requires defining the columns. This is
5343 done by defining a column format line.
5345 **** Scope of column definitions
5347 :DESCRIPTION: Where defined, where valid?
5350 To define a column format for an entire file, use a line like:
5352 #+cindex: @samp{COLUMNS}, keyword
5353 : #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5355 To specify a format that only applies to a specific tree, add
5356 a =COLUMNS= property to the top node of that tree, for example:
5359 ,** Top node for columns view
5361 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5365 If a =COLUMNS= property is present in an entry, it defines columns for
5366 the entry itself, and for the entire subtree below it. Since the
5367 column definition is part of the hierarchical structure of the
5368 document, you can define columns on level 1 that are general enough
5369 for all sublevels, and more specific columns further down, when you
5370 edit a deeper part of the tree.
5372 **** Column attributes
5374 :DESCRIPTION: Appearance and content of a column.
5377 A column definition sets the attributes of a column. The general
5378 definition looks like this:
5380 : %[WIDTH]PROPERTY[(TITLE)][{SUMMARY-TYPE}]
5382 #+texinfo: @noindent
5383 Except for the percent sign and the property name, all items are
5384 optional. The individual parts have the following meaning:
5386 - {{{var(WIDTH)}}} ::
5388 An integer specifying the width of the column in characters. If
5389 omitted, the width is determined automatically.
5391 - {{{var(PROPERTY)}}} ::
5393 The property that should be edited in this column. Special
5394 properties representing meta data are allowed here as well (see
5395 [[*Special Properties]]).
5397 - {{{var(TITLE)}}} ::
5399 The header text for the column. If omitted, the property name is
5402 - {{{var(SUMMARY-TYPE)}}} ::
5404 The summary type. If specified, the column values for parent
5405 nodes are computed from the children[fn:55].
5407 Supported summary types are:
5409 | =+= | Sum numbers in this column. |
5410 | =+;%.1f= | Like =+=, but format result with =%.1f=. |
5411 | =$= | Currency, short for =+;%.2f=. |
5412 | =min= | Smallest number in column. |
5413 | =max= | Largest number. |
5414 | =mean= | Arithmetic mean of numbers. |
5415 | =X= | Checkbox status, =[X]= if all children are =[X]=. |
5416 | =X/= | Checkbox status, =[n/m]=. |
5417 | =X%= | Checkbox status, =[n%]=. |
5418 | =:= | Sum times, HH:MM, plain numbers are hours. |
5419 | =:min= | Smallest time value in column. |
5420 | =:max= | Largest time value. |
5421 | =:mean= | Arithmetic mean of time values. |
5422 | =@min= | Minimum age[fn:56] (in days/hours/mins/seconds). |
5423 | =@max= | Maximum age (in days/hours/mins/seconds). |
5424 | =@mean= | Arithmetic mean of ages (in days/hours/mins/seconds). |
5425 | =est+= | Add low-high estimates. |
5427 #+texinfo: @noindent
5428 #+vindex: org-columns-summary-types
5429 You can also define custom summary types by setting
5430 ~org-columns-summary-types~.
5432 The =est+= summary type requires further explanation. It is used for
5433 combining estimates, expressed as low-high ranges. For example,
5434 instead of estimating a particular task will take 5 days, you might
5435 estimate it as 5-6 days if you're fairly confident you know how much
5436 work is required, or 1-10 days if you do not really know what needs to
5437 be done. Both ranges average at 5.5 days, but the first represents
5438 a more predictable delivery.
5440 When combining a set of such estimates, simply adding the lows and
5441 highs produces an unrealistically wide result. Instead, =est+= adds
5442 the statistical mean and variance of the sub-tasks, generating a final
5443 estimate from the sum. For example, suppose you had ten tasks, each
5444 of which was estimated at 0.5 to 2 days of work. Straight addition
5445 produces an estimate of 5 to 20 days, representing what to expect if
5446 everything goes either extremely well or extremely poorly. In
5447 contrast, =est+= estimates the full job more realistically, at 10-15
5450 Here is an example for a complete columns definition, along with
5451 allowed values[fn:57].
5454 :COLUMNS: %25ITEM %9Approved(Approved?){X} %Owner %11Status \
5455 %10Time_Estimate{:} %CLOCKSUM %CLOCKSUM_T
5456 :Owner_ALL: Tammy Mark Karl Lisa Don
5457 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5458 :Approved_ALL: "[ ]" "[X]"
5461 #+texinfo: @noindent
5462 The first column, =%25ITEM=, means the first 25 characters of the item
5463 itself, i.e., of the headline. You probably always should start the
5464 column definition with the =ITEM= specifier. The other specifiers
5465 create columns =Owner= with a list of names as allowed values, for
5466 =Status= with four different possible values, and for a checkbox field
5467 =Approved=. When no width is given after the =%= character, the
5468 column is exactly as wide as it needs to be in order to fully display
5469 all values. The =Approved= column does have a modified title
5470 (=Approved?=, with a question mark). Summaries are created for the
5471 =Time_Estimate= column by adding time duration expressions like HH:MM,
5472 and for the =Approved= column, by providing an =[X]= status if all
5473 children have been checked. The =CLOCKSUM= and =CLOCKSUM_T= columns
5474 are special, they lists the sums of CLOCK intervals in the subtree,
5475 either for all clocks or just for today.
5477 *** Using column view
5479 :DESCRIPTION: How to create and use column view.
5482 **** Turning column view on or off
5487 - {{{kbd(C-c C-x C-c)}}} (~org-columns~) ::
5489 #+kindex: C-c C-x C-c
5490 #+vindex: org-columns
5491 #+vindex: org-columns-default-format
5492 Turn on column view. If the cursor is before the first headline
5493 in the file, column view is turned on for the entire file, using
5494 the =#+COLUMNS= definition. If the cursor is somewhere inside
5495 the outline, this command searches the hierarchy, up from point,
5496 for a =COLUMNS= property that defines a format. When one is
5497 found, the column view table is established for the tree starting
5498 at the entry that contains the =COLUMNS= property. If no such
5499 property is found, the format is taken from the =#+COLUMNS= line
5500 or from the variable ~org-columns-default-format~, and column
5501 view is established for the current entry and its subtree.
5503 - {{{kbd(r)}}} or {{{kbd(g)}}} (~org-columns-redo~) ::
5507 #+findex: org-columns-redo
5508 Recreate the column view, to include recent changes made in the
5511 - {{{kbd(q)}}} (~org-columns-quit~) ::
5514 #+findex: org-columns-quit
5522 #+attr_texinfo: :sep and
5523 - {{{kbd(LEFT)}}}, {{{kbd(RIGHT)}}}, {{{kbd(UP)}}}, {{{kbd(DOWN)}}} ::
5525 Move through the column view from field to field.
5527 - {{{kbd(1..9\,0)}}} ::
5530 Directly select the Nth allowed value, {{{kbd(0)}}} selects the
5533 - {{{kbd(n)}}} or {{{kbd(S-RIGHT)}}} (~org-columns-next-allowed-value~) and {{{kbd(p)}}} or {{{kbd(S-LEFT)}}} (~org-columns-previous-allowed-value~) ::
5539 #+findex: org-columns-next-allowed-value
5540 #+findex: org-columns-previous-allowed-value
5541 Switch to the next/previous allowed value of the field. For
5542 this, you have to have specified allowed values for a property.
5544 - {{{kbd(e)}}} (~org-columns-edit-value~) ::
5547 #+findex: org-columns-edit-value
5548 Edit the property at point. For the special properties, this
5549 invokes the same interface that you normally use to change that
5550 property. For example, the tag completion or fast selection
5551 interface pops up when editing a =TAGS= property.
5553 - {{{kbd(C-c C-c)}}} (~org-columns-set-tags-or-toggle~) ::
5556 #+findex: org-columns-set-tags-or-toggle
5557 When there is a checkbox at point, toggle it.
5559 - {{{kbd(v)}}} (~org-columns-show-value~) ::
5562 #+findex: org-columns-show-value
5563 View the full value of this property. This is useful if the
5564 width of the column is smaller than that of the value.
5566 - {{{kbd(a)}}} (~org-columns-edit-allowed~) ::
5569 #+findex: org-columns-edit-allowed
5570 Edit the list of allowed values for this property. If the list
5571 is found in the hierarchy, the modified values is stored there.
5572 If no list is found, the new value is stored in the first entry
5573 that is part of the current column view.
5575 **** Modifying column view on-the-fly:
5580 #+attr_texinfo: :sep and
5581 - {{{kbd(<)}}} (~org-columns-narrow~) and {{{kbd(>)}}} (~org-columns-widen~) ::
5585 #+findex: org-columns-narrow
5586 #+findex: org-columns-widen
5587 Make the column narrower/wider by one character.
5589 - {{{kbd(S-M-RIGHT)}}} (~org-columns-new~) ::
5592 #+findex: org-columns-new
5593 Insert a new column, to the left of the current column.
5595 - {{{kbd(S-M-LEFT)}}} (~org-columns-delete~) ::
5598 #+findex: org-columns-delete
5599 Delete the current column.
5601 *** Capturing column view
5603 :DESCRIPTION: A dynamic block for column view.
5606 Since column view is just an overlay over a buffer, it cannot be
5607 exported or printed directly. If you want to capture a column view,
5608 use a =columnview= dynamic block (see [[*Dynamic Blocks]]). The frame of
5609 this block looks like this:
5611 #+cindex: @samp{BEGIN columnview}
5614 ,#+BEGIN: columnview :hlines 1 :id "label"
5619 #+texinfo: @noindent
5620 This dynamic block has the following parameters:
5624 This is the most important parameter. Column view is a feature
5625 that is often localized to a certain (sub)tree, and the capture
5626 block might be at a different location in the file. To identify
5627 the tree whose view to capture, you can use four values:
5631 Use the tree in which the capture block is located.
5635 Make a global view, including all headings in the file.
5637 - =file:FILENAME= ::
5639 Run column view at the top of the {{{var(FILENAME)}}} file
5643 #+cindex: @samp{ID}, property
5644 Call column view in the tree that has an =ID= property with
5645 the value {{{var(LABEL)}}}. You can use {{{kbd(M-x
5646 org-id-copy)}}} to create a globally unique ID for the
5647 current entry and copy it to the kill-ring.
5651 When ~t~, insert an hline after every line. When a number N,
5652 insert an hline before each headline with level ~<= N~.
5656 When non-~nil~, force column groups to get vertical lines.
5660 When set to a number, do not capture entries below this level.
5662 - =:skip-empty-rows= ::
5664 When non-~nil~, skip rows where the only non-empty specifier of
5665 the column view is =ITEM=.
5669 When non-~nil~, indent each =ITEM= field according to its level.
5671 #+texinfo: @noindent
5672 The following commands insert or update the dynamic block:
5674 - {{{kbd(C-c C-x i)}}} (~org-insert-columns-dblock~) ::
5677 #+findex: org-insert-columns-dblock
5678 Insert a dynamic block capturing a column view. Prompt for the
5679 scope or ID of the view.
5681 - {{{kbd(C-c C-c)}}} {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) ::
5684 #+kindex: C-c C-x C-u
5685 #+findex: org-dblock-update
5686 Update dynamic block at point. The cursor needs to be in the
5687 =#+BEGIN= line of the dynamic block.
5689 - {{{kbd(C-u C-c C-x C-u)}}} (~org-update-all-dblocks~) ::
5691 #+kindex: C-u C-c C-x C-u
5692 Update all dynamic blocks (see [[*Dynamic Blocks]]). This is useful
5693 if you have several clock table blocks, column-capturing blocks
5694 or other dynamic blocks in a buffer.
5696 You can add formulas to the column view table and you may add plotting
5697 instructions in front of the table---these survive an update of the
5698 block. If there is a =TBLFM= keyword after the table, the table is
5699 recalculated automatically after an update.
5701 An alternative way to capture and process property values into a table
5702 is provided by Eric Schulte's =org-collector.el= which is
5703 a contributed package[fn:58]. It provides a general API to collect
5704 properties from entries in a certain scope, and arbitrary Lisp
5705 expressions to process these values before inserting them into a table
5710 :DESCRIPTION: Making items useful for planning.
5715 #+cindex: date stamp
5717 To assist project planning, TODO items can be labeled with a date
5718 and/or a time. The specially formatted string carrying the date and
5719 time information is called a /timestamp/ in Org mode. This may be
5720 a little confusing because timestamp is often used as indicating when
5721 something was created or last changed. However, in Org mode this term
5722 is used in a much wider sense.
5724 ** Timestamps, Deadlines and Scheduling
5726 :DESCRIPTION: Assigning a time to a tree entry.
5727 :ALT_TITLE: Timestamps
5729 #+cindex: timestamps
5730 #+cindex: ranges, time
5731 #+cindex: date stamps
5733 #+cindex: scheduling
5735 A timestamp is a specification of a date (possibly with a time or
5736 a range of times) in a special format, either =<2003-09-16 Tue>= or
5737 =<2003-09-16 Tue 09:39>= or =<2003-09-16 Tue 12:00-12:30>=[fn:59].
5738 A timestamp can appear anywhere in the headline or body of an Org tree
5739 entry. Its presence causes entries to be shown on specific dates in
5740 the agenda (see [[*Weekly/daily agenda]]). We distinguish:
5742 - Plain timestamp; Event; Appointment ::
5745 #+cindex: appointment
5746 A simple timestamp just assigns a date/time to an item. This is
5747 just like writing down an appointment or event in a paper agenda.
5748 In the timeline and agenda displays, the headline of an entry
5749 associated with a plain timestamp is shown exactly on that date.
5752 ,* Meet Peter at the movies
5753 <2006-11-01 Wed 19:15>
5754 ,* Discussion on climate change
5755 <2006-11-02 Thu 20:00-22:00>
5758 - Timestamp with repeater interval ::
5760 #+cindex: timestamp, with repeater interval
5761 A timestamp may contain a /repeater interval/, indicating that it
5762 applies not only on the given date, but again and again after
5763 a certain interval of N days (d), weeks (w), months (m), or years
5764 (y). The following shows up in the agenda every Wednesday:
5767 ,* Pick up Sam at school
5768 <2007-05-16 Wed 12:30 +1w>
5771 - Diary-style sexp entries ::
5773 #+cindex: diary style timestamps
5774 #+cindex: sexp timestamps
5775 For more complex date specifications, Org mode supports using the
5776 special sexp diary entries implemented in the Emacs
5777 calendar/diary package[fn:60]. For example, with optional time:
5780 ,* 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5781 <%%(org-float t 4 2)>
5784 - Time/Date range ::
5787 #+cindex: date range
5788 Two timestamps connected by =--= denote a range. The headline is
5789 shown on the first and last day of the range, and on any dates
5790 that are displayed and fall in the range. Here is an example:
5793 ,** Meeting in Amsterdam
5794 <2004-08-23 Mon>--<2004-08-26 Thu>
5797 - Inactive timestamp ::
5799 #+cindex: timestamp, inactive
5800 #+cindex: inactive timestamp
5801 Just like a plain timestamp, but with square brackets instead of
5802 angular ones. These timestamps are inactive in the sense that
5803 they do /not/ trigger an entry to show up in the agenda.
5806 ,* Gillian comes late for the fifth time
5810 ** Creating Timestamps
5812 :DESCRIPTION: Commands to insert timestamps.
5815 For Org mode to recognize timestamps, they need to be in the specific
5816 format. All commands listed below produce timestamps in the correct
5819 #+attr_texinfo: :sep ,
5820 - {{{kbd(C-c .)}}} (~org-time-stamp~) ::
5823 #+findex: org-time-stamp
5824 Prompt for a date and insert a corresponding timestamp. When the
5825 cursor is at an existing timestamp in the buffer, the command is
5826 used to modify this timestamp instead of inserting a new one.
5827 When this command is used twice in succession, a time range is
5830 - {{{kbd(C-c !)}}} (~org-time-stamp-inactive~) ::
5833 #+findex: org-time-stamp-inactive
5834 Like {{{kbd(C-c .)}}}, but insert an inactive timestamp that does
5835 not cause an agenda entry.
5837 - {{{kbd(C-u C-c .)}}}, {{{kbd(C-u C-c !)}}} ::
5842 #+vindex: org-time-stamp-rounding-minutes
5843 Like {{{kbd(C-c .)}}} and {{{kbd(C-c !)}}}, but use the
5844 alternative format which contains date and time. The default
5845 time can be rounded to multiples of 5 minutes, see the option
5846 ~org-time-stamp-rounding-minutes~.
5848 - {{{kbd(C-c C-c)}}} ::
5851 Normalize timestamp, insert/fix day name if missing or wrong.
5853 - {{{kbd(C-c <)}}} (~org-date-from-calendar~) ::
5856 #+findex: org-date-from-calendar
5857 Insert a timestamp corresponding to the cursor date in the Calendar.
5859 - {{{kbd(C-c >)}}} (~org-goto-calendar~) ::
5862 #+findex: org-goto-calendar
5863 Access the Emacs calendar for the current date. If there is a
5864 timestamp in the current line, go to the corresponding date instead.
5866 - {{{kbd(C-c C-o)}}} (~org-open-at-point~) ::
5869 #+findex: org-open-at-point
5870 Access the agenda for the date given by the timestamp or -range
5871 at point (see [[*Weekly/daily agenda]]).
5873 - {{{kbd(S-LEFT)}}} (~org-timestamp-down-day~), {{{kbd(S-RIGHT)}}} (~org-timestamp-up-day~) ::
5877 #+findex: org-timestamp-down-day
5878 #+findex: org-timestamp-up-day
5879 Change date at cursor by one day. These key bindings conflict
5880 with shift-selection and related modes (see [[*Packages that
5881 conflict with Org mode]]).
5883 - {{{kbd(S-UP)}}} (~org-timestamp-up~), {{{kbd(S-DOWN)}}} (~org-timestamp-down~) ::
5887 Change the item under the cursor in a timestamp. The cursor can
5888 be on a year, month, day, hour or minute. When the timestamp
5889 contains a time range like =15:30-16:30=, modifying the first
5890 time also shifts the second, shifting the time block with
5891 constant length. To change the length, modify the second time.
5892 Note that if the cursor is in a headline and not at a timestamp,
5893 these same keys modify the priority of an item. (see
5894 [[*Priorities]]). The key bindings also conflict with
5895 shift-selection and related modes (see [[*Packages that conflict
5898 - {{{kbd(C-c C-y)}}} (~org-evaluate-time-range~) ::
5901 #+findex: org-evaluate-time-range
5902 #+cindex: evaluate time range
5903 Evaluate a time range by computing the difference between start
5904 and end. With a prefix argument, insert result after the time
5905 range (in a table: into the following column).
5907 *** The date/time prompt
5909 :DESCRIPTION: How Org mode helps you enter dates and times.
5911 #+cindex: date, reading in minibuffer
5912 #+cindex: time, reading in minibuffer
5914 #+vindex: org-read-date-prefer-future
5915 When Org mode prompts for a date/time, the default is shown in default
5916 date/time format, and the prompt therefore seems to ask for a specific
5917 format. But it in fact accepts date/time information in a variety of
5918 formats. Generally, the information should start at the beginning of
5919 the string. Org mode finds whatever information is in there and
5920 derives anything you have not specified from the /default date and
5921 time/. The default is usually the current date and time, but when
5922 modifying an existing timestamp, or when entering the second stamp of
5923 a range, it is taken from the stamp in the buffer. When filling in
5924 information, Org mode assumes that most of the time you want to enter
5925 a date in the future: if you omit the month/year and the given
5926 day/month is /before/ today, it assumes that you mean a future
5927 date[fn:61]. If the date has been automatically shifted into the
5928 future, the time prompt shows this with =(=>F)=.
5930 For example, let's assume that today is *June 13, 2006*. Here is how
5931 various inputs are interpreted, the items filled in by Org mode are in
5934 | =3-2-5= | \rArr{} 2003-02-05 |
5935 | =2/5/3= | \rArr{} 2003-02-05 |
5936 | =14= | \rArr{} *2006*-*06*-14 |
5937 | =12= | \rArr{} *2006*-*07*-12 |
5938 | =2/5= | \rArr{} *2007*-02-05 |
5939 | =Fri= | \rArr{} nearest Friday (default date or later) |
5940 | =sep 15= | \rArr{} *2006*-09-15 |
5941 | =feb 15= | \rArr{} *2007*-02-15 |
5942 | =sep 12 9= | \rArr{} 2009-09-12 |
5943 | =12:45= | \rArr{} *2006*-*06*-*13* 12:45 |
5944 | =22 sept 0:34= | \rArr{} *2006*-09-22 0:34 |
5945 | =w4= | \rArr{} ISO week for of the current year *2006* |
5946 | =2012 w4 fri= | \rArr{} Friday of ISO week 4 in 2012 |
5947 | =2012-w04-5= | \rArr{} Same as above |
5949 Furthermore you can specify a relative date by giving, as the /first/
5950 thing in the input: a plus/minus sign, a number and a letter---=d=,
5951 =w=, =m= or =y=---to indicate change in days, weeks, months, or
5952 years. With a single plus or minus, the date is always relative to
5953 today. With a double plus or minus, it is relative to the default
5954 date. If instead of a single letter, you use the abbreviation of day
5955 name, the date is the Nth such day, e.g.:
5957 | =+0= | \rArr{} today |
5958 | =.= | \rArr{} today |
5959 | =+4d= | \rArr{} four days from today |
5960 | =+4= | \rArr{} same as +4d |
5961 | =+2w= | \rArr{} two weeks from today |
5962 | =++5= | \rArr{} five days from default date |
5963 | =+2tue= | \rArr{} second Tuesday from now |
5965 #+vindex: parse-time-months
5966 #+vindex: parse-time-weekdays
5967 The function understands English month and weekday abbreviations. If
5968 you want to use un-abbreviated names and/or other languages, configure
5969 the variables ~parse-time-months~ and ~parse-time-weekdays~.
5971 #+vindex: org-read-date-force-compatible-dates
5972 Not all dates can be represented in a given Emacs implementation. By
5973 default Org mode forces dates into the compatibility range 1970--2037
5974 which works on all Emacs implementations. If you want to use dates
5975 outside of this range, read the docstring of the variable
5976 ~org-read-date-force-compatible-dates~.
5978 You can specify a time range by giving start and end times or by
5979 giving a start time and a duration (in HH:MM format). Use one or two
5980 dash(es) as the separator in the former case and use =+= as the
5981 separator in the latter case, e.g.:
5983 | =11am-1:15pm= | \rArr{} 11:00-13:15 |
5984 | =11am--1:15pm= | \rArr{} same as above |
5985 | =11am+2:15= | \rArr{} same as above |
5987 #+cindex: calendar, for selecting date
5988 #+vindex: org-popup-calendar-for-date-prompt
5989 Parallel to the minibuffer prompt, a calendar is popped up[fn:62].
5990 When you exit the date prompt, either by clicking on a date in the
5991 calendar, or by pressing {{{kbd(RET)}}}, the date selected in the
5992 calendar is combined with the information entered at the prompt. You
5993 can control the calendar fully from the minibuffer:
6007 #+attr_texinfo: :columns 0.25 0.55
6008 | {{{kbd(RET)}}} | Choose date at cursor in calendar. |
6009 | {{{kbd(mouse-1)}}} | Select date by clicking on it. |
6010 | {{{kbd(S-RIGHT)}}} | One day forward. |
6011 | {{{kbd(S-LEFT)}}} | One day backward. |
6012 | {{{kbd(S-DOWN)}}} | One week forward. |
6013 | {{{kbd(S-UP)}}} | One week backward. |
6014 | {{{kbd(M-S-RIGHT)}}} | One month forward. |
6015 | {{{kbd(M-S-LEFT)}}} | One month backward. |
6016 | {{{kbd(>)}}} | Scroll calendar forward by one month. |
6017 | {{{kbd(<)}}} | Scroll calendar backward by one month. |
6018 | {{{kbd(M-v)}}} | Scroll calendar forward by 3 months. |
6019 | {{{kbd(C-v)}}} | Scroll calendar backward by 3 months. |
6021 #+vindex: org-read-date-display-live
6022 The actions of the date/time prompt may seem complex, but I assure you
6023 they will grow on you, and you will start getting annoyed by pretty
6024 much any other way of entering a date/time out there. To help you
6025 understand what is going on, the current interpretation of your input
6026 is displayed live in the minibuffer[fn:63].
6028 *** Custom time format
6030 :DESCRIPTION: Making dates look different.
6032 #+cindex: custom date/time format
6033 #+cindex: time format, custom
6034 #+cindex: date format, custom
6036 #+vindex: org-display-custom-times
6037 #+vindex: org-time-stamp-custom-formats
6038 Org mode uses the standard ISO notation for dates and times as it is
6039 defined in ISO 8601. If you cannot get used to this and require
6040 another representation of date and time to keep you happy, you can get
6041 it by customizing the variables ~org-display-custom-times~ and
6042 ~org-time-stamp-custom-formats~.
6044 - {{{kbd(C-c C-x C-t)}}} (~org-toggle-time-stamp-overlays~) ::
6046 #+kindex: C-c C-x C-t
6047 #+findex: org-toggle-time-stamp-overlays
6048 Toggle the display of custom formats for dates and times.
6050 #+texinfo: @noindent
6051 Org mode needs the default format for scanning, so the custom
6052 date/time format does not /replace/ the default format. Instead, it
6053 is put /over/ the default format using text properties. This has the
6054 following consequences:
6056 - You cannot place the cursor onto a timestamp anymore, only before or
6059 - The {{{kbd(S-UP)}}} and {{{kbd(S-DOWN)}}} keys can no longer be used
6060 to adjust each component of a timestamp. If the cursor is at the
6061 beginning of the stamp, {{{kbd(S-UP)}}} and {{{kbd(S-DOWN)}}} change
6062 the stamp by one day, just like {{{kbd(S-LEFT)}}}
6063 {{{kbd(S-RIGHT)}}}. At the end of the stamp, change the time by one
6066 - If the timestamp contains a range of clock times or a repeater,
6067 these are not overlaid, but remain in the buffer as they were.
6069 - When you delete a timestamp character-by-character, it only
6070 disappears from the buffer after /all/ (invisible) characters
6071 belonging to the ISO timestamp have been removed.
6073 - If the custom timestamp format is longer than the default and you
6074 are using dates in tables, table alignment will be messed up. If
6075 the custom format is shorter, things do work as expected.
6077 ** Deadlines and Scheduling
6079 :DESCRIPTION: Planning your work.
6082 A timestamp may be preceded by special keywords to facilitate
6083 planning. Both the timestamp and the keyword have to be positioned
6084 immediately after the task they refer to.
6088 #+cindex: @samp{DEADLINE}
6089 Meaning: the task (most likely a TODO item, though not
6090 necessarily) is supposed to be finished on that date.
6092 #+vindex: org-deadline-warning-days
6093 On the deadline date, the task is listed in the agenda. In
6094 addition, the agenda for /today/ carries a warning about the
6095 approaching or missed deadline, starting
6096 ~org-deadline-warning-days~ before the due date, and continuing
6097 until the entry is marked DONE. An example:
6100 ,*** TODO write article about the Earth for the Guide
6101 DEADLINE: <2004-02-29 Sun>
6102 The editor in charge is [[bbdb:Ford Prefect]]
6105 #+vindex: org-agenda-skip-deadline-prewarning-if-scheduled
6106 You can specify a different lead time for warnings for a specific
6107 deadlines using the following syntax. Here is an example with
6108 a warning period of 5 days =DEADLINE: <2004-02-29 Sun -5d>=.
6109 This warning is deactivated if the task gets scheduled and you
6110 set ~org-agenda-skip-deadline-prewarning-if-scheduled~ to ~t~.
6114 #+cindex: @samp{SCHEDULED}
6115 Meaning: you are planning to start working on that task on the
6118 #+vindex: org-agenda-skip-scheduled-if-done
6119 The headline is listed under the given date[fn:64]. In addition,
6120 a reminder that the scheduled date has passed is present in the
6121 compilation for /today/, until the entry is marked DONE, i.e.,
6122 the task is automatically forwarded until completed.
6125 ,*** TODO Call Trillian for a date on New Years Eve.
6126 SCHEDULED: <2004-12-25 Sat>
6129 #+vindex: org-scheduled-delay-days
6130 #+vindex: org-agenda-skip-scheduled-delay-if-deadline
6131 If you want to /delay/ the display of this task in the agenda,
6132 use =SCHEDULED: <2004-12-25 Sat -2d>=: the task is still
6133 scheduled on the 25th but will appear two days later. In case
6134 the task contains a repeater, the delay is considered to affect
6135 all occurrences; if you want the delay to only affect the first
6136 scheduled occurrence of the task, use =--2d= instead. See
6137 ~org-scheduled-delay-days~ and
6138 ~org-agenda-skip-scheduled-delay-if-deadline~ for details on how
6139 to control this globally or per agenda.
6141 #+texinfo: @noindent
6142 *Important:* Scheduling an item in Org mode should /not/ be
6143 understood in the same way that we understand /scheduling
6144 a meeting/. Setting a date for a meeting is just a simple
6145 appointment, you should mark this entry with a simple plain
6146 timestamp, to get this item shown on the date where it applies.
6147 This is a frequent misunderstanding by Org users. In Org mode,
6148 /scheduling/ means setting a date when you want to start working
6151 You may use timestamps with repeaters in scheduling and deadline
6152 entries. Org mode issues early and late warnings based on the
6153 assumption that the timestamp represents the /nearest instance/ of the
6154 repeater. However, the use of diary S-exp entries like
6156 : <%%(org-float t 42)>
6158 #+texinfo: @noindent
6159 in scheduling and deadline timestamps is limited. Org mode does not
6160 know enough about the internals of each S-exp function to issue early
6161 and late warnings. However, it shows the item on each day where the
6162 S-exp entry matches.
6164 *** Inserting deadlines or schedules
6166 :DESCRIPTION: Planning items.
6167 :ALT_TITLE: Inserting deadline/schedule
6170 The following commands allow you to quickly insert a deadline or to
6171 schedule an item:[fn:65]
6173 - {{{kbd(C-c C-d)}}} (~org-deadline~) ::
6176 #+findex: org-deadline
6177 #+vindex: org-log-redeadline
6178 Insert =DEADLINE= keyword along with a stamp. The insertion
6179 happens in the line directly following the headline. Remove any
6180 =CLOSED= timestamp . When called with a prefix argument, also
6181 remove any existing deadline from the entry. Depending on the
6182 variable ~org-log-redeadline~, take a note when changing an
6183 existing deadline[fn:66].
6185 - {{{kbd(C-c C-s)}}} (~org-schedule~) ::
6188 #+findex: org-schedule
6189 #+vindex: org-log-reschedule
6190 Insert =SCHEDULED= keyword along with a stamp. The insertion
6191 happens in the line directly following the headline. Remove any
6192 =CLOSED= timestamp. When called with a prefix argument, also
6193 remove the scheduling date from the entry. Depending on the
6194 variable ~org-log-reschedule~, take a note when changing an
6195 existing scheduling time[fn:67].
6197 - {{{kbd(C-c C-x C-k)}}} (~org-mark-entry-for-agenda-action~) ::
6199 #+kindex: C-c C-x C-k
6202 #+findex: org-mark-entry-for-agenda-action
6203 Mark the current entry for agenda action. After you have marked
6204 the entry like this, you can open the agenda or the calendar to
6205 find an appropriate date. With the cursor on the selected date,
6206 press {{{kbd(k s)}}} or {{{kbd(k d)}}} to schedule the marked
6209 - {{{kbd(C-c / d)}}} (~org-check-deadlines~) ::
6212 #+findex: org-check-deadlines
6213 #+cindex: sparse tree, for deadlines
6214 #+vindex: org-deadline-warning-days
6215 Create a sparse tree with all deadlines that are either past-due,
6216 or which will become due within ~org-deadline-warning-days~.
6217 With {{{kbd(C-u)}}} prefix, show all deadlines in the file. With
6218 a numeric prefix, check that many days. For example, {{{kbd(C-1
6219 C-c / d)}}} shows all deadlines due tomorrow.
6221 - {{{kbd(C-c / b)}}}, ~org-check-before-date~ ::
6224 #+findex: org-check-before-date
6225 Sparse tree for deadlines and scheduled items before a given
6228 - {{{kbd(C-c / a)}}}, ~org-check-after-date~ ::
6231 #+findex: org-check-after-date
6232 Sparse tree for deadlines and scheduled items after a given date.
6234 Note that ~org-schedule~ and ~org-deadline~ supports setting the date
6235 by indicating a relative time e.g., =+1d= sets the date to the next
6236 day after today, and =--1w= sets the date to the previous week before
6237 any current timestamp.
6241 :DESCRIPTION: Items that show up again and again.
6243 #+cindex: tasks, repeated
6244 #+cindex: repeated tasks
6246 Some tasks need to be repeated again and again. Org mode helps to
6247 organize such tasks using a so-called repeater in a =DEADLINE=,
6248 =SCHEDULED=, or plain timestamp. In the following example:
6251 ,** TODO Pay the rent
6252 DEADLINE: <2005-10-01 Sat +1m>
6256 the =+1m= is a repeater; the intended interpretation is that the task
6257 has a deadline on =<2005-10-01>= and repeats itself every (one) month
6258 starting from that time. You can use yearly, monthly, weekly, daily
6259 and hourly repeat cookies by using the ~y/w/m/d/h~ letters. If you
6260 need both a repeater and a special warning period in a deadline entry,
6261 the repeater should come first and the warning period last: =DEADLINE:
6262 <2005-10-01 Sat +1m -3d>=.
6264 #+vindex: org-todo-repeat-to-state
6265 Deadlines and scheduled items produce entries in the agenda when they
6266 are over-due, so it is important to be able to mark such an entry as
6267 completed once you have done so. When you mark a =DEADLINE= or
6268 a =SCHEDULED= with the TODO keyword =DONE=, it no longer produces
6269 entries in the agenda. The problem with this is, however, is that
6270 then also the /next/ instance of the repeated entry will not be
6271 active. Org mode deals with this in the following way: when you try
6272 to mark such an entry DONE, using {{{kbd(C-c C-t)}}}, it shifts the
6273 base date of the repeating timestamp by the repeater interval, and
6274 immediately sets the entry state back to TODO[fn:68]. In the example
6275 above, setting the state to DONE would actually switch the date like
6279 ,** TODO Pay the rent
6280 DEADLINE: <2005-11-01 Tue +1m>
6283 To mark a task with a repeater as DONE, use {{{kbd(C-- 1 C-c C-t)}}},
6284 i.e., ~org-todo~ with a numeric prefix argument of =-1=.
6286 #+vindex: org-log-repeat
6287 A timestamp[fn:69] is added under the deadline, to keep a record that
6288 you actually acted on the previous instance of this deadline.
6290 As a consequence of shifting the base date, this entry is no longer
6291 visible in the agenda when checking past dates, but all future
6292 instances will be visible.
6294 With the =+1m= cookie, the date shift is always exactly one month. So
6295 if you have not paid the rent for three months, marking this entry
6296 DONE still keeps it as an overdue deadline. Depending on the task,
6297 this may not be the best way to handle it. For example, if you forgot
6298 to call your father for 3 weeks, it does not make sense to call him
6299 3 times in a single day to make up for it. Finally, there are tasks
6300 like changing batteries which should always repeat a certain time
6301 /after/ the last time you did it. For these tasks, Org mode has
6302 special repeaters =++= and =.+=. For example:
6305 ,** TODO Call Father
6306 DEADLINE: <2008-02-10 Sun ++1w>
6307 Marking this DONE shifts the date by at least one week, but also
6308 by as many weeks as it takes to get this date into the future.
6309 However, it stays on a Sunday, even if you called and marked it
6312 ,** TODO Empty kitchen trash
6313 DEADLINE: <2008-02-08 Fri 20:00 ++1d>
6314 Marking this DONE shifts the date by at least one day, and also
6315 by as many days as it takes to get the timestamp into the future.
6316 Since there is a time in the timestamp, the next deadline in the
6317 future will be on today's date if you complete the task before
6320 ,** TODO Check the batteries in the smoke detectors
6321 DEADLINE: <2005-11-01 Tue .+1m>
6322 Marking this DONE will shift the date to one month after today.
6325 #+vindex: org-agenda-skip-scheduled-if-deadline-is-shown
6326 You may have both scheduling and deadline information for a specific
6327 task. If the repeater is set for the scheduling information only, you
6328 probably want the repeater to be ignored after the deadline. If so,
6329 set the variable ~org-agenda-skip-scheduled-if-deadline-is-shown~ to
6330 ~repeated-after-deadline~. However, any scheduling information
6331 without a repeater is no longer relevant once the task is done, and
6332 thus, removed upon repeating the task. If you want both scheduling
6333 and deadline information to repeat after the same interval, set the
6334 same repeater for both timestamps.
6336 An alternative to using a repeater is to create a number of copies of
6337 a task subtree, with dates shifted in each copy. The command
6338 {{{kbd(C-c C-x c)}}} was created for this purpose; it is described in
6339 [[*Structure Editing]].
6341 ** Clocking Work Time
6343 :DESCRIPTION: Tracking how long you spend on a task.
6345 #+cindex: clocking time
6346 #+cindex: time clocking
6348 Org mode allows you to clock the time you spend on specific tasks in
6349 a project. When you start working on an item, you can start the
6350 clock. When you stop working on that task, or when you mark the task
6351 done, the clock is stopped and the corresponding time interval is
6352 recorded. It also computes the total time spent on each
6353 subtree[fn:70] of a project. And it remembers a history or tasks
6354 recently clocked, to that you can jump quickly between a number of
6355 tasks absorbing your time.
6357 To save the clock history across Emacs sessions, use:
6359 #+begin_src emacs-lisp
6360 (setq org-clock-persist 'history)
6361 (org-clock-persistence-insinuate)
6364 #+vindex: org-clock-persist
6365 When you clock into a new task after resuming Emacs, the incomplete
6366 clock[fn:71] is retrieved (see [[*Resolving idle time]]) and you are
6367 prompted about what to do with it.
6369 *** Clocking commands
6371 :DESCRIPTION: Starting and stopping a clock.
6374 #+attr_texinfo: :sep ,
6375 - {{{kbd(C-c C-x C-i)}}} (~org-clock-in~) ::
6377 #+kindex: C-c C-x C-i
6378 #+findex: org-clock-in
6379 #+vindex: org-clock-into-drawer
6380 #+vindex: org-clock-continuously
6381 #+cindex: @samp{LOG_INTO_DRAWER}, property
6382 Start the clock on the current item (clock-in). This inserts the
6383 CLOCK keyword together with a timestamp. If this is not the
6384 first clocking of this item, the multiple CLOCK lines are wrapped
6385 into a =LOGBOOK= drawer (see also the variable
6386 ~org-clock-into-drawer~). You can also overrule the setting of
6387 this variable for a subtree by setting a =CLOCK_INTO_DRAWER= or
6388 =LOG_INTO_DRAWER= property. When called with a {{{kbd(C-u)}}}
6389 prefix argument, select the task from a list of recently clocked
6390 tasks. With two {{{kbd(C-u C-u)}}} prefixes, clock into the task
6391 at point and mark it as the default task; the default task is
6392 always be available with letter {{{kbd(d)}}} when selecting
6393 a clocking task. With three {{{kbd(C-u C-u C-u)}}} prefixes,
6394 force continuous clocking by starting the clock when the last
6397 #+cindex: @samp{CLOCK_MODELINE_TOTAL}, property
6398 #+cindex: @samp{LAST_REPEAT}, property
6399 #+vindex: org-clock-modeline-total
6400 #+vindex: org-clock-in-prepare-hook
6401 While the clock is running, Org shows the current clocking time
6402 in the mode line, along with the title of the task. The clock
6403 time shown is all time ever clocked for this task and its
6404 children. If the task has an effort estimate (see [[*Effort
6405 Estimates]]), the mode line displays the current clocking time
6406 against it[fn:72]. If the task is a repeating one (see [[*Repeated
6407 tasks]]), show only the time since the last reset of the
6408 task[fn:73]. You can exercise more control over show time with
6409 the =CLOCK_MODELINE_TOTAL= property. It may have the values
6410 =current= to show only the current clocking instance, =today= to
6411 show all time clocked on this tasks today---see also the
6412 variable ~org-extend-today-until~, ~all~ to include all time, or
6413 ~auto~ which is the default[fn:74]. Clicking with
6414 {{{kbd(mouse-1)}}} onto the mode line entry pops up a menu with
6417 - {{{kbd(C-c C-x C-o)}}} (~org-clock-out~) ::
6419 #+kindex: C-c C-x C-o
6420 #+findex: org-clock-out
6421 #+vindex: org-log-note-clock-out
6422 Stop the clock (clock-out). This inserts another timestamp at
6423 the same location where the clock was last started. It also
6424 directly computes the resulting time in inserts it after the time
6425 range as ==>HH:MM=. See the variable ~org-log-note-clock-out~
6426 for the possibility to record an additional note together with
6427 the clock-out timestamp[fn:75].
6429 - {{{kbd(C-c C-x C-x)}}} (~org-clock-in-last~) ::
6431 #+kindex: C-c C-x C-x
6432 #+findex: org-clock-in-last
6433 #+vindex: org-clock-continuously
6434 Re-clock the last clocked task. With one {{{kbd(C-u)}}} prefix
6435 argument, select the task from the clock history. With two
6436 {{{kbd(C-u)}}} prefixes, force continuous clocking by starting
6437 the clock when the last clock stopped.
6439 - {{{kbd(C-c C-x C-e)}}} (~org-clock-modify-effort-estimate~) ::
6441 #+kindex: C-c C-x C-e
6442 #+findex: org-clock-modify-effort-estimate
6443 Update the effort estimate for the current clock task.
6445 - {{{kbd(C-c C-c)}}} or {{{kbd(C-c C-y)}}} (~org-evaluate-time-range~) ::
6449 #+findex: org-evaluate-time-range
6450 Recompute the time interval after changing one of the timestamps.
6451 This is only necessary if you edit the timestamps directly. If
6452 you change them with {{{kbd(S-<cursor>)}}} keys, the update is
6455 - {{{kbd(C-S-UP)}}} (~org-clock-timestamps-up~), {{{kbd(C-S-DOWN)}}} (~org-clock-timestamps-down~) ::
6458 #+findex: org-clock-timestamps-up
6460 #+findex: org-clock-timestamps-down
6461 On CLOCK log lines, increase/decrease both timestamps so that the
6462 clock duration keeps the same value.
6464 - {{{kbd(S-M-UP)}}} (~org-timestamp-up~), {{{kbd(S-M-DOWN)}}} (~org-timestamp-down~) ::
6467 #+findex: org-clock-timestamp-up
6469 #+findex: org-clock-timestamp-down
6470 On =CLOCK= log lines, increase/decrease the timestamp at point
6471 and the one of the previous, or the next, clock timestamp by the
6472 same duration. For example, if you hit {{{kbd(S-M-UP)}}} to
6473 increase a clocked-out timestamp by five minutes, then the
6474 clocked-in timestamp of the next clock is increased by five
6477 - {{{kbd(C-c C-t)}}} (~org-todo~) ::
6481 Changing the TODO state of an item to DONE automatically stops
6482 the clock if it is running in this same item.
6484 - {{{kbd(C-c C-x C-q)}}} (~org-clock-cancel~) ::
6486 #+kindex: C-c C-x C-q
6487 #+findex: org-clock-cancel
6488 Cancel the current clock. This is useful if a clock was started
6489 by mistake, or if you ended up working on something else.
6491 - {{{kbd(C-c C-x C-j)}}} (~org-clock-goto~) ::
6493 #+kindex: C-c C-x C-j
6494 #+findex: or-clock-goto
6495 Jump to the headline of the currently clocked in task. With
6496 a {{{kbd(C-u)}}} prefix argument, select the target task from
6497 a list of recently clocked tasks.
6499 - {{{kbd(C-c C-x C-d)}}} (~org-clock-display~) ::
6501 #+kindex: C-c C-x C-d
6502 #+findex: org-clock-display
6503 #+vindex: org-remove-highlights-with-change
6504 Display time summaries for each subtree in the current buffer.
6505 This puts overlays at the end of each headline, showing the total
6506 time recorded under that heading, including the time of any
6507 subheadings. You can use visibility cycling to study the tree,
6508 but the overlays disappear when you change the buffer (see
6509 variable ~org-remove-highlights-with-change~) or press {{{kbd(C-c
6512 The {{{kbd(l)}}} key may be used in the agenda (see [[*Weekly/daily
6513 agenda]]) to show which tasks have been worked on or closed during
6516 *Important:* note that both ~org-clock-out~ and ~org-clock-in-last~
6517 can have a global keybinding and do not modify the window disposition.
6521 :DESCRIPTION: Detailed reports.
6523 #+cindex: clocktable, dynamic block
6524 #+cindex: report, of clocked time
6526 Org mode can produce quite complex reports based on the time clocking
6527 information. Such a report is called a /clock table/, because it is
6528 formatted as one or several Org tables.
6530 #+attr_texinfo: :sep ,
6531 - {{{kbd(C-c C-x C-r)}}} (~org-clock-report~) ::
6533 #+kindex: C-c C-x C-r
6534 #+findex: org-clock-report
6535 Insert a dynamic block (see [[*Dynamic Blocks]]) containing a clock
6536 report as an Org mode table into the current file. When the
6537 cursor is at an existing clock table, just update it. When
6538 called with a prefix argument, jump to the first clock report in
6539 the current document and update it. The clock table includes
6542 - {{{kbd(C-c C-c)}}} or {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) ::
6545 #+kindex: C-c C-x C-u
6546 #+findex: org-dblock-update
6547 Update dynamic block at point. The cursor needs to be in the
6548 =BEGIN= line of the dynamic block.
6550 - {{{kbd(C-u C-c C-x C-u)}}} ::
6552 #+kindex: C-u C-c C-x C-u
6553 Update all dynamic blocks (see [[*Dynamic Blocks]]). This is useful
6554 if you have several clock table blocks in a buffer.
6556 - {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} (~org-clocktable-try-shift~) ::
6560 #+findex: org-clocktable-try-shift
6561 Shift the current =:block= interval and update the table. The
6562 cursor needs to be in the =#+BEGIN: clocktable= line for this
6563 command. If =:block= is =today=, it is shifted to =today-1=,
6566 Here is an example of the frame for a clock table as it is inserted
6567 into the buffer with the {{{kbd(C-c C-x C-r)}}} command:
6569 #+cindex: @samp{BEGIN clocktable}
6571 ,#+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6575 #+texinfo: @noindent
6576 #+vindex: org-clocktable-defaults
6577 The =#+BEGIN= line and specify a number of options to define the
6578 scope, structure, and formatting of the report. Defaults for all
6579 these options can be configured in the variable
6580 ~org-clocktable-defaults~.
6582 #+texinfo: @noindent
6583 First there are options that determine which clock entries are to
6588 Maximum level depth to which times are listed in the table.
6589 Clocks at deeper levels are summed into the upper level.
6593 The scope to consider. This can be any of the following:
6595 | ~nil~ | the current buffer or narrowed region |
6596 | ~file~ | the full current buffer |
6597 | ~subtree~ | the subtree where the clocktable is located |
6598 | ~treeN~ | the surrounding level N tree, for example =tree3= |
6599 | ~tree~ | the surrounding level 1 tree |
6600 | ~agenda~ | all agenda files |
6601 | =("file" ...)= | scan these files |
6602 | =FUNCTION= | scan files returned by calling FUNCTION with no argument |
6603 | ~file-with-archives~ | current file and its archives |
6604 | ~agenda-with-archives~ | all agenda files, including archives |
6608 The time block to consider. This block is specified either
6609 absolutely, or relative to the current time and may be any of
6612 | =2007-12-31= | New year eve 2007 |
6613 | =2007-12= | December 2007 |
6614 | =2007-W50= | ISO-week 50 in 2007 |
6615 | =2007-Q2= | 2nd quarter in 2007 |
6616 | =2007= | the year 2007 |
6617 | ~today~, ~yesterday~, ~today-N~ | a relative day |
6618 | ~thisweek~, ~lastweek~, ~thisweek-N~ | a relative week |
6619 | ~thismonth~, ~lastmonth~, ~thismonth-N~ | a relative month |
6620 | ~thisyear~, ~lastyear~, ~thisyear-N~ | a relative year |
6621 | ~untilnow~ | all clocked time ever |
6623 #+vindex: org-clock-display-default-range
6624 When this option is not set, Org falls back to the value in
6625 ~org-clock-display-default-range~, which defaults to the current
6628 Use {{{kbd(S-LEFT)}}} or {{{kbd(S-RIGHT)}}} to shift the time
6633 A time string specifying when to start considering times.
6634 Relative times like ="<-2w>"= can also be used. See [[*Matching
6635 tags and properties]] for relative time syntax.
6639 A time string specifying when to stop considering times.
6640 Relative times like ="<now>"= can also be used. See [[*Matching
6641 tags and properties]] for relative time syntax.
6645 The starting day of the week. The default is 1 for Monday.
6649 The starting day of the month. The default is 1 for the first.
6653 Set to ~week~ or ~day~ to split the table into chunks. To use
6654 this, ~:block~ or ~:tstart~, ~:tend~ are needed.
6658 Do not show steps that have zero time.
6662 Do not show table sections from files which did not contribute.
6666 A tags match to select entries that should contribute. See
6667 [[*Matching tags and properties]] for the match syntax.
6669 #+findex: org-clocktable-write-default
6670 Then there are options that determine the formatting of the table.
6671 There options are interpreted by the function
6672 ~org-clocktable-write-default~, but you can specify your own function
6673 using the =:formatter= parameter.
6677 When ~t~, emphasize level one and level two items.
6681 Language[fn:76] to use for descriptive cells like "Task".
6685 Link the item headlines in the table to their origins.
6689 An integer to limit the width of the headline column in the Org
6690 table. If you write it like =50!=, then the headline is also
6691 shortened in export.
6695 Indent each headline field according to its level.
6699 Number of columns to be used for times. If this is smaller than
6700 =:maxlevel=, lower levels are lumped into one column.
6704 Should a level number column be included?
6708 A cons cell containing the column to sort and a sorting type.
6709 E.g., =:sort (1 . ?a)= sorts the first column alphabetically.
6713 Abbreviation for =:level nil :indent t :narrow 40! :tcolumns 1=.
6714 All are overwritten except if there is an explicit =:narrow=.
6718 A timestamp for the entry, when available. Look for SCHEDULED,
6719 DEADLINE, TIMESTAMP and TIMESTAMP_IA special properties (see
6720 [[*Special Properties]]), in this order.
6724 List of properties shown in the table. Each property gets its
6729 When this flag is non-~nil~, the values for =:properties= are
6734 Content of a =TBLFM= keyword to be added and evaluated. As
6735 a special case, =:formula %= adds a column with % time. If you
6736 do not specify a formula here, any existing formula below the
6737 clock table survives updates and is evaluated.
6741 A function to format clock data and insert it into the buffer.
6743 To get a clock summary of the current level 1 tree, for the current
6744 day, you could write:
6747 ,#+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6751 #+texinfo: @noindent
6752 To use a specific time range you could write[fn:77]
6755 ,#+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6756 :tend "<2006-08-10 Thu 12:00>"
6760 A range starting a week ago and ending right now could be written as
6763 ,#+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6767 A summary of the current subtree with % times would be:
6770 ,#+BEGIN: clocktable :scope subtree :link t :formula %
6774 A horizontally compact representation of everything clocked during
6778 ,#+BEGIN: clocktable :scope agenda :block lastweek :compact t
6782 *** Resolving idle time and continuous clocking
6784 :DESCRIPTION: Resolving time when you've been idle.
6785 :ALT_TITLE: Resolving idle time
6788 **** Resolving idle time
6793 #+cindex: resolve idle time
6794 #+cindex: idle, resolve, dangling
6796 If you clock in on a work item, and then walk away from your
6797 computer---perhaps to take a phone call---you often need to
6798 "resolve" the time you were away by either subtracting it from the
6799 current clock, or applying it to another one.
6801 #+vindex: org-clock-idle-time
6802 #+vindex: org-clock-x11idle-program-name
6803 By customizing the variable ~org-clock-idle-time~ to some integer,
6804 such as 10 or 15, Emacs can alert you when you get back to your
6805 computer after being idle for that many minutes[fn:78], and ask what
6806 you want to do with the idle time. There will be a question waiting
6807 for you when you get back, indicating how much idle time has passed
6808 constantly updated with the current amount, as well as a set of
6809 choices to correct the discrepancy:
6814 To keep some or all of the minutes and stay clocked in, press
6815 {{{kbd(k)}}}. Org asks how many of the minutes to keep. Press
6816 {{{kbd(RET)}}} to keep them all, effectively changing nothing, or
6817 enter a number to keep that many minutes.
6822 If you use the shift key and press {{{kbd(K)}}}, it keeps however
6823 many minutes you request and then immediately clock out of that
6824 task. If you keep all of the minutes, this is the same as just
6825 clocking out of the current task.
6830 To keep none of the minutes, use {{{kbd(s)}}} to subtract all the
6831 away time from the clock, and then check back in from the moment
6837 To keep none of the minutes and just clock out at the start of
6838 the away time, use the shift key and press {{{kbd(S)}}}.
6839 Remember that using shift always leave you clocked out, no matter
6840 which option you choose.
6845 To cancel the clock altogether, use {{{kbd(C)}}}. Note that if
6846 instead of canceling you subtract the away time, and the
6847 resulting clock amount is less than a minute, the clock is still
6848 canceled rather than cluttering up the log with an empty entry.
6850 What if you subtracted those away minutes from the current clock, and
6851 now want to apply them to a new clock? Simply clock in to any task
6852 immediately after the subtraction. Org will notice that you have
6853 subtracted time "on the books", so to speak, and will ask if you want
6854 to apply those minutes to the next task you clock in on.
6856 There is one other instance when this clock resolution magic occurs.
6857 Say you were clocked in and hacking away, and suddenly your cat chased
6858 a mouse who scared a hamster that crashed into your UPS's power
6859 button! You suddenly lose all your buffers, but thanks to auto-save
6860 you still have your recent Org mode changes, including your last clock
6863 If you restart Emacs and clock into any task, Org will notice that you
6864 have a dangling clock which was never clocked out from your last
6865 session. Using that clock's starting time as the beginning of the
6866 unaccounted-for period, Org will ask how you want to resolve that
6867 time. The logic and behavior is identical to dealing with away time
6868 due to idleness; it is just happening due to a recovery event rather
6869 than a set amount of idle time.
6871 You can also check all the files visited by your Org agenda for
6872 dangling clocks at any time using {{{kbd(M-x org-resolve-clocks
6873 RET)}}} (or {{{kbd(C-c C-x C-z)}}}).
6875 **** Continuous clocking
6879 #+cindex: continuous clocking
6881 #+vindex: org-clock-continuously
6882 You may want to start clocking from the time when you clocked out the
6883 previous task. To enable this systematically, set
6884 ~org-clock-continuously~ to non-~nil~. Each time you clock in, Org
6885 retrieves the clock-out time of the last clocked entry for this
6886 session, and start the new clock from there.
6888 If you only want this from time to time, use three universal prefix
6889 arguments with ~org-clock-in~ and two {{{kbd(C-u C-u)}}} with
6890 ~org-clock-in-last~.
6894 :DESCRIPTION: Planning work effort in advance.
6896 #+cindex: effort estimates
6897 #+cindex: @samp{EFFORT}, property
6898 #+vindex: org-effort-property
6900 If you want to plan your work in a very detailed way, or if you need
6901 to produce offers with quotations of the estimated work effort, you
6902 may want to assign effort estimates to entries. If you are also
6903 clocking your work, you may later want to compare the planned effort
6904 with the actual working time, a great way to improve planning
6905 estimates. Effort estimates are stored in a special property
6906 =EFFORT=. You can set the effort for an entry with the following
6909 - {{{kbd(C-c C-x e)}}} (~org-set-effort~) ::
6912 #+findex: org-set-effort
6913 Set the effort estimate for the current entry. With a prefix
6914 argument, set it to the next allowed value---see below. This
6915 command is also accessible from the agenda with the {{{kbd(e)}}}
6918 - {{{kbd(C-c C-x C-e)}}} (~org-clock-modify-effort-estimate~) ::
6920 #+kindex: C-c C-x C-e
6921 #+findex: org-clock-modify-effort-estimate
6922 Modify the effort estimate of the item currently being clocked.
6924 Clearly the best way to work with effort estimates is through column
6925 view (see [[*Column View]]). You should start by setting up discrete
6926 values for effort estimates, and a =COLUMNS= format that displays
6927 these values together with clock sums---if you want to clock your
6928 time. For a specific buffer you can use:
6931 ,#+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6932 ,#+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort){:} %CLOCKSUM
6936 #+vindex: org-global-properties
6937 #+vindex: org-columns-default-format
6938 or, even better, you can set up these values globally by customizing
6939 the variables ~org-global-properties~ and
6940 ~org-columns-default-format~. In particular if you want to use this
6941 setup also in the agenda, a global setup may be advised.
6943 The way to assign estimates to individual items is then to switch to
6944 column mode, and to use {{{kbd(S-RIGHT)}}} and {{{kbd(S-LEFT)}}} to
6945 change the value. The values you enter are immediately summed up in
6946 the hierarchy. In the column next to it, any clocked time is
6949 #+vindex: org-agenda-columns-add-appointments-to-effort-sum
6950 If you switch to column view in the daily/weekly agenda, the effort
6951 column summarizes the estimated work effort for each day[fn:79], and
6952 you can use this to find space in your schedule. To get an overview
6953 of the entire part of the day that is committed, you can set the
6954 option ~org-agenda-columns-add-appointments-to-effort-sum~. The
6955 appointments on a day that take place over a specified time interval
6956 are then also added to the load estimate of the day.
6958 Effort estimates can be used in secondary agenda filtering that is
6959 triggered with the {{{kbd(/)}}} key in the agenda (see [[*Commands in
6960 the Agenda Buffer]]). If you have these estimates defined consistently,
6961 two or three key presses narrow down the list to stuff that fits into
6962 an available time slot.
6964 ** Taking Notes with a Relative Timer
6966 :DESCRIPTION: Notes with a running timer.
6969 #+cindex: relative timer
6970 #+cindex: countdown timer
6972 Org provides two types of timers. There is a relative timer that
6973 counts up, which can be useful when taking notes during, for example,
6974 a meeting or a video viewing. There is also a countdown timer.
6976 The relative and countdown are started with separate commands.
6978 - {{{kbd(C-c C-x 0)}}} (~org-timer-start~) ::
6981 #+findex: org-timer-start
6982 Start or reset the relative timer. By default, the timer is set
6983 to 0. When called with a {{{kbd(C-u)}}} prefix, prompt the user
6984 for a starting offset. If there is a timer string at point, this
6985 is taken as the default, providing a convenient way to restart
6986 taking notes after a break in the process. When called with
6987 a double prefix argument {{{kbd(C-u C-u)}}}, change all timer
6988 strings in the active region by a certain amount. This can be
6989 used to fix timer strings if the timer was not started at exactly
6992 - {{{kbd(C-c C-x ;)}}} (~org-timer-set-timer~) ::
6995 #+findex: org-timer-set-timer
6996 #+vindex: org-timer-default-timer
6997 Start a countdown timer. The user is prompted for a duration.
6998 ~org-timer-default-timer~ sets the default countdown value.
6999 Giving a numeric prefix argument overrides this default value.
7000 This command is available as {{{kbd(;)}}} in agenda buffers.
7002 Once started, relative and countdown timers are controlled with the
7005 - {{{kbd(C-c C-x .)}}} (~org-timer~) ::
7009 Insert a relative time into the buffer. The first time you use
7010 this, the timer starts. Using a prefix argument restarts it.
7012 - {{{kbd(C-c C-x -)}}} (~org-timer-item~) ::
7015 #+findex: org-timer-item
7016 Insert a description list item with the current relative time.
7017 With a prefix argument, first reset the timer to 0.
7019 - {{{kbd(M-RET)}}} (~org-insert-heading~) ::
7022 #+findex: org-insert-heading
7023 Once the timer list is started, you can also use
7024 {{{kbd(M-RET)}}} to insert new timer items.
7026 - {{{kbd(C-c C-x \,)}}} (~org-timer-pause-or-continue~) ::
7029 #+findex: org-timer-pause-or-continue
7030 Pause the timer, or continue it if it is already paused.
7032 - {{{kbd(C-c C-x _)}}} (~org-timer-stop~) ::
7035 #+findex: org-timer-stop
7036 Stop the timer. After this, you can only start a new timer, not
7037 continue the old one. This command also removes the timer from
7040 * Capture, Refile, Archive
7042 :DESCRIPTION: The ins and outs for projects.
7046 An important part of any organization system is the ability to quickly
7047 capture new ideas and tasks, and to associate reference material with
7048 them. Org does this using a process called /capture/. It also can
7049 store files related to a task (/attachments/) in a special directory.
7050 Once in the system, tasks and projects need to be moved around.
7051 Moving completed project trees to an archive file keeps the system
7056 :DESCRIPTION: Capturing new stuff.
7060 Capture lets you quickly store notes with little interruption of your
7061 work flow. Org's method for capturing new items is heavily inspired
7062 by John Wiegley's excellent Remember package.
7064 *** Setting up capture
7066 :DESCRIPTION: Where notes will be stored.
7069 The following customization sets a default target file for notes.
7071 #+vindex: org-default-notes-file
7072 #+begin_src emacs-lisp
7073 (setq org-default-notes-file (concat org-directory "/notes.org"))
7076 You may also define a global key for capturing new material (see
7081 :DESCRIPTION: Commands to invoke and terminate capture.
7084 - {{{kbd(M-x org-capture)}}} (~org-capture~) ::
7086 #+findex: org-capture
7088 Display the capture templates menu. If you have templates
7089 defined (see [[*Capture templates]]), it offers these templates for
7090 selection or use a new Org outline node as the default template.
7091 It inserts the template into the target file and switch to an
7092 indirect buffer narrowed to this new node. You may then insert
7093 the information you want.
7095 - {{{kbd(C-c C-c)}}} (~org-capture-finalize~) ::
7097 #+kindex: C-c C-c @r{(Capture buffer)}
7098 #+findex: org-capture-finalize
7099 Once you have finished entering information into the capture
7100 buffer, {{{kbd(C-c C-c)}}} returns you to the window
7101 configuration before the capture process, so that you can resume
7102 your work without further distraction. When called with a prefix
7103 argument, finalize and then jump to the captured item.
7105 - {{{kbd(C-c C-w)}}} (~org-capture-refile~) ::
7107 #+kindex: C-c C-w @r{(Capture buffer)}
7108 #+findex: org-capture-refile
7109 Finalize the capture process by refiling the note to a different
7110 place (see [[*Refile and Copy]]). Please realize that this is
7111 a normal refiling command that will be executed---so the cursor
7112 position at the moment you run this command is important. If you
7113 have inserted a tree with a parent and children, first move the
7114 cursor back to the parent. Any prefix argument given to this
7115 command is passed on to the ~org-refile~ command.
7117 - {{{kbd(C-c C-k)}}} (~org-capture-kill~) ::
7119 #+kindex: C-c C-k @r{(Capture buffer)}
7120 #+findex: org-capture-kill
7121 Abort the capture process and return to the previous state.
7123 #+kindex: k c @r{(Agenda)}
7124 You can also call ~org-capture~ in a special way from the agenda,
7125 using the {{{kbd(k c)}}} key combination. With this access, any
7126 timestamps inserted by the selected capture template defaults to the
7127 cursor date in the agenda, rather than to the current date.
7129 To find the locations of the last stored capture, use ~org-capture~
7130 with prefix commands:
7132 - {{{kbd(C-u M-x org-capture)}}} ::
7134 Visit the target location of a capture template. You get to
7135 select the template in the usual way.
7137 - {{{kbd(C-u C-u M-x org-capture)}}} ::
7139 Visit the last stored capture item in its buffer.
7141 #+vindex: org-capture-bookmark
7142 #+vindex: org-capture-last-stored
7143 You can also jump to the bookmark ~org-capture-last-stored~, which is
7144 automatically created unless you set ~org-capture-bookmark~ to ~nil~.
7146 To insert the capture at point in an Org buffer, call ~org-capture~
7147 with a ~C-0~ prefix argument.
7149 *** Capture templates
7151 :DESCRIPTION: Define the outline of different note types.
7153 #+cindex: templates, for Capture
7155 You can use templates for different types of capture items, and for
7156 different target locations. The easiest way to create such templates
7157 is through the customize interface.
7161 #+kindex: C @r{(Capture menu}
7162 #+vindex: org-capture-templates
7163 Customize the variable ~org-capture-templates~.
7165 Before we give the formal description of template definitions, let's
7166 look at an example. Say you would like to use one template to create
7167 general TODO entries, and you want to put these entries under the
7168 heading =Tasks= in your file =~/org/gtd.org=. Also, a date tree in
7169 the file =journal.org= should capture journal entries. A possible
7170 configuration would look like:
7172 #+begin_src emacs-lisp
7173 (setq org-capture-templates
7174 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
7175 "* TODO %?\n %i\n %a")
7176 ("j" "Journal" entry (file+datetree "~/org/journal.org")
7177 "* %?\nEntered on %U\n %i\n %a")))
7180 #+texinfo: @noindent
7181 If you then press {{{kbd(t)}}} from the capture menu, Org will prepare
7182 the template for you like this:
7186 [[file:LINK TO WHERE YOU INITIATED CAPTURE]]
7189 #+texinfo: @noindent
7190 During expansion of the template, ~%a~ has been replaced by a link to
7191 the location from where you called the capture command. This can be
7192 extremely useful for deriving tasks from emails, for example. You
7193 fill in the task definition, press {{{kbd(C-c C-c)}}} and Org returns
7194 you to the same place where you started the capture process.
7196 To define special keys to capture to a particular template without
7197 going through the interactive template selection, you can create your
7198 key binding like this:
7200 #+begin_src emacs-lisp
7201 (define-key global-map "\C-cx"
7202 (lambda () (interactive) (org-capture nil "x")))
7205 **** Template elements
7207 :DESCRIPTION: What is needed for a complete template entry.
7210 Now lets look at the elements of a template definition. Each entry in
7211 ~org-capture-templates~ is a list with the following items:
7215 The keys that selects the template, as a string, characters only,
7216 for example ="a"=, for a template to be selected with a single
7217 key, or ="bt"= for selection with two keys. When using several
7218 keys, keys using the same prefix key must be sequential in the
7219 list and preceded by a 2-element entry explaining the prefix key,
7222 #+begin_src emacs-lisp
7223 ("b" "Templates for marking stuff to buy")
7226 #+texinfo: @noindent
7227 If you do not define a template for the {{{kbd(C)}}} key, this
7228 key opens the Customize buffer for this complex variable.
7232 A short string describing the template, shown during selection.
7236 The type of entry, a symbol. Valid values are:
7240 An Org mode node, with a headline. Will be filed as the child
7241 of the target entry or as a top-level entry. The target file
7242 should be an Org file.
7246 A plain list item, placed in the first plain list at the
7247 target location. Again the target file should be an Org
7252 A checkbox item. This only differs from the plain list item
7253 by the default template.
7257 A new line in the first table at the target location. Where
7258 exactly the line will be inserted depends on the properties
7259 ~:prepend~ and ~:table-line-pos~ (see below).
7263 Text to be inserted as it is.
7267 #+vindex: org-default-notes-file
7268 #+vindex: org-directory
7269 Specification of where the captured item should be placed. In
7270 Org files, targets usually define a node. Entries will become
7271 children of this node. Other types will be added to the table or
7272 list in the body of this node. Most target specifications
7273 contain a file name. If that file name is the empty string, it
7274 defaults to ~org-default-notes-file~. A file can also be given
7275 as a variable or as a function called with no argument. When an
7276 absolute path is not specified for a target, it is taken as
7277 relative to ~org-directory~.
7281 - =(file "path/to/file")= ::
7283 Text will be placed at the beginning or end of that file.
7285 - =(id "id of existing org entry")= ::
7287 Filing as child of this entry, or in the body of the entry.
7289 - =(file+headline "filename" "node headline")= ::
7291 Fast configuration if the target heading is unique in the file.
7293 - =(file+olp "filename" "Level 1 heading" "Level 2" ...)= ::
7295 For non-unique headings, the full path is safer.
7297 - =(file+regexp "filename" "regexp to find location")= ::
7299 Use a regular expression to position the cursor.
7301 - =(file+olp+datetree "filename" [ "Level 1 heading" ...])= ::
7303 This target[fn:80] creates a heading in a date tree[fn:81] for
7304 today's date. If the optional outline path is given, the tree
7305 will be built under the node it is pointing to, instead of at
7306 top level. Check out the ~:time-prompt~ and ~:tree-type~
7307 properties below for additional options.
7309 - ~(file+function "filename" function-finding-location)~ ::
7311 A function to find the right location in the file.
7315 File to the entry that is currently being clocked.
7317 - ~(function function-finding-location)~ ::
7319 Most general way: write your own function which both visits the
7320 file and moves point to the right location.
7324 The template for creating the capture item. If you leave this
7325 empty, an appropriate default template will be used. Otherwise
7326 this is a string with escape codes, which will be replaced
7327 depending on time and context of the capture call. The string
7328 with escapes may be loaded from a template file, using the
7329 special syntax =(file "template filename")=. See below for more
7334 The rest of the entry is a property list of additional options.
7335 Recognized properties are:
7339 Normally new captured information will be appended at the
7340 target location (last child, last table line, last list item,
7341 ...). Setting this property changes that.
7343 - ~:immediate-finish~ ::
7345 When set, do not offer to edit the information, just file it
7346 away immediately. This makes sense if the template only needs
7347 information that can be added automatically.
7351 Set this to the number of lines to insert before and after the
7352 new item. Default 0, and the only other common value is 1.
7356 Start the clock in this item.
7360 Keep the clock running when filing the captured entry.
7362 - ~:clock-resume~ ::
7364 If starting the capture interrupted a clock, restart that clock
7365 when finished with the capture. Note that ~:clock-keep~ has
7366 precedence over ~:clock-resume~. When setting both to
7367 non-~nil~, the current clock will run and the previous one will
7372 Prompt for a date/time to be used for date/week trees and when
7373 filling the template. Without this property, capture uses the
7374 current date and time. Even if this property has not been set,
7375 you can force the same behavior by calling ~org-capture~ with
7376 a {{{kbd(C-1)}}} prefix argument.
7380 When ~week~, make a week tree instead of the month tree, i.e.,
7381 place the headings for each day under a heading with the
7386 Do not narrow the target buffer, simply show the full buffer. Default
7387 is to narrow it so that you only see the new material.
7389 - ~:table-line-pos~ ::
7391 Specification of the location in the table where the new line
7392 should be inserted. It should be a string like =II-3= meaning
7393 that the new line should become the third line before the
7394 second horizontal separator line.
7398 If the target file was not yet visited when capture was invoked, kill
7399 the buffer again after capture is completed.
7401 **** Template expansion
7403 :DESCRIPTION: Filling in information about time and context.
7406 In the template itself, special "%-escapes"[fn:82] allow dynamic
7407 insertion of content. The templates are expanded in the order given
7412 Insert the contents of the file given by {{{var(FILE)}}}.
7416 Evaluate Elisp SEXP and replace with the result. The
7417 {{{var(SEXP)}}} must return a string.
7421 The result of format-time-string on the {{{var(FORMAT)}}}
7426 Timestamp, date only.
7430 Timestamp, with date and time.
7434 Like ~%t~, ~%T~ above, but inactive timestamps.
7438 Initial content, the region when capture is called while the
7439 region is active. The entire text will be indented like ~%i~
7444 Annotation, normally the link created with ~org-store-link~.
7448 Like ~%a~, but prompt for the description part.
7452 Like ~%a~, but only insert the literal link.
7456 Current kill ring head.
7460 Content of the X clipboard.
7464 Title of the currently clocked task.
7468 Link to the currently clocked task.
7472 User name (taken from ~user-full-name~).
7476 File visited by current buffer when org-capture was called.
7480 Full path of the file or directory visited by current buffer.
7484 Specific information for certain link types, see below.
7488 Prompt for tags, with completion on tags in target file.
7492 Prompt for tags, with completion all tags in all agenda files.
7496 Like ~%t~, but prompt for date. Similarly ~%^T~, ~%^u~, ~%^U~. You may
7497 define a prompt like ~%^{Birthday}t~.
7501 Interactive selection of which kill or clip to use.
7505 Like ~%^C~, but insert as link.
7509 Prompt the user for a value for property PROP.
7513 Prompt the user for a string and replace this sequence with it.
7514 You may specify a default value and a completion table with
7515 ~%^{prompt|default|completion2|completion3...}~. The arrow keys
7516 access a prompt-specific history.
7520 Insert the text entered at the Nth ~%^{PROMPT}~, where N is
7521 a number, starting from 1.
7525 After completing the template, position cursor here.
7527 #+texinfo: @noindent
7528 #+vindex: org-store-link-props
7529 For specific link types, the following keywords are defined[fn:83]:
7531 #+vindex: org-from-is-user-regexp
7532 | Link type | Available keywords |
7533 |--------------+----------------------------------------------------------|
7534 | bbdb | ~%:name~, ~%:company~ |
7535 | irc | ~%:server~, ~%:port~, ~%:nick~ |
7536 | mh, rmail | ~%:type~, ~%:subject~, ~%:message-id~ |
7537 | | ~%:from~, ~%:fromname~, ~%:fromaddress~ |
7538 | | ~%:to~, ~%:toname~, ~%:toaddress~ |
7539 | | ~%:date~ (message date header field) |
7540 | | ~%:date-timestamp~ (date as active timestamp) |
7541 | | ~%:date-timestamp-inactive~ (date as inactive timestamp) |
7542 | | ~%:fromto~ (either "to NAME" or "from NAME")[fn:84] |
7543 | gnus | ~%:group~, for messages also all email fields |
7544 | w3, w3m | ~%:url~ |
7545 | info | ~%:file~, ~%:node~ |
7546 | calendar | ~%:date~ |
7547 | org-protocol | ~%:link~, ~%:description~, ~%:annotation~ |
7549 **** Templates in contexts
7551 :DESCRIPTION: Only show a template in a specific context.
7554 #+vindex: org-capture-templates-contexts
7555 To control whether a capture template should be accessible from
7556 a specific context, you can customize
7557 ~org-capture-templates-contexts~. Let's say, for example, that you
7558 have a capture template "p" for storing Gnus emails containing
7559 patches. Then you would configure this option like this:
7561 #+begin_src emacs-lisp
7562 (setq org-capture-templates-contexts
7563 '(("p" (in-mode . "message-mode"))))
7566 You can also tell that the command key {{{kbd(p)}}} should refer to
7567 another template. In that case, add this command key like this:
7569 #+begin_src emacs-lisp
7570 (setq org-capture-templates-contexts
7571 '(("p" "q" (in-mode . "message-mode"))))
7574 See the docstring of the variable for more information.
7578 :DESCRIPTION: Add files to tasks.
7580 #+cindex: attachments
7581 #+vindex: org-attach-directory
7583 It is often useful to associate reference material with an outline
7584 node/task. Small chunks of plain text can simply be stored in the
7585 subtree of a project. Hyperlinks (see [[*Hyperlinks]]) can establish
7586 associations with files that live elsewhere on your computer or in the
7587 cloud, like emails or source code files belonging to a project.
7588 Another method is /attachments/, which are files located in
7589 a directory belonging to an outline node. Org uses directories named
7590 by the unique ID of each entry. These directories are located in the
7591 ~data~ directory which lives in the same directory where your Org file
7592 lives[fn:85]. If you initialize this directory with =git init=, Org
7593 automatically commits changes when it sees them. The attachment
7594 system has been contributed to Org by John Wiegley.
7596 In cases where it seems better to do so, you can attach a directory of
7597 your choice to an entry. You can also make children inherit the
7598 attachment directory from a parent, so that an entire subtree uses the
7599 same attached directory.
7601 #+texinfo: @noindent
7602 The following commands deal with attachments:
7604 - {{{kbd(C-c C-a)}}} (~org-attach~) ::
7607 #+findex: org-attach
7608 The dispatcher for commands related to the attachment system.
7609 After these keys, a list of commands is displayed and you must
7610 press an additional key to select a command:
7612 - {{{kbd(a)}}} (~org-attach-attach~) ::
7615 #+findex: org-attach-attach
7616 #+vindex: org-attach-method
7617 Select a file and move it into the task's attachment
7618 directory. The file is copied, moved, or linked, depending
7619 on ~org-attach-method~. Note that hard links are not
7620 supported on all systems.
7622 - {{{kbd(c)}}}/{{{kbd(m)}}}/{{{kbd(l)}}} ::
7627 Attach a file using the copy/move/link method. Note that
7628 hard links are not supported on all systems.
7630 - {{{kbd(n)}}} (~org-attach-new~) ::
7633 #+findex: org-attach-new
7634 Create a new attachment as an Emacs buffer.
7636 - {{{kbd(z)}}} (~org-attach-sync~) ::
7639 #+findex: org-attach-sync
7640 Synchronize the current task with its attachment directory, in case
7641 you added attachments yourself.
7643 - {{{kbd(o)}}} (~org-attach-open~) ::
7646 #+findex: org-attach-open
7647 #+vindex: org-file-apps
7648 Open current task's attachment. If there is more than one,
7649 prompt for a file name first. Opening follows the rules set
7650 by ~org-file-apps~. For more details, see the information
7651 on following hyperlinks (see [[*Handling Links]]).
7653 - {{{kbd(O)}}} (~org-attach-open-in-emacs~) ::
7656 #+findex: org-attach-open-in-emacs
7657 Also open the attachment, but force opening the file in
7660 - {{{kbd(f)}}} (~org-attach-reveal~) ::
7663 #+findex: org-attach-reveal
7664 Open the current task's attachment directory.
7666 - {{{kbd(F)}}} (~org-attach-reveal-in-emacs~) ::
7669 #+findex: org-attach-reveal-in-emacs
7670 Also open the directory, but force using Dired in Emacs.
7672 - {{{kbd(d)}}} (~org-attach-delete-one~) ::
7675 Select and delete a single attachment.
7677 - {{{kbd(D)}}} (~org-attach-delete-all~) ::
7680 Delete all of a task's attachments. A safer way is to open
7681 the directory in Dired and delete from there.
7683 - {{{kbd(s)}}} (~org-attach-set-directory~) ::
7686 #+cindex: @samp{ATTACH_DIR}, property
7687 Set a specific directory as the entry's attachment
7688 directory. This works by putting the directory path into
7689 the =ATTACH_DIR= property.
7691 - {{{kbd(i)}}} (~org-attach-set-inherit~) ::
7694 #+cindex: @samp{ATTACH_DIR_INHERIT}, property
7695 Set the =ATTACH_DIR_INHERIT= property, so that children use
7696 the same directory for attachments as the parent does.
7698 #+cindex: attach from Dired
7699 #+findex: org-attach-dired-to-subtree
7700 It is possible to attach files to a subtree from a Dired buffer. To
7701 use this feature, have one window in Dired mode containing the file(s)
7702 to be attached and another window with point in the subtree that shall
7703 get the attachments. In the Dired window, with point on a file,
7704 {{{kbd(M-x org-attach-dired-to-subtree)}}} attaches the file to the
7705 subtree using the attachment method set by variable
7706 ~org-attach-method~. When files are marked in the Dired window then
7707 all marked files get attached.
7709 Add the following lines to the Emacs init file to have {{{kbd(C-c C-x
7710 a)}}} attach files in Dired buffers.
7712 #+begin_src emacs-lisp
7713 (add-hook 'dired-mode-hook
7715 (define-key dired-mode-map
7717 #'org-attach-dired-to-subtree))))
7720 The following code shows how to bind the previous command with
7721 a specific attachment method.
7723 #+begin_src emacs-lisp
7724 (add-hook 'dired-mode-hook
7726 (define-key dired-mode-map (kbd "C-c C-x c")
7729 (let ((org-attach-method 'cp))
7730 (call-interactively #'org-attach-dired-to-subtree))))))
7735 :DESCRIPTION: Getting input from RSS feeds.
7738 #+cindex: Atom feeds
7740 Org can add and change entries based on information found in RSS feeds
7741 and Atom feeds. You could use this to make a task out of each new
7742 podcast in a podcast feed. Or you could use a phone-based
7743 note-creating service on the web to import tasks into Org. To access
7744 feeds, configure the variable ~org-feed-alist~. The docstring of this
7745 variable has detailed information. With the following
7747 #+begin_src emacs-lisp
7748 (setq org-feed-alist
7750 "http://rss.slashdot.org/Slashdot/slashdot"
7751 "~/txt/org/feeds.org" "Slashdot Entries")))
7754 #+texinfo: @noindent
7755 new items from the feed provided by =rss.slashdot.org= result in new
7756 entries in the file =~/org/feeds.org= under the heading =Slashdot
7757 Entries=, whenever the following command is used:
7759 - {{{kbd(C-c C-x g)}}} (~org-feed-update-all~) ::
7762 Collect items from the feeds configured in ~org-feed-alist~ and
7765 - {{{kbd(C-c C-x G)}}} (~org-feed-goto-inbox~) ::
7768 Prompt for a feed name and go to the inbox configured for this feed.
7770 Under the same headline, Org creates a drawer =FEEDSTATUS= in which it
7771 stores information about the status of items in the feed, to avoid
7772 adding the same item several times.
7774 For more information, including how to read atom feeds, see
7775 =org-feed.el= and the docstring of ~org-feed-alist~.
7777 ** Protocols for External Access
7779 :DESCRIPTION: External access to Emacs and Org.
7780 :ALT_TITLE: Protocols
7782 #+cindex: protocols, for external access
7784 Org protocol is a means to trigger custom actions in Emacs from
7785 external applications. Any application that supports calling external
7786 programs with an URL as argument may be used with this functionality.
7787 For example, you can configure bookmarks in your web browser to send
7788 a link to the current page to Org and create a note from it using
7789 capture (see [[*Capture]]). You can also create a bookmark that tells
7790 Emacs to open the local source file of a remote website you are
7793 #+cindex: Org protocol, set-up
7794 #+cindex: Installing Org protocol
7795 In order to use Org protocol from an application, you need to register
7796 =org-protocol://= as a valid scheme-handler. External calls are
7797 passed to Emacs through the =emacsclient= command, so you also need to
7798 ensure an Emacs server is running. More precisely, when the
7801 : emacsclient org-protocol://PROTOCOL?key1=val1&key2=val2
7803 #+texinfo: @noindent
7804 Emacs calls the handler associated to {{{var(PROTOCOL)}}} with
7805 argument =(:key1 val1 :key2 val2)=.
7807 #+cindex: protocol, new protocol
7808 #+cindex: defining new protocols
7809 Org protocol comes with three predefined protocols, detailed in the
7810 following sections. Configure ~org-protocol-protocol-alist~ to define
7813 *** ~store-link~ protocol
7815 :DESCRIPTION: Store a link, push URL to kill-ring.
7817 #+cindex: store-link protocol
7818 #+cindex: protocol, store-link
7820 Using ~store-link~ handler, you can copy links, insertable through
7821 {{{kbd(M-x org-insert-link)}}} or yanking thereafter. More precisely,
7824 : emacsclient org-protocol://store-link?url=URL&title=TITLE
7826 #+texinfo: @noindent
7827 stores the following link:
7831 In addition, {{{var(URL)}}} is pushed on the kill-ring for yanking.
7832 You need to encode {{{var(URL)}}} and {{{var(TITLE)}}} if they contain
7833 slashes, and probably quote those for the shell.
7835 To use this feature from a browser, add a bookmark with an arbitrary
7836 name, e.g., =Org: store-link= and enter this as /Location/:
7839 javascript:location.href='org-protocol://store-link?url='+
7840 encodeURIComponent(location.href);
7843 *** ~capture~ protocol
7845 :DESCRIPTION: Fill a buffer with external information.
7847 #+cindex: capture protocol
7848 #+cindex: protocol, capture
7850 Activating "capture" handler pops up a =Capture= buffer and fills the
7851 capture template associated to the =X= key with them.
7853 : emacsclient org-protocol://capture?template=X?url=URL?title=TITLE?body=BODY
7855 To use this feature, add a bookmark with an arbitrary name, e.g.
7856 =Org: capture= and enter this as =Location=:
7859 javascript:location.href='org-protocol://template=x'+
7860 '&url='+encodeURIComponent(window.location.href)+
7861 '&title='+encodeURIComponent(document.title)+
7862 '&body='+encodeURIComponent(window.getSelection());
7865 #+vindex: org-protocol-default-template-key
7866 The result depends on the capture template used, which is set in the
7867 bookmark itself, as in the example above, or in
7868 ~org-protocol-default-template-key~.
7870 The following template placeholders are available:
7874 %:description The webpage title
7875 %:annotation Equivalent to [[%:link][%:description]]
7876 %i The selected text
7879 *** ~open-source~ protocol
7881 :DESCRIPTION: Edit published contents.
7883 #+cindex: open-source protocol
7884 #+cindex: protocol, open-source
7886 The ~open-source~ handler is designed to help with editing local
7887 sources when reading a document. To that effect, you can use
7888 a bookmark with the following location:
7891 javascript:location.href='org-protocol://open-source?&url='+
7892 encodeURIComponent(location.href)
7895 #+vindex: org-protocol-project-alist
7896 The variable ~org-protocol-project-alist~ maps URLs to local file
7897 names, by stripping URL parameters from the end and replacing the
7898 ~:base-url~ with ~:working-directory~ and ~:online-suffix~ with
7899 ~:working-suffix~. For example, assuming you own a local copy of
7900 =https://orgmode.org/worg/= contents at =/home/user/worg=, you can set
7901 ~org-protocol-project-alist~ to the following
7903 #+begin_src emacs-lisp
7904 (setq org-protocol-project-alist
7906 :base-url "https://orgmode.org/worg/"
7907 :working-directory "/home/user/worg/"
7908 :online-suffix ".html"
7909 :working-suffix ".org")))
7912 #+texinfo: @noindent
7913 If you are now browsing
7914 =https://orgmode.org/worg/org-contrib/org-protocol.html= and find
7915 a typo or have an idea about how to enhance the documentation, simply
7916 click the bookmark and start editing.
7918 #+cindex: rewritten URL in open-source protocol
7919 #+cindex: protocol, open-source rewritten URL
7920 However, such mapping may not yield the desired results. Suppose you
7921 maintain an online store located at =http://example.com/=. The local
7922 sources reside in =/home/user/example/=. It is common practice to
7923 serve all products in such a store through one file and rewrite URLs
7924 that do not match an existing file on the server. That way, a request
7925 to =http://example.com/print/posters.html= might be rewritten on the
7926 server to something like
7927 =http://example.com/shop/products.php/posters.html.php=. The
7928 ~open-source~ handler probably cannot find a file named
7929 =/home/user/example/print/posters.html.php= and fails.
7931 Such an entry in ~org-protocol-project-alist~ may hold an additional
7932 property ~:rewrites~. This property is a list of cons cells, each of
7933 which maps a regular expression to a path relative to the
7934 ~:working-directory~.
7936 Now map the URL to the path =/home/user/example/products.php= by
7937 adding ~:rewrites~ rules like this:
7939 #+begin_src emacs-lisp
7940 (setq org-protocol-project-alist
7942 :base-url "http://example.com/"
7943 :working-directory "/home/user/example/"
7944 :online-suffix ".php"
7945 :working-suffix ".php"
7946 :rewrites (("example.com/print/" . "products.php")
7947 ("example.com/$" . "index.php")))))
7950 #+texinfo: @noindent
7951 Since =example.com/$= is used as a regular expression, it maps
7952 =http://example.com/=, =https://example.com=,
7953 =http://www.example.com/= and similar to
7954 =/home/user/example/index.php=.
7956 The ~:rewrites~ rules are searched as a last resort if and only if no
7957 existing file name is matched.
7959 #+cindex: protocol, open-source, set-up mapping
7960 #+cindex: mappings in open-source protocol
7961 #+findex: org-protocol-create
7962 #+findex: org-protocol-create-for-org
7963 Two functions can help you filling ~org-protocol-project-alist~ with
7964 valid contents: ~org-protocol-create~ and
7965 ~org-protocol-create-for-org~. The latter is of use if you're editing
7966 an Org file that is part of a publishing project.
7970 :DESCRIPTION: Moving/copying a tree from one place to another.
7972 #+cindex: refiling notes
7973 #+cindex: copying notes
7975 When reviewing the captured data, you may want to refile or to copy
7976 some of the entries into a different list, for example into a project.
7977 Cutting, finding the right location, and then pasting the note is
7978 cumbersome. To simplify this process, you can use the following
7981 - {{{kbd(C-c M-w)}}} (~org-copy~) ::
7985 Copying works like refiling, except that the original note is not
7988 - {{{kbd(C-c C-w)}}} (~org-refile~) ::
7991 #+findex: org-refile
7992 #+vindex: org-reverse-note-order
7993 #+vindex: org-refile-targets
7994 #+vindex: org-refile-use-outline-path
7995 #+vindex: org-outline-path-complete-in-steps
7996 #+vindex: org-refile-allow-creating-parent-nodes
7997 #+vindex: org-log-refile
7998 Refile the entry or region at point. This command offers
7999 possible locations for refiling the entry and lets you select one
8000 with completion. The item (or all items in the region) is filed
8001 below the target heading as a subitem. Depending on
8002 ~org-reverse-note-order~, it is either the first or last subitem.
8004 By default, all level 1 headlines in the current buffer are
8005 considered to be targets, but you can have more complex
8006 definitions across a number of files. See the variable
8007 ~org-refile-targets~ for details. If you would like to select
8008 a location via a file-path-like completion along the outline
8009 path, see the variables ~org-refile-use-outline-path~ and
8010 ~org-outline-path-complete-in-steps~. If you would like to be
8011 able to create new nodes as new parents for refiling on the fly,
8012 check the variable ~org-refile-allow-creating-parent-nodes~.
8013 When the variable ~org-log-refile~[fn:86] is set, a timestamp or
8014 a note is recorded whenever an entry is refiled.
8016 - {{{kbd(C-u C-c C-w)}}} ::
8018 #+kindex: C-u C-c C-w
8019 Use the refile interface to jump to a heading.
8021 - {{{kbd(C-u C-u C-c C-w)}}} (~org-refile-goto-last-stored~) ::
8023 #+kindex: C-u C-u C-c C-w
8024 #+findex: org-refile-goto-last-stored
8025 Jump to the location where ~org-refile~ last moved a tree to.
8027 - {{{kbd(C-2 C-c C-w)}}} ::
8029 #+kindex: C-2 C-c C-w
8030 Refile as the child of the item currently being clocked.
8032 - {{{kbd(C-3 C-c C-w)}}} ::
8034 #+kindex: C-3 C-c C-w
8035 #+vindex: org-refile-keep
8036 Refile and keep the entry in place. Also see ~org-refile-keep~
8037 to make this the default behavior, and beware that this may
8038 result in duplicated ~ID~ properties.
8040 - {{{kbd(C-0 C-c C-w)}}} or {{{kbd(C-u C-u C-u C-c C-w)}}} (~org-refile-cache-clear~) ::
8042 #+kindex: C-u C-u C-u C-c C-w
8043 #+kindex: C-0 C-c C-w
8044 #+findex: org-refile-cache-clear
8045 #+vindex: org-refile-use-cache
8046 Clear the target cache. Caching of refile targets can be turned
8047 on by setting ~org-refile-use-cache~. To make the command see
8048 new possible targets, you have to clear the cache with this
8053 :DESCRIPTION: What to do with finished products.
8057 When a project represented by a (sub)tree is finished, you may want to
8058 move the tree out of the way and to stop it from contributing to the
8059 agenda. Archiving is important to keep your working files compact and
8060 global searches like the construction of agenda views fast.
8062 - {{{kbd(C-c C-x C-a)}}} (~org-archive-subtree-default~) ::
8064 #+kindex: C-c C-x C-a
8065 #+findex: org-archive-subtree-default
8066 #+vindex: org-archive-default-command
8067 Archive the current entry using the command specified in the
8068 variable ~org-archive-default-command~.
8070 *** Moving a tree to an archive file
8072 :DESCRIPTION: Moving a tree to an archive file.
8073 :ALT_TITLE: Moving subtrees
8075 #+cindex: external archiving
8077 The most common archiving action is to move a project tree to another
8078 file, the archive file.
8080 - {{{kbd(C-c C-x C-s)}}} or short {{{kbd(C-c $)}}} (~org-archive-subtree~) ::
8082 #+kindex: C-c C-x C-s
8084 #+findex: org-archive-subtree
8085 #+vindex: org-archive-location
8086 Archive the subtree starting at the cursor position to the
8087 location given by ~org-archive-location~.
8089 - {{{kbd(C-u C-c C-x C-s)}}} ::
8091 #+kindex: C-u C-c C-x C-s
8092 Check if any direct children of the current headline could be
8093 moved to the archive. To do this, check each subtree for open
8094 TODO entries. If none is found, the command offers to move it to
8095 the archive location. If the cursor is /not/ on a headline when
8096 this command is invoked, check level 1 trees.
8098 - {{{kbd(C-u C-u C-c C-x C-s)}}} ::
8100 #+kindex: C-u C-u C-c C-x C-s
8101 As above, but check subtree for timestamps instead of TODO
8102 entries. The command offers to archive the subtree if it /does/
8103 contain a timestamp, and that timestamp is in the past.
8105 #+cindex: archive locations
8106 The default archive location is a file in the same directory as the
8107 current file, with the name derived by appending =_archive= to the
8108 current file name. You can also choose what heading to file archived
8109 items under, with the possibility to add them to a datetree in a file.
8110 For information and examples on how to specify the file and the
8111 heading, see the documentation string of the variable
8112 ~org-archive-location~.
8114 There is also an in-buffer option for setting this variable, for
8117 #+cindex: @samp{ARCHIVE}, keyword
8118 : #+ARCHIVE: %s_done::
8120 #+texinfo: @noindent
8121 #+cindex: ARCHIVE, property
8122 If you would like to have a special archive location for a single
8123 entry or a (sub)tree, give the entry an =ARCHIVE= property with the
8124 location as the value (see [[*Properties and Columns]]).
8126 #+vindex: org-archive-save-context-info
8127 When a subtree is moved, it receives a number of special properties
8128 that record context information like the file from where the entry
8129 came, its outline path the archiving time etc. Configure the variable
8130 ~org-archive-save-context-info~ to adjust the amount of information
8133 *** Internal archiving
8135 :DESCRIPTION: Switch off a tree but keep it in the file.
8138 #+cindex: @samp{ARCHIVE}, tag
8139 If you want to just switch off---for agenda views---certain subtrees
8140 without moving them to a different file, you can use the =ARCHIVE=
8143 A headline that is marked with the =ARCHIVE= tag (see [[*Tags]]) stays at
8144 its location in the outline tree, but behaves in the following way:
8147 #+vindex: org-cycle-open-archived-trees
8148 It does not open when you attempt to do so with a visibility cycling
8149 command (see [[*Visibility Cycling]]). You can force cycling archived
8150 subtrees with {{{kbd(C-TAB)}}}, or by setting the option
8151 ~org-cycle-open-archived-trees~. Also normal outline commands, like
8152 ~outline-show-all~, open archived subtrees.
8155 #+vindex: org-sparse-tree-open-archived-trees
8156 During sparse tree construction (see [[*Sparse Trees]]), matches in
8157 archived subtrees are not exposed, unless you configure the option
8158 ~org-sparse-tree-open-archived-trees~.
8161 #+vindex: org-agenda-skip-archived-trees
8162 During agenda view construction (see [[*Agenda Views]]), the content of
8163 archived trees is ignored unless you configure the option
8164 ~org-agenda-skip-archived-trees~, in which case these trees are
8165 always included. In the agenda you can press {{{kbd(v a)}}} to get
8166 archives temporarily included.
8169 #+vindex: org-export-with-archived-trees
8170 Archived trees are not exported (see [[*Exporting]]), only the headline
8171 is. Configure the details using the variable
8172 ~org-export-with-archived-trees~.
8175 #+vindex: org-columns-skip-archived-trees
8176 Archived trees are excluded from column view unless the variable
8177 ~org-columns-skip-archived-trees~ is configured to ~nil~.
8179 The following commands help manage the =ARCHIVE= tag:
8181 - {{{kbd(C-c C-x a)}}} (~org-toggle-archive-tag~) ::
8184 #+findex: org-toggle-archive-tag
8185 Toggle the archive tag for the current headline. When the tag is
8186 set, the headline changes to a shadowed face, and the subtree
8189 - {{{kbd(C-u C-c C-x a)}}} ::
8191 #+kindex: C-u C-c C-x a
8192 Check if any direct children of the current headline should be
8193 archived. To do this, check each subtree for open TODO entries.
8194 If none is found, the command offers to set the =ARCHIVE= tag for
8195 the child. If the cursor is /not/ on a headline when this
8196 command is invoked, check the level 1 trees.
8198 - {{{kbd(C-TAB)}}}, ~org-force-cycle-archived~ ::
8201 Cycle a tree even if it is tagged with =ARCHIVE=.
8203 - {{{kbd(C-c C-x A)}}} (~org-archive-to-archive-sibling~) ::
8206 #+findex: org-archive-to-archive-sibling
8207 Move the current entry to the /Archive Sibling/. This is
8208 a sibling of the entry with the heading =Archive= and the archive
8209 tag. The entry becomes a child of that sibling and in this way
8210 retains a lot of its original context, including inherited tags
8211 and approximate position in the outline.
8215 :DESCRIPTION: Collecting information into views.
8217 #+cindex: agenda views
8219 Due to the way Org works, TODO items, time-stamped items, and tagged
8220 headlines can be scattered throughout a file or even a number of
8221 files. To get an overview of open action items, or of events that are
8222 important for a particular date, this information must be collected,
8223 sorted and displayed in an organized way.
8225 Org can select items based on various criteria and display them in
8226 a separate buffer. Seven different view types are provided:
8228 - an /agenda/ that is like a calendar and shows information for
8231 - a /TODO list/ that covers all unfinished action items,
8233 - a /match view/, showings headlines based on the tags, properties,
8234 and TODO state associated with them,
8236 - a /timeline view/ that shows all events in a single Org file, in
8239 - a /text search view/ that shows all entries from multiple files that
8240 contain specified keywords,
8242 - a /stuck projects view/ showing projects that currently do not move
8245 - /custom views/ that are special searches and combinations of
8248 #+texinfo: @noindent
8249 The extracted information is displayed in a special /agenda buffer/.
8250 This buffer is read-only, but provides commands to visit the
8251 corresponding locations in the original Org files, and even to edit
8252 these files remotely.
8254 #+vindex: org-agenda-skip-comment-trees
8255 #+vindex: org-agenda-skip-archived-trees
8256 #+cindex: commented entries, in agenda views
8257 #+cindex: archived entries, in agenda views
8258 By default, the report ignores commented (see [[*Comment Lines]]) and
8259 archived (see [[*Internal archiving]]) entries. You can override this by
8260 setting ~org-agenda-skip-comment-trees~ and
8261 ~org-agenda-skip-archived-trees~ to ~nil~.
8263 #+vindex: org-agenda-window-setup
8264 #+vindex: org-agenda-restore-windows-after-quit
8265 Two variables control how the agenda buffer is displayed and whether
8266 the window configuration is restored when the agenda exits:
8267 ~org-agenda-window-setup~ and ~org-agenda-restore-windows-after-quit~.
8271 :DESCRIPTION: Files being searched for agenda information.
8273 #+cindex: agenda files
8274 #+cindex: files for agenda
8276 #+vindex: org-agenda-files
8277 The information to be shown is normally collected from all /agenda
8278 files/, the files listed in the variable ~org-agenda-files~[fn:87].
8279 If a directory is part of this list, all files with the extension
8280 =.org= in this directory are part of the list.
8282 Thus, even if you only work with a single Org file, that file should
8283 be put into the list[fn:88]. You can customize ~org-agenda-files~,
8284 but the easiest way to maintain it is through the following commands
8286 #+attr_texinfo: :sep and
8287 - {{{kbd(C-c [)}}} (~org-agenda-file-to-front~) ::
8290 #+findex: org-agenda-file-to-front
8291 #+cindex: files, adding to agenda list
8292 Add current file to the list of agenda files. The file is added
8293 to the front of the list. If it was already in the list, it is
8294 moved to the front. With a prefix argument, file is added/moved
8297 - {{{kbd(C-c ])}}} (~org-remove-file~) ::
8300 #+findex: org-remove-file
8301 Remove current file from the list of agenda files.
8303 - {{{kbd(C-')}}} and {{{kbd(C-\,)}}} (~org-cycle-agenda-files~) ::
8307 #+findex: org-cycle-agenda-files
8308 #+cindex: cycling, of agenda files
8309 Cycle through agenda file list, visiting one file after the other.
8311 - {{{kbd(M-x org-iswitchb)}}} ::
8313 #+findex: org-iswitchb
8314 Command to use an ~iswitchb~-like interface to switch to and
8315 between Org buffers.
8317 #+texinfo: @noindent
8318 The Org menu contains the current list of files and can be used to
8321 If you would like to focus the agenda temporarily on a file not in
8322 this list, or on just one file in the list, or even on only a subtree
8323 in a file, then this can be done in different ways. For a single
8324 agenda command, you may press {{{kbd(<)}}} once or several times in
8325 the dispatcher (see [[*The Agenda Dispatcher]]). To restrict the agenda
8326 scope for an extended period, use the following commands:
8328 - {{{kbd(C-c C-x <)}}} (~org-agenda-set-restriction-lock~) ::
8331 #+findex: org-agenda-set-restriction-lock
8332 Permanently restrict the agenda to the current subtree. When
8333 called with a prefix argument, or with the cursor before the
8334 first headline in a file, set the agenda scope to the entire
8335 file. This restriction remains in effect until removed with
8336 {{{kbd(C-c C-x >)}}}, or by typing either {{{kbd(<)}}} or
8337 {{{kbd(>)}}} in the agenda dispatcher. If there is a window
8338 displaying an agenda view, the new restriction takes effect
8341 - {{{kbd(C-c C-x >)}}} (~org-agenda-remove-restriction-lock~) ::
8344 #+findex: org-agenda-remove-restriction-lock
8345 Remove the permanent restriction created by {{{kbd(C-c C-x <)}}}.
8347 #+texinfo: @noindent
8348 When working with =speedbar.el=, you can use the following commands in
8351 - {{{kbd(<)}}} (~org-speedbar-set-agenda-restriction~) ::
8353 #+findex: org-speedbar-set-agenda-restriction
8354 Permanently restrict the agenda to the item---either an Org file
8355 or a subtree in such a file---at the cursor in the Speedbar
8356 frame. If there is a window displaying an agenda view, the new
8357 restriction takes effect immediately.
8359 - {{{kbd(>)}}} (~org-agenda-remove-restriction-lock~) ::
8361 #+findex: org-agenda-remove-restriction-lock
8362 Lift the restriction.
8364 ** The Agenda Dispatcher
8366 :DESCRIPTION: Keyboard access to agenda views.
8367 :ALT_TITLE: Agenda Dispatcher
8369 #+cindex: agenda dispatcher
8370 #+cindex: dispatching agenda commands
8372 The views are created through a dispatcher, accessible with {{{kbd(M-x
8373 org-agenda)}}}, or, better, bound to a global key (see [[*Activation]]).
8374 It displays a menu from which an additional letter is required to
8375 execute a command. The dispatcher offers the following default
8380 Create the calendar-like agenda (see [[*Weekly/daily agenda]]).
8382 - {{{kbd(t)}}} or {{{kbd(T)}}} ::
8384 Create a list of all TODO items (see [[*The global TODO list]]).
8386 - {{{kbd(m)}}} or {{{kbd(M)}}} ::
8388 Create a list of headlines matching a given expression (see
8389 [[*Matching tags and properties]]).
8393 #+kindex: s @r{(Agenda dispatcher)}
8394 Create a list of entries selected by a boolean expression of
8395 keywords and/or regular expressions that must or must not occur
8400 #+kindex: / @r{(Agenda dispatcher)}
8401 #+vindex: org-agenda-text-search-extra-files
8402 Search for a regular expression in all agenda files and
8403 additionally in the files listed in
8404 ~org-agenda-text-search-extra-files~. This uses the Emacs
8405 command ~multi-occur~. A prefix argument can be used to specify
8406 the number of context lines for each match, default is
8409 - {{{kbd(#)}}} or {{{kbd(!)}}} ::
8411 Create a list of stuck projects (see [[*Stuck projects]]).
8415 #+kindex: < @r{(Agenda dispatcher)}
8416 Restrict an agenda command to the current buffer[fn:89]. After
8417 pressing {{{kbd(<)}}}, you still need to press the character
8418 selecting the command.
8422 #+kindex: < < @r{(Agenda dispatcher)}
8423 If there is an active region, restrict the following agenda
8424 command to the region. Otherwise, restrict it to the current
8425 subtree[fn:90]. After pressing {{{kbd(< <)}}}, you still need to
8426 press the character selecting the command.
8430 #+kindex: * @r{(Agenda dispatcher)}
8431 #+vindex: org-agenda-sticky
8432 #+findex: org-toggle-sticky-agenda
8433 Toggle sticky agenda views. By default, Org maintains only
8434 a single agenda buffer and rebuilds it each time you change the
8435 view, to make sure everything is always up to date. If you
8436 switch between views often and the build time bothers you, you
8437 can turn on sticky agenda buffers (make this the default by
8438 customizing the variable ~org-agenda-sticky~). With sticky
8439 agendas, the dispatcher only switches to the selected view, you
8440 need to update it by hand with {{{kbd(r)}}} or {{{kbd(g)}}}. You
8441 can toggle sticky agenda view any time with
8442 ~org-toggle-sticky-agenda~.
8444 You can also define custom commands that are accessible through the
8445 dispatcher, just like the default commands. This includes the
8446 possibility to create extended agenda buffers that contain several
8447 blocks together, for example the weekly agenda, the global TODO list
8448 and a number of special tags matches. See [[*Custom Agenda Views]].
8450 ** The Built-in Agenda Views
8452 :DESCRIPTION: What is available out of the box?
8453 :ALT_TITLE: Built-in Agenda Views
8456 In this section we describe the built-in views.
8458 *** Weekly/daily agenda
8460 :DESCRIPTION: The calendar page with current tasks.
8463 #+cindex: weekly agenda
8464 #+cindex: daily agenda
8466 The purpose of the weekly/daily /agenda/ is to act like a page of
8467 a paper agenda, showing all the tasks for the current week or day.
8469 - {{{kbd(M-x org-agenda a)}}} (~org-agenda-list~) ::
8471 #+kindex: a @r{(Agenda dispatcher)}
8472 #+findex: org-agenda-list
8473 #+cindex: org-agenda, command
8474 Compile an agenda for the current week from a list of Org files.
8475 The agenda shows the entries for each day. With a numeric prefix
8476 argument[fn:91]---like {{{kbd(C-u 2 1 M-x org-agenda a)}}}---you
8477 may set the number of days to be displayed.
8479 #+vindex: org-agenda-span
8480 #+vindex: org-agenda-start-day
8481 #+vindex: org-agenda-start-on-weekday
8482 The default number of days displayed in the agenda is set by the
8483 variable ~org-agenda-span~. This variable can be set to any number of
8484 days you want to see by default in the agenda, or to a span name, such
8485 a ~day~, ~week~, ~month~ or ~year~. For weekly agendas, the default
8486 is to start on the previous Monday (see
8487 ~org-agenda-start-on-weekday~). You can also set the start date using
8488 a date shift: ~(setq org-agenda-start-day "+10d")~ starts the agenda
8489 ten days from today in the future.
8491 Remote editing from the agenda buffer means, for example, that you can
8492 change the dates of deadlines and appointments from the agenda buffer.
8493 The commands available in the Agenda buffer are listed in [[*Commands in
8494 the Agenda Buffer]].
8496 **** Calendar/Diary integration
8500 #+cindex: calendar integration
8501 #+cindex: diary integration
8503 Emacs contains the calendar and diary by Edward M. Reingold. The
8504 calendar displays a three-month calendar with holidays from different
8505 countries and cultures. The diary allows you to keep track of
8506 anniversaries, lunar phases, sunrise/set, recurrent appointments
8507 (weekly, monthly) and more. In this way, it is quite complementary to
8508 Org. It can be very useful to combine output from Org with the diary.
8510 In order to include entries from the Emacs diary into Org mode's
8511 agenda, you only need to customize the variable
8513 #+begin_src emacs-lisp
8514 (setq org-agenda-include-diary t)
8517 #+texinfo: @noindent
8518 After that, everything happens automatically. All diary entries
8519 including holidays, anniversaries, etc., are included in the agenda
8520 buffer created by Org mode. {{{kbd(SPC)}}}, {{{kbd(TAB)}}}, and
8521 {{{kbd(RET)}}} can be used from the agenda buffer to jump to the diary
8522 file in order to edit existing diary entries. The {{{kbd(i)}}}
8523 command to insert new entries for the current date works in the agenda
8524 buffer, as well as the commands {{{kbd(S)}}}, {{{kbd(M)}}}, and
8525 {{{kbd(C)}}} to display Sunrise/Sunset times, show lunar phases and to
8526 convert to other calendars, respectively. {{{kbd(c)}}} can be used to
8527 switch back and forth between calendar and agenda.
8529 If you are using the diary only for S-exp entries and holidays, it is
8530 faster to not use the above setting, but instead to copy or even move
8531 the entries into an Org file. Org mode evaluates diary-style sexp
8532 entries, and does it faster because there is no overhead for first
8533 creating the diary display. Note that the sexp entries must start at
8534 the left margin, no whitespace is allowed before them, as seen in the
8535 following segment of an Org file:[fn:92]
8542 %%(org-calendar-holiday) ; special function for holiday names
8548 %%(org-anniversary 1956 5 14) Arthur Dent is %d years old
8549 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
8552 **** Anniversaries from BBDB
8556 #+cindex: BBDB, anniversaries
8557 #+cindex: anniversaries, from BBDB
8559 #+findex: org-bbdb-anniversaries
8560 If you are using the Insidious Big Brother Database to store your
8561 contacts, you very likely prefer to store anniversaries in BBDB rather
8562 than in a separate Org or diary file. Org supports this and can show
8563 BBDB anniversaries as part of the agenda. All you need to do is to
8564 add the following to one of your agenda files:
8571 %%(org-bbdb-anniversaries)
8574 You can then go ahead and define anniversaries for a BBDB record.
8575 Basically, you need to press {{{kbd(C-o anniversary RET)}}} with the
8576 cursor in a BBDB record and then add the date in the format
8577 =YYYY-MM-DD= or =MM-DD=, followed by a space and the class of the
8578 anniversary (=birthday=, =wedding=, or a format string). If you omit
8579 the class, it defaults to =birthday=. Here are a few examples, the
8580 header for the file =org-bbdb.el= contains more detailed information.
8586 2008-04-14 %s released version 6.01 of Org mode, %d years ago
8589 After a change to BBDB, or for the first agenda display during an
8590 Emacs session, the agenda display suffers a short delay as Org updates
8591 its hash with anniversaries. However, from then on things will be
8592 very fast, much faster in fact than a long list of
8593 =%%(diary-anniversary)= entries in an Org or Diary file.
8595 #+findex: org-bbdb-anniversaries-future
8596 If you would like to see upcoming anniversaries with a bit of
8597 forewarning, you can use the following instead:
8604 %%(org-bbdb-anniversaries-future 3)
8607 That will give you three days' warning: on the anniversary date itself
8608 and the two days prior. The argument is optional: if omitted, it
8611 **** Appointment reminders
8615 #+cindex: @file{appt.el}
8616 #+cindex: appointment reminders
8617 #+cindex: appointment
8620 #+cindex: APPT_WARNTIME, keyword
8621 Org can interact with Emacs appointments notification facility. To
8622 add the appointments of your agenda files, use the command
8623 ~org-agenda-to-appt~. This command lets you filter through the list
8624 of your appointments and add only those belonging to a specific
8625 category or matching a regular expression. It also reads
8626 a =APPT_WARNTIME= property which overrides the value of
8627 ~appt-message-warning-time~ for this appointment. See the docstring
8630 *** The global TODO list
8632 :DESCRIPTION: All unfinished action items.
8633 :ALT_TITLE: Global TODO list
8635 #+cindex: global TODO list
8636 #+cindex: TODO list, global
8638 The global TODO list contains all unfinished TODO items formatted and
8639 collected into a single place.
8641 - {{{kbd(M-x org-agenda t)}}} (~org-todo-list~) ::
8643 #+kindex: t @r{(Agenda dispatcher)}
8644 #+findex: org-todo-list
8645 Show the global TODO list. This collects the TODO items from all
8646 agenda files (see [[*Agenda Views]]) into a single buffer. By
8647 default, this lists items with a state the is not a DONE state.
8648 The buffer is in ~agenda-mode~, so there are commands to examine
8649 and manipulate the TODO entries directly from that buffer (see
8650 [[*Commands in the Agenda Buffer]]).
8652 - {{{kbd(M-x org-agenda T)}}} (~org-todo-list~) ::
8654 #+kindex: T @r{(Agenda dispatcher)}
8655 #+findex: org-todo-list
8656 #+cindex: TODO keyword matching
8657 #+vindex: org-todo-keywords
8658 Like the above, but allows selection of a specific TODO keyword.
8659 You can also do this by specifying a prefix argument to
8660 {{{kbd(t)}}}. You are prompted for a keyword, and you may also
8661 specify several keywords by separating them with =|= as the
8662 boolean OR operator. With a numeric prefix, the Nth keyword in
8663 ~org-todo-keywords~ is selected.
8666 The {{{kbd(r)}}} key in the agenda buffer regenerates it, and you
8667 can give a prefix argument to this command to change the selected
8668 TODO keyword, for example {{{kbd(3 r)}}}. If you often need
8669 a search for a specific keyword, define a custom command for it
8670 (see [[*The Agenda Dispatcher]]).
8672 Matching specific TODO keywords can also be done as part of
8673 a tags search (see [[*Tag Searches]]).
8675 Remote editing of TODO items means that you can change the state of
8676 a TODO entry with a single key press. The commands available in the
8677 TODO list are described in [[*Commands in the Agenda Buffer]].
8679 #+cindex: sublevels, inclusion into TODO list
8680 Normally the global TODO list simply shows all headlines with TODO
8681 keywords. This list can become very long. There are two ways to keep
8685 #+vindex: org-agenda-todo-ignore-scheduled
8686 #+vindex: org-agenda-todo-ignore-deadlines
8687 #+vindex: org-agenda-todo-ignore-timestamp
8688 #+vindex: org-agenda-todo-ignore-with-date
8689 Some people view a TODO item that has been /scheduled/ for execution
8690 or have a /deadline/ (see [[*Timestamps, Deadlines and Scheduling]]) as
8691 no longer /open/. Configure the variables
8692 ~org-agenda-todo-ignore-scheduled~,
8693 ~org-agenda-todo-ignore-deadlines~,
8694 ~org-agenda-todo-ignore-timestamp~ and/or
8695 ~org-agenda-todo-ignore-with-date~ to exclude such items from the
8699 #+vindex: org-agenda-todo-list-sublevels
8700 TODO items may have sublevels to break up the task into subtasks.
8701 In such cases it may be enough to list only the highest level TODO
8702 headline and omit the sublevels from the global list. Configure the
8703 variable ~org-agenda-todo-list-sublevels~ to get this behavior.
8705 *** Matching tags and properties
8707 :DESCRIPTION: Structured information with fine-tuned search.
8709 #+cindex: matching, of tags
8710 #+cindex: matching, of properties
8712 #+cindex: match view
8714 If headlines in the agenda files are marked with /tags/ (see [[*Tags]]),
8715 or have properties (see [[*Properties and Columns]]), you can select
8716 headlines based on this metadata and collect them into an agenda
8717 buffer. The match syntax described here also applies when creating
8718 sparse trees with {{{kbd(C-c / m)}}}.
8720 - {{{kbd(M-x org-agenda m)}}} (~org-tags-view~) ::
8722 #+kindex: m @r{(Agenda dispatcher)}
8723 #+findex: org-tags-view
8724 Produce a list of all headlines that match a given set of tags.
8725 The command prompts for a selection criterion, which is a boolean
8726 logic expression with tags, like =+work+urgent-withboss= or
8727 =work|home= (see [[*Tags]]). If you often need a specific search,
8728 define a custom command for it (see [[*The Agenda Dispatcher]]).
8730 - {{{kbd(M-x org-agenda M)}}} (~org-tags-view~) ::
8732 #+kindex: M @r{(Agenda dispatcher)}
8733 #+findex: org-tags-view
8734 #+vindex: org-tags-match-list-sublevels
8735 #+vindex: org-agenda-tags-todo-honor-ignore-options
8736 Like {{{kbd(m)}}}, but only select headlines that are also TODO
8737 items and force checking subitems (see the variable
8738 ~org-tags-match-list-sublevels~). To exclude scheduled/deadline
8739 items, see the variable
8740 ~org-agenda-tags-todo-honor-ignore-options~. Matching specific
8741 TODO keywords together with a tags match is also possible, see
8744 The commands available in the tags list are described in [[*Commands in
8745 the Agenda Buffer]].
8747 #+cindex: boolean logic, for agenda searches
8748 A search string can use Boolean operators =&= for AND and =|= for OR.
8749 =&= binds more strongly than =|=. Parentheses are currently not
8750 implemented. Each element in the search is either a tag, a regular
8751 expression matching tags, or an expression like =PROPERTY OPERATOR
8752 VALUE= with a comparison operator, accessing a property value. Each
8753 element may be preceded by =-= to select against it, and =+= is
8754 syntactic sugar for positive selection. The AND operator =&= is
8755 optional when =+= or =-= is present. Here are some examples, using
8760 Select headlines tagged =work=, but discard those also tagged
8765 Selects lines tagged =work= or =laptop=.
8767 - ~work|laptop+night~ ::
8769 Like before, but require the =laptop= lines to be tagged
8772 #+cindex: regular expressions, with tags search
8773 Instead of a tag, you may also specify a regular expression enclosed
8774 in curly braces. For example, =work+{^boss.*}= matches headlines that
8775 contain the tag =:work:= and any tag /starting/ with =boss=.
8777 #+cindex: group tags, as regular expressions
8778 Group tags (see [[*Tag Hierarchy]]) are expanded as regular expressions.
8779 E.g., if =work= is a group tag for the group =:work:lab:conf:=, then
8780 searching for =work= also searches for ={\(?:work\|lab\|conf\)}= and
8781 searching for =-work= searches for all headlines but those with one of
8782 the tags in the group (i.e., =-{\(?:work\|lab\|conf\)}=).
8784 #+cindex: TODO keyword matching, with tags search
8785 #+cindex: level, for tags/property match
8786 #+cindex: category, for tags/property match
8787 #+vindex: org-odd-levels-only
8788 You may also test for properties (see [[*Properties and Columns]]) at the
8789 same time as matching tags. The properties may be real properties, or
8790 special properties that represent other metadata (see [[*Special
8791 Properties]]). For example, the property =TODO= represents the TODO
8792 keyword of the entry. Or, the property =LEVEL= represents the level
8793 of an entry. So searching =+LEVEL=3+boss-TODO​="DONE"= lists all level
8794 three headlines that have the tag =boss= and are /not/ marked with the
8795 TODO keyword =DONE=. In buffers with ~org-odd-levels-only~ set,
8796 =LEVEL= does not count the number of stars, but =LEVEL=2= corresponds
8799 Here are more examples:
8801 - =work+TODO​="WAITING"= ::
8803 Select =work=-tagged TODO lines with the specific TODO keyword
8806 - =work+TODO​="WAITING"|home+TODO​="WAITING"= ::
8808 Waiting tasks both at work and at home.
8810 When matching properties, a number of different operators can be used
8811 to test the value of a property. Here is a complex example:
8814 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2
8815 +With={Sarah|Denny}+SCHEDULED>="<2008-10-11>"
8818 #+texinfo: @noindent
8819 The type of comparison depends on how the comparison value is written:
8821 - If the comparison value is a plain number, a numerical comparison is
8822 done, and the allowed operators are =<=, ===, =>=, =<==, =>==, and
8825 - If the comparison value is enclosed in double-quotes, a string
8826 comparison is done, and the same operators are allowed.
8828 - If the comparison value is enclosed in double-quotes /and/ angular
8829 brackets (like =DEADLINE<​="<2008-12-24 18:30>"=), both values are
8830 assumed to be date/time specifications in the standard Org way, and
8831 the comparison is done accordingly. Valid values also include
8832 ="<now>"= for now (including time), ="<today>"=, and ="<tomorrow>"=
8833 for these days at 0:00 hours, i.e., without a time specification.
8834 You can also use strings like ="<+5d>"= or ="<-2m>"= with units =d=,
8835 =w=, =m=, and =y= for day, week, month, and year, respectively.
8837 - If the comparison value is enclosed in curly braces, a regexp match
8838 is performed, with === meaning that the regexp matches the property
8839 value, and =<>= meaning that it does not match.
8841 So the search string in the example finds entries tagged =work= but
8842 not =boss=, which also have a priority value =A=, a =Coffee= property
8843 with the value =unlimited=, an =EFFORT= property that is numerically
8844 smaller than 2, a =With= property that is matched by the regular
8845 expression =Sarah|Denny=, and that are scheduled on or after October
8848 You can configure Org mode to use property inheritance during
8849 a search, but beware that this can slow down searches considerably.
8850 See [[*Property Inheritance]], for details.
8852 For backward compatibility, and also for typing speed, there is also
8853 a different way to test TODO states in a search. For this, terminate
8854 the tags/property part of the search string (which may include several
8855 terms connected with =|=) with a =/= and then specify a Boolean
8856 expression just for TODO keywords. The syntax is then similar to that
8857 for tags, but should be applied with care: for example, a positive
8858 selection on several TODO keywords cannot meaningfully be combined
8859 with boolean AND. However, /negative selection/ combined with AND can
8860 be meaningful. To make sure that only lines are checked that actually
8861 have any TODO keyword (resulting in a speed-up), use {{{kbd(M-x
8862 org-agenda M)}}}, or equivalently start the TODO part after the slash
8863 with =!=. Using {{{kbd(M-x org-agenda M)}}} or =/!= does not match
8864 TODO keywords in a DONE state. Examples:
8868 Same as =work+TODO​="WAITING"=.
8870 - =work/!-WAITING-NEXT= ::
8872 Select =work=-tagged TODO lines that are neither =WAITING= nor
8875 - =work/!+WAITING|+NEXT= ::
8877 Select =work=-tagged TODO lines that are either =WAITING= or
8882 :DESCRIPTION: Find entries by searching for text.
8884 #+cindex: search view
8885 #+cindex: text search
8886 #+cindex: searching, for text
8888 This agenda view is a general text search facility for Org mode
8889 entries. It is particularly useful to find notes.
8891 - {{{kbd(M-x org-agenda s)}}} (~org-search-view~) ::
8893 #+kindex: s @r{(Agenda dispatcher)}
8894 #+findex: org-search-view
8895 This is a special search that lets you select entries by matching
8896 a substring or specific words using a boolean logic.
8898 For example, the search string =computer equipment= matches entries
8899 that contain =computer equipment= as a substring, even if the two
8900 words are separated by more space or a line break.
8902 Search view can also search for specific keywords in the entry, using
8903 Boolean logic. The search string =+computer
8904 +wifi -ethernet -{8\.11[bg]}= matches note entries that contain the
8905 keywords =computer= and =wifi=, but not the keyword =ethernet=, and
8906 which are also not matched by the regular expression =8\.11[bg]=,
8907 meaning to exclude both =8.11b= and =8.11g=. The first =+= is
8908 necessary to turn on boolean search, other =+= characters are
8909 optional. For more details, see the docstring of the command
8912 You can incrementally adjust a boolean search with the following keys
8914 #+attr_texinfo: :columns 0.1 0.6
8915 | {{{kbd([)}}} | Add a positive search word |
8916 | {{{kbd(])}}} | Add a negative search word |
8917 | {{{kbd({)}}} | Add a positive regular expression |
8918 | {{{kbd(})}}} | Add a negative regular expression |
8920 #+vindex: org-agenda-text-search-extra-files
8921 Note that in addition to the agenda files, this command also searches
8922 the files listed in ~org-agenda-text-search-extra-files~.
8926 :DESCRIPTION: Find projects you need to review.
8928 #+pindex: GTD, Getting Things Done
8930 If you are following a system like David Allen's GTD to organize your
8931 work, one of the "duties" you have is a regular review to make sure
8932 that all projects move along. A /stuck/ project is a project that has
8933 no defined next actions, so it never shows up in the TODO lists Org
8934 mode produces. During the review, you need to identify such projects
8935 and define next actions for them.
8937 - {{{kbd(M-x org-agenda #)}}} (~org-agenda-list-stuck-projects~) ::
8939 #+kindex: # @r{(Agenda dispatcher)}
8940 #+findex: org-agenda-list-stuck-projects
8941 List projects that are stuck.
8943 - {{{kbd(M-x org-agenda !)}}} ::
8945 #+kindex: ! @r{(Agenda dispatcher)}
8946 #+vindex: org-stuck-projects
8947 Customize the variable ~org-stuck-projects~ to define what
8948 a stuck project is and how to find it.
8950 You almost certainly need to configure this view before it works for
8951 you. The built-in default assumes that all your projects are level-2
8952 headlines, and that a project is not stuck if it has at least one
8953 entry marked with a TODO keyword =TODO= or =NEXT= or =NEXTACTION=.
8955 Let's assume that you, in your own way of using Org mode, identify
8956 projects with a tag =:PROJECT:=, and that you use a TODO keyword
8957 =MAYBE= to indicate a project that should not be considered yet.
8958 Let's further assume that the TODO keyword =DONE= marks finished
8959 projects, and that =NEXT= and =TODO= indicate next actions. The tag
8960 =:@shop:= indicates shopping and is a next action even without the
8961 NEXT tag. Finally, if the project contains the special word =IGNORE=
8962 anywhere, it should not be listed either. In this case you would
8963 start by identifying eligible projects with a tags/TODO match (see
8964 [[*Tag Searches]]) =+PROJECT/-MAYBE-DONE=, and then check for =TODO=,
8965 =NEXT=, =@shop=, and =IGNORE= in the subtree to identify projects that
8966 are not stuck. The correct customization for this is:
8968 #+begin_src emacs-lisp
8969 (setq org-stuck-projects
8970 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@shop")
8974 Note that if a project is identified as non-stuck, the subtree of this
8975 entry is searched for stuck projects.
8977 ** Presentation and Sorting
8979 :DESCRIPTION: How agenda items are prepared for display.
8981 #+cindex: presentation, of agenda items
8983 #+vindex: org-agenda-prefix-format
8984 #+vindex: org-agenda-tags-column
8985 Before displaying items in an agenda view, Org mode visually prepares
8986 the items and sorts them. Each item occupies a single line. The line
8987 starts with a /prefix/ that contains the /category/ (see [[*Categories]])
8988 of the item and other important information. You can customize in
8989 which column tags are displayed through ~org-agenda-tags-column~. You
8990 can also customize the prefix using the option
8991 ~org-agenda-prefix-format~. This prefix is followed by a cleaned-up
8992 version of the outline headline associated with the item.
8996 :DESCRIPTION: Not all tasks are equal.
8999 #+cindex: @samp{CATEGORY}, keyword
9001 The category is a broad label assigned to each agenda item. By
9002 default, the category is simply derived from the file name, but you
9003 can also specify it with a special line in the buffer, like
9006 : #+CATEGORY: Thesis
9008 #+texinfo: @noindent
9009 #+cindex: @samp{CATEGORY}, property
9010 If you would like to have a special category for a single entry or
9011 a (sub)tree, give the entry a =CATEGORY= property with the special
9012 category you want to apply as the value.
9014 #+texinfo: @noindent
9015 The display in the agenda buffer looks best if the category is not
9016 longer than 10 characters.
9018 #+texinfo: @noindent
9019 #+vindex: org-agenda-category-icon-alist
9020 You can set up icons for category by customizing the
9021 ~org-agenda-category-icon-alist~ variable.
9023 *** Time-of-day specifications
9025 :DESCRIPTION: How the agenda knows the time.
9027 #+cindex: time-of-day specification
9029 Org mode checks each agenda item for a time-of-day specification. The
9030 time can be part of the timestamp that triggered inclusion into the
9033 : <2005-05-10 Tue 19:00>
9035 #+texinfo: @noindent
9036 Time ranges can be specified with two timestamps:
9038 : <2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>
9040 In the headline of the entry itself, a time(range) may also appear as
9041 plain text (like =12:45= or a =8:30-1pm=). If the agenda integrates
9042 the Emacs diary (see [[*Weekly/daily agenda]]), time specifications in
9043 diary entries are recognized as well.
9045 For agenda display, Org mode extracts the time and displays it in
9046 a standard 24 hour format as part of the prefix. The example times in
9047 the previous paragraphs would end up in the agenda like this:
9050 8:30-13:00 Arthur Dent lies in front of the bulldozer
9051 12:45...... Ford Prefect arrives and takes Arthur to the pub
9052 19:00...... The Vogon reads his poem
9053 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
9057 If the agenda is in single-day mode, or for the display of today, the
9058 timed entries are embedded in a time grid, like
9061 8:00...... ------------------
9062 8:30-13:00 Arthur Dent lies in front of the bulldozer
9063 10:00...... ------------------
9064 12:00...... ------------------
9065 12:45...... Ford Prefect arrives and takes Arthur to the pub
9066 14:00...... ------------------
9067 16:00...... ------------------
9068 18:00...... ------------------
9069 19:00...... The Vogon reads his poem
9070 20:00...... ------------------
9071 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
9074 #+vindex: org-agenda-use-time-grid
9075 #+vindex: org-agenda-time-grid
9076 The time grid can be turned on and off with the variable
9077 ~org-agenda-use-time-grid~, and can be configured with
9078 ~org-agenda-time-grid~.
9080 *** Sorting of agenda items
9082 :DESCRIPTION: The order of things.
9084 #+cindex: sorting, of agenda items
9085 #+cindex: priorities, of agenda items
9087 Before being inserted into a view, the items are sorted. How this is
9088 done depends on the type of view.
9091 #+vindex: org-agenda-files
9092 For the daily/weekly agenda, the items for each day are sorted. The
9093 default order is to first collect all items containing an explicit
9094 time-of-day specification. These entries are shown at the beginning
9095 of the list, as a /schedule/ for the day. After that, items remain
9096 grouped in categories, in the sequence given by ~org-agenda-files~.
9097 Within each category, items are sorted by priority (see
9098 [[*Priorities]]), which is composed of the base priority (2000 for
9099 priority =A=, 1000 for =B=, and 0 for =C=), plus additional
9100 increments for overdue scheduled or deadline items.
9102 - For the TODO list, items remain in the order of categories, but
9103 within each category, sorting takes place according to priority (see
9104 [[*Priorities]]). The priority used for sorting derives from the
9105 priority cookie, with additions depending on how close an item is to
9106 its due or scheduled date.
9108 - For tags matches, items are not sorted at all, but just appear in
9109 the sequence in which they are found in the agenda files.
9111 #+vindex: org-agenda-sorting-strategy
9112 Sorting can be customized using the variable
9113 ~org-agenda-sorting-strategy~, and may also include criteria based on
9114 the estimated effort of an entry (see [[*Effort Estimates]]).
9116 *** Filtering/limiting agenda times
9118 :DESCRIPTION: Dynamically narrow the agenda.
9121 Agenda built-in or customized commands are statically defined. Agenda
9122 filters and limits provide two ways of dynamically narrowing down the
9123 list of agenda entries: /filters/ and /limits/. Filters only act on
9124 the display of the items, while limits take effect before the list of
9125 agenda entries is built. Filters are more often used interactively,
9126 while limits are mostly useful when defined as local variables within
9127 custom agenda commands.
9129 **** Filtering in the agenda
9133 #+cindex: agenda filtering
9134 #+cindex: filtering entries, in agenda
9135 #+cindex: tag filtering, in agenda
9136 #+cindex: category filtering, in agenda
9137 #+cindex: top headline filtering, in agenda
9138 #+cindex: effort filtering, in agenda
9139 #+cindex: query editing, in agenda
9141 - {{{kbd(/)}}} (~org-agenda-filter-by-tag~) ::
9143 #+findex: org-agenda-filter-by-tag
9144 #+vindex: org-agenda-tag-filter-preset
9145 Filter the agenda view with respect to a tag and/or effort
9146 estimates. The difference between this and a custom agenda
9147 command is that filtering is very fast, so that you can switch
9148 quickly between different filters without having to recreate the
9151 You are prompted for a tag selection letter; {{{kbd(SPC)}}} means
9152 any tag at all. Pressing {{{kbd(TAB)}}} at that prompt offers
9153 completion to select a tag, including any tags that do not have
9154 a selection character. The command then hides all entries that
9155 do not contain or inherit this tag. When called with prefix
9156 argument, remove the entries that /do/ have the tag. A second
9157 {{{kbd(/)}}} at the prompt turns off the filter and shows any
9158 hidden entries. Pressing {{{kbd(+)}}} or {{{kbd(-)}}} switches
9159 between filtering and excluding the next tag.
9161 #+vindex: org-agenda-auto-exclude-function
9162 Org also supports automatic, context-aware tag filtering. If the
9163 variable ~org-agenda-auto-exclude-function~ is set to
9164 a user-defined function, that function can decide which tags
9165 should be excluded from the agenda automatically. Once this is
9166 set, the {{{kbd(/)}}} command then accepts {{{kbd(RET)}}} as
9167 a sub-option key and runs the auto exclusion logic. For example,
9168 let's say you use a =Net= tag to identify tasks which need
9169 network access, an =Errand= tag for errands in town, and a =Call=
9170 tag for making phone calls. You could auto-exclude these tags
9171 based on the availability of the Internet, and outside of
9172 business hours, with something like this:
9174 #+begin_src emacs-lisp
9175 (defun org-my-auto-exclude-function (tag)
9177 ((string= tag "Net")
9178 (/= 0 (call-process "/sbin/ping" nil nil nil
9179 "-c1" "-q" "-t1" "mail.gnu.org")))
9180 ((or (string= tag "Errand") (string= tag "Call"))
9181 (let ((hour (nth 2 (decode-time))))
9182 (or (< hour 8) (> hour 21)))))
9185 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
9188 - {{{kbd(<)}}} (~org-agenda-filter-by-category~) ::
9190 #+findex: org-agenda-filter-by-category
9191 Filter the current agenda view with respect to the category of
9192 the item at point. Pressing {{{kbd(<)}}} another time removes
9193 this filter. When called with a prefix argument exclude the
9194 category of the item at point from the agenda.
9196 #+vindex: org-agenda-category-filter-preset
9197 You can add a filter preset in custom agenda commands through the
9198 option ~org-agenda-category-filter-preset~. See [[*Setting options
9199 for custom commands]].
9201 - {{{kbd(^)}}} (~org-agenda-filter-by-top-headline~) ::
9203 #+findex: org-agenda-filter-by-top-headline
9204 Filter the current agenda view and only display the siblings and
9205 the parent headline of the one at point.
9207 - {{{kbd(=)}}} (~org-agenda-filter-by-regexp~) ::
9209 #+findex: org-agenda-filter-by-regexp
9210 Filter the agenda view by a regular expression: only show agenda
9211 entries matching the regular expression the user entered. When
9212 called with a prefix argument, it filters /out/ entries matching
9213 the regexp. With two universal prefix arguments, it removes all
9214 the regexp filters, which can be accumulated.
9216 #+vindex: org-agenda-regexp-filter-preset
9217 You can add a filter preset in custom agenda commands through the
9218 option ~org-agenda-regexp-filter-preset~. See [[*Setting options
9219 for custom commands]].
9221 - {{{kbd(_)}}} (~org-agenda-filter-by-effort~) ::
9223 #+findex: org-agenda-filter-by-effort
9224 Filter the agenda view with respect to effort estimates. You
9225 first need to set up allowed efforts globally, for example
9227 #+begin_src emacs-lisp
9228 (setq org-global-properties
9229 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
9232 #+vindex: org-sort-agenda-noeffort-is-high
9233 You can then filter for an effort by first typing an operator,
9234 one of {{{kbd(<)}}}, {{{kbd(>)}}} and {{{kbd(=)}}}, and then the
9235 one-digit index of an effort estimate in your array of allowed
9236 values, where {{{kbd(0)}}} means the 10th value. The filter then
9237 restricts to entries with effort smaller-or-equal, equal, or
9238 larger-or-equal than the selected value. For application of the
9239 operator, entries without a defined effort are treated according
9240 to the value of ~org-sort-agenda-noeffort-is-high~.
9242 When called with a prefix argument, it removes entries matching
9243 the condition. With two universal prefix arguments, it clears
9244 effort filters, which can be accumulated.
9246 #+vindex: org-agenda-effort-filter-preset
9247 You can add a filter preset in custom agenda commands through the
9248 option ~org-agenda-effort-filter-preset~. See [[*Setting options
9249 for custom commands]].
9251 - {{{kbd(|)}}} (~org-agenda-filter-remove-all~) ::
9253 Remove all filters in the current agenda view.
9255 **** Setting limits for the agenda
9259 #+cindex: limits, in agenda
9261 Here is a list of options that you can set, either globally, or
9262 locally in your custom agenda views (see [[*Custom Agenda Views]]).
9264 - ~org-agenda-max-entries~ ::
9266 #+vindex: org-agenda-max-entries
9267 Limit the number of entries.
9269 - ~org-agenda-max-effort~ ::
9271 #+vindex: org-agenda-max-effort
9272 Limit the duration of accumulated efforts (as minutes).
9274 - ~org-agenda-max-todos~ ::
9276 #+vindex: org-agenda-max-todos
9277 Limit the number of entries with TODO keywords.
9279 - ~org-agenda-max-tags~ ::
9281 #+vindex: org-agenda-max-tags
9282 Limit the number of tagged entries.
9284 When set to a positive integer, each option excludes entries from
9285 other categories: for example, ~(setq org-agenda-max-effort 100)~
9286 limits the agenda to 100 minutes of effort and exclude any entry that
9287 has no effort property. If you want to include entries with no effort
9288 property, use a negative value for ~org-agenda-max-effort~. One
9289 useful setup is to use ~org-agenda-max-entries~ locally in a custom
9290 command. For example, this custom command displays the next five
9291 entries with a =NEXT= TODO keyword.
9293 #+begin_src emacs-lisp
9294 (setq org-agenda-custom-commands
9296 ((org-agenda-max-entries 5)))))
9299 Once you mark one of these five entry as DONE, rebuilding the agenda
9300 will again the next five entries again, including the first entry that
9301 was excluded so far.
9303 You can also dynamically set temporary limits, which are lost when
9304 rebuilding the agenda:
9306 - {{{kbd(~ )}}} (~org-agenda-limit-interactively~) ::
9308 #+findex: org-agenda-limit-interactively
9309 This prompts for the type of limit to apply and its value.
9311 ** Commands in the Agenda Buffer
9313 :DESCRIPTION: Remote editing of Org trees.
9314 :ALT_TITLE: Agenda Commands
9316 #+cindex: commands, in agenda buffer
9318 Entries in the agenda buffer are linked back to the Org file or diary
9319 file where they originate. You are not allowed to edit the agenda
9320 buffer itself, but commands are provided to show and jump to the
9321 original entry location, and to edit the Org files "remotely" from the
9322 agenda buffer. In this way, all information is stored only once,
9323 removing the risk that your agenda and note files may diverge.
9325 Some commands can be executed with mouse clicks on agenda lines. For
9326 the other commands, the cursor needs to be in the desired line.
9332 #+cindex: motion commands in agenda
9334 - {{{kbd(n)}}} (~org-agenda-next-line~) ::
9337 #+findex: org-agenda-next-line
9338 Next line (same as {{{kbd(DOWN)}}} and {{{kbd(C-n)}}}).
9340 - {{{kbd(p)}}} (~org-agenda-previous-line~) ::
9343 #+findex: org-agenda-previous-line
9344 Previous line (same as {{{kbd(UP)}}} and {{{kbd(C-p)}}}).
9346 *** View/Go to Org file
9350 #+cindex: view file commands in agenda
9352 - {{{kbd(SPC)}}} or {{{kbd(mouse-3)}}} (~org-agenda-show-and-scroll-up~) ::
9356 #+findex: org-agenda-show-and-scroll-up
9357 Display the original location of the item in another window.
9358 With a prefix argument, make sure that drawers stay folded.
9360 - {{{kbd(L)}}} (~org-agenda-recenter~) ::
9362 #+findex: org-agenda-recenter
9363 Display original location and recenter that window.
9365 - {{{kbd(TAB)}}} or {{{kbd(mouse-2)}}} (~org-agenda-goto~) ::
9369 #+findex: org-agenda-goto
9370 Go to the original location of the item in another window.
9372 - {{{kbd(RET)}}} (~org-agenda-switch-to~) ::
9375 #+findex: org-agenda-switch-to
9376 Go to the original location of the item and delete other windows.
9378 - {{{kbd(F)}}} (~org-agenda-follow-mode~) ::
9381 #+findex: org-agenda-follow-mode
9382 #+vindex: org-agenda-start-with-follow-mode
9383 Toggle Follow mode. In Follow mode, as you move the cursor
9384 through the agenda buffer, the other window always shows the
9385 corresponding location in the Org file. The initial setting for
9386 this mode in new agenda buffers can be set with the variable
9387 ~org-agenda-start-with-follow-mode~.
9389 - {{{kbd(C-c C-x b)}}} (~org-agenda-tree-to-indirect-buffer~) ::
9392 #+findex: org-agenda-tree-to-indirect-buffer
9393 Display the entire subtree of the current item in an indirect
9394 buffer. With a numeric prefix argument N, go up to level N and
9395 then take that tree. If N is negative, go up that many levels.
9396 With a {{{kbd(C-u)}}} prefix, do not remove the previously used
9399 - {{{kbd(C-c C-o)}}} (~org-agenda-open-link~) ::
9402 #+findex: org-agenda-open-link
9403 Follow a link in the entry. This offers a selection of any links
9404 in the text belonging to the referenced Org node. If there is
9405 only one link, follow it without a selection prompt.
9411 #+cindex: change agenda display
9412 #+cindex: display changing, in agenda
9414 #+attr_texinfo: :sep ,
9418 Interactively select another agenda view and append it to the
9424 Delete other windows.
9426 - {{{kbd(v d)}}} or short {{{kbd(d)}}} (~org-agenda-day-view~) ::
9430 #+findex: org-agenda-day-view
9431 Switch to day view. When switching to day view, this setting
9432 becomes the default for subsequent agenda refreshes. A numeric
9433 prefix argument may be used to jump directly to a specific day of
9434 the year. For example, {{{kbd(32 d)}}} jumps to February 1st.
9435 When setting day view, a year may be encoded in the prefix
9436 argument as well. For example, {{{kbd(200712 d)}}} jumps to
9437 January 12, 2007. If such a year specification has only one or
9438 two digits, it is expanded into one of the 30 next years or the
9441 - {{{kbd(v w)}}} or short {{{kbd(w)}}} (~org-agenda-week-view~) ::
9445 #+findex: org-agenda-week-view
9446 Switch to week view. When switching week view, this setting
9447 becomes the default for subsequent agenda refreshes. A numeric
9448 prefix argument may be used to jump directly to a specific day of
9449 the ISO week. For example {{{kbd(9 w)}}} to ISO week number 9.
9450 When setting week view, a year may be encoded in the prefix
9451 argument as well. For example, {{{kbd(200712 w)}}} jumps to week
9452 12 in 2007. If such a year specification has only one or two
9453 digits, it is expanded into one of the 30 next years or the last
9456 - {{{kbd(v m)}}} (~org-agenda-month-view~) ::
9459 #+findex: org-agenda-month-view
9460 Switch to month view. Because month views are slow to create,
9461 they do not become the default for subsequent agenda refreshes.
9462 A numeric prefix argument may be used to jump directly to
9463 a specific day of the month. When setting month view, a year may
9464 be encoded in the prefix argument as well. For example,
9465 {{{kbd(200712 m)}}} jumps to December, 2007. If such a year
9466 specification has only one or two digits, it is expanded into one
9467 of the 30 next years or the last 69 years.
9469 - {{{kbd(v y)}}} (~org-agenda-year-view~) ::
9472 #+findex: org-agenda-year-view
9473 Switch to year view. Because year views are slow to create, they
9474 do not become the default for subsequent agenda refreshes.
9475 A numeric prefix argument may be used to jump directly to
9476 a specific day of the year.
9478 - {{{kbd(v SPC)}}} (~org-agenda-reset-view~) ::
9481 #+findex: org-agenda-reset-view
9482 #+vindex: org-agenda-span
9483 Reset the current view to ~org-agenda-span~.
9485 - {{{kbd(f)}}} (~org-agenda-later~) ::
9488 #+findex: org-agenda-later
9489 Go forward in time to display the span following the current one.
9490 For example, if the display covers a week, switch to the
9491 following week. With a prefix argument, repeat that many times.
9493 - {{{kbd(b)}}} (~org-agenda-earlier~) ::
9496 #+findex: org-agenda-earlier
9497 Go backward in time to display earlier dates.
9499 - {{{kbd(.)}}} (~org-agenda-goto-today~) ::
9502 #+findex: org-agenda-goto-today
9505 - {{{kbd(j)}}} (~org-agenda-goto-date~) ::
9508 #+findex: org-agenda-goto-date
9509 Prompt for a date and go there.
9511 - {{{kbd(J)}}} (~org-agenda-clock-goto~) ::
9514 #+findex: org-agenda-clock-goto
9515 Go to the currently clocked-in task /in the agenda buffer/.
9517 - {{{kbd(D)}}} (~org-agenda-toggle-diary~) ::
9520 #+findex: org-agenda-toggle-diary
9521 Toggle the inclusion of diary entries. See [[*Weekly/daily agenda]].
9523 - {{{kbd(v l)}}} or {{{kbd(v L)}}} or short {{{kbd(l)}}} (~org-agenda-log-mode~) ::
9528 #+findex: org-agenda-log-mode
9529 #+vindex: org-log-done
9530 #+vindex: org-agenda-log-mode-items
9531 Toggle Logbook mode. In Logbook mode, entries that were marked
9532 DONE while logging was on (see the variable ~org-log-done~) are
9533 shown in the agenda, as are entries that have been clocked on
9534 that day. You can configure the entry types that should be
9535 included in log mode using the variable
9536 ~org-agenda-log-mode-items~. When called with a {{{kbd(C-u)}}}
9537 prefix, show all possible logbook entries, including state
9538 changes. When called with two prefix arguments {{{kbd(C-u
9539 C-u)}}}, show only logging information, nothing else. {{{kbd(v
9540 L)}}} is equivalent to {{{kbd(C-u v l)}}}.
9542 - {{{kbd(v [)}}} or short {{{kbd([)}}} (~org-agenda-manipulate-query-add~) ::
9546 #+findex: org-agenda-manipulate-query-add
9547 Include inactive timestamps into the current view. Only for
9548 weekly/daily agenda and timeline views.
9550 - {{{kbd(v a)}}} (~org-agenda-archives-mode~) ::
9553 #+findex: org-agenda-archives-mode
9554 Toggle Archives mode. In Archives mode, trees that are archived
9555 (see [[*Internal archiving]]) are also scanned when producing the
9556 agenda. To exit archives mode, press {{{kbd(v a)}}} again.
9561 Toggle Archives mode. Include all archive files as well.
9563 - {{{kbd(v R)}}} or short {{{kbd(R)}}} (~org-agenda-clockreport-mode~) ::
9567 #+findex: org-agenda-clockreport-mode
9568 #+vindex: org-agenda-start-with-clockreport-mode
9569 #+vindex: org-clock-report-include-clocking-task
9570 Toggle Clockreport mode. In Clockreport mode, the daily/weekly
9571 agenda always shows a table with the clocked times for the time
9572 span and file scope covered by the current agenda view. The
9573 initial setting for this mode in new agenda buffers can be set
9574 with the variable ~org-agenda-start-with-clockreport-mode~. By
9575 using a prefix argument when toggling this mode (i.e., {{{kbd(C-u
9576 R)}}}), the clock table does not show contributions from entries
9577 that are hidden by agenda filtering[fn:94]. See also the
9578 variable ~org-clock-report-include-clocking-task~.
9583 #+vindex: org-agenda-clock-consistency-checks
9584 Show overlapping clock entries, clocking gaps, and other clocking
9585 problems in the current agenda range. You can then visit
9586 clocking lines and fix them manually. See the variable
9587 ~org-agenda-clock-consistency-checks~ for information on how to
9588 customize the definition of what constituted a clocking problem.
9589 To return to normal agenda display, press {{{kbd(l)}}} to exit
9592 - {{{kbd(v E)}}} or short {{{kbd(E)}}} (~org-agenda-entry-text-mode~) ::
9596 #+findex: org-agenda-entry-text-mode
9597 #+vindex: org-agenda-start-with-entry-text-mode
9598 #+vindex: org-agenda-entry-text-maxlines
9599 Toggle entry text mode. In entry text mode, a number of lines
9600 from the Org outline node referenced by an agenda line are
9601 displayed below the line. The maximum number of lines is given
9602 by the variable ~org-agenda-entry-text-maxlines~. Calling this
9603 command with a numeric prefix argument temporarily modifies that
9604 number to the prefix value.
9606 - {{{kbd(G)}}} (~org-agenda-toggle-time-grid~) ::
9609 #+vindex: org-agenda-use-time-grid
9610 #+vindex: org-agenda-time-grid
9611 Toggle the time grid on and off. See also the variables
9612 ~org-agenda-use-time-grid~ and ~org-agenda-time-grid~.
9614 - {{{kbd(r)}}} (~org-agenda-redo~), {{{kbd(g)}}} ::
9618 #+findex: org-agenda-redo
9619 Recreate the agenda buffer, for example to reflect the changes
9620 after modification of the timestamps of items with
9621 {{{kbd(S-LEFT)}}} and {{{kbd(S-RIGHT)}}}. When the
9622 buffer is the global TODO list, a prefix argument is interpreted
9623 to create a selective list for a specific TODO keyword.
9625 - {{{kbd(C-x C-s)}}} or short {{{kbd(s)}}} (~org-save-all-org-buffers~) ::
9628 #+findex: org-save-all-org-buffers
9630 Save all Org buffers in the current Emacs session, and also the
9633 - {{{kbd(C-c C-x C-c)}}} (~org-agenda-columns~) ::
9635 #+kindex: C-c C-x C-c
9636 #+findex: org-agenda-columns
9637 #+vindex: org-columns-default-format
9638 Invoke column view (see [[*Column View]]) in the agenda buffer. The
9639 column view format is taken from the entry at point, or, if there
9640 is no entry at point, from the first entry in the agenda view.
9641 So whatever the format for that entry would be in the original
9642 buffer (taken from a property, from a =COLUMNS= keyword, or from
9643 the default variable ~org-columns-default-format~) is used in the
9646 - {{{kbd(C-c C-x >)}}} (~org-agenda-remove-restriction-lock~) ::
9649 #+findex: org-agenda-remove-restriction-lock
9650 Remove the restriction lock on the agenda, if it is currently
9651 restricted to a file or subtree (see [[*Agenda Files]]).
9653 - {{{kbd(M-UP)}}} (~org-agenda-drag-line-backward~) ::
9656 #+findex: org-agenda-drag-line-backward
9657 Drag the line at point backward one line. With a numeric prefix
9658 argument, drag backward by that many lines.
9660 Moving agenda lines does not persist after an agenda refresh and
9661 does not modify the contributing Org files.
9663 - {{{kbd(M-DOWN)}}} (~org-agenda-drag-line-forward~) ::
9666 #+findex: org-agenda-drag-line-forward
9667 Drag the line at point forward one line. With a numeric prefix
9668 argument, drag forward by that many lines.
9674 #+cindex: remote editing, from agenda
9676 - {{{kbd(0--9)}}} ::
9680 - {{{kbd(C-_)}}} (~org-agenda-undo~) ::
9683 #+findex: org-agenda-undo
9684 #+cindex: undoing remote-editing events
9685 #+cindex: remote editing, undo
9686 Undo a change due to a remote editing command. The change is
9687 undone both in the agenda buffer and in the remote buffer.
9689 - {{{kbd(t)}}} (~org-agenda-todo~) ::
9692 #+findex: org-agenda-todo
9693 Change the TODO state of the item, both in the agenda and in the
9696 - {{{kbd(C-S-RIGHT)}}} (~org-agenda-todo-nextset~) ::
9699 #+findex: org-agenda-todo-nextset
9700 Switch to the next set of TODO keywords.
9702 - {{{kbd(C-S-LEFT)}}}, ~org-agenda-todo-previousset~ ::
9705 Switch to the previous set of TODO keywords.
9707 - {{{kbd(C-k)}}} (~org-agenda-kill~) ::
9710 #+findex: org-agenda-kill
9711 #+vindex: org-agenda-confirm-kill
9712 Delete the current agenda item along with the entire subtree
9713 belonging to it in the original Org file. If the text to be
9714 deleted remotely is longer than one line, the kill needs to be
9715 confirmed by the user. See variable ~org-agenda-confirm-kill~.
9717 - {{{kbd(C-c C-w)}}} (~org-agenda-refile~) ::
9720 #+findex: org-agenda-refile
9721 Refile the entry at point.
9723 - {{{kbd(C-c C-x C-a)}}} or short {{{kbd(a)}}} (~org-agenda-archive-default-with-confirmation~) ::
9725 #+kindex: C-c C-x C-a
9727 #+findex: org-agenda-archive-default-with-confirmation
9728 #+vindex: org-archive-default-command
9729 Archive the subtree corresponding to the entry at point using the
9730 default archiving command set in ~org-archive-default-command~.
9731 When using the {{{kbd(a)}}} key, confirmation is required.
9733 - {{{kbd(C-c C-x a)}}} (~org-agenda-toggle-archive-tag~) ::
9736 #+findex: org-agenda-toggle-archive-tag
9737 Toggle the archive tag (see [[*Internal archiving]]) for the current
9740 - {{{kbd(C-c C-x A)}}} (~org-agenda-archive-to-archive-sibling~) ::
9743 #+findex: org-agenda-archive-to-archive-sibling
9744 Move the subtree corresponding to the current entry to its
9747 - {{{kbd(C-c C-x C-s)}}} or short {{{kbd($)}}} (~org-agenda-archive~) ::
9749 #+kindex: C-c C-x C-s
9751 #+findex: org-agenda-archive
9752 Archive the subtree corresponding to the current headline. This
9753 means the entry is moved to the configured archive location, most
9754 likely a different file.
9756 - {{{kbd(T)}}} (~org-agenda-show-tags~) ::
9759 #+findex: org-agenda-show-tags
9760 #+vindex: org-agenda-show-inherited-tags
9761 Show all tags associated with the current item. This is useful
9762 if you have turned off ~org-agenda-show-inherited-tags~, but
9763 still want to see all tags of a headline occasionally.
9765 - {{{kbd(:)}}} (~org-agenda-set-tags~) ::
9768 #+findex: org-agenda-set-tags
9769 Set tags for the current headline. If there is an active region
9770 in the agenda, change a tag for all headings in the region.
9772 - {{{kbd(\,)}}} (~org-agenda-priority~) ::
9775 #+findex: org-agenda-priority
9776 Set the priority for the current item. Org mode prompts for the
9777 priority character. If you reply with {{{kbd(SPC)}}}, the
9778 priority cookie is removed from the entry.
9780 - {{{kbd(P)}}} (~org-agenda-show-priority~) ::
9783 #+findex: org-agenda-show-priority
9784 Display weighted priority of current item.
9786 - {{{kbd(+)}}} or {{{kbd(S-UP)}}} (~org-agenda-priority-up~) ::
9790 #+findex: org-agenda-priority-up
9791 Increase the priority of the current item. The priority is
9792 changed in the original buffer, but the agenda is not resorted.
9793 Use the {{{kbd(r)}}} key for this.
9795 - {{{kbd(-)}}} or {{{kbd(S-DOWN)}}} (~org-agenda-priority-down~) ::
9799 #+findex: org-agenda-priority-down
9800 Decrease the priority of the current item.
9802 - {{{kbd(C-c C-z)}}} or short {{{kbd(z)}}} (~org-agenda-add-note~) ::
9806 #+findex: org-agenda-add-note
9807 #+vindex: org-log-into-drawer
9808 Add a note to the entry. This note is recorded, and then filed
9809 to the same location where state change notes are put. Depending
9810 on ~org-log-into-drawer~, this may be inside a drawer.
9812 - {{{kbd(C-c C-a)}}} (~org-attach~) ::
9815 #+findex: org-attach
9816 Dispatcher for all command related to attachments.
9818 - {{{kbd(C-c C-s)}}} (~org-agenda-schedule~) ::
9821 #+findex: org-agenda-schedule
9822 Schedule this item. With a prefix argument, remove the
9823 scheduling timestamp
9825 - {{{kbd(C-c C-d)}}} (~org-agenda-deadline~) ::
9828 #+findex: org-agenda-deadline
9829 Set a deadline for this item. With a prefix argument, remove the
9832 - {{{kbd(S-RIGHT)}}} (~org-agenda-do-date-later~) ::
9835 #+findex: org-agenda-do-date-later
9836 Change the timestamp associated with the current line by one day
9837 into the future. If the date is in the past, the first call to
9838 this command moves it to today. With a numeric prefix argument,
9839 change it by that many days. For example, {{{kbd(3
9840 6 5 S-RIGHT)}}} changes it by a year. With a {{{kbd(C-u)}}}
9841 prefix, change the time by one hour. If you immediately repeat
9842 the command, it will continue to change hours even without the
9843 prefix argument. With a double {{{kbd(C-u C-u)}}} prefix, do the
9844 same for changing minutes. The stamp is changed in the original
9845 Org file, but the change is not directly reflected in the agenda
9846 buffer. Use {{{kbd(r)}}} or {{{kbd(g)}}} to update the buffer.
9848 - {{{kbd(S-LEFT)}}} (~org-agenda-do-date-earlier~) ::
9851 #+findex: org-agenda-do-date-earlier
9852 Change the timestamp associated with the current line by one day
9855 - {{{kbd(>)}}} (~org-agenda-date-prompt~) ::
9858 #+findex: org-agenda-date-prompt
9859 Change the timestamp associated with the current line. The key
9860 {{{kbd(>)}}} has been chosen, because it is the same as
9861 {{{kbd(S-.)}}} on my keyboard.
9863 - {{{kbd(I)}}} (~org-agenda-clock-in~) ::
9866 #+findex: org-agenda-clock-in
9867 Start the clock on the current item. If a clock is running
9868 already, it is stopped first.
9870 - {{{kbd(O)}}} (~org-agenda-clock-out~) ::
9873 #+findex: org-agenda-clock-out
9874 Stop the previously started clock.
9876 - {{{kbd(X)}}} (~org-agenda-clock-cancel~) ::
9879 #+findex: org-agenda-clock-cancel
9880 Cancel the currently running clock.
9882 - {{{kbd(J)}}} (~org-agenda-clock-goto~) ::
9885 #+findex: org-agenda-clock-goto
9886 Jump to the running clock in another window.
9888 - {{{kbd(k)}}} (~org-agenda-capture~) ::
9891 #+findex: org-agenda-capture
9892 #+cindex: capturing, from agenda
9893 #+vindex: org-capture-use-agenda-date
9894 Like ~org-capture~, but use the date at point as the default date
9895 for the capture template. See ~org-capture-use-agenda-date~ to
9896 make this the default behavior of ~org-capture~.
9898 *** Bulk remote editing selected entries
9902 #+cindex: remote editing, bulk, from agenda
9903 #+vindex: org-agenda-bulk-custom-functions
9905 - {{{kbd(m)}}} (~org-agenda-bulk-mark~) ::
9907 #+findex: org-agenda-bulk-mark
9909 Mark the entry at point for bulk action. If there is an active
9910 region in the agenda, mark the entries in the region. With
9911 numeric prefix argument, mark that many successive entries.
9913 - {{{kbd(*)}}} (~org-agenda-bulk-mark-all~) ::
9915 #+findex: org-agenda-bulk-mark-all
9917 Mark all visible agenda entries for bulk action.
9919 - {{{kbd(u)}}} (~org-agenda-bulk-unmark~) ::
9921 #+findex: org-agenda-bulk-unmark
9923 Unmark entry for bulk action.
9925 - {{{kbd(U)}}} (~org-agenda-bulk-remove-all-marks~) ::
9927 #+findex: org-agenda-bulk-remove-all-marks
9929 Unmark all marked entries for bulk action.
9931 - {{{kbd(M-m)}}} (~org-agenda-bulk-toggle~) ::
9933 #+findex: org-agenda-bulk-toggle
9935 Toggle mark of the entry at point for bulk action.
9937 - {{{kbd(M-*)}}} (~org-agenda-bulk-toggle-all~) ::
9939 #+findex: org-agenda-bulk-toggle-all
9941 Mark entries matching a regular expression for bulk action.
9943 - {{{kbd(%)}}} (~org-agenda-bulk-mark-regexp~) ::
9945 #+findex: org-agenda-bulk-mark-regexp
9947 Mark entries matching a regular expression for bulk action.
9949 - {{{kbd(B)}}} (~org-agenda-bulk-action~) ::
9951 #+findex: org-agenda-bulk-action
9952 #+vindex: org-agenda-bulk-persistent-marks
9954 Bulk action: act on all marked entries in the agenda. This
9955 prompts for another key to select the action to be applied. The
9956 prefix argument to {{{kbd(B)}}} is passed through to the
9957 {{{kbd(s)}}} and {{{kbd(d)}}} commands, to bulk-remove these
9958 special timestamps. By default, marks are removed after the
9959 bulk. If you want them to persist, set
9960 ~org-agenda-bulk-persistent-marks~ to ~t~ or hit {{{kbd(p)}}} at
9965 Toggle persistent marks.
9969 Archive all selected entries.
9973 Archive entries by moving them to their respective archive
9978 Change TODO state. This prompts for a single TODO keyword and
9979 changes the state of all selected entries, bypassing blocking
9980 and suppressing logging notes---but not timestamps.
9984 Add a tag to all selected entries.
9988 Remove a tag from all selected entries.
9992 Schedule all items to a new date. To shift existing schedule
9993 dates by a fixed number of days, use something starting with
9994 double plus at the prompt, for example =++8d= or =++2w=.
9998 Set deadline to a specific date.
10002 Prompt for a single refile target and move all entries. The
10003 entries are no longer in the agenda; refresh ({{{kbd(g)}}}) to
10008 Reschedule randomly into the coming N days. N is prompted for.
10009 With a prefix argument ({{{kbd(C-u B S)}}}), scatter only
10014 #+vindex: org-agenda-bulk-custom-functions
10015 Apply a function[fn:95] to marked entries. For example, the
10016 function below sets the =CATEGORY= property of the entries to
10019 #+begin_src emacs-lisp
10020 (defun set-category ()
10022 (let ((marker (or (org-get-at-bol 'org-hd-marker)
10023 (org-agenda-error))))
10024 (org-with-point-at marker
10025 (org-back-to-heading t)
10026 (org-set-property "CATEGORY" "web"))))
10029 *** Calendar commands
10033 #+cindex: calendar commands, from agenda
10035 - {{{kbd(c)}}} (~org-agenda-goto-calendar~) ::
10038 #+findex: org-agenda-goto-calendar
10039 Open the Emacs calendar and move to the date at the agenda
10042 - {{{kbd(c)}}} (~org-calendar-goto-agenda~) ::
10045 #+findex: org-calendar-goto-agenda
10046 When in the calendar, compute and show the Org agenda for the
10047 date at the cursor.
10049 - {{{kbd(i)}}} (~org-agenda-diary-entry~) ::
10051 #+findex: org-agenda-diary-entry
10053 #+cindex: diary entries, creating from agenda
10054 Insert a new entry into the diary, using the date at the cursor
10055 and (for block entries) the date at the mark. This adds to the
10056 Emacs diary file[fn:96], in a way similar to the {{{kbd(i)}}}
10057 command in the calendar. The diary file pops up in another
10058 window, where you can add the entry.
10060 #+vindex: org-agenda-diary-file
10061 If you configure ~org-agenda-diary-file~ to point to an Org file,
10062 Org creates entries in that file instead. Most entries are
10063 stored in a date-based outline tree that will later make it easy
10064 to archive appointments from previous months/years. The tree is
10065 built under an entry with a =DATE_TREE= property, or else with
10066 years as top-level entries. Emacs prompts you for the entry
10067 text---if you specify it, the entry is created in
10068 ~org-agenda-diary-file~ without further interaction. If you
10069 directly press {{{kbd(RET)}}} at the prompt without typing text,
10070 the target file is shown in another window for you to finish the
10071 entry there. See also the {{{kbd(k r)}}} command.
10073 - {{{kbd(M)}}} (~org-agenda-phases-of-moon~) ::
10076 #+findex: org-agenda-phases-of-moon
10077 Show the phases of the moon for the three months around current
10080 - {{{kbd(S)}}} (~org-agenda-sunrise-sunset~) ::
10083 #+findex: org-agenda-sunrise-sunset
10084 Show sunrise and sunset times. The geographical location must be
10085 set with calendar variables, see the documentation for the Emacs
10088 - {{{kbd(C)}}} (~org-agenda-convert-date~) ::
10091 #+findex: org-agenda-convert-date
10092 Convert the date at cursor into many other cultural and historic
10095 - {{{kbd(H)}}} (~org-agenda-holidays~) ::
10098 #+findex: org-agenda-holidays
10099 Show holidays for three months around the cursor date.
10106 - {{{kbd(q)}}} (~org-agenda-quit~) ::
10108 #+findex: org-agenda-quit
10110 Quit agenda, remove the agenda buffer.
10112 - {{{kbd(x)}}} (~org-agenda-exit~) ::
10114 #+findex: org-agenda-exit
10116 #+cindex: agenda files, removing buffers
10117 Exit agenda, remove the agenda buffer and all buffers loaded by
10118 Emacs for the compilation of the agenda. Buffers created by the
10119 user to visit Org files are not removed.
10121 ** Custom Agenda Views
10123 :DESCRIPTION: Defining special searches and views.
10125 #+cindex: custom agenda views
10126 #+cindex: agenda views, custom
10128 Custom agenda commands serve two purposes: to store and quickly access
10129 frequently used TODO and tags searches, and to create special
10130 composite agenda buffers. Custom agenda commands are accessible
10131 through the dispatcher (see [[*The Agenda Dispatcher]]), just like the
10134 *** Storing searches
10136 :DESCRIPTION: Type once, use often.
10139 The first application of custom searches is the definition of keyboard
10140 shortcuts for frequently used searches, either creating an agenda
10141 buffer, or a sparse tree (the latter covering of course only the
10144 #+kindex: C @r{(Agenda dispatcher)}
10145 #+vindex: org-agenda-custom-commands
10146 #+cindex: agenda views, main example
10147 #+cindex: agenda, as an agenda views
10148 #+cindex: agenda*, as an agenda views
10149 #+cindex: tags, as an agenda view
10150 #+cindex: todo, as an agenda view
10151 #+cindex: tags-todo
10152 #+cindex: todo-tree
10153 #+cindex: occur-tree
10154 #+cindex: tags-tree
10155 Custom commands are configured in the variable
10156 ~org-agenda-custom-commands~. You can customize this variable, for
10157 example by pressing {{{kbd(C)}}} from the agenda dispatcher (see [[*The
10158 Agenda Dispatcher]]). You can also directly set it with Emacs Lisp in
10159 the Emacs init file. The following example contains all valid agenda
10162 #+begin_src emacs-lisp
10163 (setq org-agenda-custom-commands
10166 ("w" todo "WAITING")
10167 ("W" todo-tree "WAITING")
10168 ("u" tags "+boss-urgent")
10169 ("v" tags-todo "+boss-urgent")
10170 ("U" tags-tree "+boss-urgent")
10171 ("f" occur-tree "\\<FIXME\\>")
10172 ("h" . "HOME+Name tags searches") ;description for "h" prefix
10173 ("hl" tags "+home+Lisa")
10174 ("hp" tags "+home+Peter")
10175 ("hk" tags "+home+Kim")))
10178 #+texinfo: @noindent
10179 The initial string in each entry defines the keys you have to press
10180 after the dispatcher command in order to access the command. Usually
10181 this will be just a single character, but if you have many similar
10182 commands, you can also define two-letter combinations where the first
10183 character is the same in several combinations and serves as a prefix
10184 key[fn:97]. The second parameter is the search type, followed by the
10185 string or regular expression to be used for the matching. The example
10186 above will therefore define:
10190 as a global search for agenda entries planned[fn:98] this
10195 as the same search, but only for entries with an hour
10196 specification like =[h]h:mm=---think of them as appointments.
10200 as a global search for TODO entries with =WAITING= as the TODO
10205 as the same search, but only in the current buffer and displaying
10206 the results as a sparse tree.
10210 as a global tags search for headlines tagged =boss= but not
10215 The same search, but limiting it to headlines that are also TODO
10220 as the same search, but only in the current buffer and displaying
10221 the result as a sparse tree.
10225 to create a sparse tree (again, current buffer only) with all
10226 entries containing the word =FIXME=.
10230 as a prefix command for a =HOME= tags search where you have to
10231 press an additional key ({{{kbd(l)}}}, {{{kbd(p)}}} or
10232 {{{kbd(k)}}}) to select a name (Lisa, Peter, or Kim) as
10233 additional tag to match.
10235 Note that ~*-tree~ agenda views need to be called from an Org buffer
10236 as they operate on the current buffer only.
10240 :DESCRIPTION: All the stuff you need in a single buffer.
10242 #+cindex: block agenda
10243 #+cindex: agenda, with block views
10245 Another possibility is the construction of agenda views that comprise
10246 the results of /several/ commands, each of which creates a block in
10247 the agenda buffer. The available commands include ~agenda~ for the
10248 daily or weekly agenda (as created with {{{kbd(a)}}}) , ~alltodo~ for
10249 the global TODO list (as constructed with {{{kbd(t)}}}), and the
10250 matching commands discussed above: ~todo~, ~tags~, and ~tags-todo~.
10251 Here are two examples:
10253 #+begin_src emacs-lisp
10254 (setq org-agenda-custom-commands
10255 '(("h" "Agenda and Home-related tasks"
10259 ("o" "Agenda and Office-related tasks"
10262 (tags "office")))))
10265 #+texinfo: @noindent
10266 This defines {{{kbd(h)}}} to create a multi-block view for stuff you
10267 need to attend to at home. The resulting agenda buffer contains your
10268 agenda for the current week, all TODO items that carry the tag =home=,
10269 and also all lines tagged with =garden=. Finally the command
10270 {{{kbd(o)}}} provides a similar view for office tasks.
10272 *** Setting options for custom commands
10274 :DESCRIPTION: Changing the rules.
10275 :ALT_TITLE: Setting options
10277 #+cindex: options, for custom agenda views
10279 #+vindex: org-agenda-custom-commands
10280 Org mode contains a number of variables regulating agenda construction
10281 and display. The global variables define the behavior for all agenda
10282 commands, including the custom commands. However, if you want to
10283 change some settings just for a single custom view, you can do so.
10284 Setting options requires inserting a list of variable names and values
10285 at the right spot in ~org-agenda-custom-commands~. For example:
10287 #+begin_src emacs-lisp
10288 (setq org-agenda-custom-commands
10289 '(("w" todo "WAITING"
10290 ((org-agenda-sorting-strategy '(priority-down))
10291 (org-agenda-prefix-format " Mixed: ")))
10292 ("U" tags-tree "+boss-urgent"
10293 ((org-show-context-detail 'minimal)))
10295 ((org-agenda-files '("~org/notes.org"))
10296 (org-agenda-text-search-extra-files nil)))))
10299 #+texinfo: @noindent
10300 Now the {{{kbd(w)}}} command sorts the collected entries only by
10301 priority, and the prefix format is modified to just say =Mixed:=
10302 instead of giving the category of the entry. The sparse tags tree of
10303 {{{kbd(U)}}} now turns out ultra-compact, because neither the headline
10304 hierarchy above the match, nor the headline following the match are
10305 shown. The command {{{kbd(N)}}} does a text search limited to only
10308 For command sets creating a block agenda, ~org-agenda-custom-commands~
10309 has two separate spots for setting options. You can add options that
10310 should be valid for just a single command in the set, and options that
10311 should be valid for all commands in the set. The former are just
10312 added to the command entry; the latter must come after the list of
10313 command entries. Going back to the block agenda example (see [[*Block
10314 agenda]]), let's change the sorting strategy for the {{{kbd(h)}}}
10315 commands to ~priority-down~, but let's sort the results for GARDEN
10316 tags query in the opposite order, ~priority-up~. This would look like
10319 #+begin_src emacs-lisp
10320 (setq org-agenda-custom-commands
10321 '(("h" "Agenda and Home-related tasks"
10325 ((org-agenda-sorting-strategy '(priority-up)))))
10326 ((org-agenda-sorting-strategy '(priority-down))))
10327 ("o" "Agenda and Office-related tasks"
10330 (tags "office")))))
10333 As you see, the values and parentheses setting is a little complex.
10334 When in doubt, use the customize interface to set this variable---it
10335 fully supports its structure. Just one caveat: when setting options
10336 in this interface, the /values/ are just Lisp expressions. So if the
10337 value is a string, you need to add the double-quotes around the value
10340 #+vindex: org-agenda-custom-commands-contexts
10341 To control whether an agenda command should be accessible from
10342 a specific context, you can customize
10343 ~org-agenda-custom-commands-contexts~. Let's say for example that you
10344 have an agenda command {{{kbd(o)}}} displaying a view that you only
10345 need when reading emails. Then you would configure this option like
10348 #+begin_src emacs-lisp
10349 (setq org-agenda-custom-commands-contexts
10350 '(("o" (in-mode . "message-mode"))))
10353 You can also tell that the command key {{{kbd(o)}}} should refer to
10354 another command key {{{kbd(r)}}}. In that case, add this command key
10357 #+begin_src emacs-lisp
10358 (setq org-agenda-custom-commands-contexts
10359 '(("o" "r" (in-mode . "message-mode"))))
10362 See the docstring of the variable for more information.
10364 ** Exporting Agenda Views
10366 :DESCRIPTION: Writing a view to a file.
10368 #+cindex: agenda views, exporting
10370 If you are away from your computer, it can be very useful to have
10371 a printed version of some agenda views to carry around. Org mode can
10372 export custom agenda views as plain text, HTML[fn:99], Postscript,
10373 PDF[fn:100], and iCalendar files. If you want to do this only
10374 occasionally, use the following command:
10376 - {{{kbd(C-x C-w)}}} (~org-agenda-write~) ::
10378 #+findex: org-agenda-write
10379 #+cindex: exporting agenda views
10380 #+cindex: agenda views, exporting
10382 #+vindex: org-agenda-exporter-settings
10383 Write the agenda view to a file.
10385 If you need to export certain agenda views frequently, you can
10386 associate any custom agenda command with a list of output file
10387 names[fn:101]. Here is an example that first defines custom commands
10388 for the agenda and the global TODO list, together with a number of
10389 files to which to export them. Then we define two block agenda
10390 commands and specify file names for them as well. File names can be
10391 relative to the current working directory, or absolute.
10393 #+begin_src emacs-lisp
10394 (setq org-agenda-custom-commands
10395 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
10396 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
10397 ("h" "Agenda and Home-related tasks"
10402 ("~/views/home.html"))
10403 ("o" "Agenda and Office-related tasks"
10408 ("~/views/office.ps" "~/calendars/office.ics"))))
10411 The extension of the file name determines the type of export. If it
10412 is =.html=, Org mode uses the htmlize package to convert the buffer to
10413 HTML and save it to this file name. If the extension is =.ps=,
10414 ~ps-print-buffer-with-faces~ is used to produce Postscript output. If
10415 the extension is =.ics=, iCalendar export is run export over all files
10416 that were used to construct the agenda, and limit the export to
10417 entries listed in the agenda. Any other extension produces a plain
10420 The export files are /not/ created when you use one of those
10421 commands interactively because this might use too much overhead.
10422 Instead, there is a special command to produce /all/ specified
10425 - {{{kbd(e)}}} (~org-store-agenda-views~) ::
10427 #+kindex: e @r{(Agenda dispatcher)}
10428 #+findex: org-store-agenda-views
10429 Export all agenda views that have export file names associated
10432 You can use the options section of the custom agenda commands to also
10433 set options for the export commands. For example:
10435 #+begin_src emacs-lisp
10436 (setq org-agenda-custom-commands
10438 ((ps-number-of-columns 2)
10439 (ps-landscape-mode t)
10440 (org-agenda-prefix-format " [ ] ")
10441 (org-agenda-with-colors nil)
10442 (org-agenda-remove-tags t))
10443 ("theagenda.ps"))))
10446 #+texinfo: @noindent
10447 #+vindex: org-agenda-exporter-settings
10448 This command sets two options for the Postscript exporter, to make it
10449 print in two columns in landscape format---the resulting page can be
10450 cut in two and then used in a paper agenda. The remaining settings
10451 modify the agenda prefix to omit category and scheduling information,
10452 and instead include a checkbox to check off items. We also remove the
10453 tags to make the lines compact, and we do not want to use colors for
10454 the black-and-white printer. Settings specified in
10455 ~org-agenda-exporter-settings~ also apply, e.g.,
10457 #+begin_src emacs-lisp
10458 (setq org-agenda-exporter-settings
10459 '((ps-number-of-columns 2)
10460 (ps-landscape-mode t)
10461 (org-agenda-add-entry-text-maxlines 5)
10462 (htmlize-output-type 'css)))
10465 #+texinfo: @noindent
10466 but the settings in ~org-agenda-custom-commands~ take precedence.
10468 #+texinfo: @noindent
10469 From the command line you may also use:
10472 emacs -eval (org-batch-store-agenda-views) -kill
10475 #+texinfo: @noindent
10476 or, if you need to modify some parameters[fn:102]
10479 emacs -eval '(org-batch-store-agenda-views \
10480 org-agenda-span (quote month) \
10481 org-agenda-start-day "2007-11-01" \
10482 org-agenda-include-diary nil \
10483 org-agenda-files (quote ("~/org/project.org")))' \
10487 #+texinfo: @noindent
10488 which creates the agenda views restricted to the file
10489 =~/org/project.org=, without diary entries and with a 30-day extent.
10491 You can also extract agenda information in a way that allows further
10492 processing by other programs. See [[*Extracting Agenda Information]], for
10495 ** Using Column View in the Agenda
10497 :DESCRIPTION: Using column view for collected entries.
10498 :ALT_TITLE: Agenda Column View
10500 #+cindex: column view, in agenda
10501 #+cindex: agenda, column view
10503 Column view (see [[*Column View]]) is normally used to view and edit
10504 properties embedded in the hierarchical structure of an Org file. It
10505 can be quite useful to use column view also from the agenda, where
10506 entries are collected by certain criteria.
10508 - {{{kbd(C-c C-x C-c)}}} (~org-agenda-columns~) ::
10509 #+kindex: C-c C-x C-c
10510 #+findex: org-agenda-columns
10512 Turn on column view in the agenda.
10514 To understand how to use this properly, it is important to realize
10515 that the entries in the agenda are no longer in their proper outline
10516 environment. This causes the following issues:
10519 #+vindex: org-columns-default-format
10520 #+vindex: org-overriding-columns-format
10521 Org needs to make a decision which columns format to use. Since
10522 the entries in the agenda are collected from different files, and
10523 different files may have different columns formats, this is
10524 a non-trivial problem. Org first checks if the variable
10525 ~org-agenda-overriding-columns-format~ is currently set, and if so,
10526 takes the format from there. Otherwise it takes the format
10527 associated with the first item in the agenda, or, if that item does
10528 not have a specific format (defined in a property, or in its file),
10529 it uses ~org-columns-default-format~.
10532 #+cindex: @samp{CLOCKSUM}, special property
10533 If any of the columns has a summary type defined (see [[*Column
10534 attributes]]), turning on column view in the agenda visits all
10535 relevant agenda files and make sure that the computations of this
10536 property are up to date. This is also true for the special
10537 =CLOCKSUM= property. Org then sums the values displayed in the
10538 agenda. In the daily/weekly agenda, the sums cover a single day;
10539 in all other views they cover the entire block.
10541 It is important to realize that the agenda may show the same entry
10542 /twice/---for example as scheduled and as a deadline---and it may
10543 show two entries from the same hierarchy (for example a /parent/
10544 and its /child/). In these cases, the summation in the agenda
10545 leads to incorrect results because some values count double.
10547 3. When the column view in the agenda shows the =CLOCKSUM= property,
10548 that is always the entire clocked time for this item. So even in
10549 the daily/weekly agenda, the clocksum listed in column view may
10550 originate from times outside the current view. This has the
10551 advantage that you can compare these values with a column listing
10552 the planned total effort for a task---one of the major
10553 applications for column view in the agenda. If you want
10554 information about clocked time in the displayed period use clock
10555 table mode (press {{{kbd(R)}}} in the agenda).
10558 #+cindex: @samp{CLOCKSUM_T}, special property
10559 When the column view in the agenda shows the =CLOCKSUM_T= property,
10560 that is always today's clocked time for this item. So even in the
10561 weekly agenda, the clocksum listed in column view only originates
10562 from today. This lets you compare the time you spent on a task for
10563 today, with the time already spent---via =CLOCKSUM=---and with
10564 the planned total effort for it.
10566 * Markup for Rich Export
10568 :DESCRIPTION: Prepare text for rich export.
10572 When exporting Org documents, the exporter tries to reflect the
10573 structure of the document as accurately as possible in the back-end.
10574 Since export targets like HTML and LaTeX allow much richer formatting,
10575 Org mode has rules on how to prepare text for rich export. This
10576 section summarizes the markup rules used in an Org mode buffer.
10580 :DESCRIPTION: The basic unit of text.
10582 #+cindex: paragraphs, markup rules
10584 Paragraphs are separated by at least one empty line. If you need to
10585 enforce a line break within a paragraph, use ~\\~ at the end of
10588 To preserve the line breaks, indentation and blank lines in a region,
10589 but otherwise use normal formatting, you can use this construct, which
10590 can also be used to format poetry.
10592 #+cindex: @samp{BEGIN_VERSE}
10593 #+cindex: verse blocks
10596 Great clouds overhead
10597 Tiny black birds rise and fall
10604 When quoting a passage from another document, it is customary to
10605 format this as a paragraph that is indented on both the left and the
10606 right margin. You can include quotations in Org documents like this:
10608 #+cindex: @samp{BEGIN_QUOTE}
10609 #+cindex: quote blocks
10612 Everything should be made as simple as possible,
10613 but not any simpler ---Albert Einstein
10617 If you would like to center some text, do it like this:
10619 #+cindex: @samp{BEGIN_CENTER}
10620 #+cindex: center blocks
10623 Everything should be made as simple as possible, \\
10624 but not any simpler
10628 ** Emphasis and Monospace
10630 :DESCRIPTION: Bold, italic, etc.
10632 #+cindex: underlined text, markup rules
10633 #+cindex: bold text, markup rules
10634 #+cindex: italic text, markup rules
10635 #+cindex: verbatim text, markup rules
10636 #+cindex: code text, markup rules
10637 #+cindex: strike-through text, markup rules
10639 You can make words =*bold*=, =/italic/=, =_underlined_=, ==verbatim==
10640 and =~code~=, and, if you must, =+strike-through+=. Text in the code
10641 and verbatim string is not processed for Org mode specific syntax; it
10642 is exported verbatim.
10644 #+vindex: org-fontify-emphasized-text
10645 To turn off fontification for marked up text, you can set
10646 ~org-fontify-emphasized-text~ to ~nil~. To narrow down the list of
10647 available markup syntax, you can customize ~org-emphasis-alist~.
10649 ** Horizontal Rules
10651 :DESCRIPTION: Make a line.
10653 #+cindex: horizontal rules, markup rules
10655 A line consisting of only dashes, and at least 5 of them, is exported
10656 as a horizontal line.
10658 ** Images and Tables
10660 :DESCRIPTION: Images, tables and caption mechanism.
10662 #+cindex: tables, markup rules
10663 #+cindex: @samp{CAPTION}, keyword
10664 #+cindex: @samp{NAME}, keyword
10666 Both the native Org mode tables (see [[*Tables]]) and tables formatted
10667 with the =table.el= package are exported properly. For Org mode
10668 tables, the lines before the first horizontal separator line become
10669 table header lines. You can use the following lines somewhere before
10670 the table to assign a caption and a label for cross references, and in
10671 the text you can refer to the object with =[[tab:basic-data]]= (see
10672 [[*Internal Links]]):
10675 ,#+CAPTION: This is the caption for the next table (or link)
10676 ,#+NAME: tab:basic-data
10681 Optionally, the caption can take the form:
10683 : #+CAPTION[Caption for list of tables]: Caption for table.
10685 #+cindex: inlined images, markup rules
10686 Some back-ends allow you to directly include images into the exported
10687 document. Org does this, if a link to an image file does not have
10688 a description part, for example =[[./img/a.jpg]]=. If you wish to define
10689 a caption for the image and maybe a label for internal cross
10690 references, make sure that the link is on a line by itself and precede
10691 it with =CAPTION= and =NAME= keywords as follows:
10694 ,#+CAPTION: This is the caption for the next figure link (or table)
10695 ,#+NAME: fig:SED-HR4049
10699 #+texinfo: @noindent
10700 Such images can be displayed within the buffer. See [[*Handling Links][the discussion of
10703 Even though images and tables are prominent examples of captioned
10704 structures, the same caption mechanism can apply to many
10705 others---e.g., LaTeX equations, source code blocks. Depending on the
10706 export back-end, those may or may not be handled.
10708 ** Literal Examples
10710 :DESCRIPTION: Source code examples with special formatting.
10712 #+cindex: literal examples, markup
10713 #+cindex: code line references, markup
10715 You can include literal examples that should not be subjected to
10716 markup. Such examples are typeset in monospace, so this is well
10717 suited for source code and similar examples.
10719 #+cindex: @samp{BEGIN_EXAMPLE}
10720 #+cindex: example block
10723 Some example from a text file.
10727 Note that such blocks may be /indented/ in order to align nicely with
10728 indented text and in particular with plain list structure (see
10729 [[*Plain Lists]]). For simplicity when using small examples, you can
10730 also start the example lines with a colon followed by a space. There
10731 may also be additional whitespace before the colon:
10735 : Some example from a text file.
10738 #+cindex: formatting source code, markup rules
10739 #+vindex: org-latex-listings
10740 If the example is source code from a programming language, or any
10741 other text that can be marked up by Font Lock in Emacs, you can ask
10742 for the example to look like the fontified Emacs buffer[fn:103]. This
10743 is done with the code block, where you also need to specify the name
10744 of the major mode that should be used to fontify the example[fn:104],
10745 see [[*Structure Templates]] for shortcuts to easily insert code blocks.
10747 #+cindex: @samp{BEGIN_SRC}
10748 #+cindex: src block
10750 ,#+BEGIN_SRC emacs-lisp
10751 (defun org-xor (a b)
10757 Both in =example= and in =src= snippets, you can add a =-n= switch to
10758 the end of the =#+BEGIN= line, to get the lines of the example
10759 numbered. The =-n= takes an optional numeric argument specifying the
10760 starting line number of the block. If you use a =+n= switch, the
10761 numbering from the previous numbered snippet is continued in the
10762 current one. The =+n= switch can also take a numeric argument. This
10763 adds the value of the argument to the last line of the previous block
10764 to determine the starting line number.
10767 ,#+BEGIN_SRC emacs-lisp -n 20
10768 ;; This exports with line number 20.
10769 (message "This is line 21")
10772 ,#+BEGIN_SRC emacs-lisp +n 10
10773 ;; This is listed as line 31.
10774 (message "This is line 32")
10778 In literal examples, Org interprets strings like =(ref:name)= as
10779 labels, and use them as targets for special hyperlinks like
10780 =[[(name)]]=---i.e., the reference name enclosed in single parenthesis.
10781 In HTML, hovering the mouse over such a link remote-highlights the
10782 corresponding code line, which is kind of cool.
10784 You can also add a =-r= switch which /removes/ the labels from the
10785 source code[fn:105]. With the =-n= switch, links to these references
10786 are labeled by the line numbers from the code listing. Otherwise
10787 links use the labels with no parentheses. Here is an example:
10789 #+begin_example -l "(dumb-reference:%s)"
10790 ,#+BEGIN_SRC emacs-lisp -n -r
10791 (save-excursion (ref:sc)
10792 (goto-char (point-min)) (ref:jump)
10794 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
10795 jumps to point-min.
10798 #+cindex: indentation, in source blocks
10799 Finally, you can use =-i= to preserve the indentation of a specific
10800 code block (see [[*Editing Source Code]]).
10802 #+vindex: org-coderef-label-format
10803 If the syntax for the label format conflicts with the language syntax,
10804 use a =-l= switch to change the format, for example
10806 : #+BEGIN_SRC pascal -n -r -l "((%s))"
10808 #+texinfo: @noindent
10809 See also the variable ~org-coderef-label-format~.
10811 HTML export also allows examples to be published as text areas (see
10812 [[*Text areas in HTML export]]).
10814 Because the =#+BEGIN= ... =#+END= patterns need to be added so often,
10815 a shortcut is provided (see [[*Structure Templates]]).
10817 - {{{kbd(C-c ')}}} (~org-edit-special~) ::
10820 #+findex: org-edit-special
10821 Edit the source code example at point in its native mode. This
10822 works by switching to a temporary buffer with the source code.
10823 You need to exit by pressing {{{kbd(C-c ')}}} again[fn:106]. The
10824 edited version then replaces the old version in the Org buffer.
10825 Fixed-width regions---where each line starts with a colon
10826 followed by a space---are edited using ~artist-mode~[fn:107] to
10827 allow creating ASCII drawings easily. Using this command in an
10828 empty line creates a new fixed-width region.
10830 #+cindex: storing link, in a source code buffer
10831 Calling ~org-store-link~ (see [[*Handling Links]]) while editing a source
10832 code example in a temporary buffer created with {{{kbd(C-c ')}}}
10833 prompts for a label. Make sure that it is unique in the current
10834 buffer, and insert it with the proper formatting like =(ref:label)= at
10835 the end of the current line. Then the label is stored as a link
10836 =(label)=, for retrieval with {{{kbd(C-c C-l)}}}.
10840 :DESCRIPTION: Greek letters and other symbols.
10842 #+cindex: math symbols
10843 #+cindex: special symbols
10844 #+cindex: @TeX{} macros
10845 #+cindex: @LaTeX{} fragments, markup rules
10846 #+cindex: HTML entities
10847 #+cindex: @LaTeX{} entities
10849 You can use LaTeX-like syntax to insert special symbols---named
10850 entities---like =\alpha= to indicate the Greek letter, or =\to= to indicate
10851 an arrow. Completion for these symbols is available, just type =\=
10852 and maybe a few letters, and press {{{kbd(M-TAB)}}} to see possible
10853 completions. If you need such a symbol inside a word, terminate it
10854 with a pair of curly brackets. For example
10857 Pro tip: Given a circle \Gamma of diameter d, the length of its
10858 circumference is \pi{}d.
10861 #+findex: org-entities-help
10862 #+vindex: org-entities-user
10863 A large number of entities is provided, with names taken from both
10864 HTML and LaTeX; you can comfortably browse the complete list from
10865 a dedicated buffer using the command ~org-entities-help~. It is also
10866 possible to provide your own special symbols in the variable
10867 ~org-entities-user~.
10869 During export, these symbols are transformed into the native format of
10870 the exporter back-end. Strings like =\alpha= are exported as =α= in
10871 the HTML output, and as =\(\alpha\)= in the LaTeX output. Similarly, =\nbsp=
10872 becomes = = in HTML and =~= in LaTeX.
10874 #+cindex: escaping characters
10875 Entities may also be used as a way to escape markup in an Org
10876 document, e.g., =\under{}not underlined\under= exports as =_not underlined_=.
10878 #+cindex: special symbols, in-buffer display
10879 If you would like to see entities displayed as UTF-8 characters, use
10880 the following command[fn:108]:
10882 - {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) ::
10883 #+kindex: C-c C-x \
10884 #+findex: org-toggle-pretty-entities
10886 Toggle display of entities as UTF-8 characters. This does not
10887 change the buffer content which remains plain ASCII, but it
10888 overlays the UTF-8 character for display purposes only.
10890 #+cindex: shy hyphen, special symbol
10891 #+cindex: dash, special symbol
10892 #+cindex: ellipsis, special symbol
10893 In addition to regular entities defined above, Org exports in
10894 a special way[fn:109] the following commonly used character
10895 combinations: =\-= is treated as a shy hyphen, =--= and =---= are
10896 converted into dashes, and =...= becomes a compact set of dots.
10898 ** Subscripts and Superscripts
10900 :DESCRIPTION: Simple syntax for raising/lowering text.
10902 #+cindex: subscript
10903 #+cindex: superscript
10905 =^= and =_= are used to indicate super- and subscripts. To increase
10906 the readability of ASCII text, it is not necessary, but OK, to
10907 surround multi-character sub- and superscripts with curly braces. For
10911 The radius of the sun is R_sun = 6.96 x 10^8 m. On the other hand,
10912 the radius of Alpha Centauri is R_{Alpha Centauri} = 1.28 x R_{sun}.
10915 #+vindex: org-use-sub-superscripts
10916 If you write a text where the underscore is often used in a different
10917 context, Org's convention to always interpret these as subscripts can
10918 get in your way. Configure the variable ~org-use-sub-superscripts~ to
10919 change this convention. For example, when setting this variable to
10920 ~{}~, =a_b= is not interpreted as a subscript, but =a_{b}= is.
10922 - {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~~) ::
10923 #+kindex: C-c C-x \
10924 #+findex: org-toggle-pretty-entities
10926 In addition to showing entities as UTF-8 characters, this command
10927 also formats sub- and superscripts in a WYSIWYM way.
10931 :DESCRIPTION: LaTeX can be freely used inside Org documents.
10933 #+cindex: @TeX{} interpretation
10934 #+cindex: @LaTeX{} interpretation
10936 Plain ASCII is normally sufficient for almost all note taking.
10937 Exceptions include scientific notes, which often require mathematical
10938 symbols and the occasional formula. LaTeX[fn:110] is widely used to
10939 typeset scientific documents. Org mode supports embedding LaTeX code
10940 into its files, because many academics are used to writing and reading
10941 LaTeX source code, and because it can be readily processed to produce
10942 pretty output for a number of export back-ends.
10944 *** LaTeX fragments
10946 :DESCRIPTION: Complex formulas made easy.
10948 #+cindex: @LaTeX{} fragments
10950 #+vindex: org-format-latex-header
10951 Org mode can contain LaTeX math fragments, and it supports ways to
10952 process these for several export back-ends. When exporting to LaTeX,
10953 the code is left as it is. When exporting to HTML, Org can use either
10954 [[http://www.mathjax.org][MathJax]] (see [[*Math formatting in HTML export]]) or transcode the math
10955 into images (see [[*Previewing LaTeX fragments]]).
10957 LaTeX fragments do not need any special marking at all. The following
10958 snippets are identified as LaTeX source code:
10960 - Environments of any kind[fn:111]. The only requirement is that the
10961 =\begin= statement appears on a new line, preceded by only
10964 - Text within the usual LaTeX math delimiters. To avoid conflicts
10965 with currency specifications, single =$= characters are only
10966 recognized as math delimiters if the enclosed text contains at most
10967 two line breaks, is directly attached to the =$= characters with no
10968 whitespace in between, and if the closing =$= is followed by
10969 whitespace, punctuation or a dash. For the other delimiters, there
10970 is no such restriction, so when in doubt, use =\(...\)= as inline
10973 #+texinfo: @noindent
10977 \begin{equation} % arbitrary environments,
10978 x=\sqrt{b} % even tables, figures
10979 \end{equation} % etc
10981 If $a^2=b$ and \( b=2 \), then the solution must be
10982 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
10985 #+vindex: org-export-with-latex
10986 LaTeX processing can be configured with the variable
10987 ~org-export-with-latex~. The default setting is ~t~ which means
10988 MathJax for HTML, and no processing for ASCII and LaTeX back-ends.
10989 You can also set this variable on a per-file basis using one of these
10992 | =#+OPTIONS: tex:t= | Do the right thing automatically (MathJax) |
10993 | =#+OPTIONS: tex:nil= | Do not process LaTeX fragments at all |
10994 | =#+OPTIONS: tex:verbatim= | Verbatim export, for jsMath or so |
10996 *** Previewing LaTeX fragments
10998 :DESCRIPTION: What will this snippet look like?
11000 #+cindex: @LaTeX{} fragments, preview
11002 #+vindex: org-preview-latex-default-process
11003 If you have a working LaTeX installation and =dvipng=, =dvisvgm= or
11004 =convert= installed[fn:112], LaTeX fragments can be processed to
11005 produce images of the typeset expressions to be used for inclusion
11006 while exporting to HTML (see [[*LaTeX fragments]]), or for inline
11007 previewing within Org mode.
11009 #+vindex: org-format-latex-options
11010 #+vindex: org-format-latex-header
11011 You can customize the variables ~org-format-latex-options~ and
11012 ~org-format-latex-header~ to influence some aspects of the preview.
11013 In particular, the ~:scale~ (and for HTML export, ~:html-scale~)
11014 property of the former can be used to adjust the size of the preview
11017 - {{{kbd(C-c C-x C-l)}}} (~org-toggle-latex-fragment~) ::
11018 #+kindex: C-c C-x C-l
11019 #+findex: org-toggle-latex-fragment
11021 Produce a preview image of the LaTeX fragment at point and
11022 overlay it over the source code. If there is no fragment at
11023 point, process all fragments in the current entry (between two
11024 headlines). When called with a prefix argument, process the
11025 entire subtree. When called with two prefix arguments, or when
11026 the cursor is before the first headline, process the entire
11029 #+vindex: org-startup-with-latex-preview
11030 You can turn on the previewing of all LaTeX fragments in a file with
11032 : #+STARTUP: latexpreview
11034 To disable it, simply use
11036 : #+STARTUP: nolatexpreview
11038 *** Using CDLaTeX to enter math
11040 :DESCRIPTION: Speed up entering of formulas.
11041 :ALT_TITLE: CDLaTeX mode
11043 #+cindex: CD@LaTeX{}
11045 CDLaTeX mode is a minor mode that is normally used in combination with
11046 a major LaTeX mode like AUCTeX in order to speed-up insertion of
11047 environments and math templates. Inside Org mode, you can make use of
11048 some of the features of CDLaTeX mode. You need to install
11049 =cdlatex.el= and =texmathp.el= (the latter comes also with AUCTeX)
11050 from [[http://www.astro.uva.nl/~dominik/Tools/cdlatex]]. Do not use
11051 CDLaTeX mode itself under Org mode, but use the light version
11052 ~org-cdlatex-mode~ that comes as part of Org mode. Turn it on for the
11053 current buffer with {{{kbd(M-x org-cdlatex-mode)}}}, or for all Org
11056 #+begin_src emacs-lisp
11057 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
11060 When this mode is enabled, the following features are present (for
11061 more details see the documentation of CDLaTeX mode):
11063 #+attr_texinfo: :sep ,
11064 - {{{kbd(C-c {)}}} ::
11067 Insert an environment template.
11069 - {{{kbd(TAB)}}} ::
11072 The {{{kbd(TAB)}}} expands the template if the cursor is inside
11073 a LaTeX fragment[fn:113]. For example, {{{kbd(TAB)}}} expands
11074 =fr= to =\frac{}{}= and position the cursor correctly inside the
11075 first brace. Another {{{kbd(TAB)}}} gets you into the second
11078 Even outside fragments, {{{kbd(TAB)}}} expands environment
11079 abbreviations at the beginning of a line. For example, if you
11080 write =equ= at the beginning of a line and press {{{kbd(TAB)}}},
11081 this abbreviation is expanded to an =equation= environment. To
11082 get a list of all abbreviations, type {{{kbd(M-x
11083 cdlatex-command-help)}}}.
11085 - {{{kbd(^)}}}, {{{kbd(_)}}} ::
11088 #+vindex: cdlatex-simplify-sub-super-scripts
11090 Pressing {{{kbd(_)}}} and {{{kbd(^)}}} inside a LaTeX fragment
11091 inserts these characters together with a pair of braces. If you
11092 use {{{kbd(TAB)}}} to move out of the braces, and if the braces
11093 surround only a single character or macro, they are removed again
11094 (depending on the variable ~cdlatex-simplify-sub-super-scripts~).
11099 Pressing the backquote followed by a character inserts math
11100 macros, also outside LaTeX fragments. If you wait more than 1.5
11101 seconds after the backquote, a help window pops up.
11106 Pressing the single-quote followed by another character modifies
11107 the symbol before point with an accent or a font. If you wait
11108 more than 1.5 seconds after the single-quote, a help window pops
11109 up. Character modification works only inside LaTeX fragments;
11110 outside the quote is normal.
11114 :DESCRIPTION: Sharing and publishing notes.
11116 #+cindex: exporting
11118 Sometimes, you may want to pretty print your notes, publish them on
11119 the web or even share them with people not using Org. In these cases,
11120 the Org export facilities can be used to convert your documents to
11121 a variety of other formats, while retaining as much structure (see
11122 [[*Document Structure]]) and markup (see [[*Markup for Rich Export]]) as
11125 #+cindex: export back-end
11126 Libraries responsible for such translation are called back-ends. Org
11127 ships with the following ones
11129 - /ascii/ (ASCII format)
11130 - /beamer/ (LaTeX Beamer format)
11131 - /html/ (HTML format)
11132 - /icalendar/ (iCalendar format)
11133 - /latex/ (LaTeX format)
11134 - /md/ (Markdown format)
11135 - /odt/ (OpenDocument Text format)
11136 - /org/ (Org format)
11137 - /texinfo/ (Texinfo format)
11138 - /man/ (Man page format)
11140 #+texinfo: @noindent
11141 Org also uses additional libraries located in =contrib/= directory
11142 (see [[*Installation]]). Users can install additional export libraries
11143 for additional formats from the Emacs packaging system. For easy
11144 discovery, these packages have a common naming scheme: ~ox-NAME~,
11145 where {{{var(NAME)}}} is one of the formats. For example,
11146 ~ox-koma-letter~ /koma-letter/ back-end.
11148 #+vindex: org-export-backends
11149 Org loads back-ends for the following formats by default: ASCII, HTML,
11150 iCalendar, LaTeX and ODT. Org can load additional back-ends either of
11151 two ways: through the ~org-export-backends~ variable configuration;
11152 or, by requiring the library in the Emacs init file like this:
11154 #+begin_src emacs-lisp
11158 ** The Export Dispatcher
11160 :DESCRIPTION: The main interface.
11162 #+cindex: dispatcher, for export commands
11163 #+cindex: Export, dispatcher
11165 The export dispatcher is the main interface for Org's exports.
11166 A hierarchical menu presents the currently configured export formats.
11167 Options are shown as easy toggle switches on the same screen.
11169 #+vindex: org-export-dispatch-use-expert-ui
11170 Org also has a minimal prompt interface for the export dispatcher.
11171 When the variable ~org-export-dispatch-use-expert-ui~ is set to
11172 a non-~nil~ value, Org prompts in the minibuffer. To switch back to
11173 the hierarchical menu, press {{{kbd(?)}}}.
11175 - {{{kbd(C-c C-e)}}} (~org-export~) ::
11177 #+findex: org-export
11179 Invokes the export dispatcher interface. The options show
11180 default settings. The {{{kbd(C-u)}}} prefix argument preserves
11181 options from the previous export, including any sub-tree
11184 Org exports the entire buffer by default. If the Org buffer has an
11185 active region, then Org exports just that region.
11187 Within the dispatcher interface, the following key combinations can
11188 further alter what is exported, and how.
11190 - {{{kbd(C-a)}}} ::
11191 #+kindex: C-c C-e C-a
11193 Toggle asynchronous export. Asynchronous export uses an external
11194 Emacs process with a specially configured initialization file to
11195 complete the exporting process in the background thereby
11196 releasing the current interface. This is particularly useful
11197 when exporting long documents.
11199 Output from an asynchronous export is saved on the "the export
11200 stack". To view this stack, call the export dispatcher with
11201 a double {{{kbd(C-u)}}} prefix argument. If already in the
11202 export dispatcher menu, {{{kbd(&)}}} displays the stack.
11204 #+vindex: org-export-async-init-file
11205 To make the background export process the default, customize the
11206 variable, ~org-export-in-background~. Additionally, you can set
11207 the initialization file used by the background process with
11208 ~org-export-async-init-file~.
11210 #+vindex: org-export-in-background
11211 You can make asynchronous export the default by setting
11212 ~org-export-in-background~.
11214 - {{{kbd(C-b)}}} ::
11215 #+kindex: C-c C-e C-b
11217 Toggle body-only export. Useful for excluding headers and
11218 footers in the export. Affects only those back-end formats that
11219 have such sections---like =<head>...</head>= in HTML.
11222 #+kindex: C-c C-e C-s
11224 Toggle sub-tree export. When turned on, Org exports only the
11225 sub-tree starting from the cursor position at the time the export
11226 dispatcher was invoked. Org uses the top heading of this
11227 sub-tree as the document's title. If the cursor is not on
11228 a heading, Org uses the nearest enclosing header. If the cursor
11229 is in the document preamble, Org signals an error and aborts
11232 #+vindex: org-export-initial-scope
11233 To make the sub-tree export the default, customize the variable
11234 ~org-export-initial-scope~.
11236 - {{{kbd(C-v)}}} ::
11237 #+kindex: C-c C-e C-v
11239 Toggle visible-only export. Useful for exporting only visible
11240 parts of an Org document by adjusting outline visibility
11245 :DESCRIPTION: Common export settings.
11247 #+cindex: options, for export
11248 #+cindex: Export, settings
11250 #+cindex: @samp{OPTIONS}, keyword
11251 Export options can be set: globally with variables; for an individual
11252 file by making variables buffer-local with in-buffer settings (see
11253 [[*Summary of In-Buffer Settings]]), by setting individual keywords, or by
11254 specifying them in a compact form with the =OPTIONS= keyword; or for
11255 a tree by setting properties (see [[*Properties and Columns]]). Options
11256 set at a specific level override options set at a more general level.
11258 #+cindex: SETUPFILE, keyword
11259 In-buffer settings may appear anywhere in the file, either directly or
11260 indirectly through a file included using =#+SETUPFILE: filename or
11261 URL= syntax. Option keyword sets tailored to a particular back-end
11262 can be inserted from the export dispatcher (see [[*The Export
11263 Dispatcher]]) using the =Insert template= command by pressing
11264 {{{kbd(#)}}}. To insert keywords individually, a good way to make
11265 sure the keyword is correct is to type =#+= and then to use
11266 {{{kbd(M-TAB)}}}[fn:16] for completion.
11268 The export keywords available for every back-end, and their equivalent
11269 global variables, include:
11273 #+cindex: @samp{AUTHOR}, keyword
11274 #+vindex: user-full-name
11275 The document author (~user-full-name~).
11279 #+cindex: @samp{CREATOR}, keyword
11280 #+vindex: org-expot-creator-string
11281 Entity responsible for output generation
11282 (~org-export-creator-string~).
11286 #+cindex: @samp{DATE}, keyword
11287 #+vindex: org-export-date-timestamp-format
11288 A date or a time-stamp[fn:114].
11292 #+cindex: @samp{EMAIL}, keyword
11293 #+vindex: user-mail-address
11294 The email address (~user-mail-address~).
11298 #+cindex: @samp{LANGUAGE}, keyword
11299 #+vindex: org-export-default-language
11300 Language to use for translating certain strings
11301 (~org-export-default-language~). With =#+LANGUAGE: fr=, for
11302 example, Org translates =Table of contents= to the French =Table
11307 #+cindex: @samp{SELECT_TAGS}, keyword
11308 #+vindex: org-export-select-tags
11309 The default value is ~("export")~. When a tree is tagged with
11310 =export= (~org-export-select-tags~), Org selects that tree and
11311 its sub-trees for export. Org excludes trees with =noexport=
11312 tags, see below. When selectively exporting files with =export=
11313 tags set, Org does not export any text that appears before the
11316 - =EXCLUDE_TAGS= ::
11318 #+cindex: @samp{EXCLUDE_TAGS}, keyword
11319 #+vindex: org-export-exclude-tags
11320 The default value is ~("noexport")~. When a tree is tagged with
11321 =noexport= (~org-export-exclude-tags~), Org excludes that tree
11322 and its sub-trees from export. Entries tagged with =noexport=
11323 are unconditionally excluded from the export, even if they have
11324 an =export= tag. Even if a sub-tree is not exported, Org
11325 executes any code blocks contained there.
11329 #+cindex: @samp{TITLE}, keyword
11330 #+cindex: document title
11331 Org displays this title. For long titles, use multiple =#+TITLE=
11334 - =EXPORT_FILE_NAME= ::
11336 #+cindex: @samp{EXPORT_FILE_NAME}, keyword
11337 The name of the output file to be generated. Otherwise, Org
11338 generates the file name based on the buffer name and the
11339 extension based on the back-end format.
11341 The =OPTIONS= keyword is a compact form. To configure multiple
11342 options, use several =OPTIONS= lines. =OPTIONS= recognizes the
11343 following arguments.
11347 #+vindex: org-export-with-smart-quotes
11348 Toggle smart quotes (~org-export-with-smart-quotes~). Depending
11349 on the language used, when activated, Org treats pairs of double
11350 quotes as primary quotes, pairs of single quotes as secondary
11351 quotes, and single quote marks as apostrophes.
11355 #+vindex: org-export-with-emphasize
11356 Toggle emphasized text (~org-export-with-emphasize~).
11360 #+vindex: org-export-with-special-strings
11361 Toggle conversion of special strings
11362 (~org-export-with-special-strings~).
11366 #+vindex: org-export-with-fixed-width
11367 Toggle fixed-width sections (~org-export-with-fixed-width~).
11371 #+vindex: org-export-with-timestamps
11372 Toggle inclusion of time/date active/inactive stamps
11373 (~org-export-with-timestamps~).
11377 #+vindex: org-export-preserve-breaks
11378 Toggles whether to preserve line breaks
11379 (~org-export-preserve-breaks~).
11383 #+vindex: org-export-with-sub-superscripts
11384 Toggle TeX-like syntax for sub- and superscripts. If you write
11385 =^:{}=, =a_{b}= is interpreted, but the simple =a_b= is left as
11386 it is (~org-export-with-sub-superscripts~).
11390 #+vindex: org-export-with-archived-trees
11391 Configure how archived trees are exported. When set to
11392 ~headline~, the export process skips the contents and processes
11393 only the headlines (~org-export-with-archived-trees~).
11397 #+vindex: org-export-with-author
11398 Toggle inclusion of author name into exported file
11399 (~org-export-with-author~).
11401 - ~broken-links~ ::
11403 #+vindex: org-export-with-broken-links
11404 Toggles if Org should continue exporting upon finding a broken
11405 internal link. When set to ~mark~, Org clearly marks the problem
11406 link in the output (~org-export-with-broken-links~).
11410 #+vindex: org-export-with-clocks
11411 Toggle inclusion of CLOCK keywords (~org-export-with-clocks~).
11415 #+vindex: org-export-with-creator
11416 Toggle inclusion of creator information in the exported file
11417 (~org-export-with-creator~).
11421 #+vindex: org-export-with-drawers
11422 Toggles inclusion of drawers, or list of drawers to include, or
11423 list of drawers to exclude (~org-export-with-drawers~).
11427 #+vindex: org-export-with-date
11428 Toggle inclusion of a date into exported file
11429 (~org-export-with-date~).
11433 #+vindex: org-export-with-entities
11434 Toggle inclusion of entities (~org-export-with-entities~).
11438 #+vindex: org-export-with-email
11439 Toggle inclusion of the author's e-mail into exported file
11440 (~org-export-with-email~).
11444 #+vindex: org-export-with-footnotes
11445 Toggle the inclusion of footnotes (~org-export-with-footnotes~).
11449 #+vindex: org-export-headline-levels
11450 Set the number of headline levels for export
11451 (~org-export-headline-levels~). Below that level, headlines are
11452 treated differently. In most back-ends, they become list items.
11456 #+vindex: org-export-with-inlinetasks
11457 Toggle inclusion of inlinetasks (~org-export-with-inlinetasks~).
11461 #+vindex: org-export-with-section-numbers
11462 #+cindex: @samp{UNNUMBERED}, property
11463 Toggle section-numbers (~org-export-with-section-numbers~). When
11464 set to number N, Org numbers only those headlines at level N or
11465 above. Set =UNNUMBERED= property to non-~nil~ to disable
11466 numbering of heading and subheadings entirely. Moreover, when
11467 the value is =notoc= the headline, and all its children, do not
11468 appear in the table of contents either (see [[*Table of Contents]]).
11472 #+vindex: org-export-with-planning
11473 Toggle export of planning information
11474 (~org-export-with-planning~). "Planning information" comes from
11475 lines located right after the headline and contain any
11476 combination of these cookies: =SCHEDULED=, =DEADLINE=, or
11481 #+vindex: org-export-with-priority
11482 Toggle inclusion of priority cookies
11483 (~org-export-with-priority~).
11487 #+vindex: org-export-with-properties
11488 Toggle inclusion of property drawers, or list the properties to
11489 include (~org-export-with-properties~).
11493 #+vindex: org-export-with-statistics-cookies
11494 Toggle inclusion of statistics cookies
11495 (~org-export-with-statistics-cookies~).
11499 #+vindex: org-export-with-tags
11500 Toggle inclusion of tags, may also be ~not-in-toc~
11501 (~org-export-with-tags~).
11505 #+vindex: org-export-with-tasks
11506 Toggle inclusion of tasks (TODO items); or ~nil~ to remove all
11507 tasks; or ~todo~ to remove DONE tasks; or list the keywords to
11508 keep (~org-export-with-tasks~).
11512 #+vindex: org-export-with-latex
11513 ~nil~ does not export; ~t~ exports; ~verbatim~ keeps everything
11514 in verbatim (~org-export-with-latex~).
11518 #+vindex: org-export-time-stamp-file
11519 Toggle inclusion of the creation time in the exported file
11520 (~org-export-time-stamp-file~).
11524 #+vindex: org-export-with-title
11525 Toggle inclusion of title (~org-export-with-title~).
11529 #+vindex: org-export-with-toc
11530 Toggle inclusion of the table of contents, or set the level limit
11531 (~org-export-with-toc~).
11535 #+vindex: org-export-with-todo-keywords
11536 Toggle inclusion of TODO keywords into exported text
11537 (~org-export-with-todo-keywords~).
11541 #+vindex: org-export-with-tables
11542 Toggle inclusion of tables (~org-export-with-tables~).
11544 When exporting sub-trees, special node properties in them can override
11545 the above keywords. They are special because they have an =EXPORT_=
11546 prefix. For example, =DATE= and =EXPORT_FILE_NAME= keywords become,
11547 respectively, =EXPORT_DATE= and =EXPORT_FILE_NAME=. Except for
11548 =SETUPFILE=, all other keywords listed above have an =EXPORT_=
11551 #+cindex: @samp{BIND}, keyword
11552 #+vindex: org-export-allow-bind-keywords
11553 If ~org-export-allow-bind-keywords~ is non-~nil~, Emacs variables can
11554 become buffer-local during export by using the =BIND= keyword. Its
11555 syntax is =#+BIND: variable value=. This is particularly useful for
11556 in-buffer settings that cannot be changed using keywords.
11558 ** Table of Contents
11560 :DESCRIPTION: The if and where of the table of contents.
11562 #+cindex: table of contents
11563 #+cindex: list of tables
11564 #+cindex: list of listings
11566 #+cindex: @samp{toc}, in @samp{OPTIONS} keyword
11567 #+vindex: org-export-with-toc
11568 The table of contents includes all headlines in the document. Its
11569 depth is therefore the same as the headline levels in the file. If
11570 you need to use a different depth, or turn it off entirely, set the
11571 ~org-export-with-toc~ variable accordingly. You can achieve the same
11572 on a per file basis, using the following =toc= item in =OPTIONS=
11576 ,#+OPTIONS: toc:2 (only include two levels in TOC)
11577 ,#+OPTIONS: toc:nil (no default TOC at all)
11580 #+cindex: excluding entries from table of contents
11581 #+cindex: table of contents, exclude entries
11582 Org includes both numbered and unnumbered headlines in the table of
11583 contents[fn:115]. If you need to exclude an unnumbered headline,
11584 along with all its children, set the =UNNUMBERED= property to =notoc=
11588 ,* Subtree not numbered, not in table of contents either
11594 #+cindex: @samp{TOC}, keyword
11595 Org normally inserts the table of contents directly before the first
11596 headline of the file. To move the table of contents to a different
11597 location, first turn off the default with ~org-export-with-toc~
11598 variable or with =#+OPTIONS: toc:nil=. Then insert =#+TOC: headlines
11599 N= at the desired location(s).
11602 ,#+OPTIONS: toc:nil
11604 ,#+TOC: headlines 2
11607 To adjust the table of contents depth for a specific section of the
11608 Org document, append an additional =local= parameter. This parameter
11609 becomes a relative depth for the current level. The following example
11610 inserts a local table of contents, with direct children only.
11614 ,#+TOC: headlines 1 local
11617 Note that for this feature to work properly in LaTeX export, the Org
11618 file requires the inclusion of the titletoc package. Because of
11619 compatibility issues, titletoc has to be loaded /before/ hyperref.
11620 Customize the ~org-latex-default-packages-alist~ variable.
11622 Use the =TOC= keyword to generate list of tables---respectively, all
11623 listings---with captions.
11630 #+cindex: @samp{ALT_TITLE}, property
11631 Normally Org uses the headline for its entry in the table of contents.
11632 But with =ALT_TITLE= property, a different entry can be specified for
11633 the table of contents.
11637 :DESCRIPTION: Include additional files into a document.
11639 #+cindex: include files, during export
11640 #+cindex: Export, include files
11641 #+cindex: @samp{INCLUDE}, keyword
11643 During export, you can include the content of another file. For
11644 example, to include your =.emacs= file, you could use:
11646 : #+INCLUDE: "~/.emacs" src emacs-lisp
11648 #+texinfo: @noindent
11649 The optional second and third parameter are the markup (e.g., =quote=,
11650 =example=, or =src=), and, if the markup is =src=, the language for
11651 formatting the contents. The markup is optional; if it is not given,
11652 assume text is in Org syntax and process it normally. The =INCLUDE=
11653 keyword also allows additional parameters =:prefix1= and =:prefix= to
11654 specify prefixes for the first line and for each following line,
11655 =:minlevel= in order to get Org mode content demoted to a specified
11656 level, as well as any options accepted by the selected markup. For
11657 example, to include a file as an item, use:
11659 : #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
11661 You can also include a portion of a file by specifying a lines range
11662 using the =:lines= parameter. The line at the upper end of the range
11663 is not included. The start and/or the end of the range may be omitted
11664 to use the obvious defaults.
11666 - =#+INCLUDE: "~/.emacs" :lines "5-10"= ::
11668 Include lines 5 to 10, 10 excluded.
11670 - =#+INCLUDE: "~/.emacs" :lines "-10"= ::
11672 Include lines 1 to 10, 10 excluded.
11674 - =#+INCLUDE: "~/.emacs" :lines "10-"= ::
11676 Include lines from 10 to EOF.
11678 You can visit the file being included with the following command.
11680 - {{{kbd(C-c ')}}} (~org-edit~special~) ::
11682 #+findex: org-edit-special
11684 Visit the include file at point.
11686 ** Macro Replacement
11688 :DESCRIPTION: Use macros to create templates.
11690 #+cindex: macro replacement, during export
11691 #+cindex: @samp{MACRO}, keyword
11693 #+vindex: org-export-global-macros
11694 Macros replace text snippets during export. Macros are defined
11695 globally in ~org-export-global-macros~, or document-wise with the
11698 : #+MACRO: name replacement text; $1, $2 are arguments
11700 #+texinfo: @noindent
11701 which can be referenced using ={{{name(arg1, arg2)}}}=[fn:116]. For
11705 ,#+MACRO: poem The rose is $1, The violet's $2. Life's ordered: Org assists you.
11706 {{{poem(red,blue)}}}
11709 #+texinfo: @noindent
11712 : The rose is red, The violet's blue. Life's ordered: Org assists you.
11714 As a special case, Org parses any replacement text starting with
11715 =(eval= as an Emacs Lisp expression and evaluates it accordingly.
11716 Within such templates, arguments become strings. Thus, the following
11719 : #+MACRO: gnucheck (eval (concat "GNU/" (capitalize $1)))
11721 #+texinfo: @noindent
11722 turns ={{{gnucheck(linux)}}}= into =GNU/Linux= during export.
11724 Org recognizes macro references in following Org markup areas:
11725 paragraphs, headlines, verse blocks, tables cells and lists. Org also
11726 recognizes macro references in keywords, such as =CAPTION=, =TITLE=,
11727 =AUTHOR=, =DATE=, and for some back-end specific export options.
11729 Org comes with following pre-defined macros:
11731 #+attr_texinfo: :sep ;
11732 - ={{{keyword(NAME)}}}=; ={{{title}}}=; ={{{author}}}=; ={{{email}}}= ::
11734 #+cindex: @samp{keyword}, macro
11735 #+cindex: @samp{title}, macro
11736 #+cindex: @samp{author}, macro
11737 #+cindex: @samp{email}, macro
11738 The =keyword= macro collects all values from {{{var(NAME)}}}
11739 keywords throughout the buffer, separated with white space.
11740 =title=, =author= and =email= macros are shortcuts for,
11741 respectively, ={{{keyword(TITLE)}}}=, ={{{keyword(AUTHOR)}}}= and
11742 ={{{keyword(EMAIL)}}}=.
11744 - ={{{date}}}=; ={{{date(FORMAT)}}}= ::
11746 #+cindex: @samp{date}, macro
11747 This macro refers to the =DATE= keyword. {{{var(FORMAT)}}} is an
11748 optional argument to the =date= macro that is used only if =DATE=
11749 is a single timestamp. {{{var(FORMAT)}}} should be a format
11750 string understood by ~format-time-string~.
11752 - ={{{time(FORMAT)}}}=; ={{{modification-time(FORMAT, VC)}}}= ::
11754 #+cindex: @samp{time}, macro
11755 #+cindex: @samp{modification-time}, macro
11756 These macros refer to the document's date and time of export and
11757 date and time of modification. {{{var(FORMAT)}}} is a string
11758 understood by ~format-time-string~. If the second argument to
11759 the ~modification-time~ macro is non-~nil~, Org uses =vc.el= to
11760 retrieve the document's modification time from the version
11761 control system. Otherwise Org reads the file attributes.
11763 - ={{{input-file}}}= ::
11765 #+cindex: @samp{input-file}, macro
11766 This macro refers to the filename of the exported file.
11768 - ={{{property(PROPERTY-NAME)}}}=; ={{{property(PROPERTY-NAME, SEARCH OPTION)}}}= ::
11770 #+cindex: @samp{property}, macro
11771 This macro returns the value of property {{{var(PROPERTY-NAME)}}}
11772 in the current entry. If {{{var(SEARCH-OPTION)}}} (see [[*Search
11773 Options in File Links]]) refers to a remote entry, use it instead.
11775 - ={{{n}}}=; ={{{n(NAME)}}}=; ={{{n(NAME, ACTION)}}}= ::
11777 #+cindex: @samp{n}, macro
11778 #+cindex: counter, macro
11779 This macro implements custom counters by returning the number of
11780 times the macro has been expanded so far while exporting the
11781 buffer. You can create more than one counter using different
11782 {{{var(NAME)}}} values. If {{{var(ACTION)}}} is =-=, previous
11783 value of the counter is held, i.e., the specified counter is not
11784 incremented. If the value is a number, the specified counter is
11785 set to that value. If it is any other non-empty string, the
11786 specified counter is reset to 1. You may leave {{{var(NAME)}}}
11787 empty to reset the default counter.
11789 #+vindex: org-hide-macro-markers
11790 The surrounding brackets can be made invisible by setting
11791 ~org-hide-macro-markers~ non-~nil~.
11793 Org expands macros at the very beginning of the export process.
11797 :DESCRIPTION: What will not be exported.
11799 #+cindex: exporting, not
11801 #+cindex: comment lines
11802 Lines starting with zero or more whitespace characters followed by one
11803 =#= and a whitespace are treated as comments and, as such, are not
11806 #+cindex: @samp{BEGIN_COMMENT}
11807 #+cindex: comment block
11808 Likewise, regions surrounded by =#+BEGIN_COMMENT= ... =#+END_COMMENT=
11811 #+cindex: comment trees
11812 Finally, a =COMMENT= keyword at the beginning of an entry, but after
11813 any other keyword or priority cookie, comments out the entire subtree.
11814 In this case, the subtree is not exported and no code block within it
11815 is executed either[fn:117]. The command below helps changing the
11816 comment status of a headline.
11818 - {{{kbd(C-c ;)}}} (~org-toggle-comment~) ::
11820 #+findex: org-toggle-comment
11822 Toggle the =COMMENT= keyword at the beginning of an entry.
11824 ** ASCII/Latin-1/UTF-8 export
11826 :DESCRIPTION: Exporting to flat files with encoding.
11828 #+cindex: ASCII export
11829 #+cindex: Latin-1 export
11830 #+cindex: UTF-8 export
11832 ASCII export produces an output file containing only plain ASCII
11833 characters. This is the simplest and most direct text output. It
11834 does not contain any Org markup. Latin-1 and UTF-8 export use
11835 additional characters and symbols available in these encoding
11836 standards. All three of these export formats offer the most basic of
11837 text output for maximum portability.
11839 #+vindex: org-ascii-text-width
11840 On export, Org fills and justifies text according to the text width
11841 set in ~org-ascii-text-width~.
11843 #+vindex: org-ascii-links-to-notes
11844 Org exports links using a footnote-like style where the descriptive
11845 part is in the text and the link is in a note before the next heading.
11846 See the variable ~org-ascii-links-to-notes~ for details.
11848 *** ASCII export commands
11853 #+attr_texinfo: :sep ,
11854 - {{{kbd(C-c C-e t a)}}} (~org-ascii-export-to-ascii~), {{{kbd(C-c C-e t l)}}}, {{{kbd(C-c C-e t u)}}} ::
11855 #+kindex: C-c C-e t a
11856 #+kindex: C-c C-e t l
11857 #+kindex: C-c C-e t u
11858 #+findex: org-ascii-export-to-ascii
11860 Export as an ASCII file with a =.txt= extension. For
11861 =myfile.org=, Org exports to =myfile.txt=, overwriting without
11862 warning. For =myfile.txt=, Org exports to =myfile.txt.txt= in
11863 order to prevent data loss.
11865 #+attr_texinfo: :sep ,
11866 - {{{kbd(C-c C-e t A)}}} (~org-ascii-export-to-ascii~), {{{kbd(C-c C-e t L)}}}, {{{kbd(C-c C-e t U)}}} ::
11867 #+kindex: C-c C-e t A
11868 #+kindex: C-c C-e t L
11869 #+kindex: C-c C-e t U
11870 #+findex: org-ascii-export-to-ascii
11872 Export to a temporary buffer. Does not create a file.
11874 *** ASCII specific export settings
11879 The ASCII export back-end has one extra keyword for customizing ASCII
11880 output. Setting this keyword works similar to the general options
11881 (see [[*Export Settings]]).
11885 #+cindex: @samp{SUBTITLE}, keyword
11886 The document subtitle. For long subtitles, use multiple
11887 =#+SUBTITLE= lines in the Org file. Org prints them on one
11888 continuous line, wrapping into multiple lines if necessary.
11890 *** Header and sectioning structure
11895 Org converts the first three outline levels into headlines for ASCII
11896 export. The remaining levels are turned into lists. To change this
11897 cut-off point where levels become lists, see [[*Export Settings]].
11899 *** Quoting ASCII text
11904 To insert text within the Org file by the ASCII back-end, use one the
11905 following constructs, inline, keyword, or export block:
11907 #+cindex: @samp{ASCII}, keyword
11908 #+cindex: @samp{BEGIN_EXPORT ascii}
11910 Inline text @@ascii:and additional text@@ within a paragraph.
11912 ,#+ASCII: Some text
11914 ,#+BEGIN_EXPORT ascii
11915 Org exports text in this block only when using ASCII back-end.
11919 *** ASCII specific attributes
11923 #+cindex: @samp{ATTR_ASCII}, keyword
11924 #+cindex: horizontal rules, in ASCII export
11926 ASCII back-end recognizes only one attribute, ~:width~, which
11927 specifies the width of an horizontal rule in number of characters.
11928 The keyword and syntax for specifying widths is:
11931 ,#+ATTR_ASCII: :width 10
11935 *** ASCII special blocks
11939 #+cindex: special blocks, in ASCII export
11940 #+cindex: @samp{BEGIN_JUSTIFYLEFT}
11941 #+cindex: @samp{BEGIN_JUSTIFYRIGHT}
11943 Besides =#+BEGIN_CENTER= blocks (see [[*Paragraphs]]), ASCII back-end has
11944 these two left and right justification blocks:
11947 ,#+BEGIN_JUSTIFYLEFT
11948 It's just a jump to the left...
11951 ,#+BEGIN_JUSTIFYRIGHT
11952 ...and then a step to the right.
11953 ,#+END_JUSTIFYRIGHT
11957 #+cindex: Beamer export
11959 Org uses Beamer export to convert an Org file tree structure into
11960 high-quality interactive slides for presentations. Beamer is a LaTeX
11961 document class for creating presentations in PDF, HTML, and other
11962 popular display formats.
11964 *** Beamer export commands
11966 :DESCRIPTION: For creating Beamer documents.
11969 - {{{kbd(C-c C-e l b)}}} (~org-beamer-export-to-latex~) ::
11970 #+kindex: C-c C-e l b
11971 #+findex: org-beamer-export-to-latex
11973 Export as LaTeX file with a =.tex= extension. For =myfile.org=,
11974 Org exports to =myfile.tex=, overwriting without warning.
11976 - {{{kbd(C-c C-e l B)}}} (~org-beamer-export-as-latex~) ::
11977 #+kindex: C-c C-e l B
11978 #+findex: org-beamer-export-as-latex
11980 Export to a temporary buffer. Does not create a file.
11982 - {{{kbd(C-c C-e l P)}}} (~org-beamer-export-to-pdf~) ::
11983 #+kindex: C-c C-e l P
11984 #+findex: org-beamer-export-to-pdf
11986 Export as LaTeX file and then convert it to PDF format.
11988 - {{{kbd(C-c C-e l O)}}} ::
11989 #+kindex: C-c C-e l O
11991 Export as LaTeX file, convert it to PDF format, and then open the
11994 *** Beamer specific export settings
11996 :DESCRIPTION: For customizing Beamer export.
11999 Beamer export back-end has several additional keywords for customizing
12000 Beamer output. These keywords work similar to the general options
12001 settings (see [[*Export Settings]]).
12003 - =BEAMER_THEME= ::
12005 #+cindex: @samp{BEAMER_THEME}, keyword
12006 #+vindex: org-beamer-theme
12007 The Beamer layout theme (~org-beamer-theme~). Use square
12008 brackets for options. For example:
12010 : #+BEAMER_THEME: Rochester [height=20pt]
12012 - =BEAMER_FONT_THEME= ::
12014 #+cindex: @samp{BEAMER_FONT_THEME}, keyword
12015 The Beamer font theme.
12017 - =BEAMER_INNER_THEME= ::
12019 #+cindex: @samp{BEAMER_INNER_THEME}, keyword
12020 The Beamer inner theme.
12022 - =BEAMER_OUTER_THEME= ::
12024 #+cindex: @samp{BEAMER_OUTER_THEME}, keyword
12025 The Beamer outer theme.
12027 - =BEAMER_HEADER= ::
12029 #+cindex: @samp{BEAMER_HEADER}, keyword
12030 Arbitrary lines inserted in the preamble, just before the
12031 =hyperref= settings.
12035 #+cindex: @samp{DESCRIPTION}, keyword
12036 The document description. For long descriptions, use multiple
12037 =DESCRIPTION= keywords. By default, =hyperref= inserts
12038 =DESCRIPTION= as metadata. Use ~org-latex-hyperref-template~ to
12039 configure document metadata. Use ~org-latex-title-command~ to
12040 configure typesetting of description as part of front matter.
12044 #+cindex: @samp{KEYWORDS}, keyword
12045 The keywords for defining the contents of the document. Use
12046 multiple =KEYWORDS= lines if necessary. By default, =hyperref=
12047 inserts =KEYWORDS= as metadata. Use
12048 ~org-latex-hyperref-template~ to configure document metadata.
12049 Use ~org-latex-title-command~ to configure typesetting of
12050 keywords as part of front matter.
12054 #+cindex: @samp{SUBTITLE}, keyword
12055 Document's subtitle. For typesetting, use
12056 ~org-beamer-subtitle-format~ string. Use
12057 ~org-latex-hyperref-template~ to configure document metadata.
12058 Use ~org-latex-title-command~ to configure typesetting of
12059 subtitle as part of front matter.
12061 *** Frames and Blocks in Beamer
12063 :DESCRIPTION: For composing Beamer slides.
12066 Org transforms heading levels into Beamer's sectioning elements,
12067 frames and blocks. Any Org tree with a not-too-deep-level nesting
12068 should in principle be exportable as a Beamer presentation.
12071 #+vindex: org-beamer-frame-level
12072 Org headlines become Beamer frames when the heading level in Org is
12073 equal to ~org-beamer-frame-level~ or =H= value in a =OPTIONS= line
12074 (see [[*Export Settings]]).
12076 #+cindex: @samp{BEAMER_ENV}, property
12077 Org overrides headlines to frames conversion for the current tree of
12078 an Org file if it encounters the =BEAMER_ENV= property set to
12079 =frame= or =fullframe=. Org ignores whatever
12080 ~org-beamer-frame-level~ happens to be for that headline level in
12081 the Org tree. In Beamer terminology, a full frame is a frame
12084 - Org exports a Beamer frame's objects as block environments. Org can
12085 enforce wrapping in special block types when =BEAMER_ENV= property
12086 is set[fn:118]. For valid values see
12087 ~org-beamer-environments-default~. To add more values, see
12088 ~org-beamer-environments-extra~.
12089 #+vindex: org-beamer-environments-default
12090 #+vindex: org-beamer-environments-extra
12093 #+cindex: @samp{BEAMER_REF}, property
12094 If =BEAMER_ENV= is set to =appendix=, Org exports the entry as an
12095 appendix. When set to =note=, Org exports the entry as a note
12096 within the frame or between frames, depending on the entry's heading
12097 level. When set to =noteNH=, Org exports the entry as a note
12098 without its title. When set to =againframe=, Org exports the entry
12099 with =\againframe= command, which makes setting the =BEAMER_REF=
12100 property mandatory because =\againframe= needs frame to resume.
12102 When =ignoreheading= is set, Org export ignores the entry's headline
12103 but not its content. This is useful for inserting content between
12104 frames. It is also useful for properly closing a =column=
12105 environment. @end itemize
12107 #+cindex: @samp{BEAMER_ACT}, property
12108 #+cindex: @samp{BEAMER_OPT}, property
12109 When =BEAMER_ACT= is set for a headline, Org export translates that
12110 headline as an overlay or action specification. When enclosed in
12111 square brackets, Org export makes the overlay specification
12112 a default. Use =BEAMER_OPT= to set any options applicable to the
12113 current Beamer frame or block. The Beamer export back-end wraps
12114 with appropriate angular or square brackets. It also adds the
12115 =fragile= option for any code that may require a verbatim block.
12117 #+cindex: @samp{BEAMER_COL}, property
12118 To create a column on the Beamer slide, use the =BEAMER_COL=
12119 property for its headline in the Org file. Set the value of
12120 =BEAMER_COL= to a decimal number representing the fraction of the
12121 total text width. Beamer export uses this value to set the column's
12122 width and fills the column with the contents of the Org entry. If
12123 the Org entry has no specific environment defined, Beamer export
12124 ignores the heading. If the Org entry has a defined environment,
12125 Beamer export uses the heading as title. Behind the scenes, Beamer
12126 export automatically handles LaTeX column separations for contiguous
12127 headlines. To manually adjust them for any unique configurations
12128 needs, use the =BEAMER_ENV= property.
12130 *** Beamer specific syntax
12132 :DESCRIPTION: For using in Org documents.
12135 Since Org's Beamer export back-end is an extension of the LaTeX
12136 back-end, it recognizes other LaTeX specific syntax---for example,
12137 =#+LATEX:= or =#+ATTR_LATEX:=. See [[*LaTeX Export]], for details.
12139 Beamer export wraps the table of contents generated with =toc:t=
12140 =OPTION= keyword in a =frame= environment. Beamer export does not
12141 wrap the table of contents generated with =TOC= keyword (see [[*Table of
12142 Contents]]). Use square brackets for specifying options.
12144 : #+TOC: headlines [currentsection]
12146 Insert Beamer-specific code using the following constructs:
12148 #+cindex: @samp{BEAMER}, keyword
12149 #+cindex: @samp{BEGIN_EXPORT beamer}
12153 ,#+BEGIN_EXPORT beamer
12154 Only Beamer export back-end exports this.
12157 Text @@beamer:some code@@ within a paragraph.
12160 Inline constructs, such as the last one above, are useful for adding
12161 overlay specifications to objects with ~bold~, ~item~, ~link~,
12162 ~radio-target~ and ~target~ types. Enclose the value in angular
12163 brackets and place the specification at the beginning of the object as
12164 shown in this example:
12166 : A *@@beamer:<2->@@useful* feature
12168 #+cindex: @samp{ATTR_BEAMER}, keyword
12169 Beamer export recognizes the =ATTR_BEAMER= keyword with the following
12170 attributes from Beamer configurations: =:environment= for changing
12171 local Beamer environment, =:overlay= for specifying Beamer overlays in
12172 angular or square brackets, and =:options= for inserting optional
12176 ,#+ATTR_BEAMER: :environment nonindentlist
12177 - item 1, not indented
12178 - item 2, not indented
12179 - item 3, not indented
12183 ,#+ATTR_BEAMER: :overlay <+->
12189 ,#+ATTR_BEAMER: :options [Lagrange]
12190 Let $G$ be a finite group, and let $H$ be
12191 a subgroup of $G$. Then the order of $H$ divides the order of $G$.
12194 *** Editing support
12196 :DESCRIPTION: Editing support.
12199 The ~org-beamer-mode~ is a special minor mode for faster editing of
12202 : #+STARTUP: beamer
12204 - {{{kbd(C-c C-b)}}} (~org-beamer-select-environment~) ::
12206 #+findex: org-beamer-select-environment
12208 The ~org-beamer-mode~ provides this key for quicker selections in
12209 Beamer normal environments, and for selecting the =BEAMER_COL=
12212 *** A Beamer example
12214 :DESCRIPTION: A complete presentation.
12217 Here is an example of an Org document ready for Beamer export.
12220 ;#+TITLE: Example Presentation
12221 ;#+AUTHOR: Carsten Dominik
12222 ;#+OPTIONS: H:2 toc:t num:t
12223 ;#+LATEX_CLASS: beamer
12224 ;#+LATEX_CLASS_OPTIONS: [presentation]
12225 ;#+BEAMER_THEME: Madrid
12226 ;#+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
12228 ,* This is the first structural section
12231 ,*** Thanks to Eric Fraga :B_block:
12236 for the first viable Beamer setup in Org
12237 ,*** Thanks to everyone else :B_block:
12243 for contributing to the discussion
12244 ,**** This will be formatted as a beamer note :B_note:
12248 ,** Frame 2 (where we will not use columns)
12250 Please test this stuff!
12255 :DESCRIPTION: Exporting to HTML.
12257 #+cindex: HTML export
12259 Org mode contains an HTML exporter with extensive HTML formatting
12260 compatible with XHTML 1.0 strict standard.
12262 *** HTML export commands
12264 :DESCRIPTION: Invoking HTML export.
12267 - {{{kbd(C-c C-e h h)}}} (~org-html-export-to-html~) ::
12268 #+kindex: C-c C-e h h
12269 #+kindex: C-c C-e h o
12270 #+findex: org-html-export-to-html
12272 Export as HTML file with a =.html= extension. For =myfile.org=,
12273 Org exports to =myfile.html=, overwriting without warning.
12274 {{{kbd{C-c C-e h o)}}} exports to HTML and opens it in a web
12277 - {{{kbd(C-c C-e h H)}}} (~org-html-export-as-html~) ::
12278 #+kindex: C-c C-e h H
12279 #+findex: org-html-export-as-html
12281 Exports to a temporary buffer. Does not create a file.
12283 *** HTML specific export settings
12285 :DESCRIPTION: Settings for HTML export.
12288 HTML export has a number of keywords, similar to the general options
12289 settings described in [[*Export Settings]].
12293 #+cindex: @samp{DESCRIPTION}, keyword
12294 This is the document's description, which the HTML exporter
12295 inserts it as a HTML meta tag in the HTML file. For long
12296 descriptions, use multiple =DESCRIPTION= lines. The exporter
12297 takes care of wrapping the lines properly.
12299 - =HTML_DOCTYPE= ::
12301 #+cindex: @samp{HTML_DOCTYPE}, keyword
12302 #+vindex: org-html-doctype
12303 Specify the document type, for example: HTML5
12304 (~org-html-doctype~).
12306 - =HTML_CONTAINER= ::
12308 #+cindex: @samp{HTML_CONTAINER}, keyword
12309 #+vindex: org-html-container-element
12310 Specify the HTML container, such as =div=, for wrapping sections
12311 and elements (~org-html-container-element~).
12313 - =HTML_LINK_HOME= ::
12315 #+cindex: @samp{HTML_LINK_HOME}, keyword
12316 #+vindex: org-html-link-home
12317 The URL for home link (~org-html-link-home~).
12319 - =HTML_LINK_UP= ::
12321 #+cindex: @samp{HTML_LINK_UP}, keyword
12322 #+vindex: org-html-link-up
12323 The URL for the up link of exported HTML pages
12324 (~org-html-link-up~).
12326 - =HTML_MATHJAX= ::
12328 #+cindex: @samp{HTML_MATHJAX}, keyword
12329 #+vindex: org-html-mathjax-options
12330 Options for MathJax (~org-html-mathjax-options~). MathJax is
12331 used to typeset LaTeX math in HTML documents. See [[*Math
12332 formatting in HTML export]], for an example.
12336 #+cindex: @samp{HTML_HEAD}, keyword
12337 #+vindex: org-html-head
12338 Arbitrary lines for appending to the HTML document's head
12341 - =HTML_HEAD_EXTRA= ::
12343 #+cindex: @samp{HTML_HEAD_EXTRA}, keyword
12344 #+vindex: org-html-head-extra
12345 More arbitrary lines for appending to the HTML document's head
12346 (~org-html-head-extra~).
12350 #+cindex: @samp{KEYWORDS}, keyword
12351 Keywords to describe the document's content. HTML exporter
12352 inserts these keywords as HTML meta tags. For long keywords, use
12353 multiple =KEYWORDS= lines.
12355 - =LATEX_HEADER= ::
12357 #+cindex: @samp{LATEX_HEADER}, keyword
12358 Arbitrary lines for appending to the preamble; HTML exporter
12359 appends when transcoding LaTeX fragments to images (see [[*Math
12360 formatting in HTML export]]).
12364 #+cindex: @samp{SUBTITLE}, keyword
12365 The document's subtitle. HTML exporter formats subtitle if
12366 document type is =HTML5= and the CSS has a =subtitle= class.
12368 Some of these keywords are explained in more detail in the following
12369 sections of the manual.
12373 :DESCRIPTION: Exporting various (X)HTML flavors.
12376 Org can export to various (X)HTML flavors.
12378 #+vindex: org-html-doctype
12379 #+vindex: org-html-doctype-alist
12380 Set the ~org-html-doctype~ variable for different (X)HTML variants.
12381 Depending on the variant, the HTML exporter adjusts the syntax of HTML
12382 conversion accordingly. Org includes the following ready-made
12386 - ~"html4-transitional"~
12387 - ~"html4-frameset"~
12389 - ~"xhtml-transitional"~
12390 - ~"xhtml-frameset"~
12395 #+texinfo: @noindent
12396 See the variable ~org-html-doctype-alist~ for details. The default is
12399 #+vindex: org-html-html5-fancy
12400 #+cindex: @samp{HTML5}, export new elements
12401 Org's HTML exporter does not by default enable new block elements
12402 introduced with the HTML5 standard. To enable them, set
12403 ~org-html-html5-fancy~ to non-~nil~. Or use an =OPTIONS= line in the
12404 file to set =html5-fancy=.
12406 HTML5 documents can now have arbitrary =#+BEGIN= ... =#+END= blocks.
12415 #+texinfo: @noindent
12424 #+texinfo: @noindent
12428 ,#+ATTR_HTML: :controls controls :width 350
12430 ,#+HTML: <source src="movie.mp4" type="video/mp4">
12431 ,#+HTML: <source src="movie.ogg" type="video/ogg">
12432 Your browser does not support the video tag.
12436 #+texinfo: @noindent
12440 <video controls="controls" width="350">
12441 <source src="movie.mp4" type="video/mp4">
12442 <source src="movie.ogg" type="video/ogg">
12443 <p>Your browser does not support the video tag.</p>
12447 #+vindex: org-html-html5-elements
12448 When special blocks do not have a corresponding HTML5 element, the
12449 HTML exporter reverts to standard translation (see
12450 ~org-html-html5-elements~). For example, =#+BEGIN_lederhosen= exports
12451 to ~<div class="lederhosen">~.
12453 Special blocks cannot have headlines. For the HTML exporter to wrap
12454 the headline and its contents in ~<section>~ or ~<article>~ tags, set
12455 the =HTML_CONTAINER= property for the headline.
12457 *** HTML preamble and postamble
12459 :DESCRIPTION: Inserting preamble and postamble.
12461 #+vindex: org-html-preamble
12462 #+vindex: org-html-postamble
12463 #+vindex: org-html-preamble-format
12464 #+vindex: org-html-postamble-format
12465 #+vindex: org-html-validation-link
12466 #+vindex: org-export-creator-string
12467 #+vindex: org-export-time-stamp-file
12469 The HTML exporter has delineations for preamble and postamble. The
12470 default value for ~org-html-preamble~ is ~t~, which makes the HTML
12471 exporter insert the preamble. See the variable
12472 ~org-html-preamble-format~ for the format string.
12474 Set ~org-html-preamble~ to a string to override the default format
12475 string. If the string is a function, the HTML exporter expects the
12476 function to return a string upon execution. The HTML exporter inserts
12477 this string in the preamble. The HTML exporter does not insert
12478 a preamble if ~org-html-preamble~ is set ~nil~.
12480 The default value for ~org-html-postamble~ is ~auto~, which makes the
12481 HTML exporter build a postamble from looking up author's name, email
12482 address, creator's name, and date. Set ~org-html-postamble~ to ~t~ to
12483 insert the postamble in the format specified in the
12484 ~org-html-postamble-format~ variable. The HTML exporter does not
12485 insert a postamble if ~org-html-postamble~ is set to ~nil~.
12487 *** Quoting HTML tags
12489 :DESCRIPTION: Using direct HTML in Org files.
12492 The HTML export back-end transforms =<= and =>= to =<= and =>=.
12494 To include raw HTML code in the Org file so the HTML export back-end
12495 can insert that HTML code in the output, use this inline syntax:
12496 =@@html:...@@=. For example:
12498 : @@html:<b>@@bold text@@html:</b>@@
12500 #+cindex: @samp{HTML}, keyword
12501 #+cindex: @samp{BEGIN_EXPORT html}
12502 For larger raw HTML code blocks, use these HTML export code blocks:
12505 ,#+HTML: Literal HTML code for export
12507 ,#+BEGIN_EXPORT html
12508 All lines between these markers are exported literally
12512 *** Links in HTML export
12514 :DESCRIPTION: Inserting and formatting links.
12516 #+cindex: links, in HTML export
12517 #+cindex: internal links, in HTML export
12518 #+cindex: external links, in HTML export
12520 The HTML export back-end transforms Org's internal links (see
12521 [[*Internal Links]]) to equivalent HTML links in the output. The back-end
12522 similarly handles Org's automatic links created by radio targets (see
12523 [[*Radio Targets]]) similarly. For Org links to external files, the
12524 back-end transforms the links to /relative/ paths.
12526 #+vindex: org-html-link-org-files-as-html
12527 For Org links to other =.org= files, the back-end automatically
12528 changes the file extension to =.html= and makes file paths relative.
12529 If the =.org= files have an equivalent =.html= version at the same
12530 location, then the converted links should work without any further
12531 manual intervention. However, to disable this automatic path
12532 translation, set ~org-html-link-org-files-as-html~ to ~nil~. When
12533 disabled, the HTML export back-end substitutes the ID-based links in
12534 the HTML output. For more about linking files when publishing to
12535 a directory, see [[*Publishing links]].
12537 Org files can also have special directives to the HTML export
12538 back-end. For example, by using =#+ATTR_HTML= lines to specify new
12539 format attributes to ~<a>~ or ~<img>~ tags. This example shows
12540 changing the link's title and style:
12542 #+cindex: @samp{ATTR_HTML}, keyword
12544 ,#+ATTR_HTML: :title The Org mode homepage :style color:red;
12545 [[https://orgmode.org]]
12548 *** Tables in HTML export
12550 :DESCRIPTION: How to modify the formatting of tables.
12552 #+cindex: tables, in HTML
12553 #+vindex: org-export-html-table-tag
12555 The HTML export back-end uses ~org-html-table-default-attributes~ when
12556 exporting Org tables to HTML. By default, the exporter does not draw
12557 frames and cell borders. To change for this for a table, use the
12558 following lines before the table in the Org file:
12560 #+cindex: @samp{CAPTION}, keyword
12561 #+cindex: @samp{ATTR_HTML}, keyword
12563 ,#+CAPTION: This is a table with lines around and between cells
12564 ,#+ATTR_HTML: border="2" rules="all" frame="border"
12567 The HTML export back-end preserves column groupings in Org tables (see
12568 [[*Column Groups]]) when exporting to HTML.
12570 Additional options for customizing tables for HTML export.
12572 - ~org-html-table-align-individual-fields~ ::
12574 #+vindex: org-html-table-align-individual-fields
12575 Non-~nil~ attaches style attributes for alignment to each table
12578 - ~org-html-table-caption-above~ ::
12580 #+vindex: org-html-table-caption-above
12581 Non-~nil~ places caption string at the beginning of the table.
12583 - ~org-html-table-data-tags~ ::
12585 #+vindex: org-html-table-data-tags
12586 Opening and ending tags for table data fields.
12588 - ~org-html-table-default-attributes~ ::
12590 #+vindex: org-html-table-default-attributes
12591 Default attributes and values for table tags.
12593 - ~org-html-table-header-tags~ ::
12595 #+vindex: org-html-table-header-tags
12596 Opening and ending tags for table's header fields.
12598 - ~org-html-table-row-tags~ ::
12600 #+vindex: org-html-table-row-tags
12601 Opening and ending tags for table rows.
12603 - ~org-html-table-use-header-tags-for-first-column~ ::
12605 #+vindex: org-html-table-use-header-tags-for-first-column
12606 Non-~nil~ formats column one in tables with header tags.
12608 *** Images in HTML export
12610 :DESCRIPTION: How to insert figures into HTML output.
12612 #+cindex: images, inline in HTML
12613 #+cindex: inlining images in HTML
12615 The HTML export back-end has features to convert Org image links to
12616 HTML inline images and HTML clickable image links.
12618 #+vindex: org-html-inline-images
12619 When the link in the Org file has no description, the HTML export
12620 back-end by default in-lines that image. For example:
12621 =[[file:myimg.jpg]]= is in-lined, while =[[file:myimg.jpg][the image]]= links to the text,
12622 =the image=. For more details, see the variable
12623 ~org-html-inline-images~.
12625 On the other hand, if the description part of the Org link is itself
12626 another link, such as =file:= or =http:= URL pointing to an image, the
12627 HTML export back-end in-lines this image and links to the main image.
12628 This Org syntax enables the back-end to link low-resolution thumbnail
12629 to the high-resolution version of the image, as shown in this example:
12631 : [[file:highres.jpg][file:thumb.jpg]]
12633 To change attributes of in-lined images, use =#+ATTR_HTML= lines in
12634 the Org file. This example shows realignment to right, and adds ~alt~
12635 and ~title~ attributes in support of text viewers and modern web
12636 accessibility standards.
12638 #+cindex: @samp{CAPTION}, keyword
12639 #+cindex: @samp{ATTR_HTML}, keyword
12641 ,#+CAPTION: A black cat stalking a spider
12642 ,#+ATTR_HTML: :alt cat/spider image :title Action! :align right
12646 #+texinfo: @noindent
12647 The HTML export back-end copies the =http= links from the Org file as
12650 *** Math formatting in HTML export
12652 :DESCRIPTION: Beautiful math also on the web.
12657 #+cindex: ImageMagick
12659 #+vindex: org-html-mathjax-options~
12660 LaTeX math snippets (see [[*LaTeX fragments]]) can be displayed in two
12661 different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax]],
12662 which should work out of the box with Org[fn:119]. Some MathJax
12663 display options can be configured via ~org-html-mathjax-options~, or
12664 in the buffer. For example, with the following settings,
12667 ,#+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
12668 ,#+HTML_MATHJAX: cancel.js noErrors.js
12671 #+texinfo: @noindent
12672 equation labels are displayed on the left margin and equations are
12673 five em from the left margin. In addition, it loads the two MathJax
12674 extensions =cancel.js= and =noErrors.js=[fn:120].
12676 #+vindex: org-html-mathjax-template
12677 See the docstring of ~org-html-mathjax-options~ for all supported
12678 variables. The MathJax template can be configure via
12679 ~org-html-mathjax-template~.
12681 If you prefer, you can also request that LaTeX fragments are processed
12682 into small images that will be inserted into the browser page. Before
12683 the availability of MathJax, this was the default method for Org
12684 files. This method requires that the dvipng program, dvisvgm or
12685 ImageMagick suite is available on your system. You can still get this
12688 : #+OPTIONS: tex:dvipng
12690 : #+OPTIONS: tex:dvisvgm
12692 #+texinfo: @noindent
12695 : #+OPTIONS: tex:imagemagick
12697 *** Text areas in HTML export
12699 :DESCRIPTION: An alternate way to show an example.
12702 #+cindex: text areas, in HTML
12703 Before Org mode's Babel, one popular approach to publishing code in
12704 HTML was by using =:textarea=. The advantage of this approach was
12705 that copying and pasting was built into browsers with simple
12706 JavaScript commands. Even editing before pasting was made simple.
12708 The HTML export back-end can create such text areas. It requires an
12709 =#+ATTR_HTML= line as shown in the example below with the =:textarea=
12710 option. This must be followed by either an example or a source code
12711 block. Other Org block types do not honor the =:textarea= option.
12713 By default, the HTML export back-end creates a text area 80 characters
12714 wide and height just enough to fit the content. Override these
12715 defaults with =:width= and =:height= options on the =#+ATTR_HTML=
12719 ,#+ATTR_HTML: :textarea t :width 40
12721 (defun org-xor (a b)
12729 :DESCRIPTION: Changing the appearance of the output.
12731 #+cindex: CSS, for HTML export
12732 #+cindex: HTML export, CSS
12734 #+vindex: org-export-html-todo-kwd-class-prefix
12735 #+vindex: org-export-html-tag-class-prefix
12736 You can modify the CSS style definitions for the exported file. The
12737 HTML exporter assigns the following special CSS classes[fn:121] to
12738 appropriate parts of the document---your style specifications may
12739 change these, in addition to any of the standard classes like for
12740 headlines, tables, etc.
12742 | ~p.author~ | author information, including email |
12743 | ~p.date~ | publishing date |
12744 | ~p.creator~ | creator info, about org mode version |
12745 | ~.title~ | document title |
12746 | ~.subtitle~ | document subtitle |
12747 | ~.todo~ | TODO keywords, all not-done states |
12748 | ~.done~ | the DONE keywords, all states that count as done |
12749 | ~.WAITING~ | each TODO keyword also uses a class named after itself |
12750 | ~.timestamp~ | timestamp |
12751 | ~.timestamp-kwd~ | keyword associated with a timestamp, like =SCHEDULED= |
12752 | ~.timestamp-wrapper~ | span around keyword plus timestamp |
12753 | ~.tag~ | tag in a headline |
12754 | ~._HOME~ | each tag uses itself as a class, "@" replaced by "_" |
12755 | ~.target~ | target for links |
12756 | ~.linenr~ | the line number in a code example |
12757 | ~.code-highlighted~ | for highlighting referenced code lines |
12758 | ~div.outline-N~ | div for outline level N (headline plus text) |
12759 | ~div.outline-text-N~ | extra div for text at outline level N |
12760 | ~.section-number-N~ | section number in headlines, different for each level |
12761 | ~.figure-number~ | label like "Figure 1:" |
12762 | ~.table-number~ | label like "Table 1:" |
12763 | ~.listing-number~ | label like "Listing 1:" |
12764 | ~div.figure~ | how to format an in-lined image |
12765 | ~pre.src~ | formatted source code |
12766 | ~pre.example~ | normal example |
12767 | ~p.verse~ | verse paragraph |
12768 | ~div.footnotes~ | footnote section headline |
12769 | ~p.footnote~ | footnote definition paragraph, containing a footnote |
12770 | ~.footref~ | a footnote reference number (always a <sup>) |
12771 | ~.footnum~ | footnote number in footnote definition (always <sup>) |
12772 | ~.org-svg~ | default class for a linked =.svg= image |
12774 #+vindex: org-html-style-default
12775 #+vindex: org-html-head
12776 #+vindex: org-html-head-extra
12777 #+cindex: @samp{HTML_INCLUDE_STYLE}, keyword
12778 The HTML export back-end includes a compact default style in each
12779 exported HTML file. To override the default style with another style,
12780 use these keywords in the Org file. They will replace the global
12781 defaults the HTML exporter uses.
12783 #+cindex: @samp{HTML_HEAD}, keyword
12784 #+cindex: @samp{HTML_HEAD_EXTRA}, keyword
12786 ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
12787 ,#+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
12790 #+vindex: org-html-head-include-default-style
12791 To just turn off the default style, customize
12792 ~org-html-head-include-default-style~ variable, or use this option
12793 line in the Org file.
12795 #+cindex: @samp{html-style}, @samp{OPTIONS} item
12796 : #+OPTIONS: html-style:nil
12798 For longer style definitions, either use several =HTML_HEAD= and
12799 =HTML_HEAD_EXTRA= keywords, or use ~<style> ... </style>~ blocks
12800 around them. Both of these approaches can avoid referring to an
12803 #+cindex: @samp{HTML_CONTAINER_CLASS}, property
12804 In order to add styles to a sub-tree, use the =HTML_CONTAINER_CLASS=
12805 property to assign a class to the tree. In order to specify CSS
12806 styles for a particular headline, you can use the id specified in
12807 a =CUSTOM_ID= property.
12809 Never change the ~org-html-style-default~ constant. Instead use other
12810 simpler ways of customizing as described above.
12812 *** JavaScript supported display of web pages
12814 :DESCRIPTION: Info and folding in a web browser.
12815 :ALT_TITLE: JavaScript support
12818 Sebastian Rose has written a JavaScript program especially designed to
12819 enhance the web viewing experience of HTML files created with Org.
12820 This program enhances large files in two different ways of viewing.
12821 One is an /Info/-like mode where each section is displayed separately
12822 and navigation can be done with the {{{kbd(n)}}} and {{{kbd(p)}}}
12823 keys, and some other keys as well, press {{{kbd(?)}}} for an overview
12824 of the available keys. The second one has a /folding/ view, much like
12825 Org provides inside Emacs. The script is available at
12826 https://orgmode.org/org-info.js and the documentation at
12827 https://orgmode.org/worg/code/org-info-js/. The script is hosted on
12828 https://orgmode.org, but for reliability, prefer installing it on your
12831 To use this program, just add this line to the Org file:
12833 #+cindex: @samp{INFOJS_OPT}, keyword
12834 : #+INFOJS_OPT: view:info toc:nil
12836 #+texinfo: @noindent
12837 The HTML header now has the code needed to automatically invoke the
12838 script. For setting options, use the syntax from the above line for
12839 options described below:
12843 The path to the script. The default is to grab the script from
12844 [[https://orgmode.org/org-info.js]], but you might want to have
12845 a local copy and use a path like =../scripts/org-info.js=.
12849 Initial view when the website is first shown. Possible values are:
12851 | =info= | Info-like interface with one section per page |
12852 | =overview= | Folding interface, initially showing only top-level |
12853 | =content= | Folding interface, starting with all headlines visible |
12854 | =showall= | Folding interface, all headlines and text visible |
12858 Maximum headline level still considered as an independent section
12859 for info and folding modes. The default is taken from
12860 ~org-export-headline-levels~, i.e., the =H= switch in =OPTIONS=.
12861 If this is smaller than in ~org-export-headline-levels~, each
12862 info/folding section can still contain child headlines.
12866 Should the table of contents /initially/ be visible? Even when
12867 =nil=, you can always get to the "toc" with {{{kbd(i)}}}.
12871 The depth of the table of contents. The defaults are taken from
12872 the variables ~org-export-headline-levels~ and
12873 ~org-export-with-toc~.
12877 Does the CSS of the page specify a fixed position for the "toc"?
12878 If yes, the toc is displayed as a section.
12882 Should there be short contents (children) in each section? Make
12883 this =above= if the section should be above initial text.
12887 Headings are highlighted when the mouse is over them. Should be
12888 =underline= (default) or a background color like =#cccccc=.
12892 Should view-toggle buttons be everywhere? When =nil= (the
12893 default), only one such button is present.
12895 #+texinfo: @noindent
12896 #+vindex: org-infojs-options
12897 #+vindex: org-export-html-use-infojs
12898 You can choose default values for these options by customizing the
12899 variable ~org-infojs-options~. If you always want to apply the script
12900 to your pages, configure the variable ~org-export-html-use-infojs~.
12904 :DESCRIPTION: Exporting to @LaTeX{} and processing to PDF.
12906 #+cindex: @LaTeX{} export
12907 #+cindex: PDF export
12909 The LaTeX export back-end can handle complex documents, incorporate
12910 standard or custom LaTeX document classes, generate documents using
12911 alternate LaTeX engines, and produce fully linked PDF files with
12912 indexes, bibliographies, and tables of contents, destined for
12913 interactive online viewing or high-quality print publication.
12915 While the details are covered in-depth in this section, here are some
12916 quick references to variables for the impatient: for engines, see
12917 ~org-latex-compiler~; for build sequences, see
12918 ~org-latex-pdf-process~; for packages, see
12919 ~org-latex-default-packages-alist~ and ~org-latex-packages-alist~.
12921 An important note about the LaTeX export back-end: it is sensitive to
12922 blank lines in the Org document. That's because LaTeX itself depends
12923 on blank lines to tell apart syntactical elements, such as paragraphs.
12925 *** LaTeX/PDF export commands
12927 :DESCRIPTION: For producing @LaTeX{} and PDF documents.
12930 - {{{kbd(C-c C-e l l)}}} (~org-latex-export-to-latex~) ::
12932 #+kindex: C-c C-e l l
12933 #+findex: org-latex-export-to-latex~
12934 Export to a LaTeX file with a =.tex= extension. For
12935 =myfile.org=, Org exports to =myfile.tex=, overwriting without
12938 - {{{kbd(C-c C-e l L)}}} (~org-latex-export-as-latex~) ::
12940 #+kindex: C-c C-e l L
12941 #+findex: org-latex-export-as-latex
12942 Export to a temporary buffer. Do not create a file.
12944 - {{{kbd(C-c C-e l p)}}} (~org-latex-export-to-pdf~) ::
12946 #+kindex: C-c C-e l p
12947 #+findex: org-latex-export-to-pdf
12948 Export as LaTeX file and convert it to PDF file.
12950 - {{{kbd(C-c C-e l o)}}} ::
12952 #+kindex: C-c C-e l o
12953 Export as LaTeX file and convert it to PDF, then open the PDF
12954 using the default viewer.
12956 - {{{kbd(M-x org-export-region-as-latex)}}} ::
12958 Convert the region to LaTeX under the assumption that it was in Org
12959 mode syntax before. This is a global command that can be invoked in
12962 #+vindex: org-latex-compiler
12963 #+vindex: org-latex-bibtex-compiler
12964 #+vindex: org-latex-default-packages-alist
12968 #+cindex: @samp{LATEX_COMPILER}, keyword
12969 The LaTeX export back-end can use any of these LaTeX engines:
12970 =pdflatex=, =xelatex=, and =lualatex=. These engines compile LaTeX
12971 files with different compilers, packages, and output options. The
12972 LaTeX export back-end finds the compiler version to use from
12973 ~org-latex-compiler~ variable or the =#+LATEX_COMPILER= keyword in the
12974 Org file. See the docstring for the
12975 ~org-latex-default-packages-alist~ for loading packages with certain
12976 compilers. Also see ~org-latex-bibtex-compiler~ to set the
12977 bibliography compiler[fn:122].
12979 *** LaTeX specific export settings
12981 :DESCRIPTION: Unique to this @LaTeX{} back-end.
12984 The LaTeX export back-end has several additional keywords for
12985 customizing LaTeX output. Setting these keywords works similar to the
12986 general options (see [[*Export Settings]]).
12988 #+attr_texinfo: :sep ,
12990 #+cindex: @samp{DESCRIPTION}, keyword
12991 #+vindex: org-latex-hyperref-template
12992 #+vindex: org-latex-title-command
12993 The document's description. The description along with author
12994 name, keywords, and related file metadata are inserted in the
12995 output file by the hyperref package. See
12996 ~org-latex-hyperref-template~ for customizing metadata items.
12997 See ~org-latex-title-command~ for typesetting description into
12998 the document's front matter. Use multiple =DESCRIPTION= keywords
12999 for long descriptions.
13003 #+cindex: @samp{LATEX_CLASS}, keyword
13004 #+vindex: org-latex-default-class
13005 #+vindex: org-latex-classes
13006 This is LaTeX document class, such as /article/, /report/,
13007 /book/, and so on, which contain predefined preamble and headline
13008 level mapping that the LaTeX export back-end needs. The back-end
13009 reads the default class name from the ~org-latex-default-class~
13010 variable. Org has /article/ as the default class. A valid
13011 default class must be an element of ~org-latex-classes~.
13013 - =LATEX_CLASS_OPTIONS= ::
13015 #+cindex: @samp{LATEX_CLASS_OPTIONS}, keyword
13016 Options the LaTeX export back-end uses when calling the LaTeX
13019 - =LATEX_COMPILER= ::
13021 #+cindex: @samp{LATEX_COMPILER}, keyword
13022 #+vindex: org-latex-compiler
13023 The compiler, such as =pdflatex=, =xelatex=, =lualatex=, for
13024 producing the PDF. See ~org-latex-compiler~.
13026 - =LATEX_HEADER=, =LATEX_HEADER_EXTRA= ::
13028 #+cindex: @samp{LATEX_HEADER}, keyword
13029 #+cindex: @samp{LATEX_HEADER_EXTRA}, keyword
13030 #+vindex: org-latex-classes
13031 Arbitrary lines to add to the document's preamble, before the
13032 hyperref settings. See ~org-latex-classes~ for adjusting the
13033 structure and order of the LaTeX headers.
13037 #+cindex: @samp{KEYWORDS}, keyword
13038 #+vindex: org-latex-hyperref-template
13039 #+vindex: org-latex-title-command
13040 The keywords for the document. The description along with author
13041 name, keywords, and related file metadata are inserted in the
13042 output file by the hyperref package. See
13043 ~org-latex-hyperref-template~ for customizing metadata items.
13044 See ~org-latex-title-command~ for typesetting description into
13045 the document's front matter. Use multiple =KEYWORDS= lines if
13050 #+cindex: @samp{SUBTITLE}, keyword
13051 #+vindex: org-latex-subtitle-separate
13052 #+vindex: org-latex-subtitle-format
13053 The document's subtitle. It is typeset as per
13054 ~org-latex-subtitle-format~. If ~org-latex-subtitle-separate~ is
13055 non-~nil~, it is typed as part of the ~\title~ macro. See
13056 ~org-latex-hyperref-template~ for customizing metadata items.
13057 See ~org-latex-title-command~ for typesetting description
13058 into the document's front matter.
13060 The following sections have further details.
13062 *** LaTeX header and sectioning structure
13064 :DESCRIPTION: Setting up the export file structure.
13065 :ALT_TITLE: LaTeX header and sectioning
13067 #+cindex: @LaTeX{} class
13068 #+cindex: @LaTeX{} sectioning structure
13069 #+cindex: @LaTeX{} header
13070 #+cindex: header, for @LaTeX{} files
13071 #+cindex: sectioning structure, for @LaTeX{} export
13073 The LaTeX export back-end converts the first three of Org's outline
13074 levels into LaTeX headlines. The remaining Org levels are exported as
13075 lists. To change this globally for the cut-off point between levels
13076 and lists, (see [[*Export Settings]]).
13078 By default, the LaTeX export back-end uses the /article/ class.
13080 #+vindex: org-latex-default-class
13081 #+vindex: org-latex-classes
13082 #+vindex: org-latex-default-packages-alist
13083 #+vindex: org-latex-packages-alist
13084 To change the default class globally, edit ~org-latex-default-class~.
13085 To change the default class locally in an Org file, add option lines
13086 =#+LATEX_CLASS: myclass=. To change the default class for just a part
13087 of the Org file, set a sub-tree property, =EXPORT_LATEX_CLASS=. The
13088 class name entered here must be valid member of ~org-latex-classes~.
13089 This variable defines a header template for each class into which the
13090 exporter splices the values of ~org-latex-default-packages-alist~ and
13091 ~org-latex-packages-alist~. Use the same three variables to define
13092 custom sectioning or custom classes.
13094 #+cindex: @samp{LATEX_CLASS}, keyword
13095 #+cindex: @samp{LATEX_CLASS_OPTIONS}, keyword
13096 #+cindex: @samp{EXPORT_LATEX_CLASS}, property
13097 #+cindex: @samp{EXPORT_LATEX_CLASS_OPTIONS}, property
13098 The LaTeX export back-end sends the =LATEX_CLASS_OPTIONS= keyword and
13099 =EXPORT_LATEX_CLASS_OPTIONS= property as options to the LaTeX
13100 ~\documentclass~ macro. The options and the syntax for specifying
13101 them, including enclosing them in square brackets, follow LaTeX
13104 : #+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn]
13106 #+cindex: @samp{LATEX_HEADER}, keyword
13107 #+cindex: @samp{LATEX_HEADER_EXTRA}, keyword
13108 The LaTeX export back-end appends values from =LATEX_HEADER= and
13109 =LATEX_HEADER_EXTRA= keywords to the LaTeX header. The docstring for
13110 ~org-latex-classes~ explains in more detail. Also note that LaTeX
13111 export back-end does not append =LATEX_HEADER_EXTRA= to the header
13112 when previewing LaTeX snippets (see [[*Previewing LaTeX fragments]]).
13114 A sample Org file with the above headers:
13117 ,#+LATEX_CLASS: article
13118 ,#+LATEX_CLASS_OPTIONS: [a4paper]
13119 ,#+LATEX_HEADER: \usepackage{xyz}
13127 *** Quoting LaTeX code
13129 :DESCRIPTION: Incorporating literal @LaTeX{} code.
13132 The LaTeX export back-end can insert any arbitrary LaTeX code, see
13133 [[*Embedded LaTeX]]. There are three ways to embed such code in the Org
13134 file and they all use different quoting syntax.
13136 #+cindex: inline, in @LaTeX{} export
13137 Inserting in-line quoted with @ symbols:
13139 : Code embedded in-line @@latex:any arbitrary LaTeX code@@ in a paragraph.
13141 #+cindex: @samp{LATEX}, keyword
13142 Inserting as one or more keyword lines in the Org file:
13144 : #+LATEX: any arbitrary LaTeX code
13146 #+cindex: @samp{BEGIN_EXPORT latex}
13147 Inserting as an export block in the Org file, where the back-end
13148 exports any code between begin and end markers:
13151 ,#+BEGIN_EXPORT latex
13152 any arbitrary LaTeX code
13156 *** Tables in LaTeX export
13158 :DESCRIPTION: Options for exporting tables to @LaTeX{}.
13160 #+cindex: tables, in @LaTeX{} export
13162 The LaTeX export back-end can pass several LaTeX attributes for table
13163 contents and layout. Besides specifying label and caption (see
13164 [[*Images and Tables]]), the other valid LaTeX attributes include:
13166 #+attr_texinfo: :sep ,
13169 #+vindex: org-latex-default-table-mode
13170 The LaTeX export back-end wraps the table differently depending
13171 on the mode for accurate rendering of math symbols. Mode is
13172 either =table=, =math=, =inline-math= or =verbatim=.
13174 For =math= or =inline-math= mode, LaTeX export back-end wraps the
13175 table in a math environment, but every cell in it is exported
13176 as-is. The LaTeX export back-end determines the default mode
13177 from ~org-latex-default-table-mode~. The LaTeX export back-end
13178 merges contiguous tables in the same mode into a single
13181 - =:environment= ::
13183 #+vindex: org-latex-default-table-environment
13184 Set the default LaTeX table environment for the LaTeX export
13185 back-end to use when exporting Org tables. Common LaTeX table
13186 environments are provided by these packages: tabularx, longtable,
13187 array, tabu, and bmatrix. For packages, such as tabularx and
13188 tabu, or any newer replacements, include them in the
13189 ~org-latex-packages-alist~ variable so the LaTeX export back-end
13190 can insert the appropriate load package headers in the converted
13191 LaTeX file. Look in the docstring for the
13192 ~org-latex-packages-alist~ variable for configuring these
13193 packages for LaTeX snippet previews, if any.
13197 Use =CAPTION= keyword to set a simple caption for a table (see
13198 [[*Images and Tables]]). For custom captions, use =:caption=
13199 attribute, which accepts raw LaTeX code. =:caption= value
13200 overrides =CAPTION= value.
13202 - =:float=, =:placement= ::
13204 The table environments by default are not floats in LaTeX. To
13205 make them floating objects use =:float= with one of the following
13206 options: =sideways=, =multicolumn=, =t=, and =nil=.
13208 LaTeX floats can also have additional layout =:placement=
13209 attributes. These are the usual =[h t b p ! H]= permissions
13210 specified in square brackets. Note that for =:float sideways=
13211 tables, the LaTeX export back-end ignores =:placement=
13214 - =:align=, =:font=, =:width= ::
13216 The LaTeX export back-end uses these attributes for regular
13217 tables to set their alignments, fonts, and widths.
13221 When =:spread= is non-~nil~, the LaTeX export back-end spreads or
13222 shrinks the table by the =:width= for tabu and longtabu
13223 environments. =:spread= has no effect if =:width= is not set.
13225 - =:booktabs=, =:center=, =:rmlines= ::
13227 #+vindex: org-latex-tables-booktabs
13228 #+vindex: org-latex-tables-centered
13229 All three commands are toggles. =:booktabs= brings in modern
13230 typesetting enhancements to regular tables. The booktabs package
13231 has to be loaded through ~org-latex-packages-alist~. =:center=
13232 is for centering the table. =:rmlines= removes all but the very
13233 first horizontal line made of ASCII characters from "table.el"
13236 - =:math-prefix=, =:math-suffix=, =:math-arguments= ::
13238 The LaTeX export back-end inserts =:math-prefix= string value in
13239 a math environment before the table. The LaTeX export back-end
13240 inserts =:math-suffix= string value in a math environment after
13241 the table. The LaTeX export back-end inserts =:math-arguments=
13242 string value between the macro name and the table's contents.
13243 =:math-arguments= comes in use for matrix macros that require
13244 more than one argument, such as =qbordermatrix=.
13246 LaTeX table attributes help formatting tables for a wide range of
13247 situations, such as matrix product or spanning multiple pages:
13250 ,#+ATTR_LATEX: :environment longtable :align l|lp{3cm}r|l
13254 ,#+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
13257 ,#+ATTR_LATEX: :mode math :environment bmatrix
13262 Set the caption with the LaTeX command
13263 =\bicaption{HeadingA}{HeadingB}=:
13266 ,#+ATTR_LATEX: :caption \bicaption{HeadingA}{HeadingB}
13271 *** Images in LaTeX export
13273 :DESCRIPTION: How to insert figures into @LaTeX{} output.
13275 #+cindex: images, inline in LaTeX
13276 #+cindex: inlining images in LaTeX
13277 #+cindex: @samp{ATTR_LATEX}, keyword
13279 The LaTeX export back-end processes image links in Org files that do
13280 not have descriptions, such as these links =[[file:img.jpg]]= or
13281 =[[./img.jpg]]=, as direct image insertions in the final PDF output. In
13282 the PDF, they are no longer links but actual images embedded on the
13283 page. The LaTeX export back-end uses =\includegraphics= macro to
13284 insert the image. But for TikZ (http://sourceforge.net/projects/pgf/)
13285 images, the back-end uses an ~\input~ macro wrapped within
13286 a ~tikzpicture~ environment.
13288 For specifying image =:width=, =:height=, and other =:options=, use
13292 ,#+ATTR_LATEX: :width 5cm :options angle=90
13293 [[./img/sed-hr4049.pdf]]
13296 For custom commands for captions, use the =:caption= attribute. It
13297 overrides the default =#+CAPTION= value:
13300 ,#+ATTR_LATEX: :caption \bicaption{HeadingA}{HeadingB}
13301 [[./img/sed-hr4049.pdf]]
13304 When captions follow the method as described in [[*Images and Tables]],
13305 the LaTeX export back-end wraps the picture in a floating =figure=
13306 environment. To float an image without specifying a caption, set the
13307 =:float= attribute to one of the following:
13311 For a standard =figure= environment; used by default whenever an
13312 image has a caption.
13316 To span the image across multiple columns of a page; the back-end
13317 wraps the image in a =figure*= environment.
13321 For text to flow around the image on the right; the figure
13322 occupies the left half of the page.
13326 For a new page with the image sideways, rotated ninety degrees,
13327 in a =sidewaysfigure= environment; overrides =:placement=
13332 To avoid a =:float= even if using a caption.
13334 #+texinfo: @noindent
13335 Use the =placement= attribute to modify a floating environment's
13339 ,#+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement {r}{0.4\textwidth}
13343 #+vindex: org-latex-images-centered
13344 #+cindex: center image in LaTeX export
13345 #+cindex: image, centering in LaTeX export
13346 The LaTeX export back-end centers all images by default. Setting
13347 =:center= to =nil= disables centering. To disable centering globally,
13348 set ~org-latex-images-centered~ to =t=.
13350 Set the =:comment-include= attribute to non-~nil~ value for the LaTeX
13351 export back-end to comment out the =\includegraphics= macro.
13353 *** Plain lists in LaTeX export
13355 :DESCRIPTION: Attributes specific to lists.
13358 #+cindex: plain lists, in @LaTeX{} export
13359 #+cindex: @samp{ATTR_LATEX}, keyword
13360 The LaTeX export back-end accepts the =environment= and =options=
13361 attributes for plain lists. Both attributes work together for
13362 customizing lists, as shown in the examples:
13365 ,#+LATEX_HEADER: \usepackage[inline]{enumitem}
13366 Some ways to say "Hello":
13367 ,#+ATTR_LATEX: :environment itemize*
13368 ,#+ATTR_LATEX: :options [label={}, itemjoin={,}, itemjoin*={, and}]
13374 Since LaTeX supports only four levels of nesting for lists, use an
13375 external package, such as =enumitem= in LaTeX, for levels deeper than
13379 ,#+LATEX_HEADER: \usepackage{enumitem}
13380 ,#+LATEX_HEADER: \renewlist{itemize}{itemize}{9}
13381 ,#+LATEX_HEADER: \setlist[itemize]{label=$\circ$}
13389 *** Source blocks in LaTeX export
13391 :DESCRIPTION: Attributes specific to source code blocks.
13393 #+cindex: source blocks, in @LaTeX{} export
13394 #+cindex: @samp{ATTR_LATEX}, keyword
13396 The LaTeX export back-end can make source code blocks into floating
13397 objects through the attributes =:float= and =:options=. For =:float=:
13401 Makes a source block float; by default floats any source block
13406 Spans the source block across multiple columns of a page.
13410 Avoids a =:float= even if using a caption; useful for source code
13411 blocks that may not fit on a page.
13414 ,#+ATTR_LATEX: :float nil
13415 ,#+BEGIN_SRC emacs-lisp
13416 Lisp code that may not fit in a single page.
13420 #+vindex: org-latex-listings-options
13421 #+vindex: org-latex-minted-options
13422 The LaTeX export back-end passes string values in =:options= to LaTeX
13423 packages for customization of that specific source block. In the
13424 example below, the =:options= are set for Minted. Minted is a source
13425 code highlighting LaTeX package with many configurable options.
13428 ,#+ATTR_LATEX: :options commentstyle=\bfseries
13429 ,#+BEGIN_SRC emacs-lisp
13431 (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
13435 To apply similar configuration options for all source blocks in
13436 a file, use the ~org-latex-listings-options~ and
13437 ~org-latex-minted-options~ variables.
13439 *** Example blocks in LaTeX export
13441 :DESCRIPTION: Attributes specific to example blocks.
13443 #+cindex: example blocks, in @LaTeX{} export
13444 #+cindex: verbatim blocks, in @LaTeX{} export
13445 #+cindex: @samp{ATTR_LATEX}, keyword
13447 The LaTeX export back-end wraps the contents of example blocks in
13448 a =verbatim= environment. To change this behavior to use another
13449 environment globally, specify an appropriate export filter (see
13450 [[*Advanced Configuration]]). To change this behavior to use another
13451 environment for each block, use the =:environment= parameter to
13452 specify a custom environment.
13455 ,#+ATTR_LATEX: :environment myverbatim
13457 This sentence is false.
13461 *** Special blocks in LaTeX export
13463 :DESCRIPTION: Attributes specific to special blocks.
13466 #+cindex: special blocks, in @LaTeX{} export
13467 #+cindex: abstract, in @LaTeX{} export
13468 #+cindex: proof, in @LaTeX{} export
13469 #+cindex: @samp{ATTR_LATEX}, keyword
13471 For other special blocks in the Org file, the LaTeX export back-end
13472 makes a special environment of the same name. The back-end also takes
13473 =:options=, if any, and appends as-is to that environment's opening
13474 string. For example:
13478 We demonstrate how to solve the Syracuse problem.
13481 ,#+ATTR_LATEX: :options [Proof of important theorem]
13484 Therefore, any even number greater than 2 is the sum of two primes.
13488 #+texinfo: @noindent
13493 We demonstrate how to solve the Syracuse problem.
13496 \begin{proof}[Proof of important theorem]
13498 Therefore, any even number greater than 2 is the sum of two primes.
13502 If you need to insert a specific caption command, use =:caption=
13503 attribute. It overrides standard =CAPTION= value, if any. For
13507 ,#+ATTR_LATEX: :caption \MyCaption{HeadingA}
13513 *** Horizontal rules in LaTeX export
13515 :DESCRIPTION: Attributes specific to horizontal rules.
13517 #+cindex: horizontal rules, in @LaTeX{} export
13518 #+cindex: @samp{ATTR_LATEX}, keyword
13520 The LaTeX export back-end converts horizontal rules by the specified
13521 =:width= and =:thickness= attributes. For example:
13524 ,#+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
13530 :DESCRIPTION: Exporting to Markdown.
13532 #+cindex: Markdown export
13534 The Markdown export back-end, "md", converts an Org file to a Markdown
13535 format, as defined at http://daringfireball.net/projects/markdown/.
13537 Since "md" is built on top of the HTML back-end, any Org constructs
13538 not supported by Markdown, such as tables, the underlying "html"
13539 back-end (see [[*HTML Export]]) converts them.
13541 *** Markdown export commands
13546 - {{{kbd(C-c C-e m m)}}} (~org-md-export-to-markdown~) ::
13548 #+kindex: C-c C-c m m
13549 #+findex: org-md-export-to-markdown
13550 Export to a text file with Markdown syntax. For =myfile.org=,
13551 Org exports to =myfile.md=, overwritten without warning.
13553 - {{{kbd(C-c C-e m M)}}} (~org-md-export-as-markdown~) ::
13555 #+kindex: C-c C-c m M
13556 #+findex: org-md-export-as-markdown
13557 Export to a temporary buffer. Does not create a file.
13559 - {{{kbd(C-c C-e m o)}}} ::
13561 #+kindex: C-c C-e m o
13562 Export as a text file with Markdown syntax, then open it.
13564 *** Header and sectioning structure
13569 #+vindex: org-md-headline-style
13570 Based on ~org-md-headline-style~, Markdown export can generate
13571 headlines of both /atx/ and /setext/ types. /atx/ limits headline
13572 levels to two whereas /setext/ limits headline levels to six. Beyond
13573 these limits, the export back-end converts headlines to lists. To set
13574 a limit to a level before the absolute limit (see [[*Export Settings]]).
13576 ** OpenDocument Text Export
13578 :DESCRIPTION: Exporting to OpenDocument Text.
13581 #+cindex: OpenDocument
13582 #+cindex: export, OpenDocument
13583 #+cindex: LibreOffice
13585 The ODT export back-end handles creating of OpenDocument Text (ODT)
13586 format. Documents created by this exporter use the
13587 {{{cite(OpenDocument-v1.2 specification)}}}[fn:123] and are compatible
13588 with LibreOffice 3.4.
13590 *** Pre-requisites for ODT export
13592 :DESCRIPTION: Required packages.
13596 The ODT export back-end relies on the zip program to create the final
13597 compressed ODT output. Check if =zip= is locally available and
13598 executable. Without it, export cannot finish.
13600 *** ODT export commands
13602 :DESCRIPTION: Invoking export.
13605 - {{{kbd(C-c C-e o o)}}} (~org-export-to-odt~) ::
13607 #+kindex: C-c C-e o o
13608 #+findex: org-export-to-odt
13609 Export as OpenDocument Text file.
13611 #+cindex: @samp{EXPORT_FILE_NAME}, property
13612 #+vindex: org-odt-preferred-output-format
13614 If ~org-odt-preferred-output-format~ is specified, the ODT export
13615 back-end automatically converts the exported file to that format.
13617 For =myfile.org=, Org exports to =myfile.odt=, overwriting
13618 without warning. The ODT export back-end exports a region only
13619 if a region was active.
13621 If the selected region is a single tree, the ODT export back-end
13622 makes the tree head the document title. Incidentally, {{{kbd(C-c
13623 @)}}} selects the current sub-tree. If the tree head entry has,
13624 or inherits, an =EXPORT_FILE_NAME= property, the ODT export
13625 back-end uses that for file name.
13627 - {{{kbd(C-c C-e o O)}}} ::
13629 #+kindex: C-c C-e o O
13630 Export as an OpenDocument Text file and open the resulting file.
13632 #+vindex: org-export-odt-preferred-output-format
13633 If ~org-export-odt-preferred-output-format~ is specified, open
13634 the converted file instead. See [[*Automatically exporting to
13637 *** ODT specific export settings
13639 :DESCRIPTION: Configuration options.
13642 The ODT export back-end has several additional keywords for
13643 customizing ODT output. Setting these keywords works similar to the
13644 general options (see [[*Export Settings]]).
13648 #+cindex: @samp{DESCRIPTION}, keyword
13649 This is the document's description, which the ODT export back-end
13650 inserts as document metadata. For long descriptions, use
13651 multiple lines, prefixed with =DESCRIPTION=.
13655 #+cindex: @samp{KEYWORDS}, keyword
13656 The keywords for the document. The ODT export back-end inserts
13657 the description along with author name, keywords, and related
13658 file metadata as metadata in the output file. Use multiple
13659 =KEYWORDS= if necessary.
13661 - =ODT_STYLES_FILE= ::
13663 #+cindex: @samp{ODT_STYLES_FILE}, keyword
13664 #+vindex: org-odt-styles-file
13665 The ODT export back-end uses the ~org-odt-styles-file~ by
13666 default. See [[*Applying custom styles]] for details.
13670 #+cindex: @samp{SUBTITLE}, keyword
13671 The document subtitle.
13673 *** Extending ODT export
13675 :DESCRIPTION: Producing DOC, PDF files.
13678 The ODT export back-end can produce documents in other formats besides
13679 ODT using a specialized ODT converter process. Its common interface
13680 works with popular converters to produce formats such as =doc=, or
13681 convert a document from one format, say =csv=, to another format, say
13684 #+cindex: @file{unoconv}
13685 #+vindex: org-odt-convert-process
13686 Customize ~org-odt-convert-process~ variable to point to =unoconv=,
13687 which is the ODT's preferred converter. Working installations of
13688 LibreOffice would already have =unoconv= installed. Alternatively,
13689 other converters may be substituted here. See [[*Configuring
13690 a document converter]].
13692 **** Automatically exporting to other formats
13697 #+vindex: org-odt-preferred-output-format
13698 If ODT format is just an intermediate step to get to other formats,
13699 such as =doc=, =docx=, =rtf=, or =pdf=, etc., then extend the ODT
13700 export back-end to directly produce that format. Specify the final
13701 format in the ~org-odt-preferred-output-format~ variable. This is one
13702 way to extend (see [[*ODT export commands]]).
13704 **** Converting between document formats
13709 The Org export back-end is made to be inter-operable with a wide range
13710 of text document format converters. Newer generation converters, such
13711 as LibreOffice and Pandoc, can handle hundreds of formats at once.
13712 Org provides a consistent interaction with whatever converter is
13713 installed. Here are some generic commands:
13715 - {{{kbd(M-x org-odt-convert)}}} ::
13717 #+findex: org-odt-convert
13718 Convert an existing document from one format to another. With
13719 a prefix argument, opens the newly produced file.
13721 *** Applying custom styles
13723 :DESCRIPTION: Styling the output.
13725 #+cindex: styles, custom
13726 #+cindex: template, custom
13728 The ODT export back-end comes with many OpenDocument styles (see
13729 [[*Working with OpenDocument style files]]). To expand or further
13730 customize these built-in style sheets, either edit the style sheets
13731 directly or generate them using an application such as LibreOffice.
13732 The example here shows creating a style using LibreOffice.
13734 **** Applying custom styles: the easy way
13739 1. Create a sample =example.org= file with settings as shown below,
13740 and export it to ODT format.
13742 : #+OPTIONS: H:10 num:t
13744 2. Open the above =example.odt= using LibreOffice. Use the /Stylist/
13745 to locate the target styles, which typically have the "Org" prefix.
13746 Open one, modify, and save as either OpenDocument Text (ODT) or
13747 OpenDocument Template (OTT) file.
13750 #+vindex: org-odt-styles-file
13751 Customize the variable ~org-odt-styles-file~ and point it to the
13752 newly created file. For additional configuration options, see
13753 [[x-overriding-factory-styles][Overriding factory styles]].
13755 #+cindex: @samp{ODT_STYLES_FILE}, keyword
13756 To apply an ODT style to a particular file, use the
13757 =ODT_STYLES_FILE= keyword as shown in the example below:
13759 : #+ODT_STYLES_FILE: "/path/to/example.ott"
13761 #+texinfo: @noindent
13764 : #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
13766 **** Using third-party styles and templates
13771 The ODT export back-end relies on many templates and style names.
13772 Using third-party styles and templates can lead to mismatches.
13773 Templates derived from built in ODT templates and styles seem to have
13776 *** Links in ODT export
13778 :DESCRIPTION: Handling and formatting links.
13780 #+cindex: links, in ODT export
13782 ODT exporter creates native cross-references for internal links. It
13783 creates Internet-style links for all other links.
13785 A link with no description and pointing to a regular, un-itemized,
13786 outline heading is replaced with a cross-reference and section number
13789 A =\ref{label}=-style reference to an image, table etc., is replaced
13790 with a cross-reference and sequence number of the labeled entity. See
13791 [[*Labels and captions in ODT export]].
13793 *** Tables in ODT export
13795 :DESCRIPTION: Org tables conversions.
13798 #+cindex: tables, in ODT export
13800 The ODT export back-end handles native Org mode tables (see [[*Tables]])
13801 and simple =table.el= tables. Complex =table.el= tables having column
13802 or row spans are not supported. Such tables are stripped from the
13805 By default, the ODT export back-end exports a table with top and
13806 bottom frames and with ruled lines separating row and column groups
13807 (see [[*Column Groups]]). All tables are typeset to occupy the same
13808 width. The ODT export back-end honors any table alignments and
13809 relative widths for columns (see [[*Column Width and Alignment]]).
13811 Note that the ODT export back-end interprets column widths as weighted
13812 ratios, the default weight being 1.
13814 #+cindex: @samp{ATTR_ODT}, keyword
13815 Specifying =:rel-width= property on an =ATTR_ODT= line controls the
13816 width of the table. For example:
13819 ,#+ATTR_ODT: :rel-width 50
13820 | Area/Month | Jan | Feb | Mar | Sum |
13821 |---------------+-------+-------+-------+-------|
13823 | <l13> | <r5> | <r5> | <r5> | <r6> |
13824 | North America | 1 | 21 | 926 | 948 |
13825 | Middle East | 6 | 75 | 844 | 925 |
13826 | Asia Pacific | 9 | 27 | 790 | 826 |
13827 |---------------+-------+-------+-------+-------|
13828 | Sum | 16 | 123 | 2560 | 2699 |
13831 On export, the above table takes 50% of text width area. The exporter
13832 sizes the columns in the ratio: 13:5:5:5:6. The first column is
13833 left-aligned and rest of the columns, right-aligned. Vertical rules
13834 separate the header and the last column. Horizontal rules separate
13835 the header and the last row.
13837 For even more customization, create custom table styles and associate
13838 them with a table using the =ATTR_ODT= keyword. See [[*Customizing
13839 tables in ODT export]].
13841 *** Images in ODT export
13843 :DESCRIPTION: Inserting images.
13845 #+cindex: images, embedding in ODT
13846 #+cindex: embedding images in ODT
13848 **** Embedding images
13853 The ODT export back-end processes image links in Org files that do not
13854 have descriptions, such as these links =[[file:img.jpg]]= or =[[./img.jpg]]=,
13855 as direct image insertions in the final output. Either of these
13862 **** Embedding clickable images
13867 For clickable images, provide a link whose description is another link
13868 to an image file. For example, to embed an image
13869 =org-mode-unicorn.png= which when clicked jumps to https://orgmode.org
13870 website, do the following
13872 : [[https://orgmode.org][./org-mode-unicorn.png]]
13874 **** Sizing and scaling of embedded images
13879 #+cindex: @samp{ATTR_ODT}, keyword
13881 Control the size and scale of the embedded images with the =ATTR_ODT=
13884 #+cindex: identify, ImageMagick
13885 #+vindex: org-odt-pixels-per-inch
13886 The ODT export back-end starts with establishing the size of the image
13887 in the final document. The dimensions of this size are measured in
13888 centimeters. The back-end then queries the image file for its
13889 dimensions measured in pixels. For this measurement, the back-end
13890 relies on ImageMagick's identify program or Emacs ~create-image~ and
13891 ~image-size~ API. ImageMagick is the preferred choice for large file
13892 sizes or frequent batch operations. The back-end then converts the
13893 pixel dimensions using ~org-odt-pixels-per-inch~ into the familiar 72
13894 dpi or 96 dpi. The default value for this is in
13895 ~display-pixels-per-inch~, which can be tweaked for better results
13896 based on the capabilities of the output device. Here are some common
13897 image scaling operations:
13899 - Explicitly size the image ::
13901 To embed =img.png= as a 10 cm x 10 cm image, do the following:
13904 ,#+ATTR_ODT: :width 10 :height 10
13908 - Scale the image ::
13910 To embed =img.png= at half its size, do the following:
13913 ,#+ATTR_ODT: :scale 0.5
13917 - Scale the image to a specific width ::
13919 To embed =img.png= with a width of 10 cm while retaining the
13920 original height:width ratio, do the following:
13923 ,#+ATTR_ODT: :width 10
13927 - Scale the image to a specific height ::
13929 To embed =img.png= with a height of 10 cm while retaining the
13930 original height:width ratio, do the following:
13933 ,#+ATTR_ODT: :height 10
13937 **** Anchoring of images
13942 #+cindex: @samp{ATTR_ODT}, keyword
13943 The ODT export back-end can anchor images to ="as-char"=,
13944 ="paragraph"=, or ="page"=. Set the preferred anchor using the
13945 =:anchor= property of the =ATTR_ODT= line.
13947 To create an image that is anchored to a page:
13950 ,#+ATTR_ODT: :anchor "page"
13954 *** Math formatting in ODT export
13956 :DESCRIPTION: Formatting @LaTeX{} fragments.
13959 The ODT exporter has special support for handling math.
13961 **** LaTeX math snippets
13963 :DESCRIPTION: Embedding in @LaTeX{} format.
13966 LaTeX math snippets (see [[*LaTeX fragments]]) can be embedded in the ODT
13967 document in one of the following ways:
13972 Add this line to the Org file. This option is activated on
13977 With this option, LaTeX fragments are first converted into MathML
13978 fragments using an external LaTeX-to-MathML converter program.
13979 The resulting MathML fragments are then embedded as an
13980 OpenDocument Formula in the exported document.
13982 #+vindex: org-latex-to-mathml-convert-command
13983 #+vindex: org-latex-to-mathml-jar-file
13984 You can specify the LaTeX-to-MathML converter by customizing the
13985 variables ~org-latex-to-mathml-convert-command~ and
13986 ~org-latex-to-mathml-jar-file~.
13988 If you prefer to use MathToWeb[fn:124] as your converter, you can
13989 configure the above variables as shown below.
13991 #+begin_src emacs-lisp
13992 (setq org-latex-to-mathml-convert-command
13993 "java -jar %j -unicode -force -df %o %I"
13994 org-latex-to-mathml-jar-file
13995 "/path/to/mathtoweb.jar")
13998 To use LaTeX​ML[fn:125] use
14000 #+begin_src emacs-lisp
14001 (setq org-latex-to-mathml-convert-command
14002 "latexmlmath \"%i\" --presentationmathml=%o")
14005 To quickly verify the reliability of the LaTeX-to-MathML
14006 converter, use the following commands:
14008 - {{{kbd(M-x org-export-as-odf)}}} ::
14010 Convert a LaTeX math snippet to an OpenDocument formula
14013 - {{{kbd(M-x org-export-as-odf-and-open)}}} ::
14015 Convert a LaTeX math snippet to an OpenDocument formula
14016 (=.odf=) file and open the formula file with the
14017 system-registered application.
14023 #+cindex: ImageMagick
14024 Add this line to the Org file. This option is activated on
14027 : #+OPTIONS: tex:dvipng
14029 : #+OPTIONS: tex:dvisvgm
14031 #+texinfo: @noindent
14034 : #+OPTIONS: tex:imagemagick
14036 Under this option, LaTeX fragments are processed into PNG or SVG
14037 images and the resulting images are embedded in the exported
14038 document. This method requires dvipng program, dvisvgm or
14039 ImageMagick programs.
14041 **** MathML and OpenDocument formula files
14043 :DESCRIPTION: Embedding in native format.
14046 When embedding LaTeX math snippets in ODT documents is not reliable,
14047 there is one more option to try. Embed an equation by linking to its
14048 MathML (=.mml=) source or its OpenDocument formula (=.odf=) file as
14051 : [[./equation.mml]]
14053 #+texinfo: @noindent
14056 : [[./equation.odf]]
14058 *** Labels and captions in ODT export
14060 :DESCRIPTION: Rendering objects.
14063 ODT format handles labeling and captioning of objects based on their
14064 types. Inline images, tables, LaTeX fragments, and Math formulas are
14065 numbered and captioned separately. Each object also gets a unique
14066 sequence number based on its order of first appearance in the Org
14067 file. Each category has its own sequence. A caption is just a label
14068 applied to these objects.
14071 ,#+CAPTION: Bell curve
14072 ,#+NAME: fig:SED-HR4049
14076 When rendered, it may show as follows in the exported document:
14078 : Figure 2: Bell curve
14080 #+vindex: org-odt-category-map-alist
14081 To modify the category component of the caption, customize the option
14082 ~org-odt-category-map-alist~. For example, to tag embedded images
14083 with the string "Illustration" instead of the default string "Figure",
14084 use the following setting:
14086 #+begin_src emacs-lisp
14087 (setq org-odt-category-map-alist
14088 '(("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
14091 With the above modification, the previous example changes to:
14093 : Illustration 2: Bell curve
14095 *** Literal examples in ODT export
14097 :DESCRIPTION: For source code and example blocks.
14100 The ODT export back-end supports literal examples (see [[*Literal
14101 Examples]]) with full fontification. Internally, the ODT export
14102 back-end relies on =htmlfontify.el= to generate the style definitions
14103 needed for fancy listings. The auto-generated styles get =OrgSrc=
14104 prefix and inherit colors from the faces used by Emacs Font Lock
14105 library for that source language.
14107 #+vindex: org-odt-fontify-srcblocks
14108 For custom fontification styles, customize the
14109 ~org-odt-create-custom-styles-for-srcblocks~ option.
14111 #+vindex: org-odt-create-custom-styles-for-srcblocks
14112 To turn off fontification of literal examples, customize the
14113 ~org-odt-fontify-srcblocks~ option.
14115 *** Advanced topics in ODT export
14117 :DESCRIPTION: For power users.
14120 The ODT export back-end has extensive features useful for power users
14121 and frequent uses of ODT formats.
14123 **** Configuring a document converter
14125 :DESCRIPTION: Registering a document converter.
14129 #+cindex: doc, docx, rtf
14130 #+cindex: converter
14132 The ODT export back-end works with popular converters with little or
14133 no extra configuration. See [[*Extending ODT export]]. The following is
14134 for unsupported converters or tweaking existing defaults.
14136 - Register the converter ::
14138 #+vindex: org-export-odt-convert-processes
14139 Add the name of the converter to the ~org-odt-convert-processes~
14140 variable. Note that it also requires how the converter is
14141 invoked on the command line. See the variable's docstring for
14144 - Configure its capabilities ::
14146 #+vindex: org-export-odt-convert-capabilities
14147 Specify which formats the converter can handle by customizing the
14148 variable ~org-odt-convert-capabilities~. Use the entry for the
14149 default values in this variable for configuring the new
14150 converter. Also see its docstring for details.
14152 - Choose the converter ::
14154 #+vindex: org-export-odt-convert-process
14155 Select the newly added converter as the preferred one by
14156 customizing the option ~org-odt-convert-process~.
14158 **** Working with OpenDocument style files
14160 :DESCRIPTION: Exploring internals.
14163 #+cindex: styles, custom
14164 #+cindex: template, custom
14166 This section explores the internals of the ODT exporter; the means by which
14167 it produces styled documents; the use of automatic and custom OpenDocument
14170 The ODT exporter relies on two files for generating its output. These
14171 files are bundled with the distribution under the directory pointed to
14172 by the variable ~org-odt-styles-dir~. The two files are:
14174 - =OrgOdtStyles.xml= <<x-orgodtstyles-xml>> ::
14176 This file contributes to the =styles.xml= file of the final ODT
14177 document. This file gets modified for the following purposes:
14179 1. To control outline numbering based on user settings;
14181 2. To add styles generated by =htmlfontify.el= for fontification of
14184 - =OrgOdtContentTemplate.xml= <<x-orgodtcontenttemplate-xml>> ::
14186 This file contributes to the =content.xml= file of the final ODT
14187 document. The contents of the Org outline are inserted between the
14188 =<office:text>= ... =</office:text>= elements of this file.
14190 Apart from serving as a template file for the final =content.xml=,
14191 the file serves the following purposes:
14193 1. It contains automatic styles for formatting of tables which are
14194 referenced by the exporter;
14196 2. It contains =<text:sequence-decl>= ... =</text:sequence-decl>=
14197 elements that control numbering of tables, images, equations, and
14200 <<x-overriding-factory-styles>> The following two variables control
14201 the location from where the ODT exporter picks up the custom styles
14202 and content template files. Customize these variables to override the
14203 factory styles used by the exporter.
14205 - ~org-odt-styles-file~ ::
14207 The ODT export back-end uses the file pointed to by this
14208 variable, such as =styles.xml=, for the final output. It can
14209 take one of the following values:
14213 Use this file instead of the default =styles.xml=
14215 - =FILE.odt= or =FILE.ott= ::
14217 Use the =styles.xml= contained in the specified OpenDocument
14218 Text or Template file
14220 - =FILE.odt= or =FILE.ott= and a subset of included files ::
14222 Use the =styles.xml= contained in the specified OpenDocument
14223 Text or Template file. Additionally extract the specified
14224 member files and embed those within the final ODT document.
14226 Use this option if the =styles.xml= file references additional
14227 files like header and footer images.
14231 Use the default =styles.xml=.
14233 - ~org-odt-content-template-file~ ::
14235 Use this variable to specify the blank =content.xml= used in the
14238 **** Creating one-off styles
14240 :DESCRIPTION: Customizing styles, highlighting...
14244 The ODT export back-end can read embedded raw OpenDocument XML from
14245 the Org file. Such direct formatting is useful for one-off instances.
14247 - Embedding ODT tags as part of regular text ::
14249 Enclose OpenDocument syntax in =@@odt:...@@= for inline markup.
14250 For example, to highlight a region of text do the following:
14253 @@odt:<text:span text:style-name="Highlight">This is highlighted
14254 text</text:span>@@. But this is regular text.
14257 *Hint:* To see the above example in action, edit the =styles.xml=
14258 (see [[x-orgodtstyles-xml][Factory styles]]) and add a custom /Highlight/ style as shown
14262 <style:style style:name="Highlight" style:family="text">
14263 <style:text-properties fo:background-color="#ff0000"/>
14267 - Embedding a one-line OpenDocument XML ::
14269 #+cindex: @samp{ODT}, keyword
14270 The ODT export back-end can read one-liner options with =#+ODT:=
14271 in the Org file. For example, to force a page break:
14274 ,#+ODT: <text:p text:style-name="PageBreak"/>
14277 *Hint:* To see the above example in action, edit your
14278 =styles.xml= (see [[x-orgodtstyles-xml][Factory styles]]) and add a custom =PageBreak=
14279 style as shown below.
14282 <style:style style:name="PageBreak" style:family="paragraph"
14283 style:parent-style-name="Text_20_body">
14284 <style:paragraph-properties fo:break-before="page"/>
14288 - Embedding a block of OpenDocument XML ::
14290 The ODT export back-end can also read ODT export blocks for
14291 OpenDocument XML. Such blocks use the =#+BEGIN_EXPORT odt=
14292 ... =#+END_EXPORT= constructs.
14294 For example, to create a one-off paragraph that uses bold text,
14298 ,#+BEGIN_EXPORT odt
14299 <text:p text:style-name="Text_20_body_20_bold">
14300 This paragraph is specially formatted and uses bold text.
14305 **** Customizing tables in ODT export
14307 :DESCRIPTION: Defining table templates.
14310 #+cindex: tables, in ODT export
14311 #+cindex: @samp{ATTR_ODT}, keyword
14313 Override the default table format by specifying a custom table style
14314 with the =#+ATTR_ODT= line. For a discussion on default formatting of
14315 tables, see [[*Tables in ODT export]].
14317 This feature closely mimics the way table templates are defined in the
14318 OpenDocument-v1.2 specification.[fn:126]
14320 #+vindex: org-odt-table-styles
14321 For quick preview of this feature, install the settings below and export the
14322 table that follows:
14324 #+begin_src emacs-lisp
14325 (setq org-export-odt-table-styles
14326 (append org-export-odt-table-styles
14327 '(("TableWithHeaderRowAndColumn" "Custom"
14328 ((use-first-row-styles . t)
14329 (use-first-column-styles . t)))
14330 ("TableWithFirstRowandLastRow" "Custom"
14331 ((use-first-row-styles . t)
14332 (use-last-row-styles . t))))))
14336 ,#+ATTR_ODT: :style TableWithHeaderRowAndColumn
14337 | Name | Phone | Age |
14338 | Peter | 1234 | 17 |
14339 | Anna | 4321 | 25 |
14342 The example above used =Custom= template and installed two table
14343 styles =TableWithHeaderRowAndColumn= and
14344 =TableWithFirstRowandLastRow=. *Important:* The OpenDocument styles
14345 needed for producing the above template were pre-defined. They are
14346 available in the section marked =Custom Table Template= in
14347 =OrgOdtContentTemplate.xml= (see [[x-orgodtcontenttemplate-xml][Factory styles]]). For adding new
14348 templates, define new styles there.
14350 To use this feature proceed as follows:
14352 1. Create a table template[fn:127].
14354 A table template is set of =table-cell= and =paragraph= styles for
14355 each of the following table cell categories:
14367 The names for the above styles must be chosen based on the name of
14368 the table template using a well-defined convention.
14370 The naming convention is better illustrated with an example. For
14371 a table template with the name =Custom=, the needed style names are
14372 listed in the following table.
14374 | Cell type | Cell style | Paragraph style |
14375 |--------------+------------------------------+-----------------------------------|
14376 | Body | =CustomTableCell= | =CustomTableParagraph= |
14377 | First column | =CustomFirstColumnTableCell= | =CustomFirstColumnTableParagraph= |
14378 | Last column | =CustomLastColumnTableCell= | =CustomLastColumnTableParagraph= |
14379 | First row | =CustomFirstRowTableCell= | =CustomFirstRowTableParagraph= |
14380 | Last row | =CustomLastRowTableCell= | =CustomLastRowTableParagraph= |
14381 | Even row | =CustomEvenRowTableCell= | =CustomEvenRowTableParagraph= |
14382 | Odd row | =CustomOddRowTableCell= | =CustomOddRowTableParagraph= |
14383 | Even column | =CustomEvenColumnTableCell= | =CustomEvenColumnTableParagraph= |
14384 | Odd column | =CustomOddColumnTableCell= | =CustomOddColumnTableParagraph= |
14386 To create a table template with the name =Custom=, define the above
14387 styles in the =<office:automatic-styles>= ...
14388 =</office:automatic-styles>= element of the content template file
14389 (see [[x-orgodtcontenttemplate-xml][Factory styles]]).
14391 2. Define a table style[fn:128].
14393 #+vindex: org-odt-table-styles
14394 To define a table style, create an entry for the style in the
14395 variable ~org-odt-table-styles~ and specify the following:
14397 - the name of the table template created in step (1),
14398 - the set of cell styles in that template that are to be activated.
14400 For example, the entry below defines two different table styles
14401 =TableWithHeaderRowAndColumn= and =TableWithFirstRowandLastRow=
14402 based on the same template =Custom=. The styles achieve their
14403 intended effect by selectively activating the individual cell
14404 styles in that template.
14406 #+begin_src emacs-lisp
14407 (setq org-export-odt-table-styles
14408 (append org-export-odt-table-styles
14409 '(("TableWithHeaderRowAndColumn" "Custom"
14410 ((use-first-row-styles . t)
14411 (use-first-column-styles . t)))
14412 ("TableWithFirstRowandLastRow" "Custom"
14413 ((use-first-row-styles . t)
14414 (use-last-row-styles . t))))))
14417 3. Associate a table with the table style.
14419 To do this, specify the table style created in step (2) as part of
14420 the =ATTR_ODT= line as shown below.
14423 ,#+ATTR_ODT: :style TableWithHeaderRowAndColumn
14424 | Name | Phone | Age |
14425 | Peter | 1234 | 17 |
14426 | Anna | 4321 | 25 |
14429 **** Validating OpenDocument XML
14431 :DESCRIPTION: Debugging corrupted OpenDocument files.
14435 Sometimes ODT format files may not open due to =.odt= file corruption.
14436 To verify if such a file is corrupt, validate it against the
14437 OpenDocument Relax NG Compact (RNC) syntax schema. But first the
14438 =.odt= files have to be decompressed using =zip=. Note that =.odt=
14439 files are ZIP archives: [[info:emacs::File Archives]]. The contents of
14440 ODT files are in XML. For general help with validation---and
14441 schema-sensitive editing---of XML files:
14442 [[info:nxml-mode::Introduction]].
14444 #+vindex: org-export-odt-schema-dir
14445 Customize ~org-odt-schema-dir~ to point to a directory with
14446 OpenDocument RNC files and the needed schema-locating rules. The ODT
14447 export back-end takes care of updating the
14448 ~rng-schema-locating-files~.
14452 :DESCRIPTION: Exporting to Org.
14455 #+cindex: Org export
14456 /org/ export back-end creates a normalized version of the Org document
14457 in current buffer. The exporter evaluates Babel code (see [[*Evaluating
14458 Code Blocks]]) and removes content specific to other back-ends.
14460 *** Org export commands
14465 - {{{kbd(C-c C-e O o)}}} (~org-org-export-to-org~) ::
14467 #+kindex: C-c C-e O o
14468 #+findex: org-org-export-to-org
14469 Export as an Org file with a =.org= extension. For =myfile.org=,
14470 Org exports to =myfile.org.org=, overwriting without warning.
14472 - {{{kbd(C-c C-e O v)}}} (~~) ::
14474 #+kindex: C-c C-e O v
14475 Export to an Org file, then open it.
14479 :DESCRIPTION: Exporting to Texinfo.
14482 *** Texinfo export commands
14484 :DESCRIPTION: Invoking commands.
14487 - {{{kbd(C-c C-e i t)}}} (~org-texinfo-export-to-texinfo~) ::
14489 #+kindex: C-c C-e i t
14490 #+findex: org-texinfo-export-to-texinfo
14491 Export as a Texinfo file with =.texi= extension. For
14492 =myfile.org=, Org exports to =myfile.texi=, overwriting without
14495 - {{{kbd(C-c C-e i i)}}} (~org-texinfo-export-to-info~) ::
14497 #+kindex: C-c C-e i i
14498 #+findex: org-texinfo-export-to-info
14499 #+vindex: org-texinfo-info-process
14500 Export to Texinfo format first and then process it to make an
14501 Info file. To generate other formats, such as DocBook, customize
14502 the ~org-texinfo-info-process~ variable.
14504 *** Texinfo specific export settings
14506 :DESCRIPTION: Setting the environment.
14509 The Texinfo export back-end has several additional keywords for
14510 customizing Texinfo output. Setting these keywords works similar to
14511 the general options (see [[*Export Settings]]).
14515 #+cindex: @samp{SUBTITLE}, keyword
14516 The document subtitle.
14520 #+cindex: @samp{SUBAUTHOR}, keyword
14521 Additional authors for the document.
14523 - =TEXINFO_FILENAME= ::
14525 #+cindex: @samp{TEXINFO_FILENAME}, keyword
14526 The Texinfo filename.
14528 - =TEXINFO_CLASS= ::
14530 #+cindex: @samp{TEXINFO_CLASS}, keyword
14531 #+vindex: org-texinfo-default-class
14532 The default document class (~org-texinfo-default-class~), which
14533 must be a member of ~org-texinfo-classes~.
14535 - =TEXINFO_HEADER= ::
14537 #+cindex: @samp{TEXINFO_HEADER}, keyword
14538 Arbitrary lines inserted at the end of the header.
14540 - =TEXINFO_POST_HEADER= ::
14542 #+cindex: @samp{TEXINFO_POST_HEADER}, keyword
14543 Arbitrary lines inserted after the end of the header.
14545 - =TEXINFO_DIR_CATEGORY= ::
14547 #+cindex: @samp{TEXINFO_DIR_CATEGORY}, keyword
14548 The directory category of the document.
14550 - =TEXINFO_DIR_TITLE= ::
14552 #+cindex: @samp{TEXINFO_DIR_TITLE}, keyword
14553 The directory title of the document.
14555 - =TEXINFO_DIR_DESC= ::
14557 #+cindex: @samp{TEXINFO_DIR_DESC}, keyword
14558 The directory description of the document.
14560 - =TEXINFO_PRINTED_TITLE= ::
14562 #+cindex: @samp{TEXINFO_PRINTED_TITLE}, keyword
14563 The printed title of the document.
14565 *** Texinfo file header
14567 :DESCRIPTION: Generating the header.
14570 #+cindex: @samp{TEXINFO_FILENAME}, keyword
14571 After creating the header for a Texinfo file, the Texinfo back-end
14572 automatically generates a name and destination path for the Info file.
14573 To override this default with a more sensible path and name, specify
14574 the =TEXINFO_FILENAME= keyword.
14576 #+vindex: org-texinfo-coding-system
14577 #+cindex: @samp{TEXINFO_HEADER}, keyword
14578 Along with the output's file name, the Texinfo header also contains
14579 language details (see [[*Export Settings]]) and encoding system as set in
14580 the ~org-texinfo-coding-system~ variable. Insert =TEXINFO_HEADER=
14581 keywords for each additional command in the header, for example:
14583 : #+TEXINFO_HEADER: @synindex
14585 #+cindex: @samp{TEXINFO_CLASS}, keyword
14586 #+vindex: org-texinfo-classes
14587 Instead of repeatedly installing the same set of commands, define
14588 a class in ~org-texinfo-classes~ once, and then activate it in the
14589 document by setting the =TEXINFO_CLASS= keyword to that class.
14591 *** Texinfo title and copyright page
14593 :DESCRIPTION: Creating preamble pages.
14596 #+cindex: @samp{TEXINFO_PRINTED_TITLE}, keyword
14597 The default template for hard copy output has a title page with
14598 =TITLE= and =AUTHOR= keywords (see [[*Export Settings]]). To replace the
14599 regular title with something different for the printed version, use
14600 the =TEXINFO_PRINTED_TITLE= and =SUBTITLE= keywords. Both expect raw
14601 Texinfo code for setting their values.
14603 #+cindex: @samp{SUBAUTHOR}, keyword
14604 If one =AUTHOR= line is not sufficient, add multiple =SUBAUTHOR=
14605 keywords. They have to be set in raw Texinfo code.
14608 ,#+AUTHOR: Jane Smith
14609 ,#+SUBAUTHOR: John Doe
14610 ,#+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt{tex,@*} Is Broken in @TeX{}
14613 #+cindex: @samp{COPYING}, property
14614 Copying material is defined in a dedicated headline with a non-~nil~
14615 =COPYING= property. The back-end inserts the contents within
14616 a =@copying= command at the beginning of the document. The heading
14617 itself does not appear in the structure of the document.
14619 Copyright information is printed on the back of the title page.
14627 This is a short example of a complete Texinfo file, version 1.0.
14629 Copyright \copy 2016 Free Software Foundation, Inc.
14632 *** Info directory file
14634 :DESCRIPTION: Installing a manual in Info file hierarchy.
14637 #+cindex: @samp{dir} file, in Texinfo export
14638 #+cindex: Info directory file, in Texinfo export
14639 #+cindex: @code{install-info}, in Texinfo export
14641 #+cindex: @samp{TEXINFO_DIR_CATEGORY}, keyword
14642 #+cindex: @samp{TEXINFO_DIR_TITLE}, keyword
14643 #+cindex: @samp{TEXINFO_DIR_DESC}, keyword
14644 The end result of the Texinfo export process is the creation of an
14645 Info file. This Info file's metadata has variables for category,
14646 title, and description: =TEXINFO_DIR_CATEGORY=, =TEXINFO_DIR_TITLE=,
14647 and =TEXINFO_DIR_DESC= keywords that establish where in the Info
14648 hierarchy the file fits.
14650 Here is an example that writes to the Info directory file:
14653 ,#+TEXINFO_DIR_CATEGORY: Emacs
14654 ,#+TEXINFO_DIR_TITLE: Org Mode: (org)
14655 ,#+TEXINFO_DIR_DESC: Outline-based notes management and organizer
14658 *** Headings and sectioning structure
14660 :DESCRIPTION: Building document structure.
14663 #+vindex: org-texinfo-classes
14664 #+vindex: org-texinfo-default-class
14665 #+cindex: @samp{TEXINFO_CLASS}, keyword
14666 The Texinfo export back-end uses a pre-defined scheme to convert Org
14667 headlines to equivalent Texinfo structuring commands. A scheme like
14668 this maps top-level headlines to numbered chapters tagged as
14669 ~@chapter~ and lower-level headlines to unnumbered chapters tagged as
14670 ~@unnumbered~. To override such mappings to introduce ~@part~ or
14671 other Texinfo structuring commands, define a new class in
14672 ~org-texinfo-classes~. Activate the new class with the
14673 =TEXINFO_CLASS= keyword. When no new class is defined and activated,
14674 the Texinfo export back-end defaults to the
14675 ~org-texinfo-default-class~.
14677 If an Org headline's level has no associated Texinfo structuring
14678 command, or is below a certain threshold (see [[*Export Settings]]), then
14679 the Texinfo export back-end makes it into a list item.
14681 #+cindex: @samp{APPENDIX}, property
14682 The Texinfo export back-end makes any headline with a non-~nil~
14683 =APPENDIX= property into an appendix. This happens independent of the
14684 Org headline level or the =TEXINFO_CLASS= keyword.
14686 #+cindex: @samp{ALT_TITLE}, property
14687 #+cindex: @samp{DESCRIPTION}, property
14688 The Texinfo export back-end creates a menu entry after the Org
14689 headline for each regular sectioning structure. To override this with
14690 a shorter menu entry, use the =ALT_TITLE= property (see [[*Table of
14691 Contents]]). Texinfo menu entries also have an option for a longer
14692 =DESCRIPTION= property. Here's an example that uses both to override
14693 the default menu entry:
14696 ,* Controlling Screen Display
14698 :ALT_TITLE: Display
14699 :DESCRIPTION: Controlling Screen Display
14703 #+cindex: Top node, in Texinfo export
14704 The text before the first headline belongs to the /Top/ node, i.e.,
14705 the node in which a reader enters an Info manual. As such, it is
14706 expected not to appear in printed output generated from the =.texi=
14707 file. See [[info:texinfo::The%20Top%20Node]], for more information.
14711 :DESCRIPTION: Creating indices.
14714 #+cindex: @samp{CINDEX}, keyword
14715 #+cindex: concept index, in Texinfo export
14716 #+cindex: @samp{FINDEX}, keyword
14717 #+cindex: function index, in Texinfo export
14718 #+cindex: @samp{KINDEX}, keyword
14719 #+cindex: keystroke index, in Texinfo export
14720 #+cindex: @samp{PINDEX}, keyword
14721 #+cindex: program index, in Texinfo export
14722 #+cindex: @samp{TINDEX}, keyword
14723 #+cindex: data type index, in Texinfo export
14724 #+cindex: @samp{VINDEX}, keyword
14725 #+cindex: variable index, in Texinfo export
14726 The Texinfo export back-end recognizes these indexing keywords if used
14727 in the Org file: =CINDEX=, =FINDEX=, =KINDEX=, =PINDEX=, =TINDEX= and
14728 =VINDEX=. Write their value as verbatim Texinfo code; in particular,
14729 ={=, =}= and =@= characters need to be escaped with =@= if they do not
14730 belong to a Texinfo command.
14732 : #+CINDEX: Defining indexing entries
14734 #+cindex: @samp{INDEX}, property
14735 For the back-end to generate an index entry for a headline, set the
14736 =INDEX= property to =cp= or =vr=. These abbreviations come from
14737 Texinfo that stand for concept index and variable index. The Texinfo
14738 manual has abbreviations for all other kinds of indexes. The back-end
14739 exports the headline as an unnumbered chapter or section command, and
14740 then inserts the index after its contents.
14749 *** Quoting Texinfo code
14751 :DESCRIPTION: Incorporating literal Texinfo code.
14754 Use any of the following three methods to insert or escape raw Texinfo
14757 #+cindex: @samp{TEXINFO}, keyword
14758 #+cindex: @samp{BEGIN_EXPORT texinfo}
14760 Richard @@texinfo:@sc{@@Stallman@@texinfo:}@@ commence' GNU.
14762 ,#+TEXINFO: @need800
14763 This paragraph is preceded by...
14765 ,#+BEGIN_EXPORT texinfo
14766 @auindex Johnson, Mark
14767 @auindex Lakoff, George
14771 *** Plain lists in Texinfo export
14773 :DESCRIPTION: List attributes.
14776 #+cindex: @samp{ATTR_TEXINFO}, keyword
14777 #+cindex: two-column tables, in Texinfo export
14779 #+cindex: table types, in Texinfo export
14780 The Texinfo export back-end by default converts description lists in
14781 the Org file using the default command =@table=, which results in
14782 a table with two columns. To change this behavior, specify
14783 =:table-type= with =ftable= or =vtable= attributes. For more
14784 information, see [[info:texinfo::Two-column Tables]].
14786 #+vindex: org-texinfo-table-default-markup
14787 The Texinfo export back-end by default also applies a text highlight
14788 based on the defaults stored in ~org-texinfo-table-default-markup~.
14789 To override the default highlight command, specify another one with
14790 the =:indic= attribute.
14792 #+cindex: multiple items in Texinfo lists
14793 Org syntax is limited to one entry per list item. Nevertheless, the
14794 Texinfo export back-end can split that entry according to any text
14795 provided through the =:sep= attribute. Each part then becomes a new
14796 entry in the first column of the table.
14798 The following example illustrates all the attributes above:
14801 ,#+ATTR_TEXINFO: :table-type vtable :sep , :indic asis
14802 - foo, bar :: This is the common text for variables foo and bar.
14805 #+texinfo: @noindent
14812 This is the common text for variables foo and bar.
14816 *** Tables in Texinfo export
14818 :DESCRIPTION: Table attributes.
14821 #+cindex: @samp{ATTR_TEXINFO}, keyword
14822 When exporting tables, the Texinfo export back-end uses the widest
14823 cell width in each column. To override this and instead specify as
14824 fractions of line length, use the =:columns= attribute. See example
14828 ,#+ATTR_TEXINFO: :columns .5 .5
14829 | a cell | another cell |
14832 *** Images in Texinfo export
14834 :DESCRIPTION: Image attributes.
14837 #+cindex: @samp{ATTR_TEXINFO}, keyword
14838 Insert a file link to the image in the Org file, and the Texinfo
14839 export back-end inserts the image. These links must have the usual
14840 supported image extensions and no descriptions. To scale the image,
14841 use =:width= and =:height= attributes. For alternate text, use =:alt=
14842 and specify the text using Texinfo code, as shown in the example:
14845 ,#+ATTR_TEXINFO: :width 1in :alt Alternate @i{text}
14849 *** Special blocks in Texinfo export
14851 :DESCRIPTION: Special block attributes.
14854 #+cindex: @samp{ATTR_TEXINFO}, keyword
14856 The Texinfo export back-end converts special blocks to commands with
14857 the same name. It also adds any =:options= attributes to the end of
14858 the command, as shown in this example:
14861 ,#+ATTR_TEXINFO: :options org-org-export-to-org ...
14863 A somewhat obsessive function name.
14867 #+texinfo: @noindent
14871 @defun org-org-export-to-org ...
14872 A somewhat obsessive function name.
14876 *** A Texinfo example
14878 :DESCRIPTION: Processing Org to Texinfo.
14881 Here is a more detailed example Org file. See
14882 [[info:texinfo::GNU%20Sample%20Texts]] for an equivalent example using
14886 ,#+TITLE: GNU Sample {{{version}}}
14887 ,#+SUBTITLE: for version {{{version}}}, {{{updated}}}
14888 ,#+AUTHOR: A.U. Thor
14889 ,#+EMAIL: bug-sample@gnu.org
14891 ,#+OPTIONS: ':t toc:t author:t email:t
14894 ,#+MACRO: version 2.0
14895 ,#+MACRO: updated last updated 4 March 2014
14897 ,#+TEXINFO_FILENAME: sample.info
14898 ,#+TEXINFO_HEADER: @syncodeindex pg cp
14900 ,#+TEXINFO_DIR_CATEGORY: Texinfo documentation system
14901 ,#+TEXINFO_DIR_TITLE: sample: (sample)
14902 ,#+TEXINFO_DIR_DESC: Invoking sample
14904 ,#+TEXINFO_PRINTED_TITLE: GNU Sample
14906 This manual is for GNU Sample (version {{{version}}},
14914 This manual is for GNU Sample (version {{{version}}},
14915 {{{updated}}}), which is an example in the Texinfo documentation.
14917 Copyright \copy 2016 Free Software Foundation, Inc.
14920 Permission is granted to copy, distribute and/or modify this
14921 document under the terms of the GNU Free Documentation License,
14922 Version 1.3 or any later version published by the Free Software
14923 Foundation; with no Invariant Sections, with no Front-Cover Texts,
14924 and with no Back-Cover Texts. A copy of the license is included in
14925 the section entitled "GNU Free Documentation License".
14931 ,#+CINDEX: invoking @command{sample}
14933 This is a sample manual. There is no sample program to invoke, but
14934 if there were, you could see its basic usage and command line
14937 ,* GNU Free Documentation License
14942 ,#+TEXINFO: @include fdl.texi
14950 ** iCalendar Export
14952 :DESCRIPTION: Exporting to iCalendar.
14954 #+cindex: iCalendar export
14956 A large part of Org mode's interoperability success is its ability to
14957 easily export to or import from external applications. The iCalendar
14958 export back-end takes calendar data from Org files and exports to the
14959 standard iCalendar format.
14961 #+vindex: org-icalendar-include-todo
14962 #+vindex: org-icalendar-use-deadline
14963 #+vindex: org-icalendar-use-scheduled
14964 The iCalendar export back-end can also incorporate TODO entries based
14965 on the configuration of the ~org-icalendar-include-todo~ variable.
14966 The back-end exports plain timestamps as =VEVENT=, TODO items as
14967 =VTODO=, and also create events from deadlines that are in non-TODO
14968 items. The back-end uses the deadlines and scheduling dates in Org
14969 TODO items for setting the start and due dates for the iCalendar TODO
14970 entry. Consult the ~org-icalendar-use-deadline~ and
14971 ~org-icalendar-use-scheduled~ variables for more details.
14973 #+vindex: org-icalendar-categories
14974 #+vindex: org-icalendar-alarm-time
14975 For tags on the headline, the iCalendar export back-end makes them
14976 into iCalendar categories. To tweak the inheritance of tags and TODO
14977 states, configure the variable ~org-icalendar-categories~. To assign
14978 clock alarms based on time, configure the ~org-icalendar-alarm-time~
14981 #+vindex: org-icalendar-store-UID
14982 #+cindex: @samp{ID}, property
14983 The iCalendar format standard requires globally unique identifier---or
14984 UID---for each entry. The iCalendar export back-end creates UIDs
14985 during export. To save a copy of the UID in the Org file set the
14986 variable ~org-icalendar-store-UID~. The back-end looks for the =ID=
14987 property of the entry for re-using the same UID for subsequent
14990 Since a single Org entry can result in multiple iCalendar
14991 entries---timestamp, deadline, scheduled item, or TODO item---Org adds
14992 prefixes to the UID, depending on which part of the Org entry
14993 triggered the creation of the iCalendar entry. Prefixing ensures UIDs
14994 remains unique, yet enable synchronization programs trace the
14997 - {{{kbd(C-c C-e c f)}}} (~org-icalendar-export-to-ics~) ::
14999 #+kindex: C-c C-e c f
15000 #+findex: org-icalendar-export-to-ics
15001 Create iCalendar entries from the current Org buffer and store
15002 them in the same directory, using a file extension =.ics=.
15004 - {{{kbd(C-c C-e c a)}}} (~org-icalendar-export-agenda-files~) ::
15006 #+kindex: C-c C-e c a
15007 #+findex: org-icalendar-export-agenda-files
15008 Create iCalendar entries from Org files in ~org-agenda-files~ and
15009 store in a separate iCalendar file for each Org file.
15011 - {{{kbd(C-c C-e c c)}}} (~org-icalendar-combine-agenda-files~) ::
15013 #+kindex: C-c C-e c c
15014 #+findex: org-icalendar-combine-agenda-files
15015 #+vindex: org-icalendar-combined-agenda-file
15016 Create a combined iCalendar file from Org files in
15017 ~org-agenda-files~ and write it to
15018 ~org-icalendar-combined-agenda-file~ file name.
15020 #+cindex: @samp{SUMMARY}, property
15021 #+cindex: @samp{DESCRIPTION}, property
15022 #+cindex: @samp{LOCATION}, property
15023 #+cindex: @samp{TIMEZONE}, property
15024 The iCalendar export back-end includes =SUMMARY=, =DESCRIPTION=,
15025 =LOCATION= and =TIMEZONE= properties from the Org entries when
15026 exporting. To force the back-end to inherit the =LOCATION= and
15027 =TIMEZONE= properties, configure the ~org-use-property-inheritance~
15030 #+vindex: org-icalendar-include-body
15031 When Org entries do not have =SUMMARY=, =DESCRIPTION= and =LOCATION=
15032 properties, the iCalendar export back-end derives the summary from the
15033 headline, and derives the description from the body of the Org item.
15034 The ~org-icalendar-include-body~ variable limits the maximum number of
15035 characters of the content are turned into its description.
15037 The =TIMEZONE= property can be used to specify a per-entry time zone,
15038 and is applied to any entry with timestamp information. Time zones
15039 should be specified as per the IANA time zone database format, e.g.,
15040 =Asia/Almaty=. Alternately, the property value can be =UTC=, to force
15041 UTC time for this entry only.
15043 Exporting to iCalendar format depends in large part on the
15044 capabilities of the destination application. Some are more lenient
15045 than others. Consult the Org mode FAQ for advice on specific
15048 ** Other Built-in Back-ends
15050 :DESCRIPTION: Exporting to a man page.
15053 Other export back-ends included with Org are:
15055 - =ox-man.el=: Export to a man page.
15057 To activate such back-ends, either customize ~org-export-backends~ or
15058 load directly with ~(require 'ox-man)~. On successful load, the
15059 back-end adds new keys in the export dispatcher (see [[*The Export
15062 Follow the comment section of such files, for example, =ox-man.el=,
15063 for usage and configuration details.
15065 ** Advanced Configuration
15067 :DESCRIPTION: Fine-tuning the export output.
15075 #+vindex: org-export-before-processing-hook
15076 #+vindex: org-export-before-parsing-hook
15077 The export process executes two hooks before the actual exporting
15078 begins. The first hook, ~org-export-before-processing-hook~, runs
15079 before any expansions of macros, Babel code, and include keywords in
15080 the buffer. The second hook, ~org-export-before-parsing-hook~, runs
15081 before the buffer is parsed.
15083 Functions added to these hooks are called with a single argument: the
15084 export back-end actually used, as a symbol. You may use them for
15085 heavy duty structural modifications of the document. For example, you
15086 can remove every headline in the buffer during export like this:
15088 #+begin_src emacs-lisp
15089 (defun my-headline-removal (backend)
15090 "Remove all headlines in the current buffer.
15091 BACKEND is the export back-end being used, as a symbol."
15093 (lambda () (delete-region (point) (line-beginning-position 2)))))
15095 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
15103 #+cindex: Filters, exporting
15104 Filters are lists of functions to be applied to certain parts for
15105 a given back-end. The output from the first function in the filter is
15106 passed on to the next function in the filter. The final output is the
15107 output from the final function in the filter.
15109 The Org export process has many filter sets applicable to different
15110 types of objects, plain text, parse trees, export options, and final
15111 output formats. The filters are named after the element type or
15112 object type: ~org-export-filter-TYPE-functions~, where {{{var(TYPE)}}}
15113 is the type targeted by the filter. Valid types are:
15115 #+attr_texinfo: :columns 0.33 0.33 0.33
15116 | body | bold | babel-call |
15117 | center-block | clock | code |
15118 | diary-sexp | drawer | dynamic-block |
15119 | entity | example-block | export-block |
15120 | export-snippet | final-output | fixed-width |
15121 | footnote-definition | footnote-reference | headline |
15122 | horizontal-rule | inline-babel-call | inline-src-block |
15123 | inlinetask | italic | item |
15124 | keyword | latex-environment | latex-fragment |
15125 | line-break | link | node-property |
15126 | options | paragraph | parse-tree |
15127 | plain-list | plain-text | planning |
15128 | property-drawer | quote-block | radio-target |
15129 | section | special-block | src-block |
15130 | statistics-cookie | strike-through | subscript |
15131 | superscript | table | table-cell |
15132 | table-row | target | timestamp |
15133 | underline | verbatim | verse-block |
15135 Here is an example filter that replaces non-breaking spaces ~Â ~ in the
15136 Org buffer with =~= for the LaTeX back-end.
15138 #+begin_src emacs-lisp
15139 (defun my-latex-filter-nobreaks (text backend info)
15140 "Ensure \"Â \" are properly handled in LaTeX export."
15141 (when (org-export-derived-backend-p backend 'latex)
15142 (replace-regexp-in-string "Â " "~" text)))
15144 (add-to-list 'org-export-filter-plain-text-functions
15145 'my-latex-filter-nobreaks)
15148 A filter requires three arguments: the code to be transformed, the
15149 name of the back-end, and some optional information about the export
15150 process. The third argument can be safely ignored. Note the use of
15151 ~org-export-derived-backend-p~ predicate that tests for /latex/
15152 back-end or any other back-end, such as /beamer/, derived from
15155 *** Defining filters for individual files
15160 The Org export can filter not just for back-ends, but also for
15161 specific files through the =BIND= keyword. Here is an example with
15162 two filters; one removes brackets from time stamps, and the other
15163 removes strike-through text. The filter functions are defined in
15164 a code block in the same Org file, which is a handy location for
15168 ,#+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
15169 ,#+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
15170 ,#+BEGIN_SRC emacs-lisp :exports results :results none
15171 (defun tmp-f-timestamp (s backend info)
15172 (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
15173 (defun tmp-f-strike-through (s backend info) "")
15177 *** Extending an existing back-end
15182 Some parts of the conversion process can be extended for certain
15183 elements so as to introduce a new or revised translation. That is how
15184 the HTML export back-end was extended to handle Markdown format. The
15185 extensions work seamlessly so any aspect of filtering not done by the
15186 extended back-end is handled by the original back-end. Of all the
15187 export customization in Org, extending is very powerful as it operates
15188 at the parser level.
15190 For this example, make the /ascii/ back-end display the language used
15191 in a source code block. Also make it display only when some attribute
15192 is non-~nil~, like the following:
15194 : #+ATTR_ASCII: :language t
15196 Then extend /ascii/ back-end with a custom "my-ascii" back-end.
15198 #+begin_src emacs-lisp
15199 (defun my-ascii-src-block (src-block contents info)
15200 "Transcode a SRC-BLOCK element from Org to ASCII.
15201 CONTENTS is nil. INFO is a plist used as a communication
15203 (if (not (org-export-read-attribute :attr_ascii src-block :language))
15204 (org-export-with-backend 'ascii src-block contents info)
15206 (format ",--[ %s ]--\n%s`----"
15207 (org-element-property :language src-block)
15208 (replace-regexp-in-string
15210 (org-element-normalize-string
15211 (org-export-format-code-default src-block info)))))))
15213 (org-export-define-derived-backend 'my-ascii 'ascii
15214 :translate-alist '((src-block . my-ascii-src-block)))
15217 The ~my-ascii-src-block~ function looks at the attribute above the
15218 current element. If not true, hands over to /ascii/ back-end. If
15219 true, which it is in this example, it creates a box around the code
15220 and leaves room for the inserting a string for language. The last
15221 form creates the new back-end that springs to action only when
15222 translating ~src-block~ type elements.
15224 To use the newly defined back-end, evaluate the following from an Org
15227 #+begin_src emacs-lisp
15228 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
15231 Further steps to consider would be an interactive function,
15232 self-installing an item in the export dispatcher menu, and other
15233 user-friendly improvements.
15235 ** Export in Foreign Buffers
15237 :DESCRIPTION: Author tables and lists in Org syntax.
15240 The export back-ends in Org often include commands to convert selected
15241 regions. A convenient feature of this in-place conversion is that the
15242 exported output replaces the original source. Here are such
15245 - ~org-html-convert-region-to-html~ ::
15247 #+findex: org-html-convert-region-to-html
15248 Convert the selected region into HTML.
15250 - ~org-latex-convert-region-to-latex~ ::
15252 #+findex: org-latex-convert-region-to-latex
15253 Convert the selected region into LaTeX.
15255 - ~org-texinfo-convert-region-to-texinfo~ ::
15257 #+findex: org-texinfo-convert-region-to-texinfo
15258 Convert the selected region into Texinfo.
15260 - ~org-md-convert-region-to-md~ ::
15262 #+findex: org-md-convert-region-to-md
15263 Convert the selected region into Markdown.
15265 In-place conversions are particularly handy for quick conversion of
15266 tables and lists in foreign buffers. For example, turn on the minor
15267 mode {{{kbd(M-x orgstruct-mode)}}} in an HTML buffer, then use the
15268 convenient Org keyboard commands to create a list, select it, and
15269 covert it to HTML with {{{kbd(M-x org-html-convert-region-to-html)}}}.
15273 :DESCRIPTION: Create a web site of linked Org files.
15275 #+cindex: publishing
15277 Org includes a publishing management system that allows you to
15278 configure automatic HTML conversion of /projects/ composed of
15279 interlinked Org files. You can also configure Org to automatically
15280 upload your exported HTML pages and related attachments, such as
15281 images and source code files, to a web server.
15283 You can also use Org to convert files into PDF, or even combine HTML
15284 and PDF conversion so that files are available in both formats on the
15287 Publishing has been contributed to Org by David O'Toole.
15291 :DESCRIPTION: Defining projects.
15293 Publishing needs significant configuration to specify files,
15294 destination and many other properties of a project.
15296 *** The variable ~org-publish-project-alist~
15298 :DESCRIPTION: The central configuration variable.
15299 :ALT_TITLE: Project alist
15301 #+cindex: projects, for publishing
15303 #+vindex: org-publish-project-alist
15304 Publishing is configured almost entirely through setting the value of
15305 one variable, called ~org-publish-project-alist~. Each element of the
15306 list configures one project, and may be in one of the two following
15309 #+begin_src emacs-lisp
15310 ("project-name" :property value :property value ...)
15313 #+texinfo: @noindent
15314 i.e., a well-formed property list with alternating keys and values,
15317 #+begin_src emacs-lisp
15318 ("project-name" :components ("project-name" "project-name" ...))
15321 In both cases, projects are configured by specifying property values.
15322 A project defines the set of files that are to be published, as well
15323 as the publishing configuration to use when publishing those files.
15324 When a project takes the second form listed above, the individual
15325 members of the ~:components~ property are taken to be sub-projects,
15326 which group together files requiring different publishing options.
15327 When you publish such a "meta-project", all the components are also
15328 published, in the sequence given.
15330 *** Sources and destinations for files
15332 :DESCRIPTION: From here to there.
15333 :ALT_TITLE: Sources and destinations
15335 #+cindex: directories, for publishing
15337 Most properties are optional, but some should always be set. In
15338 particular, Org needs to know where to look for source files, and
15339 where to put published files.
15341 - ~:base-directory~ ::
15343 Directory containing publishing source files.
15345 - ~:publishing-directory~ ::
15347 Directory where output files are published. You can directly
15348 publish to a webserver using a file name syntax appropriate for
15349 the Emacs tramp package. Or you can publish to a local directory
15350 and use external tools to upload your website (see [[*Uploading
15353 - ~:preparation-function~ ::
15355 Function or list of functions to be called before starting the
15356 publishing process, for example, to run =make= for updating files
15357 to be published. Each preparation function is called with
15358 a single argument, the project property list.
15360 - ~:completion-function~ ::
15362 Function or list of functions called after finishing the
15363 publishing process, for example, to change permissions of the
15364 resulting files. Each completion function is called with
15365 a single argument, the project property list.
15367 *** Selecting files
15369 :DESCRIPTION: What files are part of the project?
15371 #+cindex: files, selecting for publishing
15373 By default, all files with extension =.org= in the base directory are
15374 considered part of the project. This can be modified by setting the
15375 following properties
15377 - ~:base-extension~ ::
15379 Extension---without the dot---of source files. This actually
15380 is a regular expression. Set this to the symbol ~any~ if you
15381 want to get all files in ~:base-directory~, even without
15386 Regular expression to match file names that should not be published,
15387 even though they have been selected on the basis of their extension.
15391 List of files to be included regardless of ~:base-extension~ and
15396 Non-~nil~ means, check base-directory recursively for files to
15399 *** Publishing action
15401 :DESCRIPTION: Setting the function doing the publishing.
15403 #+cindex: action, for publishing
15405 Publishing means that a file is copied to the destination directory
15406 and possibly transformed in the process. The default transformation
15407 is to export Org files as HTML files, and this is done by the function
15408 ~org-publish-org-to-html~ which calls the HTML exporter (see [[*HTML
15409 Export]]). But you can also publish your content as PDF files using
15410 ~org-publish-org-to-pdf~, or as ASCII, Texinfo, etc., using the
15411 corresponding functions.
15413 If you want to publish the Org file as an =.org= file but with
15414 /archived/, /commented/, and /tag-excluded/ trees removed, use
15415 ~org-publish-org-to-org~. This produces =file.org= and put it in the
15416 publishing directory. If you want a htmlized version of this file,
15417 set the parameter ~:htmlized-source~ to ~t~. It produces
15418 =file.org.html= in the publishing directory[fn:129].
15420 Other files like images only need to be copied to the publishing
15421 destination; for this you can use ~org-publish-attachment~. For
15422 non-Org files, you always need to specify the publishing function:
15424 - ~:publishing-function~ ::
15426 Function executing the publication of a file. This may also be
15427 a list of functions, which are all called in turn.
15429 - ~:plain-source~ ::
15431 Non-~nil~ means, publish plain source.
15433 - ~:htmlized-source~ ::
15435 Non-~nil~ means, publish htmlized source.
15437 The function must accept three arguments: a property list containing
15438 at least a ~:publishing-directory~ property, the name of the file to
15439 be published, and the path to the publishing directory of the output
15440 file. It should take the specified file, make the necessary
15441 transformation, if any, and place the result into the destination
15444 *** Options for the exporters
15446 :DESCRIPTION: Tweaking HTML/@LaTeX{} export.
15447 :ALT_TITLE: Publishing options
15449 #+cindex: options, for publishing
15450 #+cindex: publishing options
15452 The property list can be used to set many export options for the HTML
15453 and LaTeX exporters. In most cases, these properties correspond to
15454 user variables in Org. The table below lists these properties along
15455 with the variable they belong to. See the documentation string for
15456 the respective variable for details.
15458 #+vindex: org-publish-project-alist
15459 When a property is given a value in ~org-publish-project-alist~, its
15460 setting overrides the value of the corresponding user variable, if
15461 any, during publishing. Options set within a file (see [[*Export
15462 Settings]]), however, override everything.
15464 **** Generic properties
15469 | ~:archived-trees~ | ~org-export-with-archived-trees~ |
15470 | ~:exclude-tags~ | ~org-export-exclude-tags~ |
15471 | ~:headline-levels~ | ~org-export-headline-levels~ |
15472 | ~:language~ | ~org-export-default-language~ |
15473 | ~:preserve-breaks~ | ~org-export-preserve-breaks~ |
15474 | ~:section-numbers~ | ~org-export-with-section-numbers~ |
15475 | ~:select-tags~ | ~org-export-select-tags~ |
15476 | ~:with-author~ | ~org-export-with-author~ |
15477 | ~:with-broken-links~ | ~org-export-with-broken-links~ |
15478 | ~:with-clocks~ | ~org-export-with-clocks~ |
15479 | ~:with-creator~ | ~org-export-with-creator~ |
15480 | ~:with-date~ | ~org-export-with-date~ |
15481 | ~:with-drawers~ | ~org-export-with-drawers~ |
15482 | ~:with-email~ | ~org-export-with-email~ |
15483 | ~:with-emphasize~ | ~org-export-with-emphasize~ |
15484 | ~:with-fixed-width~ | ~org-export-with-fixed-width~ |
15485 | ~:with-footnotes~ | ~org-export-with-footnotes~ |
15486 | ~:with-latex~ | ~org-export-with-latex~ |
15487 | ~:with-planning~ | ~org-export-with-planning~ |
15488 | ~:with-priority~ | ~org-export-with-priority~ |
15489 | ~:with-properties~ | ~org-export-with-properties~ |
15490 | ~:with-special-strings~ | ~org-export-with-special-strings~ |
15491 | ~:with-sub-superscript~ | ~org-export-with-sub-superscripts~ |
15492 | ~:with-tables~ | ~org-export-with-tables~ |
15493 | ~:with-tags~ | ~org-export-with-tags~ |
15494 | ~:with-tasks~ | ~org-export-with-tasks~ |
15495 | ~:with-timestamps~ | ~org-export-with-timestamps~ |
15496 | ~:with-title~ | ~org-export-with-title~ |
15497 | ~:with-toc~ | ~org-export-with-toc~ |
15498 | ~:with-todo-keywords~ | ~org-export-with-todo-keywords~ |
15500 **** ASCII specific properties
15505 | ~:ascii-bullets~ | ~org-ascii-bullets~ |
15506 | ~:ascii-caption-above~ | ~org-ascii-caption-above~ |
15507 | ~:ascii-charset~ | ~org-ascii-charset~ |
15508 | ~:ascii-global-margin~ | ~org-ascii-global-margin~ |
15509 | ~:ascii-format-drawer-function~ | ~org-ascii-format-drawer-function~ |
15510 | ~:ascii-format-inlinetask-function~ | ~org-ascii-format-inlinetask-function~ |
15511 | ~:ascii-headline-spacing~ | ~org-ascii-headline-spacing~ |
15512 | ~:ascii-indented-line-width~ | ~org-ascii-indented-line-width~ |
15513 | ~:ascii-inlinetask-width~ | ~org-ascii-inlinetask-width~ |
15514 | ~:ascii-inner-margin~ | ~org-ascii-inner-margin~ |
15515 | ~:ascii-links-to-notes~ | ~org-ascii-links-to-notes~ |
15516 | ~:ascii-list-margin~ | ~org-ascii-list-margin~ |
15517 | ~:ascii-paragraph-spacing~ | ~org-ascii-paragraph-spacing~ |
15518 | ~:ascii-quote-margin~ | ~org-ascii-quote-margin~ |
15519 | ~:ascii-table-keep-all-vertical-lines~ | ~org-ascii-table-keep-all-vertical-lines~ |
15520 | ~:ascii-table-use-ascii-art~ | ~org-ascii-table-use-ascii-art~ |
15521 | ~:ascii-table-widen-columns~ | ~org-ascii-table-widen-columns~ |
15522 | ~:ascii-text-width~ | ~org-ascii-text-width~ |
15523 | ~:ascii-underline~ | ~org-ascii-underline~ |
15524 | ~:ascii-verbatim-format~ | ~org-ascii-verbatim-format~ |
15526 **** Beamer specific properties
15531 | ~:beamer-theme~ | ~org-beamer-theme~ |
15532 | ~:beamer-column-view-format~ | ~org-beamer-column-view-format~ |
15533 | ~:beamer-environments-extra~ | ~org-beamer-environments-extra~ |
15534 | ~:beamer-frame-default-options~ | ~org-beamer-frame-default-options~ |
15535 | ~:beamer-outline-frame-options~ | ~org-beamer-outline-frame-options~ |
15536 | ~:beamer-outline-frame-title~ | ~org-beamer-outline-frame-title~ |
15537 | ~:beamer-subtitle-format~ | ~org-beamer-subtitle-format~ |
15539 **** HTML specific properties
15544 | ~:html-allow-name-attribute-in-anchors~ | ~org-html-allow-name-attribute-in-anchors~ |
15545 | ~:html-checkbox-type~ | ~org-html-checkbox-type~ |
15546 | ~:html-container~ | ~org-html-container-element~ |
15547 | ~:html-divs~ | ~org-html-divs~ |
15548 | ~:html-doctype~ | ~org-html-doctype~ |
15549 | ~:html-extension~ | ~org-html-extension~ |
15550 | ~:html-footnote-format~ | ~org-html-footnote-format~ |
15551 | ~:html-footnote-separator~ | ~org-html-footnote-separator~ |
15552 | ~:html-footnotes-section~ | ~org-html-footnotes-section~ |
15553 | ~:html-format-drawer-function~ | ~org-html-format-drawer-function~ |
15554 | ~:html-format-headline-function~ | ~org-html-format-headline-function~ |
15555 | ~:html-format-inlinetask-function~ | ~org-html-format-inlinetask-function~ |
15556 | ~:html-head-extra~ | ~org-html-head-extra~ |
15557 | ~:html-head-include-default-style~ | ~org-html-head-include-default-style~ |
15558 | ~:html-head-include-scripts~ | ~org-html-head-include-scripts~ |
15559 | ~:html-head~ | ~org-html-head~ |
15560 | ~:html-home/up-format~ | ~org-html-home/up-format~ |
15561 | ~:html-html5-fancy~ | ~org-html-html5-fancy~ |
15562 | ~:html-indent~ | ~org-html-indent~ |
15563 | ~:html-infojs-options~ | ~org-html-infojs-options~ |
15564 | ~:html-infojs-template~ | ~org-html-infojs-template~ |
15565 | ~:html-inline-image-rules~ | ~org-html-inline-image-rules~ |
15566 | ~:html-inline-images~ | ~org-html-inline-images~ |
15567 | ~:html-link-home~ | ~org-html-link-home~ |
15568 | ~:html-link-org-files-as-html~ | ~org-html-link-org-files-as-html~ |
15569 | ~:html-link-up~ | ~org-html-link-up~ |
15570 | ~:html-link-use-abs-url~ | ~org-html-link-use-abs-url~ |
15571 | ~:html-mathjax-options~ | ~org-html-mathjax-options~ |
15572 | ~:html-mathjax-template~ | ~org-html-mathjax-template~ |
15573 | ~:html-metadata-timestamp-format~ | ~org-html-metadata-timestamp-format~ |
15574 | ~:html-postamble-format~ | ~org-html-postamble-format~ |
15575 | ~:html-postamble~ | ~org-html-postamble~ |
15576 | ~:html-preamble-format~ | ~org-html-preamble-format~ |
15577 | ~:html-preamble~ | ~org-html-preamble~ |
15578 | ~:html-table-align-individual-field~ | ~de{org-html-table-align-individual-fields~ |
15579 | ~:html-table-attributes~ | ~org-html-table-default-attributes~ |
15580 | ~:html-table-caption-above~ | ~org-html-table-caption-above~ |
15581 | ~:html-table-data-tags~ | ~org-html-table-data-tags~ |
15582 | ~:html-table-header-tags~ | ~org-html-table-header-tags~ |
15583 | ~:html-table-row-tags~ | ~org-html-table-row-tags~ |
15584 | ~:html-table-use-header-tags-for-first-column~ | ~org-html-table-use-header-tags-for-first-column~ |
15585 | ~:html-tag-class-prefix~ | ~org-html-tag-class-prefix~ |
15586 | ~:html-text-markup-alist~ | ~org-html-text-markup-alist~ |
15587 | ~:html-todo-kwd-class-prefix~ | ~org-html-todo-kwd-class-prefix~ |
15588 | ~:html-toplevel-hlevel~ | ~org-html-toplevel-hlevel~ |
15589 | ~:html-use-infojs~ | ~org-html-use-infojs~ |
15590 | ~:html-validation-link~ | ~org-html-validation-link~ |
15591 | ~:html-viewport~ | ~org-html-viewport~ |
15592 | ~:html-xml-declaration~ | ~org-html-xml-declaration~ |
15594 **** LaTeX specific properties
15599 | ~:latex-active-timestamp-format~ | ~org-latex-active-timestamp-format~ |
15600 | ~:latex-caption-above~ | ~org-latex-caption-above~ |
15601 | ~:latex-classes~ | ~org-latex-classes~ |
15602 | ~:latex-class~ | ~org-latex-default-class~ |
15603 | ~:latex-compiler~ | ~org-latex-compiler~ |
15604 | ~:latex-default-figure-position~ | ~org-latex-default-figure-position~ |
15605 | ~:latex-default-table-environment~ | ~org-latex-default-table-environment~ |
15606 | ~:latex-default-table-mode~ | ~org-latex-default-table-mode~ |
15607 | ~:latex-diary-timestamp-format~ | ~org-latex-diary-timestamp-format~ |
15608 | ~:latex-footnote-defined-format~ | ~org-latex-footnote-defined-format~ |
15609 | ~:latex-footnote-separator~ | ~org-latex-footnote-separator~ |
15610 | ~:latex-format-drawer-function~ | ~org-latex-format-drawer-function~ |
15611 | ~:latex-format-headline-function~ | ~org-latex-format-headline-function~ |
15612 | ~:latex-format-inlinetask-function~ | ~org-latex-format-inlinetask-function~ |
15613 | ~:latex-hyperref-template~ | ~org-latex-hyperref-template~ |
15614 | ~:latex-image-default-height~ | ~org-latex-image-default-height~ |
15615 | ~:latex-image-default-option~ | ~org-latex-image-default-option~ |
15616 | ~:latex-image-default-width~ | ~org-latex-image-default-width~ |
15617 | ~:latex-images-centered~ | ~org-latex-images-centered~ |
15618 | ~:latex-inactive-timestamp-format~ | ~org-latex-inactive-timestamp-format~ |
15619 | ~:latex-inline-image-rules~ | ~org-latex-inline-image-rules~ |
15620 | ~:latex-link-with-unknown-path-format~ | ~org-latex-link-with-unknown-path-format~ |
15621 | ~:latex-listings-langs~ | ~org-latex-listings-langs~ |
15622 | ~:latex-listings-options~ | ~org-latex-listings-options~ |
15623 | ~:latex-listings~ | ~org-latex-listings~ |
15624 | ~:latex-minted-langs~ | ~org-latex-minted-langs~ |
15625 | ~:latex-minted-options~ | ~org-latex-minted-options~ |
15626 | ~:latex-prefer-user-labels~ | ~org-latex-prefer-user-labels~ |
15627 | ~:latex-subtitle-format~ | ~org-latex-subtitle-format~ |
15628 | ~:latex-subtitle-separate~ | ~org-latex-subtitle-separate~ |
15629 | ~:latex-table-scientific-notation~ | ~org-latex-table-scientific-notation~ |
15630 | ~:latex-tables-booktabs~ | ~org-latex-tables-booktabs~ |
15631 | ~:latex-tables-centered~ | ~org-latex-tables-centered~ |
15632 | ~:latex-text-markup-alist~ | ~org-latex-text-markup-alist~ |
15633 | ~:latex-title-command~ | ~org-latex-title-command~ |
15634 | ~:latex-toc-command~ | ~org-latex-toc-command~ |
15636 **** Markdown specific properties
15641 | ~:md-footnote-format~ | ~org-md-footnote-format~ |
15642 | ~:md-footnotes-section~ | ~org-md-footnotes-section~ |
15643 | ~:md-headline-style~ | ~org-md-headline-style~ |
15645 **** ODT specific properties
15650 | ~:odt-content-template-file~ | ~org-odt-content-template-file~ |
15651 | ~:odt-display-outline-level~ | ~org-odt-display-outline-level~ |
15652 | ~:odt-fontify-srcblocks~ | ~org-odt-fontify-srcblocks~ |
15653 | ~:odt-format-drawer-function~ | ~org-odt-format-drawer-function~ |
15654 | ~:odt-format-headline-function~ | ~org-odt-format-headline-function~ |
15655 | ~:odt-format-inlinetask-function~ | ~org-odt-format-inlinetask-function~ |
15656 | ~:odt-inline-formula-rules~ | ~org-odt-inline-formula-rules~ |
15657 | ~:odt-inline-image-rules~ | ~org-odt-inline-image-rules~ |
15658 | ~:odt-pixels-per-inch~ | ~org-odt-pixels-per-inch~ |
15659 | ~:odt-styles-file~ | ~org-odt-styles-file~ |
15660 | ~:odt-table-styles~ | ~org-odt-table-styles~ |
15661 | ~:odt-use-date-fields~ | ~org-odt-use-date-fields~ |
15663 **** Texinfo specific properties
15668 | ~:texinfo-active-timestamp-format~ | ~org-texinfo-active-timestamp-format~ |
15669 | ~:texinfo-classes~ | ~org-texinfo-classes~ |
15670 | ~:texinfo-class~ | ~org-texinfo-default-class~ |
15671 | ~:texinfo-table-default-markup~ | ~org-texinfo-table-default-markup~ |
15672 | ~:texinfo-diary-timestamp-format~ | ~org-texinfo-diary-timestamp-format~ |
15673 | ~:texinfo-filename~ | ~org-texinfo-filename~ |
15674 | ~:texinfo-format-drawer-function~ | ~org-texinfo-format-drawer-function~ |
15675 | ~:texinfo-format-headline-function~ | ~org-texinfo-format-headline-function~ |
15676 | ~:texinfo-format-inlinetask-function~ | ~org-texinfo-format-inlinetask-function~ |
15677 | ~:texinfo-inactive-timestamp-format~ | ~org-texinfo-inactive-timestamp-format~ |
15678 | ~:texinfo-link-with-unknown-path-format~ | ~org-texinfo-link-with-unknown-path-format~ |
15679 | ~:texinfo-node-description-column~ | ~org-texinfo-node-description-column~ |
15680 | ~:texinfo-table-scientific-notation~ | ~org-texinfo-table-scientific-notation~ |
15681 | ~:texinfo-tables-verbatim~ | ~org-texinfo-tables-verbatim~ |
15682 | ~:texinfo-text-markup-alist~ | ~org-texinfo-text-markup-alist~ |
15684 *** Publishing links
15686 :DESCRIPTION: Which links keep working after publishing?
15688 #+cindex: links, publishing
15690 To create a link from one Org file to another, you would use something
15691 like =[[file:foo.org][The foo]]= or simply =[[file:foo.org]]= (see [[*External Links]]). When
15692 published, this link becomes a link to =foo.html=. You can thus
15693 interlink the pages of your "Org web" project and the links will work
15694 as expected when you publish them to HTML. If you also publish the
15695 Org source file and want to link to it, use an =http= link instead of
15696 a =file:= link, because =file= links are converted to link to the
15697 corresponding =.html= file.
15699 You may also link to related files, such as images. Provided you are
15700 careful with relative file names, and provided you have also
15701 configured Org to upload the related files, these links will work too.
15702 See [[*Example: complex publishing configuration]], for an example of this
15705 Eventually, links between published documents can contain some search
15706 options (see [[*Search Options in File Links]]), which will be resolved to
15707 the appropriate location in the linked file. For example, once
15708 published to HTML, the following links all point to a dedicated anchor
15712 [[file:foo.org::*heading]]
15713 [[file:foo.org::#custom-id]]
15714 [[file:foo.org::target]]
15717 *** Generating a sitemap
15719 :DESCRIPTION: Generating a list of all pages.
15720 :ALT_TITLE: Site map
15722 #+cindex: sitemap, of published pages
15724 The following properties may be used to control publishing of
15725 a map of files for a given project.
15727 - ~:auto-sitemap~ ::
15729 When non-~nil~, publish a sitemap during
15730 ~org-publish-current-project~ or ~org-publish-all~.
15732 - ~:sitemap-filename~ ::
15734 Filename for output of sitemap. Defaults to =sitemap.org=, which
15735 becomes =sitemap.html=.
15737 - ~:sitemap-title~ ::
15739 Title of sitemap page. Defaults to name of file.
15741 - ~:sitemap-format-entry~ ::
15743 #+findex: org-publish-find-date
15744 #+findex: org-publish-find-property
15745 #+findex: org-publish-find-title
15746 With this option one can tell how a site-map entry is formatted
15747 in the site-map. It is a function called with three arguments:
15748 the file or directory name relative to base directory of the
15749 project, the site-map style and the current project. It is
15750 expected to return a string. Default value turns file names into
15751 links and use document titles as descriptions. For specific
15752 formatting needs, one can use ~org-publish-find-date~,
15753 ~org-publish-find-title~ and ~org-publish-find-property~, to
15754 retrieve additional information about published documents.
15756 - ~:sitemap-function~ ::
15758 Plug-in function to use for generation of the sitemap. It is
15759 called with two arguments: the title of the site-map and
15760 a representation of the files and directories involved in the
15761 project as a nested list, which can further be transformed using
15762 ~org-list-to-generic~, ~org-list-to-subtree~ and alike. Default
15763 value generates a plain list of links to all files in the
15766 - ~:sitemap-sort-folders~ ::
15768 Where folders should appear in the sitemap. Set this to ~first~
15769 (default) or ~last~ to display folders first or last,
15770 respectively. When set to ~ignore~, folders are ignored
15771 altogether. Any other value mixes files and folders. This
15772 variable has no effect when site-map style is ~tree~.
15774 - ~:sitemap-sort-files~ ::
15776 How the files are sorted in the site map. Set this to
15777 ~alphabetically~ (default), ~chronologically~ or
15778 ~anti-chronologically~. ~chronologically~ sorts the files with
15779 older date first while ~anti-chronologically~ sorts the files
15780 with newer date first. ~alphabetically~ sorts the files
15781 alphabetically. The date of a file is retrieved with
15782 ~org-publish-find-date~.
15784 - ~:sitemap-ignore-case~ ::
15786 Should sorting be case-sensitive? Default ~nil~.
15788 - ~:sitemap-file-entry-format~ ::
15790 With this option one can tell how a sitemap's entry is formatted
15791 in the sitemap. This is a format string with some escape
15792 sequences: ~%t~ stands for the title of the file, ~%a~ stands for
15793 the author of the file and ~%d~ stands for the date of the file.
15794 The date is retrieved with the ~org-publish-find-date~ function
15795 and formatted with ~org-publish-sitemap-date-format~. Default
15798 - ~:sitemap-date-format~ ::
15800 Format string for the ~format-time-string~ function that tells
15801 how a sitemap entry's date is to be formatted. This property
15802 bypasses ~org-publish-sitemap-date-format~ which defaults to
15805 *** Generating an index
15807 :DESCRIPTION: An index that reaches across pages.
15809 #+cindex: index, in a publishing project
15811 Org mode can generate an index across the files of a publishing project.
15815 When non-~nil~, generate in index in the file =theindex.org= and
15816 publish it as =theindex.html=.
15818 The file is created when first publishing a project with the
15819 ~:makeindex~ set. The file only contains a statement =#+INCLUDE:
15820 "theindex.inc"=. You can then build around this include statement by
15821 adding a title, style information, etc.
15823 #+cindex: @samp{INDEX}, keyword
15824 Index entries are specified with =INDEX= keyword. An entry that
15825 contains an exclamation mark creates a sub item.
15828 ,*** Curriculum Vitae
15830 ,#+INDEX: Application!CV
15835 :DESCRIPTION: How to get files up on the server.
15840 For those people already utilizing third party sync tools such as
15841 Rsync or Unison, it might be preferable not to use the built-in remote
15842 publishing facilities of Org mode which rely heavily on Tramp. Tramp,
15843 while very useful and powerful, tends not to be so efficient for
15844 multiple file transfer and has been known to cause problems under
15847 Specialized synchronization utilities offer several advantages. In
15848 addition to timestamp comparison, they also do content and
15849 permissions/attribute checks. For this reason you might prefer to
15850 publish your web to a local directory---possibly even /in place/ with
15851 your Org files---and then use Unison or Rsync to do the
15852 synchronization with the remote host.
15854 Since Unison, for example, can be configured as to which files to
15855 transfer to a certain remote destination, it can greatly simplify the
15856 project publishing definition. Simply keep all files in the correct
15857 location, process your Org files with ~org-publish~ and let the
15858 synchronization tool do the rest. You do not need, in this scenario,
15859 to include attachments such as JPG, CSS or PNG files in the project
15860 definition since the third-party tool syncs them.
15862 Publishing to a local directory is also much faster than to a remote
15863 one, so that you can afford more easily to republish entire projects.
15864 If you set ~org-publish-use-timestamps-flag~ to ~nil~, you gain the
15865 main benefit of re-including any changed external files such as source
15866 example files you might include with =INCLUDE= keyword. The timestamp
15867 mechanism in Org is not smart enough to detect if included files have
15870 ** Sample Configuration
15872 :DESCRIPTION: Example projects.
15875 Below we provide two example configurations. The first one is
15876 a simple project publishing only a set of Org files. The second
15877 example is more complex, with a multi-component project.
15879 *** Example: simple publishing configuration
15881 :DESCRIPTION: One-component publishing.
15882 :ALT_TITLE: Simple example
15885 This example publishes a set of Org files to the =public_html=
15886 directory on the local machine.
15888 #+begin_src emacs-lisp
15889 (setq org-publish-project-alist
15891 :base-directory "~/org/"
15892 :publishing-directory "~/public_html"
15893 :section-numbers nil
15894 :table-of-contents nil
15895 :style "<link rel=\"stylesheet\"
15896 href=\"../other/mystyle.css\"
15897 type=\"text/css\"/>")))
15900 *** Example: complex publishing configuration
15902 :DESCRIPTION: A multi-component publishing example.
15903 :ALT_TITLE: Complex example
15906 This more complicated example publishes an entire website, including
15907 Org files converted to HTML, image files, Emacs Lisp source code, and
15908 style sheets. The publishing directory is remote and private files
15911 To ensure that links are preserved, care should be taken to replicate
15912 your directory structure on the web server, and to use relative file
15913 paths. For example, if your Org files are kept in =~/org/= and your
15914 publishable images in =~/images/=, you would link to an image with
15916 : file:../images/myimage.png
15918 On the web server, the relative path to the image should be the same.
15919 You can accomplish this by setting up an =images/= folder in the right
15920 place on the web server, and publishing images to it.
15922 #+begin_src emacs-lisp
15923 (setq org-publish-project-alist
15925 :base-directory "~/org/"
15926 :base-extension "org"
15927 :publishing-directory "/ssh:user@host:~/html/notebook/"
15928 :publishing-function org-html-publish-to-html
15929 :exclude "PrivatePage.org" ;; regexp
15931 :section-numbers nil
15933 :html-head "<link rel=\"stylesheet\"
15934 href=\"../other/mystyle.css\" type=\"text/css\"/>"
15938 :base-directory "~/images/"
15939 :base-extension "jpg\\|gif\\|png"
15940 :publishing-directory "/ssh:user@host:~/html/images/"
15941 :publishing-function org-publish-attachment)
15944 :base-directory "~/other/"
15945 :base-extension "css\\|el"
15946 :publishing-directory "/ssh:user@host:~/html/other/"
15947 :publishing-function org-publish-attachment)
15948 ("website" :components ("orgfiles" "images" "other"))))
15951 ** Triggering Publication
15953 :DESCRIPTION: Publication commands.
15956 Once properly configured, Org can publish with the following commands:
15958 - {{{kbd(C-c C-e X)}}} (~org-publish~) ::
15960 #+kindex: C-c C-e X
15961 #+findex: org-publish
15962 Prompt for a specific project and publish all files that belong
15965 - {{{kbd(C-c C-e P)}}} (~org-publish-current-project~) ::
15967 #+kindex: C-c C-e P
15968 #+findex: org-publish-current-project
15969 Publish the project containing the current file.
15971 - {{{kbd(C-c C-e F)}}} (~org-publish-current-file~) ::
15973 #+kindex: C-c C-e F
15974 #+findex: org-publish-current-file
15975 Publish only the current file.
15977 - {{{kbd(C-c C-e E)}}} (~org-publish-all~) ::
15979 #+kindex: C-c C-e E
15980 #+findex: org-publish-all
15981 Publish every project.
15983 #+vindex: org-publish-use-timestamps-flag
15984 Org uses timestamps to track when a file has changed. The above
15985 functions normally only publish changed files. You can override this
15986 and force publishing of all files by giving a prefix argument to any
15987 of the commands above, or by customizing the variable
15988 ~org-publish-use-timestamps-flag~. This may be necessary in
15989 particular if files include other files via =SETUPFILE= or =INCLUDE=
15992 * Working with Source Code
15994 :DESCRIPTION: Export, evaluate, and tangle code blocks.
15996 #+cindex: source code, working with
15998 Source code here refers to any plain text collection of computer
15999 instructions, possibly with comments, written using a human-readable
16000 programming language. Org can manage source code in an Org document
16001 when the source code is identified with begin and end markers.
16002 Working with source code begins with identifying source code blocks.
16003 A source code block can be placed almost anywhere in an Org document;
16004 it is not restricted to the preamble or the end of the document.
16005 However, Org cannot manage a source code block if it is placed inside
16006 an Org comment or within a fixed width section.
16008 Here is an example source code block in the Emacs Lisp language:
16011 ,#+BEGIN_SRC emacs-lisp
16012 (defun org-xor (a b)
16018 Org can manage the source code in the block delimited by =#+BEGIN_SRC=
16019 ... =#+END_SRC= in several ways that can simplify housekeeping tasks
16020 essential to modern source code maintenance. Org can edit, format,
16021 extract, export, and publish source code blocks. Org can also compile
16022 and execute a source code block, then capture the results. The Org
16023 mode literature sometimes refers to source code blocks as /live code/
16024 blocks because they can alter the content of the Org document or the
16025 material that it exports. Users can control how live they want each
16026 source code block by tweaking the header arguments (see [[*Using
16027 Header Arguments]]) for compiling, execution, extraction, and
16030 Source code blocks are one of many Org block types, which also include
16031 =quote=, =export=, =verse=, =latex=, =example=, and =verbatim=. This
16032 section pertains to blocks between =#+BEGIN_SRC= and =#+END_SRC=.
16034 For editing and formatting a source code block, Org uses an
16035 appropriate Emacs major mode that includes features specifically
16036 designed for source code in that language.
16038 Org can extract one or more source code blocks and write them to one
16039 or more source files---a process known as /tangling/ in literate
16040 programming terminology.
16042 For exporting and publishing, Org's back-ends can format a source code
16043 block appropriately, often with native syntax highlighting.
16045 For executing and compiling a source code block, the user can
16046 configure Org to select the appropriate compiler. Org provides
16047 facilities to collect the result of the execution or compiler output,
16048 insert it into the Org document, and/or export it. In addition to
16049 text results, Org can insert links to other data types, including
16050 audio, video, and graphics. Org can also link a compiler error
16051 message to the appropriate line in the source code block.
16053 An important feature of Org's management of source code blocks is the
16054 ability to pass variables, functions, and results to one another using
16055 a common syntax for source code blocks in any language. Although most
16056 literate programming facilities are restricted to one language or
16057 another, Org's language-agnostic approach lets the literate programmer
16058 match each programming task with the appropriate computer language and
16059 to mix them all together in a single Org document. This
16060 interoperability among languages explains why Org's source code
16061 management facility was named /Org Babel/ by its originators, Eric
16062 Schulte and Dan Davison.
16064 Org mode fulfills the promise of easy verification and maintenance of
16065 publishing reproducible research by keeping text, data, code,
16066 configuration settings of the execution environment, the results of
16067 the execution, and associated narratives, claims, references, and
16068 internal and external links in a single Org document.
16070 Details of Org's facilities for working with source code are described
16071 in the following sections.
16073 ** Structure of Code Blocks
16075 :DESCRIPTION: Code block syntax described.
16077 #+cindex: code block, structure
16078 #+cindex: source code, block structure
16079 #+cindex: @samp{NAME} keyword, in source blocks
16080 #+cindex: @samp{BEGIN_SRC}
16082 Org offers two ways to structure source code in Org documents: in
16083 a source code block, and directly inline. Both specifications are
16086 A source code block conforms to this structure:
16090 ,#+BEGIN_SRC <language> <switches> <header arguments>
16095 Do not be put-off by having to remember the source block syntax. Org
16096 mode offers a command for wrapping existing text in a block (see
16097 [[*Structure Templates]]). Org also works with other completion systems
16098 in Emacs, some of which predate Org and have custom domain-specific
16099 languages for defining templates. Regular use of templates reduces
16100 errors, increases accuracy, and maintains consistency.
16102 #+cindex: source code, inline
16103 An inline code block conforms to this structure:
16105 : src_<language>{<body>}
16107 #+texinfo: @noindent
16110 : src_<language>[<header arguments>]{<body>}
16112 - =#+NAME: <name>= ::
16114 Optional. Names the source block so it can be called, like
16115 a function, from other source blocks or inline code to evaluate
16116 or to capture the results. Code from other blocks, other files,
16117 and from table formulas (see [[*The spreadsheet]]) can use the name
16118 to reference a source block. This naming serves the same purpose
16119 as naming Org tables. Org mode requires unique names. For
16120 duplicate names, Org mode's behavior is undefined.
16122 - =#+BEGIN_SRC= ... =#+END_SRC= ::
16124 Mandatory. They mark the start and end of a block that Org
16125 requires. The =#+BEGIN_SRC= line takes additional arguments, as
16130 #+cindex: language, in code blocks
16131 Mandatory. It is the identifier of the source code language in
16132 the block. See [[*Languages]], for identifiers of supported
16137 #+cindex: switches, in code blocks
16138 Optional. Switches provide finer control of the code execution,
16139 export, and format (see the discussion of switches in [[*Literal
16142 - =<header arguments>= ::
16144 #+cindex: header arguments, in code blocks
16145 Optional. Heading arguments control many aspects of evaluation,
16146 export and tangling of code blocks (see [[*Using Header Arguments]]).
16147 Using Org's properties feature, header arguments can be
16148 selectively applied to the entire buffer or specific sub-trees of
16153 Source code in the dialect of the specified language identifier.
16155 ** Using Header Arguments
16157 :DESCRIPTION: Different ways to set header arguments.
16160 Org comes with many header arguments common to all languages. New
16161 header arguments are added for specific languages as they become
16162 available for use in source code blocks. A header argument is
16163 specified with an initial colon followed by the argument's name in
16166 Since header arguments can be set in several ways, Org prioritizes
16167 them in case of overlaps or conflicts by giving local settings
16168 a higher priority. Header values in function calls, for example,
16169 override header values from global defaults.
16171 *** System-wide header arguments
16175 #+vindex: org-babel-default-header-args
16177 #+vindex: org-babel-default-header-args
16178 System-wide values of header arguments can be specified by customizing
16179 the ~org-babel-default-header-args~ variable, which defaults to the
16184 :results => "replace"
16190 The example below sets =:noweb= header arguments to =yes=, which makes
16191 Org expand =:noweb= references by default.
16193 #+begin_src emacs-lisp
16194 (setq org-babel-default-header-args
16195 (cons '(:noweb . "yes")
16196 (assq-delete-all :noweb org-babel-default-header-args)))
16199 #+cindex: language specific default header arguments
16200 #+cindex: default header arguments per language
16201 Each language can have separate default header arguments by
16202 customizing the variable ~org-babel-default-header-args:<LANG>~, where
16203 {{{var(<LANG>)}}} is the name of the language. For details, see the
16204 language-specific online documentation at
16205 https://orgmode.org/worg/org-contrib/babel/.
16207 *** Header arguments in Org mode properties
16212 For header arguments applicable to the buffer, use =PROPERTY= keyword
16213 anywhere in the Org file (see [[*Property Syntax]]).
16215 The following example makes all the R code blocks execute in the same
16216 session. Setting =:results= to =silent= ignores the results of
16217 executions for all blocks, not just R code blocks; no results inserted
16221 ,#+PROPERTY: header-args:R :session *R*
16222 ,#+PROPERTY: header-args :results silent
16225 #+vindex: org-use-property-inheritance
16226 Header arguments set through Org's property drawers (see [[*Property
16227 Syntax]]) apply at the sub-tree level on down. Since these property
16228 drawers can appear anywhere in the file hierarchy, Org uses outermost
16229 call or source block to resolve the values. Org ignores
16230 ~org-use-property-inheritance~ setting.
16232 In this example, =:cache= defaults to =yes= for all code blocks in the
16238 :header-args: :cache yes
16242 #+kindex: C-c C-x p
16243 #+findex: org-set-property
16244 Properties defined through ~org-set-property~ function, bound to
16245 {{{kbd(C-c C-x p)}}}, apply to all active languages. They override
16246 properties set in ~org-babel-default-header-args~.
16248 #+cindex: language specific header arguments properties
16249 #+cindex: header arguments per language
16250 Language-specific header arguments are also read from properties
16251 =header-args:<LANG>= where {{{var(<LANG>)}}} is the language
16252 identifier. For example,
16257 :header-args:clojure: :session *clojure-1*
16258 :header-args:R: :session *R*
16262 :header-args:clojure: :session *clojure-2*
16266 #+texinfo: @noindent
16267 would force separate sessions for Clojure blocks in =Heading= and
16268 =Subheading=, but use the same session for all R blocks. Blocks in
16269 =Subheading= inherit settings from =Heading=.
16271 *** Code block specific header arguments
16276 Header arguments are most commonly set at the source code block level,
16277 on the =#+BEGIN_SRC= line. Arguments set at this level take
16278 precedence over those set in the ~org-babel-default-header-args~
16279 variable, and also those set as header properties.
16281 In the following example, setting =:results= to =silent= makes it
16282 ignore results of the code execution. Setting =:exports= to =code=
16283 exports only the body of the code block to HTML or LaTeX.
16287 ,#+BEGIN_SRC haskell :results silent :exports code :var n=0
16289 fac n = n * fac (n-1)
16293 The same header arguments in an inline code block:
16295 : src_haskell[:exports both]{fac 5}
16297 #+cindex: @samp{HEADER}, keyword
16298 Code block header arguments can span multiple lines using =#+HEADER:=
16299 on each line. Note that Org currently accepts the plural spelling of
16300 =#+HEADER:= only as a convenience for backward-compatibility. It may
16301 be removed at some point.
16303 Multi-line header arguments on an unnamed code block:
16306 ,#+HEADER: :var data1=1
16307 ,#+BEGIN_SRC emacs-lisp :var data2=2
16308 (message "data1:%S, data2:%S" data1 data2)
16315 Multi-line header arguments on a named code block:
16318 ,#+NAME: named-block
16319 ,#+HEADER: :var data=2
16320 ,#+BEGIN_SRC emacs-lisp
16321 (message "data:%S" data)
16324 ,#+RESULTS: named-block
16328 *** Header arguments in function calls
16333 Header arguments in function calls are the most specific and override
16334 all other settings in case of an overlap. They get the highest
16335 priority. Two =#+CALL:= examples are shown below. For the complete
16336 syntax of =CALL= keyword, see [[*Evaluating Code Blocks]].
16338 In this example, =:exports results= header argument is applied to the
16339 evaluation of the =#+CALL:= line.
16341 : #+CALL: factorial(n=5) :exports results
16343 In this example, =:session special= header argument is applied to the
16344 evaluation of =factorial= code block.
16346 : #+CALL: factorial[:session special](n=5)
16348 ** Environment of a Code Block
16350 :DESCRIPTION: Arguments, sessions, working directory...
16353 *** Passing arguments
16358 #+cindex: passing arguments to code blocks
16359 #+cindex: arguments, in code blocks
16360 #+cindex: @samp{var}, header argument
16361 Use =var= for passing arguments to source code blocks. The specifics
16362 of variables in code blocks vary by the source language and are
16363 covered in the language-specific documentation. The syntax for =var=,
16364 however, is the same for all languages. This includes declaring
16365 a variable, and assigning a default value.
16367 The following syntax is used to pass arguments to code blocks using
16368 the =var= header argument.
16372 #+texinfo: @noindent
16373 {{{var(NAME)}}} is the name of the variable bound in the code block
16374 body. {{{var(ASSIGN)}}} is a literal value, such as a string,
16375 a number, a reference to a table, a list, a literal example, another
16376 code block---with or without arguments---or the results of evaluating
16379 Here are examples of passing values by reference:
16383 A table named with a =NAME= keyword.
16386 ,#+NAME: example-table
16392 ,#+NAME: table-length
16393 ,#+BEGIN_SRC emacs-lisp :var table=example-table
16397 ,#+RESULTS: table-length
16401 When passing a table, you can treat specially the row, or the
16402 column, containing labels for the columns, or the rows, in the
16405 #+cindex: @samp{colnames}, header argument
16406 The =colnames= header argument accepts =yes=, =no=, or =nil=
16407 values. The default value is =nil=: if an input table has column
16408 names---because the second row is a horizontal rule---then Org
16409 removes the column names, processes the table, puts back the
16410 column names, and then writes the table to the results block.
16411 Using =yes=, Org does the same to the first row, even if the
16412 initial table does not contain any horizontal rule. When set to
16413 =no=, Org does not pre-process column names at all.
16422 ,#+BEGIN_SRC python :var tab=less-cols :colnames nil
16423 return [[val + '*' for val in row] for row in tab]
16433 #+cindex: @samp{rownames}, header argument
16434 Similarly, the =rownames= header argument can take two values:
16435 =yes= or =no=. When set to =yes=, Org removes the first column,
16436 processes the table, puts back the first column, and then writes
16437 the table to the results block. The default is =no=, which means
16438 Org does not pre-process the first column. Note that Emacs Lisp
16439 code blocks ignore =rownames= header argument because of the ease
16440 of table-handling in Emacs.
16443 ,#+NAME: with-rownames
16444 | one | 1 | 2 | 3 | 4 | 5 |
16445 | two | 6 | 7 | 8 | 9 | 10 |
16447 ,#+BEGIN_SRC python :var tab=with-rownames :rownames yes
16448 return [[val + 10 for val in row] for row in tab]
16452 | one | 11 | 12 | 13 | 14 | 15 |
16453 | two | 16 | 17 | 18 | 19 | 20 |
16458 A simple named list.
16461 ,#+NAME: example-list
16467 ,#+BEGIN_SRC emacs-lisp :var x=example-list
16475 Note that only the top level list items are passed along. Nested
16476 list items are ignored.
16478 - code block without arguments ::
16480 A code block name, as assigned by =NAME= keyword from the example
16481 above, optionally followed by parentheses.
16484 ,#+BEGIN_SRC emacs-lisp :var length=table-length()
16492 - code block with arguments ::
16494 A code block name, as assigned by =NAME= keyword, followed by
16495 parentheses and optional arguments passed within the parentheses.
16499 ,#+BEGIN_SRC emacs-lisp :var input=8
16507 ,#+BEGIN_SRC emacs-lisp :var input=double(input=1)
16511 ,#+RESULTS: squared
16515 - literal example ::
16517 A literal example block named with a =NAME= keyword.
16520 ,#+NAME: literal-example
16526 ,#+NAME: read-literal-example
16527 ,#+BEGIN_SRC emacs-lisp :var x=literal-example
16528 (concatenate #'string x " for you.")
16531 ,#+RESULTS: read-literal-example
16532 : A literal example
16533 : on two lines for you.
16536 Indexing variable values enables referencing portions of a variable.
16537 Indexes are 0 based with negative values counting backwards from the
16538 end. If an index is separated by commas then each subsequent section
16539 indexes as the next dimension. Note that this indexing occurs
16540 /before/ other table-related header arguments are applied, such as
16541 =hlines=, =colnames= and =rownames=. The following example assigns
16542 the last cell of the first row the table =example-table= to the
16546 ,#+NAME: example-table
16552 ,#+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
16560 Two integers separated by a colon reference a range of variable
16561 values. In that case the entire inclusive range is referenced. For
16562 example the following assigns the middle three rows of =example-table=
16566 ,#+NAME: example-table
16573 ,#+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
16583 To pick the entire range, use an empty index, or the single character
16584 =*=. =0:-1= does the same thing. Example below shows how to
16585 reference the first column only.
16588 ,#+NAME: example-table
16594 ,#+BEGIN_SRC emacs-lisp :var data=example-table[,0]
16602 Index referencing can be used for tables and code blocks. Index
16603 referencing can handle any number of dimensions. Commas delimit
16604 multiple dimensions, as shown below.
16608 ,#+BEGIN_SRC emacs-lisp
16609 '(((1 2 3) (4 5 6) (7 8 9))
16610 ((10 11 12) (13 14 15) (16 17 18))
16611 ((19 20 21) (22 23 24) (25 26 27)))
16614 ,#+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
16622 Note that row names and column names are not removed prior to variable
16623 indexing. You need to take them into account, even when =colnames= or
16624 =rownames= header arguments remove them.
16626 Emacs lisp code can also set the values for variables. To
16627 differentiate a value from Lisp code, Org interprets any value
16628 starting with =(=, =[=, ='= or =`= as Emacs Lisp code. The result of
16629 evaluating that code is then assigned to the value of that variable.
16630 The following example shows how to reliably query and pass the file
16631 name of the Org mode buffer to a code block using headers. We need
16632 reliability here because the file's name could change once the code in
16633 the block starts executing.
16636 ,#+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
16641 Note that values read from tables and lists are not mistakenly
16642 evaluated as Emacs Lisp code, as illustrated in the following example.
16648 ,#+HEADERS: :var data=table[0,0]
16662 #+cindex: using sessions in code blocks
16663 #+cindex: @samp{session}, header argument
16664 Two code blocks can share the same environment. The =session= header
16665 argument is for running multiple source code blocks under one session.
16666 Org runs code blocks with the same session name in the same
16667 interpreter process.
16671 Default. Each code block gets a new interpreter process to
16672 execute. The process terminates once the block is evaluated.
16674 - {{{var(STRING)}}} ::
16676 Any string besides =none= turns that string into the name of that
16677 session. For example, =:session STRING= names it =STRING=. If
16678 =session= has no value, then the session name is derived from the
16679 source language identifier. Subsequent blocks with the same
16680 source code language use the same session. Depending on the
16681 language, state variables, code from other blocks, and the
16682 overall interpreted environment may be shared. Some interpreted
16683 languages support concurrent sessions when subsequent source code
16684 language blocks change session names.
16686 Only languages that provide interactive evaluation can have session
16687 support. Not all languages provide this support, such as C and ditaa.
16688 Even languages, such as Python and Haskell, that do support
16689 interactive evaluation impose limitations on allowable language
16690 constructs that can run interactively. Org inherits those limitations
16691 for those code blocks running in a session.
16693 *** Choosing a working directory
16698 #+cindex: working directory, in a code block
16699 #+cindex: @samp{dir}, header argument
16700 The =dir= header argument specifies the default directory during code
16701 block execution. If it is absent, then the directory associated with
16702 the current buffer is used. In other words, supplying =:dir PATH=
16703 temporarily has the same effect as changing the current directory with
16704 {{{kbd(M-x cd PATH)}}}, and then not setting =dir=. Under the
16705 surface, =dir= simply sets the value of the Emacs variable
16706 ~default-directory~.
16708 For example, to save the plot file in the =Work/= folder of the home
16709 directory---notice tilde is expanded:
16712 ,#+BEGIN_SRC R :file myplot.png :dir ~/Work
16713 matplot(matrix(rnorm(100), 10), type="l")
16717 To evaluate the code block on a remote machine, supply a remote
16718 directory name using Tramp syntax. For example:
16721 ,#+BEGIN_SRC R :file plot.png :dir /scp:dand@yakuba.princeton.edu:
16722 plot(1:10, main=system("hostname", intern=TRUE))
16726 Org first captures the text results as usual for insertion in the Org
16727 file. Then Org also inserts a link to the remote file, thanks to
16728 Emacs Tramp. Org constructs the remote path to the file name from
16729 =dir= and ~default-directory~, as illustrated here:
16731 : [[file:/scp:dand@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
16733 When =dir= is used with =session=, Org sets the starting directory for
16734 a new session. But Org does not alter the directory of an already
16737 Do not use =dir= with =:exports results= or with =:exports both= to
16738 avoid Org inserting incorrect links to remote files. That is because
16739 Org does not expand ~default directory~ to avoid some underlying
16740 portability issues.
16742 *** Inserting headers and footers
16747 #+cindex: headers, in code blocks
16748 #+cindex: footers, in code blocks
16749 #+cindex: @samp{prologue}, header argument
16750 The =prologue= header argument is for appending to the top of the code
16751 block for execution, like a reset instruction. For example, you may
16752 use =:prologue "reset"= in a Gnuplot code block or, for every such
16755 #+begin_src emacs-lisp
16756 (add-to-list 'org-babel-default-header-args:gnuplot
16757 '((:prologue . "reset")))
16761 #+cindex: @samp{epilogue}, header argument
16762 Likewise, the value of the =epilogue= header argument is for appending
16763 to the end of the code block for execution.
16765 ** Evaluating Code Blocks
16767 :DESCRIPTION: Place results of evaluation in the Org buffer.
16769 #+cindex: code block, evaluating
16770 #+cindex: source code, evaluating
16771 #+cindex: @samp{RESULTS}, keyword
16773 A note about security: With code evaluation comes the risk of harm.
16774 Org safeguards by prompting for user's permission before executing any
16775 code in the source block. To customize this safeguard, or disable it,
16776 see [[*Code Evaluation and Security Issues]].
16778 *** How to evaluate source code
16783 Org captures the results of the code block evaluation and inserts them
16784 in the Org file, right after the code block. The insertion point is
16785 after a newline and the =RESULTS= keyword. Org creates the =RESULTS=
16786 keyword if one is not already there.
16788 By default, Org enables only Emacs Lisp code blocks for execution.
16789 See [[*Languages]] to enable other languages.
16792 #+kindex: C-c C-v e
16793 #+findex: org-babel-execute-src-block
16794 Org provides many ways to execute code blocks. {{{kbd(C-c C-c)}}} or
16795 {{{kbd(C-c C-v e)}}} with the point on a code block[fn:130] calls the
16796 ~org-babel-execute-src-block~ function, which executes the code in the
16797 block, collects the results, and inserts them in the buffer.
16799 #+cindex: @samp{CALL}, keyword
16800 #+vindex: org-babel-inline-result-wrap
16801 By calling a named code block[fn:131] from an Org mode buffer or
16802 a table. Org can call the named code blocks from the current Org mode
16803 buffer or from the "Library of Babel" (see [[*Library of Babel]]).
16805 The syntax for =CALL= keyword is:
16808 ,#+CALL: <name>(<arguments>)
16809 ,#+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
16812 The syntax for inline named code blocks is:
16815 ... call_<name>(<arguments>) ...
16816 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
16819 When inline syntax is used, the result is wrapped based on the
16820 variable ~org-babel-inline-result-wrap~, which by default is set to
16821 ~"=%s="~ to produce verbatim text suitable for markup.
16825 This is the name of the code block (see [[*Structure of Code
16826 Blocks]]) to be evaluated in the current document. If the block is
16827 located in another file, start =<name>= with the file name
16828 followed by a colon. For example, in order to execute a block
16829 named =clear-data= in =file.org=, you can write the following:
16831 : #+CALL: file.org:clear-data()
16835 Org passes arguments to the code block using standard function
16836 call syntax. For example, a =#+CALL:= line that passes =4= to
16837 a code block named =double=, which declares the header argument
16838 =:var n=2=, would be written as:
16840 : #+CALL: double(n=4)
16842 #+texinfo: @noindent
16843 Note how this function call syntax is different from the header
16846 - =<inside header arguments>= ::
16848 Org passes inside header arguments to the named code block using
16849 the header argument syntax. Inside header arguments apply to
16850 code block evaluation. For example, =[:results output]= collects
16851 results printed to stdout during code execution of that block.
16852 Note how this header argument syntax is different from the
16853 function call syntax.
16855 - =<end header arguments>= ::
16857 End header arguments affect the results returned by the code
16858 block. For example, =:results html= wraps the results in
16859 a =#+BEGIN_EXPORT html= block before inserting the results in the
16862 *** Limit code block evaluation
16867 #+cindex: @samp{eval}, header argument
16868 #+cindex: control code block evaluation
16869 The =eval= header argument can limit evaluation of specific code
16870 blocks and =CALL= keyword. It is useful for protection against
16871 evaluating untrusted code blocks by prompting for a confirmation.
16873 - =never= or =no= ::
16875 Org never evaluates the source code.
16879 Org prompts the user for permission to evaluate the source code.
16881 - =never-export= or =no-export= ::
16883 Org does not evaluate the source code when exporting, yet the
16884 user can evaluate it interactively.
16886 - =query-export= ::
16888 Org prompts the user for permission to evaluate the source code
16891 If =eval= header argument is not set, then Org determines whether to
16892 evaluate the source code from the ~org-confirm-babel-evaluate~
16893 variable (see [[*Code Evaluation and Security Issues]]).
16895 *** Cache results of evaluation
16900 #+cindex: @samp{cache}, header argument
16901 #+cindex: cache results of code evaluation
16902 The =cache= header argument is for caching results of evaluating code
16903 blocks. Caching results can avoid re-evaluating a code block that
16904 have not changed since the previous run. To benefit from the cache
16905 and avoid redundant evaluations, the source block must have a result
16906 already present in the buffer, and neither the header
16907 arguments---including the value of =var= references---nor the text of
16908 the block itself has changed since the result was last computed. This
16909 feature greatly helps avoid long-running calculations. For some edge
16910 cases, however, the cached results may not be reliable.
16912 The caching feature is best for when code blocks are pure functions,
16913 that is functions that return the same value for the same input
16914 arguments (see [[*Environment of a Code Block]]), and that do not have
16915 side effects, and do not rely on external variables other than the
16916 input arguments. Functions that depend on a timer, file system
16917 objects, and random number generators are clearly unsuitable for
16920 A note of warning: when =cache= is used in a session, caching may
16921 cause unexpected results.
16923 When the caching mechanism tests for any source code changes, it does
16924 not expand Noweb style references (see [[*Noweb Reference Syntax]]). For
16925 reasons why, see http://thread.gmane.org/gmane.emacs.orgmode/79046.
16927 The =cache= header argument can have one of two values: =yes= or =no=.
16931 Default. No caching of results; code block evaluated every
16936 Whether to run the code or return the cached results is
16937 determined by comparing the SHA1 hash value of the combined code
16938 block and arguments passed to it. This hash value is packed on
16939 the =#+RESULTS:= line from previous evaluation. When hash values
16940 match, Org does not evaluate the code block. When hash values
16941 mismatch, Org evaluates the code block, inserts the results,
16942 recalculates the hash value, and updates =#+RESULTS:= line.
16944 In this example, both functions are cached. But =caller= runs only if
16945 the result from =random= has changed since the last run.
16949 ,#+BEGIN_SRC R :cache yes
16953 ,#+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
16957 ,#+BEGIN_SRC emacs-lisp :var x=random :cache yes
16961 ,#+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
16965 ** Results of Evaluation
16967 :DESCRIPTION: Choosing a results type, post-processing...
16969 #+cindex: code block, results of evaluation
16970 #+cindex: source code, results of evaluation
16972 #+cindex: @samp{results}, header argument
16973 How Org handles results of a code block execution depends on many
16974 header arguments working together. The primary determinant, however,
16975 is the =results= header argument. It accepts four classes of options.
16976 Each code block can take only one option per class:
16980 For how the results should be collected from the code block;
16984 For which type of result the code block will return; affects how
16985 Org processes and inserts results in the Org buffer;
16989 For the result; affects how Org processes and inserts results in
16994 For processing results after evaluation of the code block;
17001 Collection options specify the results. Choose one of the options;
17002 they are mutually exclusive.
17006 Default. Functional mode. Org gets the value by wrapping the
17007 code in a function definition in the language of the source
17008 block. That is why when using =:results value=, code should
17009 execute like a function and return a value. For languages like
17010 Python, an explicit ~return~ statement is mandatory when using
17011 =:results value=. Result is the value returned by the last
17012 statement in the code block.
17014 When evaluating the code block in a session (see [[*Environment of
17015 a Code Block]]), Org passes the code to an interpreter running as
17016 an interactive Emacs inferior process. Org gets the value from
17017 the source code interpreter's last statement output. Org has to
17018 use language-specific methods to obtain the value. For example,
17019 from the variable ~_~ in Python and Ruby, and the value of
17020 ~.Last.value~ in R.
17024 Scripting mode. Org passes the code to an external process
17025 running the interpreter. Org returns the contents of the
17026 standard output stream as text results.
17028 When using a session, Org passes the code to the interpreter
17029 running as an interactive Emacs inferior process. Org
17030 concatenates any text output from the interpreter and returns the
17031 collection as a result.
17033 Note that this collection is not the same as that would be
17034 collected from stdout of a non-interactive interpreter running as
17035 an external process. Compare for example these two blocks:
17038 ,#+BEGIN_SRC python :results output
17049 In the above non-session mode, the "2" is not printed; so it does
17050 not appear in results.
17053 ,#+BEGIN_SRC python :results output :session
17065 In the above session, the interactive interpreter receives and
17066 prints "2". Results show that.
17073 Type tells what result types to expect from the execution of the code
17074 block. Choose one of the options; they are mutually exclusive. The
17075 default behavior is to automatically determine the result type.
17077 #+attr_texinfo: :sep ,
17078 - =table=, =vector= ::
17080 Interpret the results as an Org table. If the result is a single
17081 value, create a table with one row and one column. Usage
17082 example: =:results value table=.
17084 #+cindex: @samp{hlines}, header argument
17085 In-between each table row or below the table headings, sometimes
17086 results have horizontal lines, which are also known as "hlines".
17087 The =hlines= argument with the default =no= value strips such
17088 lines from the input table. For most code, this is desirable, or
17089 else those =hline= symbols raise unbound variable errors.
17090 A =yes= accepts such lines, as demonstrated in the following
17102 ,#+BEGIN_SRC python :var tab=many-cols :hlines no
17106 ,#+RESULTS: no-hline
17112 ,#+BEGIN_SRC python :var tab=many-cols :hlines yes
17126 Interpret the results as an Org list. If the result is a single
17127 value, create a list of one element.
17129 - =scalar=, =verbatim= ::
17131 Interpret literally and insert as quoted text. Do not create
17132 a table. Usage example: =:results value verbatim=.
17136 Interpret as a filename. Save the results of execution of the
17137 code block to that file, then insert a link to it. You can
17138 control both the filename and the description associated to the
17141 #+cindex: @samp{file}, header argument
17142 #+cindex: @samp{output-dir}, header argument
17143 Org first tries to generate the filename from the value of the
17144 =file= header argument and the directory specified using the
17145 =output-dir= header arguments. If =output-dir= is not specified,
17146 Org assumes it is the current directory.
17149 ,#+BEGIN_SRC asymptote :results value file :file circle.pdf :output-dir img/
17155 #+cindex: @samp{file-ext}, header argument
17156 If =file= is missing, Org generates the base name of the output
17157 file from the name of the code block, and its extension from the
17158 =file-ext= header argument. In that case, both the name and the
17159 extension are mandatory.
17163 ,#+BEGIN_SRC asymptote :results value file :file-ext pdf
17169 #+cindex: @samp{file-desc}, header argument
17170 The =file-desc= header argument defines the description (see
17171 [[*Link Format]]) for the link. If =file-desc= has no value, Org
17172 uses the generated file name for both the "link" and
17173 "description" parts of the link.
17180 Format pertains to the type of the result returned by the code block.
17181 Choose one of the options; they are mutually exclusive. The default
17182 follows from the type specified above.
17186 Interpreted as raw Org mode. Inserted directly into the buffer.
17187 Aligned if it is a table. Usage example: =:results value raw=.
17191 Results enclosed in a =BEGIN_SRC org= block. For comma-escape,
17192 either {{{kbd(TAB)}}} in the block, or export the file. Usage
17193 example: =:results value org=.
17197 Results enclosed in a =BEGIN_EXPORT html= block. Usage example:
17198 =:results value html=.
17202 Results enclosed in a =BEGIN_EXPORT latex= block. Usage example:
17203 =:results value latex=.
17207 Result enclosed in a code block. Useful for parsing. Usage
17208 example: =:results value code=.
17212 Result converted to pretty-print source code. Enclosed in a code
17213 block. Languages supported: Emacs Lisp, Python, and Ruby. Usage
17214 example: =:results value pp=.
17218 Result wrapped in a =RESULTS= drawer. Useful for containing
17219 =raw= or =org= results for later scripting and automated
17220 processing. Usage example: =:results value drawer=.
17227 Handling options after collecting the results.
17231 Do not insert results in the Org mode buffer, but echo them in
17232 the minibuffer. Usage example: =:results output silent=.
17236 Default. Insert results in the Org buffer. Remove previous
17237 results. Usage example: =:results output replace=.
17241 Append results to the Org buffer. Latest results are at the
17242 bottom. Does not remove previous results. Usage example:
17243 =:results output append=.
17247 Prepend results to the Org buffer. Latest results are at the
17248 top. Does not remove previous results. Usage example: =:results
17251 *** Post-processing
17256 #+cindex: @samp{post}, header argument
17257 #+cindex: @samp{*this*}, in @samp{post} header argument
17258 The =post= header argument is for post-processing results from block
17259 evaluation. When =post= has any value, Org binds the results to
17260 ~*this*~ variable for easy passing to =var= header argument
17261 specifications (see [[*Environment of a Code Block]]). That makes results
17262 available to other code blocks, or even for direct Emacs Lisp code
17265 The following two examples illustrate =post= header argument in
17266 action. The first one shows how to attach an =ATTR_LATEX= keyword
17271 ,#+BEGIN_SRC sh :var data="" :var width="\\textwidth" :results output
17272 echo "#+ATTR_LATEX: :width $width"
17276 ,#+HEADER: :file /tmp/it.png
17277 ,#+BEGIN_SRC dot :post attr_wrap(width="5cm", data=*this*) :results drawer
17287 ,#+ATTR_LATEX :width 5cm
17288 [[file:/tmp/it.png]]
17292 The second example shows use of =colnames= header argument in =post=
17293 to pass data between code blocks.
17297 ,#+BEGIN_SRC emacs-lisp :var tbl="" fmt="%.3f"
17298 (mapcar (lambda (row)
17299 (mapcar (lambda (cell)
17307 ,#+BEGIN_SRC R :colnames yes :post round-tbl[:colnames yes](*this*)
17309 data.frame(foo=rnorm(1))
17318 ** Exporting Code Blocks
17320 :DESCRIPTION: Export contents and/or results.
17322 #+cindex: code block, exporting
17323 #+cindex: source code, exporting
17325 It is possible to export the /code/ of code blocks, the /results/ of
17326 code block evaluation, /both/ the code and the results of code block
17327 evaluation, or /none/. Org defaults to exporting /code/ for most
17328 languages. For some languages, such as ditaa, Org defaults to
17329 /results/. To export just the body of code blocks, see [[*Literal
17330 Examples]]. To selectively export sub-trees of an Org document, see
17333 #+cindex: @samp{export}, header argument
17334 The =exports= header argument is to specify if that part of the Org
17335 file is exported to, say, HTML or LaTeX formats.
17339 The default. The body of code is included into the exported
17340 file. Example: =:exports code=.
17344 The results of evaluation of the code is included in the exported
17345 file. Example: =:exports results=.
17349 Both the code and results of evaluation are included in the
17350 exported file. Example: =:exports both=.
17354 Neither the code nor the results of evaluation is included in the
17355 exported file. Whether the code is evaluated at all depends on
17356 other options. Example: =:exports none=.
17358 #+vindex: org-export-use-babel
17359 To stop Org from evaluating code blocks to speed exports, use the
17360 header argument =:eval never-export= (see [[*Evaluating Code Blocks]]).
17361 To stop Org from evaluating code blocks for greater security, set the
17362 ~org-export-use-babel~ variable to ~nil~, but understand that header
17363 arguments will have no effect.
17365 Turning off evaluation comes in handy when batch processing. For
17366 example, markup languages for wikis, which have a high risk of
17367 untrusted code. Stopping code block evaluation also stops evaluation
17368 of all header arguments of the code block. This may not be desirable
17369 in some circumstances. So during export, to allow evaluation of just
17370 the header arguments but not any code evaluation in the source block,
17371 set =:eval never-export= (see [[*Evaluating Code Blocks]]).
17373 Org never evaluates code blocks in commented sub-trees when exporting
17374 (see [[*Comment Lines]]). On the other hand, Org does evaluate code
17375 blocks in sub-trees excluded from export (see [[*Export Settings]]).
17377 ** Extracting Source Code
17379 :DESCRIPTION: Create pure source code files.
17382 #+cindex: source code, extracting
17383 #+cindex: code block, extracting source code
17385 Extracting source code from code blocks is a basic task in literate
17386 programming. Org has features to make this easy. In literate
17387 programming parlance, documents on creation are /woven/ with code and
17388 documentation, and on export, the code is tangled for execution by
17389 a computer. Org facilitates weaving and tangling for producing,
17390 maintaining, sharing, and exporting literate programming documents.
17391 Org provides extensive customization options for extracting source
17394 When Org tangles code blocks, it expands, merges, and transforms them.
17395 Then Org recomposes them into one or more separate files, as
17396 configured through the options. During this tangling process, Org
17397 expands variables in the source code, and resolves any Noweb style
17398 references (see [[*Noweb Reference Syntax]]).
17400 *** Header arguments
17405 #+cindex: @samp{tangle}, header argument
17406 The =tangle= header argument specifies if the code block is exported
17411 Export the code block to source file. The file name for the
17412 source file is derived from the name of the Org file, and the
17413 file extension is derived from the source code language
17414 identifier. Example: =:tangle yes=.
17418 The default. Do not extract the code in a source code file.
17419 Example: =:tangle no=.
17421 - {{{var(FILENAME)}}} ::
17423 Export the code block to source file whose file name is derived
17424 from any string passed to the =tangle= header argument. Org
17425 derives the file name as being relative to the directory of the
17426 Org file's location. Example: =:tangle FILENAME=.
17428 #+cindex: @samp{mkdirp}, header argument
17429 The =mkdirp= header argument creates parent directories for tangled
17430 files if the directory does not exist. =yes= enables directory
17431 creation and =no= inhibits directory creation.
17433 #+cindex: @samp{comments}, header argument
17434 The =comments= header argument controls inserting comments into
17435 tangled files. These are above and beyond whatever comments may
17436 already exist in the code block.
17440 The default. Do not insert any extra comments during tangling.
17444 Wrap the code block in comments. Include links pointing back to
17445 the place in the Org file from where the code was tangled.
17449 Kept for backward compatibility; same as =link=.
17453 Nearest headline text from Org file is inserted as comment. The
17454 exact text that is inserted is picked from the leading context of
17459 Includes both =link= and =org= options.
17463 Includes =link= option, expands Noweb references (see [[*Noweb
17464 Reference Syntax]]), and wraps them in link comments inside the
17465 body of the code block.
17467 #+cindex: @samp{padline}, header argument
17468 The =padline= header argument controls insertion of newlines to pad
17469 source code in the tangled file.
17473 Default. Insert a newline before and after each code block in
17478 Do not insert newlines to pad the tangled code blocks.
17480 #+cindex: @samp{shebang}, header argument
17481 The =shebang= header argument can turn results into executable script
17482 files. By setting it to a string value---for example, =:shebang
17483 "#!/bin/bash"=---Org inserts that string as the first line of the
17484 tangled file that the code block is extracted to. Org then turns on
17485 the tangled file's executable permission.
17487 #+cindex: @samp{no-expand}, header argument
17488 By default Org expands code blocks during tangling. The =no-expand=
17489 header argument turns off such expansions. Note that one side-effect
17490 of expansion by ~org-babel-expand-src-block~ also assigns values (see
17491 [[*Environment of a Code Block]]) to variables. Expansions also replace
17492 Noweb references with their targets (see [[*Noweb Reference Syntax]]).
17493 Some of these expansions may cause premature assignment, hence this
17494 option. This option makes a difference only for tangling. It has no
17495 effect when exporting since code blocks for execution have to be
17503 - ~org-babel-tangle~ ::
17505 #+findex: org-babel-tangle
17506 #+kindex: C-c C-v t
17507 Tangle the current file. Bound to {{{kbd(C-c C-v t)}}}.
17509 With prefix argument only tangle the current code block.
17511 - ~org-babel-tangle-file~ ::
17513 #+findex: org-babel-tangle-file
17514 #+kindex: C-c C-v f
17515 Choose a file to tangle. Bound to {{{kbd(C-c C-v f)}}}.
17522 - ~org-babel-post-tangle-hook~ ::
17524 #+vindex: org-babel-post-tangle-hook
17525 This hook is run from within code files tangled by
17526 ~org-babel-tangle~, making it suitable for post-processing,
17527 compilation, and evaluation of code in the tangled files.
17529 *** Jumping between code and Org
17534 #+findex: org-babel-tangle-jump-to-org
17535 Debuggers normally link errors and messages back to the source code.
17536 But for tangled files, we want to link back to the Org file, not to
17537 the tangled source file. To make this extra jump, Org uses
17538 ~org-babel-tangle-jump-to-org~ function with two additional source
17539 code block header arguments:
17541 1. Set =padline= to true---this is the default setting.
17542 2. Set =comments= to =link=, which makes Org insert links to the Org
17547 :DESCRIPTION: List of supported code block languages.
17549 #+cindex: babel, languages
17550 #+cindex: source code, languages
17551 #+cindex: code block, languages
17553 Code blocks in the following languages are supported.
17555 | Language | Identifier | Language | Identifier |
17556 |------------+------------+----------------+------------|
17557 | Asymptote | asymptote | Awk | awk |
17558 | C | C | C++ | C++ |
17559 | Clojure | clojure | CSS | css |
17560 | D | d | ditaa | ditaa |
17561 | Graphviz | dot | Emacs Calc | calc |
17562 | Emacs Lisp | emacs-lisp | Fortran | fortran |
17563 | Gnuplot | gnuplot | Haskell | haskell |
17564 | Java | java | Javascript | js |
17565 | LaTeX | latex | Ledger | ledger |
17566 | Lisp | lisp | Lilypond | lilypond |
17567 | Lua | lua | MATLAB | matlab |
17568 | Mscgen | mscgen | Objective Caml | ocaml |
17569 | Octave | octave | Org mode | org |
17570 | Oz | oz | Perl | perl |
17571 | Plantuml | plantuml | Processing.js | processing |
17572 | Python | python | R | R |
17573 | Ruby | ruby | Sass | sass |
17574 | Scheme | scheme | GNU Screen | screen |
17575 | Sed | sed | shell | sh |
17576 | SQL | sql | SQLite | sqlite |
17577 | Vala | vala | | |
17579 Additional documentation for some languages is at
17580 https://orgmode.org/worg/org-contrib/babel/languages.html.
17582 #+vindex: org-babel-load-languages
17583 By default, only Emacs Lisp is enabled for evaluation. To enable or
17584 disable other languages, customize the ~org-babel-load-languages~
17585 variable either through the Emacs customization interface, or by
17586 adding code to the init file as shown next.
17588 In this example, evaluation is disabled for Emacs Lisp, and enabled
17591 #+begin_src emacs-lisp
17592 (org-babel-do-load-languages
17593 'org-babel-load-languages
17594 '((emacs-lisp . nil)
17598 Note that this is not the only way to enable a language. Org also
17599 enables languages when loaded with ~require~ statement. For example,
17600 the following enables execution of Clojure code blocks:
17602 #+begin_src emacs-lisp
17603 (require 'ob-clojure)
17606 ** Editing Source Code
17608 :DESCRIPTION: Language major-mode editing.
17610 #+cindex: code block, editing
17611 #+cindex: source code, editing
17614 Use {{{kbd(C-c ')}}} to edit the current code block. It opens a new
17615 major-mode edit buffer containing the body of the source code block,
17616 ready for any edits. Use {{{kbd(C-c ')}}} again to close the buffer
17617 and return to the Org buffer.
17620 #+vindex: org-edit-src-auto-save-idle-delay
17621 #+cindex: auto-save, in code block editing
17622 {{{kbd(C-x C-s)}}} saves the buffer and updates the contents of the
17623 Org buffer. Set ~org-edit-src-auto-save-idle-delay~ to save the base
17624 buffer after a certain idle delay time. Set
17625 ~org-edit-src-turn-on-auto-save~ to auto-save this buffer into
17626 a separate file using Auto-save mode.
17628 While editing the source code in the major mode, the Org Src minor
17629 mode remains active. It provides these customization variables as
17630 described below. For even more variables, look in the customization
17631 group ~org-edit-structure~.
17633 - ~org-src-lang-modes~ ::
17635 #+vindex: org-src-lang-modes
17636 If an Emacs major-mode named ~<LANG>-mode~ exists, where
17637 {{{var(<LANG>)}}} is the language identifier from code block's
17638 header line, then the edit buffer uses that major mode. Use this
17639 variable to arbitrarily map language identifiers to major modes.
17641 - ~org-src-window-setup~ ::
17643 #+vindex: org-src-window-setup
17644 For specifying Emacs window arrangement when the new edit buffer
17647 - ~org-src-preserve-indentation~ ::
17649 #+cindex: indentation, in code blocks
17650 #+vindex: org-src-preserve-indentation
17651 Default is ~nil~. Source code is indented. This indentation
17652 applies during export or tangling, and depending on the context,
17653 may alter leading spaces and tabs. When non-~nil~, source code
17654 is aligned with the leftmost column. No lines are modified
17655 during export or tangling, which is very useful for white-space
17656 sensitive languages, such as Python.
17658 - ~org-src-ask-before-returning-to-edit-buffer~ ::
17660 #+vindex: org-src-ask-before-returning-to-edit-buffer
17661 When ~nil~, Org returns to the edit buffer without further
17662 prompts. The default prompts for a confirmation.
17664 #+vindex: org-src-fontify-natively
17665 #+vindex: org-src-block-faces
17666 Set ~org-src-fontify-natively~ to non-~nil~ to turn on native code
17667 fontification in the /Org/ buffer. Fontification of code blocks can
17668 give visual separation of text and code on the display page. To
17669 further customize the appearance of ~org-block~ for specific
17670 languages, customize ~org-src-block-faces~. The following example
17671 shades the background of regular blocks, and colors source blocks only
17672 for Python and Emacs Lisp languages.
17674 #+begin_src emacs-lisp
17676 (set-face-attribute 'org-block nil :background
17678 (face-attribute 'default :background) 3))
17680 (setq org-src-block-faces '(("emacs-lisp" (:background "#EEE2FF"))
17681 ("python" (:background "#E5FFB8"))))
17684 ** Noweb Reference Syntax
17686 :DESCRIPTION: Literate programming in Org mode.
17688 #+cindex: code block, Noweb reference
17689 #+cindex: syntax, Noweb
17690 #+cindex: source code, Noweb reference
17692 Org supports named blocks in Noweb[fn:132] style syntax:
17694 : <<CODE-BLOCK-ID>>
17696 Org can replace the construct with the source code, or the results of
17697 evaluation, of the code block identified as {{{var(CODE-BLOCK-ID)}}}.
17699 #+cindex: @samp{noweb}, header argument
17700 The =noweb= header argument controls expansion of Noweb syntax
17701 references. Expansions occur when source code blocks are evaluated,
17702 tangled, or exported.
17706 Default. No expansion of Noweb syntax references in the body of
17707 the code when evaluating, tangling, or exporting.
17711 Expansion of Noweb syntax references in the body of the code
17712 block when evaluating, tangling, or exporting.
17716 Expansion of Noweb syntax references in the body of the code
17717 block when tangling. No expansion when evaluating or exporting.
17721 Expansion of Noweb syntax references in the body of the code
17722 block when evaluating or tangling. No expansion when exporting.
17724 - =strip-export= ::
17726 Expansion of Noweb syntax references in the body of the code
17727 block when expanding prior to evaluating or tangling. Removes
17728 Noweb syntax references when exporting.
17732 Expansion of Noweb syntax references in the body of the code
17733 block only before evaluating.
17735 In the following example,
17738 ,#+NAME: initialization
17739 ,#+BEGIN_SRC emacs-lisp
17740 (setq sentence "Never a foot too far, even.")
17743 ,#+BEGIN_SRC emacs-lisp :noweb yes
17749 #+texinfo: @noindent
17750 the second code block is expanded as
17753 ,#+BEGIN_SRC emacs-lisp :noweb yes
17754 (setq sentence "Never a foot too far, even.")
17759 Noweb insertions honor prefix characters that appear before the Noweb
17760 syntax reference. This behavior is illustrated in the following
17761 example. Because the =<<example>>= Noweb reference appears behind the
17762 SQL comment syntax, each line of the expanded Noweb reference is
17769 multi-line body of example
17773 #+texinfo: @noindent
17777 ,#+BEGIN_SRC sql :noweb yes
17782 #+texinfo: @noindent
17786 ,#+BEGIN_SRC sql :noweb yes
17788 ---multi-line body of example
17792 Since this change does not affect Noweb replacement text without
17793 newlines in them, inline Noweb references are acceptable.
17795 This feature can also be used for management of indentation in
17796 exported code snippets. With:
17800 ,#+BEGIN_SRC python :exports none
17801 print('do things when true')
17805 ,#+begin_src python :exports none
17806 print('do things when false')
17810 #+texinfo: @noindent
17814 ,#+begin_src python :noweb yes :results output
17822 #+texinfo: @noindent
17827 print('do things when true')
17829 print('do things when false')
17832 #+cindex: @samp{noweb-ref}, header argument
17833 When expanding Noweb style references, Org concatenates code blocks by
17834 matching the reference name to either the code block name or, if none
17835 is found, to the =noweb-ref= header argument.
17837 For simple concatenation, set this =noweb-ref= header argument at the
17838 sub-tree or file level. In the example Org file shown next, the body
17839 of the source code in each block is extracted for concatenation to
17840 a pure code file when tangled.
17843 ,#+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
17846 ,* the mount point of the fullest disk
17848 :header-args: :noweb-ref fullest-disk
17851 ,** query all mounted disks
17856 ,** strip the header row
17861 ,** output mount point of fullest disk
17863 |awk '{if (u < +$5) {u = +$5; m = $6}} END {print m}'
17867 #+cindex: @samp{noweb-sep}, header argument
17868 By default a newline separates each noweb reference concatenation. To
17869 change this newline separator, edit the =noweb-sep= header argument.
17871 Eventually, Org can include the results of a code block rather than
17872 its body. To that effect, append parentheses, possibly including
17873 arguments, to the code block name, as shown below.
17875 : <<code-block-name(optional arguments)>>
17877 Note that when using the above approach to a code block's results, the
17878 code block name set by =NAME= keyword is required; the reference set
17879 by =noweb-ref= does not work in that case.
17881 Here is an example that demonstrates how the exported content changes
17882 when Noweb style references are used with parentheses versus without.
17887 ,#+BEGIN_SRC python :var num=0 :results output :exports none
17892 #+texinfo: @noindent
17896 ,#+BEGIN_SRC text :noweb yes
17901 #+texinfo: @noindent
17906 Below, a similar Noweb style reference is used, but with parentheses,
17907 while setting a variable =num= to 10:
17910 ,#+BEGIN_SRC text :noweb yes
17911 <<some-code(num=10)>>
17915 #+texinfo: @noindent
17916 Note that now the expansion contains the results of the code block
17917 =some-code=, not the code block itself:
17921 ** Library of Babel
17923 :DESCRIPTION: Use and contribute to a library of useful code blocks.
17925 #+cindex: babel, library of
17926 #+cindex: source code, library
17927 #+cindex: code block, library
17929 The "Library of Babel" is a collection of code blocks. Like
17930 a function library, these code blocks can be called from other Org
17931 files. A collection of useful code blocks is available on [[https://orgmode.org/worg/library-of-babel.html][Worg]]. For
17932 remote code block evaluation syntax, see [[*Evaluating Code Blocks]].
17934 #+kindex: C-c C-v i
17935 #+findex: org-babel-lob-ingest
17936 For any user to add code to the library, first save the code in
17937 regular code blocks of an Org file, and then load the Org file with
17938 ~org-babel-lob-ingest~, which is bound to {{{kbd(C-c C-v i)}}}.
17940 ** Key bindings and Useful Functions
17942 :DESCRIPTION: Work quickly with code blocks.
17944 #+cindex: code block, key bindings
17946 Many common Org mode key sequences are re-bound depending on
17949 Active key bindings in code blocks:
17952 #+findex: org-babel-execute-src-block
17954 #+findex: org-babel-open-src-block-result
17956 #+findex: org-babel-load-in-session
17958 #+findex: org-babel-pop-to-session
17959 #+attr_texinfo: :columns 0.2 0.55
17960 | Key binding | Function |
17961 |--------------------+-----------------------------------|
17962 | {{{kbd(C-c C-c)}}} | ~org-babel-execute-src-block~ |
17963 | {{{kbd(C-c C-o)}}} | ~org-babel-open-src-block-result~ |
17964 | {{{kbd(M-UP)}}} | ~org-babel-load-in-session~ |
17965 | {{{kbd(M-DOWN)}}} | ~org-babel-pop-to-session~ |
17967 Active key bindings in Org mode buffer:
17969 #+kindex: C-c C-v p
17970 #+kindex: C-c C-v C-p
17971 #+kindex: C-c C-v n
17972 #+kindex: C-c C-v C-n
17973 #+kindex: C-c C-v e
17974 #+kindex: C-c C-v C-e
17975 #+kindex: C-c C-v o
17976 #+kindex: C-c C-v C-o
17977 #+kindex: C-c C-v v
17978 #+kindex: C-c C-v C-v
17979 #+kindex: C-c C-v u
17980 #+kindex: C-c C-v C-u
17981 #+kindex: C-c C-v g
17982 #+kindex: C-c C-v C-g
17983 #+kindex: C-c C-v r
17984 #+kindex: C-c C-v C-r
17985 #+kindex: C-c C-v b
17986 #+kindex: C-c C-v C-b
17987 #+kindex: C-c C-v s
17988 #+kindex: C-c C-v C-s
17989 #+kindex: C-c C-v d
17990 #+kindex: C-c C-v C-d
17991 #+kindex: C-c C-v t
17992 #+kindex: C-c C-v C-t
17993 #+kindex: C-c C-v f
17994 #+kindex: C-c C-v C-f
17995 #+kindex: C-c C-v c
17996 #+kindex: C-c C-v C-c
17997 #+kindex: C-c C-v j
17998 #+kindex: C-c C-v C-j
17999 #+kindex: C-c C-v l
18000 #+kindex: C-c C-v C-l
18001 #+kindex: C-c C-v i
18002 #+kindex: C-c C-v C-i
18003 #+kindex: C-c C-v I
18004 #+kindex: C-c C-v C-I
18005 #+kindex: C-c C-v z
18006 #+kindex: C-c C-v C-z
18007 #+kindex: C-c C-v a
18008 #+kindex: C-c C-v C-a
18009 #+kindex: C-c C-v h
18010 #+kindex: C-c C-v C-h
18011 #+kindex: C-c C-v x
18012 #+kindex: C-c C-v C-x
18013 #+findex: org-babel-previous-src-block
18014 #+findex: org-babel-next-src-block
18015 #+findex: org-babel-execute-maybe
18016 #+findex: org-babel-open-src-block-result
18017 #+findex: org-babel-expand-src-block
18018 #+findex: org-babel-goto-src-block-head
18019 #+findex: org-babel-goto-named-src-block
18020 #+findex: org-babel-goto-named-result
18021 #+findex: org-babel-execute-buffer
18022 #+findex: org-babel-execute-subtree
18023 #+findex: org-babel-demarcate-block
18024 #+findex: org-babel-tangle
18025 #+findex: org-babel-tangle-file
18026 #+findex: org-babel-check-src-block
18027 #+findex: org-babel-insert-header-arg
18028 #+findex: org-babel-load-in-session
18029 #+findex: org-babel-lob-ingest
18030 #+findex: org-babel-view-src-block-info
18031 #+findex: org-babel-switch-to-session-with-code
18032 #+findex: org-babel-sha1-hash
18033 #+findex: org-babel-describe-bindings
18034 #+findex: org-babel-do-key-sequence-in-edit-buffer
18035 #+attr_texinfo: :columns 0.45 0.55
18036 | Key binding | Function |
18037 |------------------------------------------------+--------------------------------------------|
18038 | {{{kbd(C-c C-v p)}}} or {{{kbd(C-c C-v C-p)}}} | ~org-babel-previous-src-block~ |
18039 | {{{kbd(C-c C-v n)}}} or {{{kbd(C-c C-v C-n)}}} | ~org-babel-next-src-block~ |
18040 | {{{kbd(C-c C-v e)}}} or {{{kbd(C-c C-v C-e)}}} | ~org-babel-execute-maybe~ |
18041 | {{{kbd(C-c C-v o)}}} or {{{kbd(C-c C-v C-o)}}} | ~org-babel-open-src-block-result~ |
18042 | {{{kbd(C-c C-v v)}}} or {{{kbd(C-c C-v C-v)}}} | ~org-babel-expand-src-block~ |
18043 | {{{kbd(C-c C-v u)}}} or {{{kbd(C-c C-v C-u)}}} | ~org-babel-goto-src-block-head~ |
18044 | {{{kbd(C-c C-v g)}}} or {{{kbd(C-c C-v C-g)}}} | ~org-babel-goto-named-src-block~ |
18045 | {{{kbd(C-c C-v r)}}} or {{{kbd(C-c C-v C-r)}}} | ~org-babel-goto-named-result~ |
18046 | {{{kbd(C-c C-v b)}}} or {{{kbd(C-c C-v C-b)}}} | ~org-babel-execute-buffer~ |
18047 | {{{kbd(C-c C-v s)}}} or {{{kbd(C-c C-v C-s)}}} | ~org-babel-execute-subtree~ |
18048 | {{{kbd(C-c C-v d)}}} or {{{kbd(C-c C-v C-d)}}} | ~org-babel-demarcate-block~ |
18049 | {{{kbd(C-c C-v t)}}} or {{{kbd(C-c C-v C-t)}}} | ~org-babel-tangle~ |
18050 | {{{kbd(C-c C-v f)}}} or {{{kbd(C-c C-v C-f)}}} | ~org-babel-tangle-file~ |
18051 | {{{kbd(C-c C-v c)}}} or {{{kbd(C-c C-v C-c)}}} | ~org-babel-check-src-block~ |
18052 | {{{kbd(C-c C-v j)}}} or {{{kbd(C-c C-v C-j)}}} | ~org-babel-insert-header-arg~ |
18053 | {{{kbd(C-c C-v l)}}} or {{{kbd(C-c C-v C-l)}}} | ~org-babel-load-in-session~ |
18054 | {{{kbd(C-c C-v i)}}} or {{{kbd(C-c C-v C-i)}}} | ~org-babel-lob-ingest~ |
18055 | {{{kbd(C-c C-v I)}}} or {{{kbd(C-c C-v C-I)}}} | ~org-babel-view-src-block-info~ |
18056 | {{{kbd(C-c C-v z)}}} or {{{kbd(C-c C-v C-z)}}} | ~org-babel-switch-to-session-with-code~ |
18057 | {{{kbd(C-c C-v a)}}} or {{{kbd(C-c C-v C-a)}}} | ~org-babel-sha1-hash~ |
18058 | {{{kbd(C-c C-v h)}}} or {{{kbd(C-c C-v C-h)}}} | ~org-babel-describe-bindings~ |
18059 | {{{kbd(C-c C-v x)}}} or {{{kbd(C-c C-v C-x)}}} | ~org-babel-do-key-sequence-in-edit-buffer~ |
18063 :DESCRIPTION: Call functions from the command line.
18065 #+cindex: code block, batch execution
18066 #+cindex: source code, batch execution
18068 Org mode features, including working with source code facilities can
18069 be invoked from the command line. This enables building shell scripts
18070 for batch processing, running automated system tasks, and expanding
18071 Org mode's usefulness.
18073 The sample script shows batch processing of multiple files using
18074 ~org-babel-tangle~.
18078 # Tangle files with Org mode
18080 emacs -Q --batch --eval "
18082 (require 'ob-tangle)
18083 (dolist (file command-line-args-left)
18084 (with-current-buffer (find-file-noselect file)
18085 (org-babel-tangle))))
18091 :DESCRIPTION: All the rest which did not fit elsewhere.
18096 :DESCRIPTION: M-TAB guesses completions.
18098 #+cindex: completion, of @TeX{} symbols
18099 #+cindex: completion, of TODO keywords
18100 #+cindex: completion, of dictionary words
18101 #+cindex: completion, of option keywords
18102 #+cindex: completion, of tags
18103 #+cindex: completion, of property keys
18104 #+cindex: completion, of link abbreviations
18105 #+cindex: @TeX{} symbol completion
18106 #+cindex: TODO keywords completion
18107 #+cindex: dictionary word completion
18108 #+cindex: option keyword completion
18109 #+cindex: tag completion
18110 #+cindex: link abbreviations, completion of
18112 Org has in-buffer completions. Unlike minibuffer completions, which
18113 are useful for quick command interactions, Org's in-buffer completions
18114 are more suitable for content creation in Org documents. Type one or
18115 more letters and invoke the hot key to complete the text in-place.
18116 Depending on the context and the keys, Org offers different types of
18117 completions. No minibuffer is involved. Such mode-specific hot keys
18118 have become an integral part of Emacs and Org provides several
18121 - {{{kbd(M-TAB)}}} ::
18124 Complete word at point.
18126 - At the beginning of a headline, complete TODO keywords.
18128 - After =\=, complete TeX symbols supported by the exporter.
18130 - After =*=, complete headlines in the current buffer so that
18131 they can be used in search links like:
18133 : [[*find this headline]]
18135 - After =:= in a headline, complete tags. Org deduces the list
18136 of tags from the =TAGS= in-buffer option (see [[*Setting Tags]]),
18137 the variable ~org-tag-alist~, or from all tags used in the
18140 - After =:= and not in a headline, complete property keys. The
18141 list of keys is constructed dynamically from all keys used in
18142 the current buffer.
18144 - After =[=, complete link abbreviations (see [[*Link
18147 - After =#+=, complete the special keywords like =TYP_TODO= or
18148 file-specific =OPTIONS=. After option keyword is complete,
18149 pressing {{{kbd(M-TAB)}}} again inserts example settings for
18152 - After =STARTUP= keyword, complete startup items.
18154 - When point is anywhere else, complete dictionary words using
18157 ** Structure Templates
18159 :DESCRIPTION: Quick insertion of structural elements.
18161 #+cindex: template insertion
18162 #+cindex: insertion, of templates
18164 With just a few keystrokes, it is possible to insert empty structural
18165 blocks, such as =#+BEGIN_SRC= ... =#+END_SRC=, or to wrap existing
18166 text in such a block.
18168 - {{{kbd(C-c C-x w)}}} (~org-insert-structure-template~) ::
18170 Prompt for a type of block structure, and insert the block at
18171 point. If the region is active, it is wrapped in the block.
18172 First prompts the user for a key, which is used to look up
18173 a structure type from the values below. If the key is
18174 {{{kbd(TAB)}}}, the user is prompted to enter a type.
18176 #+vindex: org-structure-template-alist
18177 Available structure types are defined in
18178 ~org-structure-template-alist~, see the docstring for adding or
18182 #+cindex: template expansion
18183 #+cindex: insertion, of templates
18184 #+vindex: org-tempo-keywords-alist
18185 #+vindex: org-structure-template-alist
18186 Org Tempo expands snippets to structures defined in
18187 ~org-structure-template-alist~ and ~org-tempo-keywords-alist~. For
18188 example, {{{kbd(< s TAB)}}} creates a code block. Enable it by
18189 customizing ~org-modules~ or add ~(require 'org-tempo)~ to your Emacs
18193 #+attr_texinfo: :columns 0.1 0.9
18194 | {{{kbd(a)}}} | =#+BEGIN_EXPORT ascii= ... =#+END_EXPORT= |
18195 | {{{kbd(c)}}} | =#+BEGIN_CENTER= ... =#+END_CENTER= |
18196 | {{{kbd(C)}}} | =#+BEGIN_COMMENT= ... =#+END_COMMENT= |
18197 | {{{kbd(e)}}} | =#+BEGIN_EXAMPLE= ... =#+END_EXAMPLE= |
18198 | {{{kbd(h)}}} | =#+BEGIN_EXPORT html= ... =#+END_EXPORT= |
18199 | {{{kbd(l)}}} | =#+BEGIN_EXPORT latex= ... =#+END_EXPORT= |
18200 | {{{kbd(q)}}} | =#+BEGIN_QUOTE= ... =#+END_QUOTE= |
18201 | {{{kbd(s)}}} | =#+BEGIN_SRC= ... =#+END_SRC= |
18202 | {{{kbd(v)}}} | =#+BEGIN_VERSE= ... =#+END_VERSE= |
18207 :DESCRIPTION: Electric commands at the beginning of a headline.
18209 #+cindex: speed keys
18211 Single keystrokes can execute custom commands in an Org file when the
18212 cursor is on a headline. Without the extra burden of a meta or
18213 modifier key, Speed Keys can speed navigation or execute custom
18214 commands. Besides faster navigation, Speed Keys may come in handy on
18215 small mobile devices that do not have full keyboards. Speed Keys may
18216 also work on TTY devices known for their problems when entering Emacs
18219 #+vindex: org-use-speed-commands
18220 By default, Org has Speed Keys disabled. To activate Speed Keys, set
18221 the variable ~org-use-speed-commands~ to a non-~nil~ value. To
18222 trigger a Speed Key, the cursor must be at the beginning of an Org
18223 headline, before any of the stars.
18225 #+vindex: org-speed-commands-user
18226 #+findex: org-speed-command-help
18227 Org comes with a pre-defined list of Speed Keys. To add or modify
18228 Speed Keys, customize the variable, ~org-speed-commands-user~. For
18229 more details, see the variable's docstring. With Speed Keys
18230 activated, {{{kbd(M-x org-speed-command-help)}}}, or {{{kbd(?)}}} when
18231 cursor is at the beginning of an Org headline, shows currently active
18232 Speed Keys, including the user-defined ones.
18234 ** Code Evaluation and Security Issues
18236 :DESCRIPTION: Org files evaluate in-line code.
18237 :ALT_TITLE: Code Evaluation Security
18240 Unlike plain text, running code comes with risk. Each =src= code
18241 block, in terms of risk, is equivalent to an executable file. Org
18242 therefore puts a few confirmation prompts by default. This is to
18243 alert the casual user from accidentally running untrusted code.
18245 For users who do not run code blocks or write code regularly, Org's
18246 default settings should suffice. However, some users may want to
18247 tweak the prompts for fewer interruptions. To weigh the risks of
18248 automatic execution of code blocks, here are some details about code
18251 Org evaluates code in the following circumstances:
18253 - /Source code blocks/ ::
18255 Org evaluates =src= code blocks in an Org file during export.
18256 Org also evaluates a =src= code block with the {{{kbd(C-c C-c)}}}
18257 key chord. Users exporting or running code blocks must load
18258 files only from trusted sources. Be wary of customizing
18259 variables that remove or alter default security measures.
18261 #+attr_texinfo: :options org-confirm-babel-evaluate
18263 When ~t~, Org prompts the user for confirmation before executing
18264 each code block. When ~nil~, Org executes code blocks without
18265 prompting the user for confirmation. When this option is set to
18266 a custom function, Org invokes the function with these two
18267 arguments: the source code language and the body of the code
18268 block. The custom function must return either a ~t~ or ~nil~,
18269 which determines if the user is prompted. Each source code
18270 language can be handled separately through this function
18274 For example, here is how to execute ditaa code blocks without
18277 #+begin_src emacs-lisp
18278 (defun my-org-confirm-babel-evaluate (lang body)
18279 (not (string= lang "ditaa"))) ;don't ask for ditaa
18280 (setq org-confirm-babel-evaluate #'my-org-confirm-babel-evaluate)
18283 - /Following =shell= and =elisp= links/ ::
18285 Org has two link types that can directly evaluate code (see
18286 [[*External Links]]). Because such code is not visible, these links
18287 have a potential risk. Org therefore prompts the user when it
18288 encounters such links. The customization variables are:
18290 #+attr_texinfo: :options org-confirm-shell-link-function
18292 Function that prompts the user before executing a shell link.
18295 #+attr_texinfo: :options org-confirm-elisp-link-function
18297 Function that prompts the user before executing an Emacs Lisp link.
18300 - /Formulas in tables/ ::
18302 Formulas in tables (see [[*The spreadsheet]]) are code that is
18303 evaluated either by the Calc interpreter, or by the Emacs Lisp
18308 :DESCRIPTION: Adapting Org to your taste.
18310 #+cindex: customization
18311 #+cindex: options, for customization
18312 #+cindex: variables, for customization
18314 Org has more than 500 variables for customization. They can be
18315 accessed through the usual {{{kbd(M-x org-customize)}}} command. Or
18316 through the Org menu: Org \rarr Customization \rarr Browse Org Group.
18318 Org also has per-file settings for some variables (see [[*Summary of
18319 In-Buffer Settings]]).
18321 ** Summary of In-Buffer Settings
18323 :DESCRIPTION: Overview of keywords.
18324 :ALT_TITLE: In-buffer Settings
18326 #+cindex: in-buffer settings
18327 #+cindex: special keywords
18329 In-buffer settings start with =#+=, followed by a keyword, a colon,
18330 and then a word for each setting. Org accepts multiple settings on
18331 the same line. Org also accepts multiple lines for a keyword. This
18332 manual describes these settings throughout. A summary follows here.
18334 #+cindex: refresh set-up
18335 {{{kbd(C-c C-c)}}} activates any changes to the in-buffer settings.
18336 Closing and reopening the Org file in Emacs also activates the
18339 #+attr_texinfo: :sep ,
18340 - =#+ARCHIVE: %s_done= ::
18342 #+cindex: @samp{ARCHIVE}, keyword
18343 #+vindex: org-archive-location
18344 Sets the archive location of the agenda file. The corresponding
18345 variable is ~org-archive-location~.
18349 #+cindex: @samp{CATEGORY}, keyword
18350 Sets the category of the agenda file, which applies to the entire
18353 - =#+COLUMNS: %25ITEM ...= ::
18355 #+cindex: @samp{COLUMNS}, property
18356 Set the default format for columns view. This format applies
18357 when columns view is invoked in locations where no =COLUMNS=
18360 - =#+CONSTANTS: name1=value1 ...= ::
18362 #+cindex: @samp{CONSTANTS}, keyword
18363 #+vindex: org-table-formula-constants
18364 #+vindex: org-table-formula
18365 Set file-local values for constants that table formulas can use.
18366 This line sets the local variable
18367 ~org-table-formula-constants-local~. The global version of this
18368 variable is ~org-table-formula-constants~.
18370 - =#+FILETAGS: :tag1:tag2:tag3:= ::
18372 #+cindex: @samp{FILETAGS}, keyword
18373 Set tags that all entries in the file inherit from, including the
18376 - =#+LINK: linkword replace= ::
18378 #+cindex: @samp{LINK}, keyword
18379 #+vindex: org-link-abbrev-alist
18380 Each line specifies one abbreviation for one link. Use multiple
18381 =LINK= keywords for more, see [[*Link Abbreviations]]. The
18382 corresponding variable is ~org-link-abbrev-alist~.
18384 - =#+PRIORITIES: highest lowest default= ::
18386 #+cindex: @samp{PRIORITIES}, keyword
18387 #+vindex: org-highest-priority
18388 #+vindex: org-lowest-priority
18389 #+vindex: org-default-priority
18390 This line sets the limits and the default for the priorities.
18391 All three must be either letters A--Z or numbers 0--9. The
18392 highest priority must have a lower ASCII number than the lowest
18395 - =#+PROPERTY: Property_Name Value= ::
18397 #+cindex: @samp{PROPERTY}, keyword
18398 This line sets a default inheritance value for entries in the
18399 current buffer, most useful for specifying the allowed values of
18402 - =#+SETUPFILE: file= ::
18404 #+cindex: @samp{SETUPFILE}, keyword
18405 The setup file or a URL pointing to such file is for additional
18406 in-buffer settings. Org loads this file and parses it for any
18407 settings in it only when Org opens the main file. If URL is
18408 specified, the contents are downloaded and stored in a temporary
18409 file cache. {{{kbd(C-c C-c)}}} on the settings line parses and
18410 loads the file, and also resets the temporary file cache. Org
18411 also parses and loads the document during normal exporting
18412 process. Org parses the contents of this document as if it was
18413 included in the buffer. It can be another Org file. To visit
18414 the file---not a URL---use {{{kbd(C-c ')}}} while the cursor is
18415 on the line with the file name.
18419 #+cindex: @samp{STARTUP}, keyword
18420 Startup options Org uses when first visiting a file.
18422 #+vindex: org-startup-folded
18423 The first set of options deals with the initial visibility of the
18424 outline tree. The corresponding variable for global default
18425 settings is ~org-startup-folded~ with a default value of ~t~,
18426 which is the same as ~overview~.
18430 Top-level headlines only.
18438 No folding on any entry.
18440 - =showeverything= ::
18442 Show even drawer contents.
18444 #+vindex: org-startup-indented
18445 Dynamic virtual indentation is controlled by the variable
18446 ~org-startup-indented~.[fn:134]
18450 Start with ~org-indent-mode~ turned on.
18454 Start with ~org-indent-mode~ turned off.
18456 #+vindex: org-startup-align-all-tables
18457 Aligns tables consistently upon visiting a file. The corresponding
18458 variable is ~org-startup-align-all-tables~ with ~nil~ as default
18467 Do not align tables on startup.
18469 #+vindex: org-startup-shrink-all-tables
18470 Shrink table columns with a width cookie. The corresponding
18471 variable is ~org-startup-shrink-all-tables~ with ~nil~ as default
18474 #+vindex: org-startup-with-inline-images
18475 When visiting a file, inline images can be automatically displayed.
18476 The corresponding variable is ~org-startup-with-inline-images~,
18477 with a default value ~nil~ to avoid delays when visiting a file.
18479 - =inlineimages= ::
18481 Show inline images.
18483 - =noinlineimages= ::
18485 Do not show inline images on startup.
18487 #+vindex: org-log-done
18488 #+vindex: org-log-note-clock-out
18489 #+vindex: org-log-repeat
18490 Logging the closing and reopening of TODO items and clock
18491 intervals can be configured using these options (see variables
18492 ~org-log-done~, ~org-log-note-clock-out~, and ~org-log-repeat~).
18496 Record a timestamp when an item is marked DONE.
18500 Record timestamp and a note when DONE.
18504 Do not record when items are marked DONE.
18508 Record a time when reinstating a repeating item.
18510 - =lognoterepeat= ::
18512 Record a note when reinstating a repeating item.
18516 Do not record when reinstating repeating item.
18518 - =lognoteclock-out= ::
18520 Record a note when clocking out.
18522 - =nolognoteclock-out= ::
18524 Do not record a note when clocking out.
18526 - =logreschedule= ::
18528 Record a timestamp when scheduling time changes.
18530 - =lognotereschedule= ::
18532 Record a note when scheduling time changes.
18534 - =nologreschedule= ::
18536 Do not record when a scheduling date changes.
18538 - =logredeadline= ::
18540 Record a timestamp when deadline changes.
18542 - =lognoteredeadline= ::
18544 Record a note when deadline changes.
18546 - =nologredeadline= ::
18548 Do not record when a deadline date changes.
18552 Record a timestamp when refiling.
18554 - =lognoterefile= ::
18556 Record a note when refiling.
18560 Do not record when refiling.
18562 #+vindex: org-hide-leading-stars
18563 #+vindex: org-odd-levels-only
18564 Here are the options for hiding leading stars in outline headings,
18565 and for indenting outlines. The corresponding variables are
18566 ~org-hide-leading-stars~ and ~org-odd-levels-only~, both with
18567 a default setting ~nil~ (meaning =showstars= and =oddeven=).
18571 Make all but one of the stars starting a headline invisible.
18575 Show all stars starting a headline.
18579 Virtual indentation according to outline level.
18583 No virtual indentation according to outline level.
18587 Allow only odd outline levels (1, 3, ...).
18591 Allow all outline levels.
18593 #+vindex: org-put-time-stamp-overlays
18594 #+vindex: org-time-stamp-overlay-formats
18595 To turn on custom format overlays over timestamps (variables
18596 ~org-put-time-stamp-overlays~ and ~org-time-stamp-overlay-formats~),
18601 Overlay custom time format.
18603 #+vindex: constants-unit-system
18604 The following options influence the table spreadsheet (variable
18605 ~constants-unit-system~).
18609 =constants.el= should use the c-g-s unit system.
18613 =constants.el= should use the SI unit system.
18615 #+vindex: org-footnote-define-inline
18616 #+vindex: org-footnote-auto-label
18617 #+vindex: org-footnote-auto-adjust
18618 To influence footnote settings, use the following keywords. The
18619 corresponding variables are ~org-footnote-define-inline~,
18620 ~org-footnote-auto-label~, and ~org-footnote-auto-adjust~.
18624 Define footnotes inline.
18628 Define footnotes in separate section.
18632 Define footnotes near first reference, but not inline.
18636 Prompt for footnote labels.
18640 Create =[fn:1]=-like labels automatically (default).
18644 Offer automatic label for editing or confirmation.
18648 Automatically renumber and sort footnotes.
18652 Do not renumber and sort automatically.
18654 #+vindex: org-hide-block-startup
18655 To hide blocks on startup, use these keywords. The corresponding
18656 variable is ~org-hide-block-startup~.
18660 Hide all begin/end blocks on startup.
18662 - =nohideblocks= ::
18664 Do not hide blocks on startup.
18666 #+vindex: org-pretty-entities
18667 The display of entities as UTF-8 characters is governed by the
18668 variable ~org-pretty-entities~ and the keywords
18670 - =entitiespretty= ::
18672 Show entities as UTF-8 characters where possible.
18674 - =entitiesplain= ::
18676 Leave entities plain.
18678 - =#+TAGS: TAG1(c1) TAG2(c2)= ::
18680 #+cindex: @samp{TAGS}, keyword
18681 #+vindex: org-tag-alist
18682 These lines (several such lines are allowed) specify the valid
18683 tags in this file, and (potentially) the corresponding /fast tag
18684 selection/ keys. The corresponding variable is ~org-tag-alist~.
18686 - =#+TODO:=, =#+SEQ_TODO:=, =#+TYP_TODO:= ::
18688 #+cindex: @samp{SEQ_TODO}, keyword
18689 #+cindex: @samp{TODO}, keyword
18690 #+cindex: @samp{TYP_TODO}, keyword
18691 #+vindex: org-todo-keywords
18692 These lines set the TODO keywords and their interpretation in the
18693 current file. The corresponding variable is ~org-todo-keywords~.
18695 ** The Very Busy {{{kbd(C-c C-c)}}} Key
18697 :DESCRIPTION: When in doubt, press @kbd{C-c C-c}.
18700 #+cindex: @kbd{C-c C-c}, overview
18702 The {{{kbd(C-c C-c)}}} key in Org serves many purposes depending on
18703 the context. It is probably the most over-worked, multi-purpose key
18704 combination in Org. Its uses are well documented throughout this
18705 manual, but here is a consolidated list for easy reference.
18707 - If any highlights shown in the buffer from the creation of a sparse
18708 tree, or from clock display, remove such highlights.
18710 - If the cursor is in one of the special =KEYWORD= lines, scan the
18711 buffer for these lines and update the information. Also reset the
18712 Org file cache used to temporary store the contents of URLs used as
18713 values for keywords like =SETUPFILE=.
18715 - If the cursor is inside a table, realign the table. The table
18716 realigns even if automatic table editor is turned off.
18718 - If the cursor is on a =TBLFM= keyword, re-apply the formulas to the
18721 - If the current buffer is a capture buffer, close the note and file
18722 it. With a prefix argument, also jump to the target location after
18725 - If the cursor is on a =<<<target>>>=, update radio targets and
18726 corresponding links in this buffer.
18728 - If the cursor is on a property line or at the start or end of
18729 a property drawer, offer property commands.
18731 - If the cursor is at a footnote reference, go to the corresponding
18732 definition, and /vice versa/.
18734 - If the cursor is on a statistics cookie, update it.
18736 - If the cursor is in a plain list item with a checkbox, toggle the
18737 status of the checkbox.
18739 - If the cursor is on a numbered item in a plain list, renumber the
18742 - If the cursor is on the =#+BEGIN= line of a dynamic block, the block
18745 - If the cursor is at a timestamp, fix the day name in the timestamp.
18747 ** A Cleaner Outline View
18749 :DESCRIPTION: Getting rid of leading stars in the outline.
18750 :ALT_TITLE: Clean View
18752 #+cindex: hiding leading stars
18753 #+cindex: dynamic indentation
18754 #+cindex: odd-levels-only outlines
18755 #+cindex: clean outline view
18757 Org's default outline with stars and no indents can become too
18758 cluttered for short documents. For /book-like/ long documents, the
18759 effect is not as noticeable. Org provides an alternate stars and
18760 indentation scheme, as shown on the right in the following table. It
18761 uses only one star and indents text to line with the heading:
18764 ,* Top level headline | * Top level headline
18765 ,** Second level | * Second level
18766 ,*** Third level | * Third level
18767 some text | some text
18768 ,*** Third level | * Third level
18769 more text | more text
18770 ,* Another top level headline | * Another top level headline
18773 #+texinfo: @noindent
18774 #+cindex: Indent mode
18775 #+findex: org-indent-mode
18776 To turn this mode on, use the minor mode, ~org-indent-mode~. Text
18777 lines that are not headlines are prefixed with spaces to vertically
18778 align with the headline text[fn:135].
18780 #+vindex: org-indent-indentation-per-level
18781 To make more horizontal space, the headlines are shifted by two stars.
18782 This can be configured by the ~org-indent-indentation-per-level~
18783 variable. Only one star on each headline is visible, the rest are
18784 masked with the same font color as the background.
18786 Note that turning on ~org-indent-mode~ sets ~org-hide-leading-stars~
18787 to ~t~ and ~org-adapt-indentation~ to ~nil~.
18789 #+vindex: org-startup-indented
18790 To globally turn on ~org-indent-mode~ for all files, customize the
18791 variable ~org-startup-indented~.
18793 To turn on indenting for individual files, use =STARTUP= keyword as
18796 : #+STARTUP: indent
18798 Indent on startup makes Org use hard spaces to align text with
18799 headings as shown in examples below.
18801 - /Indentation of text below headlines/ ::
18803 Indent text to align with the headline.
18807 more text, now indented
18810 #+vindex: org-adapt-indentation
18811 Org supports this with paragraph filling, line wrapping, and
18812 structure editing, preserving or adapting the indentation as
18813 appropriate[fn:136].
18815 - /Hiding leading stars/ ::
18817 #+vindex: org-hide-leading-stars
18818 Org can make leading stars invisible. For global preference,
18819 configure the variable ~org-hide-leading-stars~. For per-file
18820 preference, use these file =STARTUP= options:
18823 ,#+STARTUP: hidestars
18824 ,#+STARTUP: showstars
18827 With stars hidden, the tree is shown as:
18830 ,* Top level headline
18836 #+texinfo: @noindent
18837 #+vindex: org-hide, face
18838 Because Org makes the font color the same as the background color
18839 to hide to stars, sometimes ~org-hide~ face may need tweaking to
18840 get the effect right. For some black and white combinations,
18841 ~grey90~ on a white background might mask the stars better.
18845 #+vindex: org-odd-levels-only
18846 Using stars for only odd levels, 1, 3, 5, ..., can also clean up
18847 the clutter. This removes two stars from each level[fn:137].
18848 For Org to properly handle this cleaner structure during edits
18849 and exports, configure the variable ~org-odd-levels-only~. To
18850 set this per-file, use either one of the following lines:
18854 ,#+STARTUP: oddeven
18857 To switch between single and double stars layouts, use {{{kbd(M-x
18858 org-convert-to-odd-levels)}}} and {{{kbd(M-x
18859 org-convert-to-oddeven-levels)}}}.
18861 ** Using Org on a TTY
18863 :DESCRIPTION: Using Org on a tty.
18864 :ALT_TITLE: TTY Keys
18866 #+cindex: tty key bindings
18868 Org provides alternative key bindings for TTY and modern mobile
18869 devices that cannot handle cursor keys and complex modifier key
18870 chords. Some of these workarounds may be more cumbersome than
18871 necessary. Users should look into customizing these further based on
18872 their usage needs. For example, the normal {{{kbd(S-cursor)}}} for
18873 editing timestamp might be better with {{{kbd(C-c .)}}} chord.
18875 #+attr_texinfo: :columns 0.2 0.25 0.1 0.25
18876 | Default | Alternative 1 | Speed key | Alternative 2 |
18877 |----------------------+--------------------------+--------------+----------------------|
18878 | {{{kbd(S-TAB)}}} | {{{kbd(C-u TAB)}}} | {{{kbd(C)}}} | |
18879 | {{{kbd(M-LEFT)}}} | {{{kbd(C-c C-x l)}}} | {{{kbd(l)}}} | {{{kbd(Esc LEFT)}}} |
18880 | {{{kbd(M-S-LEFT)}}} | {{{kbd(C-c C-x L)}}} | {{{kbd(L)}}} | |
18881 | {{{kbd(M-RIGHT)}}} | {{{kbd(C-c C-x r)}}} | {{{kbd(r)}}} | {{{kbd(Esc RIGHT)}}} |
18882 | {{{kbd(M-S-RIGHT)}}} | {{{kbd(C-c C-x R)}}} | {{{kbd(R)}}} | |
18883 | {{{kbd(M-UP)}}} | {{{kbd(C-c C-x u)}}} | | {{{kbd(Esc UP)}}} |
18884 | {{{kbd(M-S-UP)}}} | {{{kbd(C-c C-x U)}}} | {{{kbd(U)}}} | |
18885 | {{{kbd(M-DOWN)}}} | {{{kbd(C-c C-x d)}}} | | {{{kbd(Esc DOWN)}}} |
18886 | {{{kbd(M-S-DOWN)}}} | {{{kbd(C-c C-x D)}}} | {{{kbd(D)}}} | |
18887 | {{{kbd(S-RET)}}} | {{{kbd(C-c C-x c)}}} | | |
18888 | {{{kbd(M-RET)}}} | {{{kbd(C-c C-x m)}}} | | {{{kbd(Esc RET)}}} |
18889 | {{{kbd(M-S-RET)}}} | {{{kbd(C-c C-x M)}}} | | |
18890 | {{{kbd(S-LEFT)}}} | {{{kbd(C-c LEFT)}}} | | |
18891 | {{{kbd(S-RIGHT)}}} | {{{kbd(C-c RIGHT)}}} | | |
18892 | {{{kbd(S-UP)}}} | {{{kbd(C-c UP)}}} | | |
18893 | {{{kbd(S-DOWN)}}} | {{{kbd(C-c DOWN)}}} | | |
18894 | {{{kbd(C-S-LEFT)}}} | {{{kbd(C-c C-x LEFT)}}} | | |
18895 | {{{kbd(C-S-RIGHT)}}} | {{{kbd(C-c C-x RIGHT)}}} | | |
18897 ** Interaction with Other Packages
18899 :DESCRIPTION: With other Emacs packages.
18900 :ALT_TITLE: Interaction
18902 #+cindex: packages, interaction with other
18904 Org's compatibility and the level of interaction with other Emacs
18905 packages are documented here.
18907 *** Packages that Org cooperates with
18909 :DESCRIPTION: Packages Org cooperates with.
18910 :ALT_TITLE: Cooperation
18913 - =calc.el= by Dave Gillespie ::
18914 #+cindex: @file{calc.el}
18916 Org uses the Calc package for implementing spreadsheet
18917 functionality in its tables (see [[*The spreadsheet]]). Org also
18918 uses Calc for embedded calculations. See [[info:calc:Embedded%20Mode][GNU Emacs Calc Manual]].
18920 - =constants.el= by Carsten Dominik ::
18921 #+cindex: @file{constants.el}
18922 #+vindex: org-table-formula-constants
18924 Org can use names for constants in formulas in tables. Org can
18925 also use calculation suffixes for units, such as =M= for =Mega=.
18926 For a standard collection of such constants, install the
18927 =constants= package. Install version 2.0 of this package,
18928 available at [[http://www.astro.uva.nl/~dominik/Tools]]. Org checks
18929 if the function ~constants-get~ has been autoloaded.
18930 Installation instructions are in the file =constants.el=.
18932 - =cdlatex.el= by Carsten Dominik ::
18933 #+cindex: @file{cdlatex.el}
18935 Org mode can make use of the CDLaTeX package to efficiently enter
18936 LaTeX fragments into Org files. See [[*Using CDLaTeX to enter
18939 - =imenu.el= by Ake Stenhoff and Lars Lindberg ::
18940 #+cindex: @file{imenu.el}
18942 Imenu creates dynamic menus based on an index of items in a file.
18943 Org mode supports Imenu menus. Enable it with a mode hook as
18946 #+begin_src emacs-lisp
18947 (add-hook 'org-mode-hook
18948 (lambda () (imenu-add-to-menubar "Imenu")))
18951 #+vindex: org-imenu-depth
18952 By default the index is two levels deep---you can modify the
18953 depth using the option ~org-imenu-depth~.
18955 - =speedbar.el= by Eric M. Ludlam ::
18956 #+cindex: @file{speedbar.el}
18958 Speedbar package creates a special Emacs frame for displaying
18959 files and index items in files. Org mode supports Speedbar;
18960 users can drill into Org files directly from the Speedbar. The
18961 {{{kbd(<)}}} in the Speedbar frame tweaks the agenda commands to
18962 that file or to a subtree.
18964 - =table.el= by Takaaki Ota ::
18965 #+cindex: table editor, @file{table.el}
18966 #+cindex: @file{table.el}
18968 Complex ASCII tables with automatic line wrapping, column- and
18969 row-spanning, and alignment can be created using the Emacs table
18970 package by Takaaki Ota. Org mode recognizes such tables and
18971 exports them properly. {{{kbd(C-c ')}}} to edit these tables in
18972 a special buffer, much like Org's code blocks. Because of
18973 interference with other Org mode functionality, Takaaki Ota
18974 tables cannot be edited directly in the Org buffer.
18976 - {{{kbd(C-c ')}}} (~org-edit-special~) ::
18979 #+findex: org-edit-special
18980 Edit a =table.el= table. Works when the cursor is in
18981 a =table.el= table.
18983 - {{{kbd(C-c ~​)}}} (~org-table-create-with-table.el~) ::
18986 #+findex: org-table-create-with-table.el
18987 Insert a =table.el= table. If there is already a table at
18988 point, this command converts it between the =table.el=
18989 format and the Org mode format. See the documentation
18990 string of the command ~org-convert-table~ for the
18991 restrictions under which this is possible.
18993 *** Packages that conflict with Org mode
18995 :DESCRIPTION: Packages that lead to conflicts.
18996 :ALT_TITLE: Conflicts
18999 #+cindex: shift-selection-mode
19000 #+vindex: org-support-shift-select
19001 In Emacs, ~shift-selection-mode~ combines cursor motions with shift
19002 key to enlarge regions. Emacs sets this mode by default. This
19003 conflicts with Org's use of {{{kbd(S-<cursor>)}}} commands to change
19004 timestamps, TODO keywords, priorities, and item bullet types, etc.
19005 Since {{{kbd(S-<cursor>)}}} commands outside of specific contexts do
19006 not do anything, Org offers the variable ~org-support-shift-select~
19007 for customization. Org mode accommodates shift selection by (i)
19008 making it available outside of the special contexts where special
19009 commands apply, and (ii) extending an existing active region even if
19010 the cursor moves across a special context.
19012 - =cua.el= by Kim. F. Storm ::
19014 #+cindex: @file{cua.el}
19015 #+vindex: org-replace-disputed-keys
19016 Org key bindings conflict with {{{kbd(S-cursor)}}} keys used by
19017 CUA mode. For Org to relinquish these bindings to CUA mode,
19018 configure the variable ~org-replace-disputed-keys~. When set,
19019 Org moves the following key bindings in Org files, and in the
19020 agenda buffer---but not during date selection.
19022 | S-UP \rArr{} M-p | S-DOWN \rArr{} M-n |
19023 | S-LEFT \rArr{} M-- | S-RIGHT \rArr{} M-+ |
19024 | C-S-LEFT \rArr{} M-S-- | C-S-RIGHT \rArr{} M-S-+ |
19026 #+vindex: org-disputed-keys
19027 Yes, these are unfortunately more difficult to remember. If you
19028 want to have other replacement keys, look at the variable
19029 ~org-disputed-keys~.
19031 - =ecomplete.el= by Lars Magne Ingebrigtsen ::
19033 #+cindex: @file{ecomplete.el}
19034 Ecomplete provides "electric" address completion in address
19035 header lines in message buffers. Sadly Orgtbl mode cuts
19036 Ecomplete's power supply: no completion happens when Orgtbl mode
19037 is enabled in message buffers while entering text in address
19038 header lines. If one wants to use ecomplete one should /not/
19039 follow the advice to automagically turn on Orgtbl mode in message
19040 buffers (see [[*The Orgtbl Minor Mode]]), but instead---after
19041 filling in the message headers---turn on Orgtbl mode manually
19042 when needed in the messages body.
19044 - =filladapt.el= by Kyle Jones ::
19046 #+cindex: @file{filladapt.el}
19047 Org mode tries to do the right thing when filling paragraphs,
19048 list items and other elements. Many users reported problems
19049 using both =filladapt.el= and Org mode, so a safe thing to do is
19050 to disable filladapt like this:
19052 #+begin_src emacs-lisp
19053 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
19056 - =viper.el= by Michael Kifer ::
19057 #+cindex: @file{viper.el}
19060 Viper uses {{{kbd(C-c /)}}} and therefore makes this key not
19061 access the corresponding Org mode command ~org-sparse-tree~. You
19062 need to find another key for this command, or override the key in
19063 ~viper-vi-global-user-map~ with
19065 #+begin_src emacs-lisp
19066 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
19069 - =windmove.el= by Hovav Shacham ::
19070 #+cindex: @file{windmove.el}
19072 This package also uses the {{{kbd(S-<cursor>)}}} keys, so
19073 everything written in the paragraph above about CUA mode also
19074 applies here. If you want to make the windmove function active
19075 in locations where Org mode does not have special functionality
19076 on {{{kbd(S-<cursor>)}}}, add this to your configuration:
19078 #+begin_src emacs-lisp
19079 ;; Make windmove work in Org mode:
19080 (add-hook 'org-shiftup-final-hook 'windmove-up)
19081 (add-hook 'org-shiftleft-final-hook 'windmove-left)
19082 (add-hook 'org-shiftdown-final-hook 'windmove-down)
19083 (add-hook 'org-shiftright-final-hook 'windmove-right)
19086 - =yasnippet.el= ::
19088 #+cindex: @file{yasnippet.el}
19089 The way Org mode binds the {{{kbd(TAB)}}} key (binding to ~[tab]~
19090 instead of ~"\t"~) overrules YASnippet's access to this key. The
19091 following code fixed this problem:
19093 #+begin_src emacs-lisp
19094 (add-hook 'org-mode-hook
19096 (setq-local yas/trigger-key [tab])
19097 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
19100 The latest version of YASnippet does not play well with Org mode.
19101 If the above code does not fix the conflict, start by defining
19102 the following function:
19104 #+begin_src emacs-lisp
19105 (defun yas/org-very-safe-expand ()
19106 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
19109 Then, tell Org mode to use that function:
19111 #+begin_src emacs-lisp
19112 (add-hook 'org-mode-hook
19114 (make-variable-buffer-local 'yas/trigger-key)
19115 (setq yas/trigger-key [tab])
19116 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
19117 (define-key yas/keymap [tab] 'yas/next-field)))
19122 :DESCRIPTION: Encrypting Org files.
19125 Org Crypt encrypts the text of an entry, but not the headline, or
19126 properties. Behind the scene, it uses the Emacs EasyPG library to
19127 encrypt and decrypt files.
19129 #+vindex: org-crypt-tag-matcher
19130 Any text below a headline that has a =crypt= tag is automatically
19131 encrypted when the file is saved. To use a different tag, customize
19132 the ~org-crypt-tag-matcher~ setting.
19134 Here is a suggestion for Org Crypt settings in Emacs init file:
19136 #+begin_src emacs-lisp
19137 (require 'org-crypt)
19138 (org-crypt-use-before-save-magic)
19139 (setq org-tags-exclude-from-inheritance '("crypt"))
19141 (setq org-crypt-key nil)
19142 ;; GPG key to use for encryption
19143 ;; Either the Key ID or set to nil to use symmetric encryption.
19145 (setq auto-save-default nil)
19146 ;; Auto-saving does not cooperate with org-crypt.el: so you need to
19147 ;; turn it off if you plan to use org-crypt.el quite often. Otherwise,
19148 ;; you'll get an (annoying) message each time you start Org.
19150 ;; To turn it off only locally, you can insert this:
19152 ;; # -*- buffer-auto-save-file-name: nil; -*-
19155 Excluding the =crypt= tag from inheritance prevents already encrypted
19156 text from being encrypted again.
19160 :DESCRIPTION: How to hack your way around.
19161 :APPENDIX: Appendix
19165 This appendix describes some ways a user can extend the functionality
19170 :DESCRIPTION: How to reach into Org's internals.
19174 Org has a large number of hook variables for adding functionality.
19175 This appendix illustrates using a few. A complete list of hooks with
19176 documentation is maintained by the Worg project at
19177 https://orgmode.org/worg/doc.html#hooks.
19181 :DESCRIPTION: Available extensions.
19183 #+cindex: add-on packages
19185 Various authors wrote a large number of add-on packages for Org.
19187 These packages are not part of Emacs, but they are distributed as
19188 contributed packages with the separate release available at
19189 https://orgmode.org. See the =contrib/README= file in the source code
19190 directory for a list of contributed files. Worg page with more
19191 information is at: https://orgmode.org/worg/org-contrib/.
19193 ** Adding Hyperlink Types
19195 :DESCRIPTION: New custom link types.
19197 #+cindex: hyperlinks, adding new types
19199 Org has many built-in hyperlink types (see [[*Hyperlinks]]), and an
19200 interface for adding new link types. The following example shows the
19201 process of adding Org links to Unix man pages, which look like this
19203 : [[man:printf][The printf manual]]
19205 #+texinfo: @noindent
19206 The following =org-man.el= file implements it
19208 #+begin_src emacs-lisp
19209 ;;; org-man.el - Support for links to man pages in Org mode
19212 (org-link-set-parameters "man"
19213 :follow org-man-command
19214 :export #'org-man-export
19215 :store #'org-man-store-link)
19217 (defcustom org-man-command 'man
19218 "The Emacs command to be used to display a man page."
19220 :type '(choice (const man) (const woman)))
19222 (defun org-man-store-link ()
19223 "Store a link to a man page."
19224 (when (memq major-mode '(Man-mode woman-mode))
19225 ;; This is a man page, we do make this link.
19226 (let* ((page (org-man-get-page-name))
19227 (link (concat "man:" page))
19228 (description (format "Man page for %s" page)))
19229 (org-store-link-props
19232 :description description))))
19234 (defun org-man-get-page-name ()
19235 "Extract the page name from the buffer name."
19236 ;; This works for both `Man-mode' and `woman-mode'.
19237 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
19238 (match-string 1 (buffer-name))
19239 (error "Cannot create link to this man page")))
19241 (defun org-man-export (link description format)
19242 "Export a man page link from Org files."
19243 (let ((path (format "http://man.he.net/?topic=%s§ion=all" link))
19244 (desc (or description link)))
19246 (`html (format "<a target=\"_blank\" href=\"%s\">%s</a>" path desc))
19247 (`latex (format "\\href{%s}{%s}" path desc))
19248 (`texinfo (format "@uref{%s,%s}" path desc))
19249 (`ascii (format "%s (%s)" desc path))
19253 ;;; org-man.el ends here
19256 #+texinfo: @noindent
19257 To activate links to man pages in Org, enter this in the Emacs init
19260 #+begin_src emacs-lisp
19264 #+texinfo: @noindent
19265 A review of =org-man.el=:
19267 1. First, ~(require 'org)~ ensures =org.el= is loaded.
19271 #+findex: org-link-set-parameters
19272 #+vindex: org-link-parameters
19273 Then ~org-link-set-parameters~ defines a new link type with =man=
19274 prefix and associates functions for following, exporting and
19275 storing such links. See the variable ~org-link-parameters~ for
19276 a complete list of possible associations.
19278 3. The rest of the file implements necessary variables and functions.
19280 For example, ~org-man-store-link~ is responsible for storing a link
19281 when ~org-store-link~ (see [[*Handling Links]]) is called from a buffer
19282 displaying a man page. It first checks if the ~major-mode~ is
19283 appropriate. If check fails, the function returns ~nil~, which
19284 means it isn't responsible for creating a link to the current
19285 buffer. Otherwise the function makes a link string by combining
19286 the =man:= prefix with the man topic. It also provides a default
19287 description. The function ~org-insert-link~ can insert it back
19288 into an Org buffer later on.
19290 ** Adding Export Back-ends
19292 :DESCRIPTION: How to write new export back-ends.
19294 #+cindex: Export, writing back-ends
19296 Org's export engine makes it easy for writing new back-ends. The
19297 framework on which the engine was built makes it easy to derive new
19298 back-ends from existing ones.
19300 #+findex: org-export-define-backend
19301 #+findex: org-export-define-derived-backend
19302 The two main entry points to the export engine are:
19303 ~org-export-define-backend~ and ~org-export-define-derived-backend~.
19304 To grok these functions, see =ox-latex.el= for an example of defining
19305 a new back-end from scratch, and =ox-beamer.el= for an example of
19306 deriving from an existing engine.
19308 For creating a new back-end from scratch, first set its name as
19309 a symbol in an alist consisting of elements and export functions. To
19310 make the back-end visible to the export dispatcher, set ~:menu-entry~
19311 keyword. For export options specific to this back-end, set the
19314 For creating a new back-end from an existing one, set
19315 ~:translate-alist~ to an alist of export functions. This alist
19316 replaces the parent back-end functions.
19318 For complete documentation, see [[https://orgmode.org/worg/dev/org-export-reference.html][the Org Export Reference on Worg]].
19320 ** Tables in Arbitrary Syntax
19322 :DESCRIPTION: Orgtbl for LaTeX and other programs.
19324 #+cindex: tables, in other modes
19325 #+cindex: lists, in other modes
19326 #+cindex: Orgtbl mode
19328 Due to Org's success in handling tables with Orgtbl, a frequently
19329 requested feature is the use of Org's table functions in other modes,
19330 e.g., LaTeX. This would be hard to do in a general way without
19331 complicated customization nightmares. Moreover, that would take Org
19332 away from its simplicity roots that Orgtbl has proven. There is,
19333 however, an alternate approach to accomplishing the same.
19335 This approach involves implementing a custom /translate/ function that
19336 operates on a native Org /source table/ to produce a table in another
19337 format. This strategy would keep the excellently working Orgtbl
19338 simple and isolate complications, if any, confined to the translate
19339 function. To add more alien table formats, we just add more translate
19340 functions. Also the burden of developing custom translate functions
19341 for new table formats is in the hands of those who know those formats
19346 :DESCRIPTION: Sending and receiving radio tables.
19348 #+cindex: radio tables
19350 Radio tables are target locations for translated tables that are not near
19351 their source. Org finds the target location and inserts the translated
19354 The key to finding the target location is the magic words =BEGIN/END
19355 RECEIVE ORGTBL=. They have to appear as comments in the current mode.
19356 If the mode is C, then:
19359 /* BEGIN RECEIVE ORGTBL table_name */
19360 /* END RECEIVE ORGTBL table_name */
19363 #+texinfo: @noindent
19364 At the location of source, Org needs a special line to direct Orgtbl
19365 to translate and to find the target for inserting the translated
19366 table. For example:
19368 #+cindex: @samp{ORGTBL}, keyword
19369 : #+ORGTBL: SEND table_name translation_function arguments ...
19371 #+texinfo: @noindent
19372 =table_name= is the table's reference name, which is also used in the
19373 receiver lines, and the =translation_function= is the Lisp function
19374 that translates. This line, in addition, may also contain alternating
19375 key and value arguments at the end. The translation function gets
19376 these values as a property list. A few standard parameters are
19377 already recognized and acted upon before the translation function is
19382 Skip the first N lines of the table. Hlines do count; include
19383 them if they are to be skipped.
19385 - =:skipcols (n1 n2 ...)= ::
19387 List of columns to be skipped. First Org automatically discards
19388 columns with calculation marks and then sends the table to the
19389 translator function, which then skips columns as specified in
19392 #+texinfo: @noindent
19393 To keep the source table intact in the buffer without being disturbed
19394 when the source file is compiled or otherwise being worked on, use one
19395 of these strategies:
19397 - Place the table in a block comment. For example, in C mode you
19398 could wrap the table between =/*= and =*/= lines.
19400 - Put the table after an "end" statement. For example ~\bye~ in TeX
19401 and ~\end{document}~ in LaTeX.
19403 - Comment and un-comment each line of the table during edits. The
19404 {{{kbd(M-x orgtbl-toggle-comment)}}} command makes toggling easy.
19406 *** A LaTeX example of radio tables
19408 :DESCRIPTION: Step by step, almost a tutorial.
19409 :ALT_TITLE: A LaTeX example
19411 #+cindex: @LaTeX{}, and Orgtbl mode
19413 To wrap a source table in LaTeX, use the =comment= environment
19414 provided by =comment.sty=[fn:138]. To activate it, put
19415 ~\usepackage{comment}~ in the document header. Orgtbl mode inserts
19416 a radio table skeleton[fn:137] with the command {{{kbd(M-x
19417 orgtbl-insert-radio-table)}}}, which prompts for a table name. For
19418 example, if =salesfigures= is the name, the template inserts:
19421 % BEGIN RECEIVE ORGTBL salesfigures
19422 % END RECEIVE ORGTBL salesfigures
19424 ,#+ORGTBL: SEND salesfigures orgtbl-to-latex
19429 #+vindex: LaTeX-verbatim-environments
19430 #+texinfo: @noindent
19431 The line =#+ORGTBL: SEND= tells Orgtbl mode to use the function
19432 ~orgtbl-to-latex~ to convert the table to LaTeX format, then insert
19433 the table at the target (receive) location named =salesfigures=. Now
19434 the table is ready for data entry. It can even use spreadsheet
19438 % BEGIN RECEIVE ORGTBL salesfigures
19439 % END RECEIVE ORGTBL salesfigures
19441 ,#+ORGTBL: SEND salesfigures orgtbl-to-latex
19442 | Month | Days | Nr sold | per day |
19443 |-------+------+---------+---------|
19444 | Jan | 23 | 55 | 2.4 |
19445 | Feb | 21 | 16 | 0.8 |
19446 | March | 22 | 278 | 12.6 |
19447 ,#+TBLFM: $4=$3/$2;%.1f
19448 % $ (optional extra dollar to keep Font Lock happy, see footnote)
19452 #+texinfo: @noindent
19453 After editing, {{{kbd(C-c C-c)}}} inserts the translated table at the
19454 target location, between the two marker lines.
19456 For hand-made custom tables, note that the translator needs to skip
19457 the first two lines of the source table. Also the command has to
19458 /splice/ out the target table without the header and footer.
19461 \begin{tabular}{lrrr}
19462 Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\
19463 % BEGIN RECEIVE ORGTBL salesfigures
19464 % END RECEIVE ORGTBL salesfigures
19468 ,#+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
19469 | Month | Days | Nr sold | per day |
19470 |-------+------+---------+---------|
19471 | Jan | 23 | 55 | 2.4 |
19472 | Feb | 21 | 16 | 0.8 |
19473 | March | 22 | 278 | 12.6 |
19474 ,#+TBLFM: $4=$3/$2;%.1f
19478 The LaTeX translator function ~orgtbl-to-latex~ is already part of
19479 Orgtbl mode and uses a =tabular= environment to typeset the table and
19480 marks horizontal lines with ~\hline~. For additional parameters to
19481 control output, see [[*Translator functions]]:
19483 - ~:splice nil/t~ ::
19485 When non-~nil~, return only table body lines; not wrapped in
19486 tabular environment. Default is ~nil~.
19490 Format to warp each field. It should contain =%s= for the
19491 original field value. For example, to wrap each field value in
19492 dollar symbol, you could use =:fmt "$%s$"=. Format can also wrap
19493 a property list with column numbers and formats, for example
19494 =:fmt (2 "$%s$" 4 "%s\\%%")=. In place of a string, a function
19495 of one argument can be used; the function must return a formatted
19500 Format numbers as exponentials. The spec should have =%s= twice
19501 for inserting mantissa and exponent, for example
19502 ="%s\\times10^{%s}"=. This may also be a property list with
19503 column numbers and formats, for example =:efmt (2
19504 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")=. After
19505 {{{var(EFMT)}}} has been applied to a value, {{{var(FMT)}}}---see
19506 above---is also be applied. Functions with two arguments can be
19507 supplied instead of strings. By default, no special formatting
19510 *** Translator functions
19512 :DESCRIPTION: Copy and modify.
19514 #+cindex: HTML, and Orgtbl mode
19515 #+cindex: translator function
19517 #+findex: orgtbl-to-csv
19518 #+findex: orgtbl-to-tsv
19519 #+findex: orgtbl-to-latex
19520 #+findex: orgtbl-to-html
19521 #+findex: orgtbl-to-texinfo
19522 #+findex: orgtbl-to-unicode
19523 #+findex: orgtbl-to-orgtbl
19524 #+findex: orgtbl-to-generic
19525 Orgtbl mode has built-in translator functions: ~orgtbl-to-csv~
19526 (comma-separated values), ~orgtbl-to-tsv~ (TAB-separated values),
19527 ~orgtbl-to-latex~, ~orgtbl-to-html~, ~orgtbl-to-texinfo~,
19528 ~orgtbl-to-unicode~ and ~orgtbl-to-orgtbl~. They use the generic
19529 translator, ~orgtbl-to-generic~, which delegates translations to
19530 various export back-ends.
19532 Properties passed to the function through the =ORGTBL SEND= line take
19533 precedence over properties defined inside the function. For example,
19534 this overrides the default LaTeX line endings, ~\\~, with ~\\[2mm]~:
19536 : #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
19538 For a new language translator, define a converter function. It can be
19539 a generic function, such as shown in this example. It marks
19540 a beginning and ending of a table with =!BTBL!= and =!ETBL!=;
19541 a beginning and ending of lines with =!BL!= and =!EL!=; and uses a TAB
19542 for a field separator:
19544 #+begin_src emacs-lisp
19545 (defun orgtbl-to-language (table params)
19546 "Convert the orgtbl-mode TABLE to language."
19549 (org-combine-plists
19550 '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
19554 #+texinfo: @noindent
19555 The documentation for the ~orgtbl-to-generic~ function shows
19556 a complete list of parameters, each of which can be passed through to
19557 ~orgtbl-to-latex~, ~orgtbl-to-texinfo~, and any other function using
19558 that generic function.
19560 For complicated translations the generic translator function could be
19561 replaced by a custom translator function. Such a custom function must
19562 take two arguments and return a single string containing the formatted
19563 table. The first argument is the table whose lines are a list of
19564 fields or the symbol ~hline~. The second argument is the property
19565 list consisting of parameters specified in the =#+ORGTBL: SEND= line.
19566 Please share your translator functions by posting them to the Org
19567 users mailing list, at mailto:emacs-orgmode@gnu.org.
19571 :DESCRIPTION: Automatically filled blocks.
19573 #+cindex: dynamic blocks
19575 Org supports /dynamic blocks/ in Org documents. They are inserted
19576 with begin and end markers like any other code block, but the contents
19577 are updated automatically by a user function. For example, {{{kbd(C-c
19578 C-x C-r)}}} inserts a dynamic table that updates the work time (see
19579 [[*Clocking Work Time]]).
19581 Dynamic blocks can have names and function parameters. The syntax is
19582 similar to source code block specifications:
19585 ,#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
19590 These commands update dynamic blocks:
19592 - {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) ::
19594 #+kindex: C-c C-x C-u
19595 #+findex: org-dblock-update
19596 Update dynamic block at point.
19598 - {{{kbd(C-u C-c C-x C-u)}}} ::
19600 #+kindex: C-u C-c C-x C-u
19601 Update all dynamic blocks in the current file.
19603 Before updating a dynamic block, Org removes content between the
19604 =BEGIN= and =END= markers. Org then reads the parameters on the
19605 =BEGIN= line for passing to the writer function. If the function
19606 expects to access the removed content, then Org expects an extra
19607 parameter, =:content=, on the =BEGIN= line.
19609 The syntax for naming a writer function with a dynamic block labelled
19610 =myblock= is: ~org-dblock-write:myblock~. Parameters come from the
19613 The following is an example of a dynamic block and a block writer function
19614 that updates the time when the function was last run:
19617 ,#+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
19622 #+texinfo: @noindent
19623 The dynamic block's writer function:
19625 #+begin_src emacs-lisp
19626 (defun org-dblock-write:block-update-time (params)
19627 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
19628 (insert "Last block update at: "
19629 (format-time-string fmt))))
19632 To keep dynamic blocks up-to-date in an Org file, use the function,
19633 ~org-update-all-dblocks~ in hook, such as ~before-save-hook~. The
19634 ~org-update-all-dblocks~ function does not run if the file is not in
19637 #+findex: org-narrow-to-block
19638 Dynamic blocks, like any other block, can be narrowed with
19639 ~org-narrow-to-block~.
19641 ** Special Agenda Views
19643 :DESCRIPTION: Customized views.
19645 #+cindex: agenda views, user-defined
19647 #+vindex: org-agenda-skip-function
19648 #+vindex: org-agenda-skip-function-global
19649 Org provides a special hook to further limit items in agenda views:
19650 ~agenda~, ~agenda*~[fn:140], ~todo~, ~alltodo~, ~tags~, ~tags-todo~,
19651 ~tags-tree~. Specify a custom function that tests inclusion of every
19652 matched item in the view. This function can also skip as much as is
19655 For a global condition applicable to agenda views, use the
19656 ~org-agenda-skip-function-global~ variable. Org uses a global
19657 condition with ~org-agenda-skip-function~ for custom searching.
19659 This example defines a function for a custom view showing TODO items
19660 with =waiting= status. Manually this is a multi-step search process,
19661 but with a custom view, this can be automated as follows:
19663 The custom function searches the subtree for the =waiting= tag and
19664 returns ~nil~ on match. Otherwise it gives the location from where
19665 the search continues.
19667 #+begin_src emacs-lisp
19668 (defun my-skip-unless-waiting ()
19669 "Skip trees that are not waiting"
19670 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
19671 (if (re-search-forward ":waiting:" subtree-end t)
19672 nil ; tag found, do not skip
19673 subtree-end))) ; tag not found, continue after end of subtree
19676 To use this custom function in a custom agenda command:
19678 #+begin_src emacs-lisp
19679 (org-add-agenda-custom-command
19680 '("b" todo "PROJECT"
19681 ((org-agenda-skip-function 'my-skip-unless-waiting)
19682 (org-agenda-overriding-header "Projects waiting for something: "))))
19685 #+vindex: org-agenda-overriding-header
19686 Note that this also binds ~org-agenda-overriding-header~ to a more
19687 meaningful string suitable for the agenda view.
19689 #+vindex: org-odd-levels-only
19690 #+vindex: org-agenda-skip-function
19691 Search for entries with a limit set on levels for the custom search.
19692 This is a general approach to creating custom searches in Org. To
19693 include all levels, use =LEVEL>0=[fn:141]. Then to selectively pick
19694 the matched entries, use ~org-agenda-skip-function~, which also
19695 accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and
19696 ~org-agenda-skip-subtree-if~. For example:
19698 - ~(org-agenda-skip-entry-if 'scheduled)~ ::
19700 Skip current entry if it has been scheduled.
19702 - ~(org-agenda-skip-entry-if 'notscheduled)~ ::
19704 Skip current entry if it has not been scheduled.
19706 - ~(org-agenda-skip-entry-if 'deadline)~ ::
19708 Skip current entry if it has a deadline.
19710 - ~(org-agenda-skip-entry-if 'scheduled 'deadline)~ ::
19712 Skip current entry if it has a deadline, or if it is scheduled.
19714 - ~(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))~ ::
19716 Skip current entry if the TODO keyword is TODO or WAITING.
19718 - ~(org-agenda-skip-entry-if 'todo 'done)~ ::
19720 Skip current entry if the TODO keyword marks a DONE state.
19722 - ~(org-agenda-skip-entry-if 'timestamp)~ ::
19724 Skip current entry if it has any timestamp, may also be deadline
19727 - ~(org-agenda-skip-entry-if 'regexp "regular expression")~ ::
19729 Skip current entry if the regular expression matches in the
19732 - ~(org-agenda-skip-entry-if 'notregexp "regular expression")~ ::
19734 Skip current entry unless the regular expression matches.
19736 - ~(org-agenda-skip-subtree-if 'regexp "regular expression")~ ::
19738 Same as above, but check and skip the entire subtree.
19740 The following is an example of a search for =waiting= without the
19743 #+begin_src emacs-lisp
19744 (org-add-agenda-custom-command
19745 '("b" todo "PROJECT"
19746 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
19747 'regexp ":waiting:"))
19748 (org-agenda-overriding-header "Projects waiting for something: "))))
19751 ** Speeding Up Your Agendas
19753 :DESCRIPTION: Tips on how to speed up your agendas.
19755 #+cindex: agenda views, optimization
19757 Some agenda commands slow down when the Org files grow in size or
19758 number. Here are tips to speed up:
19760 - Reduce the number of Org agenda files to avoid slowdowns due to hard drive
19763 - Reduce the number of DONE and archived headlines so agenda
19764 operations that skip over these can finish faster.
19766 - Do not dim blocked tasks:
19767 #+vindex: org-agenda-dim-blocked-tasks
19769 #+begin_src emacs-lisp
19770 (setq org-agenda-dim-blocked-tasks nil)
19773 - Stop preparing agenda buffers on startup:
19774 #+vindex: org-startup-folded
19775 #+vindex: org-agenda-inhibit-startup
19777 #+begin_src emacs-lisp
19778 (setq org-agenda-inhibit-startup nil)
19781 - Disable tag inheritance for agendas:
19782 #+vindex: org-agenda-show-inherited-tags
19783 #+vindex: org-agenda-use-tag-inheritance
19785 #+begin_src emacs-lisp
19786 (setq org-agenda-use-tag-inheritance nil)
19789 These options can be applied to selected agenda views. For more
19790 details about generation of agenda views, see the docstrings for the
19791 relevant variables, and this [[https://orgmode.org/worg/agenda-optimization.html][dedicated Worg page]] for agenda
19794 ** Extracting Agenda Information
19796 :DESCRIPTION: Post-processing agenda information.
19798 #+cindex: agenda, pipe
19799 #+cindex: scripts, for agenda processing
19801 Org provides commands to access agendas through Emacs batch mode.
19802 Through this command-line interface, agendas are automated for further
19803 processing or printing.
19805 #+vindex: org-agenda-custom-commands
19806 #+findex: org-batch-agenda
19807 ~org-batch-agenda~ creates an agenda view in ASCII and outputs to
19808 standard output. This command takes one string parameter. When
19809 string consists of a single character, Org uses it as a key to
19810 ~org-agenda-custom-commands~. These are the same ones available
19811 through the agenda dispatcher (see [[*The Agenda Dispatcher]]).
19813 This example command line directly prints the TODO list to the printer:
19815 : emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
19817 When the string parameter length is two or more characters, Org
19818 matches it with tags/TODO strings. For example, this example command
19819 line prints items tagged with =shop=, but excludes items tagged with
19823 emacs -batch -l ~/.emacs \
19824 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
19827 #+texinfo: @noindent
19828 An example showing on-the-fly parameter modifications:
19831 emacs -batch -l ~/.emacs \
19832 -eval '(org-batch-agenda "a" \
19833 org-agenda-span (quote month) \
19834 org-agenda-include-diary nil \
19835 org-agenda-files (quote ("~/org/project.org")))' \
19839 #+texinfo: @noindent
19840 which produces an agenda for the next 30 days from just the
19841 =~/org/projects.org= file.
19843 #+findex: org-batch-agenda-csv
19844 For structured processing of agenda output, use ~org-batch-agenda-csv~
19845 with the following fields:
19847 - category :: The category of the item
19848 - head :: The headline, without TODO keyword, TAGS and PRIORITY
19849 - type :: The type of the agenda entry, can be
19851 | ~todo~ | selected in TODO match |
19852 | ~tagsmatch~ | selected in tags match |
19853 | ~diary~ | imported from diary |
19854 | ~deadline~ | a deadline |
19855 | ~scheduled~ | scheduled |
19856 | ~timestamp~ | appointment, selected by timestamp |
19857 | ~closed~ | entry was closed on date |
19858 | ~upcoming-deadline~ | warning about nearing deadline |
19859 | ~past-scheduled~ | forwarded scheduled item |
19860 | ~block~ | entry has date block including date |
19862 - todo :: The TODO keyword, if any
19863 - tags :: All tags including inherited ones, separated by colons
19864 - date :: The relevant date, like =2007-2-14=
19865 - time :: The time, like =15:00-16:50=
19866 - extra :: String with extra planning info
19867 - priority-l :: The priority letter if any was given
19868 - priority-n :: The computed numerical priority
19870 #+texinfo: @noindent
19871 If the selection of the agenda item was based on a timestamp,
19872 including those items with =DEADLINE= and =SCHEDULED= keywords, then
19873 Org includes date and time in the output.
19875 If the selection of the agenda item was based on a timestamp (or
19876 deadline/scheduled), then Org includes date and time in the output.
19878 Here is an example of a post-processing script in Perl. It takes the
19879 CSV output from Emacs and prints with a checkbox:
19884 # define the Emacs command to run
19885 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
19887 # run it and capture the output
19888 $agenda = qx{$cmd 2>/dev/null};
19890 # loop over all lines
19891 foreach $line (split(/\n/,$agenda)) {
19892 # get the individual values
19893 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
19894 $priority_l,$priority_n) = split(/,/,$line);
19895 # process and print
19896 print "[ ] $head\n";
19900 ** Using the Property API
19902 :DESCRIPTION: Writing programs that use entry properties.
19904 #+cindex: API, for properties
19905 #+cindex: properties, API
19907 Here is a description of the functions that can be used to work with
19910 #+attr_texinfo: :options org-entry-properties &optional pom which
19912 Get all properties of the entry at point-or-marker {{{var(POM)}}}.
19913 This includes the TODO keyword, the tags, time strings for deadline,
19914 scheduled, and clocking, and any additional properties defined in the
19915 entry. The return value is an alist. Keys may occur multiple times
19916 if the property key was used several times. {{{var(POM)}}} may also
19917 be ~nil~, in which case the current entry is used. If
19918 {{{var(WHICH)}}} is ~nil~ or ~all~, get all properties. If
19919 {{{var(WHICH)}}} is ~special~ or ~standard~, only get that subclass.
19922 #+vindex: org-use-property-inheritance
19923 #+findex: org-insert-property-drawer
19924 #+attr_texinfo: :options org-entry-get pom property &optional inherit
19926 Get value of {{{var(PROPERTY)}}} for entry at point-or-marker
19927 {{{var(POM)}}}. By default, this only looks at properties defined
19928 locally in the entry. If {{{var(INHERIT)}}} is non-~nil~ and the
19929 entry does not have the property, then also check higher levels of the
19930 hierarchy. If {{{var(INHERIT)}}} is the symbol ~selective~, use
19931 inheritance if and only if the setting of
19932 ~org-use-property-inheritance~ selects {{{var(PROPERTY)}}} for
19936 #+attr_texinfo: :options org-entry-delete pom property
19938 Delete the property {{{var(PROPERTY)}}} from entry at point-or-marker
19942 #+attr_texinfo: :options org-entry-put pom property value
19944 Set {{{var(PROPERTY)}}} to {{{var(VALUES)}}} for entry at
19945 point-or-marker POM.
19948 #+attr_texinfo: :options org-buffer-property-keys &optional include-specials
19950 Get all property keys in the current buffer.
19953 #+attr_texinfo: :options org-insert-property-drawer
19955 Insert a property drawer for the current entry. Also
19958 #+attr_texinfo: :options org-entry-put-multivalued-property pom property &rest values
19960 Set {{{var(PROPERTY)}}} at point-or-marker {{{var(POM)}}} to
19961 {{{var(VALUES)}}}. {{{var(VALUES)}}} should be a list of strings.
19962 They are concatenated, with spaces as separators.
19965 #+attr_texinfo: :options org-entry-get-multivalued-property pom property
19967 Treat the value of the property {{{var(PROPERTY)}}} as
19968 a whitespace-separated list of values and return the values as a list
19972 #+attr_texinfo: :options org-entry-add-to-multivalued-property pom property value
19974 Treat the value of the property {{{var(PROPERTY)}}} as
19975 a whitespace-separated list of values and make sure that
19976 {{{var(VALUE)}}} is in this list.
19979 #+attr_texinfo: :options org-entry-remove-from-multivalued-property pom property value
19981 Treat the value of the property {{{var(PROPERTY)}}} as
19982 a whitespace-separated list of values and make sure that
19983 {{{var(VALUE)}}} is /not/ in this list.
19986 #+attr_texinfo: :options org-entry-member-in-multivalued-property pom property value
19988 Treat the value of the property {{{var(PROPERTY)}}} as
19989 a whitespace-separated list of values and check if {{{var(VALUE)}}} is
19993 #+attr_texinfo: :options org-property-allowed-value-functions
19995 Hook for functions supplying allowed values for a specific property.
19996 The functions must take a single argument, the name of the property,
19997 and return a flat list of allowed values. If =:ETC= is one of the
19998 values, use the values as completion help, but allow also other values
19999 to be entered. The functions must return ~nil~ if they are not
20000 responsible for this property.
20003 ** Using the Mapping API
20005 :DESCRIPTION: Mapping over all or selected entries.
20007 #+cindex: API, for mapping
20008 #+cindex: mapping entries, API
20010 Org has sophisticated mapping capabilities to find all entries
20011 satisfying certain criteria. Internally, this functionality is used
20012 to produce agenda views, but there is also an API that can be used to
20013 execute arbitrary functions for each or selected entries. The main
20014 entry point for this API is:
20016 #+attr_texinfo: :options org-map-entries func &optional match scope &rest skip
20018 Call {{{(var(FUNC))}}} at each headline selected by {{{var(MATCH)}}}
20019 in {{{var(SCOPE)}}}.
20021 {{{var(FUNC)}}} is a function or a Lisp form. With the cursor
20022 positioned at the beginning of the headline, call the function without
20023 arguments. Org returns an alist of return values of calls to the
20026 To avoid preserving point, Org wraps the call to {{{var(FUNC)}}} in
20027 save-excursion form. After evaluation, Org moves the cursor to the
20028 end of the line that was just processed. Search continues from that
20029 point forward. This may not always work as expected under some
20030 conditions, such as if the current sub-tree was removed by a previous
20031 archiving operation. In such rare circumstances, Org skips the next
20032 entry entirely when it should not. To stop Org from such skips, make
20033 {{{var(FUNC)}}} set the variable ~org-map-continue-from~ to a specific
20036 {{{var(MATCH)}}} is a tags/property/TODO match. Org iterates only
20037 matched headlines. Org iterates over all headlines when
20038 {{{var(MATCH)}}} is ~nil~ or ~t~.
20040 {{{var(SCOPE)}}} determines the scope of this command. It can be any
20045 The current buffer, respecting the restriction, if any.
20049 The subtree started with the entry at point.
20053 The entries within the active region, if any.
20057 The current buffer, without restriction.
20059 - ~file-with-archives~ ::
20061 The current buffer, and any archives associated with it.
20067 - ~agenda-with-archives~ ::
20069 All agenda files with any archive files associated with them.
20071 - ~(file1 file2 ...)~ ::
20073 If this is a list, all files in the list are scanned.
20075 #+texinfo: @noindent
20076 The remaining arguments are treated as settings for the scanner's
20077 skipping facilities. Valid arguments are:
20081 Skip trees with the archive tag.
20085 Skip trees with the COMMENT keyword.
20087 - function or Lisp form ::
20089 #+vindex: org-agenda-skip-function
20090 Used as value for ~org-agenda-skip-function~, so whenever the
20091 function returns ~t~, {{{var(FUNC)}}} is called for that entry
20092 and search continues from the point where the function leaves it.
20095 The mapping routine can call any arbitrary function, even functions
20096 that change meta data or query the property API (see [[*Using the
20097 Property API]]). Here are some handy functions:
20099 #+attr_texinfo: :options org-todo &optional arg
20101 Change the TODO state of the entry. See the docstring of the
20102 functions for the many possible values for the argument
20106 #+attr_texinfo: :options org-priority &optional action
20108 Change the priority of the entry. See the docstring of this function
20109 for the possible values for {{{var(ACTION)}}}.
20112 #+attr_texinfo: :options org-toggle-tag tag &optional onoff
20114 Toggle the tag {{{var(TAG)}}} in the current entry. Setting
20115 {{{var(ONOFF)}}} to either ~on~ or ~off~ does not toggle tag, but
20116 ensure that it is either on or off.
20119 #+attr_texinfo: :options org-promote
20121 Promote the current entry.
20124 #+attr_texinfo: :options org-demote
20126 Demote the current entry.
20129 This example turns all entries tagged with =TOMORROW= into TODO
20130 entries with keyword =UPCOMING=. Org ignores entries in comment trees
20133 #+begin_src emacs-lisp
20134 (org-map-entries '(org-todo "UPCOMING")
20135 "+TOMORROW" 'file 'archive 'comment)
20138 The following example counts the number of entries with TODO keyword
20139 =WAITING=, in all agenda files.
20141 #+begin_src emacs-lisp
20142 (length (org-map-entries t "/+WAITING" 'agenda))
20147 :DESCRIPTION: Viewing and capture on a mobile device.
20148 :APPENDIX: Appendix
20151 #+cindex: smartphone
20153 #+cindex: MobileOrg
20155 MobileOrg is a companion mobile app that runs on iOS and Android
20156 devices. MobileOrg enables offline-views and capture support for an
20157 Org mode system that is rooted on a "real" computer. MobileOrg can
20158 record changes to existing entries.
20160 The [[https://github.com/MobileOrg/][iOS implementation]] for the /iPhone/iPod Touch/iPad/ series of
20161 devices, was started by Richard Moreland and is now in the hands of
20162 Sean Escriva. Android users should check out [[http://wiki.github.com/matburt/mobileorg-android/][MobileOrg Android]] by
20163 Matt Jones. Though the two implementations are not identical, they
20164 offer similar features.
20166 This appendix describes Org's support for agenda view formats
20167 compatible with MobileOrg. It also describes synchronizing changes,
20168 such as to notes, between MobileOrg and the computer.
20170 To change tags and TODO states in MobileOrg, first customize the
20171 variables ~org-todo-keywords~ and ~org-tag-alist~. These should cover
20172 all the important tags and TODO keywords, even if Org files use only
20173 some of them. Though MobileOrg has in-buffer settings, it understands
20174 TODO states /sets/ (see [[*Setting up keywords for individual files]]) and
20175 /mutually exclusive/ tags (see [[*Setting Tags]]) only for those set in
20178 ** Setting Up the Staging Area
20180 :DESCRIPTION: For the mobile device.
20183 MobileOrg needs access to a file directory on a server to interact
20184 with Emacs. With a public server, consider encrypting the files.
20185 MobileOrg version 1.5 supports encryption for the iPhone. Org also
20186 requires =openssl= installed on the local computer. To turn on
20187 encryption, set the same password in MobileOrg and in Emacs. Set the
20188 password in the variable ~org-mobile-use-encryption~[fn:142]. Note
20189 that even after MobileOrg encrypts the file contents, the file name
20190 remains visible on the file systems of the local computer, the server,
20191 and the mobile device.
20193 For a server to host files, consider options like [[http://dropbox.com][Dropbox.com]]
20194 account[fn:143]. On first connection, MobileOrg creates a directory
20195 =MobileOrg= on Dropbox. Pass its location to Emacs through an
20196 initialisation file variable as follows:
20198 #+begin_src emacs-lisp
20199 (setq org-mobile-directory "~/Dropbox/MobileOrg")
20202 Org copies files to the above directory for MobileOrg. Org also uses
20203 the same directory for sharing notes between Org and MobileOrg.
20205 ** Pushing to MobileOrg
20207 :DESCRIPTION: Uploading Org files and agendas.
20210 #+vindex: org-mobile-files
20211 #+vindex: org-directory
20212 Org pushes files listed in ~org-mobile-files~ to
20213 ~org-mobile-directory~. Files include agenda files (as listed in
20214 ~org-agenda-files~). Customize ~org-mobile-files~ to add other files.
20215 File names are staged with paths relative to ~org-directory~, so all
20216 files should be inside this directory[fn:144].
20218 Push creates a special Org file =agendas.org= with custom agenda views
20219 defined by the user[fn:145].
20221 Finally, Org writes the file =index.org=, containing links to other
20222 files. MobileOrg reads this file first from the server to determine
20223 what other files to download for agendas. For faster downloads,
20224 MobileOrg only reads files whose checksums[fn:146] have changed.
20226 ** Pulling from MobileOrg
20228 :DESCRIPTION: Integrating captured and flagged items.
20231 When MobileOrg synchronizes with the server, it pulls the Org files
20232 for viewing. It then appends to the file =mobileorg.org= on the
20233 server the captured entries, pointers to flagged and changed entries.
20234 Org integrates its data in an inbox file format.
20237 #+vindex: org-mobile-inbox-for-pull
20238 Org moves all entries found in =mobileorg.org=[fn:147] and appends
20239 them to the file pointed to by the variable
20240 ~org-mobile-inbox-for-pull~. Each captured entry and each editing
20241 event is a top-level entry in the inbox file.
20243 2. After moving the entries, Org attempts changes to MobileOrg. Some
20244 changes are applied directly and without user interaction.
20245 Examples include changes to tags, TODO state, headline and body
20246 text. Entries for further action are tagged as =FLAGGED=. Org
20247 marks entries with problems with an error message in the inbox.
20248 They have to be resolved manually.
20250 3. Org generates an agenda view for flagged entries for user
20251 intervention to clean up. For notes stored in flagged entries,
20252 MobileOrg displays them in the echo area when the cursor is on the
20253 corresponding agenda item.
20258 Pressing {{{kbd(?)}}} displays the entire flagged note in
20259 another window. Org also pushes it to the kill ring. To
20260 store flagged note as a normal note, use {{{kbd(? z C-y C-c
20261 C-c)}}}. Pressing{{{kbd(?)}}} twice does these things: first
20262 it removes the =FLAGGED= tag; second, it removes the flagged
20263 note from the property drawer; third, it signals that manual
20264 editing of the flagged entry is now finished.
20266 #+kindex: ? @r{(Agenda dispatcher)}
20267 From the agenda dispatcher, {{{kbd(?)}}} returns to the view to finish
20268 processing flagged entries. Note that these entries may not be the
20269 most recent since MobileOrg searches files that were last pulled. To
20270 get an updated agenda view with changes since the last pull, pull
20273 * History and Acknowledgments
20275 :DESCRIPTION: How Org came into being.
20284 Org was born in 2003, out of frustration over the user interface of
20285 the Emacs Outline mode. I was trying to organize my notes and
20286 projects, and using Emacs seemed to be the natural way to go.
20287 However, having to remember eleven different commands with two or
20288 three keys per command, only to hide and show parts of the outline
20289 tree, that seemed entirely unacceptable to me. Also, when using
20290 outlines to take notes, I constantly wanted to restructure the tree,
20291 organizing it parallel to my thoughts and plans. /Visibility cycling/
20292 and /structure editing/ were originally implemented in the package
20293 =outline-magic.el=, but quickly moved to the more general =org.el=.
20294 As this environment became comfortable for project planning, the next
20295 step was adding /TODO entries/, basic /timestamps/, and /table
20296 support/. These areas highlighted the two main goals that Org still
20297 has today: to be a new, outline-based, plain text mode with innovative
20298 and intuitive editing features, and to incorporate project planning
20299 functionality directly into a notes file.
20301 Since the first release, literally thousands of emails to me or to the
20302 [[mailto:emacs-orgmode@gnu.org][mailing list]] have provided a constant stream of bug reports, feedback,
20303 new ideas, and sometimes patches and add-on code. Many thanks to
20304 everyone who has helped to improve this package. I am trying to keep
20305 here a list of the people who had significant influence in shaping one
20306 or more aspects of Org. The list may not be complete, if I have
20307 forgotten someone, please accept my apologies and let me know.
20309 Before I get to this list, a few special mentions are in order:
20311 - Bastien Guerry ::
20313 Bastien has written a large number of extensions to Org (most of
20314 them integrated into the core by now), including the LaTeX
20315 exporter and the plain list parser. His support during the early
20316 days was central to the success of this project. Bastien also
20317 invented Worg, helped establishing the Web presence of Org, and
20318 sponsored hosting costs for the orgmode.org website. Bastien
20319 stepped in as maintainer of Org between 2011 and 2013, at a time
20320 when I desperately needed a break.
20322 - Eric Schulte and Dan Davison ::
20324 Eric and Dan are jointly responsible for the Org Babel system,
20325 which turns Org into a multi-language environment for evaluating
20326 code and doing literate programming and reproducible research.
20327 This has become one of Org's killer features that define what Org
20332 John has contributed a number of great ideas and patches directly
20333 to Org, including the attachment system (=org-attach.el=),
20334 integration with Apple Mail (=org-mac-message.el=), hierarchical
20335 dependencies of TODO items, habit tracking (=org-habits.el=), and
20336 encryption (=org-crypt.el=). Also, the capture system is really
20337 an extended copy of his great =remember.el=.
20339 - Sebastian Rose ::
20341 Without Sebastian, the HTML/XHTML publishing of Org would be the
20342 pitiful work of an ignorant amateur. Sebastian has pushed this
20343 part of Org onto a much higher level. He also wrote
20344 =org-info.js=, a Java script for displaying webpages derived from
20345 Org using an Info-like or a folding interface with single-key
20348 #+texinfo: @noindent
20349 See below for the full list of contributions! Again, please let me
20350 know what I am missing here!
20357 I (Bastien) have been maintaining Org between 2011 and 2013. This
20358 appendix would not be complete without adding a few more
20359 acknowledgments and thanks.
20361 I am first grateful to Carsten for his trust while handing me over the
20362 maintainership of Org. His unremitting support is what really helped
20363 me getting more confident over time, with both the community and the
20366 When I took over maintainership, I knew I would have to make Org more
20367 collaborative than ever, as I would have to rely on people that are
20368 more knowledgeable than I am on many parts of the code. Here is
20369 a list of the persons I could rely on, they should really be
20370 considered co-maintainers, either of the code or the community:
20374 Eric is maintaining the Babel parts of Org. His reactivity here
20375 kept me away from worrying about possible bugs here and let me
20376 focus on other parts.
20378 - Nicolas Goaziou ::
20380 Nicolas is maintaining the consistency of the deepest parts of
20381 Org. His work on =org-element.el= and =ox.el= has been
20382 outstanding, and it opened the doors for many new ideas and
20383 features. He rewrote many of the old exporters to use the new
20384 export engine, and helped with documenting this major change.
20385 More importantly (if that's possible), he has been more than
20386 reliable during all the work done for Org 8.0, and always very
20387 reactive on the mailing list.
20391 Achim rewrote the building process of Org, turning some /ad hoc/
20392 tools into a flexible and conceptually clean process. He
20393 patiently coped with the many hiccups that such a change can
20398 The Org mode mailing list would not be such a nice place without
20399 Nick, who patiently helped users so many times. It is impossible
20400 to overestimate such a great help, and the list would not be so
20401 active without him.
20403 I received support from so many users that it is clearly impossible to
20404 be fair when shortlisting a few of them, but Org's history would not
20405 be complete if the ones above were not mentioned in this manual.
20407 ** List of Contributions
20412 - Russel Adams came up with the idea for drawers.
20414 - Thomas Baumann wrote =org-bbdb.el= and =org-mhe.el=.
20416 - Christophe Bataillon created the great unicorn logo that we use on
20417 the Org mode website.
20419 - Alex Bochannek provided a patch for rounding timestamps.
20421 - Jan Böcker wrote =org-docview.el=.
20423 - Brad Bozarth showed how to pull RSS feed data into Org files.
20425 - Tom Breton wrote =org-choose.el=.
20427 - Charles Cave's suggestion sparked the implementation of templates
20428 for Remember, which are now templates for capture.
20430 - Pavel Chalmoviansky influenced the agenda treatment of items with
20433 - Gregory Chernov patched support for Lisp forms into table
20434 calculations and improved XEmacs compatibility, in particular by
20435 porting =nouline.el= to XEmacs.
20437 - Sacha Chua suggested copying some linking code from Planner.
20439 - Baoqiu Cui contributed the DocBook exporter.
20441 - Eddward DeVilla proposed and tested checkbox statistics. He also
20442 came up with the idea of properties, and that there should be an API
20445 - Nick Dokos tracked down several nasty bugs.
20447 - Kees Dullemond used to edit projects lists directly in HTML and so
20448 inspired some of the early development, including HTML export. He
20449 also asked for a way to narrow wide table columns.
20451 - Thomas S. Dye contributed documentation on Worg and helped
20452 integrating the Org Babel documentation into the manual.
20454 - Christian Egli converted the documentation into Texinfo format,
20455 inspired the agenda, patched CSS formatting into the HTML exporter,
20456 and wrote =org-taskjuggler.el=.
20458 - David Emery provided a patch for custom CSS support in exported HTML
20461 - Nic Ferrier contributed mailcap and XOXO support.
20463 - Miguel A. Figueroa-Villanueva implemented hierarchical checkboxes.
20465 - John Foerch figured out how to make incremental search show context
20466 around a match in a hidden outline tree.
20468 - Raimar Finken wrote =org-git-line.el=.
20470 - Mikael Fornius works as a mailing list moderator.
20472 - Austin Frank works as a mailing list moderator.
20474 - Eric Fraga drove the development of Beamer export with ideas and
20477 - Barry Gidden did proofreading the manual in preparation for the book
20478 publication through Network Theory Ltd.
20480 - Niels Giesen had the idea to automatically archive DONE trees.
20482 - Nicolas Goaziou rewrote much of the plain list code.
20484 - Kai Grossjohann pointed out key-binding conflicts with other
20487 - Brian Gough of Network Theory Ltd publishes the Org mode manual as
20490 - Bernt Hansen has driven much of the support for auto-repeating
20491 tasks, task state change logging, and the clocktable. His clear
20492 explanations have been critical when we started to adopt the Git
20493 version control system.
20495 - Manuel Hermenegildo has contributed various ideas, small fixes and
20498 - Phil Jackson wrote =org-irc.el=.
20500 - Scott Jaderholm proposed footnotes, control over whitespace between
20501 folded entries, and column view for properties.
20503 - Matt Jones wrote MobileOrg Android.
20505 - Tokuya Kameshima wrote =org-wl.el= and =org-mew.el=.
20507 - Shidai Liu ("Leo") asked for embedded LaTeX and tested it. He also
20508 provided frequent feedback and some patches.
20510 - Matt Lundin has proposed last-row references for table formulas and
20511 named invisible anchors. He has also worked a lot on the FAQ.
20513 - David Maus wrote =org-atom.el=, maintains the issues file for Org,
20514 and is a prolific contributor on the mailing list with competent
20515 replies, small fixes and patches.
20517 - Jason F. McBrayer suggested agenda export to CSV format.
20519 - Max Mikhanosha came up with the idea of refiling.
20521 - Dmitri Minaev sent a patch to set priority limits on a per-file
20524 - Stefan Monnier provided a patch to keep the Emacs Lisp compiler
20527 - Richard Moreland wrote MobileOrg for the iPhone.
20529 - Rick Moynihan proposed allowing multiple TODO sequences in a file
20530 and being able to quickly restrict the agenda to a subtree.
20532 - Todd Neal provided patches for links to Info files and Elisp forms.
20534 - Greg Newman refreshed the unicorn logo into its current form.
20536 - Tim O'Callaghan suggested in-file links, search options for general
20537 file links, and tags.
20539 - Osamu Okano wrote =orgcard2ref.pl=, a Perl program to create a text
20540 version of the reference card.
20542 - Takeshi Okano translated the manual and David O'Toole's tutorial
20545 - Oliver Oppitz suggested multi-state TODO items.
20547 - Scott Otterson sparked the introduction of descriptive text for
20548 links, among other things.
20550 - Pete Phillips helped during the development of the TAGS feature,
20551 and provided frequent feedback.
20553 - Martin Pohlack provided the code snippet to bundle character
20554 insertion into bundles of 20 for undo.
20556 - T.V. Raman reported bugs and suggested improvements.
20558 - Matthias Rempe (Oelde) provided ideas, Windows support, and quality
20561 - Paul Rivier provided the basic implementation of named footnotes.
20562 He also acted as mailing list moderator for some time.
20564 - Kevin Rogers contributed code to access VM files on remote hosts.
20566 - Frank Ruell solved the mystery of the =keymapp nil= bug, a conflict
20569 - Jason Riedy generalized the send-receive mechanism for Orgtbl
20570 tables with extensive patches.
20572 - Philip Rooke created the Org reference card, provided lots of
20573 feedback, developed and applied standards to the Org documentation.
20575 - Christian Schlauer proposed angular brackets around links, among
20578 - Paul Sexton wrote =org-ctags.el=.
20580 - Tom Shannon's =organizer-mode.el= inspired linking to VM/BBDB/Gnus.
20582 - Ilya Shlyakhter proposed the Archive Sibling, line numbering in
20583 literal examples, and remote highlighting for referenced code lines.
20585 - Stathis Sideris wrote the =ditaa.jar= ASCII to PNG converter that is
20586 now packaged into Org's =contrib/= directory.
20588 - Daniel Sinder came up with the idea of internal archiving by locking
20591 - Dale Smith proposed link abbreviations.
20593 - James TD Smith has contributed a large number of patches for
20594 useful tweaks and features.
20596 - Adam Spiers asked for global linking commands, inspired the link
20597 extension system, added support for Mairix, and proposed the mapping
20600 - Ulf Stegemann created the table to translate special symbols to
20601 HTML, LaTeX, UTF-8, Latin-1 and ASCII.
20603 - Andy Stewart contributed code to =org-w3m.el=, to copy
20604 HTML content with links transformation to Org syntax.
20606 - David O'Toole wrote =org-publish.el= and drafted the
20607 manual chapter about publishing.
20609 - Jambunathan K. contributed the ODT exporter.
20611 - Sebastien Vauban reported many issues with LaTeX and Beamer export
20612 and enabled source code highlighting in Gnus.
20614 - Stefan Vollmar organized a video-recorded talk at the
20615 Max-Planck-Institute for Neurology. He also inspired the creation
20616 of a concept index for HTML export.
20618 - Jürgen Vollmer contributed code generating the table of contents in
20621 - Samuel Wales has provided important feedback and bug reports.
20623 - Chris Wallace provided a patch implementing the =QUOTE= block.
20625 - David Wainberg suggested archiving, and improvements to the
20628 - Carsten Wimmer suggested some changes and helped fix a bug in
20631 - Roland Winkler requested additional key bindings to make Org work on
20634 - Piotr Zielinski wrote =org-mouse.el=, proposed agenda
20635 blocks and contributed various ideas and code snippets.
20637 * GNU Free Documentation License
20640 :DESCRIPTION: The license for this documentation.
20643 #+texinfo: @include ../doc/doclicense.texi
20648 :DESCRIPTION: An index of Org's concepts and features.
20653 :DESCRIPTION: Key bindings and where they are described.
20657 * Command and Function Index
20659 :DESCRIPTION: Command names and some internal functions.
20665 :DESCRIPTION: Variables mentioned in the manual.
20669 This is not a complete index of variables and faces, only the ones
20670 that are mentioned in the manual. For a more complete list, use
20671 {{{kbd(M-x org-customize)}}} and then click yourself through the tree.
20678 This manual is for Org version {{{version}}}.
20680 Copyright \copy 2004--2018 Free Software Foundation, Inc.
20683 Permission is granted to copy, distribute and/or modify this document
20684 under the terms of the GNU Free Documentation License, Version 1.3 or
20685 any later version published by the Free Software Foundation; with no
20686 Invariant Sections, with the Front-Cover texts being "A GNU Manual",
20687 and with the Back-Cover Texts as in (a) below. A copy of the license
20688 is included in the section entitled "GNU Free Documentation License".
20690 (a) The FSF's Back-Cover Text is: "You have the freedom to copy and
20691 modify this GNU manual."
20694 * Export Setup :noexport:
20696 #+subtitle: Release {{{version}}}
20697 #+author: by Carsten Dominik
20698 #+subauthor: with contributions by Bastien Guerry, Nicolas Goaziou, Eric Schulte, Jambunathan K, Dan Davison, Thomas Dye, David O'Toole, and Philip Rooke.
20699 #+date: {{{modification-time}}}
20700 #+email: tsd@tsdye.com
20703 # XXX: We cannot use TODO keyword as a node starts with "TODO".
20704 #+todo: REVIEW FIXME | DONE
20705 #+property: header-args :eval no
20706 #+startup: overview nologdone
20708 #+export_file_name: org.texi
20710 #+texinfo_dir_category: Emacs editing modes
20711 #+texinfo_dir_title: Org Mode: (org)
20712 #+texinfo_dir_desc: Outline-based notes management and organizer
20714 # Use proper quote and backtick for code sections in PDF output
20715 # Cf. Texinfo manual 14.2
20716 #+texinfo_header: @set txicodequoteundirected
20717 #+texinfo_header: @set txicodequotebacktick
20720 #+texinfo_header: @set MAINTAINERSITE @uref{https://orgmode.org,maintainers webpage}
20721 #+texinfo_header: @set MAINTAINER Carsten Dominik
20722 #+texinfo_header: @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20723 #+texinfo_header: @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
20725 #+options: H:4 num:t toc:t author:t \n:nil ::t |:t ^:nil -:t f:t *:t <:t e:t ':t
20726 #+options: d:nil todo:nil pri:nil tags:not-in-toc stat:nil broken-links:mark
20727 #+select_tags: export
20728 #+exclude_tags: noexport
20730 #+macro: cite @@texinfo:@cite{@@$1@@texinfo:}@@
20731 #+macro: var @@texinfo:@var{@@$1@@texinfo:}@@
20733 # The "version" macro returns major.minor version number. This is
20734 # sufficient since bugfix releases are not expected to add features
20735 # and therefore imply manual modifications.
20736 #+macro: version (eval (mapconcat #'identity (cl-subseq (split-string (org-version) "\\.") 0 -1) "."))
20738 # The "kbd" macro turns KBD into @kbd{KBD}. Additionnally, it
20739 # encloses case-sensitive special keys (SPC, RET...) within @key{...}.
20740 #+macro: kbd (eval (let ((case-fold-search nil) (regexp (regexp-opt '("SPC" "RET" "LFD" "TAB" "BS" "ESC" "DELETE" "SHIFT" "CTRL" "META" "UP" "LEFT" "RIGHT" "DOWN") 'words))) (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (replace-regexp-in-string regexp "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t))))
20744 [fn:1] If you do not use Font Lock globally turn it on in Org buffer
20745 with ~(add-hook 'org-mode-hook 'turn-on-font-lock)~.
20747 [fn:2] Please consider subscribing to the mailing list in order to
20748 minimize the work the mailing list moderators have to do.
20750 [fn:3] See the variables ~org-special-ctrl-a/e~, ~org-special-ctrl-k~,
20751 and ~org-ctrl-k-protect-subtree~ to configure special behavior of
20752 {{{kbd(C-a)}}}, {{{kbd(C-e)}}}, and {{{kbd(C-k)}}} in headlines. Note
20753 also that clocking only works with headings indented less than 30
20756 [fn:4] See, however, the option ~org-cycle-emulate-tab~.
20758 [fn:5] The indirect buffer contains the entire buffer, but is narrowed
20759 to the current tree. Editing the indirect buffer also changes the
20760 original buffer, but without affecting visibility in that buffer. For
20761 more information about indirect buffers, see [[info:emacs:Indirect%20Buffers][GNU Emacs Manual]].
20763 [fn:6] When ~org-agenda-inhibit-startup~ is non-~nil~, Org does not
20764 honor the default visibility state when first opening a file for the
20765 agenda (see [[*Speeding Up Your Agendas]]).
20767 [fn:7] See also the variable ~org-show-context-detail~ to decide how
20768 much context is shown around each match.
20770 [fn:8] This depends on the option ~org-remove-highlights-with-change~.
20772 [fn:9] When using =*= as a bullet, lines must be indented so that they
20773 are not interpreted as headlines. Also, when you are hiding leading
20774 stars to get a clean outline view, plain list items starting with
20775 a star may be hard to distinguish from true headlines. In short: even
20776 though =*= is supported, it may be better to not use it for plain list
20779 [fn:10] You can filter out any of them by configuring
20780 ~org-plain-list-ordered-item-terminator~.
20782 [fn:11] You can also get =a.=, =A.=, =a)= and =A)= by configuring
20783 ~org-list-allow-alphabetical~. To minimize confusion with normal
20784 text, those are limited to one character only. Beyond that limit,
20785 bullets automatically become numbers.
20787 [fn:12] If there's a checkbox in the item, the cookie must be put
20788 /before/ the checkbox. If you have activated alphabetical lists, you
20789 can also use counters like =[@b]=.
20791 [fn:13] If you do not want the item to be split, customize the
20792 variable ~org-M-RET-may-split-line~.
20794 [fn:14] If you want to cycle around items that way, you may customize
20795 ~org-list-use-circular-motion~.
20797 [fn:15] See ~org-list-use-circular-motion~ for a cyclic behavior.
20799 [fn:16] Many desktops intercept {{{kbd(M-TAB)}}} to switch windows.
20800 Use {{{kbd(C-M-i)}}} or {{{kbd(ESC TAB)}}} instead.
20802 [fn:17] The corresponding in-buffer setting is: =#+STARTUP: fninline=
20803 or =#+STARTUP: nofninline=.
20805 [fn:18] The corresponding in-buffer options are =#+STARTUP: fnadjust=
20806 and =#+STARTUP: nofnadjust=.
20808 [fn:19] To insert a vertical bar into a table field, use =\vert= or,
20809 inside a word =abc\vert{}def=.
20811 [fn:20] Org understands references typed by the user as =B4=, but it
20812 does not use this syntax when offering a formula for editing. You can
20813 customize this behavior using the variable
20814 ~org-table-use-standard-references~.
20816 [fn:21] The computation time scales as O(N^2) because table
20817 {{{var(FOO)}}} is parsed for each field to be copied.
20819 [fn:22] The file =constants.el= can supply the values of constants in
20820 two different unit systems, =SI= and =cgs=. Which one is used depends
20821 on the value of the variable ~constants-unit-system~. You can use the
20822 =STARTUP= options =constSI= and =constcgs= to set this value for the
20825 [fn:23] The printf reformatting is limited in precision because the
20826 value passed to it is converted into an "integer" or "double". The
20827 "integer" is limited in size by truncating the signed value to 32
20828 bits. The "double" is limited in precision to 64 bits overall which
20829 leaves approximately 16 significant decimal digits.
20831 [fn:24] Such names must start with an alphabetic character and use
20832 only alphanumeric/underscore characters.
20834 [fn:25] To insert a link targeting a headline, in-buffer completion
20835 can be used. Just type a star followed by a few optional letters into
20836 the buffer and press {{{kbd(M-TAB)}}}. All headlines in the current
20837 buffer are offered as completions.
20839 [fn:26] When targeting a =NAME= keyword, =CAPTION= keyword is
20840 mandatory in order to get proper numbering (see [[*Images and Tables]]).
20842 [fn:27] The actual behavior of the search depends on the value of the
20843 variable ~org-link-search-must-match-exact-headline~. If its value is
20844 ~nil~, then a fuzzy text search is done. If it is ~t~, then only the
20845 exact headline is matched, ignoring spaces and statistic cookies. If
20846 the value is ~query-to-create~, then an exact headline is searched; if
20847 it is not found, then the user is queried to create it.
20849 [fn:28] If the headline contains a timestamp, it is removed from the
20850 link, which results in a wrong link---you should avoid putting
20851 a timestamp in the headline.
20853 [fn:29] The Org Id library must first be loaded, either through
20854 ~org-customize~, by enabling ~id~ in ~org-modules~, or by adding
20855 ~(require 'org-id)~ in your Emacs init file.
20857 [fn:30] Note that you do not have to use this command to insert
20858 a link. Links in Org are plain text, and you can type or paste them
20859 straight into the buffer. By using this command, the links are
20860 automatically enclosed in double brackets, and you will be asked for
20861 the optional descriptive text.
20863 [fn:31] After insertion of a stored link, the link will be removed
20864 from the list of stored links. To keep it in the list later use, use
20865 a triple {{{kbd(C-u)}}} prefix argument to {{{kbd(C-c C-l)}}}, or
20866 configure the option ~org-keep-stored-link-after-insertion~.
20868 [fn:32] This works if a function has been defined in the ~:complete~
20869 property of a link in ~org-link-parameters~.
20871 [fn:33] See the variable ~org-display-internal-link-with-indirect-buffer~.
20873 [fn:34] The variable ~org-startup-with-inline-images~ can be set
20874 within a buffer with the =STARTUP= options =inlineimages= and
20877 [fn:35] For backward compatibility, line numbers can also follow a
20880 [fn:36] Of course, you can make a document that contains only long
20881 lists of TODO items, but this is not required.
20883 [fn:37] Changing the variable ~org-todo-keywords~ only becomes
20884 effective after restarting Org mode in a buffer.
20886 [fn:38] This is also true for the {{{kbd(t)}}} command in the timeline
20887 and agenda buffers.
20889 [fn:39] All characters are allowed except =@=, =^= and =!=, which have
20890 a special meaning here.
20892 [fn:40] Check also the variable ~org-fast-tag-selection-include-todo~,
20893 it allows you to change the TODO state through the tags interface
20894 ([[*Setting Tags]]), in case you like to mingle the two concepts. Note
20895 that this means you need to come up with unique keys across both sets
20898 [fn:41] Org mode parses these lines only when Org mode is activated
20899 after visiting a file. {{{kbd(C-c C-c)}}} with the cursor in a line
20900 starting with =#+= is simply restarting Org mode for the current
20903 [fn:42] The corresponding in-buffer setting is: =#+STARTUP: logdone=.
20905 [fn:43] The corresponding in-buffer setting is: =#+STARTUP:
20908 [fn:44] See the variable ~org-log-states-order-reversed~.
20910 [fn:45] Note that the =LOGBOOK= drawer is unfolded when pressing
20911 {{{kbd(SPC)}}} in the agenda to show an entry---use {{{kbd(C-u
20912 SPC)}}} to keep it folded here.
20914 [fn:46] It is possible that Org mode records two timestamps when you
20915 are using both ~org-log-done~ and state change logging. However, it
20916 never prompts for two notes: if you have configured both, the state
20917 change recording note takes precedence and cancel the closing note.
20919 [fn:47] See also the option ~org-priority-start-cycle-with-default~.
20921 [fn:48] To keep subtasks out of the global TODO list, see the
20922 ~org-agenda-todo-list-sublevels~.
20924 [fn:49] With the exception of description lists. But you can allow it
20925 by modifying ~org-list-automatic-rules~ accordingly.
20927 [fn:50] Set the variable ~org-hierarchical-checkbox-statistics~ if you
20928 want such cookies to count all checkboxes below the cookie, not just
20929 those belonging to direct children.
20931 [fn:51] {{{kbd(C-u C-c C-c)}}} on the /first/ item of a list with no
20932 checkbox adds checkboxes to the rest of the list.
20934 [fn:52] As with all these in-buffer settings, pressing {{{kbd(C-c
20935 C-c)}}} activates any changes in the line.
20937 [fn:53] This is only true if the search does not involve more complex
20938 tests including properties (see [[*Property Searches]]).
20940 [fn:54] Keys are automatically assigned to tags that have no
20943 [fn:55] If more than one summary type applies to the same property,
20944 the parent values are computed according to the first of them.
20946 [fn:56] An age is defined as a duration, using effort modifiers
20947 defined in ~org-effort-durations~, e.g., =3d 1h=. If any value in the
20948 column is as such, the summary is also an effort duration.
20950 [fn:57] Please note that the =COLUMNS= definition must be on a single
20951 line; it is wrapped here only because of formatting constraints.
20953 [fn:58] Contributed packages are not part of Emacs, but are
20954 distributed with the main distribution of Org---visit
20955 [[https://orgmode.org]].
20957 [fn:59] The Org date format is inspired by the standard ISO 8601
20958 date/time format. To use an alternative format, see [[*Custom time
20959 format]]. The day name is optional when you type the date yourself.
20960 However, any date inserted or modified by Org adds that day name, for
20961 reading convenience.
20963 [fn:60] When working with the standard diary sexp functions, you need
20964 to be very careful with the order of the arguments. That order
20965 depends evilly on the variable ~calendar-date-style~. For example, to
20966 specify a date December 12, 2005, the call might look like
20967 =(diary-date 12 1 2005)= or =(diary-date 1 12 2005)= or =(diary-date
20968 2005 12 1)=, depending on the settings. This has been the source of
20969 much confusion. Org mode users can resort to special versions of
20970 these functions like ~org-date~ or ~org-anniversary~. These work just
20971 like the corresponding ~diary-~ functions, but with stable ISO order
20972 of arguments (year, month, day) wherever applicable, independent of
20973 the value of ~calendar-date-style~.
20975 [fn:61] See the variable ~org-read-date-prefer-future~. You may set
20976 that variable to the symbol ~time~ to even make a time before now
20977 shift the date to tomorrow.
20979 [fn:62] If you do not need/want the calendar, configure the variable
20980 ~org-popup-calendar-for-date-prompt~.
20982 [fn:63] If you find this distracting, turn off the display with
20983 ~org-read-date-display-live~.
20985 [fn:64] It will still be listed on that date after it has been marked
20986 DONE. If you do not like this, set the variable
20987 ~org-agenda-skip-scheduled-if-done~.
20989 [fn:65] The =SCHEDULED= and =DEADLINE= dates are inserted on the line
20990 right below the headline. Do not put any text between this line and
20993 [fn:66] Note the corresponding =STARTUP= options =logredeadline=,
20994 =lognoteredeadline=, and =nologredeadline=.
20996 [fn:67] Note the corresponding =STARTUP= options =logreschedule=,
20997 =lognotereschedule=, and =nologreschedule=.
20999 [fn:68] In fact, the target state is taken from, in this sequence, the
21000 =REPEAT_TO_STATE= property, the variable ~org-todo-repeat-to-state~ if
21001 it is a string, the previous TODO state if ~org-todo-repeat-to-state~
21002 is ~t~, or the first state of the TODO state sequence.
21004 [fn:69] You can change this using the option ~org-log-repeat~, or the
21005 =STARTUP= options =logrepeat=, =lognoterepeat=, and =nologrepeat=.
21006 With =lognoterepeat=, you will also be prompted for a note.
21008 [fn:70] Clocking only works if all headings are indented with less
21009 than 30 stars. This is a hard-coded limitation of ~lmax~ in
21012 [fn:71] To resume the clock under the assumption that you have worked
21013 on this task while outside Emacs, use ~(setq org-clock-persist t)~.
21015 [fn:72] To add an effort estimate "on the fly", hook a function doing
21016 this to ~org-clock-in-prepare-hook~.
21018 [fn:73] The last reset of the task is recorded by the =LAST_REPEAT=
21021 [fn:74] See also the variable ~org-clock-modeline-total~.
21023 [fn:75] The corresponding in-buffer setting is: =#+STARTUP:
21026 [fn:76] Language terms can be set through the variable
21027 ~org-clock-clocktable-language-setup~.
21029 [fn:77] Note that all parameters must be specified in a single
21030 line---the line is broken here only to fit it into the manual.
21032 [fn:78] On computers using macOS, idleness is based on actual user
21033 idleness, not just Emacs' idle time. For X11, you can install
21034 a utility program =x11idle.c=, available in the =contrib/scripts/=
21035 directory of the Org Git distribution, or install the xprintidle
21036 package and set it to the variable ~org-clock-x11idle-program-name~ if
21037 you are running Debian, to get the same general treatment of idleness.
21038 On other systems, idle time refers to Emacs idle time only.
21040 [fn:79] Please note the pitfalls of summing hierarchical data in
21041 a flat list ([[*Using Column View in the Agenda]]).
21043 [fn:80] Org used to offer four different targets for date/week tree
21044 capture. Now, Org automatically translates these to use
21045 ~file+olp+datetree~, applying the ~:time-prompt~ and ~:tree-type~
21046 properties. Please rewrite your date/week-tree targets using
21047 ~file+olp+datetree~ since the older targets are now deprecated.
21049 [fn:81] A date tree is an outline structure with years on the highest
21050 level, months or ISO weeks as sublevels and then dates on the lowest
21051 level. Tags are allowed in the tree structure.
21053 [fn:82] If you need one of these sequences literally, escape the =%=
21056 [fn:83] If you define your own link types (see [[*Adding Hyperlink
21057 Types]]), any property you store with ~org-store-link-props~ can be
21058 accessed in capture templates in a similar way.
21060 [fn:84] This is always the other, not the user. See the variable
21061 ~org-from-is-user-regexp~.
21063 [fn:85] If you move entries or Org files from one directory to
21064 another, you may want to configure ~org-attach-directory~ to contain
21067 [fn:86] Note the corresponding =STARTUP= options =logrefile=,
21068 =lognoterefile=, and =nologrefile=.
21070 [fn:87] If the value of that variable is not a list, but a single file
21071 name, then the list of agenda files in maintained in that external
21074 [fn:88] When using the dispatcher, pressing {{{kbd(<)}}} before
21075 selecting a command actually limits the command to the current file,
21076 and ignores ~org-agenda-files~ until the next dispatcher command.
21078 [fn:89] For backward compatibility, you can also press {{{kbd(1)}}} to
21079 restrict to the current buffer.
21081 [fn:90] For backward compatibility, you can also press {{{kbd(0)}}} to
21082 restrict to the current region/subtree.
21084 [fn:91] For backward compatibility, the universal prefix argument
21085 {{{kbd(C-u)}}} causes all TODO entries to be listed before the agenda.
21086 This feature is deprecated, use the dedicated TODO list, or a block
21087 agenda instead (see [[*Block agenda]]).
21089 [fn:92] The variable ~org-anniversary~ used in the example is just
21090 like ~diary-anniversary~, but the argument order is always according
21091 to ISO and therefore independent of the value of
21092 ~calendar-date-style~.
21094 [fn:93] Custom commands can preset a filter by binding the variable
21095 ~org-agenda-tag-filter-preset~ as an option. This filter is then
21096 applied to the view and persists as a basic filter through refreshes
21097 and more secondary filtering. The filter is a global property of the
21098 entire agenda view---in a block agenda, you should only set this in
21099 the global options section, not in the section of an individual block.
21101 [fn:94] Only tags filtering is respected here, effort filtering is
21104 [fn:95] You can also create persistent custom functions through
21105 ~org-agenda-bulk-custom-functions~.
21107 [fn:96] This file is parsed for the agenda when
21108 ~org-agenda-include-diary~ is set.
21110 [fn:97] You can provide a description for a prefix key by inserting
21111 a cons cell with the prefix and the description.
21113 [fn:98] /Planned/ means here that these entries have some planning
21114 information attached to them, like a time-stamp, a scheduled or
21115 a deadline string. See ~org-agenda-entry-types~ on how to set what
21116 planning information is taken into account.
21118 [fn:99] For HTML you need to install Hrvoje Niksic's =htmlize.el=
21119 from [[https://github.com/hniksic/emacs-htmlize][Hrvoje Niksic's repository]].
21121 [fn:100] To create PDF output, the Ghostscript ps2pdf utility must be
21122 installed on the system. Selecting a PDF file also creates the
21125 [fn:101] If you want to store standard views like the weekly agenda or
21126 the global TODO list as well, you need to define custom commands for
21127 them in order to be able to specify file names.
21129 [fn:102] Quoting depends on the system you use, please check the FAQ
21132 [fn:103] This works automatically for the HTML backend (it requires
21133 version 1.34 of the =htmlize.el= package, which you need to install).
21134 Fontified code chunks in LaTeX can be achieved using either the
21135 listings package or the [[https://github.com/gpoore/minted][minted]] package. Refer to
21136 ~org-export-latex-listings~ for details.
21138 [fn:104] Source code in code blocks may also be evaluated either
21139 interactively or on export. See [[*Working with Source Code]] for more
21140 information on evaluating code blocks.
21142 [fn:105] Adding =-k= to =-n -r= /keeps/ the labels in the source code
21143 while using line numbers for the links, which might be useful to
21144 explain those in an Org mode example code.
21146 [fn:106] Upon exit, lines starting with =*=, =,*=, =#+= and =,#+= get
21147 a comma prepended, to keep them from being interpreted by Org as
21148 outline nodes or special syntax. These commas are stripped when
21149 editing with {{{kbd(C-c ')}}}, and also before export.
21151 [fn:107] You may select a different-mode with the variable
21152 ~org-edit-fixed-width-region-mode~.
21154 [fn:108] You can turn this on by default by setting the variable
21155 ~org-pretty-entities~, or on a per-file base with the =STARTUP= option
21158 [fn:109] This behaviour can be disabled with =-= export setting (see
21159 [[*Export Settings]]).
21161 [fn:110] LaTeX is a macro system based on Donald\nbsp{}E.\nbsp{}Knuth's TeX
21162 system. Many of the features described here as "LaTeX" are really
21163 from TeX, but for simplicity I am blurring this distinction.
21165 [fn:111] When MathJax is used, only the environments recognized by
21166 MathJax are processed. When dvipng, dvisvgm, or ImageMagick suite is
21167 used to create images, any LaTeX environment is handled.
21169 [fn:112] These are respectively available at
21170 [[http://sourceforge.net/projects/dvipng/]], [[http://dvisvgm.bplaced.net/]]
21171 and from the ImageMagick suite. Choose the converter by setting the
21172 variable ~org-preview-latex-default-process~ accordingly.
21174 [fn:113] Org mode has a method to test if the cursor is inside such
21175 a fragment, see the documentation of the function
21176 ~org-inside-LaTeX-fragment-p~.
21178 [fn:114] The variable ~org-export-date-timestamp-format~ defines how
21179 this timestamp are exported.
21181 [fn:115] At the moment, some export back-ends do not obey this
21182 specification. For example, LaTeX export excludes every unnumbered
21183 headline from the table of contents.
21185 [fn:116] Since commas separate the arguments, commas within arguments
21186 have to be escaped with the backslash character. So only those
21187 backslash characters before a comma need escaping with another
21188 backslash character.
21190 [fn:117] For a less drastic behavior, consider using a select tag (see
21191 [[*Export Settings]]) instead.
21193 [fn:118] If =BEAMER_ENV= is set, Org export adds =B_environment= tag
21194 to make it visible. The tag serves as a visual aid and has no
21195 semantic relevance.
21197 [fn:119] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by
21198 [[http://www.mathjax.org][MathJax]].
21200 [fn:120] See [[http://docs.mathjax.org/en/latest/tex.html#tex-extensions][TeX and LaTeX extensions]] in the [[http://docs.mathjax.org][MathJax manual]] to learn
21203 [fn:121] If the classes on TODO keywords and tags lead to conflicts,
21204 use the variables ~org-html-todo-kwd-class-prefix~ and
21205 ~org-html-tag-class-prefix~ to make them unique.
21207 [fn:122] This does not allow setting different bibliography compilers
21208 for different files. However, "smart" LaTeX compilation systems, such
21209 as latexmk, can select the correct bibliography compiler.
21211 [fn:123] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications
21212 (OpenDocument) Version 1.2]].
21214 [fn:124] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]].
21216 [fn:125] See [[http://dlmf.nist.gov/LaTeXML/]].
21218 [fn:126] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]]
21220 [fn:127] See the =<table:table-template>= element of the
21221 OpenDocument-v1.2 specification.
21223 [fn:128] See the attributes =table:template-name=,
21224 =table:use-first-row-styles=, =table:use-last-row-styles=,
21225 =table:use-first-column-styles=, =table:use-last-column-styles=,
21226 =table:use-banding-rows-styles=, and =table:use-banding-column-styles=
21227 of the =<table:table>= element in the OpenDocument-v1.2 specification.
21229 [fn:129] If the publishing directory is the same as the source
21230 directory, =file.org= is exported as =file.org.org=, so you probably
21231 do not want to do this.
21233 [fn:130] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used
21234 to remove code evaluation from the {{{kbd(C-c C-c)}}} key binding.
21236 [fn:131] Actually, the constructs =call_<name>()= and =src_<lang>{}=
21237 are not evaluated when they appear in a keyword line---i.e. lines
21238 starting with =#+KEYWORD:=, see [[*Summary of In-Buffer Settings]].
21240 [fn:132] For Noweb literate programming details, see
21241 http://www.cs.tufts.edu/~nr/noweb/.
21243 [fn:133] For more information, please refer to the commentary section
21246 [fn:134] Note that ~org-indent-mode~ also sets the ~wrap-prefix~
21247 property, such that ~visual-line-mode~ (or purely setting ~word-wrap~)
21248 wraps long lines (including headlines) correctly indented.
21250 [fn:135] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly
21251 for indenting and wrapping long lines of headlines or text. This
21252 minor mode handles ~visual-line-mode~ and directly applied settings
21253 through ~word-wrap~.
21255 [fn:136] Also see the variable ~org-adapt-indentation~.
21257 [fn:137] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 4 stars, and so
21260 [fn:138] https://ctan.org/tex-archive/macros/latex/contrib/comment?lang=en
21262 [fn:139] If the =TBLFM= keyword contains an odd number of dollar
21263 characters, this may cause problems with Font Lock in LaTeX mode. As
21264 shown in the example you can fix this by adding an extra line inside
21265 the =comment= environment that is used to balance the dollar
21266 expressions. If you are using AUCTeX with the font-latex library,
21267 a much better solution is to add the =comment= environment to the
21268 variable ~LaTeX-verbatim-environments~.
21270 [fn:140] The ~agenda*~ view is the same as ~agenda~ except that it
21271 only considers /appointments/, i.e., scheduled and deadline items that
21272 have a time specification =[h]h:mm= in their time-stamps.
21274 [fn:141] Note that, for ~org-odd-levels-only~, a level number
21275 corresponds to order in the hierarchy, not to the number of stars.
21277 [fn:142] If Emacs is configured for safe storing of passwords, then
21278 configure the variable, ~org-mobile-encryption-password~; please read
21279 the docstring of that variable.
21281 [fn:143] An alternative is to use a WebDAV server. MobileOrg
21282 documentation has details of WebDAV server configuration. Additional
21283 help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]].
21285 [fn:144] Symbolic links in ~org-directory~ need to have the same name
21288 [fn:145] While creating the agendas, Org mode forces ID properties on
21289 all referenced entries, so that these entries can be uniquely
21290 identified if MobileOrg flags them for further action. To avoid
21291 setting properties configure the variable
21292 ~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode then relies
21293 on outline paths, assuming they are unique.
21295 [fn:146] Checksums are stored automatically in the file
21298 [fn:147] The file will be empty after this operation.