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 markup language. It
19 also is an authoring system with unique support for literate
20 programming and 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 make 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
143 Note that in this case, ~make autoloads~ is mandatory: it defines
144 Org's version in =org-version.el= and Org's autoloads in
147 Remember to add the correct load-path as described in the method
150 You can also compile with =make=, generate the documentation with
151 =make doc=, create a local configuration with =make config= and
152 install Org with =make install=. Please run =make help= to get the
153 list of compilation/installation options.
155 For more detailed explanations on Org's build system, please check the
156 Org Build System page on [[https://orgmode.org/worg/dev/org-build-system.html][Worg]].
160 :DESCRIPTION: How to activate Org for certain buffers.
165 #+cindex: global key bindings
166 #+cindex: key bindings, global
168 Org mode buffers need Font Lock to be turned on: this is the default
171 There are compatibility issues between Org mode and some other Elisp
172 packages (see [[*Packages that conflict with Org mode]]). Please take the
173 time to check the list.
176 #+findex: org-capture
177 #+findex: org-store-link
178 For a better experience, the three Org commands ~org-store-link~,
179 ~org-capture~ and ~org-agenda~ ought to be accessible anywhere in
180 Emacs, not just in Org buffers. To that effect, you need to bind them
181 to globally available keys, like the ones reserved for users (see
182 [[info:elisp::Key%20Binding%20Conventions]]). Here are suggested
183 bindings, please modify the keys to your own liking.
185 #+begin_src emacs-lisp
186 (global-set-key "\C-cl" 'org-store-link)
187 (global-set-key "\C-ca" 'org-agenda)
188 (global-set-key "\C-cc" 'org-capture)
191 #+cindex: Org mode, turning on
192 Files with the =.org= extension use Org mode by default. To turn on
193 Org mode in a file that does not have the extension =.org=, make the
194 first line of a file look like this:
196 : MY PROJECTS -*- mode: org; -*-
198 #+vindex: org-insert-mode-line-in-empty-file
200 which selects Org mode for this buffer no matter what the file's name
201 is. See also the variable ~org-insert-mode-line-in-empty-file~.
203 Many commands in Org work on the region if the region is /active/. To
204 make use of this, you need to have ~transient-mark-mode~ turned on,
205 which is the default. If you do not like ~transient-mark-mode~, you
206 can create an active region by using the mouse to select a region, or
207 pressing {{{kbd(C-SPC)}}} twice before moving the cursor.
211 :DESCRIPTION: Bug reports, ideas, patches, etc.
214 #+cindex: bug reports
215 #+cindex: reporting a bug
219 If you find problems with Org, or if you have questions, remarks, or
220 ideas about it, please send an email to the Org mailing list
221 [[mailto:emacs-orgmode@gnu.org]]. You can subscribe to the list [[https://lists.gnu.org/mailman/listinfo/emacs-orgmode][from this
222 web page]]. If you are not a member of the mailing list, your mail will
223 be passed to the list after a moderator has approved it[fn:2].
225 #+findex: org-version
226 #+findex: org-submit-bug-report
227 For bug reports, please first try to reproduce the bug with the latest
228 version of Org available---if you are running an outdated version, it
229 is quite possible that the bug has been fixed already. If the bug
230 persists, prepare a report and provide as much information as
231 possible, including the version information of Emacs ({{{kbd(M-x
232 emacs-version)}}}) and Org ({{{kbd(M-x org-version)}}}), as well as
233 the Org related setup in the Emacs init file. The easiest way to do
234 this is to use the command
236 : M-x org-submit-bug-report <RET>
239 which puts all this information into an Emacs mail buffer so that you
240 only need to add your description. If you are not sending the Email
241 from within Emacs, please copy and paste the content into your Email
244 Sometimes you might face a problem due to an error in your Emacs or
245 Org mode setup. Before reporting a bug, it is very helpful to start
246 Emacs with minimal customizations and reproduce the problem. Doing so
247 often helps you determine if the problem is with your customization or
248 with Org mode itself. You can start a typical minimal session with
249 a command like the example below.
251 : $ emacs -Q -l /path/to/minimal-org.el
253 However if you are using Org mode as distributed with Emacs, a minimal
254 setup is not necessary. In that case it is sufficient to start Emacs
255 as =emacs -Q=. The =minimal-org.el= setup file can have contents as
258 #+begin_src emacs-lisp
259 ;;; Minimal setup to load latest `org-mode'.
261 ;; Activate debugging.
262 (setq debug-on-error t
266 ;; Add latest Org mode to load path.
267 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
268 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
271 If an error occurs, a "backtrace" can be very useful---see below on
272 how to create one. Often a small example file helps, along with clear
275 1. What exactly did you do?
276 2. What did you expect to happen?
277 3. What happened instead?
280 Thank you for helping to improve this program.
282 *** How to create a useful backtrace
287 #+cindex: backtrace of an error
288 If working with Org produces an error with a message you do not
289 understand, you may have hit a bug. The best way to report this is by
290 providing, in addition to what was mentioned above, a backtrace. This
291 is information from the built-in debugger about where and how the
292 error occurred. Here is how to produce a useful backtrace:
294 1. Reload uncompiled versions of all Org mode Lisp files. The
295 backtrace contains much more information if it is produced with
296 uncompiled code. To do this, use
298 : C-u M-x org-reload <RET>
301 or, from the menu: Org \rarr Refresh/Reload \rarr Reload Org uncompiled.
303 2. Then, activate the debugger:
305 : M-x toggle-debug-or-error <RET>
308 or, from the menu: Options \rarr Enter Debugger on Error.
310 3. Do whatever you have to do to hit the error. Do not forget to
311 document the steps you take.
313 4. When you hit the error, a =*Backtrace*= buffer appears on the
314 screen. Save this buffer to a file---for example using {{{kbd(C-x
315 C-w)}}}---and attach it to your bug report.
317 ** Typesetting Conventions Used in this Manual
319 :DESCRIPTION: Typesetting conventions used in this manual.
320 :ALT_TITLE: Conventions
323 *** TODO keywords, tags, properties, etc.
328 Org uses various syntactical elements: TODO keywords, tags, property
329 names, keywords, blocks, etc. In this manual we use the following
332 #+attr_texinfo: :sep ,
333 - =TODO=, =WAITING= ::
335 TODO keywords are written with all capitals, even if they are
338 - =boss=, =ARCHIVE= ::
340 User-defined tags are written in lowercase; built-in tags with
341 special meaning are written with all capitals.
343 - =Release=, =PRIORITY= ::
345 User-defined properties are capitalized; built-in properties with
346 special meaning are written with all capitals.
348 - =TITLE=, =BEGIN= ... =END= ::
350 Keywords and blocks are written in uppercase to enhance their
351 readability, but you can use lowercase in your Org files.
353 *** Key bindings and commands
358 The manual lists both the keys and the corresponding commands for
359 accessing a functionality. Org mode often uses the same key for
360 different functions, depending on context. The command that is bound
361 to such keys has a generic name, like ~org-metaright~. In the manual
362 we will, wherever possible, give the function that is internally
363 called by the generic command. For example, in the chapter on
364 document structure, {{{kbd(M-RIGHT)}}} will be listed to call
365 ~org-do-demote~, while in the chapter on tables, it will be listed to
366 call ~org-table-move-column-right~.
370 :DESCRIPTION: A tree works like your brain.
372 #+cindex: document structure
373 #+cindex: structure of document
375 Org is based on Outline mode and provides flexible commands to
376 edit the structure of the document.
380 :DESCRIPTION: Org is based on Outline mode.
383 #+cindex: Outline mode
385 Org is implemented on top of Outline mode. Outlines allow a document
386 to be organized in a hierarchical structure, which, least for me, is
387 the best representation of notes and thoughts. An overview of this
388 structure is achieved by folding, i.e., hiding large parts of the
389 document to show only the general document structure and the parts
390 currently being worked on. Org greatly simplifies the use of outlines
391 by compressing the entire show and hide functionalities into a single
392 command, ~org-cycle~, which is bound to the {{{kbd(TAB)}}} key.
396 :DESCRIPTION: How to typeset Org tree headlines.
399 #+cindex: outline tree
400 #+vindex: org-special-ctrl-a/e
401 #+vindex: org-special-ctrl-k
402 #+vindex: org-ctrl-k-protect-subtree
404 Headlines define the structure of an outline tree. The headlines in
405 Org start with one or more stars, on the left margin[fn:3]. For
409 ,* Top level headline
415 ,* Another top level headline
418 #+vindex: org-footnote-section
420 Note that the name defined in ~org-footnote-section~ is reserved. Do
421 not use it as a title for your own headings.
423 Some people find the many stars too noisy and would prefer an outline
424 that has whitespace followed by a single star as headline starters.
425 See [[*A Cleaner Outline View]].
427 #+vindex: org-cycle-separator-lines
428 An empty line after the end of a subtree is considered part of it and
429 is hidden when the subtree is folded. However, if you leave at least
430 two empty lines, one empty line remains visible after folding the
431 subtree, in order to structure the collapsed view. See the variable
432 ~org-cycle-separator-lines~ to modify this behavior.
434 ** Visibility Cycling
436 :DESCRIPTION: Show and hide, much simplified.
438 #+cindex: cycling, visibility
439 #+cindex: visibility cycling
440 #+cindex: trees, visibility
441 #+cindex: show hidden text
444 *** Global and local cycling
446 :DESCRIPTION: Cycling through various visibility states.
448 #+cindex: subtree visibility states
449 #+cindex: subtree cycling
450 #+cindex: folded, subtree visibility state
451 #+cindex: children, subtree visibility state
452 #+cindex: subtree, subtree visibility state
454 Outlines make it possible to hide parts of the text in the buffer.
455 Org uses just two commands, bound to {{{kbd(TAB)}}} and
456 {{{kbd(S-TAB)}}} to change the visibility in the buffer.
458 #+attr_texinfo: :sep ,
459 - {{{kbd(TAB)}}} (~org-cycle~) ::
463 /Subtree cycling/: Rotate current subtree among the states
466 ,-> FOLDED -> CHILDREN -> SUBTREE --.
467 '-----------------------------------'
470 #+vindex: org-cycle-emulate-tab
471 The cursor must be on a headline for this to work[fn:4].
473 - {{{kbd(S-TAB)}}} (~org-global-cycle~), {{{kbd(C-u TAB)}}} ::
475 #+cindex: global visibility states
476 #+cindex: global cycling
477 #+cindex: overview, global visibility state
478 #+cindex: contents, global visibility state
479 #+cindex: show all, global visibility state
482 #+findex: org-global-cycle
483 /Global cycling/: Rotate the entire buffer among the states
486 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
487 '--------------------------------------'
490 When {{{kbd(S-TAB)}}} is called with a numeric prefix argument N,
491 the CONTENTS view up to headlines of level N are shown. Note
492 that inside tables (see [[*Tables]]), {{{kbd(S-TAB)}}} jumps to the
493 previous field instead.
495 #+vindex: org-cycle-global-at-bob
496 You can run global cycling using {{{kbd(TAB)}}} only if point is
497 at the very beginning of the buffer, but not on a headline, and
498 ~org-cycle-global-at-bob~ is set to a non-~nil~ value.
500 - {{{kbd(C-u C-u TAB)}}} (~org-set-startup-visibility~) ::
502 #+cindex: startup visibility
503 #+kindex: C-u C-u TAB
504 #+findex: org-set-startup-visibility
505 Switch back to the startup visibility of the buffer (see [[*Initial
508 - {{{kbd(C-u C-u C-u TAB)}}} (~outline-show-all~) ::
510 #+cindex: show all, command
511 #+kindex: C-u C-u C-u TAB
512 #+findex: outline-show-all
513 Show all, including drawers.
515 - {{{kbd(C-c C-r)}}} (~org-reveal~) ::
517 #+cindex: revealing context
520 Reveal context around point, showing the current entry, the
521 following heading and the hierarchy above. Useful for working
522 near a location that has been exposed by a sparse tree command
523 (see [[*Sparse Trees]]) or an agenda command (see [[*Commands in the
524 Agenda Buffer]]). With a prefix argument show, on each level, all
525 sibling headings. With a double prefix argument, also show the
526 entire subtree of the parent.
528 - {{{kbd(C-c C-k)}}} (~outline-show-branches~) ::
530 #+cindex: show branches, command
532 #+findex: outline-show-branches
533 Expose all the headings of the subtree, CONTENTS view for just
536 - {{{kbd(C-c TAB)}}} (~outline-show-children~) ::
538 #+cindex: show children, command
540 #+findex: outline-show-children
541 Expose all direct children of the subtree. With a numeric prefix
542 argument N, expose all children down to level N.
544 - {{{kbd(C-c C-x b)}}} (~org-tree-to-indirect-buffer~) ::
547 #+findex: org-tree-to-indirect-buffer
548 Show the current subtree in an indirect buffer[fn:5]. With
549 a numeric prefix argument, N, go up to level N and then take that
550 tree. If N is negative then go up that many levels. With
551 a {{{kbd(C-u)}}} prefix, do not remove the previously used
554 - {{{kbd(C-c C-x v)}}} (~org-copy-visible~) ::
557 #+findex: org-copy-visible
558 Copy the /visible/ text in the region into the kill ring.
560 *** Initial visibility
562 :DESCRIPTION: Setting the initial visibility state.
565 #+vindex: org-startup-folded
566 When Emacs first visits an Org file, the global state is set to
567 OVERVIEW, i.e., only the top level headlines are visible[fn:6]. This
568 can be configured through the variable ~org-startup-folded~, or on
569 a per-file basis by adding one of the following lines anywhere in the
572 #+cindex: STARTUP, keyword
577 ,#+STARTUP: showeverything
580 #+cindex: @samp{VISIBILITY}, property
582 Furthermore, any entries with a =VISIBILITY= property (see [[*Properties
583 and Columns]]) get their visibility adapted accordingly. Allowed values
584 for this property are =folded=, =children=, =content=, and ~all~.
586 - {{{kbd(C-u C-u TAB)}}} (~org-set-startup-visibility~) ::
588 #+kindex: C-u C-u TAB
589 #+findex: org-set-startup-visibility
590 Switch back to the startup visibility of the buffer, i.e.,
591 whatever is requested by startup options and =VISIBILITY=
592 properties in individual entries.
594 *** Catching invisible edits
596 :DESCRIPTION: Preventing mistakes when editing invisible parts.
598 #+cindex: edits, catching invisible
600 #+vindex: org-catch-invisible-edits
601 Sometimes you may inadvertently edit an invisible part of the buffer
602 and be confused on what has been edited and how to undo the mistake.
603 Setting ~org-catch-invisible-edits~ to non-~nil~ helps preventing
604 this. See the docstring of this option on how Org should catch
605 invisible edits and process them.
609 :DESCRIPTION: Jumping to other headlines.
611 #+cindex: motion, between headlines
612 #+cindex: jumping, to headlines
613 #+cindex: headline navigation
615 The following commands jump to other headlines in the buffer.
617 - {{{kbd(C-c C-n)}}} (~outline-next-visible-heading~) ::
620 #+findex: outline-next-visible-heading
623 - {{{kbd(C-c C-p)}}} (~outline-previous-visible-heading~) ::
626 #+findex: outline-previous-visible-heading
629 - {{{kbd(C-c C-f)}}} (~org-forward-same-level~) ::
632 #+findex: org-forward-same-level
633 Next heading same level.
635 - {{{kbd(C-c C-b)}}} (~org-backward-same-level~) ::
638 #+findex: org-backward-same-level
639 Previous heading same level.
641 - {{{kbd(C-c C-u)}}} (~outline-up-heading~) ::
644 #+findex: outline-up-heading
645 Backward to higher level heading.
647 - {{{kbd(C-c C-j)}}} (~org-goto~) ::
651 #+vindex: org-goto-auto-isearch
652 Jump to a different place without changing the current outline
653 visibility. Shows the document structure in a temporary buffer,
654 where you can use the following keys to find your destination:
656 #+attr_texinfo: :columns 0.3 0.7
657 | {{{kbd(TAB)}}} | Cycle visibility. |
658 | {{{kbd(DOWN)}}} / {{{kbd(UP)}}} | Next/previous visible headline. |
659 | {{{kbd(RET)}}} | Select this location. |
660 | {{{kbd(/)}}} | Do a Sparse-tree search |
663 The following keys work if you turn off ~org-goto-auto-isearch~
665 #+attr_texinfo: :columns 0.3 0.7
666 | {{{kbd(n)}}} / {{{kbd(p)}}} | Next/previous visible headline. |
667 | {{{kbd(f)}}} / {{{kbd(b)}}} | Next/previous headline same level. |
668 | {{{kbd(u)}}} | One level up. |
669 | {{{kbd(0)}}} ... {{{kbd(9)}}} | Digit argument. |
670 | {{{kbd(q)}}} | Quit. |
672 #+vindex: org-goto-interface
674 See also the variable ~org-goto-interface~.
678 :DESCRIPTION: Changing sequence and level of headlines.
680 #+cindex: structure editing
681 #+cindex: headline, promotion and demotion
682 #+cindex: promotion, of subtrees
683 #+cindex: demotion, of subtrees
684 #+cindex: subtree, cut and paste
685 #+cindex: pasting, of subtrees
686 #+cindex: cutting, of subtrees
687 #+cindex: copying, of subtrees
688 #+cindex: sorting, of subtrees
689 #+cindex: subtrees, cut and paste
691 - {{{kbd(M-RET)}}} (~org-meta-return~) ::
694 #+findex: org-meta-return
695 #+vindex: org-M-RET-may-split-line
696 Insert a new heading, item or row.
698 If the command is used at the /beginning/ of a line, and if there
699 is a heading or a plain list item (see [[*Plain Lists]]) at point,
700 the new heading/item is created /before/ the current line. When
701 used at the beginning of a regular line of text, turn that line
704 When this command is used in the middle of a line, the line is
705 split and the rest of the line becomes the new item or headline.
706 If you do not want the line to be split, customize
707 ~org-M-RET-may-split-line~.
709 Calling the command with a {{{kbd(C-u)}}} prefix unconditionally
710 inserts a new heading at the end of the current subtree, thus
711 preserving its contents. With a double {{{kbd(C-u C-u)}}}
712 prefix, the new heading is created at the end of the parent
715 - {{{kbd(C-RET)}}} (~org-insert-heading-respect-content~) ::
718 #+findex: org-insert-heading-respect-content
719 Insert a new heading at the end of the current subtree.
721 - {{{kbd(M-S-RET)}}} (~org-insert-todo-heading~) ::
724 #+findex: org-insert-todo-heading
725 #+vindex: org-treat-insert-todo-heading-as-state-change
726 Insert new TODO entry with same level as current heading. See
728 ~org-treat-insert-todo-heading-as-state-change~.
730 - {{{kbd(C-S-RET)}}} (~org-insert-todo-heading-respect-content~) ::
733 #+findex: org-insert-todo-heading-respect-content
734 Insert new TODO entry with same level as current heading. Like
735 {{{kbd(C-RET)}}}, the new headline is inserted after the current
738 - {{{kbd(TAB)}}} (~org-cycle~) ::
742 In a new entry with no text yet, the first {{{kbd(TAB)}}} demotes
743 the entry to become a child of the previous one. The next
744 {{{kbd(TAB)}}} makes it a parent, and so on, all the way to top
745 level. Yet another {{{kbd(TAB)}}}, and you are back to the
748 - {{{kbd(M-LEFT)}}} (~org-do-promote~) ::
751 #+findex: org-do-promote
752 Promote current heading by one level.
754 - {{{kbd(M-RIGHT)}}} (~org-do-demote~) ::
757 #+findex: org-do-demote
758 Demote current heading by one level.
760 - {{{kbd(M-S-LEFT)}}} (~org-promote-subtree~) ::
763 #+findex: org-promote-subtree
764 Promote the current subtree by one level.
766 - {{{kbd(M-S-RIGHT)}}} (~org-demote-subtree~) ::
769 #+findex: org-demote-subtree
770 Demote the current subtree by one level.
772 - {{{kbd(M-UP)}}} (~org-move-subtree-up~) ::
775 #+findex: org-move-subtree-up
776 Move subtree up, i.e., swap with previous subtree of same level.
778 - {{{kbd(M-DOWN)}}} (~org-move-subtree-down~) ::
781 #+findex: org-move-subtree-down
782 Move subtree down, i.e., swap with next subtree of same level.
784 - {{{kbd(C-c @)}}} (~org-mark-subtree~) ::
787 #+findex: org-mark-subtree
788 Mark the subtree at point. Hitting repeatedly marks subsequent
789 subtrees of the same level as the marked subtree.
791 - {{{kbd(C-c C-x C-w)}}} (~org-cut-subtree~) ::
793 #+kindex: C-c C-x C-w
794 #+findex: org-cut-subtree
795 Kill subtree, i.e., remove it from buffer but save in kill ring.
796 With a numeric prefix argument N, kill N sequential subtrees.
798 - {{{kbd(C-c C-x M-w)}}} (~org-copy-subtree~) ::
800 #+kindex: C-c C-x M-w
801 #+findex: org-copy-subtree
802 Copy subtree to kill ring. With a numeric prefix argument N,
803 copy the N sequential subtrees.
805 - {{{kbd(C-c C-x C-y)}}} (~org-paste-subtree~) ::
807 #+kindex: C-c C-x C-y
808 #+findex: org-paste-subtree
809 Yank subtree from kill ring. This does modify the level of the
810 subtree to make sure the tree fits in nicely at the yank
811 position. The yank level can also be specified with a numeric
812 prefix argument, or by yanking after a headline marker like
815 - {{{kbd(C-y)}}} (~org-yank~) ::
819 #+vindex: org-yank-adjusted-subtrees
820 #+vindex: org-yank-folded-subtrees
821 Depending on the variables ~org-yank-adjusted-subtrees~ and
822 ~org-yank-folded-subtrees~, Org's internal ~yank~ command pastes
823 subtrees folded and in a clever way, using the same command as
824 {{{kbd(C-c C-x C-y)}}}. With the default settings, no level
825 adjustment takes place, but the yanked tree is folded unless
826 doing so would swallow text previously visible. Any prefix
827 argument to this command forces a normal ~yank~ to be executed,
828 with the prefix passed along. A good way to force a normal yank
829 is {{{kbd(C-u C-y)}}}. If you use ~yank-pop~ after a yank, it
830 yanks previous kill items plainly, without adjustment and
833 - {{{kbd(C-c C-x c)}}} (~org-clone-subtree-with-time-shift~) ::
836 #+findex: org-clone-subtree-with-time-shift
837 Clone a subtree by making a number of sibling copies of it. You
838 are prompted for the number of copies to make, and you can also
839 specify if any timestamps in the entry should be shifted. This
840 can be useful, for example, to create a number of tasks related
841 to a series of lectures to prepare. For more details, see the
842 docstring of the command ~org-clone-subtree-with-time-shift~.
844 - {{{kbd(C-c C-w)}}} (~org-refile~) ::
848 Refile entry or region to a different location. See [[*Refile and
851 - {{{kbd(C-c ^)}}} (~org-sort~) ::
855 Sort same-level entries. When there is an active region, all
856 entries in the region are sorted. Otherwise the children of the
857 current headline are sorted. The command prompts for the sorting
858 method, which can be alphabetically, numerically, by time---first
859 timestamp with active preferred, creation time, scheduled time,
860 deadline time---by priority, by TODO keyword---in the sequence
861 the keywords have been defined in the setup---or by the value of
862 a property. Reverse sorting is possible as well. You can also
863 supply your own function to extract the sorting key. With
864 a {{{kbd(C-u)}}} prefix, sorting is case-sensitive.
866 - {{{kbd(C-x n s)}}} (~org-narrow-to-subtree~) ::
869 #+findex: org-narrow-to-subtree
870 Narrow buffer to current subtree.
872 - {{{kbd(C-x n b)}}} (~org-narrow-to-block~) ::
875 #+findex: org-narrow-to-block
876 Narrow buffer to current block.
878 - {{{kbd(C-x n w)}}} (~widen~) ::
882 Widen buffer to remove narrowing.
884 - {{{kbd(C-c *)}}} (~org-toggle-heading~) ::
887 #+findex: org-toggle-heading
888 Turn a normal line or plain list item into a headline---so that
889 it becomes a subheading at its location. Also turn a headline
890 into a normal line by removing the stars. If there is an active
891 region, turn all lines in the region into headlines. If the
892 first line in the region was an item, turn only the item lines
893 into headlines. Finally, if the first line is a headline, remove
894 the stars from all headlines in the region.
896 #+cindex: region, active
897 #+cindex: active region
898 #+cindex: transient mark mode
899 When there is an active region---i.e., when Transient Mark mode is
900 active---promotion and demotion work on all headlines in the region.
901 To select a region of headlines, it is best to place both point and
902 mark at the beginning of a line, mark at the beginning of the first
903 headline, and point at the line just after the last headline to
904 change. Note that when the cursor is inside a table (see [[*Tables]]),
905 the Meta-Cursor keys have different functionality.
909 :DESCRIPTION: Matches embedded in context.
911 #+cindex: sparse trees
912 #+cindex: trees, sparse
913 #+cindex: folding, sparse trees
914 #+cindex: occur, command
916 #+vindex: org-show-context-detail
917 An important feature of Org mode is the ability to construct /sparse
918 trees/ for selected information in an outline tree, so that the entire
919 document is folded as much as possible, but the selected information
920 is made visible along with the headline structure above it[fn:7].
921 Just try it out and you will see immediately how it works.
923 Org mode contains several commands creating such trees, all these
924 commands can be accessed through a dispatcher:
926 - {{{kbd(C-c /)}}} (~org-sparse-tree~) ::
929 #+findex: org-sparse-tree
930 This prompts for an extra key to select a sparse-tree creating
933 - {{{kbd(C-c / r)}}} or {{{kbd(C-c / /)}}} (~org-occur~) ::
938 #+vindex: org-remove-highlights-with-change
939 Prompts for a regexp and shows a sparse tree with all matches.
940 If the match is in a headline, the headline is made visible. If
941 the match is in the body of an entry, headline and body are made
942 visible. In order to provide minimal context, also the full
943 hierarchy of headlines above the match is shown, as well as the
944 headline following the match. Each match is also highlighted;
945 the highlights disappear when the buffer is changed by an editing
946 command, or by pressing {{{kbd(C-c C-c)}}}[fn:8]. When called
947 with a {{{kbd(C-u)}}} prefix argument, previous highlights are
948 kept, so several calls to this command can be stacked.
950 - {{{kbd(M-g n)}}} or {{{kbd(M-g M-n)}}} (~next-error~) ::
955 Jump to the next sparse tree match in this buffer.
957 - {{{kbd(M-g p)}}} or {{{kbd(M-g M-p)}}} (~previous-error~) ::
961 #+findex: previous-error
962 Jump to the previous sparse tree match in this buffer.
964 #+vindex: org-agenda-custom-commands
966 For frequently used sparse trees of specific search strings, you can
967 use the variable ~org-agenda-custom-commands~ to define fast keyboard
968 access to specific sparse trees. These commands will then be
969 accessible through the agenda dispatcher (see [[*The Agenda Dispatcher]]).
972 #+begin_src emacs-lisp
973 (setq org-agenda-custom-commands
974 '(("f" occur-tree "FIXME")))
978 defines the key {{{kbd(f)}}} as a shortcut for creating a sparse tree
979 matching the string =FIXME=.
981 The other sparse tree commands select headings based on TODO keywords,
982 tags, or properties and are discussed later in this manual.
985 #+cindex: printing sparse trees
986 #+cindex: visible text, printing
987 To print a sparse tree, you can use the Emacs command
988 ~ps-print-buffer-with-faces~ which does not print invisible parts of
989 the document. Or you can use the command {{{kbd(C-c C-e v)}}} to
990 export only the visible part of the document and print the resulting
995 :DESCRIPTION: Additional structure within an entry.
997 #+cindex: plain lists
998 #+cindex: lists, plain
999 #+cindex: lists, ordered
1000 #+cindex: ordered lists
1002 Within an entry of the outline tree, hand-formatted lists can provide
1003 additional structure. They also provide a way to create lists of
1004 checkboxes (see [[*Checkboxes]]). Org supports editing such lists, and
1005 every exporter (see [[*Exporting]]) can parse and format them.
1007 Org knows ordered lists, unordered lists, and description lists.
1009 #+attr_texinfo: :indic @bullet
1010 - /Unordered/ list items start with =-=, =+=, or =*=[fn:9] as bullets.
1013 #+vindex: org-plain-list-ordered-item-terminator
1014 #+vindex: org-alphabetical-lists
1015 /Ordered/ list items start with a numeral followed by either
1016 a period or a right parenthesis[fn:10], such as =1.= or =1)=[fn:11]
1017 If you want a list to start with a different value---e.g.,
1018 20---start the text of the item with =[@20]=[fn:12]. Those
1019 constructs can be used in any item of the list in order to enforce
1020 a particular numbering.
1022 - /Description/ list items are unordered list items, and contain the
1023 separator =::= to distinguish the description /term/ from the
1026 Items belonging to the same list must have the same indentation on the
1027 first line. In particular, if an ordered list reaches number =10.=,
1028 then the 2-digit numbers must be written left-aligned with the other
1029 numbers in the list. An item ends before the next line that is less
1030 or equally indented than its bullet/number.
1032 A list ends whenever every item has ended, which means before any line
1033 less or equally indented than items at top level. It also ends before
1034 two blank lines. In that case, all items are closed. Here is an
1038 ,* Lord of the Rings
1039 My favorite scenes are (in this order)
1040 1. The attack of the Rohirrim
1041 2. Eowyn's fight with the witch king
1042 + this was already my favorite scene in the book
1043 + I really like Miranda Otto.
1044 3. Peter Jackson being shot by Legolas
1046 He makes a really funny face when it happens.
1047 But in the end, no individual scenes matter but the film as a whole.
1048 Important actors in this film are:
1049 - Elijah Wood :: He plays Frodo
1050 - Sean Astin :: He plays Sam, Frodo's friend. I still remember him
1051 very well from his role as Mikey Walsh in /The Goonies/.
1054 Org supports these lists by tuning filling and wrapping commands to
1055 deal with them correctly, and by exporting them properly (see
1056 [[*Exporting]]). Since indentation is what governs the structure of these
1057 lists, many structural constructs like =#+BEGIN_= blocks can be
1058 indented to signal that they belong to a particular item.
1060 #+vindex: org-list-demote-modify-bullet
1061 #+vindex: org-list-indent-offset
1062 If you find that using a different bullet for a sub-list---than that
1063 used for the current list-level---improves readability, customize the
1064 variable ~org-list-demote-modify-bullet~. To get a greater difference
1065 of indentation between items and theirs sub-items, customize
1066 ~org-list-indent-offset~.
1068 #+vindex: org-list-automatic-rules
1069 The following commands act on items when the cursor is in the first
1070 line of an item---the line with the bullet or number. Some of them
1071 imply the application of automatic rules to keep list structure
1072 intact. If some of these actions get in your way, configure
1073 ~org-list-automatic-rules~ to disable them individually.
1075 #+attr_texinfo: :sep ,
1076 - {{{kbd(TAB)}}} (~org-cycle~) ::
1078 #+cindex: cycling, in plain lists
1081 #+vindex: org-cycle-include-plain-lists
1082 Items can be folded just like headline levels. Normally this
1083 works only if the cursor is on a plain list item. For more
1084 details, see the variable ~org-cycle-include-plain-lists~. If
1085 this variable is set to ~integrate~, plain list items are treated
1086 like low-level headlines. The level of an item is then given by
1087 the indentation of the bullet/number. Items are always
1088 subordinate to real headlines, however; the hierarchies remain
1089 completely separated. In a new item with no text yet, the first
1090 {{{kbd(TAB)}}} demotes the item to become a child of the previous
1091 one. Subsequent {{{kbd(TAB)}}}s move the item to meaningful
1092 levels in the list and eventually get it back to its initial
1095 - {{{kbd(M-RET)}}} (~org-insert-heading~) ::
1098 #+findex: org-insert-heading
1099 #+vindex: org-M-RET-may-split-line
1100 Insert new item at current level. With a prefix argument, force
1101 a new heading (see [[*Structure Editing]]). If this command is used
1102 in the middle of an item, that item is /split/ in two, and the
1103 second part becomes the new item[fn:13]. If this command is
1104 executed /before item's body/, the new item is created /before/
1107 - {{{kbd(M-S-RET)}}} ::
1110 Insert a new item with a checkbox (see [[*Checkboxes]]).
1112 - {{{kbd(S-UP)}}}, {{{kbd(S-DOWN)}}} ::
1116 #+cindex: shift-selection-mode
1117 #+vindex: org-support-shift-select
1118 #+vindex: org-list-use-circular-motion
1119 Jump to the previous/next item in the current list, but only if
1120 ~org-support-shift-select~ is off[fn:14]. If not, you can
1121 still use paragraph jumping commands like {{{kbd(C-UP)}}}
1122 and {{{kbd(C-DOWN)}}} to quite similar effect.
1124 - {{{kbd(M-UP)}}}, {{{kbd(M-DOWN)}}} ::
1128 Move the item including subitems up/down[fn:15], i.e., swap with
1129 previous/next item of same indentation. If the list is ordered,
1130 renumbering is automatic.
1132 - {{{kbd(M-LEFT)}}}, {{{kbd(M-RIGHT)}}} ::
1136 Decrease/increase the indentation of an item, leaving children
1139 - {{{kbd(M-S-LEFT)}}}, {{{kbd(M-S-RIGHT)}}} ::
1143 Decrease/increase the indentation of the item, including
1144 subitems. Initially, the item tree is selected based on current
1145 indentation. When these commands are executed several times in
1146 direct succession, the initially selected region is used, even if
1147 the new indentation would imply a different hierarchy. To use
1148 the new hierarchy, break the command chain with a cursor motion
1151 As a special case, using this command on the very first item of
1152 a list moves the whole list. This behavior can be disabled by
1153 configuring ~org-list-automatic-rules~. The global indentation
1154 of a list has no influence on the text /after/ the list.
1156 - {{{kbd(C-c C-c)}}} ::
1159 If there is a checkbox (see [[*Checkboxes]]) in the item line, toggle
1160 the state of the checkbox. In any case, verify bullets and
1161 indentation consistency in the whole list.
1163 - {{{kbd(C-c -)}}} ::
1166 #+vindex: org-plain-list-ordered-item-terminator
1167 Cycle the entire list level through the different
1168 itemize/enumerate bullets (=-=, =+=, =*=, =1.=, =1)=) or a subset
1169 of them, depending on ~org-plain-list-ordered-item-terminator~,
1170 the type of list, and its indentation. With a numeric prefix
1171 argument N, select the Nth bullet from this list. If there is an
1172 active region when calling this, selected text is changed into an
1173 item. With a prefix argument, all lines are converted to list
1174 items. If the first line already was a list item, any item
1175 marker is removed from the list. Finally, even without an active
1176 region, a normal line is converted into a list item.
1178 - {{{kbd(C-c *)}}} ::
1181 Turn a plain list item into a headline---so that it becomes
1182 a subheading at its location. See [[*Structure Editing]], for
1183 a detailed explanation.
1185 - {{{kbd(C-c C-*)}}} ::
1188 Turn the whole plain list into a subtree of the current heading.
1189 Checkboxes (see [[*Checkboxes]]) become TODO, respectively DONE,
1190 keywords when unchecked, respectively checked.
1192 - {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} ::
1194 #+vindex: org-support-shift-select
1197 This command also cycles bullet styles when the cursor in on the
1198 bullet or anywhere in an item line, details depending on
1199 ~org-support-shift-select~.
1201 - {{{kbd(C-c ^)}}} ::
1204 #+cindex: sorting, of plain list
1205 Sort the plain list. Prompt for the sorting method: numerically,
1206 alphabetically, by time, or by custom function.
1210 :DESCRIPTION: Tucking stuff away.
1213 #+cindex: visibility cycling, drawers
1215 Sometimes you want to keep information associated with an entry, but
1216 you normally do not want to see it. For this, Org mode has /drawers/.
1217 They can contain anything but a headline and another drawer. Drawers
1221 ,** This is a headline
1222 Still outside the drawer
1224 This is inside the drawer.
1230 #+findex: org-insert-drawer
1231 You can interactively insert a drawer at point by calling
1232 ~org-insert-drawer~, which is bound to {{{kbd(C-c C-x d)}}}. With an
1233 active region, this command puts the region inside the drawer. With
1234 a prefix argument, this command calls ~org-insert-property-drawer~,
1235 which creates a =PROPERTIES= drawer right below the current headline.
1236 Org mode uses this special drawer for storing properties (see
1237 [[*Properties and Columns]]). You cannot use it for anything else.
1239 Completion over drawer keywords is also possible using
1240 {{{kbd(M-TAB)}}}[fn:16].
1242 Visibility cycling (see [[*Visibility Cycling]]) on the headline hides and
1243 shows the entry, but keep the drawer collapsed to a single line. In
1244 order to look inside the drawer, you need to move the cursor to the
1245 drawer line and press {{{kbd(TAB)}}} there.
1247 You can also arrange for state change notes (see [[Tracking TODO state
1248 changes]]) and clock times (see [[*Clocking Work Time]]) to be stored in
1249 a =LOGBOOK= drawer. If you want to store a quick note there, in
1250 a similar way to state changes, use
1252 - {{{kbd(C-c C-z)}}} ::
1255 Add a time-stamped note to the =LOGBOOK= drawer.
1259 :DESCRIPTION: Folding blocks.
1261 #+vindex: org-hide-block-startup
1262 #+cindex: blocks, folding
1264 Org mode uses =#+BEGIN= ... =#+END= blocks for various purposes from
1265 including source code examples (see [[*Literal Examples]]) to capturing
1266 time logging information (see [[*Clocking Work Time]]). These blocks can
1267 be folded and unfolded by pressing {{{kbd(TAB)}}} in the =#+BEGIN=
1268 line. You can also get all blocks folded at startup by configuring
1269 the variable ~org-hide-block-startup~ or on a per-file basis by using
1271 #+cindex: STARTUP, keyword
1273 ,#+STARTUP: hideblocks
1274 ,#+STARTUP: nohideblocks
1277 ** Creating Footnotes
1279 :DESCRIPTION: How footnotes are defined in Org's syntax.
1283 Org mode supports the creation of footnotes.
1285 A footnote is started by a footnote marker in square brackets in
1286 column 0, no indentation allowed. It ends at the next footnote
1287 definition, headline, or after two consecutive empty lines. The
1288 footnote reference is simply the marker in square brackets, inside
1289 text. Markers always start with =fn:=. For example:
1292 The Org homepage[fn:1] now looks a lot better than it used to.
1294 [fn:1] The link is: https://orgmode.org
1297 Org mode extends the number-based syntax to /named/ footnotes and
1298 optional inline definition. Here are the valid references:
1302 A named footnote reference, where {{{var(NAME)}}} is a unique
1303 label word, or, for simplicity of automatic creation, a number.
1305 - =[fn:: This is the inline definition of this footnote]= ::
1307 A LaTeX-like anonymous footnote where the definition is given
1308 directly at the reference point.
1310 - =[fn:NAME: a definition]= ::
1312 An inline definition of a footnote, which also specifies a name
1313 for the note. Since Org allows multiple references to the same
1314 note, you can then use =[fn:NAME]= to create additional
1317 #+vindex: org-footnote-auto-label
1318 Footnote labels can be created automatically, or you can create names
1319 yourself. This is handled by the variable ~org-footnote-auto-label~
1320 and its corresponding =STARTUP= keywords. See the docstring of that
1321 variable for details.
1323 #+texinfo: @noindent
1324 The following command handles footnotes:
1326 - {{{kbd(C-c C-x f)}}} ::
1328 The footnote action command.
1331 When the cursor is on a footnote reference, jump to the
1332 definition. When it is at a definition, jump to
1333 the---first---reference.
1335 #+vindex: org-footnote-define-inline
1336 #+vindex: org-footnote-section
1337 Otherwise, create a new footnote. Depending on the variable
1338 ~org-footnote-define-inline~[fn:17], the definition is placed
1339 right into the text as part of the reference, or separately into
1340 the location determined by the variable ~org-footnote-section~.
1342 When this command is called with a prefix argument, a menu of
1343 additional options is offered:
1345 #+attr_texinfo: :columns 0.1 0.9
1346 | {{{kbd(s)}}} | Sort the footnote definitions by reference sequence. |
1347 | {{{kbd(r)}}} | Renumber the simple =fn:N= footnotes. |
1348 | {{{kbd(S)}}} | Short for first {{{kbd(r)}}}, then {{{kbd(s)}}} action. |
1349 | {{{kbd(n)}}} | Rename all footnotes into a =fn:1= ... =fn:n= sequence. |
1350 | {{{kbd(d)}}} | Delete the footnote at point, including definition and references. |
1352 #+vindex: org-footnote-auto-adjust
1353 Depending on the variable ~org-footnote-auto-adjust~[fn:18],
1354 renumbering and sorting footnotes can be automatic after each
1355 insertion or deletion.
1357 - {{{kbd(C-c C-c)}}} ::
1360 If the cursor is on a footnote reference, jump to the definition.
1361 If it is at the definition, jump back to the reference. When
1362 called at a footnote location with a prefix argument, offer the
1363 same menu as {{{kbd(C-c C-x f)}}}.
1365 - {{{kbd(C-c C-o)}}} or {{{kbd(mouse-1/2)}}} ::
1370 Footnote labels are also links to the corresponding definition or
1371 reference, and you can use the usual commands to follow these
1376 :DESCRIPTION: Formal description of Org's syntax.
1379 A reference document providing a formal description of Org's syntax is
1380 available as [[https://orgmode.org/worg/dev/org-syntax.html][a draft on Worg]], written and maintained by Nicolas
1381 Goaziou. It defines Org's core internal concepts such as =headlines=,
1382 =sections=, =affiliated keywords=, =(greater) elements= and =objects=.
1383 Each part of an Org file falls into one of the categories above.
1385 To explore the abstract structure of an Org buffer, run this in
1388 : M-: (org-element-parse-buffer) <RET>
1390 #+texinfo: @noindent
1391 It outputs a list containing the buffer's content represented as an
1392 abstract structure. The export engine relies on the information
1393 stored in this list. Most interactive commands---e.g., for structure
1394 editing---also rely on the syntactic meaning of the surrounding
1397 #+cindex: syntax checker
1400 You can check syntax in your documents using ~org-lint~ command.
1404 :DESCRIPTION: Pure magic for quick formatting.
1407 #+cindex: editing tables
1409 Org comes with a fast and intuitive table editor. Spreadsheet-like
1410 calculations are supported using the Emacs Calc package (see [[info:calc][GNU Emacs
1411 Calculator Manual]]).
1413 ** Built-in Table Editor
1415 :DESCRIPTION: Simple tables.
1417 #+cindex: table editor, built-in
1419 Org makes it easy to format tables in plain ASCII. Any line with =|=
1420 as the first non-whitespace character is considered part of a table.
1421 =|= is also the column separator[fn:19]. A table might look like
1425 | Name | Phone | Age |
1426 |-------+-------+-----|
1427 | Peter | 1234 | 17 |
1428 | Anna | 4321 | 25 |
1431 A table is re-aligned automatically each time you press
1432 {{{kbd(TAB)}}}, {{{kbd(RET)}}} or {{{kbd(C-c C-c)}}} inside the table.
1433 {{{kbd(TAB)}}} also moves to the next field---{{{kbd(RET)}}} to the
1434 next row---and creates new table rows at the end of the table or
1435 before horizontal lines. The indentation of the table is set by the
1436 first line. Any line starting with =|-= is considered as a horizontal
1437 separator line and will be expanded on the next re-align to span the
1438 whole table width. So, to create the above table, you would only type
1445 #+texinfo: @noindent
1446 and then press {{{kbd(TAB)}}} to align the table and start filling in
1447 fields. Even faster would be to type =|Name|Phone|Age= followed by
1450 When typing text into a field, Org treats {{{kbd(DEL)}}},
1451 {{{kbd(Backspace)}}}, and all character keys in a special way, so that
1452 inserting and deleting avoids shifting other fields. Also, when
1453 typing /immediately/ after the cursor was moved into a new field with
1454 {{{kbd(TAB)}}}, {{{kbd(S-TAB)}}} or {{{kbd(RET)}}}, the field is
1455 automatically made blank. If this behavior is too unpredictable for
1456 you, configure the option ~org-table-auto-blank-field~.
1458 *** Creation and conversion
1463 - {{{kbd(C-c |)}}} (~org-table-create-or-convert-from-region~) ::
1466 #+findex: org-table-create-or-convert-from-region
1467 Convert the active region to table. If every line contains at
1468 least one {{{kbd(TAB)}}} character, the function assumes that the
1469 material is tab separated. If every line contains a comma,
1470 comma-separated values (CSV) are assumed. If not, lines are
1471 split at whitespace into fields. You can use a prefix argument
1472 to force a specific separator: {{{kbd(C-u)}}} forces CSV,
1473 {{{kbd(C-u C-u)}}} forces {{{kbd(TAB)}}}, {{{kbd(C-u C-u C-u)}}}
1474 prompts for a regular expression to match the separator, and
1475 a numeric argument N indicates that at least N consecutive
1476 spaces, or alternatively a {{{kbd(TAB)}}} will be the separator.
1478 If there is no active region, this command creates an empty Org
1479 table. But it is easier just to start typing, like {{{kbd(|
1480 N a m e | P h o n e | A g e RET | - TAB)}}}.
1482 *** Re-aligning and field motion
1487 - {{{kbd(C-c C-c)}}} (~org-table-align~) ::
1490 #+findex: org-table-align
1491 Re-align the table without moving the cursor.
1493 - {{{kbd(TAB)}}} (~org-table-next-field~) ::
1496 #+findex: org-table-next-field
1497 Re-align the table, move to the next field. Creates a new row if
1500 - {{{kbd(C-c SPC)}}} (~org-table-blank-field~) ::
1503 #+findex: org-table-blank-field
1504 Blank the field at point.
1506 - {{{kbd(S-TAB)}}} (~org-table-previous-field~) ::
1509 #+findex: org-table-previous-field
1510 Re-align, move to previous field.
1512 - {{{kbd(RET)}}} (~org-table-next-row~) ::
1515 #+findex: org-table-next-row
1516 Re-align the table and move down to next row. Creates a new row
1517 if necessary. At the beginning or end of a line, {{{kbd(RET)}}}
1518 still inserts a new line, so it can be used to split a table.
1520 - {{{kbd(M-a)}}} (~org-table-beginning-of-field~) ::
1523 #+findex: org-table-beginning-of-field
1524 Move to beginning of the current table field, or on to the
1527 - {{{kbd(M-e)}}} (~org-table-end-of-field~) ::
1530 #+findex: org-table-end-of-field
1531 Move to end of the current table field, or on to the next field.
1533 *** Column and row editing
1538 - {{{kbd(M-LEFT)}}} (~org-table-move-column-left~) ::
1541 #+findex: org-table-move-column-left
1542 Move the current column left.
1544 - {{{kbd(M-RIGHT)}}} (~org-table-move-column-right~) ::
1547 #+findex: org-table-move-column-right
1548 Move the current column right.
1550 - {{{kbd(M-S-LEFT)}}} (~org-table-delete-column~) ::
1553 #+findex: org-table-delete-column
1554 Kill the current column.
1556 - {{{kbd(M-S-RIGHT)}}} (~org-table-insert-column~) ::
1559 #+findex: org-table-insert-column
1560 Insert a new column to the left of the cursor position.
1562 - {{{kbd(M-UP)}}} (~org-table-move-row-up~) ::
1565 #+findex: org-table-move-row-up
1566 Move the current row up.
1568 - {{{kbd(M-DOWN)}}} (~org-table-move-row-down~) ::
1571 #+findex: org-table-move-row-down
1572 Move the current row down.
1574 - {{{kbd(M-S-UP)}}} (~org-table-kill-row~) ::
1577 #+findex: org-table-kill-row
1578 Kill the current row or horizontal line.
1580 - {{{kbd(M-S-DOWN)}}} (~org-table-insert-row~) ::
1583 #+findex: org-table-insert-row
1584 Insert a new row above the current row. With a prefix argument,
1585 the line is created below the current one.
1587 - {{{kbd(C-c -)}}} (~org-table-insert-hline~) ::
1590 #+findex: org-table-insert-hline
1591 Insert a horizontal line below current row. With a prefix
1592 argument, the line is created above the current line.
1594 - {{{kbd(C-c RET)}}} (~org-table-hline-and-move~) ::
1597 #+findex: org-table-hline-and-move
1598 Insert a horizontal line below current row, and move the cursor
1599 into the row below that line.
1601 - {{{kbd(C-c ^)}}} (~org-table-sort-lines~) ::
1604 #+findex: org-table-sort-lines
1605 Sort the table lines in the region. The position of point
1606 indicates the column to be used for sorting, and the range of
1607 lines is the range between the nearest horizontal separator
1608 lines, or the entire table. If point is before the first column,
1609 you are prompted for the sorting column. If there is an active
1610 region, the mark specifies the first line and the sorting column,
1611 while point should be in the last line to be included into the
1612 sorting. The command prompts for the sorting type,
1613 alphabetically, numerically, or by time. You can sort in normal
1614 or reverse order. You can also supply your own key extraction
1615 and comparison functions. When called with a prefix argument,
1616 alphabetic sorting is case-sensitive.
1623 - {{{kbd(C-c C-x M-w)}}} (~org-table-copy-region~) ::
1625 #+kindex: C-c C-x M-w
1626 #+findex: org-table-copy-region
1627 Copy a rectangular region from a table to a special clipboard.
1628 Point and mark determine edge fields of the rectangle. If there
1629 is no active region, copy just the current field. The process
1630 ignores horizontal separator lines.
1632 - {{{kbd(C-c C-x C-w)}}} (~org-table-cut-region~) ::
1634 #+kindex: C-c C-x C-w
1635 #+findex: org-table-cut-region
1636 Copy a rectangular region from a table to a special clipboard,
1637 and blank all fields in the rectangle. So this is the "cut"
1640 - {{{kbd(C-c C-x C-y)}}} (~org-table-paste-rectangle~) ::
1642 #+kindex: C-c C-x C-y
1643 #+findex: org-table-paste-rectangle
1644 Paste a rectangular region into a table. The upper left corner
1645 ends up in the current field. All involved fields are
1646 overwritten. If the rectangle does not fit into the present
1647 table, the table is enlarged as needed. The process ignores
1648 horizontal separator lines.
1650 - {{{kbd(M-RET)}}} (~org-table-wrap-region~) ::
1653 #+findex: org-table-wrap-region
1654 Split the current field at the cursor position and move the rest
1655 to the line below. If there is an active region, and both point
1656 and mark are in the same column, the text in the column is
1657 wrapped to minimum width for the given number of lines.
1658 A numeric prefix argument may be used to change the number of
1659 desired lines. If there is no region, but you specify a prefix
1660 argument, the current field is made blank, and the content is
1661 appended to the field above.
1668 #+cindex: formula, in tables
1669 #+cindex: calculations, in tables
1671 - {{{kbd(C-c +)}}} (~org-table-sum~) ::
1674 #+findex: org-table-sum
1675 Sum the numbers in the current column, or in the rectangle
1676 defined by the active region. The result is shown in the echo
1677 area and can be inserted with {{{kbd(C-y)}}}.
1679 - {{{kbd(S-RET)}}} (~org-table-copy-down~) ::
1682 #+findex: org-table-copy-down
1683 #+vindex: org-table-copy-increment
1684 When current field is empty, copy from first non-empty field
1685 above. When not empty, copy current field down to next row and
1686 move cursor along with it. Depending on the variable
1687 ~org-table-copy-increment~, integer field values can be
1688 incremented during copy. Integers that are too large are not
1689 incremented, however. Also, a ~0~ prefix argument temporarily
1690 disables the increment. This key is also used by shift-selection
1691 and related modes (see [[*Packages that conflict with Org mode]]).
1698 - {{{kbd(C-c `)}}} (~org-table-edit-field~) ::
1701 #+findex: org-table-edit-field
1702 Edit the current field in a separate window. This is useful for
1703 fields that are not fully visible (see [[*Column Width and
1704 Alignment]]). When called with a {{{kbd(C-u)}}} prefix, just make
1705 the full field visible, so that it can be edited in place. When
1706 called with two {{{kbd(C-u)}}} prefixes, make the editor window
1707 follow the cursor through the table and always show the current
1708 field. The follow mode exits automatically when the cursor
1709 leaves the table, or when you repeat this command with {{{kbd(C-u
1712 - {{{kbd(M-x org-table-import)}}} ::
1714 #+findex: org-table-import
1715 Import a file as a table. The table should be TAB or whitespace
1716 separated. Use, for example, to import a spreadsheet table or
1717 data from a database, because these programs generally can write
1718 TAB-separated text files. This command works by inserting the
1719 file into the buffer and then converting the region to a table.
1720 Any prefix argument is passed on to the converter, which uses it
1721 to determine the separator.
1723 - {{{kbd(C-c |)}}} (~org-table-create-or-convert-from-region~) ::
1726 #+findex: org-table-create-or-convert-from-region
1727 Tables can also be imported by pasting tabular text into the Org
1728 buffer, selecting the pasted text with {{{kbd(C-x C-x)}}} and
1729 then using the {{{kbd(C-c |)}}} command (see [[*Creation and
1732 - {{{kbd(M-x org-table-export)}}} ::
1734 #+findex: org-table-export
1735 #+vindex: org-table-export-default-format
1736 Export the table, by default as a TAB-separated file. Use for
1737 data exchange with, for example, spreadsheet or database
1738 programs. The format used to export the file can be configured
1739 in the variable ~org-table-export-default-format~. You may also
1740 use properties =TABLE_EXPORT_FILE= and =TABLE_EXPORT_FORMAT= to
1741 specify the file name and the format for table export in
1742 a subtree. Org supports quite general formats for exported
1743 tables. The exporter format is the same as the format used by
1744 Orgtbl radio tables, see [[*Translator functions]], for a detailed
1747 ** Column Width and Alignment
1749 :DESCRIPTION: Overrule the automatic settings.
1751 #+cindex: narrow columns in tables
1752 #+cindex: alignment in tables
1754 The width of columns is automatically determined by the table editor.
1755 The alignment of a column is determined automatically from the
1756 fraction of number-like versus non-number fields in the column.
1758 #+vindex: org-table-automatic-realign
1759 Editing a field may modify alignment of the table. Moving
1760 a contiguous row or column---i.e., using {{{kbd(TAB)}}} or
1761 {{{kbd(RET)}}}---automatically re-aligns it. If you want to disable
1762 this behavior, set ~org-table-automatic-realign~ to ~nil~. In any
1763 case, you can always align manually a table:
1765 - {{{kbd(C-c C-c)}}} (~org-table-align~) ::
1768 #+findex: org-table-align
1769 Align the current table.
1771 #+texinfo: @noindent
1772 #+vindex: org-startup-align-all-tables
1773 Setting the option ~org-startup-align-all-tables~ re-aligns all tables
1774 in a file upon visiting it. You can also set this option on
1775 a per-file basis with:
1782 Sometimes a single field or a few fields need to carry more text,
1783 leading to inconveniently wide columns. Maybe you want to hide away
1784 several columns or display them with a fixed width, regardless of
1785 content, as shown in the following example.
1788 |---+---------------------+--------| |---+-------…|…|
1789 | | <6> | | | | <6> …|…|
1790 | 1 | one | some | ----\ | 1 | one …|…|
1791 | 2 | two | boring | ----/ | 2 | two …|…|
1792 | 3 | This is a long text | column | | 3 | This i…|…|
1793 |---+---------------------+--------| |---+-------…|…|
1796 To set the width of a column, one field anywhere in the column may
1797 contain just the string =<N>= where {{{var(N)}}} specifies the width
1798 as a number of characters. You control displayed width of columns
1799 with the following tools:
1801 - {{{kbd(C-c TAB)}}} (~org-table-toggle-column-width~) ::
1804 #+findex: org-table-toggle-column-width
1805 Shrink or expand current column.
1807 If a width cookie specifies a width W for the column, shrinking
1808 it displays the first W visible characters only. Otherwise, the
1809 column is shrunk to a single character.
1811 When called before the first column or after the last one, ask
1812 for a list of column ranges to operate on.
1814 - {{{kbd(C-u C-c TAB)}}} (~org-table-shrink~) ::
1816 #+kindex: C-u C-c TAB
1817 #+findex: org-table-shrink
1818 Shrink all columns with a column width. Expand the others.
1820 - {{{kbd(C-u C-u C-c TAB)}}} (~org-table-expand~) ::
1822 #+kindex: C-u C-u C-c TAB
1823 #+findex: org-table-expand
1826 To see the full text of a shrunk field, hold the mouse over it:
1827 a tool-tip window then shows the full contents of the field.
1828 Alternatively, {{{kbd(C-h .)}}} (~display-local-help~) reveals them,
1829 too. For convenience, any change near the shrunk part of a column
1832 #+vindex: org-startup-shrink-all-tables
1833 Setting the option ~org-startup-shrink-all-tables~ shrinks all columns
1834 containing a width cookie in a file the moment it is visited. You can
1835 also set this option on a per-file basis with:
1839 If you would like to overrule the automatic alignment of number-rich
1840 columns to the right and of string-rich columns to the left, you can
1841 use =<r>=, =<c>= or =<l>= in a similar fashion. You may also combine
1842 alignment and field width like this: =<r10>=.
1844 Lines which only contain these formatting cookies are removed
1845 automatically upon exporting the document.
1849 :DESCRIPTION: Grouping to trigger vertical lines.
1851 #+cindex: grouping columns in tables
1853 When Org exports tables, it does so by default without vertical lines
1854 because that is visually more satisfying in general. Occasionally
1855 however, vertical lines can be useful to structure a table into groups
1856 of columns, much like horizontal lines can do for groups of rows. In
1857 order to specify column groups, you can use a special row where the
1858 first field contains only =/=. The further fields can either contain
1859 =<= to indicate that this column should start a group, =>= to indicate
1860 the end of a column, or =<>= (no space between =<= and =>=) to make
1861 a column a group of its own. Upon export, boundaries between column
1862 groups are marked with vertical lines. Here is an example:
1865 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1866 |---+-----+-----+-----+---------+------------|
1867 | / | < | | > | < | > |
1868 | 1 | 1 | 1 | 1 | 1 | 1 |
1869 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
1870 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
1871 |---+-----+-----+-----+---------+------------|
1872 ,#+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
1875 It is also sufficient to just insert the column group starters after
1876 every vertical line you would like to have:
1879 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
1880 |---+-----+-----+-----+---------+------------|
1884 ** The Orgtbl Minor Mode
1886 :DESCRIPTION: The table editor as minor mode.
1887 :ALT_TITLE: Orgtbl Mode
1889 #+cindex: Orgtbl mode
1890 #+cindex: minor mode for tables
1892 #+findex: orgtbl-mode
1893 If you like the intuitive way the Org table editor works, you might
1894 also want to use it in other modes like Text mode or Mail mode. The
1895 minor mode Orgtbl mode makes this possible. You can always toggle the
1896 mode with {{{kbd(M-x orgtbl-mode)}}}. To turn it on by default, for
1897 example in Message mode, use
1899 #+begin_src emacs-lisp
1900 (add-hook 'message-mode-hook 'turn-on-orgtbl)
1903 Furthermore, with some special setup, it is possible to maintain
1904 tables in arbitrary syntax with Orgtbl mode. For example, it is
1905 possible to construct LaTeX tables with the underlying ease and power
1906 of Orgtbl mode, including spreadsheet capabilities. For details, see
1907 [[*Tables in Arbitrary Syntax]].
1911 :DESCRIPTION: The table editor has spreadsheet capabilities.
1913 #+cindex: calculations, in tables
1914 #+cindex: spreadsheet capabilities
1915 #+cindex: Calc package
1917 The table editor makes use of the Emacs Calc package to implement
1918 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms
1919 to derive fields from other fields. While fully featured, Org's
1920 implementation is not identical to other spreadsheets. For example,
1921 Org knows the concept of a /column formula/ that will be applied to
1922 all non-header fields in a column without having to copy the formula
1923 to each relevant field. There is also a formula debugger, and
1924 a formula editor with features for highlighting fields in the table
1925 corresponding to the references at the point in the formula, moving
1926 these references by arrow keys.
1930 :DESCRIPTION: How to refer to another field or range.
1932 #+cindex: references
1934 To compute fields in the table from other fields, formulas must
1935 reference other fields or ranges. In Org, fields can be referenced by
1936 name, by absolute coordinates, and by relative coordinates. To find
1937 out what the coordinates of a field are, press {{{kbd(C-c ?)}}} in
1938 that field, or press {{{kbd(C-c })}}} to toggle the display of a grid.
1940 **** Field references
1945 #+cindex: field references
1946 #+cindex: references, to fields
1947 Formulas can reference the value of another field in two ways. Like
1948 in any other spreadsheet, you may reference fields with
1949 a letter/number combination like =B3=, meaning the second field in the
1950 third row. However, Org prefers to use another, more general
1951 representation that looks like this:[fn:20]
1955 Column specifications can be absolute like =$1=, =$2=, ..., =$N=, or
1956 relative to the current column, i.e., the column of the field which is
1957 being computed, like =$+1= or =$-2=. =$<= and =$>= are immutable
1958 references to the first and last column, respectively, and you can use
1959 =$>>>= to indicate the third column from the right.
1961 The row specification only counts data lines and ignores horizontal
1962 separator lines, or "hlines". Like with columns, you can use absolute
1963 row numbers =@1=, =@2=, ..., =@N=, and row numbers relative to the
1964 current row like =@+3= or =@-1=. =@<= and =@>= are immutable
1965 references the first and last row in the table, respectively. You may
1966 also specify the row relative to one of the hlines: =@I= refers to the
1967 first hline, =@II= to the second, etc. =@-I= refers to the first such
1968 line above the current line, =@+I= to the first such line below the
1969 current line. You can also write =@III+2= which is the second data
1970 line after the third hline in the table.
1972 =@0= and =$0= refer to the current row and column, respectively, i.e.,
1973 to the row/column for the field being computed. Also, if you omit
1974 either the column or the row part of the reference, the current
1975 row/column is implied.
1977 Org's references with /unsigned/ numbers are fixed references in the
1978 sense that if you use the same reference in the formula for two
1979 different fields, the same field is referenced each time. Org's
1980 references with /signed/ numbers are floating references because the
1981 same reference operator can reference different fields depending on
1982 the field being calculated by the formula.
1984 Here are a few examples:
1986 #+attr_texinfo: :columns 0.2 0.8
1987 | =@2$3= | 2nd row, 3rd column (same as =C2=) |
1988 | =$5= | column 5 in the current row (same as =E&=) |
1989 | =@2= | current column, row 2 |
1990 | =@-1$-3= | field one row up, three columns to the left |
1991 | =@-I$2= | field just under hline above current row, column 2 |
1992 | =@>$5= | field in the last row, in column 5 |
1994 **** Range references
1999 #+cindex: range references
2000 #+cindex: references, to ranges
2001 You may reference a rectangular range of fields by specifying two
2002 field references connected by two dots =..=. If both fields are in
2003 the current row, you may simply use =$2..$7=, but if at least one
2004 field is in a different row, you need to use the general =@ROW$COLUMN=
2005 format at least for the first field, i.e., the reference must start
2006 with =@= in order to be interpreted correctly. Examples:
2008 #+attr_texinfo: :columns 0.2 0.8
2009 | =$1..$3= | first three fields in the current row |
2010 | =$P..$Q= | range, using column names (see [[*Advanced features]]) |
2011 | =$<<<..$>>= | start in third column, continue to the last but one |
2012 | =@2$1..@4$3= | six fields between these two fields (same as =A2..C4=) |
2013 | =@-1$-2..@-1= | 3 fields in the row above, starting from 2 columns on the left |
2014 | =@I..II= | between first and second hline, short for =@I..@II= |
2016 #+texinfo: @noindent
2017 Range references return a vector of values that can be fed into Calc
2018 vector functions. Empty fields in ranges are normally suppressed, so
2019 that the vector contains only the non-empty fields. For other options
2020 with the mode switches =E=, =N= and examples, see [[*Formula syntax for
2023 **** Field coordinates in formulas
2028 #+cindex: field coordinates
2029 #+cindex: coordinates, of field
2030 #+cindex: row, of field coordinates
2031 #+cindex: column, of field coordinates
2032 #+vindex: org-table-current-column
2033 #+vindex: org-table-current-dline
2034 One of the very first actions during evaluation of Calc formulas and
2035 Lisp formulas is to substitute =@#= and =$#= in the formula with the
2036 row or column number of the field where the current result will go to.
2037 The traditional Lisp formula equivalents are ~org-table-current-dline~
2038 and ~org-table-current-column~. Examples:
2040 - =if(@# % 2, $#, string(""))= ::
2042 Insert column number on odd rows, set field to empty on even
2045 - =$2 = '(identity remote(FOO, @@#$1))= ::
2047 Copy text or values of each row of column 1 of the table named
2048 {{{var(FOO)}}} into column 2 of the current table.
2050 - =@3 = 2 * remote(FOO, @@1$$#)= ::
2052 Insert the doubled value of each column of row 1 of the table
2053 named {{{var(FOO)}}} into row 3 of the current table.
2055 #+texinfo: @noindent
2056 For the second and third examples, table {{{var(FOO)}}} must have at
2057 least as many rows or columns as the current table. Note that this is
2058 inefficient[fn:21] for large number of rows.
2060 **** Named references
2064 #+cindex: named references
2065 #+cindex: references, named
2066 #+cindex: name, of column or field
2067 #+cindex: constants, in calculations
2068 #+cindex: @samp{CONSTANTS}, keyword
2069 #+vindex: org-table-formula-constants
2071 =$name= is interpreted as the name of a column, parameter or constant.
2072 Constants are defined globally through the variable
2073 ~org-table-formula-constants~, and locally---for the file---through
2074 a line like this example:
2076 : #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2078 #+texinfo: @noindent
2079 #+vindex: constants-unit-system
2080 #+pindex: constants.el
2081 Also, properties (see [[*Properties and Columns]]) can be used as
2082 constants in table formulas: for a property =Xyz= use the name
2083 =$PROP_Xyz=, and the property will be searched in the current outline
2084 entry and in the hierarchy above it. If you have the =constants.el=
2085 package, it will also be used to resolve constants, including natural
2086 constants like =$h= for Planck's constant, and units like =$km= for
2087 kilometers[fn:22]. Column names and parameters can be specified in
2088 special table lines. These are described below, see [[*Advanced
2089 features]]. All names must start with a letter, and further consist
2090 of letters and numbers.
2092 **** Remote references
2097 #+cindex: remote references
2098 #+cindex: references, remote
2099 #+cindex: references, to a different table
2100 #+cindex: name, of column or field
2101 #+cindex: @samp{NAME}, keyword
2102 You may also reference constants, fields and ranges from a different
2103 table, either in the current file or even in a different file. The
2108 #+texinfo: @noindent
2109 where {{{var(NAME)}}} can be the name of a table in the current file
2110 as set by a =#+NAME:= line before the table. It can also be the ID of
2111 an entry, even in a different file, and the reference then refers to
2112 the first table in that entry. {{{var(REF)}}} is an absolute field or
2113 range reference as described above for example =@3$3= or =$somename=,
2114 valid in the referenced table.
2116 #+cindex: table indirection
2117 When {{{var(NAME)}}} has the format =@ROW$COLUMN=, it is substituted
2118 with the name or ID found in this field of the current table. For
2119 example =remote($1, @@>$2)= \Rightarrow =remote(year_2013, @@>$1)=. The format
2120 =B3= is not supported because it can not be distinguished from a plain
2123 *** Formula syntax for Calc
2125 :DESCRIPTION: Using Calc to compute stuff.
2127 #+cindex: formula syntax, Calc
2128 #+cindex: syntax, of formulas
2130 A formula can be any algebraic expression understood by the Emacs Calc
2131 package. Note that Calc has the non-standard convention that =/= has
2132 lower precedence than =*=, so that =a/b*c= is interpreted as
2133 =(a/(b*c))=. Before evaluation by ~calc-eval~ (see [[info:calc#Calling Calc from Your Programs][Calling Calc from
2134 Your Lisp Programs]]), variable substitution takes place according to
2135 the rules described above.
2137 #+cindex: vectors, in table calculations
2138 The range vectors can be directly fed into the Calc vector functions
2139 like ~vmean~ and ~vsum~.
2141 #+cindex: format specifier, in spreadsheet
2142 #+cindex: mode, for Calc
2143 #+vindex: org-calc-default-modes
2144 A formula can contain an optional mode string after a semicolon. This
2145 string consists of flags to influence Calc and other modes during
2146 execution. By default, Org uses the standard Calc modes (precision
2147 12, angular units degrees, fraction and symbolic modes off). The
2148 display format, however, has been changed to ~(float 8)~ to keep
2149 tables compact. The default settings can be configured using the
2150 variable ~org-calc-default-modes~.
2154 Set the internal Calc calculation precision to 20 digits.
2156 - =n3=, =s3=, =e2=, =f4= ::
2158 Normal, scientific, engineering or fixed format of the result of
2159 Calc passed back to Org. Calc formatting is unlimited in
2160 precision as long as the Calc calculation precision is greater.
2164 Degree and radian angle modes of Calc.
2168 Fraction and symbolic modes of Calc.
2172 Duration computations in Calc or Lisp, [[*Durations and time
2177 If and how to consider empty fields. Without =E= empty fields in
2178 range references are suppressed so that the Calc vector or Lisp
2179 list contains only the non-empty fields. With =E= the empty
2180 fields are kept. For empty fields in ranges or empty field
2181 references the value =nan= (not a number) is used in Calc
2182 formulas and the empty string is used for Lisp formulas. Add =N=
2183 to use 0 instead for both formula types. For the value of
2184 a field the mode =N= has higher precedence than =E=.
2188 Interpret all fields as numbers, use 0 for non-numbers. See the
2189 next section to see how this is essential for computations with
2190 Lisp formulas. In Calc formulas it is used only occasionally
2191 because there number strings are already interpreted as numbers
2196 Literal, for Lisp formulas only. See the next section.
2198 #+texinfo: @noindent
2199 Unless you use large integer numbers or high-precision calculation and
2200 display for floating point numbers you may alternatively provide
2201 a ~printf~ format specifier to reformat the Calc result after it has
2202 been passed back to Org instead of letting Calc already do the
2203 formatting[fn:23]. A few examples:
2205 | =$1+$2= | Sum of first and second field |
2206 | =$1+$2;%.2f= | Same, format result to two decimals |
2207 | =exp($2)+exp($1)= | Math functions can be used |
2208 | =$0;%.1f= | Reformat current cell to 1 decimal |
2209 | =($3-32)*5/9= | Degrees F \to C conversion |
2210 | =$c/$1/$cm= | Hz \to cm conversion, using =constants.el= |
2211 | =tan($1);Dp3s1= | Compute in degrees, precision 3, display SCI 1 |
2212 | =sin($1);Dp3%.1e= | Same, but use ~printf~ specifier for display |
2213 | =vmean($2..$7)= | Compute column range mean, using vector function |
2214 | =vmean($2..$7);EN= | Same, but treat empty fields as 0 |
2215 | =taylor($3,x=7,2)= | Taylor series of $3, at x=7, second degree |
2217 Calc also contains a complete set of logical operations (see [[info:calc#Logical%20Operations][Logical
2218 Operations]]). For example
2220 - =if($1 < 20, teen, string(""))= ::
2222 ="teen"= if age =$1= is less than 20, else the Org table result
2223 field is set to empty with the empty string.
2225 - =if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E f-1= ::
2227 Sum of the first two columns. When at least one of the input
2228 fields is empty the Org table result field is set to empty. =E=
2229 is required to not convert empty fields to 0. =f-1= is an
2230 optional Calc format string similar to =%.1f= but leaves empty
2233 - =if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E= ::
2235 Mean value of a range unless there is any empty field. Every
2236 field in the range that is empty is replaced by =nan= which lets
2237 =vmean= result in =nan=. Then =typeof == 12= detects the =nan=
2238 from ~vmean~ and the Org table result field is set to empty. Use
2239 this when the sample set is expected to never have missing
2242 - =if("$1..$7" == "[]", string(""), vmean($1..$7))= ::
2244 Mean value of a range with empty fields skipped. Every field in
2245 the range that is empty is skipped. When all fields in the range
2246 are empty the mean value is not defined and the Org table result
2247 field is set to empty. Use this when the sample set can have
2250 - =vmean($1..$7); EN= ::
2252 To complete the example before: Mean value of a range with empty
2253 fields counting as samples with value 0. Use this only when
2254 incomplete sample sets should be padded with 0 to the full size.
2256 You can add your own Calc functions defined in Emacs Lisp with
2257 ~defmath~ and use them in formula syntax for Calc.
2259 *** Emacs Lisp forms as formulas
2261 :DESCRIPTION: Writing formulas in Emacs Lisp.
2262 :ALT_TITLE: Formula syntax for Lisp
2264 #+cindex: Lisp forms, as table formulas
2266 It is also possible to write a formula in Emacs Lisp. This can be
2267 useful for string manipulation and control structures, if Calc's
2268 functionality is not enough.
2270 If a formula starts with a single-quote followed by an opening
2271 parenthesis, then it is evaluated as a Lisp form. The evaluation
2272 should return either a string or a number. Just as with Calc
2273 formulas, you can specify modes and a ~printf~ format after
2276 With Emacs Lisp forms, you need to be conscious about the way field
2277 references are interpolated into the form. By default, a reference is
2278 interpolated as a Lisp string (in double-quotes) containing the field.
2279 If you provide the =N= mode switch, all referenced elements are
2280 numbers---non-number fields will be zero---and interpolated as Lisp
2281 numbers, without quotes. If you provide the =L= flag, all fields are
2282 interpolated literally, without quotes. I.e., if you want a reference
2283 to be interpreted as a string by the Lisp form, enclose the reference
2284 operator itself in double-quotes, like ="$3"=. Ranges are inserted as
2285 space-separated fields, so you can embed them in list or vector
2288 Here are a few examples---note how the =N= mode is used when we do
2289 computations in Lisp:
2291 - ='(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))= ::
2293 Swap the first two characters of the content of column 1.
2297 Add columns 1 and 2, equivalent to Calc's =$1+$2=.
2299 - ='(apply '+ '($1..$4));N= ::
2301 Compute the sum of columns 1 to 4, like Calc's =vsum($1..$4)=.
2303 *** Durations and time values
2305 :DESCRIPTION: How to compute durations and time values.
2307 #+cindex: Duration, computing
2308 #+cindex: Time, computing
2309 #+vindex: org-table-duration-custom-format
2311 If you want to compute time values use the =T=, =t=, or =U= flag,
2312 either in Calc formulas or Elisp formulas:
2315 | Task 1 | Task 2 | Total |
2316 |---------+----------+----------|
2317 | 2:12 | 1:47 | 03:59:00 |
2318 | 2:12 | 1:47 | 03:59 |
2319 | 3:02:20 | -2:07:00 | 0.92 |
2320 ,#+TBLFM: @2$3=$1+$2;T::@3$3=$1+$2;U::@4$3=$1+$2;t
2323 Input duration values must be of the form =HH:MM[:SS]=, where seconds
2324 are optional. With the =T= flag, computed durations are displayed as
2325 =HH:MM:SS= (see the first formula above). With the =U= flag, seconds
2326 are omitted so that the result is only =HH:MM= (see second formula
2327 above). Zero-padding of the hours field depends upon the value of the
2328 variable ~org-table-duration-hour-zero-padding~.
2330 With the =t= flag, computed durations are displayed according to the
2331 value of the option ~org-table-duration-custom-format~, which defaults
2332 to ~hours~ and displays the result as a fraction of hours (see the
2333 third formula in the example above).
2335 Negative duration values can be manipulated as well, and integers are
2336 considered as seconds in addition and subtraction.
2338 *** Field and range formulas
2340 :DESCRIPTION: Formula for specific (ranges of) fields.
2342 #+cindex: field formula
2343 #+cindex: range formula
2344 #+cindex: formula, for individual table field
2345 #+cindex: formula, for range of fields
2347 To assign a formula to a particular field, type it directly into the
2348 field, preceded by =:==, for example =vsum(@II..III)=. When you press
2349 {{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(C-c C-c)}}} with the cursor
2350 still in the field, the formula is stored as the formula for this
2351 field, evaluated, and the current field is replaced with the result.
2353 #+cindex: @samp{TBLFM}, keyword
2354 Formulas are stored in a special =TBLFM= keyword located directly
2355 below the table. If you type the equation in the fourth field of the
2356 third data line in the table, the formula looks like =@3$4=$1+$2=.
2357 When inserting/deleting/swapping column and rows with the appropriate
2358 commands, /absolute references/ (but not relative ones) in stored
2359 formulas are modified in order to still reference the same field. To
2360 avoid this from happening, in particular in range references, anchor
2361 ranges at the table borders (using =@<=, =@>=, =$<=, =$>=), or at
2362 hlines using the =@I= notation. Automatic adaptation of field
2363 references does of course not happen if you edit the table structure
2364 with normal editing commands---then you must fix the equations
2367 Instead of typing an equation into the field, you may also use the
2370 - {{{kbd(C-u C-c =)}}} (~org-table-eval-formula~) ::
2373 #+findex: org-table-eval-formula
2374 Install a new formula for the current field. The command prompts
2375 for a formula with default taken from the =TBLFM= keyword,
2376 applies it to the current field, and stores it.
2378 The left-hand side of a formula can also be a special expression in
2379 order to assign the formula to a number of different fields. There is
2380 no keyboard shortcut to enter such range formulas. To add them, use
2381 the formula editor (see [[*Editing and debugging formulas]]) or edit the
2382 =TBLFM= keyword directly.
2386 Column formula, valid for the entire column. This is so common
2387 that Org treats these formulas in a special way, see [[*Column
2392 Row formula, applies to all fields in the specified row. =@>==
2397 Range formula, applies to all fields in the given rectangular
2398 range. This can also be used to assign a formula to some but not
2399 all fields in a row.
2403 Named field, see [[*Advanced features]].
2407 :DESCRIPTION: Formulas valid for an entire column.
2409 #+cindex: column formula
2410 #+cindex: formula, for table column
2412 When you assign a formula to a simple column reference like =$3==, the
2413 same formula is used in all fields of that column, with the following
2414 very convenient exceptions: (i) If the table contains horizontal
2415 separator hlines with rows above and below, everything before the
2416 first such hline is considered part of the table /header/ and is not
2417 modified by column formulas. Therefore a header is mandatory when you
2418 use column formulas and want to add hlines to group rows, like for
2419 example to separate a total row at the bottom from the summand rows
2420 above. (ii) Fields that already get a value from a field/range
2421 formula are left alone by column formulas. These conditions make
2422 column formulas very easy to use.
2424 To assign a formula to a column, type it directly into any field in
2425 the column, preceded by an equal sign, like ==$1+$2=. When you press
2426 {{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(C-c C-c)}}} with the cursor
2427 still in the field, the formula is stored as the formula for the
2428 current column, evaluated and the current field replaced with the
2429 result. If the field contains only ===, the previously stored formula
2430 for this column is used. For each column, Org only remembers the most
2431 recently used formula. In the =TBLFM= keyword, column formulas look
2432 like =$4=$1+$2=. The left-hand side of a column formula can not be
2433 the name of column, it must be the numeric column reference or =$>=.
2435 Instead of typing an equation into the field, you may also use the
2438 - {{{kbd(C-c =)}}} (~org-table-eval-formula~) ::
2441 #+findex: org-table-eval-formula
2442 Install a new formula for the current column and replace current
2443 field with the result of the formula. The command prompts for
2444 a formula, with default taken from the =TBLFM= keyword, applies
2445 it to the current field and stores it. With a numeric prefix
2446 argument, e.g., {{{kbd(C-5 C-c =)}}}, the command applies it to
2447 that many consecutive fields in the current column.
2449 *** Lookup functions
2451 :DESCRIPTION: Lookup functions for searching tables.
2453 #+cindex: lookup functions in tables
2454 #+cindex: table lookup functions
2456 Org has three predefined Emacs Lisp functions for lookups in tables.
2458 - ~(org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)~ ::
2460 #+findex: org-lookup-first
2461 Searches for the first element {{{var(S)}}} in list
2462 {{{var(S-LIST)}}} for which
2463 #+begin_src emacs-lisp
2466 is non-~nil~; returns the value from the corresponding position
2467 in list {{{var(R-LIST)}}}. The default {{{var(PREDICATE)}}} is
2468 ~equal~. Note that the parameters {{{var(VAL)}}} and
2469 {{{var(S)}}} are passed to {{{var(PREDICATE)}}} in the same order
2470 as the corresponding parameters are in the call to
2471 ~org-lookup-first~, where {{{var(VAL)}}} precedes
2472 {{{var(S-LIST)}}}. If {{{var(R-LIST)}}} is ~nil~, the matching
2473 element {{{var(S)}}} of {{{var(S-LIST)}}} is returned.
2475 - ~(org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)~ ::
2477 #+findex: org-lookup-last
2478 Similar to ~org-lookup-first~ above, but searches for the /last/
2479 element for which {{{var(PREDICATE)}}} is non-~nil~.
2481 - ~(org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)~ ::
2483 #+findex: org-lookup-all
2484 Similar to ~org-lookup-first~, but searches for /all/ elements
2485 for which {{{var(PREDICATE)}}} is non-~nil~, and returns /all/
2486 corresponding values. This function can not be used by itself in
2487 a formula, because it returns a list of values. However,
2488 powerful lookups can be built when this function is combined with
2489 other Emacs Lisp functions.
2491 If the ranges used in these functions contain empty fields, the =E=
2492 mode for the formula should usually be specified: otherwise empty
2493 fields are not included in {{{var(S-LIST)}}} and/or {{{var(R-LIST)}}}
2494 which can, for example, result in an incorrect mapping from an element
2495 of {{{var(S-LIST)}}} to the corresponding element of
2498 These three functions can be used to implement associative arrays,
2499 count matching cells, rank results, group data, etc. For practical
2500 examples see [[https://orgmode.org/worg/org-tutorials/org-lookups.html][this tutorial on Worg]].
2502 *** Editing and debugging formulas
2504 :DESCRIPTION: Fixing formulas.
2506 #+cindex: formula editing
2507 #+cindex: editing, of table formulas
2509 #+vindex: org-table-use-standard-references
2510 You can edit individual formulas in the minibuffer or directly in the
2511 field. Org can also prepare a special buffer with all active formulas
2512 of a table. When offering a formula for editing, Org converts
2513 references to the standard format (like =B3= or =D&=) if possible. If
2514 you prefer to only work with the internal format (like =@3$2= or
2515 =$4=), configure the variable ~org-table-use-standard-references~.
2517 - {{{kbd(C-c =)}}} or {{{kbd(C-u C-c =)}}} (~org-table-eval-formula~) ::
2521 #+findex: org-table-eval-formula
2522 Edit the formula associated with the current column/field in the
2523 minibuffer. See [[*Column formulas]], and [[*Field and range formulas]].
2525 - {{{kbd(C-u C-u C-c =)}}} (~org-table-eval-formula~) ::
2527 #+kindex: C-u C-u C-c =
2528 #+findex: org-table-eval-formula
2529 Re-insert the active formula (either a field formula, or a column
2530 formula) into the current field, so that you can edit it directly
2531 in the field. The advantage over editing in the minibuffer is
2532 that you can use the command {{{kbd(C-c ?)}}}.
2534 - {{{kbd(C-c ?)}}} (~org-table-field-info~) ::
2537 #+findex: org-table-field-info
2538 While editing a formula in a table field, highlight the field(s)
2539 referenced by the reference at the cursor position in the
2542 - {{{kbd(C-c })}}} (~org-table-toggle-coordinate-overlays~) ::
2545 #+findex: org-table-toggle-coordinate-overlays
2546 Toggle the display of row and column numbers for a table, using
2547 overlays. These are updated each time the table is aligned; you
2548 can force it with {{{kbd(C-c C-c)}}}.
2550 - {{{kbd(C-c {)}}} (~org-table-toggle-formula-debugger~) ::
2553 #+findex: org-table-toggle-formula-debugger
2554 Toggle the formula debugger on and off. See below.
2556 - {{{kbd(C-c ')}}} (~org-table-edit-formulas~) ::
2559 #+findex: org-table-edit-formulas
2560 Edit all formulas for the current table in a special buffer,
2561 where the formulas are displayed one per line. If the current
2562 field has an active formula, the cursor in the formula editor
2563 marks it. While inside the special buffer, Org automatically
2564 highlights any field or range reference at the cursor position.
2565 You may edit, remove and add formulas, and use the following
2568 - {{{kbd(C-c C-c)}}} or {{{kbd(C-x C-s)}}} (~org-table-fedit-finish~) ::
2572 #+findex: org-table-fedit-finish
2573 Exit the formula editor and store the modified formulas. With
2574 {{{kbd(C-u)}}} prefix, also apply the new formulas to the
2577 - {{{kbd(C-c C-q)}}} (~org-table-fedit-abort~) ::
2580 #+findex: org-table-fedit-abort
2581 Exit the formula editor without installing changes.
2583 - {{{kbd(C-c C-r)}}} (~org-table-fedit-toggle-ref-type~) ::
2586 #+findex: org-table-fedit-toggle-ref-type
2587 Toggle all references in the formula editor between standard
2588 (like =B3=) and internal (like =@3$2=).
2590 - {{{kbd(TAB)}}} (~org-table-fedit-lisp-indent~) ::
2593 #+findex: org-table-fedit-lisp-indent
2594 Pretty-print or indent Lisp formula at point. When in a line
2595 containing a Lisp formula, format the formula according to
2596 Emacs Lisp rules. Another {{{kbd(TAB)}}} collapses the formula
2597 back again. In the open formula, {{{kbd(TAB)}}} re-indents
2598 just like in Emacs Lisp mode.
2600 - {{{kbd(M-TAB)}}} (~lisp-complete-symbol~) ::
2603 #+findex: lisp-complete-symbol
2604 Complete Lisp symbols, just like in Emacs Lisp mode.
2606 - {{{kbd(S-UP)}}}, {{{kbd(S-DOWN)}}}, {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} ::
2612 #+findex: org-table-fedit-ref-up
2613 #+findex: org-table-fedit-ref-down
2614 #+findex: org-table-fedit-ref-left
2615 #+findex: org-table-fedit-ref-right
2616 Shift the reference at point. For example, if the reference
2617 is =B3= and you press {{{kbd(S-RIGHT)}}}, it becomes =C3=.
2618 This also works for relative references and for hline
2621 - {{{kbd(M-S-UP)}}} (~org-table-fedit-line-up~) ::
2624 #+findex: org-table-fedit-line-up
2625 Move the test line for column formulas up in the Org buffer.
2627 - {{{kbd(M-S-DOWN)}}} (~org-table-fedit-line-down~) ::
2630 #+findex: org-table-fedit-line-down
2631 Move the test line for column formulas down in the Org buffer.
2633 - {{{kbd(M-UP)}}} (~org-table-fedit-scroll-up~) ::
2636 #+findex: org-table-fedit-scroll-up
2637 Scroll up the window displaying the table.
2639 - {{{kbd(M-DOWN)}}} (~org-table-fedit-scroll-down~) ::
2642 #+findex: org-table-fedit-scroll-down
2643 Scroll down the window displaying the table.
2645 - {{{kbd(C-c })}}} ::
2648 #+findex: org-table-toggle-coordinate-overlays
2649 Turn the coordinate grid in the table on and off.
2651 Making a table field blank does not remove the formula associated with
2652 the field, because that is stored in a different line---the =TBLFM=
2653 keyword line. During the next recalculation, the field will be filled
2654 again. To remove a formula from a field, you have to give an empty
2655 reply when prompted for the formula, or to edit the =TBLFM= keyword.
2658 You may edit the =TBLFM= keyword directly and re-apply the changed
2659 equations with {{{kbd(C-c C-c)}}} in that line or with the normal
2660 recalculation commands in the table.
2662 **** Using multiple =TBLFM= lines
2666 #+cindex: multiple formula lines
2667 #+cindex: @samp{TBLFM} keywords, multiple
2668 #+cindex: @samp{TBLFM}, switching
2671 You may apply the formula temporarily. This is useful when you switch
2672 the formula. Place multiple =TBLFM= keywords right after the table,
2673 and then press {{{kbd(C-c C-c)}}} on the formula to apply. Here is an
2685 #+texinfo: @noindent
2686 Pressing {{{kbd(C-c C-c)}}} in the line of =#+TBLFM: $2=$1*2= yields:
2697 #+texinfo: @noindent
2698 Note: If you recalculate this table, with {{{kbd(C-u C-c *)}}}, for
2699 example, you get the following result of applying only the first
2711 **** Debugging formulas
2715 #+cindex: formula debugging
2716 #+cindex: debugging, of table formulas
2718 When the evaluation of a formula leads to an error, the field content
2719 becomes the string =#ERROR=. If you would like to see what is going
2720 on during variable substitution and calculation in order to find
2721 a bug, turn on formula debugging in the Tbl menu and repeat the
2722 calculation, for example by pressing {{{kbd(C-u C-u C-c = RET)}}} in
2723 a field. Detailed information are displayed.
2725 *** Updating the table
2727 :DESCRIPTION: Recomputing all dependent fields.
2729 #+cindex: recomputing table fields
2730 #+cindex: updating, table
2732 Recalculation of a table is normally not automatic, but needs to be
2733 triggered by a command. To make recalculation at least
2734 semi-automatic, see [[*Advanced features]].
2736 In order to recalculate a line of a table or the entire table, use the
2739 - {{{kbd(C-c *)}}} (~org-table-recalculate~) ::
2742 #+findex: org-table-recalculate
2743 Recalculate the current row by first applying the stored column
2744 formulas from left to right, and all field/range formulas in the
2747 - {{{kbd(C-u C-c *)}}} or {{{kbd(C-u C-c C-c)}}} ::
2750 #+kindex: C-u C-c C-c
2751 Recompute the entire table, line by line. Any lines before the
2752 first hline are left alone, assuming that these are part of the
2755 - {{{kbd(C-u C-u C-c *)}}} or {{{kbd(C-u C-u C-c C-c)}}} (~org-table-iterate~) ::
2757 #+kindex: C-u C-u C-c *
2758 #+kindex: C-u C-u C-c C-c
2759 #+findex: org-table-iterate
2760 Iterate the table by recomputing it until no further changes
2761 occur. This may be necessary if some computed fields use the
2762 value of other fields that are computed /later/ in the
2763 calculation sequence.
2765 - {{{kbd(M-x org-table-recalculate-buffer-tables)}}} ::
2767 #+findex: org-table-recalculate-buffer-tables
2768 Recompute all tables in the current buffer.
2770 - {{{kbd(M-x org-table-iterate-buffer-tables)}}} ::
2772 #+findex: org-table-iterate-buffer-tables
2773 Iterate all tables in the current buffer, in order to converge
2774 table-to-table dependencies.
2776 *** Advanced features
2778 :DESCRIPTION: Field and column names, automatic recalculation...
2781 If you want the recalculation of fields to happen automatically, or if
2782 you want to be able to assign /names/[fn:24] to fields and columns,
2783 you need to reserve the first column of the table for special marking
2786 - {{{kbd(C-#)}}} (~org-table-rotate-recalc-marks~) ::
2789 #+findex: org-table-rotate-recalc-marks
2790 Rotate the calculation mark in first column through the states
2791 =#=, =*=, =!=, =$=. When there is an active region, change all
2792 marks in the region.
2794 Here is an example of a table that collects exam results of students
2795 and makes use of these features:
2798 |---+---------+--------+--------+--------+-------+------|
2799 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2800 |---+---------+--------+--------+--------+-------+------|
2801 | ! | | P1 | P2 | P3 | Tot | |
2802 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2803 | ^ | | m1 | m2 | m3 | mt | |
2804 |---+---------+--------+--------+--------+-------+------|
2805 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2806 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2807 |---+---------+--------+--------+--------+-------+------|
2808 | | Average | | | | 25.0 | |
2809 | ^ | | | | | at | |
2810 | $ | max=50 | | | | | |
2811 |---+---------+--------+--------+--------+-------+------|
2812 ,#+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@-II..@-I);%.1f
2815 #+texinfo: @noindent
2816 *Important*: please note that for these special tables, recalculating
2817 the table with {{{kbd(C-u C-c *)}}} only affects rows that are marked
2818 =#= or =*=, and fields that have a formula assigned to the field
2819 itself. The column formulas are not applied in rows with empty first
2822 #+cindex: marking characters, tables
2823 The marking characters have the following meaning:
2827 The fields in this line define names for the columns, so that you
2828 may refer to a column as =$Tot= instead of =$6=.
2832 This row defines names for the fields /above/ the row. With such
2833 a definition, any formula in the table may use =$m1= to refer to
2834 the value =10=. Also, if you assign a formula to a names field,
2835 it is stored as =$name = ...=.
2839 Similar to =^=, but defines names for the fields in the row
2844 Fields in this row can define /parameters/ for formulas. For
2845 example, if a field in a =$= row contains =max=50=, then formulas
2846 in this table can refer to the value 50 using =$max=. Parameters
2847 work exactly like constants, only that they can be defined on
2852 Fields in this row are automatically recalculated when pressing
2853 {{{kbd(TAB)}}} or {{{kbd(RET)}}} or {{{kbd(S-TAB)}}} in this row.
2854 Also, this row is selected for a global recalculation with
2855 {{{kbd(C-u C-c *)}}}. Unmarked lines are left alone by this
2860 Selects this line for global recalculation with {{{kbd(C-u C-c
2861 *)}}}, but not for automatic recalculation. Use this when
2862 automatic recalculation slows down editing too much.
2866 Do not export this line. Useful for lines that contain the
2867 narrowing =<N>= markers or column group markers.
2869 Finally, just to whet your appetite for what can be done with the
2870 fantastic Calc package, here is a table that computes the Taylor
2871 series of degree n at location x for a couple of functions.
2874 |---+-------------+---+-----+--------------------------------------|
2875 | | Func | n | x | Result |
2876 |---+-------------+---+-----+--------------------------------------|
2877 | # | exp(x) | 1 | x | 1 + x |
2878 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2879 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2880 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2881 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2882 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2883 |---+-------------+---+-----+--------------------------------------|
2884 ,#+TBLFM: $5=taylor($2,$4,$3);n3
2889 :DESCRIPTION: Plotting from Org tables.
2891 #+cindex: graph, in tables
2892 #+cindex: plot tables using Gnuplot
2894 Org Plot can produce graphs of information stored in Org tables,
2895 either graphically or in ASCII art.
2897 *** Graphical plots using Gnuplot
2902 #+cindex: @samp{PLOT}, keyword
2903 Org Plot can produce 2D and 3D graphs of information stored in Org
2904 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
2905 that you have both Gnuplot and Gnuplot mode installed on your system,
2906 then call {{{kbd(C-c \quot g)}}} or {{{kbd(M-x org-plot/gnuplot)}}} on the
2910 ,#+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2911 | Sede | Max cites | H-index |
2912 |-----------+-----------+---------|
2913 | Chile | 257.72 | 21.39 |
2914 | Leeds | 165.77 | 19.68 |
2915 | Sao Paolo | 71.00 | 11.50 |
2916 | Stockholm | 134.19 | 14.33 |
2917 | Morelia | 257.56 | 17.67 |
2920 Notice that Org Plot is smart enough to apply the table's headers as
2921 labels. Further control over the labels, type, content, and
2922 appearance of plots can be exercised through the =PLOT= keyword
2923 preceding a table. See below for a complete list of Org Plot options.
2924 For more information and examples see the [[https://orgmode.org/worg/org-tutorials/org-plot.html][Org Plot tutorial]].
2933 Specify any Gnuplot option to be set when graphing.
2937 Specify the title of the plot.
2941 Specify which column of the table to use as the =x= axis.
2945 Specify the columns to graph as a Lisp style list, surrounded by
2946 parentheses and separated by spaces for example =dep:(3 4)= to
2947 graph the third and fourth columns. Defaults to graphing all
2948 other columns aside from the =ind= column.
2952 Specify whether the plot is =2d=, =3d=, or =grid=.
2956 Specify a =with= option to be inserted for every column being
2957 plotted, e.g., =lines=, =points=, =boxes=, =impulses=. Defaults
2962 If you want to plot to a file, specify
2963 ="path/to/desired/output-file"=.
2967 List of labels to be used for the =deps=. Defaults to the column
2968 headers if they exist.
2972 Specify an entire line to be inserted in the Gnuplot script.
2976 When plotting =3d= or =grid= types, set this to =t= to graph
2977 a flat mapping rather than a =3d= slope.
2981 Specify format of Org mode timestamps as they will be parsed by
2982 Gnuplot. Defaults to =%Y-%m-%d-%H:%M:%S=.
2986 If you want total control, you can specify a script file---place
2987 the file name between double-quotes---which will be used to plot.
2988 Before plotting, every instance of =$datafile= in the specified
2989 script will be replaced with the path to the generated data file.
2990 Note: even if you set this option, you may still want to specify
2991 the plot type, as that can impact the content of the data file.
2998 While the cursor is on a column, typing {{{kbd(C-c " a)}}} or
2999 {{{kbd(M-x orgtbl-ascii-plot)}}} create a new column containing an
3000 ASCII-art bars plot. The plot is implemented through a regular column
3001 formula. When the source column changes, the bar plot may be updated
3002 by refreshing the table, for example typing {{{kbd(C-u C-c *)}}}.
3005 | Sede | Max cites | |
3006 |---------------+-----------+--------------|
3007 | Chile | 257.72 | WWWWWWWWWWWW |
3008 | Leeds | 165.77 | WWWWWWWh |
3009 | Sao Paolo | 71.00 | WWW; |
3010 | Stockholm | 134.19 | WWWWWW: |
3011 | Morelia | 257.56 | WWWWWWWWWWWH |
3012 | Rochefourchat | 0.00 | |
3013 ,#+TBLFM: $3='(orgtbl-ascii-draw $2 0.0 257.72 12)
3016 The formula is an Elisp call.
3018 #+attr_texinfo: :options orgtbl-ascii-draw value min max &optional width
3020 Draw an ASCII bar in a table.
3022 {{{var(VALUE)}}} is the value to plot.
3024 {{{var(MIN)}}} is the value displayed as an empty bar. {{{var(MAX)}}}
3025 is the value filling all the {{{var(WIDTH)}}}. Sources values outside
3026 this range are displayed as =too small= or =too large=.
3028 {{{var(WIDTH)}}} is the number of characters of the bar plot. It
3034 :DESCRIPTION: Notes in context.
3036 #+cindex: hyperlinks
3038 Like HTML, Org provides links inside a file, external links to
3039 other files, Usenet articles, emails, and much more.
3043 :DESCRIPTION: How links in Org are formatted.
3045 #+cindex: link format
3046 #+cindex: format, of links
3048 Org recognizes plain URL-like links and activate them as clickable
3049 links. The general link format, however, looks like this:
3051 : [[LINK][DESCRIPTION]]
3053 #+texinfo: @noindent
3058 #+texinfo: @noindent
3059 Once a link in the buffer is complete (all brackets present), Org
3060 changes the display so that =DESCRIPTION= is displayed instead of
3061 =[[LINK][DESCRIPTION]]= and =LINK= is displayed instead of =[[LINK]]=. Links are be
3062 highlighted in the face ~org-link~, which by default is an underlined
3063 face. You can directly edit the visible part of a link. Note that
3064 this can be either the LINK part, if there is no description, or the
3065 {{{var(DESCRIPTION)}}} part. To edit also the invisible
3066 {{{var(LINK)}}} part, use {{{kbd(C-c C-l)}}} with the cursor on the
3069 If you place the cursor at the beginning or just behind the end of the
3070 displayed text and press {{{kbd(BS)}}}, you remove
3071 the---invisible---bracket at that location. This makes the link
3072 incomplete and the internals are again displayed as plain text.
3073 Inserting the missing bracket hides the link internals again. To show
3074 the internal structure of all links, use the menu: Org \rarr Hyperlinks \rarr
3079 :DESCRIPTION: Links to other places in the current file.
3081 #+cindex: internal links
3082 #+cindex: links, internal
3083 #+cindex: targets, for links
3085 #+cindex: @samp{CUSTOM_ID}, property
3086 If the link does not look like a URL, it is considered to be internal
3087 in the current file. The most important case is a link like
3088 =[[#my-custom-id]]= which links to the entry with the =CUSTOM_ID= property
3089 =my-custom-id=. You are responsible yourself to make sure these
3090 custom IDs are unique in a file.
3092 Links such as =[[My Target]]= or =[[My Target][Find my target]]= lead to a text search in
3095 The link can be followed with {{{kbd(C-c C-o)}}} when the cursor is on
3096 the link, or with a mouse click (see [[*Handling Links]]). Links to
3097 custom IDs point to the corresponding headline. The preferred match
3098 for a text link is a /dedicated target/: the same string in double
3099 angular brackets, like =<<My Target>>=.
3101 #+cindex: @samp{NAME}, keyword
3102 If no dedicated target exists, the link tries to match the exact name
3103 of an element within the buffer. Naming is done with the =NAME=
3104 keyword, which has to be put in the line before the element it refers
3105 to, as in the following example
3114 If none of the above succeeds, Org searches for a headline that is
3115 exactly the link text but may also include a TODO keyword and
3118 During export, internal links are used to mark objects and assign them
3119 a number. Marked objects are then referenced by links pointing to
3120 them. In particular, links without a description appear as the number
3121 assigned to the marked object[fn:26]. In the following excerpt from
3126 2. <<target>>another item
3127 Here we refer to item [[target]].
3130 #+texinfo: @noindent
3131 The last sentence will appear as =Here we refer to item 2= when
3134 In non-Org files, the search looks for the words in the link text. In
3135 the above example the search would be for =target=.
3137 Following a link pushes a mark onto Org's own mark ring. You can
3138 return to the previous position with {{{kbd(C-c &)}}}. Using this
3139 command several times in direct succession goes back to positions
3144 :DESCRIPTION: Make targets trigger links in plain text.
3146 #+cindex: radio targets
3147 #+cindex: targets, radio
3148 #+cindex: links, radio targets
3150 Org can automatically turn any occurrences of certain target names in
3151 normal text into a link. So without explicitly creating a link, the
3152 text connects to the target radioing its position. Radio targets are
3153 enclosed by triple angular brackets. For example, a target =<<<My
3154 Target>>>= causes each occurrence of =my target= in normal text to
3155 become activated as a link. The Org file is scanned automatically for
3156 radio targets only when the file is first loaded into Emacs. To
3157 update the target list during editing, press {{{kbd(C-c C-c)}}} with
3158 the cursor on or at a target.
3162 :DESCRIPTION: URL-like links to the world.
3164 #+cindex: links, external
3165 #+cindex: external links
3166 #+cindex: Gnus links
3167 #+cindex: BBDB links
3170 #+cindex: file links
3171 #+cindex: Rmail links
3172 #+cindex: MH-E links
3173 #+cindex: Usenet links
3174 #+cindex: shell links
3175 #+cindex: Info links
3176 #+cindex: Elisp links
3178 Org supports links to files, websites, Usenet and email messages, BBDB
3179 database entries and links to both IRC conversations and their logs.
3180 External links are URL-like locators. They start with a short
3181 identifying string followed by a colon. There can be no space after
3182 the colon. The following list shows examples for each link type.
3184 | =http://www.astro.uva.nl/=dominik= | on the web |
3185 | =doi:10.1000/182= | DOI for an electronic resource |
3186 | =file:/home/dominik/images/jupiter.jpg= | file, absolute path |
3187 | =/home/dominik/images/jupiter.jpg= | same as above |
3188 | =file:papers/last.pdf= | file, relative path |
3189 | =./papers/last.pdf= | same as above |
3190 | =file:/ssh:me@some.where:papers/last.pdf= | file, path on remote machine |
3191 | =/ssh:me@some.where:papers/last.pdf= | same as above |
3192 | =file:sometextfile::NNN= | file, jump to line number |
3193 | =file:projects.org= | another Org file |
3194 | =file:projects.org::some words= | text search in Org file[fn:27] |
3195 | =file:projects.org::*task title= | heading search in Org file |
3196 | =file+sys:/path/to/file= | open via OS, like double-click |
3197 | =file+emacs:/path/to/file= | force opening by Emacs |
3198 | =docview:papers/last.pdf::NNN= | open in doc-view mode at page |
3199 | =id:B7423F4D-2E8A-471B-8810-C40F074717E9= | Link to heading by ID |
3200 | =news:comp.emacs= | Usenet link |
3201 | =mailto:adent@galaxy.net= | Mail link |
3202 | =mhe:folder= | MH-E folder link |
3203 | =mhe:folder#id= | MH-E message link |
3204 | =rmail:folder= | Rmail folder link |
3205 | =rmail:folder#id= | Rmail message link |
3206 | =gnus:group= | Gnus group link |
3207 | =gnus:group#id= | Gnus article link |
3208 | =bbdb:R.*Stallman= | BBDB link (with regexp) |
3209 | =irc:/irc.com/#emacs/bob= | IRC link |
3210 | =info:org#External links= | Info node link |
3211 | =shell:ls *.org= | A shell command |
3212 | =elisp:org-agenda= | Interactive Elisp command |
3213 | =elisp:(find-file-other-frame "Elisp.org")= | Elisp form to evaluate |
3216 #+cindex: Wanderlust links
3217 On top of these built-in link types, some are available through the
3218 =contrib/= directory (see [[*Installation]]). For example, these links to
3219 VM or Wanderlust messages are available when you load the
3220 corresponding libraries from the =contrib/= directory:
3222 | =vm:folder= | VM folder link |
3223 | =vm:folder#id= | VM message link |
3224 | =vm://myself@some.where.org/folder#id= | VM on remote machine |
3225 | =vm-imap:account:folder= | VM IMAP folder link |
3226 | =vm-imap:account:folder#id= | VM IMAP message link |
3227 | =wl:folder= | Wanderlust folder link |
3228 | =wl:folder#id= | Wanderlust message link |
3230 For customizing Org to add new link types, see [[*Adding Hyperlink
3233 A link should be enclosed in double brackets and may contain
3234 a descriptive text to be displayed instead of the URL (see [[*Link
3235 Format]]), for example:
3237 : [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3239 #+texinfo: @noindent
3240 If the description is a file name or URL that points to an image, HTML
3241 export (see [[*HTML Export]]) inlines the image as a clickable button. If
3242 there is no description at all and the link points to an image, that
3243 image is inlined into the exported HTML file.
3245 #+cindex: square brackets, around links
3246 #+cindex: angular brackets, around links
3247 #+cindex: plain text external links
3248 Org also finds external links in the normal text and activates them as
3249 links. If spaces must be part of the link (for example in
3250 =bbdb:Richard Stallman=), or if you need to remove ambiguities about
3251 the end of the link, enclose them in square or angular brackets.
3255 :DESCRIPTION: Creating, inserting and following.
3257 #+cindex: links, handling
3259 Org provides methods to create a link in the correct syntax, to insert
3260 it into an Org file, and to follow the link.
3262 #+findex: org-store-link
3263 #+cindex: storing links
3264 The main function is ~org-store-link~, called with {{{kbd(M-x
3265 org-store-link)}}}. Because of its importance, we suggest to bind it
3266 to a widely available key (see [[*Activation]]). It stores a link to the
3267 current location. The link is stored for later insertion into an Org
3268 buffer---see below. What kind of link is created depends on the
3271 - /Org mode buffers/ ::
3273 For Org files, if there is a =<<target>>= at the cursor, the link
3274 points to the target. Otherwise it points to the current
3275 headline, which is also the description[fn:28].
3277 #+vindex: org-link-to-org-use-id
3278 #+cindex: @samp{CUSTOM_ID}, property
3279 #+cindex: @samp{ID}, property
3280 If the headline has a =CUSTOM_ID= property, store a link to this
3281 custom ID. In addition or alternatively, depending on the value
3282 of ~org-link-to-org-use-id~, create and/or use a globally unique
3283 ID property for the link[fn:29]. So using this command in Org
3284 buffers potentially creates two links: a human-readable link from
3285 the custom ID, and one that is globally unique and works even if
3286 the entry is moved from file to file. Later, when inserting the
3287 link, you need to decide which one to use.
3289 - /Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus/ ::
3291 Pretty much all Emacs mail clients are supported. The link
3292 points to the current article, or, in some Gnus buffers, to the
3293 group. The description is constructed from the author and the
3296 - /Web browsers: W3, W3M and EWW/ ::
3298 Here the link is the current URL, with the page title as
3301 - /Contacts: BBDB/ ::
3303 Links created in a BBDB buffer point to the current entry.
3307 #+vindex: org-irc-links-to-logs
3308 For IRC links, if the variable ~org-irc-link-to-logs~ is
3309 non-~nil~, create a =file= style link to the relevant point in
3310 the logs for the current conversation. Otherwise store an =irc=
3311 style link to the user/channel/server under the point.
3315 For any other file, the link points to the file, with a search
3316 string (see [[*Search Options in File Links]]) pointing to the
3317 contents of the current line. If there is an active region, the
3318 selected words form the basis of the search string. If the
3319 automatically created link is not working correctly or accurately
3320 enough, you can write custom functions to select the search
3321 string and to do the search for particular file types (see
3322 [[*Custom Searches]]).
3324 You can also define dedicated links to other files. See [[*Adding
3329 When the cursor is in an agenda view, the created link points to
3330 the entry referenced by the current line.
3332 From an Org buffer, the following commands create, navigate or, more
3333 generally, act on links.
3335 #+attr_texinfo: :sep ,
3336 - {{{kbd(C-c C-l)}}} (~org-insert-link~) ::
3339 #+findex: org-insert-link
3340 #+cindex: link completion
3341 #+cindex: completion, of links
3342 #+cindex: inserting links
3343 #+vindex: org-keep-stored-link-after-insertion
3344 Insert a link[fn:30]. This prompts for a link to be inserted
3345 into the buffer. You can just type a link, using text for an
3346 internal link, or one of the link type prefixes mentioned in the
3347 examples above. The link is inserted into the buffer, along with
3348 a descriptive text[fn:31]. If some text was selected at this
3349 time, it becomes the default description.
3351 - /Inserting stored links/ ::
3353 All links stored during the current session are part of the
3354 history for this prompt, so you can access them with
3355 {{{kbd(UP)}}} and {{{kbd(DOWN)}}} (or {{{kbd(M-p)}}},
3358 - /Completion support/ ::
3360 Completion with {{{kbd(TAB)}}} helps you to insert valid link
3361 prefixes like =http= or =ftp=, including the prefixes defined
3362 through link abbreviations (see [[*Link Abbreviations]]). If you
3363 press {{{kbd(RET)}}} after inserting only the prefix, Org
3364 offers specific completion support for some link types[fn:32].
3365 For example, if you type {{{kbd(f i l e RET)}}}---alternative
3366 access: {{{kbd(C-u C-c C-l)}}}, see below---Org offers file
3367 name completion, and after {{{kbd(b b d b RET)}}} you can
3368 complete contact names.
3370 - {{{kbd(C-u C-c C-l)}}} ::
3372 #+cindex: file name completion
3373 #+cindex: completion, of file names
3374 #+kindex: C-u C-c C-l
3375 When {{{kbd(C-c C-l)}}} is called with a {{{kbd(C-u)}}} prefix
3376 argument, insert a link to a file. You may use file name
3377 completion to select the name of the file. The path to the file
3378 is inserted relative to the directory of the current Org file, if
3379 the linked file is in the current directory or in a sub-directory
3380 of it, or if the path is written relative to the current
3381 directory using =../=. Otherwise an absolute path is used, if
3382 possible with =~/= for your home directory. You can force an
3383 absolute path with two {{{kbd(C-u)}}} prefixes.
3385 - {{{kbd(C-c C-l)}}} (with cursor on existing link) ::
3387 #+cindex: following links
3388 When the cursor is on an existing link, {{{kbd(C-c C-l)}}} allows
3389 you to edit the link and description parts of the link.
3391 - {{{kbd(C-c C-o)}}} (~org-open-at-point~) ::
3394 #+findex: org-open-at-point
3395 #+vindex: org-file-apps
3396 Open link at point. This launches a web browser for URL (using
3397 ~browse-url-at-point~), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB
3398 for the corresponding links, and execute the command in a shell
3399 link. When the cursor is on an internal link, this command runs
3400 the corresponding search. When the cursor is on a TAG list in
3401 a headline, it creates the corresponding TAGS view. If the
3402 cursor is on a timestamp, it compiles the agenda for that date.
3403 Furthermore, it visits text and remote files in =file= links with
3404 Emacs and select a suitable application for local non-text files.
3405 Classification of files is based on file extension only. See
3406 option ~org-file-apps~. If you want to override the default
3407 application and visit the file with Emacs, use a {{{kbd(C-u)}}}
3408 prefix. If you want to avoid opening in Emacs, use a {{{kbd(C-u
3411 #+vindex: org-link-frame-setup
3412 If the cursor is on a headline, but not on a link, offer all
3413 links in the headline and entry text. If you want to setup the
3414 frame configuration for following links, customize
3415 ~org-link-frame-setup~.
3419 #+vindex: org-return-follows-link
3421 When ~org-return-follows-link~ is set, {{{kbd(RET)}}} also
3422 follows the link at point.
3424 - {{{kbd(mouse-2)}}} or {{{kbd(mouse-1)}}} ::
3428 On links, {{{kbd(mouse-1)}}} and {{{kbd(mouse-2)}}} opens the
3429 link just as {{{kbd(C-c C-o)}}} does.
3431 - {{{kbd(mouse-3)}}} ::
3433 #+vindex: org-display-internal-link-with-indirect-buffer
3435 Like {{{kbd(mouse-2)}}}, but force file links to be opened with
3436 Emacs, and internal links to be displayed in another
3439 - {{{kbd(C-c C-x C-v)}}} (~org-toggle-inline-images~) ::
3441 #+cindex: inlining images
3442 #+cindex: images, inlining
3443 #+vindex: org-startup-with-inline-images
3444 #+kindex: C-c C-x C-v
3445 #+findex: org-toggle-inline-images
3446 Toggle the inline display of linked images. Normally this only
3447 inlines images that have no description part in the link, i.e.,
3448 images that are inlined during export. When called with a prefix
3449 argument, also display images that do have a link description.
3450 You can ask for inline images to be displayed at startup by
3451 configuring the variable ~org-startup-with-inline-images~[fn:34].
3453 - {{{kbd(C-c %)}}} (~org-mark-ring-push~) ::
3456 #+findex: org-mark-ring-push
3458 Push the current position onto the mark ring, to be able to
3459 return easily. Commands following an internal link do this
3462 - {{{kbd(C-c &)}}} (~org-mark-ring-goto~) ::
3465 #+findex: org-mark-ring-goto
3466 #+cindex: links, returning to
3467 Jump back to a recorded position. A position is recorded by the
3468 commands following internal links, and by {{{kbd(C-c %)}}}.
3469 Using this command several times in direct succession moves
3470 through a ring of previously recorded positions.
3472 - {{{kbd(C-c C-x C-n)}}} (~org-next-link~), {{{kbd(C-c C-x C-p)}}} (~org-previous-link~) ::
3474 #+kindex: C-c C-x C-p
3475 #+findex: org-previous-link
3476 #+kindex: C-c C-x C-n
3477 #+findex: org-next-link
3478 #+cindex: links, finding next/previous
3479 Move forward/backward to the next link in the buffer. At the
3480 limit of the buffer, the search fails once, and then wraps
3481 around. The key bindings for this are really too long; you might
3482 want to bind this also to {{{kbd(M-n)}}} and {{{kbd(M-p)}}}.
3484 #+begin_src emacs-lisp
3485 (add-hook 'org-load-hook
3487 (define-key org-mode-map "\M-n" 'org-next-link)
3488 (define-key org-mode-map "\M-p" 'org-previous-link)))
3491 ** Using Links Outside Org
3493 :DESCRIPTION: Linking from my C source code?
3496 #+findex: org-insert-link-global
3497 #+findex: org-open-at-point-global
3498 You can insert and follow links that have Org syntax not only in Org,
3499 but in any Emacs buffer. For this, Org provides two functions:
3500 ~org-insert-link-global~ and ~org-open-at-point-global~.
3502 You might want to bind them to globally available keys. See
3503 [[*Activation]] for some advice.
3505 ** Link Abbreviations
3507 :DESCRIPTION: Shortcuts for writing complex links.
3509 #+cindex: link abbreviations
3510 #+cindex: abbreviation, links
3512 Long URL can be cumbersome to type, and often many similar links are
3513 needed in a document. For this you can use link abbreviations. An
3514 abbreviated link looks like this
3516 : [[linkword:tag][description]]
3518 #+texinfo: @noindent
3519 #+vindex: org-link-abbrev-alist
3520 where the tag is optional. The /linkword/ must be a word, starting
3521 with a letter, followed by letters, numbers, =-=, and =_=.
3522 Abbreviations are resolved according to the information in the
3523 variable ~org-link-abbrev-alist~ that relates the linkwords to
3524 replacement text. Here is an example:
3526 #+begin_src emacs-lisp
3527 (setq org-link-abbrev-alist
3528 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3529 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3530 ("google" . "http://www.google.com/search?q=")
3531 ("gmap" . "http://maps.google.com/maps?q=%s")
3532 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3533 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3536 If the replacement text contains the string =%s=, it is replaced with
3537 the tag. Using =%h= instead of =%s= percent-encodes the tag (see the
3538 example above, where we need to encode the URL parameter). Using
3539 =%(my-function)= passes the tag to a custom function, and replace it
3540 by the resulting string.
3542 If the replacement text do not contain any specifier, it is simply
3543 appended to the string in order to create the link.
3545 Instead of a string, you may also specify a function that will be
3546 called with the tag as the only argument to create the link.
3548 With the above setting, you could link to a specific bug with
3549 =[[bugzilla:129]]=, search the web for =OrgMode= with =[[google:OrgMode]]=,
3550 show the map location of the Free Software Foundation =[[gmap:51
3551 Franklin Street, Boston]]= or of Carsten office =[[omap:Science Park 904,
3552 Amsterdam, The Netherlands]]= and find out what the Org author is doing
3553 besides Emacs hacking with =[[ads:Dominik,C]]=.
3555 If you need special abbreviations just for a single Org buffer, you
3556 can define them in the file with
3558 #+cindex: @samp{LINK}, keyword
3560 ,#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3561 ,#+LINK: google http://www.google.com/search?q=%s
3564 #+texinfo: @noindent
3565 In-buffer completion (see [[*Completion]]) can be used after =[= to
3566 complete link abbreviations. You may also define a function that
3567 implements special (e.g., completion) support for inserting such
3568 a link with {{{kbd(C-c C-l)}}}. Such a function should not accept any
3569 arguments, and return the full link with prefix. You can set the link
3570 completion function like this:
3572 #+begin_src emacs-lisp
3573 (org-link-set-parameter "type" :complete #'some-completion-function)
3576 ** Search Options in File Links
3578 :DESCRIPTION: Linking to a specific location.
3579 :ALT_TITLE: Search Options
3581 #+cindex: search option in file links
3582 #+cindex: file links, searching
3584 File links can contain additional information to make Emacs jump to
3585 a particular location in the file when following a link. This can be
3586 a line number or a search option after a double colon[fn:35]. For
3587 example, when the command ~org-store-link~ creates a link (see
3588 [[*Handling Links]]) to a file, it encodes the words in the current line
3589 as a search string that can be used to find this line back later when
3590 following the link with {{{kbd(C-c C-o)}}}.
3592 Here is the syntax of the different ways to attach a search to a file
3593 link, together with an explanation:
3596 [[file:~/code/main.c::255]]
3597 [[file:~/xx.org::My Target]]
3598 [[file:~/xx.org::*My Target]]
3599 [[file:~/xx.org::#my-custom-id]]
3600 [[file:~/xx.org::/regexp/]]
3609 Search for a link target =<<My Target>>=, or do a text search for
3610 =my target=, similar to the search in internal links, see
3611 [[*Internal Links]]. In HTML export (see [[*HTML Export]]), such a file
3612 link becomes a HTML reference to the corresponding named anchor
3617 In an Org file, restrict search to headlines.
3619 - =#my-custom-id= ::
3621 Link to a heading with a =CUSTOM_ID= property
3625 Do a regular expression search for {{{var(REGEXP)}}}. This uses
3626 the Emacs command ~occur~ to list all matches in a separate
3627 window. If the target file is in Org mode, ~org-occur~ is used
3628 to create a sparse tree with the matches.
3630 As a degenerate case, a file link with an empty file name can be used
3631 to search the current file. For example, =[[file:::find me]]= does
3632 a search for =find me= in the current file, just as =[[find me]]= would.
3636 :DESCRIPTION: When the default search is not enough.
3638 #+cindex: custom search strings
3639 #+cindex: search strings, custom
3641 The default mechanism for creating search strings and for doing the
3642 actual search related to a file link may not work correctly in all
3643 cases. For example, BibTeX database files have many entries like
3644 ~year="1993"~ which would not result in good search strings, because
3645 the only unique identification for a BibTeX entry is the citation key.
3647 #+vindex: org-create-file-search-functions
3648 #+vindex: org-execute-file-search-functions
3649 If you come across such a problem, you can write custom functions to
3650 set the right search string for a particular file type, and to do the
3651 search for the string in the file. Using ~add-hook~, these functions
3652 need to be added to the hook variables
3653 ~org-create-file-search-functions~ and
3654 ~org-execute-file-search-functions~. See the docstring for these
3655 variables for more information. Org actually uses this mechanism for
3656 BibTeX database files, and you can use the corresponding code as an
3657 implementation example. See the file =org-bibtex.el=.
3661 :DESCRIPTION: Every tree branch can be a TODO item.
3663 #+cindex: TODO items
3665 Org mode does not maintain TODO lists as separate documents[fn:36].
3666 Instead, TODO items are an integral part of the notes file, because
3667 TODO items usually come up while taking notes! With Org mode, simply
3668 mark any entry in a tree as being a TODO item. In this way,
3669 information is not duplicated, and the entire context from which the
3670 TODO item emerged is always present.
3672 Of course, this technique for managing TODO items scatters them
3673 throughout your notes file. Org mode compensates for this by
3674 providing methods to give you an overview of all the things that you
3677 ** Basic TODO Functionality
3679 :DESCRIPTION: Marking and displaying TODO entries.
3680 :ALT_TITLE: TODO Basics
3683 Any headline becomes a TODO item when it starts with the word =TODO=,
3686 : *** TODO Write letter to Sam Fortune
3688 #+texinfo: @noindent
3689 The most important commands to work with TODO entries are:
3691 - {{{kbd(C-c C-t)}}} (~org-todo~) ::
3694 #+cindex: cycling, of TODO states
3695 Rotate the TODO state of the current item among
3698 ,-> (unmarked) -> TODO -> DONE --.
3699 '--------------------------------'
3702 If TODO keywords have fast access keys (see [[*Fast access to
3703 TODO states]]), prompt for a TODO keyword through the fast
3704 selection interface; this is the default behavior when
3705 ~org-use-fast-todo-selection~ is non-~nil~.
3707 The same rotation can also be done "remotely" from the timeline
3708 and agenda buffers with the {{{kbd(t)}}} command key (see
3709 [[*Commands in the Agenda Buffer]]).
3711 - {{{kbd(C-u C-c C-t)}}} ::
3713 #+kindex: C-u C-c C-t
3714 When TODO keywords have no selection keys, select a specific
3715 keyword using completion; otherwise force cycling through TODO
3716 states with no prompt. When ~org-use-fast-todo-selection~ is set
3717 to ~prefix~, use the fast selection interface.
3719 - {{{kbd(S-RIGHT)}}} {{{kbd(S-LEFT)}}} ::
3723 #+vindex: org-treat-S-cursor-todo-selection-as-state-change
3724 Select the following/preceding TODO state, similar to cycling.
3725 Useful mostly if more than two TODO states are possible (see
3726 [[*Extended Use of TODO Keywords]]). See also [[*Packages that
3727 conflict with Org mode]], for a discussion of the interaction with
3728 ~shift-selection-mode~. See also the variable
3729 ~org-treat-S-cursor-todo-selection-as-state-change~.
3731 - {{{kbd(C-c / t)}}} (~org-show-todo-tree~) ::
3734 #+cindex: sparse tree, for TODO
3735 #+vindex: org-todo-keywords
3736 #+findex: org-show-todo-tree
3737 View TODO items in a /sparse tree/ (see [[*Sparse Trees]]). Folds
3738 the entire buffer, but shows all TODO items---with not-DONE
3739 state---and the headings hierarchy above them. With a prefix
3740 argument, or by using {{{kbd(C-c / T)}}}, search for a specific
3741 TODO. You are prompted for the keyword, and you can also give
3742 a list of keywords like =KWD1|KWD2|...= to list entries that
3743 match any one of these keywords. With a numeric prefix argument
3744 N, show the tree for the Nth keyword in the variable
3745 ~org-todo-keywords~. With two prefix arguments, find all TODO
3746 states, both un-done and done.
3748 - {{{kbd(C-c a t)}}} (~org-todo-list~) ::
3751 Show the global TODO list. Collects the TODO items (with
3752 not-DONE states) from all agenda files (see [[*Agenda Views]]) into
3753 a single buffer. The new buffer is in Org Agenda mode, which
3754 provides commands to examine and manipulate the TODO entries from
3755 the new buffer (see [[*Commands in the Agenda Buffer]]). See [[*The
3756 global TODO list]], for more information.
3758 - {{{kbd(S-M-RET)}}} (~org-insert-todo-heading~) ::
3761 #+findex: org-insert-todo-heading
3762 Insert a new TODO entry below the current one.
3764 #+vindex: org-todo-state-tags-triggers
3765 #+texinfo: @noindent
3766 Changing a TODO state can also trigger tag changes. See the docstring
3767 of the option ~org-todo-state-tags-triggers~ for details.
3769 ** Extended Use of TODO Keywords
3771 :DESCRIPTION: Workflow and assignments.
3772 :ALT_TITLE: TODO Extensions
3774 #+cindex: extended TODO keywords
3776 #+vindex: org-todo-keywords
3777 By default, marked TODO entries have one of only two states: TODO and
3778 DONE. Org mode allows you to classify TODO items in more complex ways
3779 with /TODO keywords/ (stored in ~org-todo-keywords~). With special
3780 setup, the TODO keyword system can work differently in different
3783 Note that /tags/ are another way to classify headlines in general and
3784 TODO items in particular (see [[*Tags]]).
3786 *** TODO keywords as workflow states
3788 :DESCRIPTION: From TODO to DONE in steps.
3789 :ALT_TITLE: Workflow states
3791 #+cindex: TODO workflow
3792 #+cindex: workflow states as TODO keywords
3794 You can use TODO keywords to indicate different /sequential/ states in
3795 the process of working on an item, for example[fn:37]:
3797 #+begin_src emacs-lisp
3798 (setq org-todo-keywords
3799 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3802 The vertical bar separates the TODO keywords (states that /need
3803 action/) from the DONE states (which need /no further action/). If
3804 you do not provide the separator bar, the last state is used as the
3807 #+cindex: completion, of TODO keywords
3808 With this setup, the command {{{kbd(C-c C-t)}}} cycles an entry from
3809 =TODO= to =FEEDBACK=, then to =VERIFY=, and finally to =DONE= and
3810 =DELEGATED=. You may also use a numeric prefix argument to quickly
3811 select a specific state. For example {{{kbd(C-3 C-c C-t)}}} changes
3812 the state immediately to =VERIFY=. Or you can use {{{kbd(S-LEFT)}}}
3813 to go backward through the sequence. If you define many keywords, you
3814 can use in-buffer completion (see [[*Completion]]) or even a special
3815 one-key selection scheme (see [[*Fast access to TODO states]]) to insert
3816 these words into the buffer. Changing a TODO state can be logged with
3817 a timestamp, see [[*Tracking TODO state changes]], for more information.
3819 *** TODO keywords as types
3821 :DESCRIPTION: I do this, Fred does the rest.
3822 :ALT_TITLE: TODO types
3824 #+cindex: TODO types
3825 #+cindex: names as TODO keywords
3826 #+cindex: types as TODO keywords
3828 The second possibility is to use TODO keywords to indicate different
3829 /types/ of action items. For example, you might want to indicate that
3830 items are for "work" or "home". Or, when you work with several people
3831 on a single project, you might want to assign action items directly to
3832 persons, by using their names as TODO keywords. This would be set up
3835 #+begin_src emacs-lisp
3836 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3839 In this case, different keywords do not indicate a sequence, but
3840 rather different types. So the normal work flow would be to assign
3841 a task to a person, and later to mark it DONE. Org mode supports this
3842 style by adapting the workings of the command {{{kbd(C-c
3843 C-t)}}}[fn:38]. When used several times in succession, it still
3844 cycles through all names, in order to first select the right type for
3845 a task. But when you return to the item after some time and execute
3846 {{{kbd(C-c C-t)}}} again, it will switch from any name directly to
3847 =DONE=. Use prefix arguments or completion to quickly select
3848 a specific name. You can also review the items of a specific TODO
3849 type in a sparse tree by using a numeric prefix to {{{kbd(C-c / t)}}}.
3850 For example, to see all things Lucy has to do, you would use
3851 {{{kbd(C-3 C-c / t)}}}. To collect Lucy's items from all agenda files
3852 into a single buffer, you would use the numeric prefix argument as
3853 well when creating the global TODO list: {{{kbd(C-3 C-c a t)}}}.
3855 *** Multiple keyword sets in one file
3857 :DESCRIPTION: Mixing it all, still finding your way.
3858 :ALT_TITLE: Multiple sets in one file
3860 #+cindex: TODO keyword sets
3862 Sometimes you may want to use different sets of TODO keywords in
3863 parallel. For example, you may want to have the basic TODO/DONE, but
3864 also a workflow for bug fixing, and a separate state indicating that
3865 an item has been canceled---so it is not DONE, but also does not
3866 require action. Your setup would then look like this:
3868 #+begin_src emacs-lisp
3869 (setq org-todo-keywords
3870 '((sequence "TODO" "|" "DONE")
3871 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3872 (sequence "|" "CANCELED")))
3875 The keywords should all be different, this helps Org mode to keep
3876 track of which subsequence should be used for a given entry. In this
3877 setup, {{{kbd(C-c C-t)}}} only operates within a subsequence, so it
3878 switches from =DONE= to (nothing) to =TODO=, and from =FIXED= to
3879 (nothing) to =REPORT=. Therefore you need a mechanism to initially
3880 select the correct sequence. Besides the obvious ways like typing
3881 a keyword or using completion, you may also apply the following
3884 #+attr_texinfo: :sep ,
3885 - {{{kbd(C-u C-u C-c C-t)}}}, {{{kbd(C-S-RIGHT)}}}, {{{kbd(C-S-LEFT)}}} ::
3889 #+kindex: C-u C-u C-c C-t
3890 These keys jump from one TODO subset to the next. In the above
3891 example, {{{kbd(C-u C-u C-c C-t)}}} or {{{kbd(C-S-RIGHT)}}} would
3892 jump from =TODO= or =DONE= to =REPORT=, and any of the words in
3893 the second row to =CANCELED=. Note that the {{{kbd(C-S-)}}} key
3894 binding conflict with ~shift-selection-mode~ (see [[*Packages
3895 that conflict with Org mode]]).
3897 - {{{kbd(S-RIGHT)}}}, {{{kbd(S-LEFT)}}} ::
3901 {{{kbd(S-LEFT)}}} and {{{kbd(S-RIGHT)}}} walk through /all/
3902 keywords from all sets, so for example {{{kbd(S-RIGHT)}}} would
3903 switch from =DONE= to =REPORT= in the example above. For
3904 a discussion of the interaction with ~shift-selection-mode~, see
3905 [[*Packages that conflict with Org mode]].
3907 *** Fast access to TODO states
3909 :DESCRIPTION: Single letter selection of state.
3912 If you would like to quickly change an entry to an arbitrary TODO
3913 state instead of cycling through the states, you can set up keys for
3914 single-letter access to the states. This is done by adding the
3915 selection character after each keyword, in parentheses[fn:39]. For
3918 #+begin_src emacs-lisp
3919 (setq org-todo-keywords
3920 '((sequence "TODO(t)" "|" "DONE(d)")
3921 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3922 (sequence "|" "CANCELED(c)")))
3925 #+vindex: org-fast-tag-selection-include-todo
3926 If you then press {{{kbd(C-c C-t)}}} followed by the selection key,
3927 the entry is switched to this state. {{{kbd(SPC)}}} can be used to
3928 remove any TODO keyword from an entry[fn:40].
3930 *** Setting up keywords for individual files
3932 :DESCRIPTION: Different files, different requirements.
3933 :ALT_TITLE: Per-file keywords
3935 #+cindex: keyword options
3936 #+cindex: per-file keywords
3937 #+cindex: @samp{TODO}, keyword
3938 #+cindex: @samp{TYP_TODO}, keyword
3939 #+cindex: @samp{SEQ_TODO}, keyword
3941 It can be very useful to use different aspects of the TODO mechanism
3942 in different files. For file-local settings, you need to add special
3943 lines to the file which set the keywords and interpretation for that
3944 file only. For example, to set one of the two examples discussed
3945 above, you need one of the following lines, starting in column zero
3946 anywhere in the file:
3948 : #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3950 #+texinfo: @noindent
3951 you may also write =#+SEQ_TODO= to be explicit about the
3952 interpretation, but it means the same as =#+TODO=, or
3954 : #+TYP_TODO: Fred Sara Lucy Mike | DONE
3956 A setup for using several sets in parallel would be:
3959 ,#+TODO: TODO | DONE
3960 ,#+TODO: REPORT BUG KNOWNCAUSE | FIXED
3964 #+cindex: completion, of option keywords
3966 #+texinfo: @noindent
3967 To make sure you are using the correct keyword, type =#+= into the
3968 buffer and then use {{{kbd(M-TAB)}}} completion.
3970 #+cindex: DONE, final TODO keyword
3971 Remember that the keywords after the vertical bar---or the last
3972 keyword if no bar is there---must always mean that the item is DONE,
3973 although you may use a different word. After changing one of these
3974 lines, use {{{kbd(C-c C-c)}}} with the cursor still in the line to
3975 make the changes known to Org mode[fn:41].
3977 *** Faces for TODO keywords
3979 :DESCRIPTION: Highlighting states.
3981 #+cindex: faces, for TODO keywords
3983 #+vindex: org-todo, face
3984 #+vindex: org-done, face
3985 #+vindex: org-todo-keyword-faces
3986 Org mode highlights TODO keywords with special faces: ~org-todo~ for
3987 keywords indicating that an item still has to be acted upon, and
3988 ~org-done~ for keywords indicating that an item is finished. If you
3989 are using more than two different states, you might want to use
3990 special faces for some of them. This can be done using the variable
3991 ~org-todo-keyword-faces~. For example:
3993 #+begin_src emacs-lisp
3994 (setq org-todo-keyword-faces
3995 '(("TODO" . org-warning) ("STARTED" . "yellow")
3996 ("CANCELED" . (:foreground "blue" :weight bold))))
3999 #+vindex: org-faces-easy-properties
4000 While using a list with face properties as shown for =CANCELED=
4001 /should/ work, this does not always seem to be the case. If
4002 necessary, define a special face and use that. A string is
4003 interpreted as a color. The variable ~org-faces-easy-properties~
4004 determines if that color is interpreted as a foreground or
4007 *** TODO dependencies
4009 :DESCRIPTION: When one task needs to wait for others.
4011 #+cindex: TODO dependencies
4012 #+cindex: dependencies, of TODO states
4014 #+vindex: org-enforce-todo-dependencies
4015 #+cindex: @samp{ORDERED}, property
4016 The structure of Org files---hierarchy and lists---makes it easy to
4017 define TODO dependencies. Usually, a parent TODO task should not be
4018 marked DONE until all TODO subtasks, defined as children tasks, are
4019 marked as DONE. And sometimes there is a logical sequence to a number
4020 of TODO (sub)tasks, so that one task cannot be acted upon before all
4021 siblings above it are done. If you customize the variable
4022 ~org-enforce-todo-dependencies~, Org blocks entries from changing state
4023 to DONE while they have TODO children that are not DONE. Furthermore,
4024 if an entry has a property =ORDERED=, each of its TODO children is
4025 blocked until all earlier siblings are marked DONE. Here is an
4029 ,* TODO Blocked until (two) is done
4038 ,** TODO b, needs to wait for (a)
4039 ,** TODO c, needs to wait for (a) and (b)
4042 #+cindex: TODO dependencies, NOBLOCKING
4043 #+cindex: NOBLOCKING, property
4044 You can ensure an entry is never blocked by using the =NOBLOCKING=
4048 ,* This entry is never blocked
4054 - {{{kbd(C-c C-x o)}}} (~org-toggle-ordered-property~) ::
4057 #+findex: org-toggle-ordered-property
4058 #+vindex: org-track-ordered-property-with-tag
4059 Toggle the =ORDERED= property of the current entry. A property is
4060 used for this behavior because this should be local to the
4061 current entry, not inherited from entries above like a tag.
4062 However, if you would like to /track/ the value of this property
4063 with a tag for better 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 #+texinfo: @noindent
4166 to record a timestamp without a note for TODO keywords configured with
4167 =@=, just type {{{kbd(C-c C-c)}}} to enter a blank note when prompted.
4169 #+vindex: org-log-done
4170 #+texinfo: @noindent
4171 You not only define global TODO keywords and fast access keys, but
4172 also request that a time is recorded when the entry is set to =DONE=,
4173 and that a note is recorded when switching to =WAIT= or
4174 =CANCELED=[fn:46]. The setting for =WAIT= is even more special: the
4175 =!= after the slash means that in addition to the note taken when
4176 entering the state, a timestamp should be recorded when /leaving/ the
4177 =WAIT= state, if and only if the /target/ state does not configure
4178 logging for entering it. So it has no effect when switching from
4179 =WAIT= to =DONE=, because =DONE= is configured to record a timestamp
4180 only. But when switching from =WAIT= back to =TODO=, the =/!= in the
4181 =WAIT= setting now triggers a timestamp even though =TODO= has no
4184 You can use the exact same syntax for setting logging preferences local
4187 : #+TODO: TODO(t) WAIT(w@/!) | DONE(d!) CANCELED(c@)
4189 #+cindex: @samp{LOGGING}, property
4190 In order to define logging settings that are local to a subtree or
4191 a single item, define a =LOGGING= property in this entry. Any
4192 non-empty =LOGGING= property resets all logging settings to ~nil~.
4193 You may then turn on logging for this specific tree using =STARTUP=
4194 keywords like =lognotedone= or =logrepeat=, as well as adding state
4195 specific settings like =TODO(!)=. For example:
4198 ,* TODO Log each state with only a time
4200 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4202 ,* TODO Only log when switching to WAIT, and when repeating
4204 :LOGGING: WAIT(@) logrepeat
4206 ,* TODO No logging at all
4212 *** Tracking your habits
4214 :DESCRIPTION: How consistent have you been?
4217 #+cindex: STYLE, property
4219 Org has the ability to track the consistency of a special category of
4220 TODO, called "habits." A habit has the following properties:
4222 1. You have enabled the ~habits~ module by customizing the variable
4225 2. The habit is a TODO item, with a TODO keyword representing an open
4228 3. The property =STYLE= is set to the value =habit=.
4230 4. The TODO has a scheduled date, usually with a =.+= style repeat
4231 interval. A =++= style may be appropriate for habits with time
4232 constraints, e.g., must be done on weekends, or a =+= style for an
4233 unusual habit that can have a backlog, e.g., weekly reports.
4235 5. The TODO may also have minimum and maximum ranges specified by
4236 using the syntax =.+2d/3d=, which says that you want to do the task
4237 at least every three days, but at most every two days.
4239 6. You must also have state logging for the DONE state enabled (see
4240 [[*Tracking TODO state changes]]), in order for historical data to be
4241 represented in the consistency graph. If it is not enabled it is
4242 not an error, but the consistency graphs are largely meaningless.
4244 To give you an idea of what the above rules look like in action, here's an
4245 actual habit with some history:
4249 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4252 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4254 - State "DONE" from "TODO" [2009-10-15 Thu]
4255 - State "DONE" from "TODO" [2009-10-12 Mon]
4256 - State "DONE" from "TODO" [2009-10-10 Sat]
4257 - State "DONE" from "TODO" [2009-10-04 Sun]
4258 - State "DONE" from "TODO" [2009-10-02 Fri]
4259 - State "DONE" from "TODO" [2009-09-29 Tue]
4260 - State "DONE" from "TODO" [2009-09-25 Fri]
4261 - State "DONE" from "TODO" [2009-09-19 Sat]
4262 - State "DONE" from "TODO" [2009-09-16 Wed]
4263 - State "DONE" from "TODO" [2009-09-12 Sat]
4266 What this habit says is: I want to shave at most every 2 days---given
4267 by the =SCHEDULED= date and repeat interval---and at least every
4268 4 days. If today is the 15th, then the habit first appears in the
4269 agenda on Oct 17, after the minimum of 2 days has elapsed, and will
4270 appear overdue on Oct 19, after four days have elapsed.
4272 What's really useful about habits is that they are displayed along
4273 with a consistency graph, to show how consistent you've been at
4274 getting that task done in the past. This graph shows every day that
4275 the task was done over the past three weeks, with colors for each day.
4276 The colors used are:
4278 - Blue :: If the task was not to be done yet on that day.
4279 - Green :: If the task could have been done on that day.
4280 - Yellow :: If the task was going to be overdue the next day.
4281 - Red :: If the task was overdue on that day.
4283 In addition to coloring each day, the day is also marked with an
4284 asterisk if the task was actually done that day, and an exclamation
4285 mark to show where the current day falls in the graph.
4287 There are several configuration variables that can be used to change
4288 the way habits are displayed in the agenda.
4290 - ~org-habit-graph-column~ ::
4292 #+vindex: org-habit-graph-column
4293 The buffer column at which the consistency graph should be drawn.
4294 This overwrites any text in that column, so it is a good idea to
4295 keep your habits' titles brief and to the point.
4297 - ~org-habit-preceding-days~ ::
4299 #+vindex: org-habit-preceding-days
4300 The amount of history, in days before today, to appear in
4303 - ~org-habit-following-days~ ::
4305 #+vindex: org-habit-following-days
4306 The number of days after today that appear in consistency graphs.
4308 - ~org-habit-show-habits-only-for-today~ ::
4310 #+vindex: org-habit-show-habits-only-for-today
4311 If non-~nil~, only show habits in today's agenda view. This is
4312 set to true by default.
4314 Lastly, pressing {{{kbd(K)}}} in the agenda buffer causes habits to
4315 temporarily be disabled and do not appear at all. Press {{{kbd(K)}}}
4316 again to bring them back. They are also subject to tag filtering, if
4317 you have habits which should only be done in certain contexts, for
4322 :DESCRIPTION: Some things are more important than others.
4324 #+cindex: priorities
4325 #+cindex: priority cookie
4327 If you use Org mode extensively, you may end up with enough TODO items
4328 that it starts to make sense to prioritize them. Prioritizing can be
4329 done by placing a /priority cookie/ into the headline of a TODO item,
4332 : *** TODO [#A] Write letter to Sam Fortune
4334 #+vindex: org-priority-faces
4335 #+texinfo: @noindent
4336 By default, Org mode supports three priorities: =A=, =B=, and =C=.
4337 =A= is the highest priority. An entry without a cookie is treated
4338 just like priority =B=. Priorities make a difference only for sorting
4339 in the agenda (see [[*Weekly/daily agenda]]); outside the agenda, they
4340 have no inherent meaning to Org mode. The cookies can be highlighted
4341 with special faces by customizing the variable ~org-priority-faces~.
4343 Priorities can be attached to any outline node; they do not need to be
4346 #+attr_texinfo: :sep ;
4347 - {{{kbd(C-c \,)}}} (~org-priority~) ::
4350 #+findex: org-priority
4351 Set the priority of the current headline. The command prompts
4352 for a priority character =A=, =B= or =C=. When you press
4353 {{{kbd(SPC)}}} instead, the priority cookie is removed from the
4354 headline. The priorities can also be changed "remotely" from the
4355 timeline and agenda buffer with the {{{kbd(\,)}}} command (see
4356 [[*Commands in the Agenda Buffer]]).
4358 - {{{kbd(S-UP)}}} (~org-priority-up~); {{{kbd(S-DOWN)}}} (~org-priority-down~) ::
4362 #+findex: org-priority-up
4363 #+findex: org-priority-down
4364 #+vindex: org-priority-start-cycle-with-default
4365 Increase/decrease priority of current headline[fn:47]. Note that
4366 these keys are also used to modify timestamps (see [[*Creating
4367 Timestamps]]). See also [[*Packages that conflict with Org mode]], for
4368 a discussion of the interaction with ~shift-selection-mode~.
4370 #+vindex: org-highest-priority
4371 #+vindex: org-lowest-priority
4372 #+vindex: org-default-priority
4373 You can change the range of allowed priorities by setting the
4374 variables ~org-highest-priority~, ~org-lowest-priority~, and
4375 ~org-default-priority~. For an individual buffer, you may set these
4376 values (highest, lowest, default) like this (please make sure that the
4377 highest priority is earlier in the alphabet than the lowest priority):
4379 #+cindex: @samp{PRIORITIES}, keyword
4380 : #+PRIORITIES: A C B
4382 ** Breaking Down Tasks into Subtasks
4384 :DESCRIPTION: Splitting a task into manageable pieces.
4385 :ALT_TITLE: Breaking Down Tasks
4387 #+cindex: tasks, breaking down
4388 #+cindex: statistics, for TODO items
4390 #+vindex: org-agenda-todo-list-sublevels
4391 It is often advisable to break down large tasks into smaller,
4392 manageable subtasks. You can do this by creating an outline tree
4393 below a TODO item, with detailed subtasks on the tree[fn:48]. To keep
4394 the overview over the fraction of subtasks that are already completed,
4395 insert either =[/]= or =[%]= anywhere in the headline. These cookies
4396 are updated each time the TODO status of a child changes, or when
4397 pressing {{{kbd(C-c C-c)}}} on the cookie. For example:
4400 ,* Organize Party [33%]
4401 ,** TODO Call people [1/2]
4405 ,** DONE Talk to neighbor
4408 #+cindex: @samp{COOKIE_DATA}, property
4409 If a heading has both checkboxes and TODO children below it, the
4410 meaning of the statistics cookie become ambiguous. Set the property
4411 =COOKIE_DATA= to either =checkbox= or =todo= to resolve this issue.
4413 #+vindex: org-hierarchical-todo-statistics
4414 If you would like to have the statistics cookie count any TODO entries
4415 in the subtree (not just direct children), configure the variable
4416 ~org-hierarchical-todo-statistics~. To do this for a single subtree,
4417 include the word =recursive= into the value of the =COOKIE_DATA=
4421 ,* Parent capturing statistics [2/20]
4423 :COOKIE_DATA: todo recursive
4427 If you would like a TODO entry to automatically change to DONE when
4428 all children are done, you can use the following setup:
4430 #+begin_src emacs-lisp
4431 (defun org-summary-todo (n-done n-not-done)
4432 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4433 (let (org-log-done org-log-states) ; turn off logging
4434 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4436 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4439 Another possibility is the use of checkboxes to identify (a hierarchy
4440 of) a large number of subtasks (see [[*Checkboxes]]).
4444 :DESCRIPTION: Tick-off lists.
4446 #+cindex: checkboxes
4448 #+vindex: org-list-automatic-rules
4449 Every item in a plain list[fn:49] (see [[*Plain Lists]]) can be made into
4450 a checkbox by starting it with the string =[ ]=. This feature is
4451 similar to TODO items (see [[*TODO Items]]), but is more lightweight.
4452 Checkboxes are not included into the global TODO list, so they are
4453 often great to split a task into a number of simple steps. Or you can
4454 use them in a shopping list. To toggle a checkbox, use {{{kbd(C-c
4455 C-c)}}}, or use the mouse (thanks to Piotr Zielinski's
4458 Here is an example of a checkbox list.
4461 ,* TODO Organize party [2/4]
4462 - [-] call people [1/3]
4467 - [ ] think about what music to play
4468 - [X] talk to the neighbors
4471 Checkboxes work hierarchically, so if a checkbox item has children
4472 that are checkboxes, toggling one of the children checkboxes makes the
4473 parent checkbox reflect if none, some, or all of the children are
4476 #+cindex: statistics, for checkboxes
4477 #+cindex: checkbox statistics
4478 #+cindex: @samp{COOKIE_DATA}, property
4479 #+vindex: org-hierarchical-checkbox-statistics
4480 The =[2/4]= and =[1/3]= in the first and second line are cookies
4481 indicating how many checkboxes present in this entry have been checked
4482 off, and the total number of checkboxes present. This can give you an
4483 idea on how many checkboxes remain, even without opening a folded
4484 entry. The cookies can be placed into a headline or into (the first
4485 line of) a plain list item. Each cookie covers checkboxes of direct
4486 children structurally below the headline/item on which the cookie
4487 appears[fn:50]. You have to insert the cookie yourself by typing
4488 either =[/]= or =[%]=. With =[/]= you get an =n out of m= result, as
4489 in the examples above. With =[%]= you get information about the
4490 percentage of checkboxes checked (in the above example, this would be
4491 =[50%]= and =[33%]=, respectively). In a headline, a cookie can count
4492 either checkboxes below the heading or TODO states of children, and it
4493 displays whatever was changed last. Set the property =COOKIE_DATA= to
4494 either =checkbox= or =todo= to resolve this issue.
4496 #+cindex: blocking, of checkboxes
4497 #+cindex: checkbox blocking
4498 #+cindex: @samp{ORDERED}, property
4499 If the current outline node has an =ORDERED= property, checkboxes must
4500 be checked off in sequence, and an error is thrown if you try to check
4501 off a box while there are unchecked boxes above it.
4503 #+texinfo: @noindent
4504 The following commands work with checkboxes:
4506 - {{{kbd(C-c C-c)}}} (~org-toggle-checkbox~) ::
4509 #+findex: org-toggle-checkbox
4510 Toggle checkbox status or---with prefix argument---checkbox
4511 presence at point. With a single prefix argument, add an empty
4512 checkbox or remove the current one[fn:51]. With a double prefix
4513 argument, set it to =[-]=, which is considered to be an
4516 - {{{kbd(C-c C-x C-b)}}} (~org-toggle-checkbox~) ::
4518 #+kindex: C-c C-x C-b
4519 Toggle checkbox status or---with prefix argument---checkbox
4520 presence at point. With double prefix argument, set it to =[-]=,
4521 which is considered to be an intermediate state.
4523 - If there is an active region, toggle the first checkbox in the
4524 region and set all remaining boxes to the same status as the
4525 first. With a prefix argument, add or remove the checkbox for
4526 all items in the region.
4528 - If the cursor is in a headline, toggle checkboxes in the region
4529 between this headline and the next---so /not/ the entire
4532 - If there is no active region, just toggle the checkbox at
4535 - {{{kbd(M-S-RET)}}} (~org-insert-todo-heading~) ::
4538 #+findex: org-insert-todo-heading
4539 Insert a new item with a checkbox. This works only if the cursor
4540 is already in a plain list item (see [[*Plain Lists]]).
4542 - {{{kbd(C-c C-x o)}}} (~org-toggle-ordered-property~) ::
4545 #+findex: org-toggle-ordered-property
4546 #+vindex: org-track-ordered-property-with-tag
4547 Toggle the =ORDERED= property of the entry, to toggle if
4548 checkboxes must be checked off in sequence. A property is used
4549 for this behavior because this should be local to the current
4550 entry, not inherited like a tag. However, if you would like to
4551 /track/ the value of this property with a tag for better
4552 visibility, customize ~org-track-ordered-property-with-tag~.
4554 - {{{kbd(C-c #)}}} (~org-update-statistics-cookies~) ::
4557 #+findex: org-update-statistics-cookies
4558 Update the statistics cookie in the current outline entry. When
4559 called with a {{{kbd(C-u)}}} prefix, update the entire file.
4560 Checkbox statistic cookies are updated automatically if you
4561 toggle checkboxes with {{{kbd(C-c C-c)}}} and make new ones with
4562 {{{kbd(M-S-RET)}}}. TODO statistics cookies update when changing
4563 TODO states. If you delete boxes/entries or add/change them by
4564 hand, use this command to get things back into sync.
4568 :DESCRIPTION: Tagging headlines and matching sets of tags.
4571 #+cindex: headline tagging
4572 #+cindex: matching, tags
4573 #+cindex: sparse tree, tag based
4575 An excellent way to implement labels and contexts for
4576 cross-correlating information is to assign /tags/ to headlines. Org
4577 mode has extensive support for tags.
4579 #+vindex: org-tag-faces
4580 Every headline can contain a list of tags; they occur at the end of
4581 the headline. Tags are normal words containing letters, numbers, =_=,
4582 and =@=. Tags must be preceded and followed by a single colon, e.g.,
4583 =:work:=. Several tags can be specified, as in =:work:urgent:=. Tags
4584 by default are in bold face with the same color as the headline. You
4585 may specify special faces for specific tags using the variable
4586 ~org-tag-faces~, in much the same way as you can for TODO keywords
4587 (see [[*Faces for TODO keywords]]).
4591 :DESCRIPTION: Tags use the tree structure of an outline.
4593 #+cindex: tag inheritance
4594 #+cindex: inheritance, of tags
4595 #+cindex: sublevels, inclusion into tags match
4597 /Tags/ make use of the hierarchical structure of outline trees. If
4598 a heading has a certain tag, all subheadings inherit the tag as well.
4599 For example, in the list
4602 ,* Meeting with the French group :work:
4603 ,** Summary by Frank :boss:notes:
4604 ,*** TODO Prepare slides for him :action:
4607 #+texinfo: @noindent
4608 the final heading has the tags =work=, =boss=, =notes=, and =action=
4609 even though the final heading is not explicitly marked with those
4610 tags. You can also set tags that all entries in a file should inherit
4611 just as if these tags were defined in a hypothetical level zero that
4612 surrounds the entire file. Use a line like this[fn:52]
4614 #+cindex: @samp{FILETAGS}, keyword
4615 : #+FILETAGS: :Peter:Boss:Secret:
4617 #+vindex: org-use-tag-inheritance
4618 #+vindex: org-tags-exclude-from-inheritance
4619 #+texinfo: @noindent
4620 To limit tag inheritance to specific tags, or to turn it off entirely,
4621 use the variables ~org-use-tag-inheritance~ and
4622 ~org-tags-exclude-from-inheritance~.
4624 #+vindex: org-tags-match-list-sublevels
4625 When a headline matches during a tags search while tag inheritance is
4626 turned on, all the sublevels in the same tree---for a simple match
4627 form---match as well[fn:53]. The list of matches may then become
4628 very long. If you only want to see the first tags match in a subtree,
4629 configure the variable ~org-tags-match-list-sublevels~ (not
4632 #+vindex: org-agenda-use-tag-inheritance
4633 Tag inheritance is relevant when the agenda search tries to match
4634 a tag, either in the ~tags~ or ~tags-todo~ agenda types. In other
4635 agenda types, ~org-use-tag-inheritance~ has no effect. Still, you may
4636 want to have your tags correctly set in the agenda, so that tag
4637 filtering works fine, with inherited tags. Set
4638 ~org-agenda-use-tag-inheritance~ to control this: the default value
4639 includes all agenda types, but setting this to ~nil~ can really speed
4640 up agenda generation.
4644 :DESCRIPTION: How to assign tags to a headline.
4646 #+cindex: setting tags
4647 #+cindex: tags, setting
4650 Tags can simply be typed into the buffer at the end of a headline.
4651 After a colon, {{{kbd(M-TAB)}}} offers completion on tags. There is
4652 also a special command for inserting tags:
4654 - {{{kbd(C-c C-q)}}} (~org-set-tags-command~) ::
4657 #+findex: org-set-tags-command
4658 #+cindex: completion, of tags
4659 #+vindex: org-tags-column
4660 Enter new tags for the current headline. Org mode either offers
4661 completion or a special single-key interface for setting tags,
4662 see below. After pressing {{{kbd(RET)}}}, the tags are inserted
4663 and aligned to ~org-tags-column~. When called with
4664 a {{{kbd(C-u)}}} prefix, all tags in the current buffer are
4665 aligned to that column, just to make things look nice. Tags are
4666 automatically realigned after promotion, demotion, and TODO state
4667 changes (see [[*Basic TODO Functionality]]).
4669 - {{{kbd(C-c C-c)}}} (~org-set-tags-command~) ::
4672 When the cursor is in a headline, this does the same as
4675 #+vindex: org-complete-tags-always-offer-all-agenda-tags
4676 #+vindex: org-tag-alist
4677 #+cindex: @samp{TAGS}, keyword
4678 Org supports tag insertion based on a /list of tags/. By default this
4679 list is constructed dynamically, containing all tags currently used in
4680 the buffer[fn:54]. You may also globally specify a hard list of tags
4681 with the variable ~org-tag-alist~. Finally you can set the default
4682 tags for a given file using the =TAGS= keyword, like
4685 ,#+TAGS: @work @home @tennisclub
4686 ,#+TAGS: laptop car pc sailboat
4689 If you have globally defined your preferred set of tags using the
4690 variable ~org-tag-alist~, but would like to use a dynamic tag list in
4691 a specific file, add an empty =TAGS= keyword to that file:
4695 #+vindex: org-tag-persistent-alist
4696 If you have a preferred set of tags that you would like to use in
4697 every file, in addition to those defined on a per-file basis by =TAGS=
4698 keyword, then you may specify a list of tags with the variable
4699 ~org-tag-persistent-alist~. You may turn this off on a per-file basis
4700 by adding a =STARTUP= keyword to that file:
4704 By default Org mode uses the standard minibuffer completion facilities
4705 for entering tags. However, it also implements another, quicker, tag
4706 selection method called /fast tag selection/. This allows you to
4707 select and deselect tags with just a single key press. For this to
4708 work well you should assign unique letters to most of your commonly
4709 used tags. You can do this globally by configuring the variable
4710 ~org-tag-alist~ in your Emacs init file. For example, you may find
4711 the need to tag many items in different files with =@home=. In this
4712 case you can set something like:
4714 #+begin_src emacs-lisp
4715 (setq org-tag-alist '(("@work" . ?w) ("@home" . ?h) ("laptop" . ?l)))
4718 #+texinfo: @noindent
4719 If the tag is only relevant to the file you are working on, then you
4720 can instead set the =TAGS= keyword as:
4722 : #+TAGS: @work(w) @home(h) @tennisclub(t) laptop(l) pc(p)
4724 #+texinfo: @noindent
4725 The tags interface shows the available tags in a splash window. If
4726 you want to start a new line after a specific tag, insert =\n= into
4729 : #+TAGS: @work(w) @home(h) @tennisclub(t) \n laptop(l) pc(p)
4731 #+texinfo: @noindent
4732 or write them in two lines:
4735 ,#+TAGS: @work(w) @home(h) @tennisclub(t)
4736 ,#+TAGS: laptop(l) pc(p)
4739 #+texinfo: @noindent
4740 You can also group together tags that are mutually exclusive by using
4743 : #+TAGS: { @work(w) @home(h) @tennisclub(t) } laptop(l) pc(p)
4745 #+texinfo: @noindent
4746 you indicate that at most one of =@work=, =@home=, and =@tennisclub=
4747 should be selected. Multiple such groups are allowed.
4749 #+texinfo: @noindent
4750 Do not forget to press {{{kbd(C-c C-c)}}} with the cursor in one of
4751 these lines to activate any changes.
4753 #+texinfo: @noindent
4754 To set these mutually exclusive groups in the variable
4755 ~org-tags-alist~, you must use the dummy tags ~:startgroup~ and
4756 ~:endgroup~ instead of the braces. Similarly, you can use ~:newline~
4757 to indicate a line break. The previous example would be set globally
4758 by the following configuration:
4760 #+begin_src emacs-lisp
4761 (setq org-tag-alist '((:startgroup . nil)
4762 ("@work" . ?w) ("@home" . ?h)
4763 ("@tennisclub" . ?t)
4765 ("laptop" . ?l) ("pc" . ?p)))
4768 If at least one tag has a selection key then pressing {{{kbd(C-c
4769 C-c)}}} automatically presents you with a special interface, listing
4770 inherited tags, the tags of the current headline, and a list of all
4771 valid tags with corresponding keys[fn:55].
4773 Pressing keys assigned to tags adds or removes them from the list of
4774 tags in the current line. Selecting a tag in a group of mutually
4775 exclusive tags turns off any other tag from that group.
4777 In this interface, you can also use the following special keys:
4782 Enter a tag in the minibuffer, even if the tag is not in the
4783 predefined list. You can complete on all tags present in the
4784 buffer. You can also add several tags: just separate them with
4790 Clear all tags for this line.
4795 Accept the modified set.
4800 Abort without installing changes.
4805 If {{{kbd(q)}}} is not assigned to a tag, it aborts like
4811 Turn off groups of mutually exclusive tags. Use this to (as an
4812 exception) assign several tags from such a group.
4817 Toggle auto-exit after the next change (see below). If you are
4818 using expert mode, the first {{{kbd(C-c)}}} displays the
4821 #+texinfo: @noindent
4822 This method lets you assign tags to a headline with very few keys.
4823 With the above setup, you could clear the current tags and set
4824 =@home=, =laptop= and =pc= tags with just the following keys:
4825 {{{kbd(C-c C-c SPC h l p RET)}}}. Switching from =@home= to =@work=
4826 would be done with {{{kbd(C-c C-c w RET)}}} or alternatively with
4827 {{{kbd(C-c C-c C-c w)}}}. Adding the non-predefined tag =Sarah= could
4828 be done with {{{kbd(C-c C-c TAB S a r a h RET)}}}.
4830 #+vindex: org-fast-tag-selection-single-key
4831 If you find that most of the time you need only a single key press to
4832 modify your list of tags, set the variable
4833 ~org-fast-tag-selection-single-key~. Then you no longer have to press
4834 {{{kbd(RET)}}} to exit fast tag selection---it exits after the first
4835 change. If you then occasionally need more keys, press {{{kbd(C-c)}}}
4836 to turn off auto-exit for the current tag selection process (in
4837 effect: start selection with {{{kbd(C-c C-c C-c)}}} instead of
4838 {{{kbd(C-c C-c)}}}). If you set the variable to the value ~expert~,
4839 the special window is not even shown for single-key tag selection, it
4840 comes up only when you press an extra {{{kbd(C-c)}}}.
4844 :DESCRIPTION: Create a hierarchy of tags.
4846 #+cindex: group tags
4847 #+cindex: tags, groups
4848 #+cindex: tags hierarchy
4850 Tags can be defined in hierarchies. A tag can be defined as a /group
4851 tag/ for a set of other tags. The group tag can be seen as the
4852 "broader term" for its set of tags. Defining multiple group tags and
4853 nesting them creates a tag hierarchy.
4855 One use-case is to create a taxonomy of terms (tags) that can be used
4856 to classify nodes in a document or set of documents.
4858 When you search for a group tag, it return matches for all members in
4859 the group and its subgroups. In an agenda view, filtering by a group
4860 tag displays or hide headlines tagged with at least one of the members
4861 of the group or any of its subgroups. This makes tag searches and
4862 filters even more flexible.
4864 You can set group tags by using brackets and inserting a colon between
4865 the group tag and its related tags---beware that all whitespaces are
4866 mandatory so that Org can parse this line correctly:
4868 : #+TAGS: [ GTD : Control Persp ]
4870 In this example, =GTD= is the group tag and it is related to two other
4871 tags: =Control=, =Persp=. Defining =Control= and =Persp= as group
4872 tags creates an hierarchy of tags:
4875 ,#+TAGS: [ Control : Context Task ]
4876 ,#+TAGS: [ Persp : Vision Goal AOF Project ]
4879 That can conceptually be seen as a hierarchy of tags:
4891 You can use the ~:startgrouptag~, ~:grouptags~ and ~:endgrouptag~
4892 keyword directly when setting ~org-tag-alist~ directly:
4894 #+begin_src emacs-lisp
4895 (setq org-tag-alist '((:startgrouptag)
4909 The tags in a group can be mutually exclusive if using the same group
4910 syntax as is used for grouping mutually exclusive tags together; using
4913 : #+TAGS: { Context : @Home @Work @Call }
4915 When setting ~org-tag-alist~ you can use ~:startgroup~ and ~:endgroup~
4916 instead of ~:startgrouptag~ and ~:endgrouptag~ to make the tags
4919 Furthermore, the members of a group tag can also be regular
4920 expressions, creating the possibility of a more dynamic and rule-based
4921 tag structure. The regular expressions in the group must be specified
4922 within curly brackets. Here is an expanded example:
4925 ,#+TAGS: [ Vision : {V@.+} ]
4926 ,#+TAGS: [ Goal : {G@.+} ]
4927 ,#+TAGS: [ AOF : {AOF@.+} ]
4928 ,#+TAGS: [ Project : {P@.+} ]
4931 Searching for the tag =Project= now lists all tags also including
4932 regular expression matches for =P@.+=, and similarly for tag searches
4933 on =Vision=, =Goal= and =AOF=. For example, this would work well for
4934 a project tagged with a common project-identifier,
4935 e.g. =P@2014_OrgTags=.
4938 #+findex: org-toggle-tags-groups
4939 #+vindex: org-group-tags
4940 If you want to ignore group tags temporarily, toggle group tags
4941 support with ~org-toggle-tags-groups~, bound to {{{kbd(C-c C-x q)}}}.
4942 If you want to disable tag groups completely, set ~org-group-tags~ to
4947 :DESCRIPTION: Searching for combinations of tags.
4949 #+cindex: tag searches
4950 #+cindex: searching for tags
4952 Once a system of tags has been set up, it can be used to collect
4953 related information into special lists.
4955 - {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} (~org-match-sparse-tree~) ::
4959 #+findex: org-match-sparse-tree
4960 Create a sparse tree with all headlines matching a tags search.
4961 With a {{{kbd(C-u)}}} prefix argument, ignore headlines that are
4964 - {{{kbd(C-c a m)}}} (~org-tags-view~) ::
4967 #+findex: org-tags-view
4968 Create a global list of tag matches from all agenda files. See
4969 [[*Matching tags and properties]].
4971 - {{{kbd(C-c a M)}}} (~org-tags-view~) ::
4974 #+vindex: org-tags-match-list-sublevels
4975 Create a global list of tag matches from all agenda files, but
4976 check only TODO items and force checking subitems (see the option
4977 ~org-tags-match-list-sublevels~).
4979 These commands all prompt for a match string which allows basic
4980 Boolean logic like =+boss+urgent-project1=, to find entries with tags
4981 =boss= and =urgent=, but not =project1=, or =Kathy|Sally= to find
4982 entries which are tagged, like =Kathy= or =Sally=. The full syntax of
4983 the search string is rich and allows also matching against TODO
4984 keywords, entry levels and properties. For a complete description
4985 with many examples, see [[*Matching tags and properties]].
4987 * Properties and Columns
4989 :DESCRIPTION: Storing information about an entry.
4991 #+cindex: properties
4993 A property is a key-value pair associated with an entry. Properties
4994 can be set so they are associated with a single entry, with every
4995 entry in a tree, or with every entry in an Org file.
4997 There are two main applications for properties in Org mode. First,
4998 properties are like tags, but with a value. Imagine maintaining
4999 a file where you document bugs and plan releases for a piece of
5000 software. Instead of using tags like =release_1=, =release_2=, you
5001 can use a property, say =Release=, that in different subtrees has
5002 different values, such as =1.0= or =2.0=. Second, you can use
5003 properties to implement (very basic) database capabilities in an Org
5004 buffer. Imagine keeping track of your music CDs, where properties
5005 could be things such as the album, artist, date of release, number of
5008 Properties can be conveniently edited and viewed in column view (see
5013 :DESCRIPTION: How properties are spelled out.
5015 #+cindex: property syntax
5016 #+cindex: drawer, for properties
5018 Properties are key--value pairs. When they are associated with
5019 a single entry or with a tree they need to be inserted into a special
5020 drawer (see [[*Drawers]]) with the name =PROPERTIES=, which has to be
5021 located right below a headline, and its planning line (see [[*Deadlines
5022 and Scheduling]]) when applicable. Each property is specified on
5023 a single line, with the key---surrounded by colons---first, and the
5024 value after it. Keys are case-insensitive. Here is an example:
5029 ,*** Goldberg Variations
5031 :Title: Goldberg Variations
5032 :Composer: J.S. Bach
5034 :Publisher: Deutsche Grammophon
5039 Depending on the value of ~org-use-property-inheritance~, a property
5040 set this way is associated either with a single entry, or with the
5041 sub-tree defined by the entry, see [[*Property Inheritance]].
5043 You may define the allowed values for a particular property =Xyz= by
5044 setting a property =Xyz_ALL=. This special property is /inherited/,
5045 so if you set it in a level 1 entry, it applies to the entire tree.
5046 When allowed values are defined, setting the corresponding property
5047 becomes easier and is less prone to typing errors. For the example
5048 with the CD collection, we can pre-define publishers and the number of
5049 disks in a box like this:
5054 :NDisks_ALL: 1 2 3 4
5055 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5059 If you want to set properties that can be inherited by any entry in
5060 a file, use a line like:
5062 #+cindex: @samp{_ALL} suffix, in properties
5063 #+cindex: @samp{PROPERTY}, keyword
5064 : #+PROPERTY: NDisks_ALL 1 2 3 4
5066 #+cindex: @samp{+} suffix, in properties
5067 If you want to add to the value of an existing property, append a =+=
5068 to the property name. The following results in the property =var=
5069 having the value =foo=1 bar=2=.
5072 ,#+PROPERTY: var foo=1
5073 ,#+PROPERTY: var+ bar=2
5076 It is also possible to add to the values of inherited properties. The
5077 following results in the =Genres= property having the value =Classic
5078 Baroque= under the =Goldberg Variations= subtree.
5086 ,*** Goldberg Variations
5088 :Title: Goldberg Variations
5089 :Composer: J.S. Bach
5091 :Publisher: Deutsche Grammophon
5097 Note that a property can only have one entry per drawer.
5099 #+vindex: org-global-properties
5100 Property values set with the global variable ~org-global-properties~
5101 can be inherited by all entries in all Org files.
5103 #+texinfo: @noindent
5104 The following commands help to work with properties:
5106 #+attr_texinfo: :sep ,
5107 - {{{kbd(M-TAB)}}} (~pcomplete~) ::
5111 After an initial colon in a line, complete property keys. All
5112 keys used in the current file are offered as possible
5115 - {{{kbd(C-c C-x p)}}} (~org-set-property~) ::
5118 #+findex: org-set-property
5119 Set a property. This prompts for a property name and a value.
5120 If necessary, the property drawer is created as well.
5122 - {{{kbd(C-u M-x org-insert-drawer)}}} ::
5124 #+findex: org-insert-drawer
5125 Insert a property drawer into the current entry. The drawer is
5126 inserted early in the entry, but after the lines with planning
5127 information like deadlines.
5129 - {{{kbd(C-c C-c)}}} (~org-property-action~) ::
5132 #+findex: org-property-action
5133 With the cursor in a property drawer, this executes property
5136 - {{{kbd(C-c C-c s)}}} (~org-set-property~) ::
5139 #+findex: org-set-property
5140 Set a property in the current entry. Both the property and the value
5141 can be inserted using completion.
5143 - {{{kbd(S-RIGHT)}}} (~org-property-next-allowed-values~), {{{kbd(S-LEFT)}}} (~org-property-previous-allowed-value~) ::
5147 Switch property at point to the next/previous allowed value.
5149 - {{{kbd(C-c C-c d)}}} (~org-delete-property~) ::
5152 #+findex: org-delete-property
5153 Remove a property from the current entry.
5155 - {{{kbd(C-c C-c D)}}} (~org-delete-property-globally~) ::
5158 #+findex: org-delete-property-globally
5159 Globally remove a property, from all entries in the current file.
5161 - {{{kbd(C-c C-c c)}}} (~org-compute-property-at-point~) ::
5164 #+findex: org-compute-property-at-point
5165 Compute the property at point, using the operator and scope from
5166 the nearest column format definition.
5168 ** Special Properties
5170 :DESCRIPTION: Access to other Org mode features.
5172 #+cindex: properties, special
5174 Special properties provide an alternative access method to Org mode
5175 features, like the TODO state or the priority of an entry, discussed
5176 in the previous chapters. This interface exists so that you can
5177 include these states in a column view (see [[*Column View]]), or to use
5178 them in queries. The following property names are special and should
5179 not be used as keys in the properties drawer:
5181 #+cindex: @samp{ALLTAGS}, special property
5182 #+cindex: @samp{BLOCKED}, special property
5183 #+cindex: @samp{CLOCKSUM}, special property
5184 #+cindex: @samp{CLOCKSUM_T}, special property
5185 #+cindex: @samp{CLOSED}, special property
5186 #+cindex: @samp{DEADLINE}, special property
5187 #+cindex: @samp{FILE}, special property
5188 #+cindex: @samp{ITEM}, special property
5189 #+cindex: @samp{PRIORITY}, special property
5190 #+cindex: @samp{SCHEDULED}, special property
5191 #+cindex: @samp{TAGS}, special property
5192 #+cindex: @samp{TIMESTAMP}, special property
5193 #+cindex: @samp{TIMESTAMP_IA}, special property
5194 #+cindex: @samp{TODO}, special property
5195 | =ALLTAGS= | All tags, including inherited ones. |
5196 | =BLOCKED= | ~t~ if task is currently blocked by children or siblings. |
5197 | =CATEGORY= | The category of an entry. |
5198 | =CLOCKSUM= | The sum of CLOCK intervals in the subtree. ~org-clock-sum~ |
5199 | | must be run first to compute the values in the current buffer. |
5200 | =CLOCKSUM_T= | The sum of CLOCK intervals in the subtree for today. |
5201 | | ~org-clock-sum-today~ must be run first to compute the |
5202 | | values in the current buffer. |
5203 | =CLOSED= | When was this entry closed? |
5204 | =DEADLINE= | The deadline time string, without the angular brackets. |
5205 | =FILE= | The filename the entry is located in. |
5206 | =ITEM= | The headline of the entry. |
5207 | =PRIORITY= | The priority of the entry, a string with a single letter. |
5208 | =SCHEDULED= | The scheduling timestamp, without the angular brackets. |
5209 | =TAGS= | The tags defined directly in the headline. |
5210 | =TIMESTAMP= | The first keyword-less timestamp in the entry. |
5211 | =TIMESTAMP_IA= | The first inactive timestamp in the entry. |
5212 | =TODO= | The TODO keyword of the entry. |
5214 ** Property Searches
5216 :DESCRIPTION: Matching property values.
5218 #+cindex: properties, searching
5219 #+cindex: searching, of properties
5221 To create sparse trees and special lists with selection based on
5222 properties, the same commands are used as for tag searches (see [[*Tag
5225 - {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} (~org-match-sparse-tree~) ::
5229 #+findex: org-match-sparse-tree
5230 Create a sparse tree with all matching entries. With
5231 a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not
5234 - {{{kbd(C-c a m)}}}, ~org-tags-view~ ::
5237 Create a global list of tag/property matches from all agenda
5240 - {{{kbd(C-c a M)}}} (~org-tags-view~) ::
5243 #+findex: org-tags-view
5244 #+vindex: org-tags-match-list-sublevels
5245 Create a global list of tag matches from all agenda files, but
5246 check only TODO items and force checking of subitems (see the
5247 option ~org-tags-match-list-sublevels~).
5249 The syntax for the search string is described in [[*Matching tags and
5252 There is also a special command for creating sparse trees based on a
5255 - {{{kbd(C-c / p)}}} ::
5258 Create a sparse tree based on the value of a property. This
5259 first prompts for the name of a property, and then for a value.
5260 A sparse tree is created with all entries that define this
5261 property with the given value. If you enclose the value in curly
5262 braces, it is interpreted as a regular expression and matched
5263 against the property values.
5265 ** Property Inheritance
5267 :DESCRIPTION: Passing values down a tree.
5269 #+cindex: properties, inheritance
5270 #+cindex: inheritance, of properties
5272 #+vindex: org-use-property-inheritance
5273 The outline structure of Org documents lends itself to an inheritance
5274 model of properties: if the parent in a tree has a certain property,
5275 the children can inherit this property. Org mode does not turn this
5276 on by default, because it can slow down property searches
5277 significantly and is often not needed. However, if you find
5278 inheritance useful, you can turn it on by setting the variable
5279 ~org-use-property-inheritance~. It may be set to ~t~ to make all
5280 properties inherited from the parent, to a list of properties that
5281 should be inherited, or to a regular expression that matches inherited
5282 properties. If a property has the value ~nil~, this is interpreted as
5283 an explicit un-define of the property, so that inheritance search
5284 stops at this value and returns ~nil~.
5286 Org mode has a few properties for which inheritance is hard-coded, at
5287 least for the special applications for which they are used:
5291 #+cindex: @samp{COLUMNS}, property
5292 The =COLUMNS= property defines the format of column view (see
5293 [[*Column View]]). It is inherited in the sense that the level where
5294 a =COLUMNS= property is defined is used as the starting point for
5295 a column view table, independently of the location in the subtree
5296 from where columns view is turned on.
5300 #+cindex: @samp{CATEGORY}, property
5301 For agenda view, a category set through a =CATEGORY= property
5302 applies to the entire subtree.
5306 #+cindex: @samp{ARCHIVE}, property
5307 For archiving, the =ARCHIVE= property may define the archive
5308 location for the entire subtree (see [[*Moving a tree to an archive
5313 #+cindex: @samp{LOGGING}, property
5314 The =LOGGING= property may define logging settings for an entry
5315 or a subtree (see [[*Tracking TODO state changes]]).
5319 :DESCRIPTION: Tabular viewing and editing.
5322 A great way to view and edit properties in an outline tree is /column
5323 view/. In column view, each outline node is turned into a table row.
5324 Columns in this table provide access to properties of the entries.
5325 Org mode implements columns by overlaying a tabular structure over the
5326 headline of each item. While the headlines have been turned into
5327 a table row, you can still change the visibility of the outline tree.
5328 For example, you get a compact table by switching to "contents"
5329 view---{{{kbd(S-TAB)}}} {{{kbd(S-TAB)}}}, or simply {{{kbd(c)}}}
5330 while column view is active---but you can still open, read, and edit
5331 the entry below each headline. Or, you can switch to column view
5332 after executing a sparse tree command and in this way get a table only
5333 for the selected items. Column view also works in agenda buffers (see
5334 [[*Agenda Views]]) where queries have collected selected items, possibly
5335 from a number of files.
5337 *** Defining columns
5339 :DESCRIPTION: The COLUMNS format property.
5341 #+cindex: column view, for properties
5342 #+cindex: properties, column view
5344 Setting up a column view first requires defining the columns. This is
5345 done by defining a column format line.
5347 **** Scope of column definitions
5349 :DESCRIPTION: Where defined, where valid?
5352 To define a column format for an entire file, use a line like:
5354 #+cindex: @samp{COLUMNS}, keyword
5355 : #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5357 To specify a format that only applies to a specific tree, add
5358 a =COLUMNS= property to the top node of that tree, for example:
5361 ,** Top node for columns view
5363 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5367 If a =COLUMNS= property is present in an entry, it defines columns for
5368 the entry itself, and for the entire subtree below it. Since the
5369 column definition is part of the hierarchical structure of the
5370 document, you can define columns on level 1 that are general enough
5371 for all sublevels, and more specific columns further down, when you
5372 edit a deeper part of the tree.
5374 **** Column attributes
5376 :DESCRIPTION: Appearance and content of a column.
5379 A column definition sets the attributes of a column. The general
5380 definition looks like this:
5382 : %[WIDTH]PROPERTY[(TITLE)][{SUMMARY-TYPE}]
5384 #+texinfo: @noindent
5385 Except for the percent sign and the property name, all items are
5386 optional. The individual parts have the following meaning:
5388 - {{{var(WIDTH)}}} ::
5390 An integer specifying the width of the column in characters. If
5391 omitted, the width is determined automatically.
5393 - {{{var(PROPERTY)}}} ::
5395 The property that should be edited in this column. Special
5396 properties representing meta data are allowed here as well (see
5397 [[*Special Properties]]).
5399 - {{{var(TITLE)}}} ::
5401 The header text for the column. If omitted, the property name is
5404 - {{{var(SUMMARY-TYPE)}}} ::
5406 The summary type. If specified, the column values for parent
5407 nodes are computed from the children[fn:56].
5409 Supported summary types are:
5411 | =+= | Sum numbers in this column. |
5412 | =+;%.1f= | Like =+=, but format result with =%.1f=. |
5413 | =$= | Currency, short for =+;%.2f=. |
5414 | =min= | Smallest number in column. |
5415 | =max= | Largest number. |
5416 | =mean= | Arithmetic mean of numbers. |
5417 | =X= | Checkbox status, =[X]= if all children are =[X]=. |
5418 | =X/= | Checkbox status, =[n/m]=. |
5419 | =X%= | Checkbox status, =[n%]=. |
5420 | =:= | Sum times, HH:MM, plain numbers are hours. |
5421 | =:min= | Smallest time value in column. |
5422 | =:max= | Largest time value. |
5423 | =:mean= | Arithmetic mean of time values. |
5424 | =@min= | Minimum age[fn:57] (in days/hours/mins/seconds). |
5425 | =@max= | Maximum age (in days/hours/mins/seconds). |
5426 | =@mean= | Arithmetic mean of ages (in days/hours/mins/seconds). |
5427 | =est+= | Add low-high estimates. |
5429 #+texinfo: @noindent
5430 #+vindex: org-columns-summary-types
5431 You can also define custom summary types by setting
5432 ~org-columns-summary-types~.
5434 The =est+= summary type requires further explanation. It is used for
5435 combining estimates, expressed as low-high ranges. For example,
5436 instead of estimating a particular task will take 5 days, you might
5437 estimate it as 5--6 days if you're fairly confident you know how much
5438 work is required, or 1--10 days if you do not really know what needs
5439 to be done. Both ranges average at 5.5 days, but the first represents
5440 a more predictable delivery.
5442 When combining a set of such estimates, simply adding the lows and
5443 highs produces an unrealistically wide result. Instead, =est+= adds
5444 the statistical mean and variance of the sub-tasks, generating a final
5445 estimate from the sum. For example, suppose you had ten tasks, each
5446 of which was estimated at 0.5 to 2 days of work. Straight addition
5447 produces an estimate of 5 to 20 days, representing what to expect if
5448 everything goes either extremely well or extremely poorly. In
5449 contrast, =est+= estimates the full job more realistically, at 10--15
5452 Here is an example for a complete columns definition, along with
5453 allowed values[fn:58].
5456 :COLUMNS: %25ITEM %9Approved(Approved?){X} %Owner %11Status \
5457 %10Time_Estimate{:} %CLOCKSUM %CLOCKSUM_T
5458 :Owner_ALL: Tammy Mark Karl Lisa Don
5459 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5460 :Approved_ALL: "[ ]" "[X]"
5463 #+texinfo: @noindent
5464 The first column, =%25ITEM=, means the first 25 characters of the item
5465 itself, i.e., of the headline. You probably always should start the
5466 column definition with the =ITEM= specifier. The other specifiers
5467 create columns =Owner= with a list of names as allowed values, for
5468 =Status= with four different possible values, and for a checkbox field
5469 =Approved=. When no width is given after the =%= character, the
5470 column is exactly as wide as it needs to be in order to fully display
5471 all values. The =Approved= column does have a modified title
5472 (=Approved?=, with a question mark). Summaries are created for the
5473 =Time_Estimate= column by adding time duration expressions like HH:MM,
5474 and for the =Approved= column, by providing an =[X]= status if all
5475 children have been checked. The =CLOCKSUM= and =CLOCKSUM_T= columns
5476 are special, they lists the sums of CLOCK intervals in the subtree,
5477 either for all clocks or just for today.
5479 *** Using column view
5481 :DESCRIPTION: How to create and use column view.
5484 **** Turning column view on or off
5489 - {{{kbd(C-c C-x C-c)}}} (~org-columns~) ::
5491 #+kindex: C-c C-x C-c
5492 #+vindex: org-columns
5493 #+vindex: org-columns-default-format
5494 Turn on column view. If the cursor is before the first headline
5495 in the file, column view is turned on for the entire file, using
5496 the =#+COLUMNS= definition. If the cursor is somewhere inside
5497 the outline, this command searches the hierarchy, up from point,
5498 for a =COLUMNS= property that defines a format. When one is
5499 found, the column view table is established for the tree starting
5500 at the entry that contains the =COLUMNS= property. If no such
5501 property is found, the format is taken from the =#+COLUMNS= line
5502 or from the variable ~org-columns-default-format~, and column
5503 view is established for the current entry and its subtree.
5505 - {{{kbd(r)}}} or {{{kbd(g)}}} (~org-columns-redo~) ::
5509 #+findex: org-columns-redo
5510 Recreate the column view, to include recent changes made in the
5513 - {{{kbd(q)}}} (~org-columns-quit~) ::
5516 #+findex: org-columns-quit
5524 #+attr_texinfo: :sep and
5525 - {{{kbd(LEFT)}}}, {{{kbd(RIGHT)}}}, {{{kbd(UP)}}}, {{{kbd(DOWN)}}} ::
5527 Move through the column view from field to field.
5529 - {{{kbd(1..9\,0)}}} ::
5532 Directly select the Nth allowed value, {{{kbd(0)}}} selects the
5535 - {{{kbd(n)}}} or {{{kbd(S-RIGHT)}}} (~org-columns-next-allowed-value~) and {{{kbd(p)}}} or {{{kbd(S-LEFT)}}} (~org-columns-previous-allowed-value~) ::
5541 #+findex: org-columns-next-allowed-value
5542 #+findex: org-columns-previous-allowed-value
5543 Switch to the next/previous allowed value of the field. For
5544 this, you have to have specified allowed values for a property.
5546 - {{{kbd(e)}}} (~org-columns-edit-value~) ::
5549 #+findex: org-columns-edit-value
5550 Edit the property at point. For the special properties, this
5551 invokes the same interface that you normally use to change that
5552 property. For example, the tag completion or fast selection
5553 interface pops up when editing a =TAGS= property.
5555 - {{{kbd(C-c C-c)}}} (~org-columns-set-tags-or-toggle~) ::
5558 #+findex: org-columns-set-tags-or-toggle
5559 When there is a checkbox at point, toggle it.
5561 - {{{kbd(v)}}} (~org-columns-show-value~) ::
5564 #+findex: org-columns-show-value
5565 View the full value of this property. This is useful if the
5566 width of the column is smaller than that of the value.
5568 - {{{kbd(a)}}} (~org-columns-edit-allowed~) ::
5571 #+findex: org-columns-edit-allowed
5572 Edit the list of allowed values for this property. If the list
5573 is found in the hierarchy, the modified values is stored there.
5574 If no list is found, the new value is stored in the first entry
5575 that is part of the current column view.
5577 **** Modifying column view on-the-fly:
5582 #+attr_texinfo: :sep and
5583 - {{{kbd(<)}}} (~org-columns-narrow~) and {{{kbd(>)}}} (~org-columns-widen~) ::
5587 #+findex: org-columns-narrow
5588 #+findex: org-columns-widen
5589 Make the column narrower/wider by one character.
5591 - {{{kbd(S-M-RIGHT)}}} (~org-columns-new~) ::
5594 #+findex: org-columns-new
5595 Insert a new column, to the left of the current column.
5597 - {{{kbd(S-M-LEFT)}}} (~org-columns-delete~) ::
5600 #+findex: org-columns-delete
5601 Delete the current column.
5603 *** Capturing column view
5605 :DESCRIPTION: A dynamic block for column view.
5608 Since column view is just an overlay over a buffer, it cannot be
5609 exported or printed directly. If you want to capture a column view,
5610 use a =columnview= dynamic block (see [[*Dynamic Blocks]]). The frame of
5611 this block looks like this:
5613 #+cindex: @samp{BEGIN columnview}
5616 ,#+BEGIN: columnview :hlines 1 :id "label"
5621 #+texinfo: @noindent
5622 This dynamic block has the following parameters:
5626 This is the most important parameter. Column view is a feature
5627 that is often localized to a certain (sub)tree, and the capture
5628 block might be at a different location in the file. To identify
5629 the tree whose view to capture, you can use four values:
5633 Use the tree in which the capture block is located.
5637 Make a global view, including all headings in the file.
5639 - =file:FILENAME= ::
5641 Run column view at the top of the {{{var(FILENAME)}}} file
5645 #+cindex: @samp{ID}, property
5646 Call column view in the tree that has an =ID= property with
5647 the value {{{var(LABEL)}}}. You can use {{{kbd(M-x
5648 org-id-copy)}}} to create a globally unique ID for the
5649 current entry and copy it to the kill-ring.
5653 When ~t~, insert an hline after every line. When a number N,
5654 insert an hline before each headline with level ~<= N~.
5658 When non-~nil~, force column groups to get vertical lines.
5662 When set to a number, do not capture entries below this level.
5664 - =:skip-empty-rows= ::
5666 When non-~nil~, skip rows where the only non-empty specifier of
5667 the column view is =ITEM=.
5671 When non-~nil~, indent each =ITEM= field according to its level.
5673 #+texinfo: @noindent
5674 The following commands insert or update the dynamic block:
5676 - {{{kbd(C-c C-x i)}}} (~org-insert-columns-dblock~) ::
5679 #+findex: org-insert-columns-dblock
5680 Insert a dynamic block capturing a column view. Prompt for the
5681 scope or ID of the view.
5683 - {{{kbd(C-c C-c)}}} {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) ::
5686 #+kindex: C-c C-x C-u
5687 #+findex: org-dblock-update
5688 Update dynamic block at point. The cursor needs to be in the
5689 =#+BEGIN= line of the dynamic block.
5691 - {{{kbd(C-u C-c C-x C-u)}}} (~org-update-all-dblocks~) ::
5693 #+kindex: C-u C-c C-x C-u
5694 Update all dynamic blocks (see [[*Dynamic Blocks]]). This is useful
5695 if you have several clock table blocks, column-capturing blocks
5696 or other dynamic blocks in a buffer.
5698 You can add formulas to the column view table and you may add plotting
5699 instructions in front of the table---these survive an update of the
5700 block. If there is a =TBLFM= keyword after the table, the table is
5701 recalculated automatically after an update.
5703 An alternative way to capture and process property values into a table
5704 is provided by Eric Schulte's =org-collector.el= which is
5705 a contributed package[fn:59]. It provides a general API to collect
5706 properties from entries in a certain scope, and arbitrary Lisp
5707 expressions to process these values before inserting them into a table
5712 :DESCRIPTION: Making items useful for planning.
5717 #+cindex: date stamp
5719 To assist project planning, TODO items can be labeled with a date
5720 and/or a time. The specially formatted string carrying the date and
5721 time information is called a /timestamp/ in Org mode. This may be
5722 a little confusing because timestamp is often used as indicating when
5723 something was created or last changed. However, in Org mode this term
5724 is used in a much wider sense.
5726 ** Timestamps, Deadlines and Scheduling
5728 :DESCRIPTION: Assigning a time to a tree entry.
5729 :ALT_TITLE: Timestamps
5731 #+cindex: timestamps
5732 #+cindex: ranges, time
5733 #+cindex: date stamps
5735 #+cindex: scheduling
5737 A timestamp is a specification of a date (possibly with a time or
5738 a range of times) in a special format, either =<2003-09-16 Tue>= or
5739 =<2003-09-16 Tue 09:39>= or =<2003-09-16 Tue 12:00-12:30>=[fn:60].
5740 A timestamp can appear anywhere in the headline or body of an Org tree
5741 entry. Its presence causes entries to be shown on specific dates in
5742 the agenda (see [[*Weekly/daily agenda]]). We distinguish:
5744 - Plain timestamp; Event; Appointment ::
5747 #+cindex: appointment
5748 A simple timestamp just assigns a date/time to an item. This is
5749 just like writing down an appointment or event in a paper agenda.
5750 In the timeline and agenda displays, the headline of an entry
5751 associated with a plain timestamp is shown exactly on that date.
5754 ,* Meet Peter at the movies
5755 <2006-11-01 Wed 19:15>
5756 ,* Discussion on climate change
5757 <2006-11-02 Thu 20:00-22:00>
5760 - Timestamp with repeater interval ::
5762 #+cindex: timestamp, with repeater interval
5763 A timestamp may contain a /repeater interval/, indicating that it
5764 applies not only on the given date, but again and again after
5765 a certain interval of N days (d), weeks (w), months (m), or years
5766 (y). The following shows up in the agenda every Wednesday:
5769 ,* Pick up Sam at school
5770 <2007-05-16 Wed 12:30 +1w>
5773 - Diary-style sexp entries ::
5775 #+cindex: diary style timestamps
5776 #+cindex: sexp timestamps
5777 For more complex date specifications, Org mode supports using the
5778 special sexp diary entries implemented in the Emacs
5779 calendar/diary package[fn:61]. For example, with optional time:
5782 ,* 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5783 <%%(diary-float t 4 2)>
5786 - Time/Date range ::
5789 #+cindex: date range
5790 Two timestamps connected by =--= denote a range. The headline is
5791 shown on the first and last day of the range, and on any dates
5792 that are displayed and fall in the range. Here is an example:
5795 ,** Meeting in Amsterdam
5796 <2004-08-23 Mon>--<2004-08-26 Thu>
5799 - Inactive timestamp ::
5801 #+cindex: timestamp, inactive
5802 #+cindex: inactive timestamp
5803 Just like a plain timestamp, but with square brackets instead of
5804 angular ones. These timestamps are inactive in the sense that
5805 they do /not/ trigger an entry to show up in the agenda.
5808 ,* Gillian comes late for the fifth time
5812 ** Creating Timestamps
5814 :DESCRIPTION: Commands to insert timestamps.
5817 For Org mode to recognize timestamps, they need to be in the specific
5818 format. All commands listed below produce timestamps in the correct
5821 #+attr_texinfo: :sep ,
5822 - {{{kbd(C-c .)}}} (~org-time-stamp~) ::
5825 #+findex: org-time-stamp
5826 Prompt for a date and insert a corresponding timestamp. When the
5827 cursor is at an existing timestamp in the buffer, the command is
5828 used to modify this timestamp instead of inserting a new one.
5829 When this command is used twice in succession, a time range is
5833 #+vindex: org-time-stamp-rounding-minutes
5834 When called with a prefix argument, use the alternative format
5835 which contains date and time. The default time can be rounded to
5836 multiples of 5 minutes. See the option
5837 ~org-time-stamp-rounding-minutes~.
5839 #+kindex: C-u C-u C-c .
5840 With two prefix arguments, insert an active timestamp with the
5841 current time without prompting.
5843 - {{{kbd(C-c !)}}} (~org-time-stamp-inactive~) ::
5847 #+kindex: C-u C-u C-c !
5848 #+findex: org-time-stamp-inactive
5849 Like {{{kbd(C-c .)}}}, but insert an inactive timestamp that does
5850 not cause an agenda entry.
5852 - {{{kbd(C-c C-c)}}} ::
5855 Normalize timestamp, insert or fix day name if missing or wrong.
5857 - {{{kbd(C-c <)}}} (~org-date-from-calendar~) ::
5860 #+findex: org-date-from-calendar
5861 Insert a timestamp corresponding to the cursor date in the
5864 - {{{kbd(C-c >)}}} (~org-goto-calendar~) ::
5867 #+findex: org-goto-calendar
5868 Access the Emacs calendar for the current date. If there is
5869 a timestamp in the current line, go to the corresponding date
5872 - {{{kbd(C-c C-o)}}} (~org-open-at-point~) ::
5875 #+findex: org-open-at-point
5876 Access the agenda for the date given by the timestamp or -range
5877 at point (see [[*Weekly/daily agenda]]).
5879 - {{{kbd(S-LEFT)}}} (~org-timestamp-down-day~), {{{kbd(S-RIGHT)}}} (~org-timestamp-up-day~) ::
5883 #+findex: org-timestamp-down-day
5884 #+findex: org-timestamp-up-day
5885 Change date at cursor by one day. These key bindings conflict
5886 with shift-selection and related modes (see [[*Packages that
5887 conflict with Org mode]]).
5889 - {{{kbd(S-UP)}}} (~org-timestamp-up~), {{{kbd(S-DOWN)}}} (~org-timestamp-down~) ::
5893 On the beginning or enclosing bracket of a timestamp, change its
5894 type. Within a timestamp, change the item under the cursor. The
5895 cursor can be on a year, month, day, hour or minute. When the
5896 timestamp contains a time range like =15:30-16:30=, modifying the
5897 first time also shifts the second, shifting the time block with
5898 constant length. To change the length, modify the second time.
5899 Note that if the cursor is in a headline and not at a timestamp,
5900 these same keys modify the priority of an item (see [[*Priorities]]).
5901 The key bindings also conflict with shift-selection and related
5902 modes (see [[*Packages that conflict with Org mode]]).
5904 - {{{kbd(C-c C-y)}}} (~org-evaluate-time-range~) ::
5907 #+findex: org-evaluate-time-range
5908 #+cindex: evaluate time range
5909 Evaluate a time range by computing the difference between start
5910 and end. With a prefix argument, insert result after the time
5911 range (in a table: into the following column).
5913 *** The date/time prompt
5915 :DESCRIPTION: How Org mode helps you enter dates and times.
5917 #+cindex: date, reading in minibuffer
5918 #+cindex: time, reading in minibuffer
5920 #+vindex: org-read-date-prefer-future
5921 When Org mode prompts for a date/time, the default is shown in default
5922 date/time format, and the prompt therefore seems to ask for a specific
5923 format. But it in fact accepts date/time information in a variety of
5924 formats. Generally, the information should start at the beginning of
5925 the string. Org mode finds whatever information is in there and
5926 derives anything you have not specified from the /default date and
5927 time/. The default is usually the current date and time, but when
5928 modifying an existing timestamp, or when entering the second stamp of
5929 a range, it is taken from the stamp in the buffer. When filling in
5930 information, Org mode assumes that most of the time you want to enter
5931 a date in the future: if you omit the month/year and the given
5932 day/month is /before/ today, it assumes that you mean a future
5933 date[fn:62]. If the date has been automatically shifted into the
5934 future, the time prompt shows this with =(=>F)=.
5936 For example, let's assume that today is *June 13, 2006*. Here is how
5937 various inputs are interpreted, the items filled in by Org mode are in
5940 | =3-2-5= | \rArr{} 2003-02-05 |
5941 | =2/5/3= | \rArr{} 2003-02-05 |
5942 | =14= | \rArr{} *2006*-*06*-14 |
5943 | =12= | \rArr{} *2006*-*07*-12 |
5944 | =2/5= | \rArr{} *2007*-02-05 |
5945 | =Fri= | \rArr{} nearest Friday (default date or later) |
5946 | =sep 15= | \rArr{} *2006*-09-15 |
5947 | =feb 15= | \rArr{} *2007*-02-15 |
5948 | =sep 12 9= | \rArr{} 2009-09-12 |
5949 | =12:45= | \rArr{} *2006*-*06*-*13* 12:45 |
5950 | =22 sept 0:34= | \rArr{} *2006*-09-22 0:34 |
5951 | =w4= | \rArr{} ISO week for of the current year *2006* |
5952 | =2012 w4 fri= | \rArr{} Friday of ISO week 4 in 2012 |
5953 | =2012-w04-5= | \rArr{} Same as above |
5955 Furthermore you can specify a relative date by giving, as the /first/
5956 thing in the input: a plus/minus sign, a number and a letter---=d=,
5957 =w=, =m= or =y=---to indicate change in days, weeks, months, or
5958 years. With a single plus or minus, the date is always relative to
5959 today. With a double plus or minus, it is relative to the default
5960 date. If instead of a single letter, you use the abbreviation of day
5961 name, the date is the Nth such day, e.g.:
5963 | =+0= | \rArr{} today |
5964 | =.= | \rArr{} today |
5965 | =+4d= | \rArr{} four days from today |
5966 | =+4= | \rArr{} same as +4d |
5967 | =+2w= | \rArr{} two weeks from today |
5968 | =++5= | \rArr{} five days from default date |
5969 | =+2tue= | \rArr{} second Tuesday from now |
5971 #+vindex: parse-time-months
5972 #+vindex: parse-time-weekdays
5973 The function understands English month and weekday abbreviations. If
5974 you want to use un-abbreviated names and/or other languages, configure
5975 the variables ~parse-time-months~ and ~parse-time-weekdays~.
5977 #+vindex: org-read-date-force-compatible-dates
5978 Not all dates can be represented in a given Emacs implementation. By
5979 default Org mode forces dates into the compatibility range 1970--2037
5980 which works on all Emacs implementations. If you want to use dates
5981 outside of this range, read the docstring of the variable
5982 ~org-read-date-force-compatible-dates~.
5984 You can specify a time range by giving start and end times or by
5985 giving a start time and a duration (in HH:MM format). Use one or two
5986 dash(es) as the separator in the former case and use =+= as the
5987 separator in the latter case, e.g.:
5989 | =11am-1:15pm= | \rArr{} 11:00-13:15 |
5990 | =11am--1:15pm= | \rArr{} same as above |
5991 | =11am+2:15= | \rArr{} same as above |
5993 #+cindex: calendar, for selecting date
5994 #+vindex: org-popup-calendar-for-date-prompt
5995 Parallel to the minibuffer prompt, a calendar is popped up[fn:63].
5996 When you exit the date prompt, either by clicking on a date in the
5997 calendar, or by pressing {{{kbd(RET)}}}, the date selected in the
5998 calendar is combined with the information entered at the prompt. You
5999 can control the calendar fully from the minibuffer:
6013 #+attr_texinfo: :columns 0.25 0.55
6014 | {{{kbd(RET)}}} | Choose date at cursor in calendar. |
6015 | {{{kbd(mouse-1)}}} | Select date by clicking on it. |
6016 | {{{kbd(S-RIGHT)}}} | One day forward. |
6017 | {{{kbd(S-LEFT)}}} | One day backward. |
6018 | {{{kbd(S-DOWN)}}} | One week forward. |
6019 | {{{kbd(S-UP)}}} | One week backward. |
6020 | {{{kbd(M-S-RIGHT)}}} | One month forward. |
6021 | {{{kbd(M-S-LEFT)}}} | One month backward. |
6022 | {{{kbd(>)}}} | Scroll calendar forward by one month. |
6023 | {{{kbd(<)}}} | Scroll calendar backward by one month. |
6024 | {{{kbd(M-v)}}} | Scroll calendar forward by 3 months. |
6025 | {{{kbd(C-v)}}} | Scroll calendar backward by 3 months. |
6027 #+vindex: org-read-date-display-live
6028 The actions of the date/time prompt may seem complex, but I assure you
6029 they will grow on you, and you will start getting annoyed by pretty
6030 much any other way of entering a date/time out there. To help you
6031 understand what is going on, the current interpretation of your input
6032 is displayed live in the minibuffer[fn:64].
6034 *** Custom time format
6036 :DESCRIPTION: Making dates look different.
6038 #+cindex: custom date/time format
6039 #+cindex: time format, custom
6040 #+cindex: date format, custom
6042 #+vindex: org-display-custom-times
6043 #+vindex: org-time-stamp-custom-formats
6044 Org mode uses the standard ISO notation for dates and times as it is
6045 defined in ISO 8601. If you cannot get used to this and require
6046 another representation of date and time to keep you happy, you can get
6047 it by customizing the variables ~org-display-custom-times~ and
6048 ~org-time-stamp-custom-formats~.
6050 - {{{kbd(C-c C-x C-t)}}} (~org-toggle-time-stamp-overlays~) ::
6052 #+kindex: C-c C-x C-t
6053 #+findex: org-toggle-time-stamp-overlays
6054 Toggle the display of custom formats for dates and times.
6056 #+texinfo: @noindent
6057 Org mode needs the default format for scanning, so the custom
6058 date/time format does not /replace/ the default format. Instead, it
6059 is put /over/ the default format using text properties. This has the
6060 following consequences:
6062 - You cannot place the cursor onto a timestamp anymore, only before or
6065 - The {{{kbd(S-UP)}}} and {{{kbd(S-DOWN)}}} keys can no longer be used
6066 to adjust each component of a timestamp. If the cursor is at the
6067 beginning of the stamp, {{{kbd(S-UP)}}} and {{{kbd(S-DOWN)}}} change
6068 the stamp by one day, just like {{{kbd(S-LEFT)}}}
6069 {{{kbd(S-RIGHT)}}}. At the end of the stamp, change the time by one
6072 - If the timestamp contains a range of clock times or a repeater,
6073 these are not overlaid, but remain in the buffer as they were.
6075 - When you delete a timestamp character-by-character, it only
6076 disappears from the buffer after /all/ (invisible) characters
6077 belonging to the ISO timestamp have been removed.
6079 - If the custom timestamp format is longer than the default and you
6080 are using dates in tables, table alignment will be messed up. If
6081 the custom format is shorter, things do work as expected.
6083 ** Deadlines and Scheduling
6085 :DESCRIPTION: Planning your work.
6088 A timestamp may be preceded by special keywords to facilitate
6089 planning. Both the timestamp and the keyword have to be positioned
6090 immediately after the task they refer to.
6094 #+cindex: @samp{DEADLINE}
6095 Meaning: the task (most likely a TODO item, though not
6096 necessarily) is supposed to be finished on that date.
6098 #+vindex: org-deadline-warning-days
6099 On the deadline date, the task is listed in the agenda. In
6100 addition, the agenda for /today/ carries a warning about the
6101 approaching or missed deadline, starting
6102 ~org-deadline-warning-days~ before the due date, and continuing
6103 until the entry is marked DONE. An example:
6106 ,*** TODO write article about the Earth for the Guide
6107 DEADLINE: <2004-02-29 Sun>
6108 The editor in charge is [[bbdb:Ford Prefect]]
6111 #+vindex: org-agenda-skip-deadline-prewarning-if-scheduled
6112 You can specify a different lead time for warnings for a specific
6113 deadlines using the following syntax. Here is an example with
6114 a warning period of 5 days =DEADLINE: <2004-02-29 Sun -5d>=.
6115 This warning is deactivated if the task gets scheduled and you
6116 set ~org-agenda-skip-deadline-prewarning-if-scheduled~ to ~t~.
6120 #+cindex: @samp{SCHEDULED}
6121 Meaning: you are planning to start working on that task on the
6124 #+vindex: org-agenda-skip-scheduled-if-done
6125 The headline is listed under the given date[fn:65]. In addition,
6126 a reminder that the scheduled date has passed is present in the
6127 compilation for /today/, until the entry is marked DONE, i.e.,
6128 the task is automatically forwarded until completed.
6131 ,*** TODO Call Trillian for a date on New Years Eve.
6132 SCHEDULED: <2004-12-25 Sat>
6135 #+vindex: org-scheduled-delay-days
6136 #+vindex: org-agenda-skip-scheduled-delay-if-deadline
6137 If you want to /delay/ the display of this task in the agenda,
6138 use =SCHEDULED: <2004-12-25 Sat -2d>=: the task is still
6139 scheduled on the 25th but will appear two days later. In case
6140 the task contains a repeater, the delay is considered to affect
6141 all occurrences; if you want the delay to only affect the first
6142 scheduled occurrence of the task, use =--2d= instead. See
6143 ~org-scheduled-delay-days~ and
6144 ~org-agenda-skip-scheduled-delay-if-deadline~ for details on how
6145 to control this globally or per agenda.
6147 #+texinfo: @noindent
6148 *Important:* Scheduling an item in Org mode should /not/ be
6149 understood in the same way that we understand /scheduling
6150 a meeting/. Setting a date for a meeting is just a simple
6151 appointment, you should mark this entry with a simple plain
6152 timestamp, to get this item shown on the date where it applies.
6153 This is a frequent misunderstanding by Org users. In Org mode,
6154 /scheduling/ means setting a date when you want to start working
6157 You may use timestamps with repeaters in scheduling and deadline
6158 entries. Org mode issues early and late warnings based on the
6159 assumption that the timestamp represents the /nearest instance/ of the
6160 repeater. However, the use of diary S-exp entries like
6162 : <%%(diary-float t 42)>
6164 #+texinfo: @noindent
6165 in scheduling and deadline timestamps is limited. Org mode does not
6166 know enough about the internals of each S-exp function to issue early
6167 and late warnings. However, it shows the item on each day where the
6168 S-exp entry matches.
6170 *** Inserting deadlines or schedules
6172 :DESCRIPTION: Planning items.
6173 :ALT_TITLE: Inserting deadline/schedule
6176 The following commands allow you to quickly insert a deadline or to
6177 schedule an item:[fn:66]
6179 - {{{kbd(C-c C-d)}}} (~org-deadline~) ::
6182 #+findex: org-deadline
6183 #+vindex: org-log-redeadline
6184 Insert =DEADLINE= keyword along with a stamp. The insertion
6185 happens in the line directly following the headline. Remove any
6186 =CLOSED= timestamp . When called with a prefix argument, also
6187 remove any existing deadline from the entry. Depending on the
6188 variable ~org-log-redeadline~, take a note when changing an
6189 existing deadline[fn:67].
6191 - {{{kbd(C-c C-s)}}} (~org-schedule~) ::
6194 #+findex: org-schedule
6195 #+vindex: org-log-reschedule
6196 Insert =SCHEDULED= keyword along with a stamp. The insertion
6197 happens in the line directly following the headline. Remove any
6198 =CLOSED= timestamp. When called with a prefix argument, also
6199 remove the scheduling date from the entry. Depending on the
6200 variable ~org-log-reschedule~, take a note when changing an
6201 existing scheduling time[fn:68].
6203 - {{{kbd(C-c C-x C-k)}}} (~org-mark-entry-for-agenda-action~) ::
6205 #+kindex: C-c C-x C-k
6208 #+findex: org-mark-entry-for-agenda-action
6209 Mark the current entry for agenda action. After you have marked
6210 the entry like this, you can open the agenda or the calendar to
6211 find an appropriate date. With the cursor on the selected date,
6212 press {{{kbd(k s)}}} or {{{kbd(k d)}}} to schedule the marked
6215 - {{{kbd(C-c / d)}}} (~org-check-deadlines~) ::
6218 #+findex: org-check-deadlines
6219 #+cindex: sparse tree, for deadlines
6220 #+vindex: org-deadline-warning-days
6221 Create a sparse tree with all deadlines that are either past-due,
6222 or which will become due within ~org-deadline-warning-days~.
6223 With {{{kbd(C-u)}}} prefix, show all deadlines in the file. With
6224 a numeric prefix, check that many days. For example, {{{kbd(C-1
6225 C-c / d)}}} shows all deadlines due tomorrow.
6227 - {{{kbd(C-c / b)}}}, ~org-check-before-date~ ::
6230 #+findex: org-check-before-date
6231 Sparse tree for deadlines and scheduled items before a given
6234 - {{{kbd(C-c / a)}}}, ~org-check-after-date~ ::
6237 #+findex: org-check-after-date
6238 Sparse tree for deadlines and scheduled items after a given date.
6240 Note that ~org-schedule~ and ~org-deadline~ supports setting the date
6241 by indicating a relative time e.g., =+1d= sets the date to the next
6242 day after today, and =--1w= sets the date to the previous week before
6243 any current timestamp.
6247 :DESCRIPTION: Items that show up again and again.
6249 #+cindex: tasks, repeated
6250 #+cindex: repeated tasks
6252 Some tasks need to be repeated again and again. Org mode helps to
6253 organize such tasks using a so-called repeater in a =DEADLINE=,
6254 =SCHEDULED=, or plain timestamp. In the following example:
6257 ,** TODO Pay the rent
6258 DEADLINE: <2005-10-01 Sat +1m>
6262 the =+1m= is a repeater; the intended interpretation is that the task
6263 has a deadline on =<2005-10-01>= and repeats itself every (one) month
6264 starting from that time. You can use yearly, monthly, weekly, daily
6265 and hourly repeat cookies by using the ~y/w/m/d/h~ letters. If you
6266 need both a repeater and a special warning period in a deadline entry,
6267 the repeater should come first and the warning period last: =DEADLINE:
6268 <2005-10-01 Sat +1m -3d>=.
6270 #+vindex: org-todo-repeat-to-state
6271 Deadlines and scheduled items produce entries in the agenda when they
6272 are over-due, so it is important to be able to mark such an entry as
6273 completed once you have done so. When you mark a =DEADLINE= or
6274 a =SCHEDULED= with the TODO keyword =DONE=, it no longer produces
6275 entries in the agenda. The problem with this is, however, is that
6276 then also the /next/ instance of the repeated entry will not be
6277 active. Org mode deals with this in the following way: when you try
6278 to mark such an entry DONE, using {{{kbd(C-c C-t)}}}, it shifts the
6279 base date of the repeating timestamp by the repeater interval, and
6280 immediately sets the entry state back to TODO[fn:69]. In the example
6281 above, setting the state to DONE would actually switch the date like
6285 ,** TODO Pay the rent
6286 DEADLINE: <2005-11-01 Tue +1m>
6289 To mark a task with a repeater as DONE, use {{{kbd(C-- 1 C-c C-t)}}},
6290 i.e., ~org-todo~ with a numeric prefix argument of =-1=.
6292 #+vindex: org-log-repeat
6293 A timestamp[fn:70] is added under the deadline, to keep a record that
6294 you actually acted on the previous instance of this deadline.
6296 As a consequence of shifting the base date, this entry is no longer
6297 visible in the agenda when checking past dates, but all future
6298 instances will be visible.
6300 With the =+1m= cookie, the date shift is always exactly one month. So
6301 if you have not paid the rent for three months, marking this entry
6302 DONE still keeps it as an overdue deadline. Depending on the task,
6303 this may not be the best way to handle it. For example, if you forgot
6304 to call your father for 3 weeks, it does not make sense to call him
6305 3 times in a single day to make up for it. Finally, there are tasks
6306 like changing batteries which should always repeat a certain time
6307 /after/ the last time you did it. For these tasks, Org mode has
6308 special repeaters =++= and =.+=. For example:
6311 ,** TODO Call Father
6312 DEADLINE: <2008-02-10 Sun ++1w>
6313 Marking this DONE shifts the date by at least one week, but also
6314 by as many weeks as it takes to get this date into the future.
6315 However, it stays on a Sunday, even if you called and marked it
6318 ,** TODO Empty kitchen trash
6319 DEADLINE: <2008-02-08 Fri 20:00 ++1d>
6320 Marking this DONE shifts the date by at least one day, and also
6321 by as many days as it takes to get the timestamp into the future.
6322 Since there is a time in the timestamp, the next deadline in the
6323 future will be on today's date if you complete the task before
6326 ,** TODO Check the batteries in the smoke detectors
6327 DEADLINE: <2005-11-01 Tue .+1m>
6328 Marking this DONE will shift the date to one month after today.
6331 #+vindex: org-agenda-skip-scheduled-if-deadline-is-shown
6332 You may have both scheduling and deadline information for a specific
6333 task. If the repeater is set for the scheduling information only, you
6334 probably want the repeater to be ignored after the deadline. If so,
6335 set the variable ~org-agenda-skip-scheduled-if-deadline-is-shown~ to
6336 ~repeated-after-deadline~. However, any scheduling information
6337 without a repeater is no longer relevant once the task is done, and
6338 thus, removed upon repeating the task. If you want both scheduling
6339 and deadline information to repeat after the same interval, set the
6340 same repeater for both timestamps.
6342 An alternative to using a repeater is to create a number of copies of
6343 a task subtree, with dates shifted in each copy. The command
6344 {{{kbd(C-c C-x c)}}} was created for this purpose; it is described in
6345 [[*Structure Editing]].
6347 ** Clocking Work Time
6349 :DESCRIPTION: Tracking how long you spend on a task.
6351 #+cindex: clocking time
6352 #+cindex: time clocking
6354 Org mode allows you to clock the time you spend on specific tasks in
6355 a project. When you start working on an item, you can start the
6356 clock. When you stop working on that task, or when you mark the task
6357 done, the clock is stopped and the corresponding time interval is
6358 recorded. It also computes the total time spent on each
6359 subtree[fn:71] of a project. And it remembers a history or tasks
6360 recently clocked, to that you can jump quickly between a number of
6361 tasks absorbing your time.
6363 To save the clock history across Emacs sessions, use:
6365 #+begin_src emacs-lisp
6366 (setq org-clock-persist 'history)
6367 (org-clock-persistence-insinuate)
6370 #+vindex: org-clock-persist
6371 When you clock into a new task after resuming Emacs, the incomplete
6372 clock[fn:72] is retrieved (see [[*Resolving idle time]]) and you are
6373 prompted about what to do with it.
6375 *** Clocking commands
6377 :DESCRIPTION: Starting and stopping a clock.
6380 #+attr_texinfo: :sep ,
6381 - {{{kbd(C-c C-x C-i)}}} (~org-clock-in~) ::
6383 #+kindex: C-c C-x C-i
6384 #+findex: org-clock-in
6385 #+vindex: org-clock-into-drawer
6386 #+vindex: org-clock-continuously
6387 #+cindex: @samp{LOG_INTO_DRAWER}, property
6388 Start the clock on the current item (clock-in). This inserts the
6389 CLOCK keyword together with a timestamp. If this is not the
6390 first clocking of this item, the multiple CLOCK lines are wrapped
6391 into a =LOGBOOK= drawer (see also the variable
6392 ~org-clock-into-drawer~). You can also overrule the setting of
6393 this variable for a subtree by setting a =CLOCK_INTO_DRAWER= or
6394 =LOG_INTO_DRAWER= property. When called with a {{{kbd(C-u)}}}
6395 prefix argument, select the task from a list of recently clocked
6396 tasks. With two {{{kbd(C-u C-u)}}} prefixes, clock into the task
6397 at point and mark it as the default task; the default task is
6398 always be available with letter {{{kbd(d)}}} when selecting
6399 a clocking task. With three {{{kbd(C-u C-u C-u)}}} prefixes,
6400 force continuous clocking by starting the clock when the last
6403 #+cindex: @samp{CLOCK_MODELINE_TOTAL}, property
6404 #+cindex: @samp{LAST_REPEAT}, property
6405 #+vindex: org-clock-mode-line-total
6406 #+vindex: org-clock-in-prepare-hook
6407 While the clock is running, Org shows the current clocking time
6408 in the mode line, along with the title of the task. The clock
6409 time shown is all time ever clocked for this task and its
6410 children. If the task has an effort estimate (see [[*Effort
6411 Estimates]]), the mode line displays the current clocking time
6412 against it[fn:73]. If the task is a repeating one (see [[*Repeated
6413 tasks]]), show only the time since the last reset of the
6414 task[fn:74]. You can exercise more control over show time with
6415 the =CLOCK_MODELINE_TOTAL= property. It may have the values
6416 =current= to show only the current clocking instance, =today= to
6417 show all time clocked on this tasks today---see also the
6418 variable ~org-extend-today-until~, ~all~ to include all time, or
6419 ~auto~ which is the default[fn:75]. Clicking with
6420 {{{kbd(mouse-1)}}} onto the mode line entry pops up a menu with
6423 - {{{kbd(C-c C-x C-o)}}} (~org-clock-out~) ::
6425 #+kindex: C-c C-x C-o
6426 #+findex: org-clock-out
6427 #+vindex: org-log-note-clock-out
6428 Stop the clock (clock-out). This inserts another timestamp at
6429 the same location where the clock was last started. It also
6430 directly computes the resulting time in inserts it after the time
6431 range as ==>HH:MM=. See the variable ~org-log-note-clock-out~
6432 for the possibility to record an additional note together with
6433 the clock-out timestamp[fn:76].
6435 - {{{kbd(C-c C-x C-x)}}} (~org-clock-in-last~) ::
6437 #+kindex: C-c C-x C-x
6438 #+findex: org-clock-in-last
6439 #+vindex: org-clock-continuously
6440 Re-clock the last clocked task. With one {{{kbd(C-u)}}} prefix
6441 argument, select the task from the clock history. With two
6442 {{{kbd(C-u)}}} prefixes, force continuous clocking by starting
6443 the clock when the last clock stopped.
6445 - {{{kbd(C-c C-x C-e)}}} (~org-clock-modify-effort-estimate~) ::
6447 #+kindex: C-c C-x C-e
6448 #+findex: org-clock-modify-effort-estimate
6449 Update the effort estimate for the current clock task.
6451 - {{{kbd(C-c C-c)}}} or {{{kbd(C-c C-y)}}} (~org-evaluate-time-range~) ::
6455 #+findex: org-evaluate-time-range
6456 Recompute the time interval after changing one of the timestamps.
6457 This is only necessary if you edit the timestamps directly. If
6458 you change them with {{{kbd(S-<cursor>)}}} keys, the update is
6461 - {{{kbd(C-S-UP)}}} (~org-clock-timestamps-up~), {{{kbd(C-S-DOWN)}}} (~org-clock-timestamps-down~) ::
6464 #+findex: org-clock-timestamps-up
6466 #+findex: org-clock-timestamps-down
6467 On CLOCK log lines, increase/decrease both timestamps so that the
6468 clock duration keeps the same value.
6470 - {{{kbd(S-M-UP)}}} (~org-timestamp-up~), {{{kbd(S-M-DOWN)}}} (~org-timestamp-down~) ::
6473 #+findex: org-clock-timestamp-up
6475 #+findex: org-clock-timestamp-down
6476 On =CLOCK= log lines, increase/decrease the timestamp at point
6477 and the one of the previous, or the next, clock timestamp by the
6478 same duration. For example, if you hit {{{kbd(S-M-UP)}}} to
6479 increase a clocked-out timestamp by five minutes, then the
6480 clocked-in timestamp of the next clock is increased by five
6483 - {{{kbd(C-c C-t)}}} (~org-todo~) ::
6487 Changing the TODO state of an item to DONE automatically stops
6488 the clock if it is running in this same item.
6490 - {{{kbd(C-c C-x C-q)}}} (~org-clock-cancel~) ::
6492 #+kindex: C-c C-x C-q
6493 #+findex: org-clock-cancel
6494 Cancel the current clock. This is useful if a clock was started
6495 by mistake, or if you ended up working on something else.
6497 - {{{kbd(C-c C-x C-j)}}} (~org-clock-goto~) ::
6499 #+kindex: C-c C-x C-j
6500 #+findex: or-clock-goto
6501 Jump to the headline of the currently clocked in task. With
6502 a {{{kbd(C-u)}}} prefix argument, select the target task from
6503 a list of recently clocked tasks.
6505 - {{{kbd(C-c C-x C-d)}}} (~org-clock-display~) ::
6507 #+kindex: C-c C-x C-d
6508 #+findex: org-clock-display
6509 #+vindex: org-remove-highlights-with-change
6510 Display time summaries for each subtree in the current buffer.
6511 This puts overlays at the end of each headline, showing the total
6512 time recorded under that heading, including the time of any
6513 subheadings. You can use visibility cycling to study the tree,
6514 but the overlays disappear when you change the buffer (see
6515 variable ~org-remove-highlights-with-change~) or press {{{kbd(C-c
6518 The {{{kbd(l)}}} key may be used in the agenda (see [[*Weekly/daily
6519 agenda]]) to show which tasks have been worked on or closed during
6522 *Important:* note that both ~org-clock-out~ and ~org-clock-in-last~
6523 can have a global keybinding and do not modify the window disposition.
6527 :DESCRIPTION: Detailed reports.
6529 #+cindex: clocktable, dynamic block
6530 #+cindex: report, of clocked time
6532 Org mode can produce quite complex reports based on the time clocking
6533 information. Such a report is called a /clock table/, because it is
6534 formatted as one or several Org tables.
6536 #+attr_texinfo: :sep ,
6537 - {{{kbd(C-c C-x C-r)}}} (~org-clock-report~) ::
6539 #+kindex: C-c C-x C-r
6540 #+findex: org-clock-report
6541 Insert a dynamic block (see [[*Dynamic Blocks]]) containing a clock
6542 report as an Org mode table into the current file. When the
6543 cursor is at an existing clock table, just update it. When
6544 called with a prefix argument, jump to the first clock report in
6545 the current document and update it. The clock table includes
6548 - {{{kbd(C-c C-c)}}} or {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) ::
6551 #+kindex: C-c C-x C-u
6552 #+findex: org-dblock-update
6553 Update dynamic block at point. The cursor needs to be in the
6554 =BEGIN= line of the dynamic block.
6556 - {{{kbd(C-u C-c C-x C-u)}}} ::
6558 #+kindex: C-u C-c C-x C-u
6559 Update all dynamic blocks (see [[*Dynamic Blocks]]). This is useful
6560 if you have several clock table blocks in a buffer.
6562 - {{{kbd(S-LEFT)}}}, {{{kbd(S-RIGHT)}}} (~org-clocktable-try-shift~) ::
6566 #+findex: org-clocktable-try-shift
6567 Shift the current =:block= interval and update the table. The
6568 cursor needs to be in the =#+BEGIN: clocktable= line for this
6569 command. If =:block= is =today=, it is shifted to =today-1=,
6572 Here is an example of the frame for a clock table as it is inserted
6573 into the buffer with the {{{kbd(C-c C-x C-r)}}} command:
6575 #+cindex: @samp{BEGIN clocktable}
6577 ,#+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6581 #+texinfo: @noindent
6582 #+vindex: org-clocktable-defaults
6583 The =#+BEGIN= line and specify a number of options to define the
6584 scope, structure, and formatting of the report. Defaults for all
6585 these options can be configured in the variable
6586 ~org-clocktable-defaults~.
6588 #+texinfo: @noindent
6589 First there are options that determine which clock entries are to
6594 Maximum level depth to which times are listed in the table.
6595 Clocks at deeper levels are summed into the upper level.
6599 The scope to consider. This can be any of the following:
6601 | ~nil~ | the current buffer or narrowed region |
6602 | ~file~ | the full current buffer |
6603 | ~subtree~ | the subtree where the clocktable is located |
6604 | ~treeN~ | the surrounding level N tree, for example =tree3= |
6605 | ~tree~ | the surrounding level 1 tree |
6606 | ~agenda~ | all agenda files |
6607 | =("file" ...)= | scan these files |
6608 | =FUNCTION= | scan files returned by calling FUNCTION with no argument |
6609 | ~file-with-archives~ | current file and its archives |
6610 | ~agenda-with-archives~ | all agenda files, including archives |
6614 The time block to consider. This block is specified either
6615 absolutely, or relative to the current time and may be any of
6618 | =2007-12-31= | New year eve 2007 |
6619 | =2007-12= | December 2007 |
6620 | =2007-W50= | ISO-week 50 in 2007 |
6621 | =2007-Q2= | 2nd quarter in 2007 |
6622 | =2007= | the year 2007 |
6623 | ~today~, ~yesterday~, ~today-N~ | a relative day |
6624 | ~thisweek~, ~lastweek~, ~thisweek-N~ | a relative week |
6625 | ~thismonth~, ~lastmonth~, ~thismonth-N~ | a relative month |
6626 | ~thisyear~, ~lastyear~, ~thisyear-N~ | a relative year |
6627 | ~untilnow~ | all clocked time ever |
6629 #+vindex: org-clock-display-default-range
6630 When this option is not set, Org falls back to the value in
6631 ~org-clock-display-default-range~, which defaults to the current
6634 Use {{{kbd(S-LEFT)}}} or {{{kbd(S-RIGHT)}}} to shift the time
6639 A time string specifying when to start considering times.
6640 Relative times like ="<-2w>"= can also be used. See [[*Matching
6641 tags and properties]] for relative time syntax.
6645 A time string specifying when to stop considering times.
6646 Relative times like ="<now>"= can also be used. See [[*Matching
6647 tags and properties]] for relative time syntax.
6651 The starting day of the week. The default is 1 for Monday.
6655 The starting day of the month. The default is 1 for the first.
6659 Set to ~week~ or ~day~ to split the table into chunks. To use
6660 this, ~:block~ or ~:tstart~, ~:tend~ are needed.
6664 Do not show steps that have zero time.
6668 Do not show table sections from files which did not contribute.
6672 A tags match to select entries that should contribute. See
6673 [[*Matching tags and properties]] for the match syntax.
6675 #+findex: org-clocktable-write-default
6676 Then there are options that determine the formatting of the table.
6677 There options are interpreted by the function
6678 ~org-clocktable-write-default~, but you can specify your own function
6679 using the =:formatter= parameter.
6683 When ~t~, emphasize level one and level two items.
6687 Language[fn:77] to use for descriptive cells like "Task".
6691 Link the item headlines in the table to their origins.
6695 An integer to limit the width of the headline column in the Org
6696 table. If you write it like =50!=, then the headline is also
6697 shortened in export.
6701 Indent each headline field according to its level.
6705 Number of columns to be used for times. If this is smaller than
6706 =:maxlevel=, lower levels are lumped into one column.
6710 Should a level number column be included?
6714 A cons cell containing the column to sort and a sorting type.
6715 E.g., =:sort (1 . ?a)= sorts the first column alphabetically.
6719 Abbreviation for =:level nil :indent t :narrow 40! :tcolumns 1=.
6720 All are overwritten except if there is an explicit =:narrow=.
6724 A timestamp for the entry, when available. Look for SCHEDULED,
6725 DEADLINE, TIMESTAMP and TIMESTAMP_IA special properties (see
6726 [[*Special Properties]]), in this order.
6730 When this flag is non-~nil~, show the headline's tags.
6734 List of properties shown in the table. Each property gets its
6739 When this flag is non-~nil~, the values for =:properties= are
6744 Content of a =TBLFM= keyword to be added and evaluated. As
6745 a special case, =:formula %= adds a column with % time. If you
6746 do not specify a formula here, any existing formula below the
6747 clock table survives updates and is evaluated.
6751 A function to format clock data and insert it into the buffer.
6753 To get a clock summary of the current level 1 tree, for the current
6754 day, you could write:
6757 ,#+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6761 #+texinfo: @noindent
6762 To use a specific time range you could write[fn:78]
6765 ,#+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6766 :tend "<2006-08-10 Thu 12:00>"
6770 A range starting a week ago and ending right now could be written as
6773 ,#+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6777 A summary of the current subtree with % times would be:
6780 ,#+BEGIN: clocktable :scope subtree :link t :formula %
6784 A horizontally compact representation of everything clocked during
6788 ,#+BEGIN: clocktable :scope agenda :block lastweek :compact t
6792 *** Resolving idle time and continuous clocking
6794 :DESCRIPTION: Resolving time when you've been idle.
6795 :ALT_TITLE: Resolving idle time
6798 **** Resolving idle time
6803 #+cindex: resolve idle time
6804 #+cindex: idle, resolve, dangling
6806 If you clock in on a work item, and then walk away from your
6807 computer---perhaps to take a phone call---you often need to
6808 "resolve" the time you were away by either subtracting it from the
6809 current clock, or applying it to another one.
6811 #+vindex: org-clock-idle-time
6812 #+vindex: org-clock-x11idle-program-name
6813 By customizing the variable ~org-clock-idle-time~ to some integer,
6814 such as 10 or 15, Emacs can alert you when you get back to your
6815 computer after being idle for that many minutes[fn:79], and ask what
6816 you want to do with the idle time. There will be a question waiting
6817 for you when you get back, indicating how much idle time has passed
6818 constantly updated with the current amount, as well as a set of
6819 choices to correct the discrepancy:
6824 To keep some or all of the minutes and stay clocked in, press
6825 {{{kbd(k)}}}. Org asks how many of the minutes to keep. Press
6826 {{{kbd(RET)}}} to keep them all, effectively changing nothing, or
6827 enter a number to keep that many minutes.
6832 If you use the shift key and press {{{kbd(K)}}}, it keeps however
6833 many minutes you request and then immediately clock out of that
6834 task. If you keep all of the minutes, this is the same as just
6835 clocking out of the current task.
6840 To keep none of the minutes, use {{{kbd(s)}}} to subtract all the
6841 away time from the clock, and then check back in from the moment
6847 To keep none of the minutes and just clock out at the start of
6848 the away time, use the shift key and press {{{kbd(S)}}}.
6849 Remember that using shift always leave you clocked out, no matter
6850 which option you choose.
6855 To cancel the clock altogether, use {{{kbd(C)}}}. Note that if
6856 instead of canceling you subtract the away time, and the
6857 resulting clock amount is less than a minute, the clock is still
6858 canceled rather than cluttering up the log with an empty entry.
6860 What if you subtracted those away minutes from the current clock, and
6861 now want to apply them to a new clock? Simply clock in to any task
6862 immediately after the subtraction. Org will notice that you have
6863 subtracted time "on the books", so to speak, and will ask if you want
6864 to apply those minutes to the next task you clock in on.
6866 There is one other instance when this clock resolution magic occurs.
6867 Say you were clocked in and hacking away, and suddenly your cat chased
6868 a mouse who scared a hamster that crashed into your UPS's power
6869 button! You suddenly lose all your buffers, but thanks to auto-save
6870 you still have your recent Org mode changes, including your last clock
6873 If you restart Emacs and clock into any task, Org will notice that you
6874 have a dangling clock which was never clocked out from your last
6875 session. Using that clock's starting time as the beginning of the
6876 unaccounted-for period, Org will ask how you want to resolve that
6877 time. The logic and behavior is identical to dealing with away time
6878 due to idleness; it is just happening due to a recovery event rather
6879 than a set amount of idle time.
6881 You can also check all the files visited by your Org agenda for
6882 dangling clocks at any time using {{{kbd(M-x org-resolve-clocks
6883 RET)}}} (or {{{kbd(C-c C-x C-z)}}}).
6885 **** Continuous clocking
6889 #+cindex: continuous clocking
6891 #+vindex: org-clock-continuously
6892 You may want to start clocking from the time when you clocked out the
6893 previous task. To enable this systematically, set
6894 ~org-clock-continuously~ to non-~nil~. Each time you clock in, Org
6895 retrieves the clock-out time of the last clocked entry for this
6896 session, and start the new clock from there.
6898 If you only want this from time to time, use three universal prefix
6899 arguments with ~org-clock-in~ and two {{{kbd(C-u C-u)}}} with
6900 ~org-clock-in-last~.
6904 :DESCRIPTION: Planning work effort in advance.
6906 #+cindex: effort estimates
6907 #+cindex: @samp{EFFORT}, property
6908 #+vindex: org-effort-property
6910 If you want to plan your work in a very detailed way, or if you need
6911 to produce offers with quotations of the estimated work effort, you
6912 may want to assign effort estimates to entries. If you are also
6913 clocking your work, you may later want to compare the planned effort
6914 with the actual working time, a great way to improve planning
6915 estimates. Effort estimates are stored in a special property
6916 =EFFORT=. You can set the effort for an entry with the following
6919 - {{{kbd(C-c C-x e)}}} (~org-set-effort~) ::
6922 #+findex: org-set-effort
6923 Set the effort estimate for the current entry. With a prefix
6924 argument, set it to the next allowed value---see below. This
6925 command is also accessible from the agenda with the {{{kbd(e)}}}
6928 - {{{kbd(C-c C-x C-e)}}} (~org-clock-modify-effort-estimate~) ::
6930 #+kindex: C-c C-x C-e
6931 #+findex: org-clock-modify-effort-estimate
6932 Modify the effort estimate of the item currently being clocked.
6934 Clearly the best way to work with effort estimates is through column
6935 view (see [[*Column View]]). You should start by setting up discrete
6936 values for effort estimates, and a =COLUMNS= format that displays
6937 these values together with clock sums---if you want to clock your
6938 time. For a specific buffer you can use:
6941 ,#+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6942 ,#+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort){:} %CLOCKSUM
6946 #+vindex: org-global-properties
6947 #+vindex: org-columns-default-format
6948 or, even better, you can set up these values globally by customizing
6949 the variables ~org-global-properties~ and
6950 ~org-columns-default-format~. In particular if you want to use this
6951 setup also in the agenda, a global setup may be advised.
6953 The way to assign estimates to individual items is then to switch to
6954 column mode, and to use {{{kbd(S-RIGHT)}}} and {{{kbd(S-LEFT)}}} to
6955 change the value. The values you enter are immediately summed up in
6956 the hierarchy. In the column next to it, any clocked time is
6959 #+vindex: org-agenda-columns-add-appointments-to-effort-sum
6960 If you switch to column view in the daily/weekly agenda, the effort
6961 column summarizes the estimated work effort for each day[fn:80], and
6962 you can use this to find space in your schedule. To get an overview
6963 of the entire part of the day that is committed, you can set the
6964 option ~org-agenda-columns-add-appointments-to-effort-sum~. The
6965 appointments on a day that take place over a specified time interval
6966 are then also added to the load estimate of the day.
6968 Effort estimates can be used in secondary agenda filtering that is
6969 triggered with the {{{kbd(/)}}} key in the agenda (see [[*Commands in
6970 the Agenda Buffer]]). If you have these estimates defined consistently,
6971 two or three key presses narrow down the list to stuff that fits into
6972 an available time slot.
6974 ** Taking Notes with a Relative Timer
6976 :DESCRIPTION: Notes with a running timer.
6979 #+cindex: relative timer
6980 #+cindex: countdown timer
6982 Org provides two types of timers. There is a relative timer that
6983 counts up, which can be useful when taking notes during, for example,
6984 a meeting or a video viewing. There is also a countdown timer.
6986 The relative and countdown are started with separate commands.
6988 - {{{kbd(C-c C-x 0)}}} (~org-timer-start~) ::
6991 #+findex: org-timer-start
6992 Start or reset the relative timer. By default, the timer is set
6993 to 0. When called with a {{{kbd(C-u)}}} prefix, prompt the user
6994 for a starting offset. If there is a timer string at point, this
6995 is taken as the default, providing a convenient way to restart
6996 taking notes after a break in the process. When called with
6997 a double prefix argument {{{kbd(C-u C-u)}}}, change all timer
6998 strings in the active region by a certain amount. This can be
6999 used to fix timer strings if the timer was not started at exactly
7002 - {{{kbd(C-c C-x ;)}}} (~org-timer-set-timer~) ::
7005 #+findex: org-timer-set-timer
7006 #+vindex: org-timer-default-timer
7007 Start a countdown timer. The user is prompted for a duration.
7008 ~org-timer-default-timer~ sets the default countdown value.
7009 Giving a numeric prefix argument overrides this default value.
7010 This command is available as {{{kbd(;)}}} in agenda buffers.
7012 Once started, relative and countdown timers are controlled with the
7015 - {{{kbd(C-c C-x .)}}} (~org-timer~) ::
7019 Insert a relative time into the buffer. The first time you use
7020 this, the timer starts. Using a prefix argument restarts it.
7022 - {{{kbd(C-c C-x -)}}} (~org-timer-item~) ::
7025 #+findex: org-timer-item
7026 Insert a description list item with the current relative time.
7027 With a prefix argument, first reset the timer to 0.
7029 - {{{kbd(M-RET)}}} (~org-insert-heading~) ::
7032 #+findex: org-insert-heading
7033 Once the timer list is started, you can also use
7034 {{{kbd(M-RET)}}} to insert new timer items.
7036 - {{{kbd(C-c C-x \,)}}} (~org-timer-pause-or-continue~) ::
7039 #+findex: org-timer-pause-or-continue
7040 Pause the timer, or continue it if it is already paused.
7042 - {{{kbd(C-c C-x _)}}} (~org-timer-stop~) ::
7045 #+findex: org-timer-stop
7046 Stop the timer. After this, you can only start a new timer, not
7047 continue the old one. This command also removes the timer from
7050 * Capture, Refile, Archive
7052 :DESCRIPTION: The ins and outs for projects.
7056 An important part of any organization system is the ability to quickly
7057 capture new ideas and tasks, and to associate reference material with
7058 them. Org does this using a process called /capture/. It also can
7059 store files related to a task (/attachments/) in a special directory.
7060 Once in the system, tasks and projects need to be moved around.
7061 Moving completed project trees to an archive file keeps the system
7066 :DESCRIPTION: Capturing new stuff.
7070 Capture lets you quickly store notes with little interruption of your
7071 work flow. Org's method for capturing new items is heavily inspired
7072 by John Wiegley's excellent Remember package.
7074 *** Setting up capture
7076 :DESCRIPTION: Where notes will be stored.
7079 The following customization sets a default target file for notes.
7081 #+vindex: org-default-notes-file
7082 #+begin_src emacs-lisp
7083 (setq org-default-notes-file (concat org-directory "/notes.org"))
7086 You may also define a global key for capturing new material (see
7091 :DESCRIPTION: Commands to invoke and terminate capture.
7094 - {{{kbd(M-x org-capture)}}} (~org-capture~) ::
7096 #+findex: org-capture
7098 Display the capture templates menu. If you have templates
7099 defined (see [[*Capture templates]]), it offers these templates for
7100 selection or use a new Org outline node as the default template.
7101 It inserts the template into the target file and switch to an
7102 indirect buffer narrowed to this new node. You may then insert
7103 the information you want.
7105 - {{{kbd(C-c C-c)}}} (~org-capture-finalize~) ::
7107 #+kindex: C-c C-c @r{(Capture buffer)}
7108 #+findex: org-capture-finalize
7109 Once you have finished entering information into the capture
7110 buffer, {{{kbd(C-c C-c)}}} returns you to the window
7111 configuration before the capture process, so that you can resume
7112 your work without further distraction. When called with a prefix
7113 argument, finalize and then jump to the captured item.
7115 - {{{kbd(C-c C-w)}}} (~org-capture-refile~) ::
7117 #+kindex: C-c C-w @r{(Capture buffer)}
7118 #+findex: org-capture-refile
7119 Finalize the capture process by refiling the note to a different
7120 place (see [[*Refile and Copy]]). Please realize that this is
7121 a normal refiling command that will be executed---so the cursor
7122 position at the moment you run this command is important. If you
7123 have inserted a tree with a parent and children, first move the
7124 cursor back to the parent. Any prefix argument given to this
7125 command is passed on to the ~org-refile~ command.
7127 - {{{kbd(C-c C-k)}}} (~org-capture-kill~) ::
7129 #+kindex: C-c C-k @r{(Capture buffer)}
7130 #+findex: org-capture-kill
7131 Abort the capture process and return to the previous state.
7133 #+kindex: k c @r{(Agenda)}
7134 You can also call ~org-capture~ in a special way from the agenda,
7135 using the {{{kbd(k c)}}} key combination. With this access, any
7136 timestamps inserted by the selected capture template defaults to the
7137 cursor date in the agenda, rather than to the current date.
7139 To find the locations of the last stored capture, use ~org-capture~
7140 with prefix commands:
7142 - {{{kbd(C-u M-x org-capture)}}} ::
7144 Visit the target location of a capture template. You get to
7145 select the template in the usual way.
7147 - {{{kbd(C-u C-u M-x org-capture)}}} ::
7149 Visit the last stored capture item in its buffer.
7151 #+vindex: org-capture-bookmark
7152 #+vindex: org-capture-last-stored
7153 You can also jump to the bookmark ~org-capture-last-stored~, which is
7154 automatically created unless you set ~org-capture-bookmark~ to ~nil~.
7156 To insert the capture at point in an Org buffer, call ~org-capture~
7157 with a ~C-0~ prefix argument.
7159 *** Capture templates
7161 :DESCRIPTION: Define the outline of different note types.
7163 #+cindex: templates, for Capture
7165 You can use templates for different types of capture items, and for
7166 different target locations. The easiest way to create such templates
7167 is through the customize interface.
7171 #+kindex: C @r{(Capture menu}
7172 #+vindex: org-capture-templates
7173 Customize the variable ~org-capture-templates~.
7175 Before we give the formal description of template definitions, let's
7176 look at an example. Say you would like to use one template to create
7177 general TODO entries, and you want to put these entries under the
7178 heading =Tasks= in your file =~/org/gtd.org=. Also, a date tree in
7179 the file =journal.org= should capture journal entries. A possible
7180 configuration would look like:
7182 #+begin_src emacs-lisp
7183 (setq org-capture-templates
7184 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
7185 "* TODO %?\n %i\n %a")
7186 ("j" "Journal" entry (file+datetree "~/org/journal.org")
7187 "* %?\nEntered on %U\n %i\n %a")))
7190 #+texinfo: @noindent
7191 If you then press {{{kbd(t)}}} from the capture menu, Org will prepare
7192 the template for you like this:
7196 [[file:LINK TO WHERE YOU INITIATED CAPTURE]]
7199 #+texinfo: @noindent
7200 During expansion of the template, ~%a~ has been replaced by a link to
7201 the location from where you called the capture command. This can be
7202 extremely useful for deriving tasks from emails, for example. You
7203 fill in the task definition, press {{{kbd(C-c C-c)}}} and Org returns
7204 you to the same place where you started the capture process.
7206 To define special keys to capture to a particular template without
7207 going through the interactive template selection, you can create your
7208 key binding like this:
7210 #+begin_src emacs-lisp
7211 (define-key global-map "\C-cx"
7212 (lambda () (interactive) (org-capture nil "x")))
7215 **** Template elements
7217 :DESCRIPTION: What is needed for a complete template entry.
7220 Now lets look at the elements of a template definition. Each entry in
7221 ~org-capture-templates~ is a list with the following items:
7225 The keys that selects the template, as a string, characters only,
7226 for example ="a"=, for a template to be selected with a single
7227 key, or ="bt"= for selection with two keys. When using several
7228 keys, keys using the same prefix key must be sequential in the
7229 list and preceded by a 2-element entry explaining the prefix key,
7232 #+begin_src emacs-lisp
7233 ("b" "Templates for marking stuff to buy")
7236 #+texinfo: @noindent
7237 If you do not define a template for the {{{kbd(C)}}} key, this
7238 key opens the Customize buffer for this complex variable.
7242 A short string describing the template, shown during selection.
7246 The type of entry, a symbol. Valid values are:
7250 An Org mode node, with a headline. Will be filed as the child
7251 of the target entry or as a top-level entry. The target file
7252 should be an Org file.
7256 A plain list item, placed in the first plain list at the
7257 target location. Again the target file should be an Org
7262 A checkbox item. This only differs from the plain list item
7263 by the default template.
7267 A new line in the first table at the target location. Where
7268 exactly the line will be inserted depends on the properties
7269 ~:prepend~ and ~:table-line-pos~ (see below).
7273 Text to be inserted as it is.
7277 #+vindex: org-default-notes-file
7278 #+vindex: org-directory
7279 Specification of where the captured item should be placed. In
7280 Org files, targets usually define a node. Entries will become
7281 children of this node. Other types will be added to the table or
7282 list in the body of this node. Most target specifications
7283 contain a file name. If that file name is the empty string, it
7284 defaults to ~org-default-notes-file~. A file can also be given
7285 as a variable or as a function called with no argument. When an
7286 absolute path is not specified for a target, it is taken as
7287 relative to ~org-directory~.
7291 - =(file "path/to/file")= ::
7293 Text will be placed at the beginning or end of that file.
7295 - =(id "id of existing org entry")= ::
7297 Filing as child of this entry, or in the body of the entry.
7299 - =(file+headline "filename" "node headline")= ::
7301 Fast configuration if the target heading is unique in the file.
7303 - =(file+olp "filename" "Level 1 heading" "Level 2" ...)= ::
7305 For non-unique headings, the full path is safer.
7307 - =(file+regexp "filename" "regexp to find location")= ::
7309 Use a regular expression to position the cursor.
7311 - =(file+olp+datetree "filename" [ "Level 1 heading" ...])= ::
7313 This target[fn:81] creates a heading in a date tree[fn:82] for
7314 today's date. If the optional outline path is given, the tree
7315 will be built under the node it is pointing to, instead of at
7316 top level. Check out the ~:time-prompt~ and ~:tree-type~
7317 properties below for additional options.
7319 - ~(file+function "filename" function-finding-location)~ ::
7321 A function to find the right location in the file.
7325 File to the entry that is currently being clocked.
7327 - ~(function function-finding-location)~ ::
7329 Most general way: write your own function which both visits the
7330 file and moves point to the right location.
7334 The template for creating the capture item. If you leave this
7335 empty, an appropriate default template will be used. Otherwise
7336 this is a string with escape codes, which will be replaced
7337 depending on time and context of the capture call. The string
7338 with escapes may be loaded from a template file, using the
7339 special syntax =(file "template filename")=. See below for more
7344 The rest of the entry is a property list of additional options.
7345 Recognized properties are:
7349 Normally new captured information will be appended at the
7350 target location (last child, last table line, last list item,
7351 ...). Setting this property changes that.
7353 - ~:immediate-finish~ ::
7355 When set, do not offer to edit the information, just file it
7356 away immediately. This makes sense if the template only needs
7357 information that can be added automatically.
7361 Set this to the number of lines to insert before and after the
7362 new item. Default 0, and the only other common value is 1.
7366 Start the clock in this item.
7370 Keep the clock running when filing the captured entry.
7372 - ~:clock-resume~ ::
7374 If starting the capture interrupted a clock, restart that clock
7375 when finished with the capture. Note that ~:clock-keep~ has
7376 precedence over ~:clock-resume~. When setting both to
7377 non-~nil~, the current clock will run and the previous one will
7382 Prompt for a date/time to be used for date/week trees and when
7383 filling the template. Without this property, capture uses the
7384 current date and time. Even if this property has not been set,
7385 you can force the same behavior by calling ~org-capture~ with
7386 a {{{kbd(C-1)}}} prefix argument.
7390 When ~week~, make a week tree instead of the month tree, i.e.,
7391 place the headings for each day under a heading with the
7396 Do not narrow the target buffer, simply show the full buffer. Default
7397 is to narrow it so that you only see the new material.
7399 - ~:table-line-pos~ ::
7401 Specification of the location in the table where the new line
7402 should be inserted. It should be a string like =II-3= meaning
7403 that the new line should become the third line before the
7404 second horizontal separator line.
7408 If the target file was not yet visited when capture was invoked, kill
7409 the buffer again after capture is completed.
7411 **** Template expansion
7413 :DESCRIPTION: Filling in information about time and context.
7416 In the template itself, special "%-escapes"[fn:83] allow dynamic
7417 insertion of content. The templates are expanded in the order given
7422 Insert the contents of the file given by {{{var(FILE)}}}.
7426 Evaluate Elisp SEXP and replace with the result. The
7427 {{{var(SEXP)}}} must return a string.
7431 The result of format-time-string on the {{{var(FORMAT)}}}
7436 Timestamp, date only.
7440 Timestamp, with date and time.
7444 Like ~%t~, ~%T~ above, but inactive timestamps.
7448 Initial content, the region when capture is called while the
7449 region is active. The entire text will be indented like ~%i~
7454 Annotation, normally the link created with ~org-store-link~.
7458 Like ~%a~, but prompt for the description part.
7462 Like ~%a~, but only insert the literal link.
7466 Current kill ring head.
7470 Content of the X clipboard.
7474 Title of the currently clocked task.
7478 Link to the currently clocked task.
7482 User name (taken from ~user-full-name~).
7486 File visited by current buffer when org-capture was called.
7490 Full path of the file or directory visited by current buffer.
7494 Specific information for certain link types, see below.
7498 Prompt for tags, with completion on tags in target file.
7502 Prompt for tags, with completion all tags in all agenda files.
7506 Like ~%t~, but prompt for date. Similarly ~%^T~, ~%^u~, ~%^U~. You may
7507 define a prompt like ~%^{Birthday}t~.
7511 Interactive selection of which kill or clip to use.
7515 Like ~%^C~, but insert as link.
7519 Prompt the user for a value for property PROP.
7523 Prompt the user for a string and replace this sequence with it.
7524 You may specify a default value and a completion table with
7525 ~%^{prompt|default|completion2|completion3...}~. The arrow keys
7526 access a prompt-specific history.
7530 Insert the text entered at the Nth ~%^{PROMPT}~, where N is
7531 a number, starting from 1.
7535 After completing the template, position cursor here.
7537 #+texinfo: @noindent
7538 #+vindex: org-store-link-props
7539 For specific link types, the following keywords are defined[fn:84]:
7541 #+vindex: org-from-is-user-regexp
7542 | Link type | Available keywords |
7543 |--------------+----------------------------------------------------------|
7544 | bbdb | ~%:name~, ~%:company~ |
7545 | irc | ~%:server~, ~%:port~, ~%:nick~ |
7546 | mh, rmail | ~%:type~, ~%:subject~, ~%:message-id~ |
7547 | | ~%:from~, ~%:fromname~, ~%:fromaddress~ |
7548 | | ~%:to~, ~%:toname~, ~%:toaddress~ |
7549 | | ~%:date~ (message date header field) |
7550 | | ~%:date-timestamp~ (date as active timestamp) |
7551 | | ~%:date-timestamp-inactive~ (date as inactive timestamp) |
7552 | | ~%:fromto~ (either "to NAME" or "from NAME")[fn:85] |
7553 | gnus | ~%:group~, for messages also all email fields |
7554 | w3, w3m | ~%:url~ |
7555 | info | ~%:file~, ~%:node~ |
7556 | calendar | ~%:date~ |
7557 | org-protocol | ~%:link~, ~%:description~, ~%:annotation~ |
7559 **** Templates in contexts
7561 :DESCRIPTION: Only show a template in a specific context.
7564 #+vindex: org-capture-templates-contexts
7565 To control whether a capture template should be accessible from
7566 a specific context, you can customize
7567 ~org-capture-templates-contexts~. Let's say, for example, that you
7568 have a capture template "p" for storing Gnus emails containing
7569 patches. Then you would configure this option like this:
7571 #+begin_src emacs-lisp
7572 (setq org-capture-templates-contexts
7573 '(("p" (in-mode . "message-mode"))))
7576 You can also tell that the command key {{{kbd(p)}}} should refer to
7577 another template. In that case, add this command key like this:
7579 #+begin_src emacs-lisp
7580 (setq org-capture-templates-contexts
7581 '(("p" "q" (in-mode . "message-mode"))))
7584 See the docstring of the variable for more information.
7588 :DESCRIPTION: Add files to tasks.
7590 #+cindex: attachments
7591 #+vindex: org-attach-directory
7593 It is often useful to associate reference material with an outline
7594 node/task. Small chunks of plain text can simply be stored in the
7595 subtree of a project. Hyperlinks (see [[*Hyperlinks]]) can establish
7596 associations with files that live elsewhere on your computer or in the
7597 cloud, like emails or source code files belonging to a project.
7598 Another method is /attachments/, which are files located in
7599 a directory belonging to an outline node. Org uses directories named
7600 by the unique ID of each entry. These directories are located in the
7601 ~data~ directory which lives in the same directory where your Org file
7602 lives[fn:86]. If you initialize this directory with =git init=, Org
7603 automatically commits changes when it sees them. The attachment
7604 system has been contributed to Org by John Wiegley.
7606 In cases where it seems better to do so, you can attach a directory of
7607 your choice to an entry. You can also make children inherit the
7608 attachment directory from a parent, so that an entire subtree uses the
7609 same attached directory.
7611 #+texinfo: @noindent
7612 The following commands deal with attachments:
7614 - {{{kbd(C-c C-a)}}} (~org-attach~) ::
7617 #+findex: org-attach
7618 The dispatcher for commands related to the attachment system.
7619 After these keys, a list of commands is displayed and you must
7620 press an additional key to select a command:
7622 - {{{kbd(a)}}} (~org-attach-attach~) ::
7625 #+findex: org-attach-attach
7626 #+vindex: org-attach-method
7627 Select a file and move it into the task's attachment
7628 directory. The file is copied, moved, or linked, depending
7629 on ~org-attach-method~. Note that hard links are not
7630 supported on all systems.
7632 - {{{kbd(c)}}}/{{{kbd(m)}}}/{{{kbd(l)}}} ::
7637 Attach a file using the copy/move/link method. Note that
7638 hard links are not supported on all systems.
7640 - {{{kbd(n)}}} (~org-attach-new~) ::
7643 #+findex: org-attach-new
7644 Create a new attachment as an Emacs buffer.
7646 - {{{kbd(z)}}} (~org-attach-sync~) ::
7649 #+findex: org-attach-sync
7650 Synchronize the current task with its attachment directory, in case
7651 you added attachments yourself.
7653 - {{{kbd(o)}}} (~org-attach-open~) ::
7656 #+findex: org-attach-open
7657 #+vindex: org-file-apps
7658 Open current task's attachment. If there is more than one,
7659 prompt for a file name first. Opening follows the rules set
7660 by ~org-file-apps~. For more details, see the information
7661 on following hyperlinks (see [[*Handling Links]]).
7663 - {{{kbd(O)}}} (~org-attach-open-in-emacs~) ::
7666 #+findex: org-attach-open-in-emacs
7667 Also open the attachment, but force opening the file in
7670 - {{{kbd(f)}}} (~org-attach-reveal~) ::
7673 #+findex: org-attach-reveal
7674 Open the current task's attachment directory.
7676 - {{{kbd(F)}}} (~org-attach-reveal-in-emacs~) ::
7679 #+findex: org-attach-reveal-in-emacs
7680 Also open the directory, but force using Dired in Emacs.
7682 - {{{kbd(d)}}} (~org-attach-delete-one~) ::
7685 Select and delete a single attachment.
7687 - {{{kbd(D)}}} (~org-attach-delete-all~) ::
7690 Delete all of a task's attachments. A safer way is to open
7691 the directory in Dired and delete from there.
7693 - {{{kbd(s)}}} (~org-attach-set-directory~) ::
7696 #+cindex: @samp{ATTACH_DIR}, property
7697 Set a specific directory as the entry's attachment
7698 directory. This works by putting the directory path into
7699 the =ATTACH_DIR= property.
7701 - {{{kbd(i)}}} (~org-attach-set-inherit~) ::
7704 #+cindex: @samp{ATTACH_DIR_INHERIT}, property
7705 Set the =ATTACH_DIR_INHERIT= property, so that children use
7706 the same directory for attachments as the parent does.
7708 #+cindex: attach from Dired
7709 #+findex: org-attach-dired-to-subtree
7710 It is possible to attach files to a subtree from a Dired buffer. To
7711 use this feature, have one window in Dired mode containing the file(s)
7712 to be attached and another window with point in the subtree that shall
7713 get the attachments. In the Dired window, with point on a file,
7714 {{{kbd(M-x org-attach-dired-to-subtree)}}} attaches the file to the
7715 subtree using the attachment method set by variable
7716 ~org-attach-method~. When files are marked in the Dired window then
7717 all marked files get attached.
7719 Add the following lines to the Emacs init file to have {{{kbd(C-c C-x
7720 a)}}} attach files in Dired buffers.
7722 #+begin_src emacs-lisp
7723 (add-hook 'dired-mode-hook
7725 (define-key dired-mode-map
7727 #'org-attach-dired-to-subtree))))
7730 The following code shows how to bind the previous command with
7731 a specific attachment method.
7733 #+begin_src emacs-lisp
7734 (add-hook 'dired-mode-hook
7736 (define-key dired-mode-map (kbd "C-c C-x c")
7739 (let ((org-attach-method 'cp))
7740 (call-interactively #'org-attach-dired-to-subtree))))))
7745 :DESCRIPTION: Getting input from RSS feeds.
7748 #+cindex: Atom feeds
7750 Org can add and change entries based on information found in RSS feeds
7751 and Atom feeds. You could use this to make a task out of each new
7752 podcast in a podcast feed. Or you could use a phone-based
7753 note-creating service on the web to import tasks into Org. To access
7754 feeds, configure the variable ~org-feed-alist~. The docstring of this
7755 variable has detailed information. With the following
7757 #+begin_src emacs-lisp
7758 (setq org-feed-alist
7760 "http://rss.slashdot.org/Slashdot/slashdot"
7761 "~/txt/org/feeds.org" "Slashdot Entries")))
7764 #+texinfo: @noindent
7765 new items from the feed provided by =rss.slashdot.org= result in new
7766 entries in the file =~/org/feeds.org= under the heading =Slashdot
7767 Entries=, whenever the following command is used:
7769 - {{{kbd(C-c C-x g)}}} (~org-feed-update-all~) ::
7772 Collect items from the feeds configured in ~org-feed-alist~ and
7775 - {{{kbd(C-c C-x G)}}} (~org-feed-goto-inbox~) ::
7778 Prompt for a feed name and go to the inbox configured for this feed.
7780 Under the same headline, Org creates a drawer =FEEDSTATUS= in which it
7781 stores information about the status of items in the feed, to avoid
7782 adding the same item several times.
7784 For more information, including how to read atom feeds, see
7785 =org-feed.el= and the docstring of ~org-feed-alist~.
7787 ** Protocols for External Access
7789 :DESCRIPTION: External access to Emacs and Org.
7790 :ALT_TITLE: Protocols
7792 #+cindex: protocols, for external access
7794 Org protocol is a means to trigger custom actions in Emacs from
7795 external applications. Any application that supports calling external
7796 programs with an URL as argument may be used with this functionality.
7797 For example, you can configure bookmarks in your web browser to send
7798 a link to the current page to Org and create a note from it using
7799 capture (see [[*Capture]]). You can also create a bookmark that tells
7800 Emacs to open the local source file of a remote website you are
7803 #+cindex: Org protocol, set-up
7804 #+cindex: Installing Org protocol
7805 In order to use Org protocol from an application, you need to register
7806 =org-protocol://= as a valid scheme-handler. External calls are
7807 passed to Emacs through the =emacsclient= command, so you also need to
7808 ensure an Emacs server is running. More precisely, when the
7811 : emacsclient org-protocol://PROTOCOL?key1=val1&key2=val2
7813 #+texinfo: @noindent
7814 Emacs calls the handler associated to {{{var(PROTOCOL)}}} with
7815 argument =(:key1 val1 :key2 val2)=.
7817 #+cindex: protocol, new protocol
7818 #+cindex: defining new protocols
7819 Org protocol comes with three predefined protocols, detailed in the
7820 following sections. Configure ~org-protocol-protocol-alist~ to define
7823 *** ~store-link~ protocol
7825 :DESCRIPTION: Store a link, push URL to kill-ring.
7827 #+cindex: store-link protocol
7828 #+cindex: protocol, store-link
7830 Using ~store-link~ handler, you can copy links, insertable through
7831 {{{kbd(M-x org-insert-link)}}} or yanking thereafter. More precisely,
7834 : emacsclient org-protocol://store-link?url=URL&title=TITLE
7836 #+texinfo: @noindent
7837 stores the following link:
7841 In addition, {{{var(URL)}}} is pushed on the kill-ring for yanking.
7842 You need to encode {{{var(URL)}}} and {{{var(TITLE)}}} if they contain
7843 slashes, and probably quote those for the shell.
7845 To use this feature from a browser, add a bookmark with an arbitrary
7846 name, e.g., =Org: store-link= and enter this as /Location/:
7849 javascript:location.href='org-protocol://store-link?url='+
7850 encodeURIComponent(location.href);
7853 *** ~capture~ protocol
7855 :DESCRIPTION: Fill a buffer with external information.
7857 #+cindex: capture protocol
7858 #+cindex: protocol, capture
7860 Activating "capture" handler pops up a =Capture= buffer and fills the
7861 capture template associated to the =X= key with them.
7863 : emacsclient org-protocol://capture?template=X?url=URL?title=TITLE?body=BODY
7865 To use this feature, add a bookmark with an arbitrary name, e.g.
7866 =Org: capture= and enter this as =Location=:
7869 javascript:location.href='org-protocol://capture?template=x'+
7870 '&url='+encodeURIComponent(window.location.href)+
7871 '&title='+encodeURIComponent(document.title)+
7872 '&body='+encodeURIComponent(window.getSelection());
7875 #+vindex: org-protocol-default-template-key
7876 The result depends on the capture template used, which is set in the
7877 bookmark itself, as in the example above, or in
7878 ~org-protocol-default-template-key~.
7880 The following template placeholders are available:
7884 %:description The webpage title
7885 %:annotation Equivalent to [[%:link][%:description]]
7886 %i The selected text
7889 *** ~open-source~ protocol
7891 :DESCRIPTION: Edit published contents.
7893 #+cindex: open-source protocol
7894 #+cindex: protocol, open-source
7896 The ~open-source~ handler is designed to help with editing local
7897 sources when reading a document. To that effect, you can use
7898 a bookmark with the following location:
7901 javascript:location.href='org-protocol://open-source?&url='+
7902 encodeURIComponent(location.href)
7905 #+vindex: org-protocol-project-alist
7906 The variable ~org-protocol-project-alist~ maps URLs to local file
7907 names, by stripping URL parameters from the end and replacing the
7908 ~:base-url~ with ~:working-directory~ and ~:online-suffix~ with
7909 ~:working-suffix~. For example, assuming you own a local copy of
7910 =https://orgmode.org/worg/= contents at =/home/user/worg=, you can set
7911 ~org-protocol-project-alist~ to the following
7913 #+begin_src emacs-lisp
7914 (setq org-protocol-project-alist
7916 :base-url "https://orgmode.org/worg/"
7917 :working-directory "/home/user/worg/"
7918 :online-suffix ".html"
7919 :working-suffix ".org")))
7922 #+texinfo: @noindent
7923 If you are now browsing
7924 =https://orgmode.org/worg/org-contrib/org-protocol.html= and find
7925 a typo or have an idea about how to enhance the documentation, simply
7926 click the bookmark and start editing.
7928 #+cindex: rewritten URL in open-source protocol
7929 #+cindex: protocol, open-source rewritten URL
7930 However, such mapping may not yield the desired results. Suppose you
7931 maintain an online store located at =http://example.com/=. The local
7932 sources reside in =/home/user/example/=. It is common practice to
7933 serve all products in such a store through one file and rewrite URLs
7934 that do not match an existing file on the server. That way, a request
7935 to =http://example.com/print/posters.html= might be rewritten on the
7936 server to something like
7937 =http://example.com/shop/products.php/posters.html.php=. The
7938 ~open-source~ handler probably cannot find a file named
7939 =/home/user/example/print/posters.html.php= and fails.
7941 Such an entry in ~org-protocol-project-alist~ may hold an additional
7942 property ~:rewrites~. This property is a list of cons cells, each of
7943 which maps a regular expression to a path relative to the
7944 ~:working-directory~.
7946 Now map the URL to the path =/home/user/example/products.php= by
7947 adding ~:rewrites~ rules like this:
7949 #+begin_src emacs-lisp
7950 (setq org-protocol-project-alist
7952 :base-url "http://example.com/"
7953 :working-directory "/home/user/example/"
7954 :online-suffix ".php"
7955 :working-suffix ".php"
7956 :rewrites (("example.com/print/" . "products.php")
7957 ("example.com/$" . "index.php")))))
7960 #+texinfo: @noindent
7961 Since =example.com/$= is used as a regular expression, it maps
7962 =http://example.com/=, =https://example.com=,
7963 =http://www.example.com/= and similar to
7964 =/home/user/example/index.php=.
7966 The ~:rewrites~ rules are searched as a last resort if and only if no
7967 existing file name is matched.
7969 #+cindex: protocol, open-source, set-up mapping
7970 #+cindex: mappings in open-source protocol
7971 #+findex: org-protocol-create
7972 #+findex: org-protocol-create-for-org
7973 Two functions can help you filling ~org-protocol-project-alist~ with
7974 valid contents: ~org-protocol-create~ and
7975 ~org-protocol-create-for-org~. The latter is of use if you're editing
7976 an Org file that is part of a publishing project.
7980 :DESCRIPTION: Moving/copying a tree from one place to another.
7982 #+cindex: refiling notes
7983 #+cindex: copying notes
7985 When reviewing the captured data, you may want to refile or to copy
7986 some of the entries into a different list, for example into a project.
7987 Cutting, finding the right location, and then pasting the note is
7988 cumbersome. To simplify this process, you can use the following
7991 - {{{kbd(C-c M-w)}}} (~org-copy~) ::
7995 Copying works like refiling, except that the original note is not
7998 - {{{kbd(C-c C-w)}}} (~org-refile~) ::
8001 #+findex: org-refile
8002 #+vindex: org-reverse-note-order
8003 #+vindex: org-refile-targets
8004 #+vindex: org-refile-use-outline-path
8005 #+vindex: org-outline-path-complete-in-steps
8006 #+vindex: org-refile-allow-creating-parent-nodes
8007 #+vindex: org-log-refile
8008 Refile the entry or region at point. This command offers
8009 possible locations for refiling the entry and lets you select one
8010 with completion. The item (or all items in the region) is filed
8011 below the target heading as a subitem. Depending on
8012 ~org-reverse-note-order~, it is either the first or last subitem.
8014 By default, all level 1 headlines in the current buffer are
8015 considered to be targets, but you can have more complex
8016 definitions across a number of files. See the variable
8017 ~org-refile-targets~ for details. If you would like to select
8018 a location via a file-path-like completion along the outline
8019 path, see the variables ~org-refile-use-outline-path~ and
8020 ~org-outline-path-complete-in-steps~. If you would like to be
8021 able to create new nodes as new parents for refiling on the fly,
8022 check the variable ~org-refile-allow-creating-parent-nodes~.
8023 When the variable ~org-log-refile~[fn:87] is set, a timestamp or
8024 a note is recorded whenever an entry is refiled.
8026 - {{{kbd(C-u C-c C-w)}}} ::
8028 #+kindex: C-u C-c C-w
8029 Use the refile interface to jump to a heading.
8031 - {{{kbd(C-u C-u C-c C-w)}}} (~org-refile-goto-last-stored~) ::
8033 #+kindex: C-u C-u C-c C-w
8034 #+findex: org-refile-goto-last-stored
8035 Jump to the location where ~org-refile~ last moved a tree to.
8037 - {{{kbd(C-2 C-c C-w)}}} ::
8039 #+kindex: C-2 C-c C-w
8040 Refile as the child of the item currently being clocked.
8042 - {{{kbd(C-3 C-c C-w)}}} ::
8044 #+kindex: C-3 C-c C-w
8045 #+vindex: org-refile-keep
8046 Refile and keep the entry in place. Also see ~org-refile-keep~
8047 to make this the default behavior, and beware that this may
8048 result in duplicated ~ID~ properties.
8050 - {{{kbd(C-0 C-c C-w)}}} or {{{kbd(C-u C-u C-u C-c C-w)}}} (~org-refile-cache-clear~) ::
8052 #+kindex: C-u C-u C-u C-c C-w
8053 #+kindex: C-0 C-c C-w
8054 #+findex: org-refile-cache-clear
8055 #+vindex: org-refile-use-cache
8056 Clear the target cache. Caching of refile targets can be turned
8057 on by setting ~org-refile-use-cache~. To make the command see
8058 new possible targets, you have to clear the cache with this
8063 :DESCRIPTION: What to do with finished products.
8067 When a project represented by a (sub)tree is finished, you may want to
8068 move the tree out of the way and to stop it from contributing to the
8069 agenda. Archiving is important to keep your working files compact and
8070 global searches like the construction of agenda views fast.
8072 - {{{kbd(C-c C-x C-a)}}} (~org-archive-subtree-default~) ::
8074 #+kindex: C-c C-x C-a
8075 #+findex: org-archive-subtree-default
8076 #+vindex: org-archive-default-command
8077 Archive the current entry using the command specified in the
8078 variable ~org-archive-default-command~.
8080 *** Moving a tree to an archive file
8082 :DESCRIPTION: Moving a tree to an archive file.
8083 :ALT_TITLE: Moving subtrees
8085 #+cindex: external archiving
8087 The most common archiving action is to move a project tree to another
8088 file, the archive file.
8090 - {{{kbd(C-c C-x C-s)}}} or short {{{kbd(C-c $)}}} (~org-archive-subtree~) ::
8092 #+kindex: C-c C-x C-s
8094 #+findex: org-archive-subtree
8095 #+vindex: org-archive-location
8096 Archive the subtree starting at the cursor position to the
8097 location given by ~org-archive-location~.
8099 - {{{kbd(C-u C-c C-x C-s)}}} ::
8101 #+kindex: C-u C-c C-x C-s
8102 Check if any direct children of the current headline could be
8103 moved to the archive. To do this, check each subtree for open
8104 TODO entries. If none is found, the command offers to move it to
8105 the archive location. If the cursor is /not/ on a headline when
8106 this command is invoked, check level 1 trees.
8108 - {{{kbd(C-u C-u C-c C-x C-s)}}} ::
8110 #+kindex: C-u C-u C-c C-x C-s
8111 As above, but check subtree for timestamps instead of TODO
8112 entries. The command offers to archive the subtree if it /does/
8113 contain a timestamp, and that timestamp is in the past.
8115 #+cindex: archive locations
8116 The default archive location is a file in the same directory as the
8117 current file, with the name derived by appending =_archive= to the
8118 current file name. You can also choose what heading to file archived
8119 items under, with the possibility to add them to a datetree in a file.
8120 For information and examples on how to specify the file and the
8121 heading, see the documentation string of the variable
8122 ~org-archive-location~.
8124 There is also an in-buffer option for setting this variable, for
8127 #+cindex: @samp{ARCHIVE}, keyword
8128 : #+ARCHIVE: %s_done::
8130 #+texinfo: @noindent
8131 #+cindex: ARCHIVE, property
8132 If you would like to have a special archive location for a single
8133 entry or a (sub)tree, give the entry an =ARCHIVE= property with the
8134 location as the value (see [[*Properties and Columns]]).
8136 #+vindex: org-archive-save-context-info
8137 When a subtree is moved, it receives a number of special properties
8138 that record context information like the file from where the entry
8139 came, its outline path the archiving time etc. Configure the variable
8140 ~org-archive-save-context-info~ to adjust the amount of information
8143 *** Internal archiving
8145 :DESCRIPTION: Switch off a tree but keep it in the file.
8148 #+cindex: @samp{ARCHIVE}, tag
8149 If you want to just switch off---for agenda views---certain subtrees
8150 without moving them to a different file, you can use the =ARCHIVE=
8153 A headline that is marked with the =ARCHIVE= tag (see [[*Tags]]) stays at
8154 its location in the outline tree, but behaves in the following way:
8157 #+vindex: org-cycle-open-archived-trees
8158 It does not open when you attempt to do so with a visibility cycling
8159 command (see [[*Visibility Cycling]]). You can force cycling archived
8160 subtrees with {{{kbd(C-TAB)}}}, or by setting the option
8161 ~org-cycle-open-archived-trees~. Also normal outline commands, like
8162 ~outline-show-all~, open archived subtrees.
8165 #+vindex: org-sparse-tree-open-archived-trees
8166 During sparse tree construction (see [[*Sparse Trees]]), matches in
8167 archived subtrees are not exposed, unless you configure the option
8168 ~org-sparse-tree-open-archived-trees~.
8171 #+vindex: org-agenda-skip-archived-trees
8172 During agenda view construction (see [[*Agenda Views]]), the content of
8173 archived trees is ignored unless you configure the option
8174 ~org-agenda-skip-archived-trees~, in which case these trees are
8175 always included. In the agenda you can press {{{kbd(v a)}}} to get
8176 archives temporarily included.
8179 #+vindex: org-export-with-archived-trees
8180 Archived trees are not exported (see [[*Exporting]]), only the headline
8181 is. Configure the details using the variable
8182 ~org-export-with-archived-trees~.
8185 #+vindex: org-columns-skip-archived-trees
8186 Archived trees are excluded from column view unless the variable
8187 ~org-columns-skip-archived-trees~ is configured to ~nil~.
8189 The following commands help manage the =ARCHIVE= tag:
8191 - {{{kbd(C-c C-x a)}}} (~org-toggle-archive-tag~) ::
8194 #+findex: org-toggle-archive-tag
8195 Toggle the archive tag for the current headline. When the tag is
8196 set, the headline changes to a shadowed face, and the subtree
8199 - {{{kbd(C-u C-c C-x a)}}} ::
8201 #+kindex: C-u C-c C-x a
8202 Check if any direct children of the current headline should be
8203 archived. To do this, check each subtree for open TODO entries.
8204 If none is found, the command offers to set the =ARCHIVE= tag for
8205 the child. If the cursor is /not/ on a headline when this
8206 command is invoked, check the level 1 trees.
8208 - {{{kbd(C-TAB)}}}, ~org-force-cycle-archived~ ::
8211 Cycle a tree even if it is tagged with =ARCHIVE=.
8213 - {{{kbd(C-c C-x A)}}} (~org-archive-to-archive-sibling~) ::
8216 #+findex: org-archive-to-archive-sibling
8217 Move the current entry to the /Archive Sibling/. This is
8218 a sibling of the entry with the heading =Archive= and the archive
8219 tag. The entry becomes a child of that sibling and in this way
8220 retains a lot of its original context, including inherited tags
8221 and approximate position in the outline.
8225 :DESCRIPTION: Collecting information into views.
8227 #+cindex: agenda views
8229 Due to the way Org works, TODO items, time-stamped items, and tagged
8230 headlines can be scattered throughout a file or even a number of
8231 files. To get an overview of open action items, or of events that are
8232 important for a particular date, this information must be collected,
8233 sorted and displayed in an organized way.
8235 Org can select items based on various criteria and display them in
8236 a separate buffer. Seven different view types are provided:
8238 - an /agenda/ that is like a calendar and shows information for
8241 - a /TODO list/ that covers all unfinished action items,
8243 - a /match view/, showings headlines based on the tags, properties,
8244 and TODO state associated with them,
8246 - a /timeline view/ that shows all events in a single Org file, in
8249 - a /text search view/ that shows all entries from multiple files that
8250 contain specified keywords,
8252 - a /stuck projects view/ showing projects that currently do not move
8255 - /custom views/ that are special searches and combinations of
8258 #+texinfo: @noindent
8259 The extracted information is displayed in a special /agenda buffer/.
8260 This buffer is read-only, but provides commands to visit the
8261 corresponding locations in the original Org files, and even to edit
8262 these files remotely.
8264 #+vindex: org-agenda-skip-comment-trees
8265 #+vindex: org-agenda-skip-archived-trees
8266 #+cindex: commented entries, in agenda views
8267 #+cindex: archived entries, in agenda views
8268 By default, the report ignores commented (see [[*Comment Lines]]) and
8269 archived (see [[*Internal archiving]]) entries. You can override this by
8270 setting ~org-agenda-skip-comment-trees~ and
8271 ~org-agenda-skip-archived-trees~ to ~nil~.
8273 #+vindex: org-agenda-window-setup
8274 #+vindex: org-agenda-restore-windows-after-quit
8275 Two variables control how the agenda buffer is displayed and whether
8276 the window configuration is restored when the agenda exits:
8277 ~org-agenda-window-setup~ and ~org-agenda-restore-windows-after-quit~.
8281 :DESCRIPTION: Files being searched for agenda information.
8283 #+cindex: agenda files
8284 #+cindex: files for agenda
8286 #+vindex: org-agenda-files
8287 The information to be shown is normally collected from all /agenda
8288 files/, the files listed in the variable ~org-agenda-files~[fn:88].
8289 If a directory is part of this list, all files with the extension
8290 =.org= in this directory are part of the list.
8292 Thus, even if you only work with a single Org file, that file should
8293 be put into the list[fn:89]. You can customize ~org-agenda-files~,
8294 but the easiest way to maintain it is through the following commands
8296 #+attr_texinfo: :sep and
8297 - {{{kbd(C-c [)}}} (~org-agenda-file-to-front~) ::
8300 #+findex: org-agenda-file-to-front
8301 #+cindex: files, adding to agenda list
8302 Add current file to the list of agenda files. The file is added
8303 to the front of the list. If it was already in the list, it is
8304 moved to the front. With a prefix argument, file is added/moved
8307 - {{{kbd(C-c ])}}} (~org-remove-file~) ::
8310 #+findex: org-remove-file
8311 Remove current file from the list of agenda files.
8313 - {{{kbd(C-')}}} and {{{kbd(C-\,)}}} (~org-cycle-agenda-files~) ::
8317 #+findex: org-cycle-agenda-files
8318 #+cindex: cycling, of agenda files
8319 Cycle through agenda file list, visiting one file after the other.
8321 - {{{kbd(M-x org-switchb)}}} ::
8323 #+findex: org-switchb
8324 Command to use an iswitchb-like interface to switch to and
8325 between Org buffers.
8327 #+texinfo: @noindent
8328 The Org menu contains the current list of files and can be used to
8331 If you would like to focus the agenda temporarily on a file not in
8332 this list, or on just one file in the list, or even on only a subtree
8333 in a file, then this can be done in different ways. For a single
8334 agenda command, you may press {{{kbd(<)}}} once or several times in
8335 the dispatcher (see [[*The Agenda Dispatcher]]). To restrict the agenda
8336 scope for an extended period, use the following commands:
8338 - {{{kbd(C-c C-x <)}}} (~org-agenda-set-restriction-lock~) ::
8341 #+findex: org-agenda-set-restriction-lock
8342 Restrict the agenda to the current subtree. If there already is
8343 a restriction at point, remove it. When called with a universal
8344 prefix argument or with the cursor before the first headline in a
8345 file, set the agenda scope to the entire file. This restriction
8346 remains in effect until removed with {{{kbd(C-c C-x >)}}}, or by typing
8347 either {{{kbd(<)}}} or {{{kbd(>)}}} in the agenda dispatcher. If there is a
8348 window displaying an agenda view, the new restriction takes
8351 - {{{kbd(C-c C-x >)}}} (~org-agenda-remove-restriction-lock~) ::
8354 #+findex: org-agenda-remove-restriction-lock
8355 Remove the restriction created by {{{kbd(C-c C-x <)}}}.
8357 #+texinfo: @noindent
8358 When working with =speedbar.el=, you can use the following commands in
8361 - {{{kbd(<)}}} (~org-speedbar-set-agenda-restriction~) ::
8363 #+findex: org-speedbar-set-agenda-restriction
8364 Restrict the agenda to the item---either an Org file or a subtree
8365 in such a file---at the cursor in the Speedbar frame. If agenda
8366 is already restricted there, remove the restriction. If there is
8367 a window displaying an agenda view, the new restriction takes
8370 - {{{kbd(>)}}} (~org-agenda-remove-restriction-lock~) ::
8372 #+findex: org-agenda-remove-restriction-lock
8373 Remove the restriction.
8375 ** The Agenda Dispatcher
8377 :DESCRIPTION: Keyboard access to agenda views.
8378 :ALT_TITLE: Agenda Dispatcher
8380 #+cindex: agenda dispatcher
8381 #+cindex: dispatching agenda commands
8383 The views are created through a dispatcher, accessible with {{{kbd(M-x
8384 org-agenda)}}}, or, better, bound to a global key (see [[*Activation]]).
8385 It displays a menu from which an additional letter is required to
8386 execute a command. The dispatcher offers the following default
8391 Create the calendar-like agenda (see [[*Weekly/daily agenda]]).
8393 - {{{kbd(t)}}} or {{{kbd(T)}}} ::
8395 Create a list of all TODO items (see [[*The global TODO list]]).
8397 - {{{kbd(m)}}} or {{{kbd(M)}}} ::
8399 Create a list of headlines matching a given expression (see
8400 [[*Matching tags and properties]]).
8404 #+kindex: s @r{(Agenda dispatcher)}
8405 Create a list of entries selected by a boolean expression of
8406 keywords and/or regular expressions that must or must not occur
8411 #+kindex: / @r{(Agenda dispatcher)}
8412 #+vindex: org-agenda-text-search-extra-files
8413 Search for a regular expression in all agenda files and
8414 additionally in the files listed in
8415 ~org-agenda-text-search-extra-files~. This uses the Emacs
8416 command ~multi-occur~. A prefix argument can be used to specify
8417 the number of context lines for each match, default is
8420 - {{{kbd(#)}}} or {{{kbd(!)}}} ::
8422 Create a list of stuck projects (see [[*Stuck projects]]).
8426 #+kindex: < @r{(Agenda dispatcher)}
8427 Restrict an agenda command to the current buffer[fn:90]. After
8428 pressing {{{kbd(<)}}}, you still need to press the character
8429 selecting the command.
8433 #+kindex: < < @r{(Agenda dispatcher)}
8434 If there is an active region, restrict the following agenda
8435 command to the region. Otherwise, restrict it to the current
8436 subtree[fn:91]. After pressing {{{kbd(< <)}}}, you still need to
8437 press the character selecting the command.
8441 #+kindex: * @r{(Agenda dispatcher)}
8442 #+vindex: org-agenda-sticky
8443 #+findex: org-toggle-sticky-agenda
8444 Toggle sticky agenda views. By default, Org maintains only
8445 a single agenda buffer and rebuilds it each time you change the
8446 view, to make sure everything is always up to date. If you
8447 switch between views often and the build time bothers you, you
8448 can turn on sticky agenda buffers (make this the default by
8449 customizing the variable ~org-agenda-sticky~). With sticky
8450 agendas, the dispatcher only switches to the selected view, you
8451 need to update it by hand with {{{kbd(r)}}} or {{{kbd(g)}}}. You
8452 can toggle sticky agenda view any time with
8453 ~org-toggle-sticky-agenda~.
8455 You can also define custom commands that are accessible through the
8456 dispatcher, just like the default commands. This includes the
8457 possibility to create extended agenda buffers that contain several
8458 blocks together, for example the weekly agenda, the global TODO list
8459 and a number of special tags matches. See [[*Custom Agenda Views]].
8461 ** The Built-in Agenda Views
8463 :DESCRIPTION: What is available out of the box?
8464 :ALT_TITLE: Built-in Agenda Views
8467 In this section we describe the built-in views.
8469 *** Weekly/daily agenda
8471 :DESCRIPTION: The calendar page with current tasks.
8474 #+cindex: weekly agenda
8475 #+cindex: daily agenda
8477 The purpose of the weekly/daily /agenda/ is to act like a page of
8478 a paper agenda, showing all the tasks for the current week or day.
8480 - {{{kbd(M-x org-agenda a)}}} (~org-agenda-list~) ::
8482 #+kindex: a @r{(Agenda dispatcher)}
8483 #+findex: org-agenda-list
8484 #+cindex: org-agenda, command
8485 Compile an agenda for the current week from a list of Org files.
8486 The agenda shows the entries for each day. With a numeric prefix
8487 argument[fn:92]---like {{{kbd(C-u 2 1 M-x org-agenda a)}}}---you
8488 may set the number of days to be displayed.
8490 #+vindex: org-agenda-span
8491 #+vindex: org-agenda-start-day
8492 #+vindex: org-agenda-start-on-weekday
8493 The default number of days displayed in the agenda is set by the
8494 variable ~org-agenda-span~. This variable can be set to any number of
8495 days you want to see by default in the agenda, or to a span name, such
8496 a ~day~, ~week~, ~month~ or ~year~. For weekly agendas, the default
8497 is to start on the previous Monday (see
8498 ~org-agenda-start-on-weekday~). You can also set the start date using
8499 a date shift: ~(setq org-agenda-start-day "+10d")~ starts the agenda
8500 ten days from today in the future.
8502 Remote editing from the agenda buffer means, for example, that you can
8503 change the dates of deadlines and appointments from the agenda buffer.
8504 The commands available in the Agenda buffer are listed in [[*Commands in
8505 the Agenda Buffer]].
8507 **** Calendar/Diary integration
8511 #+cindex: calendar integration
8512 #+cindex: diary integration
8514 Emacs contains the calendar and diary by Edward\nbsp{}M.\nbsp{}Reingold. The
8515 calendar displays a three-month calendar with holidays from different
8516 countries and cultures. The diary allows you to keep track of
8517 anniversaries, lunar phases, sunrise/set, recurrent appointments
8518 (weekly, monthly) and more. In this way, it is quite complementary to
8519 Org. It can be very useful to combine output from Org with the diary.
8521 In order to include entries from the Emacs diary into Org mode's
8522 agenda, you only need to customize the variable
8524 #+begin_src emacs-lisp
8525 (setq org-agenda-include-diary t)
8528 #+texinfo: @noindent
8529 After that, everything happens automatically. All diary entries
8530 including holidays, anniversaries, etc., are included in the agenda
8531 buffer created by Org mode. {{{kbd(SPC)}}}, {{{kbd(TAB)}}}, and
8532 {{{kbd(RET)}}} can be used from the agenda buffer to jump to the diary
8533 file in order to edit existing diary entries. The {{{kbd(i)}}}
8534 command to insert new entries for the current date works in the agenda
8535 buffer, as well as the commands {{{kbd(S)}}}, {{{kbd(M)}}}, and
8536 {{{kbd(C)}}} to display Sunrise/Sunset times, show lunar phases and to
8537 convert to other calendars, respectively. {{{kbd(c)}}} can be used to
8538 switch back and forth between calendar and agenda.
8540 If you are using the diary only for S-exp entries and holidays, it is
8541 faster to not use the above setting, but instead to copy or even move
8542 the entries into an Org file. Org mode evaluates diary-style sexp
8543 entries, and does it faster because there is no overhead for first
8544 creating the diary display. Note that the sexp entries must start at
8545 the left margin, no whitespace is allowed before them, as seen in the
8546 following segment of an Org file:[fn:93]
8553 %%(org-calendar-holiday) ; special function for holiday names
8559 %%(org-anniversary 1956 5 14) Arthur Dent is %d years old
8560 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
8563 **** Anniversaries from BBDB
8567 #+cindex: BBDB, anniversaries
8568 #+cindex: anniversaries, from BBDB
8570 #+findex: org-bbdb-anniversaries
8571 If you are using the Insidious Big Brother Database to store your
8572 contacts, you very likely prefer to store anniversaries in BBDB rather
8573 than in a separate Org or diary file. Org supports this and can show
8574 BBDB anniversaries as part of the agenda. All you need to do is to
8575 add the following to one of your agenda files:
8582 %%(org-bbdb-anniversaries)
8585 You can then go ahead and define anniversaries for a BBDB record.
8586 Basically, you need to press {{{kbd(C-o anniversary RET)}}} with the
8587 cursor in a BBDB record and then add the date in the format
8588 =YYYY-MM-DD= or =MM-DD=, followed by a space and the class of the
8589 anniversary (=birthday=, =wedding=, or a format string). If you omit
8590 the class, it defaults to =birthday=. Here are a few examples, the
8591 header for the file =org-bbdb.el= contains more detailed information.
8597 2008-04-14 %s released version 6.01 of Org mode, %d years ago
8600 After a change to BBDB, or for the first agenda display during an
8601 Emacs session, the agenda display suffers a short delay as Org updates
8602 its hash with anniversaries. However, from then on things will be
8603 very fast, much faster in fact than a long list of
8604 =%%(diary-anniversary)= entries in an Org or Diary file.
8606 #+findex: org-bbdb-anniversaries-future
8607 If you would like to see upcoming anniversaries with a bit of
8608 forewarning, you can use the following instead:
8615 %%(org-bbdb-anniversaries-future 3)
8618 That will give you three days' warning: on the anniversary date itself
8619 and the two days prior. The argument is optional: if omitted, it
8622 **** Appointment reminders
8626 #+cindex: @file{appt.el}
8627 #+cindex: appointment reminders
8628 #+cindex: appointment
8631 #+cindex: APPT_WARNTIME, keyword
8632 Org can interact with Emacs appointments notification facility. To
8633 add the appointments of your agenda files, use the command
8634 ~org-agenda-to-appt~. This command lets you filter through the list
8635 of your appointments and add only those belonging to a specific
8636 category or matching a regular expression. It also reads
8637 a =APPT_WARNTIME= property which overrides the value of
8638 ~appt-message-warning-time~ for this appointment. See the docstring
8641 *** The global TODO list
8643 :DESCRIPTION: All unfinished action items.
8644 :ALT_TITLE: Global TODO list
8646 #+cindex: global TODO list
8647 #+cindex: TODO list, global
8649 The global TODO list contains all unfinished TODO items formatted and
8650 collected into a single place.
8652 - {{{kbd(M-x org-agenda t)}}} (~org-todo-list~) ::
8654 #+kindex: t @r{(Agenda dispatcher)}
8655 #+findex: org-todo-list
8656 Show the global TODO list. This collects the TODO items from all
8657 agenda files (see [[*Agenda Views]]) into a single buffer. By
8658 default, this lists items with a state the is not a DONE state.
8659 The buffer is in ~agenda-mode~, so there are commands to examine
8660 and manipulate the TODO entries directly from that buffer (see
8661 [[*Commands in the Agenda Buffer]]).
8663 - {{{kbd(M-x org-agenda T)}}} (~org-todo-list~) ::
8665 #+kindex: T @r{(Agenda dispatcher)}
8666 #+findex: org-todo-list
8667 #+cindex: TODO keyword matching
8668 #+vindex: org-todo-keywords
8669 Like the above, but allows selection of a specific TODO keyword.
8670 You can also do this by specifying a prefix argument to
8671 {{{kbd(t)}}}. You are prompted for a keyword, and you may also
8672 specify several keywords by separating them with =|= as the
8673 boolean OR operator. With a numeric prefix, the Nth keyword in
8674 ~org-todo-keywords~ is selected.
8677 The {{{kbd(r)}}} key in the agenda buffer regenerates it, and you
8678 can give a prefix argument to this command to change the selected
8679 TODO keyword, for example {{{kbd(3 r)}}}. If you often need
8680 a search for a specific keyword, define a custom command for it
8681 (see [[*The Agenda Dispatcher]]).
8683 Matching specific TODO keywords can also be done as part of
8684 a tags search (see [[*Tag Searches]]).
8686 Remote editing of TODO items means that you can change the state of
8687 a TODO entry with a single key press. The commands available in the
8688 TODO list are described in [[*Commands in the Agenda Buffer]].
8690 #+cindex: sublevels, inclusion into TODO list
8691 Normally the global TODO list simply shows all headlines with TODO
8692 keywords. This list can become very long. There are two ways to keep
8696 #+vindex: org-agenda-todo-ignore-scheduled
8697 #+vindex: org-agenda-todo-ignore-deadlines
8698 #+vindex: org-agenda-todo-ignore-timestamp
8699 #+vindex: org-agenda-todo-ignore-with-date
8700 Some people view a TODO item that has been /scheduled/ for execution
8701 or have a /deadline/ (see [[*Timestamps, Deadlines and Scheduling]]) as
8702 no longer /open/. Configure the variables
8703 ~org-agenda-todo-ignore-scheduled~,
8704 ~org-agenda-todo-ignore-deadlines~,
8705 ~org-agenda-todo-ignore-timestamp~ and/or
8706 ~org-agenda-todo-ignore-with-date~ to exclude such items from the
8710 #+vindex: org-agenda-todo-list-sublevels
8711 TODO items may have sublevels to break up the task into subtasks.
8712 In such cases it may be enough to list only the highest level TODO
8713 headline and omit the sublevels from the global list. Configure the
8714 variable ~org-agenda-todo-list-sublevels~ to get this behavior.
8716 *** Matching tags and properties
8718 :DESCRIPTION: Structured information with fine-tuned search.
8720 #+cindex: matching, of tags
8721 #+cindex: matching, of properties
8723 #+cindex: match view
8725 If headlines in the agenda files are marked with /tags/ (see [[*Tags]]),
8726 or have properties (see [[*Properties and Columns]]), you can select
8727 headlines based on this metadata and collect them into an agenda
8728 buffer. The match syntax described here also applies when creating
8729 sparse trees with {{{kbd(C-c / m)}}}.
8731 - {{{kbd(M-x org-agenda m)}}} (~org-tags-view~) ::
8733 #+kindex: m @r{(Agenda dispatcher)}
8734 #+findex: org-tags-view
8735 Produce a list of all headlines that match a given set of tags.
8736 The command prompts for a selection criterion, which is a boolean
8737 logic expression with tags, like =+work+urgent-withboss= or
8738 =work|home= (see [[*Tags]]). If you often need a specific search,
8739 define a custom command for it (see [[*The Agenda Dispatcher]]).
8741 - {{{kbd(M-x org-agenda M)}}} (~org-tags-view~) ::
8743 #+kindex: M @r{(Agenda dispatcher)}
8744 #+findex: org-tags-view
8745 #+vindex: org-tags-match-list-sublevels
8746 #+vindex: org-agenda-tags-todo-honor-ignore-options
8747 Like {{{kbd(m)}}}, but only select headlines that are also TODO
8748 items and force checking subitems (see the variable
8749 ~org-tags-match-list-sublevels~). To exclude scheduled/deadline
8750 items, see the variable
8751 ~org-agenda-tags-todo-honor-ignore-options~. Matching specific
8752 TODO keywords together with a tags match is also possible, see
8755 The commands available in the tags list are described in [[*Commands in
8756 the Agenda Buffer]].
8758 #+cindex: boolean logic, for agenda searches
8759 A search string can use Boolean operators =&= for AND and =|= for OR.
8760 =&= binds more strongly than =|=. Parentheses are currently not
8761 implemented. Each element in the search is either a tag, a regular
8762 expression matching tags, or an expression like =PROPERTY OPERATOR
8763 VALUE= with a comparison operator, accessing a property value. Each
8764 element may be preceded by =-= to select against it, and =+= is
8765 syntactic sugar for positive selection. The AND operator =&= is
8766 optional when =+= or =-= is present. Here are some examples, using
8771 Select headlines tagged =work=, but discard those also tagged
8776 Selects lines tagged =work= or =laptop=.
8778 - ~work|laptop+night~ ::
8780 Like before, but require the =laptop= lines to be tagged
8783 #+cindex: regular expressions, with tags search
8784 Instead of a tag, you may also specify a regular expression enclosed
8785 in curly braces. For example, =work+{^boss.*}= matches headlines that
8786 contain the tag =:work:= and any tag /starting/ with =boss=.
8788 #+cindex: group tags, as regular expressions
8789 Group tags (see [[*Tag Hierarchy]]) are expanded as regular expressions.
8790 E.g., if =work= is a group tag for the group =:work:lab:conf:=, then
8791 searching for =work= also searches for ={\(?:work\|lab\|conf\)}= and
8792 searching for =-work= searches for all headlines but those with one of
8793 the tags in the group (i.e., =-{\(?:work\|lab\|conf\)}=).
8795 #+cindex: TODO keyword matching, with tags search
8796 #+cindex: level, for tags/property match
8797 #+cindex: category, for tags/property match
8798 #+vindex: org-odd-levels-only
8799 You may also test for properties (see [[*Properties and Columns]]) at the
8800 same time as matching tags. The properties may be real properties, or
8801 special properties that represent other metadata (see [[*Special
8802 Properties]]). For example, the property =TODO= represents the TODO
8803 keyword of the entry. Or, the property =LEVEL= represents the level
8804 of an entry. So searching =+LEVEL=3+boss-TODO="DONE"= lists all level
8805 three headlines that have the tag =boss= and are /not/ marked with the
8806 TODO keyword =DONE=. In buffers with ~org-odd-levels-only~ set,
8807 =LEVEL= does not count the number of stars, but =LEVEL=2= corresponds
8810 Here are more examples:
8812 - =work+TODO="WAITING"= ::
8814 Select =work=-tagged TODO lines with the specific TODO keyword
8817 - =work+TODO="WAITING"|home+TODO="WAITING"= ::
8819 Waiting tasks both at work and at home.
8821 When matching properties, a number of different operators can be used
8822 to test the value of a property. Here is a complex example:
8825 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2
8826 +With={Sarah|Denny}+SCHEDULED>="<2008-10-11>"
8829 #+texinfo: @noindent
8830 The type of comparison depends on how the comparison value is written:
8832 - If the comparison value is a plain number, a numerical comparison is
8833 done, and the allowed operators are =<=, ===, =>=, =<==, =>==, and
8836 - If the comparison value is enclosed in double-quotes, a string
8837 comparison is done, and the same operators are allowed.
8839 - If the comparison value is enclosed in double-quotes /and/ angular
8840 brackets (like =DEADLINE<="<2008-12-24 18:30>"=), both values are
8841 assumed to be date/time specifications in the standard Org way, and
8842 the comparison is done accordingly. Valid values also include
8843 ="<now>"= for now (including time), ="<today>"=, and ="<tomorrow>"=
8844 for these days at 0:00 hours, i.e., without a time specification.
8845 You can also use strings like ="<+5d>"= or ="<-2m>"= with units =d=,
8846 =w=, =m=, and =y= for day, week, month, and year, respectively.
8848 - If the comparison value is enclosed in curly braces, a regexp match
8849 is performed, with === meaning that the regexp matches the property
8850 value, and =<>= meaning that it does not match.
8852 So the search string in the example finds entries tagged =work= but
8853 not =boss=, which also have a priority value =A=, a =Coffee= property
8854 with the value =unlimited=, an =EFFORT= property that is numerically
8855 smaller than 2, a =With= property that is matched by the regular
8856 expression =Sarah|Denny=, and that are scheduled on or after October
8859 You can configure Org mode to use property inheritance during
8860 a search, but beware that this can slow down searches considerably.
8861 See [[*Property Inheritance]], for details.
8863 For backward compatibility, and also for typing speed, there is also
8864 a different way to test TODO states in a search. For this, terminate
8865 the tags/property part of the search string (which may include several
8866 terms connected with =|=) with a =/= and then specify a Boolean
8867 expression just for TODO keywords. The syntax is then similar to that
8868 for tags, but should be applied with care: for example, a positive
8869 selection on several TODO keywords cannot meaningfully be combined
8870 with boolean AND. However, /negative selection/ combined with AND can
8871 be meaningful. To make sure that only lines are checked that actually
8872 have any TODO keyword (resulting in a speed-up), use {{{kbd(M-x
8873 org-agenda M)}}}, or equivalently start the TODO part after the slash
8874 with =!=. Using {{{kbd(M-x org-agenda M)}}} or =/!= does not match
8875 TODO keywords in a DONE state. Examples:
8879 Same as =work+TODO="WAITING"=.
8881 - =work/!-WAITING-NEXT= ::
8883 Select =work=-tagged TODO lines that are neither =WAITING= nor
8886 - =work/!+WAITING|+NEXT= ::
8888 Select =work=-tagged TODO lines that are either =WAITING= or
8893 :DESCRIPTION: Find entries by searching for text.
8895 #+cindex: search view
8896 #+cindex: text search
8897 #+cindex: searching, for text
8899 This agenda view is a general text search facility for Org mode
8900 entries. It is particularly useful to find notes.
8902 - {{{kbd(M-x org-agenda s)}}} (~org-search-view~) ::
8904 #+kindex: s @r{(Agenda dispatcher)}
8905 #+findex: org-search-view
8906 This is a special search that lets you select entries by matching
8907 a substring or specific words using a boolean logic.
8909 For example, the search string =computer equipment= matches entries
8910 that contain =computer equipment= as a substring, even if the two
8911 words are separated by more space or a line break.
8913 Search view can also search for specific keywords in the entry, using
8914 Boolean logic. The search string =+computer
8915 +wifi -ethernet -{8\.11[bg]}= matches note entries that contain the
8916 keywords =computer= and =wifi=, but not the keyword =ethernet=, and
8917 which are also not matched by the regular expression =8\.11[bg]=,
8918 meaning to exclude both =8.11b= and =8.11g=. The first =+= is
8919 necessary to turn on boolean search, other =+= characters are
8920 optional. For more details, see the docstring of the command
8923 You can incrementally adjust a boolean search with the following keys
8925 #+attr_texinfo: :columns 0.1 0.6
8926 | {{{kbd([)}}} | Add a positive search word |
8927 | {{{kbd(])}}} | Add a negative search word |
8928 | {{{kbd({)}}} | Add a positive regular expression |
8929 | {{{kbd(})}}} | Add a negative regular expression |
8931 #+vindex: org-agenda-text-search-extra-files
8932 Note that in addition to the agenda files, this command also searches
8933 the files listed in ~org-agenda-text-search-extra-files~.
8937 :DESCRIPTION: Find projects you need to review.
8939 #+pindex: GTD, Getting Things Done
8941 If you are following a system like David Allen's GTD to organize your
8942 work, one of the "duties" you have is a regular review to make sure
8943 that all projects move along. A /stuck/ project is a project that has
8944 no defined next actions, so it never shows up in the TODO lists Org
8945 mode produces. During the review, you need to identify such projects
8946 and define next actions for them.
8948 - {{{kbd(M-x org-agenda #)}}} (~org-agenda-list-stuck-projects~) ::
8950 #+kindex: # @r{(Agenda dispatcher)}
8951 #+findex: org-agenda-list-stuck-projects
8952 List projects that are stuck.
8954 - {{{kbd(M-x org-agenda !)}}} ::
8956 #+kindex: ! @r{(Agenda dispatcher)}
8957 #+vindex: org-stuck-projects
8958 Customize the variable ~org-stuck-projects~ to define what
8959 a stuck project is and how to find it.
8961 You almost certainly need to configure this view before it works for
8962 you. The built-in default assumes that all your projects are level-2
8963 headlines, and that a project is not stuck if it has at least one
8964 entry marked with a TODO keyword =TODO= or =NEXT= or =NEXTACTION=.
8966 Let's assume that you, in your own way of using Org mode, identify
8967 projects with a tag =:PROJECT:=, and that you use a TODO keyword
8968 =MAYBE= to indicate a project that should not be considered yet.
8969 Let's further assume that the TODO keyword =DONE= marks finished
8970 projects, and that =NEXT= and =TODO= indicate next actions. The tag
8971 =:@shop:= indicates shopping and is a next action even without the
8972 NEXT tag. Finally, if the project contains the special word =IGNORE=
8973 anywhere, it should not be listed either. In this case you would
8974 start by identifying eligible projects with a tags/TODO match (see
8975 [[*Tag Searches]]) =+PROJECT/-MAYBE-DONE=, and then check for =TODO=,
8976 =NEXT=, =@shop=, and =IGNORE= in the subtree to identify projects that
8977 are not stuck. The correct customization for this is:
8979 #+begin_src emacs-lisp
8980 (setq org-stuck-projects
8981 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@shop")
8985 Note that if a project is identified as non-stuck, the subtree of this
8986 entry is searched for stuck projects.
8988 ** Presentation and Sorting
8990 :DESCRIPTION: How agenda items are prepared for display.
8992 #+cindex: presentation, of agenda items
8994 #+vindex: org-agenda-prefix-format
8995 #+vindex: org-agenda-tags-column
8996 Before displaying items in an agenda view, Org mode visually prepares
8997 the items and sorts them. Each item occupies a single line. The line
8998 starts with a /prefix/ that contains the /category/ (see [[*Categories]])
8999 of the item and other important information. You can customize in
9000 which column tags are displayed through ~org-agenda-tags-column~. You
9001 can also customize the prefix using the option
9002 ~org-agenda-prefix-format~. This prefix is followed by a cleaned-up
9003 version of the outline headline associated with the item.
9007 :DESCRIPTION: Not all tasks are equal.
9010 #+cindex: @samp{CATEGORY}, keyword
9012 The category is a broad label assigned to each agenda item. By
9013 default, the category is simply derived from the file name, but you
9014 can also specify it with a special line in the buffer, like
9017 : #+CATEGORY: Thesis
9019 #+texinfo: @noindent
9020 #+cindex: @samp{CATEGORY}, property
9021 If you would like to have a special category for a single entry or
9022 a (sub)tree, give the entry a =CATEGORY= property with the special
9023 category you want to apply as the value.
9025 #+texinfo: @noindent
9026 The display in the agenda buffer looks best if the category is not
9027 longer than 10 characters.
9029 #+texinfo: @noindent
9030 #+vindex: org-agenda-category-icon-alist
9031 You can set up icons for category by customizing the
9032 ~org-agenda-category-icon-alist~ variable.
9034 *** Time-of-day specifications
9036 :DESCRIPTION: How the agenda knows the time.
9038 #+cindex: time-of-day specification
9040 Org mode checks each agenda item for a time-of-day specification. The
9041 time can be part of the timestamp that triggered inclusion into the
9044 : <2005-05-10 Tue 19:00>
9046 #+texinfo: @noindent
9047 Time ranges can be specified with two timestamps:
9049 : <2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>
9051 #+vindex: org-agenda-search-headline-for-time
9052 In the headline of the entry itself, a time(range)---like =12:45= or
9053 a =8:30-1pm=---may also appear as plain text[fn:94].
9055 If the agenda integrates the Emacs diary (see [[*Weekly/daily agenda]]),
9056 time specifications in diary entries are recognized as well.
9058 For agenda display, Org mode extracts the time and displays it in
9059 a standard 24 hour format as part of the prefix. The example times in
9060 the previous paragraphs would end up in the agenda like this:
9063 8:30-13:00 Arthur Dent lies in front of the bulldozer
9064 12:45...... Ford Prefect arrives and takes Arthur to the pub
9065 19:00...... The Vogon reads his poem
9066 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
9070 If the agenda is in single-day mode, or for the display of today, the
9071 timed entries are embedded in a time grid, like
9074 8:00...... ------------------
9075 8:30-13:00 Arthur Dent lies in front of the bulldozer
9076 10:00...... ------------------
9077 12:00...... ------------------
9078 12:45...... Ford Prefect arrives and takes Arthur to the pub
9079 14:00...... ------------------
9080 16:00...... ------------------
9081 18:00...... ------------------
9082 19:00...... The Vogon reads his poem
9083 20:00...... ------------------
9084 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
9087 #+vindex: org-agenda-use-time-grid
9088 #+vindex: org-agenda-time-grid
9089 The time grid can be turned on and off with the variable
9090 ~org-agenda-use-time-grid~, and can be configured with
9091 ~org-agenda-time-grid~.
9093 *** Sorting of agenda items
9095 :DESCRIPTION: The order of things.
9097 #+cindex: sorting, of agenda items
9098 #+cindex: priorities, of agenda items
9100 Before being inserted into a view, the items are sorted. How this is
9101 done depends on the type of view.
9104 #+vindex: org-agenda-files
9105 For the daily/weekly agenda, the items for each day are sorted. The
9106 default order is to first collect all items containing an explicit
9107 time-of-day specification. These entries are shown at the beginning
9108 of the list, as a /schedule/ for the day. After that, items remain
9109 grouped in categories, in the sequence given by ~org-agenda-files~.
9110 Within each category, items are sorted by priority (see
9111 [[*Priorities]]), which is composed of the base priority (2000 for
9112 priority =A=, 1000 for =B=, and 0 for =C=), plus additional
9113 increments for overdue scheduled or deadline items.
9115 - For the TODO list, items remain in the order of categories, but
9116 within each category, sorting takes place according to priority (see
9117 [[*Priorities]]). The priority used for sorting derives from the
9118 priority cookie, with additions depending on how close an item is to
9119 its due or scheduled date.
9121 - For tags matches, items are not sorted at all, but just appear in
9122 the sequence in which they are found in the agenda files.
9124 #+vindex: org-agenda-sorting-strategy
9125 Sorting can be customized using the variable
9126 ~org-agenda-sorting-strategy~, and may also include criteria based on
9127 the estimated effort of an entry (see [[*Effort Estimates]]).
9129 *** Filtering/limiting agenda times
9131 :DESCRIPTION: Dynamically narrow the agenda.
9134 Agenda built-in or customized commands are statically defined. Agenda
9135 filters and limits provide two ways of dynamically narrowing down the
9136 list of agenda entries: /filters/ and /limits/. Filters only act on
9137 the display of the items, while limits take effect before the list of
9138 agenda entries is built. Filters are more often used interactively,
9139 while limits are mostly useful when defined as local variables within
9140 custom agenda commands.
9142 **** Filtering in the agenda
9146 #+cindex: agenda filtering
9147 #+cindex: filtering entries, in agenda
9148 #+cindex: tag filtering, in agenda
9149 #+cindex: category filtering, in agenda
9150 #+cindex: top headline filtering, in agenda
9151 #+cindex: effort filtering, in agenda
9152 #+cindex: query editing, in agenda
9154 - {{{kbd(/)}}} (~org-agenda-filter-by-tag~) ::
9156 #+findex: org-agenda-filter-by-tag
9157 #+vindex: org-agenda-tag-filter-preset
9158 Filter the agenda view with respect to a tag and/or effort
9159 estimates. The difference between this and a custom agenda
9160 command is that filtering is very fast, so that you can switch
9161 quickly between different filters without having to recreate the
9164 You are prompted for a tag selection letter; {{{kbd(SPC)}}} means
9165 any tag at all. Pressing {{{kbd(TAB)}}} at that prompt offers
9166 completion to select a tag, including any tags that do not have
9167 a selection character. The command then hides all entries that
9168 do not contain or inherit this tag. When called with prefix
9169 argument, remove the entries that /do/ have the tag. A second
9170 {{{kbd(/)}}} at the prompt turns off the filter and shows any
9171 hidden entries. Pressing {{{kbd(+)}}} or {{{kbd(-)}}} switches
9172 between filtering and excluding the next tag.
9174 #+vindex: org-agenda-auto-exclude-function
9175 Org also supports automatic, context-aware tag filtering. If the
9176 variable ~org-agenda-auto-exclude-function~ is set to
9177 a user-defined function, that function can decide which tags
9178 should be excluded from the agenda automatically. Once this is
9179 set, the {{{kbd(/)}}} command then accepts {{{kbd(RET)}}} as
9180 a sub-option key and runs the auto exclusion logic. For example,
9181 let's say you use a =Net= tag to identify tasks which need
9182 network access, an =Errand= tag for errands in town, and a =Call=
9183 tag for making phone calls. You could auto-exclude these tags
9184 based on the availability of the Internet, and outside of
9185 business hours, with something like this:
9187 #+begin_src emacs-lisp
9188 (defun org-my-auto-exclude-function (tag)
9190 ((string= tag "Net")
9191 (/= 0 (call-process "/sbin/ping" nil nil nil
9192 "-c1" "-q" "-t1" "mail.gnu.org")))
9193 ((or (string= tag "Errand") (string= tag "Call"))
9194 (let ((hour (nth 2 (decode-time))))
9195 (or (< hour 8) (> hour 21)))))
9198 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
9201 - {{{kbd(<)}}} (~org-agenda-filter-by-category~) ::
9203 #+findex: org-agenda-filter-by-category
9204 Filter the current agenda view with respect to the category of
9205 the item at point. Pressing {{{kbd(<)}}} another time removes
9206 this filter. When called with a prefix argument exclude the
9207 category of the item at point from the agenda.
9209 #+vindex: org-agenda-category-filter-preset
9210 You can add a filter preset in custom agenda commands through the
9211 option ~org-agenda-category-filter-preset~. See [[*Setting options
9212 for custom commands]].
9214 - {{{kbd(^)}}} (~org-agenda-filter-by-top-headline~) ::
9216 #+findex: org-agenda-filter-by-top-headline
9217 Filter the current agenda view and only display the siblings and
9218 the parent headline of the one at point.
9220 - {{{kbd(=)}}} (~org-agenda-filter-by-regexp~) ::
9222 #+findex: org-agenda-filter-by-regexp
9223 Filter the agenda view by a regular expression: only show agenda
9224 entries matching the regular expression the user entered. When
9225 called with a prefix argument, it filters /out/ entries matching
9226 the regexp. Called in a regexp-filtered agenda view, remove the
9227 filter, unless there are two universal prefix arguments, in which
9228 case filters are cumulated.
9230 #+vindex: org-agenda-regexp-filter-preset
9231 You can add a filter preset in custom agenda commands through the
9232 option ~org-agenda-regexp-filter-preset~. See [[*Setting options
9233 for custom commands]].
9235 - {{{kbd(_)}}} (~org-agenda-filter-by-effort~) ::
9237 #+findex: org-agenda-filter-by-effort
9238 Filter the agenda view with respect to effort estimates. You
9239 first need to set up allowed efforts globally, for example
9241 #+begin_src emacs-lisp
9242 (setq org-global-properties
9243 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
9246 #+vindex: org-sort-agenda-noeffort-is-high
9247 You can then filter for an effort by first typing an operator,
9248 one of {{{kbd(<)}}}, {{{kbd(>)}}} and {{{kbd(=)}}}, and then the
9249 one-digit index of an effort estimate in your array of allowed
9250 values, where {{{kbd(0)}}} means the 10th value. The filter then
9251 restricts to entries with effort smaller-or-equal, equal, or
9252 larger-or-equal than the selected value. For application of the
9253 operator, entries without a defined effort are treated according
9254 to the value of ~org-sort-agenda-noeffort-is-high~.
9256 When called with a prefix argument, it removes entries matching
9257 the condition. With two universal prefix arguments, it clears
9258 effort filters, which can be accumulated.
9260 #+vindex: org-agenda-effort-filter-preset
9261 You can add a filter preset in custom agenda commands through the
9262 option ~org-agenda-effort-filter-preset~. See [[*Setting options
9263 for custom commands]].
9265 - {{{kbd(|)}}} (~org-agenda-filter-remove-all~) ::
9267 Remove all filters in the current agenda view.
9269 **** Setting limits for the agenda
9273 #+cindex: limits, in agenda
9275 Here is a list of options that you can set, either globally, or
9276 locally in your custom agenda views (see [[*Custom Agenda Views]]).
9278 - ~org-agenda-max-entries~ ::
9280 #+vindex: org-agenda-max-entries
9281 Limit the number of entries.
9283 - ~org-agenda-max-effort~ ::
9285 #+vindex: org-agenda-max-effort
9286 Limit the duration of accumulated efforts (as minutes).
9288 - ~org-agenda-max-todos~ ::
9290 #+vindex: org-agenda-max-todos
9291 Limit the number of entries with TODO keywords.
9293 - ~org-agenda-max-tags~ ::
9295 #+vindex: org-agenda-max-tags
9296 Limit the number of tagged entries.
9298 When set to a positive integer, each option excludes entries from
9299 other categories: for example, ~(setq org-agenda-max-effort 100)~
9300 limits the agenda to 100 minutes of effort and exclude any entry that
9301 has no effort property. If you want to include entries with no effort
9302 property, use a negative value for ~org-agenda-max-effort~. One
9303 useful setup is to use ~org-agenda-max-entries~ locally in a custom
9304 command. For example, this custom command displays the next five
9305 entries with a =NEXT= TODO keyword.
9307 #+begin_src emacs-lisp
9308 (setq org-agenda-custom-commands
9310 ((org-agenda-max-entries 5)))))
9313 Once you mark one of these five entry as DONE, rebuilding the agenda
9314 will again the next five entries again, including the first entry that
9315 was excluded so far.
9317 You can also dynamically set temporary limits, which are lost when
9318 rebuilding the agenda:
9320 - {{{kbd(~ )}}} (~org-agenda-limit-interactively~) ::
9322 #+findex: org-agenda-limit-interactively
9323 This prompts for the type of limit to apply and its value.
9325 ** Commands in the Agenda Buffer
9327 :DESCRIPTION: Remote editing of Org trees.
9328 :ALT_TITLE: Agenda Commands
9330 #+cindex: commands, in agenda buffer
9332 Entries in the agenda buffer are linked back to the Org file or diary
9333 file where they originate. You are not allowed to edit the agenda
9334 buffer itself, but commands are provided to show and jump to the
9335 original entry location, and to edit the Org files "remotely" from the
9336 agenda buffer. In this way, all information is stored only once,
9337 removing the risk that your agenda and note files may diverge.
9339 Some commands can be executed with mouse clicks on agenda lines. For
9340 the other commands, the cursor needs to be in the desired line.
9346 #+cindex: motion commands in agenda
9348 - {{{kbd(n)}}} (~org-agenda-next-line~) ::
9351 #+findex: org-agenda-next-line
9352 Next line (same as {{{kbd(DOWN)}}} and {{{kbd(C-n)}}}).
9354 - {{{kbd(p)}}} (~org-agenda-previous-line~) ::
9357 #+findex: org-agenda-previous-line
9358 Previous line (same as {{{kbd(UP)}}} and {{{kbd(C-p)}}}).
9360 *** View/Go to Org file
9364 #+cindex: view file commands in agenda
9366 - {{{kbd(SPC)}}} or {{{kbd(mouse-3)}}} (~org-agenda-show-and-scroll-up~) ::
9370 #+findex: org-agenda-show-and-scroll-up
9371 Display the original location of the item in another window.
9372 With a prefix argument, make sure that drawers stay folded.
9374 - {{{kbd(L)}}} (~org-agenda-recenter~) ::
9376 #+findex: org-agenda-recenter
9377 Display original location and recenter that window.
9379 - {{{kbd(TAB)}}} or {{{kbd(mouse-2)}}} (~org-agenda-goto~) ::
9383 #+findex: org-agenda-goto
9384 Go to the original location of the item in another window.
9386 - {{{kbd(RET)}}} (~org-agenda-switch-to~) ::
9389 #+findex: org-agenda-switch-to
9390 Go to the original location of the item and delete other windows.
9392 - {{{kbd(F)}}} (~org-agenda-follow-mode~) ::
9395 #+findex: org-agenda-follow-mode
9396 #+vindex: org-agenda-start-with-follow-mode
9397 Toggle Follow mode. In Follow mode, as you move the cursor
9398 through the agenda buffer, the other window always shows the
9399 corresponding location in the Org file. The initial setting for
9400 this mode in new agenda buffers can be set with the variable
9401 ~org-agenda-start-with-follow-mode~.
9403 - {{{kbd(C-c C-x b)}}} (~org-agenda-tree-to-indirect-buffer~) ::
9406 #+findex: org-agenda-tree-to-indirect-buffer
9407 Display the entire subtree of the current item in an indirect
9408 buffer. With a numeric prefix argument N, go up to level N and
9409 then take that tree. If N is negative, go up that many levels.
9410 With a {{{kbd(C-u)}}} prefix, do not remove the previously used
9413 - {{{kbd(C-c C-o)}}} (~org-agenda-open-link~) ::
9416 #+findex: org-agenda-open-link
9417 Follow a link in the entry. This offers a selection of any links
9418 in the text belonging to the referenced Org node. If there is
9419 only one link, follow it without a selection prompt.
9425 #+cindex: change agenda display
9426 #+cindex: display changing, in agenda
9428 #+attr_texinfo: :sep ,
9432 Interactively select another agenda view and append it to the
9438 Delete other windows.
9440 - {{{kbd(v d)}}} or short {{{kbd(d)}}} (~org-agenda-day-view~) ::
9444 #+findex: org-agenda-day-view
9445 Switch to day view. When switching to day view, this setting
9446 becomes the default for subsequent agenda refreshes. A numeric
9447 prefix argument may be used to jump directly to a specific day of
9448 the year. For example, {{{kbd(32 d)}}} jumps to February 1st.
9449 When setting day view, a year may be encoded in the prefix
9450 argument as well. For example, {{{kbd(200712 d)}}} jumps to
9451 January 12, 2007. If such a year specification has only one or
9452 two digits, it is expanded into one of the 30 next years or the
9455 - {{{kbd(v w)}}} or short {{{kbd(w)}}} (~org-agenda-week-view~) ::
9459 #+findex: org-agenda-week-view
9460 Switch to week view. When switching week view, this setting
9461 becomes the default for subsequent agenda refreshes. A numeric
9462 prefix argument may be used to jump directly to a specific day of
9463 the ISO week. For example {{{kbd(9 w)}}} to ISO week number 9.
9464 When setting week view, a year may be encoded in the prefix
9465 argument as well. For example, {{{kbd(200712 w)}}} jumps to week
9466 12 in 2007. If such a year specification has only one or two
9467 digits, it is expanded into one of the 30 next years or the last
9470 - {{{kbd(v m)}}} (~org-agenda-month-view~) ::
9473 #+findex: org-agenda-month-view
9474 Switch to month view. Because month views are slow to create,
9475 they do not become the default for subsequent agenda refreshes.
9476 A numeric prefix argument may be used to jump directly to
9477 a specific day of the month. When setting month view, a year may
9478 be encoded in the prefix argument as well. For example,
9479 {{{kbd(200712 m)}}} jumps to December, 2007. If such a year
9480 specification has only one or two digits, it is expanded into one
9481 of the 30 next years or the last 69 years.
9483 - {{{kbd(v y)}}} (~org-agenda-year-view~) ::
9486 #+findex: org-agenda-year-view
9487 Switch to year view. Because year views are slow to create, they
9488 do not become the default for subsequent agenda refreshes.
9489 A numeric prefix argument may be used to jump directly to
9490 a specific day of the year.
9492 - {{{kbd(v SPC)}}} (~org-agenda-reset-view~) ::
9495 #+findex: org-agenda-reset-view
9496 #+vindex: org-agenda-span
9497 Reset the current view to ~org-agenda-span~.
9499 - {{{kbd(f)}}} (~org-agenda-later~) ::
9502 #+findex: org-agenda-later
9503 Go forward in time to display the span following the current one.
9504 For example, if the display covers a week, switch to the
9505 following week. With a prefix argument, repeat that many times.
9507 - {{{kbd(b)}}} (~org-agenda-earlier~) ::
9510 #+findex: org-agenda-earlier
9511 Go backward in time to display earlier dates.
9513 - {{{kbd(.)}}} (~org-agenda-goto-today~) ::
9516 #+findex: org-agenda-goto-today
9519 - {{{kbd(j)}}} (~org-agenda-goto-date~) ::
9522 #+findex: org-agenda-goto-date
9523 Prompt for a date and go there.
9525 - {{{kbd(J)}}} (~org-agenda-clock-goto~) ::
9528 #+findex: org-agenda-clock-goto
9529 Go to the currently clocked-in task /in the agenda buffer/.
9531 - {{{kbd(D)}}} (~org-agenda-toggle-diary~) ::
9534 #+findex: org-agenda-toggle-diary
9535 Toggle the inclusion of diary entries. See [[*Weekly/daily agenda]].
9537 - {{{kbd(v l)}}} or {{{kbd(v L)}}} or short {{{kbd(l)}}} (~org-agenda-log-mode~) ::
9542 #+findex: org-agenda-log-mode
9543 #+vindex: org-log-done
9544 #+vindex: org-agenda-log-mode-items
9545 Toggle Logbook mode. In Logbook mode, entries that were marked
9546 DONE while logging was on (see the variable ~org-log-done~) are
9547 shown in the agenda, as are entries that have been clocked on
9548 that day. You can configure the entry types that should be
9549 included in log mode using the variable
9550 ~org-agenda-log-mode-items~. When called with a {{{kbd(C-u)}}}
9551 prefix, show all possible logbook entries, including state
9552 changes. When called with two prefix arguments {{{kbd(C-u
9553 C-u)}}}, show only logging information, nothing else. {{{kbd(v
9554 L)}}} is equivalent to {{{kbd(C-u v l)}}}.
9556 - {{{kbd(v [)}}} or short {{{kbd([)}}} (~org-agenda-manipulate-query-add~) ::
9560 #+findex: org-agenda-manipulate-query-add
9561 Include inactive timestamps into the current view. Only for
9562 weekly/daily agenda and timeline views.
9564 - {{{kbd(v a)}}} (~org-agenda-archives-mode~) ::
9567 #+findex: org-agenda-archives-mode
9568 Toggle Archives mode. In Archives mode, trees that are archived
9569 (see [[*Internal archiving]]) are also scanned when producing the
9570 agenda. To exit archives mode, press {{{kbd(v a)}}} again.
9575 Toggle Archives mode. Include all archive files as well.
9577 - {{{kbd(v R)}}} or short {{{kbd(R)}}} (~org-agenda-clockreport-mode~) ::
9581 #+findex: org-agenda-clockreport-mode
9582 #+vindex: org-agenda-start-with-clockreport-mode
9583 #+vindex: org-clock-report-include-clocking-task
9584 Toggle Clockreport mode. In Clockreport mode, the daily/weekly
9585 agenda always shows a table with the clocked times for the time
9586 span and file scope covered by the current agenda view. The
9587 initial setting for this mode in new agenda buffers can be set
9588 with the variable ~org-agenda-start-with-clockreport-mode~. By
9589 using a prefix argument when toggling this mode (i.e., {{{kbd(C-u
9590 R)}}}), the clock table does not show contributions from entries
9591 that are hidden by agenda filtering[fn:96]. See also the
9592 variable ~org-clock-report-include-clocking-task~.
9597 #+vindex: org-agenda-clock-consistency-checks
9598 Show overlapping clock entries, clocking gaps, and other clocking
9599 problems in the current agenda range. You can then visit
9600 clocking lines and fix them manually. See the variable
9601 ~org-agenda-clock-consistency-checks~ for information on how to
9602 customize the definition of what constituted a clocking problem.
9603 To return to normal agenda display, press {{{kbd(l)}}} to exit
9606 - {{{kbd(v E)}}} or short {{{kbd(E)}}} (~org-agenda-entry-text-mode~) ::
9610 #+findex: org-agenda-entry-text-mode
9611 #+vindex: org-agenda-start-with-entry-text-mode
9612 #+vindex: org-agenda-entry-text-maxlines
9613 Toggle entry text mode. In entry text mode, a number of lines
9614 from the Org outline node referenced by an agenda line are
9615 displayed below the line. The maximum number of lines is given
9616 by the variable ~org-agenda-entry-text-maxlines~. Calling this
9617 command with a numeric prefix argument temporarily modifies that
9618 number to the prefix value.
9620 - {{{kbd(G)}}} (~org-agenda-toggle-time-grid~) ::
9623 #+vindex: org-agenda-use-time-grid
9624 #+vindex: org-agenda-time-grid
9625 Toggle the time grid on and off. See also the variables
9626 ~org-agenda-use-time-grid~ and ~org-agenda-time-grid~.
9628 - {{{kbd(r)}}} (~org-agenda-redo~), {{{kbd(g)}}} ::
9632 #+findex: org-agenda-redo
9633 Recreate the agenda buffer, for example to reflect the changes
9634 after modification of the timestamps of items with
9635 {{{kbd(S-LEFT)}}} and {{{kbd(S-RIGHT)}}}. When the
9636 buffer is the global TODO list, a prefix argument is interpreted
9637 to create a selective list for a specific TODO keyword.
9639 - {{{kbd(C-x C-s)}}} or short {{{kbd(s)}}} (~org-save-all-org-buffers~) ::
9642 #+findex: org-save-all-org-buffers
9644 Save all Org buffers in the current Emacs session, and also the
9647 - {{{kbd(C-c C-x C-c)}}} (~org-agenda-columns~) ::
9649 #+kindex: C-c C-x C-c
9650 #+findex: org-agenda-columns
9651 #+vindex: org-columns-default-format
9652 Invoke column view (see [[*Column View]]) in the agenda buffer. The
9653 column view format is taken from the entry at point, or, if there
9654 is no entry at point, from the first entry in the agenda view.
9655 So whatever the format for that entry would be in the original
9656 buffer (taken from a property, from a =COLUMNS= keyword, or from
9657 the default variable ~org-columns-default-format~) is used in the
9660 - {{{kbd(C-c C-x >)}}} (~org-agenda-remove-restriction-lock~) ::
9663 #+findex: org-agenda-remove-restriction-lock
9664 Remove the restriction lock on the agenda, if it is currently
9665 restricted to a file or subtree (see [[*Agenda Files]]).
9667 - {{{kbd(M-UP)}}} (~org-agenda-drag-line-backward~) ::
9670 #+findex: org-agenda-drag-line-backward
9671 Drag the line at point backward one line. With a numeric prefix
9672 argument, drag backward by that many lines.
9674 Moving agenda lines does not persist after an agenda refresh and
9675 does not modify the contributing Org files.
9677 - {{{kbd(M-DOWN)}}} (~org-agenda-drag-line-forward~) ::
9680 #+findex: org-agenda-drag-line-forward
9681 Drag the line at point forward one line. With a numeric prefix
9682 argument, drag forward by that many lines.
9688 #+cindex: remote editing, from agenda
9690 - {{{kbd(0--9)}}} ::
9694 - {{{kbd(C-_)}}} (~org-agenda-undo~) ::
9697 #+findex: org-agenda-undo
9698 #+cindex: undoing remote-editing events
9699 #+cindex: remote editing, undo
9700 Undo a change due to a remote editing command. The change is
9701 undone both in the agenda buffer and in the remote buffer.
9703 - {{{kbd(t)}}} (~org-agenda-todo~) ::
9706 #+findex: org-agenda-todo
9707 Change the TODO state of the item, both in the agenda and in the
9710 - {{{kbd(C-S-RIGHT)}}} (~org-agenda-todo-nextset~) ::
9713 #+findex: org-agenda-todo-nextset
9714 Switch to the next set of TODO keywords.
9716 - {{{kbd(C-S-LEFT)}}}, ~org-agenda-todo-previousset~ ::
9719 Switch to the previous set of TODO keywords.
9721 - {{{kbd(C-k)}}} (~org-agenda-kill~) ::
9724 #+findex: org-agenda-kill
9725 #+vindex: org-agenda-confirm-kill
9726 Delete the current agenda item along with the entire subtree
9727 belonging to it in the original Org file. If the text to be
9728 deleted remotely is longer than one line, the kill needs to be
9729 confirmed by the user. See variable ~org-agenda-confirm-kill~.
9731 - {{{kbd(C-c C-w)}}} (~org-agenda-refile~) ::
9734 #+findex: org-agenda-refile
9735 Refile the entry at point.
9737 - {{{kbd(C-c C-x C-a)}}} or short {{{kbd(a)}}} (~org-agenda-archive-default-with-confirmation~) ::
9739 #+kindex: C-c C-x C-a
9741 #+findex: org-agenda-archive-default-with-confirmation
9742 #+vindex: org-archive-default-command
9743 Archive the subtree corresponding to the entry at point using the
9744 default archiving command set in ~org-archive-default-command~.
9745 When using the {{{kbd(a)}}} key, confirmation is required.
9747 - {{{kbd(C-c C-x a)}}} (~org-agenda-toggle-archive-tag~) ::
9750 #+findex: org-agenda-toggle-archive-tag
9751 Toggle the archive tag (see [[*Internal archiving]]) for the current
9754 - {{{kbd(C-c C-x A)}}} (~org-agenda-archive-to-archive-sibling~) ::
9757 #+findex: org-agenda-archive-to-archive-sibling
9758 Move the subtree corresponding to the current entry to its
9761 - {{{kbd(C-c C-x C-s)}}} or short {{{kbd($)}}} (~org-agenda-archive~) ::
9763 #+kindex: C-c C-x C-s
9765 #+findex: org-agenda-archive
9766 Archive the subtree corresponding to the current headline. This
9767 means the entry is moved to the configured archive location, most
9768 likely a different file.
9770 - {{{kbd(T)}}} (~org-agenda-show-tags~) ::
9773 #+findex: org-agenda-show-tags
9774 #+vindex: org-agenda-show-inherited-tags
9775 Show all tags associated with the current item. This is useful
9776 if you have turned off ~org-agenda-show-inherited-tags~, but
9777 still want to see all tags of a headline occasionally.
9779 - {{{kbd(:)}}} (~org-agenda-set-tags~) ::
9782 #+findex: org-agenda-set-tags
9783 Set tags for the current headline. If there is an active region
9784 in the agenda, change a tag for all headings in the region.
9786 - {{{kbd(\,)}}} (~org-agenda-priority~) ::
9789 #+findex: org-agenda-priority
9790 Set the priority for the current item. Org mode prompts for the
9791 priority character. If you reply with {{{kbd(SPC)}}}, the
9792 priority cookie is removed from the entry.
9794 - {{{kbd(P)}}} (~org-agenda-show-priority~) ::
9797 #+findex: org-agenda-show-priority
9798 Display weighted priority of current item.
9800 - {{{kbd(+)}}} or {{{kbd(S-UP)}}} (~org-agenda-priority-up~) ::
9804 #+findex: org-agenda-priority-up
9805 Increase the priority of the current item. The priority is
9806 changed in the original buffer, but the agenda is not resorted.
9807 Use the {{{kbd(r)}}} key for this.
9809 - {{{kbd(-)}}} or {{{kbd(S-DOWN)}}} (~org-agenda-priority-down~) ::
9813 #+findex: org-agenda-priority-down
9814 Decrease the priority of the current item.
9816 - {{{kbd(C-c C-z)}}} or short {{{kbd(z)}}} (~org-agenda-add-note~) ::
9820 #+findex: org-agenda-add-note
9821 #+vindex: org-log-into-drawer
9822 Add a note to the entry. This note is recorded, and then filed
9823 to the same location where state change notes are put. Depending
9824 on ~org-log-into-drawer~, this may be inside a drawer.
9826 - {{{kbd(C-c C-a)}}} (~org-attach~) ::
9829 #+findex: org-attach
9830 Dispatcher for all command related to attachments.
9832 - {{{kbd(C-c C-s)}}} (~org-agenda-schedule~) ::
9835 #+findex: org-agenda-schedule
9836 Schedule this item. With a prefix argument, remove the
9837 scheduling timestamp
9839 - {{{kbd(C-c C-d)}}} (~org-agenda-deadline~) ::
9842 #+findex: org-agenda-deadline
9843 Set a deadline for this item. With a prefix argument, remove the
9846 - {{{kbd(S-RIGHT)}}} (~org-agenda-do-date-later~) ::
9849 #+findex: org-agenda-do-date-later
9850 Change the timestamp associated with the current line by one day
9851 into the future. If the date is in the past, the first call to
9852 this command moves it to today. With a numeric prefix argument,
9853 change it by that many days. For example, {{{kbd(3
9854 6 5 S-RIGHT)}}} changes it by a year. With a {{{kbd(C-u)}}}
9855 prefix, change the time by one hour. If you immediately repeat
9856 the command, it will continue to change hours even without the
9857 prefix argument. With a double {{{kbd(C-u C-u)}}} prefix, do the
9858 same for changing minutes. The stamp is changed in the original
9859 Org file, but the change is not directly reflected in the agenda
9860 buffer. Use {{{kbd(r)}}} or {{{kbd(g)}}} to update the buffer.
9862 - {{{kbd(S-LEFT)}}} (~org-agenda-do-date-earlier~) ::
9865 #+findex: org-agenda-do-date-earlier
9866 Change the timestamp associated with the current line by one day
9869 - {{{kbd(>)}}} (~org-agenda-date-prompt~) ::
9872 #+findex: org-agenda-date-prompt
9873 Change the timestamp associated with the current line. The key
9874 {{{kbd(>)}}} has been chosen, because it is the same as
9875 {{{kbd(S-.)}}} on my keyboard.
9877 - {{{kbd(I)}}} (~org-agenda-clock-in~) ::
9880 #+findex: org-agenda-clock-in
9881 Start the clock on the current item. If a clock is running
9882 already, it is stopped first.
9884 - {{{kbd(O)}}} (~org-agenda-clock-out~) ::
9887 #+findex: org-agenda-clock-out
9888 Stop the previously started clock.
9890 - {{{kbd(X)}}} (~org-agenda-clock-cancel~) ::
9893 #+findex: org-agenda-clock-cancel
9894 Cancel the currently running clock.
9896 - {{{kbd(J)}}} (~org-agenda-clock-goto~) ::
9899 #+findex: org-agenda-clock-goto
9900 Jump to the running clock in another window.
9902 - {{{kbd(k)}}} (~org-agenda-capture~) ::
9905 #+findex: org-agenda-capture
9906 #+cindex: capturing, from agenda
9907 #+vindex: org-capture-use-agenda-date
9908 Like ~org-capture~, but use the date at point as the default date
9909 for the capture template. See ~org-capture-use-agenda-date~ to
9910 make this the default behavior of ~org-capture~.
9912 *** Bulk remote editing selected entries
9916 #+cindex: remote editing, bulk, from agenda
9917 #+vindex: org-agenda-bulk-custom-functions
9919 - {{{kbd(m)}}} (~org-agenda-bulk-mark~) ::
9921 #+findex: org-agenda-bulk-mark
9923 Mark the entry at point for bulk action. If there is an active
9924 region in the agenda, mark the entries in the region. With
9925 numeric prefix argument, mark that many successive entries.
9927 - {{{kbd(*)}}} (~org-agenda-bulk-mark-all~) ::
9929 #+findex: org-agenda-bulk-mark-all
9931 Mark all visible agenda entries for bulk action.
9933 - {{{kbd(u)}}} (~org-agenda-bulk-unmark~) ::
9935 #+findex: org-agenda-bulk-unmark
9937 Unmark entry for bulk action.
9939 - {{{kbd(U)}}} (~org-agenda-bulk-remove-all-marks~) ::
9941 #+findex: org-agenda-bulk-remove-all-marks
9943 Unmark all marked entries for bulk action.
9945 - {{{kbd(M-m)}}} (~org-agenda-bulk-toggle~) ::
9947 #+findex: org-agenda-bulk-toggle
9949 Toggle mark of the entry at point for bulk action.
9951 - {{{kbd(M-*)}}} (~org-agenda-bulk-toggle-all~) ::
9953 #+findex: org-agenda-bulk-toggle-all
9955 Mark entries matching a regular expression for bulk action.
9957 - {{{kbd(%)}}} (~org-agenda-bulk-mark-regexp~) ::
9959 #+findex: org-agenda-bulk-mark-regexp
9961 Mark entries matching a regular expression for bulk action.
9963 - {{{kbd(B)}}} (~org-agenda-bulk-action~) ::
9965 #+findex: org-agenda-bulk-action
9966 #+vindex: org-agenda-bulk-persistent-marks
9968 Bulk action: act on all marked entries in the agenda. This
9969 prompts for another key to select the action to be applied. The
9970 prefix argument to {{{kbd(B)}}} is passed through to the
9971 {{{kbd(s)}}} and {{{kbd(d)}}} commands, to bulk-remove these
9972 special timestamps. By default, marks are removed after the
9973 bulk. If you want them to persist, set
9974 ~org-agenda-bulk-persistent-marks~ to ~t~ or hit {{{kbd(p)}}} at
9979 Toggle persistent marks.
9983 Archive all selected entries.
9987 Archive entries by moving them to their respective archive
9992 Change TODO state. This prompts for a single TODO keyword and
9993 changes the state of all selected entries, bypassing blocking
9994 and suppressing logging notes---but not timestamps.
9998 Add a tag to all selected entries.
10002 Remove a tag from all selected entries.
10006 Schedule all items to a new date. To shift existing schedule
10007 dates by a fixed number of days, use something starting with
10008 double plus at the prompt, for example =++8d= or =++2w=.
10012 Set deadline to a specific date.
10016 Prompt for a single refile target and move all entries. The
10017 entries are no longer in the agenda; refresh ({{{kbd(g)}}}) to
10022 Reschedule randomly into the coming N days. N is prompted for.
10023 With a prefix argument ({{{kbd(C-u B S)}}}), scatter only
10028 #+vindex: org-agenda-bulk-custom-functions
10029 Apply a function[fn:97] to marked entries. For example, the
10030 function below sets the =CATEGORY= property of the entries to
10033 #+begin_src emacs-lisp
10034 (defun set-category ()
10036 (let ((marker (or (org-get-at-bol 'org-hd-marker)
10037 (org-agenda-error))))
10038 (org-with-point-at marker
10039 (org-back-to-heading t)
10040 (org-set-property "CATEGORY" "web"))))
10043 *** Calendar commands
10047 #+cindex: calendar commands, from agenda
10049 - {{{kbd(c)}}} (~org-agenda-goto-calendar~) ::
10052 #+findex: org-agenda-goto-calendar
10053 Open the Emacs calendar and move to the date at the agenda
10056 - {{{kbd(c)}}} (~org-calendar-goto-agenda~) ::
10059 #+findex: org-calendar-goto-agenda
10060 When in the calendar, compute and show the Org agenda for the
10061 date at the cursor.
10063 - {{{kbd(i)}}} (~org-agenda-diary-entry~) ::
10065 #+findex: org-agenda-diary-entry
10067 #+cindex: diary entries, creating from agenda
10068 Insert a new entry into the diary, using the date at the cursor
10069 and (for block entries) the date at the mark. This adds to the
10070 Emacs diary file[fn:98], in a way similar to the {{{kbd(i)}}}
10071 command in the calendar. The diary file pops up in another
10072 window, where you can add the entry.
10074 #+vindex: org-agenda-diary-file
10075 If you configure ~org-agenda-diary-file~ to point to an Org file,
10076 Org creates entries in that file instead. Most entries are
10077 stored in a date-based outline tree that will later make it easy
10078 to archive appointments from previous months/years. The tree is
10079 built under an entry with a =DATE_TREE= property, or else with
10080 years as top-level entries. Emacs prompts you for the entry
10081 text---if you specify it, the entry is created in
10082 ~org-agenda-diary-file~ without further interaction. If you
10083 directly press {{{kbd(RET)}}} at the prompt without typing text,
10084 the target file is shown in another window for you to finish the
10085 entry there. See also the {{{kbd(k r)}}} command.
10087 - {{{kbd(M)}}} (~org-agenda-phases-of-moon~) ::
10090 #+findex: org-agenda-phases-of-moon
10091 Show the phases of the moon for the three months around current
10094 - {{{kbd(S)}}} (~org-agenda-sunrise-sunset~) ::
10097 #+findex: org-agenda-sunrise-sunset
10098 Show sunrise and sunset times. The geographical location must be
10099 set with calendar variables, see the documentation for the Emacs
10102 - {{{kbd(C)}}} (~org-agenda-convert-date~) ::
10105 #+findex: org-agenda-convert-date
10106 Convert the date at cursor into many other cultural and historic
10109 - {{{kbd(H)}}} (~org-agenda-holidays~) ::
10112 #+findex: org-agenda-holidays
10113 Show holidays for three months around the cursor date.
10120 - {{{kbd(q)}}} (~org-agenda-quit~) ::
10122 #+findex: org-agenda-quit
10124 Quit agenda, remove the agenda buffer.
10126 - {{{kbd(x)}}} (~org-agenda-exit~) ::
10128 #+findex: org-agenda-exit
10130 #+cindex: agenda files, removing buffers
10131 Exit agenda, remove the agenda buffer and all buffers loaded by
10132 Emacs for the compilation of the agenda. Buffers created by the
10133 user to visit Org files are not removed.
10135 ** Custom Agenda Views
10137 :DESCRIPTION: Defining special searches and views.
10139 #+cindex: custom agenda views
10140 #+cindex: agenda views, custom
10142 Custom agenda commands serve two purposes: to store and quickly access
10143 frequently used TODO and tags searches, and to create special
10144 composite agenda buffers. Custom agenda commands are accessible
10145 through the dispatcher (see [[*The Agenda Dispatcher]]), just like the
10148 *** Storing searches
10150 :DESCRIPTION: Type once, use often.
10153 The first application of custom searches is the definition of keyboard
10154 shortcuts for frequently used searches, either creating an agenda
10155 buffer, or a sparse tree (the latter covering of course only the
10158 #+kindex: C @r{(Agenda dispatcher)}
10159 #+vindex: org-agenda-custom-commands
10160 #+cindex: agenda views, main example
10161 #+cindex: agenda, as an agenda views
10162 #+cindex: agenda*, as an agenda views
10163 #+cindex: tags, as an agenda view
10164 #+cindex: todo, as an agenda view
10165 #+cindex: tags-todo
10166 #+cindex: todo-tree
10167 #+cindex: occur-tree
10168 #+cindex: tags-tree
10169 Custom commands are configured in the variable
10170 ~org-agenda-custom-commands~. You can customize this variable, for
10171 example by pressing {{{kbd(C)}}} from the agenda dispatcher (see [[*The
10172 Agenda Dispatcher]]). You can also directly set it with Emacs Lisp in
10173 the Emacs init file. The following example contains all valid agenda
10176 #+begin_src emacs-lisp
10177 (setq org-agenda-custom-commands
10180 ("w" todo "WAITING")
10181 ("W" todo-tree "WAITING")
10182 ("u" tags "+boss-urgent")
10183 ("v" tags-todo "+boss-urgent")
10184 ("U" tags-tree "+boss-urgent")
10185 ("f" occur-tree "\\<FIXME\\>")
10186 ("h" . "HOME+Name tags searches") ;description for "h" prefix
10187 ("hl" tags "+home+Lisa")
10188 ("hp" tags "+home+Peter")
10189 ("hk" tags "+home+Kim")))
10192 #+texinfo: @noindent
10193 The initial string in each entry defines the keys you have to press
10194 after the dispatcher command in order to access the command. Usually
10195 this will be just a single character, but if you have many similar
10196 commands, you can also define two-letter combinations where the first
10197 character is the same in several combinations and serves as a prefix
10198 key[fn:99]. The second parameter is the search type, followed by the
10199 string or regular expression to be used for the matching. The example
10200 above will therefore define:
10204 as a global search for agenda entries planned[fn:100] this
10209 as the same search, but only for entries with an hour
10210 specification like =[h]h:mm=---think of them as appointments.
10214 as a global search for TODO entries with =WAITING= as the TODO
10219 as the same search, but only in the current buffer and displaying
10220 the results as a sparse tree.
10224 as a global tags search for headlines tagged =boss= but not
10229 The same search, but limiting it to headlines that are also TODO
10234 as the same search, but only in the current buffer and displaying
10235 the result as a sparse tree.
10239 to create a sparse tree (again, current buffer only) with all
10240 entries containing the word =FIXME=.
10244 as a prefix command for a =HOME= tags search where you have to
10245 press an additional key ({{{kbd(l)}}}, {{{kbd(p)}}} or
10246 {{{kbd(k)}}}) to select a name (Lisa, Peter, or Kim) as
10247 additional tag to match.
10249 Note that ~*-tree~ agenda views need to be called from an Org buffer
10250 as they operate on the current buffer only.
10254 :DESCRIPTION: All the stuff you need in a single buffer.
10256 #+cindex: block agenda
10257 #+cindex: agenda, with block views
10259 Another possibility is the construction of agenda views that comprise
10260 the results of /several/ commands, each of which creates a block in
10261 the agenda buffer. The available commands include ~agenda~ for the
10262 daily or weekly agenda (as created with {{{kbd(a)}}}) , ~alltodo~ for
10263 the global TODO list (as constructed with {{{kbd(t)}}}), and the
10264 matching commands discussed above: ~todo~, ~tags~, and ~tags-todo~.
10265 Here are two examples:
10267 #+begin_src emacs-lisp
10268 (setq org-agenda-custom-commands
10269 '(("h" "Agenda and Home-related tasks"
10273 ("o" "Agenda and Office-related tasks"
10276 (tags "office")))))
10279 #+texinfo: @noindent
10280 This defines {{{kbd(h)}}} to create a multi-block view for stuff you
10281 need to attend to at home. The resulting agenda buffer contains your
10282 agenda for the current week, all TODO items that carry the tag =home=,
10283 and also all lines tagged with =garden=. Finally the command
10284 {{{kbd(o)}}} provides a similar view for office tasks.
10286 *** Setting options for custom commands
10288 :DESCRIPTION: Changing the rules.
10289 :ALT_TITLE: Setting options
10291 #+cindex: options, for custom agenda views
10293 #+vindex: org-agenda-custom-commands
10294 Org mode contains a number of variables regulating agenda construction
10295 and display. The global variables define the behavior for all agenda
10296 commands, including the custom commands. However, if you want to
10297 change some settings just for a single custom view, you can do so.
10298 Setting options requires inserting a list of variable names and values
10299 at the right spot in ~org-agenda-custom-commands~. For example:
10301 #+begin_src emacs-lisp
10302 (setq org-agenda-custom-commands
10303 '(("w" todo "WAITING"
10304 ((org-agenda-sorting-strategy '(priority-down))
10305 (org-agenda-prefix-format " Mixed: ")))
10306 ("U" tags-tree "+boss-urgent"
10307 ((org-show-context-detail 'minimal)))
10309 ((org-agenda-files '("~org/notes.org"))
10310 (org-agenda-text-search-extra-files nil)))))
10313 #+texinfo: @noindent
10314 Now the {{{kbd(w)}}} command sorts the collected entries only by
10315 priority, and the prefix format is modified to just say =Mixed:=
10316 instead of giving the category of the entry. The sparse tags tree of
10317 {{{kbd(U)}}} now turns out ultra-compact, because neither the headline
10318 hierarchy above the match, nor the headline following the match are
10319 shown. The command {{{kbd(N)}}} does a text search limited to only
10322 For command sets creating a block agenda, ~org-agenda-custom-commands~
10323 has two separate spots for setting options. You can add options that
10324 should be valid for just a single command in the set, and options that
10325 should be valid for all commands in the set. The former are just
10326 added to the command entry; the latter must come after the list of
10327 command entries. Going back to the block agenda example (see [[*Block
10328 agenda]]), let's change the sorting strategy for the {{{kbd(h)}}}
10329 commands to ~priority-down~, but let's sort the results for GARDEN
10330 tags query in the opposite order, ~priority-up~. This would look like
10333 #+begin_src emacs-lisp
10334 (setq org-agenda-custom-commands
10335 '(("h" "Agenda and Home-related tasks"
10339 ((org-agenda-sorting-strategy '(priority-up)))))
10340 ((org-agenda-sorting-strategy '(priority-down))))
10341 ("o" "Agenda and Office-related tasks"
10344 (tags "office")))))
10347 As you see, the values and parentheses setting is a little complex.
10348 When in doubt, use the customize interface to set this variable---it
10349 fully supports its structure. Just one caveat: when setting options
10350 in this interface, the /values/ are just Lisp expressions. So if the
10351 value is a string, you need to add the double-quotes around the value
10354 #+vindex: org-agenda-custom-commands-contexts
10355 To control whether an agenda command should be accessible from
10356 a specific context, you can customize
10357 ~org-agenda-custom-commands-contexts~. Let's say for example that you
10358 have an agenda command {{{kbd(o)}}} displaying a view that you only
10359 need when reading emails. Then you would configure this option like
10362 #+begin_src emacs-lisp
10363 (setq org-agenda-custom-commands-contexts
10364 '(("o" (in-mode . "message-mode"))))
10367 You can also tell that the command key {{{kbd(o)}}} should refer to
10368 another command key {{{kbd(r)}}}. In that case, add this command key
10371 #+begin_src emacs-lisp
10372 (setq org-agenda-custom-commands-contexts
10373 '(("o" "r" (in-mode . "message-mode"))))
10376 See the docstring of the variable for more information.
10378 ** Exporting Agenda Views
10380 :DESCRIPTION: Writing a view to a file.
10382 #+cindex: agenda views, exporting
10384 If you are away from your computer, it can be very useful to have
10385 a printed version of some agenda views to carry around. Org mode can
10386 export custom agenda views as plain text, HTML[fn:101], Postscript,
10387 PDF[fn:102], and iCalendar files. If you want to do this only
10388 occasionally, use the following command:
10390 - {{{kbd(C-x C-w)}}} (~org-agenda-write~) ::
10392 #+findex: org-agenda-write
10393 #+cindex: exporting agenda views
10394 #+cindex: agenda views, exporting
10396 #+vindex: org-agenda-exporter-settings
10397 Write the agenda view to a file.
10399 If you need to export certain agenda views frequently, you can
10400 associate any custom agenda command with a list of output file
10401 names[fn:103]. Here is an example that first defines custom commands
10402 for the agenda and the global TODO list, together with a number of
10403 files to which to export them. Then we define two block agenda
10404 commands and specify file names for them as well. File names can be
10405 relative to the current working directory, or absolute.
10407 #+begin_src emacs-lisp
10408 (setq org-agenda-custom-commands
10409 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
10410 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
10411 ("h" "Agenda and Home-related tasks"
10416 ("~/views/home.html"))
10417 ("o" "Agenda and Office-related tasks"
10422 ("~/views/office.ps" "~/calendars/office.ics"))))
10425 The extension of the file name determines the type of export. If it
10426 is =.html=, Org mode uses the htmlize package to convert the buffer to
10427 HTML and save it to this file name. If the extension is =.ps=,
10428 ~ps-print-buffer-with-faces~ is used to produce Postscript output. If
10429 the extension is =.ics=, iCalendar export is run export over all files
10430 that were used to construct the agenda, and limit the export to
10431 entries listed in the agenda. Any other extension produces a plain
10434 The export files are /not/ created when you use one of those
10435 commands interactively because this might use too much overhead.
10436 Instead, there is a special command to produce /all/ specified
10439 - {{{kbd(e)}}} (~org-store-agenda-views~) ::
10441 #+kindex: e @r{(Agenda dispatcher)}
10442 #+findex: org-store-agenda-views
10443 Export all agenda views that have export file names associated
10446 You can use the options section of the custom agenda commands to also
10447 set options for the export commands. For example:
10449 #+begin_src emacs-lisp
10450 (setq org-agenda-custom-commands
10452 ((ps-number-of-columns 2)
10453 (ps-landscape-mode t)
10454 (org-agenda-prefix-format " [ ] ")
10455 (org-agenda-with-colors nil)
10456 (org-agenda-remove-tags t))
10457 ("theagenda.ps"))))
10460 #+texinfo: @noindent
10461 #+vindex: org-agenda-exporter-settings
10462 This command sets two options for the Postscript exporter, to make it
10463 print in two columns in landscape format---the resulting page can be
10464 cut in two and then used in a paper agenda. The remaining settings
10465 modify the agenda prefix to omit category and scheduling information,
10466 and instead include a checkbox to check off items. We also remove the
10467 tags to make the lines compact, and we do not want to use colors for
10468 the black-and-white printer. Settings specified in
10469 ~org-agenda-exporter-settings~ also apply, e.g.,
10471 #+begin_src emacs-lisp
10472 (setq org-agenda-exporter-settings
10473 '((ps-number-of-columns 2)
10474 (ps-landscape-mode t)
10475 (org-agenda-add-entry-text-maxlines 5)
10476 (htmlize-output-type 'css)))
10479 #+texinfo: @noindent
10480 but the settings in ~org-agenda-custom-commands~ take precedence.
10482 #+texinfo: @noindent
10483 From the command line you may also use:
10486 emacs -eval (org-batch-store-agenda-views) -kill
10489 #+texinfo: @noindent
10490 or, if you need to modify some parameters[fn:104]
10493 emacs -eval '(org-batch-store-agenda-views \
10494 org-agenda-span (quote month) \
10495 org-agenda-start-day "2007-11-01" \
10496 org-agenda-include-diary nil \
10497 org-agenda-files (quote ("~/org/project.org")))' \
10501 #+texinfo: @noindent
10502 which creates the agenda views restricted to the file
10503 =~/org/project.org=, without diary entries and with a 30-day extent.
10505 You can also extract agenda information in a way that allows further
10506 processing by other programs. See [[*Extracting Agenda Information]], for
10509 ** Using Column View in the Agenda
10511 :DESCRIPTION: Using column view for collected entries.
10512 :ALT_TITLE: Agenda Column View
10514 #+cindex: column view, in agenda
10515 #+cindex: agenda, column view
10517 Column view (see [[*Column View]]) is normally used to view and edit
10518 properties embedded in the hierarchical structure of an Org file. It
10519 can be quite useful to use column view also from the agenda, where
10520 entries are collected by certain criteria.
10522 - {{{kbd(C-c C-x C-c)}}} (~org-agenda-columns~) ::
10523 #+kindex: C-c C-x C-c
10524 #+findex: org-agenda-columns
10526 Turn on column view in the agenda.
10528 To understand how to use this properly, it is important to realize
10529 that the entries in the agenda are no longer in their proper outline
10530 environment. This causes the following issues:
10533 #+vindex: org-columns-default-format
10534 #+vindex: org-overriding-columns-format
10535 Org needs to make a decision which columns format to use. Since
10536 the entries in the agenda are collected from different files, and
10537 different files may have different columns formats, this is
10538 a non-trivial problem. Org first checks if the variable
10539 ~org-agenda-overriding-columns-format~ is currently set, and if so,
10540 takes the format from there. Otherwise it takes the format
10541 associated with the first item in the agenda, or, if that item does
10542 not have a specific format (defined in a property, or in its file),
10543 it uses ~org-columns-default-format~.
10546 #+cindex: @samp{CLOCKSUM}, special property
10547 If any of the columns has a summary type defined (see [[*Column
10548 attributes]]), turning on column view in the agenda visits all
10549 relevant agenda files and make sure that the computations of this
10550 property are up to date. This is also true for the special
10551 =CLOCKSUM= property. Org then sums the values displayed in the
10552 agenda. In the daily/weekly agenda, the sums cover a single day;
10553 in all other views they cover the entire block.
10555 It is important to realize that the agenda may show the same entry
10556 /twice/---for example as scheduled and as a deadline---and it may
10557 show two entries from the same hierarchy (for example a /parent/
10558 and its /child/). In these cases, the summation in the agenda
10559 leads to incorrect results because some values count double.
10561 3. When the column view in the agenda shows the =CLOCKSUM= property,
10562 that is always the entire clocked time for this item. So even in
10563 the daily/weekly agenda, the clocksum listed in column view may
10564 originate from times outside the current view. This has the
10565 advantage that you can compare these values with a column listing
10566 the planned total effort for a task---one of the major
10567 applications for column view in the agenda. If you want
10568 information about clocked time in the displayed period use clock
10569 table mode (press {{{kbd(R)}}} in the agenda).
10572 #+cindex: @samp{CLOCKSUM_T}, special property
10573 When the column view in the agenda shows the =CLOCKSUM_T= property,
10574 that is always today's clocked time for this item. So even in the
10575 weekly agenda, the clocksum listed in column view only originates
10576 from today. This lets you compare the time you spent on a task for
10577 today, with the time already spent---via =CLOCKSUM=---and with
10578 the planned total effort for it.
10580 * Markup for Rich Export
10582 :DESCRIPTION: Prepare text for rich export.
10586 When exporting Org documents, the exporter tries to reflect the
10587 structure of the document as accurately as possible in the back-end.
10588 Since export targets like HTML and LaTeX allow much richer formatting,
10589 Org mode has rules on how to prepare text for rich export. This
10590 section summarizes the markup rules used in an Org mode buffer.
10594 :DESCRIPTION: The basic unit of text.
10596 #+cindex: paragraphs, markup rules
10598 Paragraphs are separated by at least one empty line. If you need to
10599 enforce a line break within a paragraph, use ~\\~ at the end of
10602 To preserve the line breaks, indentation and blank lines in a region,
10603 but otherwise use normal formatting, you can use this construct, which
10604 can also be used to format poetry.
10606 #+cindex: @samp{BEGIN_VERSE}
10607 #+cindex: verse blocks
10610 Great clouds overhead
10611 Tiny black birds rise and fall
10618 When quoting a passage from another document, it is customary to
10619 format this as a paragraph that is indented on both the left and the
10620 right margin. You can include quotations in Org documents like this:
10622 #+cindex: @samp{BEGIN_QUOTE}
10623 #+cindex: quote blocks
10626 Everything should be made as simple as possible,
10627 but not any simpler ---Albert Einstein
10631 If you would like to center some text, do it like this:
10633 #+cindex: @samp{BEGIN_CENTER}
10634 #+cindex: center blocks
10637 Everything should be made as simple as possible, \\
10638 but not any simpler
10642 ** Emphasis and Monospace
10644 :DESCRIPTION: Bold, italic, etc.
10646 #+cindex: underlined text, markup rules
10647 #+cindex: bold text, markup rules
10648 #+cindex: italic text, markup rules
10649 #+cindex: verbatim text, markup rules
10650 #+cindex: code text, markup rules
10651 #+cindex: strike-through text, markup rules
10653 You can make words =*bold*=, =/italic/=, =_underlined_=, ==verbatim==
10654 and =~code~=, and, if you must, =+strike-through+=. Text in the code
10655 and verbatim string is not processed for Org mode specific syntax; it
10656 is exported verbatim.
10658 #+vindex: org-fontify-emphasized-text
10659 To turn off fontification for marked up text, you can set
10660 ~org-fontify-emphasized-text~ to ~nil~. To narrow down the list of
10661 available markup syntax, you can customize ~org-emphasis-alist~.
10663 ** Horizontal Rules
10665 :DESCRIPTION: Make a line.
10667 #+cindex: horizontal rules, markup rules
10669 A line consisting of only dashes, and at least 5 of them, is exported
10670 as a horizontal line.
10672 ** Images and Tables
10674 :DESCRIPTION: Images, tables and caption mechanism.
10676 #+cindex: tables, markup rules
10677 #+cindex: @samp{CAPTION}, keyword
10678 #+cindex: @samp{NAME}, keyword
10680 Both the native Org mode tables (see [[*Tables]]) and tables formatted
10681 with the =table.el= package are exported properly. For Org mode
10682 tables, the lines before the first horizontal separator line become
10683 table header lines. You can use the following lines somewhere before
10684 the table to assign a caption and a label for cross references, and in
10685 the text you can refer to the object with =[[tab:basic-data]]= (see
10686 [[*Internal Links]]):
10689 ,#+CAPTION: This is the caption for the next table (or link)
10690 ,#+NAME: tab:basic-data
10695 Optionally, the caption can take the form:
10697 : #+CAPTION[Caption for list of tables]: Caption for table.
10699 #+cindex: inlined images, markup rules
10700 Some back-ends allow you to directly include images into the exported
10701 document. Org does this, if a link to an image file does not have
10702 a description part, for example =[[./img/a.jpg]]=. If you wish to define
10703 a caption for the image and maybe a label for internal cross
10704 references, make sure that the link is on a line by itself and precede
10705 it with =CAPTION= and =NAME= keywords as follows:
10708 ,#+CAPTION: This is the caption for the next figure link (or table)
10709 ,#+NAME: fig:SED-HR4049
10713 #+texinfo: @noindent
10714 Such images can be displayed within the buffer. See [[*Handling Links][the discussion of
10717 Even though images and tables are prominent examples of captioned
10718 structures, the same caption mechanism can apply to many
10719 others---e.g., LaTeX equations, source code blocks. Depending on the
10720 export back-end, those may or may not be handled.
10722 ** Literal Examples
10724 :DESCRIPTION: Source code examples with special formatting.
10726 #+cindex: literal examples, markup
10727 #+cindex: code line references, markup
10729 You can include literal examples that should not be subjected to
10730 markup. Such examples are typeset in monospace, so this is well
10731 suited for source code and similar examples.
10733 #+cindex: @samp{BEGIN_EXAMPLE}
10734 #+cindex: example block
10737 Some example from a text file.
10741 Note that such blocks may be /indented/ in order to align nicely with
10742 indented text and in particular with plain list structure (see
10743 [[*Plain Lists]]). For simplicity when using small examples, you can
10744 also start the example lines with a colon followed by a space. There
10745 may also be additional whitespace before the colon:
10749 : Some example from a text file.
10752 #+cindex: formatting source code, markup rules
10753 #+vindex: org-latex-listings
10754 If the example is source code from a programming language, or any
10755 other text that can be marked up by Font Lock in Emacs, you can ask
10756 for the example to look like the fontified Emacs buffer[fn:105]. This
10757 is done with the code block, where you also need to specify the name
10758 of the major mode that should be used to fontify the example[fn:106],
10759 see [[*Structure Templates]] for shortcuts to easily insert code blocks.
10761 #+cindex: @samp{BEGIN_SRC}
10762 #+cindex: src block
10764 ,#+BEGIN_SRC emacs-lisp
10765 (defun org-xor (a b)
10771 Both in =example= and in =src= snippets, you can add a =-n= switch to
10772 the end of the =#+BEGIN= line, to get the lines of the example
10773 numbered. The =-n= takes an optional numeric argument specifying the
10774 starting line number of the block. If you use a =+n= switch, the
10775 numbering from the previous numbered snippet is continued in the
10776 current one. The =+n= switch can also take a numeric argument. This
10777 adds the value of the argument to the last line of the previous block
10778 to determine the starting line number.
10781 ,#+BEGIN_SRC emacs-lisp -n 20
10782 ;; This exports with line number 20.
10783 (message "This is line 21")
10786 ,#+BEGIN_SRC emacs-lisp +n 10
10787 ;; This is listed as line 31.
10788 (message "This is line 32")
10792 In literal examples, Org interprets strings like =(ref:name)= as
10793 labels, and use them as targets for special hyperlinks like
10794 =[[(name)]]=---i.e., the reference name enclosed in single parenthesis.
10795 In HTML, hovering the mouse over such a link remote-highlights the
10796 corresponding code line, which is kind of cool.
10798 You can also add a =-r= switch which /removes/ the labels from the
10799 source code[fn:107]. With the =-n= switch, links to these references
10800 are labeled by the line numbers from the code listing. Otherwise
10801 links use the labels with no parentheses. Here is an example:
10803 #+begin_example -l "(dumb-reference:%s)"
10804 ,#+BEGIN_SRC emacs-lisp -n -r
10805 (save-excursion (ref:sc)
10806 (goto-char (point-min)) (ref:jump)
10808 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
10809 jumps to point-min.
10812 #+cindex: indentation, in source blocks
10813 Finally, you can use =-i= to preserve the indentation of a specific
10814 code block (see [[*Editing Source Code]]).
10816 #+vindex: org-coderef-label-format
10817 If the syntax for the label format conflicts with the language syntax,
10818 use a =-l= switch to change the format, for example
10820 : #+BEGIN_SRC pascal -n -r -l "((%s))"
10822 #+texinfo: @noindent
10823 See also the variable ~org-coderef-label-format~.
10825 HTML export also allows examples to be published as text areas (see
10826 [[*Text areas in HTML export]]).
10828 Because the =#+BEGIN= ... =#+END= patterns need to be added so often,
10829 a shortcut is provided (see [[*Structure Templates]]).
10831 - {{{kbd(C-c ')}}} (~org-edit-special~) ::
10834 #+findex: org-edit-special
10835 Edit the source code example at point in its native mode. This
10836 works by switching to a temporary buffer with the source code.
10837 You need to exit by pressing {{{kbd(C-c ')}}} again[fn:108]. The
10838 edited version then replaces the old version in the Org buffer.
10839 Fixed-width regions---where each line starts with a colon
10840 followed by a space---are edited using ~artist-mode~[fn:109] to
10841 allow creating ASCII drawings easily. Using this command in an
10842 empty line creates a new fixed-width region.
10844 #+cindex: storing link, in a source code buffer
10845 Calling ~org-store-link~ (see [[*Handling Links]]) while editing a source
10846 code example in a temporary buffer created with {{{kbd(C-c ')}}}
10847 prompts for a label. Make sure that it is unique in the current
10848 buffer, and insert it with the proper formatting like =(ref:label)= at
10849 the end of the current line. Then the label is stored as a link
10850 =(label)=, for retrieval with {{{kbd(C-c C-l)}}}.
10854 :DESCRIPTION: Greek letters and other symbols.
10856 #+cindex: math symbols
10857 #+cindex: special symbols
10858 #+cindex: @TeX{} macros
10859 #+cindex: @LaTeX{} fragments, markup rules
10860 #+cindex: HTML entities
10861 #+cindex: @LaTeX{} entities
10863 You can use LaTeX-like syntax to insert special symbols---named
10864 entities---like =\alpha= to indicate the Greek letter, or =\to= to indicate
10865 an arrow. Completion for these symbols is available, just type =\=
10866 and maybe a few letters, and press {{{kbd(M-TAB)}}} to see possible
10867 completions. If you need such a symbol inside a word, terminate it
10868 with a pair of curly brackets. For example
10871 Pro tip: Given a circle \Gamma of diameter d, the length of its
10872 circumference is \pi{}d.
10875 #+findex: org-entities-help
10876 #+vindex: org-entities-user
10877 A large number of entities is provided, with names taken from both
10878 HTML and LaTeX; you can comfortably browse the complete list from
10879 a dedicated buffer using the command ~org-entities-help~. It is also
10880 possible to provide your own special symbols in the variable
10881 ~org-entities-user~.
10883 During export, these symbols are transformed into the native format of
10884 the exporter back-end. Strings like =\alpha= are exported as =α= in
10885 the HTML output, and as =\(\alpha\)= in the LaTeX output. Similarly, =\nbsp=
10886 becomes = = in HTML and =~= in LaTeX.
10888 #+cindex: escaping characters
10889 Entities may also be used as a way to escape markup in an Org
10890 document, e.g., =\under{}not underlined\under= exports as =_not underlined_=.
10892 #+cindex: special symbols, in-buffer display
10893 If you would like to see entities displayed as UTF-8 characters, use
10894 the following command[fn:110]:
10896 - {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) ::
10897 #+kindex: C-c C-x \
10898 #+findex: org-toggle-pretty-entities
10900 Toggle display of entities as UTF-8 characters. This does not
10901 change the buffer content which remains plain ASCII, but it
10902 overlays the UTF-8 character for display purposes only.
10904 #+cindex: shy hyphen, special symbol
10905 #+cindex: dash, special symbol
10906 #+cindex: ellipsis, special symbol
10907 In addition to regular entities defined above, Org exports in
10908 a special way[fn:111] the following commonly used character
10909 combinations: =\-= is treated as a shy hyphen, =--= and =---= are
10910 converted into dashes, and =...= becomes a compact set of dots.
10912 ** Subscripts and Superscripts
10914 :DESCRIPTION: Simple syntax for raising/lowering text.
10916 #+cindex: subscript
10917 #+cindex: superscript
10919 =^= and =_= are used to indicate super- and subscripts. To increase
10920 the readability of ASCII text, it is not necessary, but OK, to
10921 surround multi-character sub- and superscripts with curly braces. For
10925 The radius of the sun is R_sun = 6.96 x 10^8 m. On the other hand,
10926 the radius of Alpha Centauri is R_{Alpha Centauri} = 1.28 x R_{sun}.
10929 #+vindex: org-use-sub-superscripts
10930 If you write a text where the underscore is often used in a different
10931 context, Org's convention to always interpret these as subscripts can
10932 get in your way. Configure the variable ~org-use-sub-superscripts~ to
10933 change this convention. For example, when setting this variable to
10934 ~{}~, =a_b= is not interpreted as a subscript, but =a_{b}= is.
10936 - {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~~) ::
10937 #+kindex: C-c C-x \
10938 #+findex: org-toggle-pretty-entities
10940 In addition to showing entities as UTF-8 characters, this command
10941 also formats sub- and superscripts in a WYSIWYM way.
10945 :DESCRIPTION: LaTeX can be freely used inside Org documents.
10947 #+cindex: @TeX{} interpretation
10948 #+cindex: @LaTeX{} interpretation
10950 Plain ASCII is normally sufficient for almost all note taking.
10951 Exceptions include scientific notes, which often require mathematical
10952 symbols and the occasional formula. LaTeX[fn:112] is widely used to
10953 typeset scientific documents. Org mode supports embedding LaTeX code
10954 into its files, because many academics are used to writing and reading
10955 LaTeX source code, and because it can be readily processed to produce
10956 pretty output for a number of export back-ends.
10958 *** LaTeX fragments
10960 :DESCRIPTION: Complex formulas made easy.
10962 #+cindex: @LaTeX{} fragments
10964 #+vindex: org-format-latex-header
10965 Org mode can contain LaTeX math fragments, and it supports ways to
10966 process these for several export back-ends. When exporting to LaTeX,
10967 the code is left as it is. When exporting to HTML, Org can use either
10968 [[http://www.mathjax.org][MathJax]] (see [[*Math formatting in HTML export]]) or transcode the math
10969 into images (see [[*Previewing LaTeX fragments]]).
10971 LaTeX fragments do not need any special marking at all. The following
10972 snippets are identified as LaTeX source code:
10974 - Environments of any kind[fn:113]. The only requirement is that the
10975 =\begin= statement appears on a new line, preceded by only
10978 - Text within the usual LaTeX math delimiters. To avoid conflicts
10979 with currency specifications, single =$= characters are only
10980 recognized as math delimiters if the enclosed text contains at most
10981 two line breaks, is directly attached to the =$= characters with no
10982 whitespace in between, and if the closing =$= is followed by
10983 whitespace, punctuation or a dash. For the other delimiters, there
10984 is no such restriction, so when in doubt, use =\(...\)= as inline
10987 #+texinfo: @noindent
10991 \begin{equation} % arbitrary environments,
10992 x=\sqrt{b} % even tables, figures
10993 \end{equation} % etc
10995 If $a^2=b$ and \( b=2 \), then the solution must be
10996 either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].
10999 #+vindex: org-export-with-latex
11000 LaTeX processing can be configured with the variable
11001 ~org-export-with-latex~. The default setting is ~t~ which means
11002 MathJax for HTML, and no processing for ASCII and LaTeX back-ends.
11003 You can also set this variable on a per-file basis using one of these
11006 | =#+OPTIONS: tex:t= | Do the right thing automatically (MathJax) |
11007 | =#+OPTIONS: tex:nil= | Do not process LaTeX fragments at all |
11008 | =#+OPTIONS: tex:verbatim= | Verbatim export, for jsMath or so |
11010 *** Previewing LaTeX fragments
11012 :DESCRIPTION: What will this snippet look like?
11014 #+cindex: @LaTeX{} fragments, preview
11016 #+vindex: org-preview-latex-default-process
11017 If you have a working LaTeX installation and =dvipng=, =dvisvgm= or
11018 =convert= installed[fn:114], LaTeX fragments can be processed to
11019 produce images of the typeset expressions to be used for inclusion
11020 while exporting to HTML (see [[*LaTeX fragments]]), or for inline
11021 previewing within Org mode.
11023 #+vindex: org-format-latex-options
11024 #+vindex: org-format-latex-header
11025 You can customize the variables ~org-format-latex-options~ and
11026 ~org-format-latex-header~ to influence some aspects of the preview.
11027 In particular, the ~:scale~ (and for HTML export, ~:html-scale~)
11028 property of the former can be used to adjust the size of the preview
11031 - {{{kbd(C-c C-x C-l)}}} (~org-toggle-latex-fragment~) ::
11032 #+kindex: C-c C-x C-l
11033 #+findex: org-toggle-latex-fragment
11035 Produce a preview image of the LaTeX fragment at point and
11036 overlay it over the source code. If there is no fragment at
11037 point, process all fragments in the current entry (between two
11038 headlines). When called with a prefix argument, process the
11039 entire subtree. When called with two prefix arguments, or when
11040 the cursor is before the first headline, process the entire
11043 #+vindex: org-startup-with-latex-preview
11044 You can turn on the previewing of all LaTeX fragments in a file with
11046 : #+STARTUP: latexpreview
11048 To disable it, simply use
11050 : #+STARTUP: nolatexpreview
11052 *** Using CDLaTeX to enter math
11054 :DESCRIPTION: Speed up entering of formulas.
11055 :ALT_TITLE: CDLaTeX mode
11057 #+cindex: CD@LaTeX{}
11059 CDLaTeX mode is a minor mode that is normally used in combination with
11060 a major LaTeX mode like AUCTeX in order to speed-up insertion of
11061 environments and math templates. Inside Org mode, you can make use of
11062 some of the features of CDLaTeX mode. You need to install
11063 =cdlatex.el= and =texmathp.el= (the latter comes also with AUCTeX)
11064 from [[http://www.astro.uva.nl/~dominik/Tools/cdlatex]]. Do not use
11065 CDLaTeX mode itself under Org mode, but use the light version
11066 ~org-cdlatex-mode~ that comes as part of Org mode. Turn it on for the
11067 current buffer with {{{kbd(M-x org-cdlatex-mode)}}}, or for all Org
11070 #+begin_src emacs-lisp
11071 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
11074 When this mode is enabled, the following features are present (for
11075 more details see the documentation of CDLaTeX mode):
11077 #+attr_texinfo: :sep ,
11078 - {{{kbd(C-c {)}}} ::
11081 Insert an environment template.
11083 - {{{kbd(TAB)}}} ::
11086 The {{{kbd(TAB)}}} key expands the template if the cursor is
11087 inside a LaTeX fragment[fn:115]. For example, {{{kbd(TAB)}}}
11088 expands =fr= to =\frac{}{}= and position the cursor correctly
11089 inside the first brace. Another {{{kbd(TAB)}}} gets you into the
11092 Even outside fragments, {{{kbd(TAB)}}} expands environment
11093 abbreviations at the beginning of a line. For example, if you
11094 write =equ= at the beginning of a line and press {{{kbd(TAB)}}},
11095 this abbreviation is expanded to an =equation= environment. To
11096 get a list of all abbreviations, type {{{kbd(M-x
11097 cdlatex-command-help)}}}.
11099 - {{{kbd(^)}}}, {{{kbd(_)}}} ::
11102 #+vindex: cdlatex-simplify-sub-super-scripts
11104 Pressing {{{kbd(_)}}} and {{{kbd(^)}}} inside a LaTeX fragment
11105 inserts these characters together with a pair of braces. If you
11106 use {{{kbd(TAB)}}} to move out of the braces, and if the braces
11107 surround only a single character or macro, they are removed again
11108 (depending on the variable ~cdlatex-simplify-sub-super-scripts~).
11113 Pressing the backquote followed by a character inserts math
11114 macros, also outside LaTeX fragments. If you wait more than 1.5
11115 seconds after the backquote, a help window pops up.
11120 Pressing the single-quote followed by another character modifies
11121 the symbol before point with an accent or a font. If you wait
11122 more than 1.5 seconds after the single-quote, a help window pops
11123 up. Character modification works only inside LaTeX fragments;
11124 outside the quote is normal.
11128 :DESCRIPTION: Sharing and publishing notes.
11130 #+cindex: exporting
11132 Sometimes, you may want to pretty print your notes, publish them on
11133 the web or even share them with people not using Org. In these cases,
11134 the Org export facilities can be used to convert your documents to
11135 a variety of other formats, while retaining as much structure (see
11136 [[*Document Structure]]) and markup (see [[*Markup for Rich Export]]) as
11139 #+cindex: export back-end
11140 Libraries responsible for such translation are called back-ends. Org
11141 ships with the following ones
11143 - /ascii/ (ASCII format)
11144 - /beamer/ (LaTeX Beamer format)
11145 - /html/ (HTML format)
11146 - /icalendar/ (iCalendar format)
11147 - /latex/ (LaTeX format)
11148 - /md/ (Markdown format)
11149 - /odt/ (OpenDocument Text format)
11150 - /org/ (Org format)
11151 - /texinfo/ (Texinfo format)
11152 - /man/ (Man page format)
11154 #+texinfo: @noindent
11155 Org also uses additional libraries located in =contrib/= directory
11156 (see [[*Installation]]). Users can install additional export libraries
11157 for additional formats from the Emacs packaging system. For easy
11158 discovery, these packages have a common naming scheme: ~ox-NAME~,
11159 where {{{var(NAME)}}} is one of the formats. For example,
11160 ~ox-koma-letter~ /koma-letter/ back-end.
11162 #+vindex: org-export-backends
11163 Org loads back-ends for the following formats by default: ASCII, HTML,
11164 iCalendar, LaTeX and ODT. Org can load additional back-ends either of
11165 two ways: through the ~org-export-backends~ variable configuration;
11166 or, by requiring the library in the Emacs init file like this:
11168 #+begin_src emacs-lisp
11172 ** The Export Dispatcher
11174 :DESCRIPTION: The main interface.
11176 #+cindex: dispatcher, for export commands
11177 #+cindex: Export, dispatcher
11179 The export dispatcher is the main interface for Org's exports.
11180 A hierarchical menu presents the currently configured export formats.
11181 Options are shown as easy toggle switches on the same screen.
11183 #+vindex: org-export-dispatch-use-expert-ui
11184 Org also has a minimal prompt interface for the export dispatcher.
11185 When the variable ~org-export-dispatch-use-expert-ui~ is set to
11186 a non-~nil~ value, Org prompts in the minibuffer. To switch back to
11187 the hierarchical menu, press {{{kbd(?)}}}.
11189 - {{{kbd(C-c C-e)}}} (~org-export~) ::
11191 #+findex: org-export
11193 Invokes the export dispatcher interface. The options show
11194 default settings. The {{{kbd(C-u)}}} prefix argument preserves
11195 options from the previous export, including any sub-tree
11198 Org exports the entire buffer by default. If the Org buffer has an
11199 active region, then Org exports just that region.
11201 Within the dispatcher interface, the following key combinations can
11202 further alter what is exported, and how.
11204 - {{{kbd(C-a)}}} ::
11205 #+kindex: C-c C-e C-a
11207 Toggle asynchronous export. Asynchronous export uses an external
11208 Emacs process with a specially configured initialization file to
11209 complete the exporting process in the background thereby
11210 releasing the current interface. This is particularly useful
11211 when exporting long documents.
11213 Output from an asynchronous export is saved on the "the export
11214 stack". To view this stack, call the export dispatcher with
11215 a double {{{kbd(C-u)}}} prefix argument. If already in the
11216 export dispatcher menu, {{{kbd(&)}}} displays the stack.
11218 #+vindex: org-export-async-init-file
11219 To make the background export process the default, customize the
11220 variable, ~org-export-in-background~. Additionally, you can set
11221 the initialization file used by the background process with
11222 ~org-export-async-init-file~.
11224 #+vindex: org-export-in-background
11225 You can make asynchronous export the default by setting
11226 ~org-export-in-background~.
11228 - {{{kbd(C-b)}}} ::
11229 #+kindex: C-c C-e C-b
11231 Toggle body-only export. Useful for excluding headers and
11232 footers in the export. Affects only those back-end formats that
11233 have such sections---like =<head>...</head>= in HTML.
11235 - {{{kbd(C-s)}}} ::
11236 #+kindex: C-c C-e C-s
11238 Toggle sub-tree export. When turned on, Org exports only the
11239 sub-tree starting from the cursor position at the time the export
11240 dispatcher was invoked. Org uses the top heading of this
11241 sub-tree as the document's title. If the cursor is not on
11242 a heading, Org uses the nearest enclosing header. If the cursor
11243 is in the document preamble, Org signals an error and aborts
11246 #+vindex: org-export-initial-scope
11247 To make the sub-tree export the default, customize the variable
11248 ~org-export-initial-scope~.
11250 - {{{kbd(C-v)}}} ::
11251 #+kindex: C-c C-e C-v
11253 Toggle visible-only export. Useful for exporting only visible
11254 parts of an Org document by adjusting outline visibility
11259 :DESCRIPTION: Common export settings.
11261 #+cindex: options, for export
11262 #+cindex: Export, settings
11264 #+cindex: @samp{OPTIONS}, keyword
11265 Export options can be set: globally with variables; for an individual
11266 file by making variables buffer-local with in-buffer settings (see
11267 [[*Summary of In-Buffer Settings]]), by setting individual keywords, or by
11268 specifying them in a compact form with the =OPTIONS= keyword; or for
11269 a tree by setting properties (see [[*Properties and Columns]]). Options
11270 set at a specific level override options set at a more general level.
11272 #+cindex: SETUPFILE, keyword
11273 In-buffer settings may appear anywhere in the file, either directly or
11274 indirectly through a file included using =#+SETUPFILE: filename or
11275 URL= syntax. Option keyword sets tailored to a particular back-end
11276 can be inserted from the export dispatcher (see [[*The Export
11277 Dispatcher]]) using the =Insert template= command by pressing
11278 {{{kbd(#)}}}. To insert keywords individually, a good way to make
11279 sure the keyword is correct is to type =#+= and then to use
11280 {{{kbd(M-TAB)}}}[fn:16] for completion.
11282 The export keywords available for every back-end, and their equivalent
11283 global variables, include:
11287 #+cindex: @samp{AUTHOR}, keyword
11288 #+vindex: user-full-name
11289 The document author (~user-full-name~).
11293 #+cindex: @samp{CREATOR}, keyword
11294 #+vindex: org-expot-creator-string
11295 Entity responsible for output generation
11296 (~org-export-creator-string~).
11300 #+cindex: @samp{DATE}, keyword
11301 #+vindex: org-export-date-timestamp-format
11302 A date or a time-stamp[fn:116].
11306 #+cindex: @samp{EMAIL}, keyword
11307 #+vindex: user-mail-address
11308 The email address (~user-mail-address~).
11312 #+cindex: @samp{LANGUAGE}, keyword
11313 #+vindex: org-export-default-language
11314 Language to use for translating certain strings
11315 (~org-export-default-language~). With =#+LANGUAGE: fr=, for
11316 example, Org translates =Table of contents= to the French =Table
11321 #+cindex: @samp{SELECT_TAGS}, keyword
11322 #+vindex: org-export-select-tags
11323 The default value is ~("export")~. When a tree is tagged with
11324 =export= (~org-export-select-tags~), Org selects that tree and
11325 its sub-trees for export. Org excludes trees with =noexport=
11326 tags, see below. When selectively exporting files with =export=
11327 tags set, Org does not export any text that appears before the
11330 - =EXCLUDE_TAGS= ::
11332 #+cindex: @samp{EXCLUDE_TAGS}, keyword
11333 #+vindex: org-export-exclude-tags
11334 The default value is ~("noexport")~. When a tree is tagged with
11335 =noexport= (~org-export-exclude-tags~), Org excludes that tree
11336 and its sub-trees from export. Entries tagged with =noexport=
11337 are unconditionally excluded from the export, even if they have
11338 an =export= tag. Even if a sub-tree is not exported, Org
11339 executes any code blocks contained there.
11343 #+cindex: @samp{TITLE}, keyword
11344 #+cindex: document title
11345 Org displays this title. For long titles, use multiple =#+TITLE=
11348 - =EXPORT_FILE_NAME= ::
11350 #+cindex: @samp{EXPORT_FILE_NAME}, keyword
11351 The name of the output file to be generated. Otherwise, Org
11352 generates the file name based on the buffer name and the
11353 extension based on the back-end format.
11355 The =OPTIONS= keyword is a compact form. To configure multiple
11356 options, use several =OPTIONS= lines. =OPTIONS= recognizes the
11357 following arguments.
11361 #+vindex: org-export-with-smart-quotes
11362 Toggle smart quotes (~org-export-with-smart-quotes~). Depending
11363 on the language used, when activated, Org treats pairs of double
11364 quotes as primary quotes, pairs of single quotes as secondary
11365 quotes, and single quote marks as apostrophes.
11369 #+vindex: org-export-with-emphasize
11370 Toggle emphasized text (~org-export-with-emphasize~).
11374 #+vindex: org-export-with-special-strings
11375 Toggle conversion of special strings
11376 (~org-export-with-special-strings~).
11380 #+vindex: org-export-with-fixed-width
11381 Toggle fixed-width sections (~org-export-with-fixed-width~).
11385 #+vindex: org-export-with-timestamps
11386 Toggle inclusion of time/date active/inactive stamps
11387 (~org-export-with-timestamps~).
11391 #+vindex: org-export-preserve-breaks
11392 Toggles whether to preserve line breaks
11393 (~org-export-preserve-breaks~).
11397 #+vindex: org-export-with-sub-superscripts
11398 Toggle TeX-like syntax for sub- and superscripts. If you write
11399 =^:{}=, =a_{b}= is interpreted, but the simple =a_b= is left as
11400 it is (~org-export-with-sub-superscripts~).
11404 #+vindex: org-export-with-archived-trees
11405 Configure how archived trees are exported. When set to
11406 ~headline~, the export process skips the contents and processes
11407 only the headlines (~org-export-with-archived-trees~).
11411 #+vindex: org-export-with-author
11412 Toggle inclusion of author name into exported file
11413 (~org-export-with-author~).
11415 - ~broken-links~ ::
11417 #+vindex: org-export-with-broken-links
11418 Toggles if Org should continue exporting upon finding a broken
11419 internal link. When set to ~mark~, Org clearly marks the problem
11420 link in the output (~org-export-with-broken-links~).
11424 #+vindex: org-export-with-clocks
11425 Toggle inclusion of CLOCK keywords (~org-export-with-clocks~).
11429 #+vindex: org-export-with-creator
11430 Toggle inclusion of creator information in the exported file
11431 (~org-export-with-creator~).
11435 #+vindex: org-export-with-drawers
11436 Toggles inclusion of drawers, or list of drawers to include, or
11437 list of drawers to exclude (~org-export-with-drawers~).
11441 #+vindex: org-export-with-date
11442 Toggle inclusion of a date into exported file
11443 (~org-export-with-date~).
11447 #+vindex: org-export-with-entities
11448 Toggle inclusion of entities (~org-export-with-entities~).
11452 #+vindex: org-export-with-email
11453 Toggle inclusion of the author's e-mail into exported file
11454 (~org-export-with-email~).
11458 #+vindex: org-export-with-footnotes
11459 Toggle the inclusion of footnotes (~org-export-with-footnotes~).
11463 #+vindex: org-export-headline-levels
11464 Set the number of headline levels for export
11465 (~org-export-headline-levels~). Below that level, headlines are
11466 treated differently. In most back-ends, they become list items.
11470 #+vindex: org-export-with-inlinetasks
11471 Toggle inclusion of inlinetasks (~org-export-with-inlinetasks~).
11475 #+vindex: org-export-with-section-numbers
11476 #+cindex: @samp{UNNUMBERED}, property
11477 Toggle section-numbers (~org-export-with-section-numbers~). When
11478 set to number N, Org numbers only those headlines at level N or
11479 above. Set =UNNUMBERED= property to non-~nil~ to disable
11480 numbering of heading and subheadings entirely. Moreover, when
11481 the value is =notoc= the headline, and all its children, do not
11482 appear in the table of contents either (see [[*Table of Contents]]).
11486 #+vindex: org-export-with-planning
11487 Toggle export of planning information
11488 (~org-export-with-planning~). "Planning information" comes from
11489 lines located right after the headline and contain any
11490 combination of these cookies: =SCHEDULED=, =DEADLINE=, or
11495 #+vindex: org-export-with-priority
11496 Toggle inclusion of priority cookies
11497 (~org-export-with-priority~).
11501 #+vindex: org-export-with-properties
11502 Toggle inclusion of property drawers, or list the properties to
11503 include (~org-export-with-properties~).
11507 #+vindex: org-export-with-statistics-cookies
11508 Toggle inclusion of statistics cookies
11509 (~org-export-with-statistics-cookies~).
11513 #+vindex: org-export-with-tags
11514 Toggle inclusion of tags, may also be ~not-in-toc~
11515 (~org-export-with-tags~).
11519 #+vindex: org-export-with-tasks
11520 Toggle inclusion of tasks (TODO items); or ~nil~ to remove all
11521 tasks; or ~todo~ to remove DONE tasks; or list the keywords to
11522 keep (~org-export-with-tasks~).
11526 #+vindex: org-export-with-latex
11527 ~nil~ does not export; ~t~ exports; ~verbatim~ keeps everything
11528 in verbatim (~org-export-with-latex~).
11532 #+vindex: org-export-time-stamp-file
11533 Toggle inclusion of the creation time in the exported file
11534 (~org-export-time-stamp-file~).
11538 #+vindex: org-export-with-title
11539 Toggle inclusion of title (~org-export-with-title~).
11543 #+vindex: org-export-with-toc
11544 Toggle inclusion of the table of contents, or set the level limit
11545 (~org-export-with-toc~).
11549 #+vindex: org-export-with-todo-keywords
11550 Toggle inclusion of TODO keywords into exported text
11551 (~org-export-with-todo-keywords~).
11555 #+vindex: org-export-with-tables
11556 Toggle inclusion of tables (~org-export-with-tables~).
11558 When exporting sub-trees, special node properties in them can override
11559 the above keywords. They are special because they have an =EXPORT_=
11560 prefix. For example, =DATE= and =EXPORT_FILE_NAME= keywords become,
11561 respectively, =EXPORT_DATE= and =EXPORT_FILE_NAME=. Except for
11562 =SETUPFILE=, all other keywords listed above have an =EXPORT_=
11565 #+cindex: @samp{BIND}, keyword
11566 #+vindex: org-export-allow-bind-keywords
11567 If ~org-export-allow-bind-keywords~ is non-~nil~, Emacs variables can
11568 become buffer-local during export by using the =BIND= keyword. Its
11569 syntax is =#+BIND: variable value=. This is particularly useful for
11570 in-buffer settings that cannot be changed using keywords.
11572 ** Table of Contents
11574 :DESCRIPTION: The if and where of the table of contents.
11576 #+cindex: table of contents
11577 #+cindex: list of tables
11578 #+cindex: list of listings
11580 #+cindex: @samp{toc}, in @samp{OPTIONS} keyword
11581 #+vindex: org-export-with-toc
11582 The table of contents includes all headlines in the document. Its
11583 depth is therefore the same as the headline levels in the file. If
11584 you need to use a different depth, or turn it off entirely, set the
11585 ~org-export-with-toc~ variable accordingly. You can achieve the same
11586 on a per file basis, using the following =toc= item in =OPTIONS=
11590 ,#+OPTIONS: toc:2 (only include two levels in TOC)
11591 ,#+OPTIONS: toc:nil (no default TOC at all)
11594 #+cindex: excluding entries from table of contents
11595 #+cindex: table of contents, exclude entries
11596 Org includes both numbered and unnumbered headlines in the table of
11597 contents[fn:117]. If you need to exclude an unnumbered headline,
11598 along with all its children, set the =UNNUMBERED= property to =notoc=
11602 ,* Subtree not numbered, not in table of contents either
11608 #+cindex: @samp{TOC}, keyword
11609 Org normally inserts the table of contents directly before the first
11610 headline of the file. To move the table of contents to a different
11611 location, first turn off the default with ~org-export-with-toc~
11612 variable or with =#+OPTIONS: toc:nil=. Then insert =#+TOC: headlines
11613 N= at the desired location(s).
11616 ,#+OPTIONS: toc:nil
11618 ,#+TOC: headlines 2
11621 To adjust the table of contents depth for a specific section of the
11622 Org document, append an additional =local= parameter. This parameter
11623 becomes a relative depth for the current level. The following example
11624 inserts a local table of contents, with direct children only.
11628 ,#+TOC: headlines 1 local
11631 Note that for this feature to work properly in LaTeX export, the Org
11632 file requires the inclusion of the titletoc package. Because of
11633 compatibility issues, titletoc has to be loaded /before/ hyperref.
11634 Customize the ~org-latex-default-packages-alist~ variable.
11636 Use the =TOC= keyword to generate list of tables---respectively, all
11637 listings---with captions.
11644 #+cindex: @samp{ALT_TITLE}, property
11645 Normally Org uses the headline for its entry in the table of contents.
11646 But with =ALT_TITLE= property, a different entry can be specified for
11647 the table of contents.
11651 :DESCRIPTION: Include additional files into a document.
11653 #+cindex: include files, during export
11654 #+cindex: Export, include files
11655 #+cindex: @samp{INCLUDE}, keyword
11657 During export, you can include the content of another file. For
11658 example, to include your =.emacs= file, you could use:
11660 : #+INCLUDE: "~/.emacs" src emacs-lisp
11662 #+texinfo: @noindent
11663 The optional second and third parameter are the markup (e.g., =quote=,
11664 =example=, or =src=), and, if the markup is =src=, the language for
11665 formatting the contents. The markup is optional; if it is not given,
11666 assume text is in Org syntax and process it normally. The =INCLUDE=
11667 keyword also allows additional parameters =:prefix1= and =:prefix= to
11668 specify prefixes for the first line and for each following line,
11669 =:minlevel= in order to get Org mode content demoted to a specified
11670 level, as well as any options accepted by the selected markup. For
11671 example, to include a file as an item, use:
11673 : #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
11675 You can also include a portion of a file by specifying a lines range
11676 using the =:lines= parameter. The line at the upper end of the range
11677 is not included. The start and/or the end of the range may be omitted
11678 to use the obvious defaults.
11680 - =#+INCLUDE: "~/.emacs" :lines "5-10"= ::
11682 Include lines 5 to 10, 10 excluded.
11684 - =#+INCLUDE: "~/.emacs" :lines "-10"= ::
11686 Include lines 1 to 10, 10 excluded.
11688 - =#+INCLUDE: "~/.emacs" :lines "10-"= ::
11690 Include lines from 10 to EOF.
11692 You can visit the file being included with the following command.
11694 - {{{kbd(C-c ')}}} (~org-edit~special~) ::
11696 #+findex: org-edit-special
11698 Visit the include file at point.
11700 ** Macro Replacement
11702 :DESCRIPTION: Use macros to create templates.
11704 #+cindex: macro replacement, during export
11705 #+cindex: @samp{MACRO}, keyword
11707 #+vindex: org-export-global-macros
11708 Macros replace text snippets during export. Macros are defined
11709 globally in ~org-export-global-macros~, or document-wise with the
11712 : #+MACRO: name replacement text; $1, $2 are arguments
11714 #+texinfo: @noindent
11715 which can be referenced using ={{{name(arg1, arg2)}}}=[fn:118]. For
11719 ,#+MACRO: poem The rose is $1, The violet's $2. Life's ordered: Org assists you.
11720 {{{poem(red,blue)}}}
11723 #+texinfo: @noindent
11726 : The rose is red, The violet's blue. Life's ordered: Org assists you.
11728 As a special case, Org parses any replacement text starting with
11729 =(eval= as an Emacs Lisp expression and evaluates it accordingly.
11730 Within such templates, arguments become strings. Thus, the following
11733 : #+MACRO: gnucheck (eval (concat "GNU/" (capitalize $1)))
11735 #+texinfo: @noindent
11736 turns ={{{gnucheck(linux)}}}= into =GNU/Linux= during export.
11738 Org recognizes macro references in following Org markup areas:
11739 paragraphs, headlines, verse blocks, tables cells and lists. Org also
11740 recognizes macro references in keywords, such as =CAPTION=, =TITLE=,
11741 =AUTHOR=, =DATE=, and for some back-end specific export options.
11743 Org comes with following pre-defined macros:
11745 #+attr_texinfo: :sep ;
11746 - ={{{keyword(NAME)}}}=; ={{{title}}}=; ={{{author}}}=; ={{{email}}}= ::
11748 #+cindex: @samp{keyword}, macro
11749 #+cindex: @samp{title}, macro
11750 #+cindex: @samp{author}, macro
11751 #+cindex: @samp{email}, macro
11752 The =keyword= macro collects all values from {{{var(NAME)}}}
11753 keywords throughout the buffer, separated with white space.
11754 =title=, =author= and =email= macros are shortcuts for,
11755 respectively, ={{{keyword(TITLE)}}}=, ={{{keyword(AUTHOR)}}}= and
11756 ={{{keyword(EMAIL)}}}=.
11758 - ={{{date}}}=; ={{{date(FORMAT)}}}= ::
11760 #+cindex: @samp{date}, macro
11761 This macro refers to the =DATE= keyword. {{{var(FORMAT)}}} is an
11762 optional argument to the =date= macro that is used only if =DATE=
11763 is a single timestamp. {{{var(FORMAT)}}} should be a format
11764 string understood by ~format-time-string~.
11766 - ={{{time(FORMAT)}}}=; ={{{modification-time(FORMAT, VC)}}}= ::
11768 #+cindex: @samp{time}, macro
11769 #+cindex: @samp{modification-time}, macro
11770 These macros refer to the document's date and time of export and
11771 date and time of modification. {{{var(FORMAT)}}} is a string
11772 understood by ~format-time-string~. If the second argument to
11773 the ~modification-time~ macro is non-~nil~, Org uses =vc.el= to
11774 retrieve the document's modification time from the version
11775 control system. Otherwise Org reads the file attributes.
11777 - ={{{input-file}}}= ::
11779 #+cindex: @samp{input-file}, macro
11780 This macro refers to the filename of the exported file.
11782 - ={{{property(PROPERTY-NAME)}}}=; ={{{property(PROPERTY-NAME, SEARCH OPTION)}}}= ::
11784 #+cindex: @samp{property}, macro
11785 This macro returns the value of property {{{var(PROPERTY-NAME)}}}
11786 in the current entry. If {{{var(SEARCH-OPTION)}}} (see [[*Search
11787 Options in File Links]]) refers to a remote entry, use it instead.
11789 - ={{{n}}}=; ={{{n(NAME)}}}=; ={{{n(NAME, ACTION)}}}= ::
11791 #+cindex: @samp{n}, macro
11792 #+cindex: counter, macro
11793 This macro implements custom counters by returning the number of
11794 times the macro has been expanded so far while exporting the
11795 buffer. You can create more than one counter using different
11796 {{{var(NAME)}}} values. If {{{var(ACTION)}}} is =-=, previous
11797 value of the counter is held, i.e., the specified counter is not
11798 incremented. If the value is a number, the specified counter is
11799 set to that value. If it is any other non-empty string, the
11800 specified counter is reset to 1. You may leave {{{var(NAME)}}}
11801 empty to reset the default counter.
11803 #+cindex: @samp{results}, macro
11804 Moreover, inline source blocks (see [[*Structure of Code Blocks]]) use the
11805 special =results= macro to mark their output. As such, you are
11806 advised against re-defining it, unless you know what you are doing.
11808 #+vindex: org-hide-macro-markers
11809 The surrounding brackets can be made invisible by setting
11810 ~org-hide-macro-markers~ to a non-~nil~ value.
11812 Org expands macros at the very beginning of the export process.
11816 :DESCRIPTION: What will not be exported.
11818 #+cindex: exporting, not
11820 #+cindex: comment lines
11821 Lines starting with zero or more whitespace characters followed by one
11822 =#= and a whitespace are treated as comments and, as such, are not
11825 #+cindex: @samp{BEGIN_COMMENT}
11826 #+cindex: comment block
11827 Likewise, regions surrounded by =#+BEGIN_COMMENT= ... =#+END_COMMENT=
11830 #+cindex: comment trees
11831 Finally, a =COMMENT= keyword at the beginning of an entry, but after
11832 any other keyword or priority cookie, comments out the entire subtree.
11833 In this case, the subtree is not exported and no code block within it
11834 is executed either[fn:119]. The command below helps changing the
11835 comment status of a headline.
11837 - {{{kbd(C-c ;)}}} (~org-toggle-comment~) ::
11839 #+findex: org-toggle-comment
11841 Toggle the =COMMENT= keyword at the beginning of an entry.
11843 ** ASCII/Latin-1/UTF-8 export
11845 :DESCRIPTION: Exporting to flat files with encoding.
11847 #+cindex: ASCII export
11848 #+cindex: Latin-1 export
11849 #+cindex: UTF-8 export
11851 ASCII export produces an output file containing only plain ASCII
11852 characters. This is the simplest and most direct text output. It
11853 does not contain any Org markup. Latin-1 and UTF-8 export use
11854 additional characters and symbols available in these encoding
11855 standards. All three of these export formats offer the most basic of
11856 text output for maximum portability.
11858 #+vindex: org-ascii-text-width
11859 On export, Org fills and justifies text according to the text width
11860 set in ~org-ascii-text-width~.
11862 #+vindex: org-ascii-links-to-notes
11863 Org exports links using a footnote-like style where the descriptive
11864 part is in the text and the link is in a note before the next heading.
11865 See the variable ~org-ascii-links-to-notes~ for details.
11867 *** ASCII export commands
11872 #+attr_texinfo: :sep ,
11873 - {{{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)}}} ::
11874 #+kindex: C-c C-e t a
11875 #+kindex: C-c C-e t l
11876 #+kindex: C-c C-e t u
11877 #+findex: org-ascii-export-to-ascii
11879 Export as an ASCII file with a =.txt= extension. For
11880 =myfile.org=, Org exports to =myfile.txt=, overwriting without
11881 warning. For =myfile.txt=, Org exports to =myfile.txt.txt= in
11882 order to prevent data loss.
11884 #+attr_texinfo: :sep ,
11885 - {{{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)}}} ::
11886 #+kindex: C-c C-e t A
11887 #+kindex: C-c C-e t L
11888 #+kindex: C-c C-e t U
11889 #+findex: org-ascii-export-to-ascii
11891 Export to a temporary buffer. Does not create a file.
11893 *** ASCII specific export settings
11898 The ASCII export back-end has one extra keyword for customizing ASCII
11899 output. Setting this keyword works similar to the general options
11900 (see [[*Export Settings]]).
11904 #+cindex: @samp{SUBTITLE}, keyword
11905 The document subtitle. For long subtitles, use multiple
11906 =#+SUBTITLE= lines in the Org file. Org prints them on one
11907 continuous line, wrapping into multiple lines if necessary.
11909 *** Header and sectioning structure
11914 Org converts the first three outline levels into headlines for ASCII
11915 export. The remaining levels are turned into lists. To change this
11916 cut-off point where levels become lists, see [[*Export Settings]].
11918 *** Quoting ASCII text
11923 To insert text within the Org file by the ASCII back-end, use one the
11924 following constructs, inline, keyword, or export block:
11926 #+cindex: @samp{ASCII}, keyword
11927 #+cindex: @samp{BEGIN_EXPORT ascii}
11929 Inline text @@ascii:and additional text@@ within a paragraph.
11931 ,#+ASCII: Some text
11933 ,#+BEGIN_EXPORT ascii
11934 Org exports text in this block only when using ASCII back-end.
11938 *** ASCII specific attributes
11942 #+cindex: @samp{ATTR_ASCII}, keyword
11943 #+cindex: horizontal rules, in ASCII export
11945 ASCII back-end recognizes only one attribute, ~:width~, which
11946 specifies the width of an horizontal rule in number of characters.
11947 The keyword and syntax for specifying widths is:
11950 ,#+ATTR_ASCII: :width 10
11954 *** ASCII special blocks
11958 #+cindex: special blocks, in ASCII export
11959 #+cindex: @samp{BEGIN_JUSTIFYLEFT}
11960 #+cindex: @samp{BEGIN_JUSTIFYRIGHT}
11962 Besides =#+BEGIN_CENTER= blocks (see [[*Paragraphs]]), ASCII back-end has
11963 these two left and right justification blocks:
11966 ,#+BEGIN_JUSTIFYLEFT
11967 It's just a jump to the left...
11970 ,#+BEGIN_JUSTIFYRIGHT
11971 ...and then a step to the right.
11972 ,#+END_JUSTIFYRIGHT
11976 #+cindex: Beamer export
11978 Org uses Beamer export to convert an Org file tree structure into
11979 high-quality interactive slides for presentations. Beamer is a LaTeX
11980 document class for creating presentations in PDF, HTML, and other
11981 popular display formats.
11983 *** Beamer export commands
11985 :DESCRIPTION: For creating Beamer documents.
11988 - {{{kbd(C-c C-e l b)}}} (~org-beamer-export-to-latex~) ::
11989 #+kindex: C-c C-e l b
11990 #+findex: org-beamer-export-to-latex
11992 Export as LaTeX file with a =.tex= extension. For =myfile.org=,
11993 Org exports to =myfile.tex=, overwriting without warning.
11995 - {{{kbd(C-c C-e l B)}}} (~org-beamer-export-as-latex~) ::
11996 #+kindex: C-c C-e l B
11997 #+findex: org-beamer-export-as-latex
11999 Export to a temporary buffer. Does not create a file.
12001 - {{{kbd(C-c C-e l P)}}} (~org-beamer-export-to-pdf~) ::
12002 #+kindex: C-c C-e l P
12003 #+findex: org-beamer-export-to-pdf
12005 Export as LaTeX file and then convert it to PDF format.
12007 - {{{kbd(C-c C-e l O)}}} ::
12008 #+kindex: C-c C-e l O
12010 Export as LaTeX file, convert it to PDF format, and then open the
12013 *** Beamer specific export settings
12015 :DESCRIPTION: For customizing Beamer export.
12018 Beamer export back-end has several additional keywords for customizing
12019 Beamer output. These keywords work similar to the general options
12020 settings (see [[*Export Settings]]).
12022 - =BEAMER_THEME= ::
12024 #+cindex: @samp{BEAMER_THEME}, keyword
12025 #+vindex: org-beamer-theme
12026 The Beamer layout theme (~org-beamer-theme~). Use square
12027 brackets for options. For example:
12029 : #+BEAMER_THEME: Rochester [height=20pt]
12031 - =BEAMER_FONT_THEME= ::
12033 #+cindex: @samp{BEAMER_FONT_THEME}, keyword
12034 The Beamer font theme.
12036 - =BEAMER_INNER_THEME= ::
12038 #+cindex: @samp{BEAMER_INNER_THEME}, keyword
12039 The Beamer inner theme.
12041 - =BEAMER_OUTER_THEME= ::
12043 #+cindex: @samp{BEAMER_OUTER_THEME}, keyword
12044 The Beamer outer theme.
12046 - =BEAMER_HEADER= ::
12048 #+cindex: @samp{BEAMER_HEADER}, keyword
12049 Arbitrary lines inserted in the preamble, just before the
12050 =hyperref= settings.
12054 #+cindex: @samp{DESCRIPTION}, keyword
12055 The document description. For long descriptions, use multiple
12056 =DESCRIPTION= keywords. By default, =hyperref= inserts
12057 =DESCRIPTION= as metadata. Use ~org-latex-hyperref-template~ to
12058 configure document metadata. Use ~org-latex-title-command~ to
12059 configure typesetting of description as part of front matter.
12063 #+cindex: @samp{KEYWORDS}, keyword
12064 The keywords for defining the contents of the document. Use
12065 multiple =KEYWORDS= lines if necessary. By default, =hyperref=
12066 inserts =KEYWORDS= as metadata. Use
12067 ~org-latex-hyperref-template~ to configure document metadata.
12068 Use ~org-latex-title-command~ to configure typesetting of
12069 keywords as part of front matter.
12073 #+cindex: @samp{SUBTITLE}, keyword
12074 Document's subtitle. For typesetting, use
12075 ~org-beamer-subtitle-format~ string. Use
12076 ~org-latex-hyperref-template~ to configure document metadata.
12077 Use ~org-latex-title-command~ to configure typesetting of
12078 subtitle as part of front matter.
12080 *** Frames and Blocks in Beamer
12082 :DESCRIPTION: For composing Beamer slides.
12085 Org transforms heading levels into Beamer's sectioning elements,
12086 frames and blocks. Any Org tree with a not-too-deep-level nesting
12087 should in principle be exportable as a Beamer presentation.
12090 #+vindex: org-beamer-frame-level
12091 Org headlines become Beamer frames when the heading level in Org is
12092 equal to ~org-beamer-frame-level~ or =H= value in a =OPTIONS= line
12093 (see [[*Export Settings]]).
12095 #+cindex: @samp{BEAMER_ENV}, property
12096 Org overrides headlines to frames conversion for the current tree of
12097 an Org file if it encounters the =BEAMER_ENV= property set to
12098 =frame= or =fullframe=. Org ignores whatever
12099 ~org-beamer-frame-level~ happens to be for that headline level in
12100 the Org tree. In Beamer terminology, a full frame is a frame
12103 - Org exports a Beamer frame's objects as block environments. Org can
12104 enforce wrapping in special block types when =BEAMER_ENV= property
12105 is set[fn:120]. For valid values see
12106 ~org-beamer-environments-default~. To add more values, see
12107 ~org-beamer-environments-extra~.
12108 #+vindex: org-beamer-environments-default
12109 #+vindex: org-beamer-environments-extra
12112 #+cindex: @samp{BEAMER_REF}, property
12113 If =BEAMER_ENV= is set to =appendix=, Org exports the entry as an
12114 appendix. When set to =note=, Org exports the entry as a note
12115 within the frame or between frames, depending on the entry's heading
12116 level. When set to =noteNH=, Org exports the entry as a note
12117 without its title. When set to =againframe=, Org exports the entry
12118 with =\againframe= command, which makes setting the =BEAMER_REF=
12119 property mandatory because =\againframe= needs frame to resume.
12121 When =ignoreheading= is set, Org export ignores the entry's headline
12122 but not its content. This is useful for inserting content between
12123 frames. It is also useful for properly closing a =column=
12124 environment. @end itemize
12126 #+cindex: @samp{BEAMER_ACT}, property
12127 #+cindex: @samp{BEAMER_OPT}, property
12128 When =BEAMER_ACT= is set for a headline, Org export translates that
12129 headline as an overlay or action specification. When enclosed in
12130 square brackets, Org export makes the overlay specification
12131 a default. Use =BEAMER_OPT= to set any options applicable to the
12132 current Beamer frame or block. The Beamer export back-end wraps
12133 with appropriate angular or square brackets. It also adds the
12134 =fragile= option for any code that may require a verbatim block.
12136 #+cindex: @samp{BEAMER_COL}, property
12137 To create a column on the Beamer slide, use the =BEAMER_COL=
12138 property for its headline in the Org file. Set the value of
12139 =BEAMER_COL= to a decimal number representing the fraction of the
12140 total text width. Beamer export uses this value to set the column's
12141 width and fills the column with the contents of the Org entry. If
12142 the Org entry has no specific environment defined, Beamer export
12143 ignores the heading. If the Org entry has a defined environment,
12144 Beamer export uses the heading as title. Behind the scenes, Beamer
12145 export automatically handles LaTeX column separations for contiguous
12146 headlines. To manually adjust them for any unique configurations
12147 needs, use the =BEAMER_ENV= property.
12149 *** Beamer specific syntax
12151 :DESCRIPTION: For using in Org documents.
12154 Since Org's Beamer export back-end is an extension of the LaTeX
12155 back-end, it recognizes other LaTeX specific syntax---for example,
12156 =#+LATEX:= or =#+ATTR_LATEX:=. See [[*LaTeX Export]], for details.
12158 Beamer export wraps the table of contents generated with =toc:t=
12159 =OPTION= keyword in a =frame= environment. Beamer export does not
12160 wrap the table of contents generated with =TOC= keyword (see [[*Table of
12161 Contents]]). Use square brackets for specifying options.
12163 : #+TOC: headlines [currentsection]
12165 Insert Beamer-specific code using the following constructs:
12167 #+cindex: @samp{BEAMER}, keyword
12168 #+cindex: @samp{BEGIN_EXPORT beamer}
12172 ,#+BEGIN_EXPORT beamer
12173 Only Beamer export back-end exports this.
12176 Text @@beamer:some code@@ within a paragraph.
12179 Inline constructs, such as the last one above, are useful for adding
12180 overlay specifications to objects with ~bold~, ~item~, ~link~,
12181 ~radio-target~ and ~target~ types. Enclose the value in angular
12182 brackets and place the specification at the beginning of the object as
12183 shown in this example:
12185 : A *@@beamer:<2->@@useful* feature
12187 #+cindex: @samp{ATTR_BEAMER}, keyword
12188 Beamer export recognizes the =ATTR_BEAMER= keyword with the following
12189 attributes from Beamer configurations: =:environment= for changing
12190 local Beamer environment, =:overlay= for specifying Beamer overlays in
12191 angular or square brackets, and =:options= for inserting optional
12195 ,#+ATTR_BEAMER: :environment nonindentlist
12196 - item 1, not indented
12197 - item 2, not indented
12198 - item 3, not indented
12202 ,#+ATTR_BEAMER: :overlay <+->
12208 ,#+ATTR_BEAMER: :options [Lagrange]
12209 Let $G$ be a finite group, and let $H$ be
12210 a subgroup of $G$. Then the order of $H$ divides the order of $G$.
12213 *** Editing support
12215 :DESCRIPTION: Editing support.
12218 The ~org-beamer-mode~ is a special minor mode for faster editing of
12221 : #+STARTUP: beamer
12223 - {{{kbd(C-c C-b)}}} (~org-beamer-select-environment~) ::
12225 #+findex: org-beamer-select-environment
12227 The ~org-beamer-mode~ provides this key for quicker selections in
12228 Beamer normal environments, and for selecting the =BEAMER_COL=
12231 *** A Beamer example
12233 :DESCRIPTION: A complete presentation.
12236 Here is an example of an Org document ready for Beamer export.
12239 ;#+TITLE: Example Presentation
12240 ;#+AUTHOR: Carsten Dominik
12241 ;#+OPTIONS: H:2 toc:t num:t
12242 ;#+LATEX_CLASS: beamer
12243 ;#+LATEX_CLASS_OPTIONS: [presentation]
12244 ;#+BEAMER_THEME: Madrid
12245 ;#+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
12247 ,* This is the first structural section
12250 ,*** Thanks to Eric Fraga :B_block:
12255 for the first viable Beamer setup in Org
12256 ,*** Thanks to everyone else :B_block:
12262 for contributing to the discussion
12263 ,**** This will be formatted as a beamer note :B_note:
12267 ,** Frame 2 (where we will not use columns)
12269 Please test this stuff!
12274 :DESCRIPTION: Exporting to HTML.
12276 #+cindex: HTML export
12278 Org mode contains an HTML exporter with extensive HTML formatting
12279 compatible with XHTML 1.0 strict standard.
12281 *** HTML export commands
12283 :DESCRIPTION: Invoking HTML export.
12286 - {{{kbd(C-c C-e h h)}}} (~org-html-export-to-html~) ::
12287 #+kindex: C-c C-e h h
12288 #+kindex: C-c C-e h o
12289 #+findex: org-html-export-to-html
12291 Export as HTML file with a =.html= extension. For =myfile.org=,
12292 Org exports to =myfile.html=, overwriting without warning.
12293 {{{kbd{C-c C-e h o)}}} exports to HTML and opens it in a web
12296 - {{{kbd(C-c C-e h H)}}} (~org-html-export-as-html~) ::
12297 #+kindex: C-c C-e h H
12298 #+findex: org-html-export-as-html
12300 Exports to a temporary buffer. Does not create a file.
12302 *** HTML specific export settings
12304 :DESCRIPTION: Settings for HTML export.
12307 HTML export has a number of keywords, similar to the general options
12308 settings described in [[*Export Settings]].
12312 #+cindex: @samp{DESCRIPTION}, keyword
12313 This is the document's description, which the HTML exporter
12314 inserts it as a HTML meta tag in the HTML file. For long
12315 descriptions, use multiple =DESCRIPTION= lines. The exporter
12316 takes care of wrapping the lines properly.
12318 - =HTML_DOCTYPE= ::
12320 #+cindex: @samp{HTML_DOCTYPE}, keyword
12321 #+vindex: org-html-doctype
12322 Specify the document type, for example: HTML5
12323 (~org-html-doctype~).
12325 - =HTML_CONTAINER= ::
12327 #+cindex: @samp{HTML_CONTAINER}, keyword
12328 #+vindex: org-html-container-element
12329 Specify the HTML container, such as =div=, for wrapping sections
12330 and elements (~org-html-container-element~).
12332 - =HTML_LINK_HOME= ::
12334 #+cindex: @samp{HTML_LINK_HOME}, keyword
12335 #+vindex: org-html-link-home
12336 The URL for home link (~org-html-link-home~).
12338 - =HTML_LINK_UP= ::
12340 #+cindex: @samp{HTML_LINK_UP}, keyword
12341 #+vindex: org-html-link-up
12342 The URL for the up link of exported HTML pages
12343 (~org-html-link-up~).
12345 - =HTML_MATHJAX= ::
12347 #+cindex: @samp{HTML_MATHJAX}, keyword
12348 #+vindex: org-html-mathjax-options
12349 Options for MathJax (~org-html-mathjax-options~). MathJax is
12350 used to typeset LaTeX math in HTML documents. See [[*Math
12351 formatting in HTML export]], for an example.
12355 #+cindex: @samp{HTML_HEAD}, keyword
12356 #+vindex: org-html-head
12357 Arbitrary lines for appending to the HTML document's head
12360 - =HTML_HEAD_EXTRA= ::
12362 #+cindex: @samp{HTML_HEAD_EXTRA}, keyword
12363 #+vindex: org-html-head-extra
12364 More arbitrary lines for appending to the HTML document's head
12365 (~org-html-head-extra~).
12369 #+cindex: @samp{KEYWORDS}, keyword
12370 Keywords to describe the document's content. HTML exporter
12371 inserts these keywords as HTML meta tags. For long keywords, use
12372 multiple =KEYWORDS= lines.
12374 - =LATEX_HEADER= ::
12376 #+cindex: @samp{LATEX_HEADER}, keyword
12377 Arbitrary lines for appending to the preamble; HTML exporter
12378 appends when transcoding LaTeX fragments to images (see [[*Math
12379 formatting in HTML export]]).
12383 #+cindex: @samp{SUBTITLE}, keyword
12384 The document's subtitle. HTML exporter formats subtitle if
12385 document type is =HTML5= and the CSS has a =subtitle= class.
12387 Some of these keywords are explained in more detail in the following
12388 sections of the manual.
12392 :DESCRIPTION: Exporting various (X)HTML flavors.
12395 Org can export to various (X)HTML flavors.
12397 #+vindex: org-html-doctype
12398 #+vindex: org-html-doctype-alist
12399 Set the ~org-html-doctype~ variable for different (X)HTML variants.
12400 Depending on the variant, the HTML exporter adjusts the syntax of HTML
12401 conversion accordingly. Org includes the following ready-made
12405 - ~"html4-transitional"~
12406 - ~"html4-frameset"~
12408 - ~"xhtml-transitional"~
12409 - ~"xhtml-frameset"~
12414 #+texinfo: @noindent
12415 See the variable ~org-html-doctype-alist~ for details. The default is
12418 #+vindex: org-html-html5-fancy
12419 #+cindex: @samp{HTML5}, export new elements
12420 Org's HTML exporter does not by default enable new block elements
12421 introduced with the HTML5 standard. To enable them, set
12422 ~org-html-html5-fancy~ to non-~nil~. Or use an =OPTIONS= line in the
12423 file to set =html5-fancy=.
12425 HTML5 documents can now have arbitrary =#+BEGIN= ... =#+END= blocks.
12434 #+texinfo: @noindent
12443 #+texinfo: @noindent
12447 ,#+ATTR_HTML: :controls controls :width 350
12449 ,#+HTML: <source src="movie.mp4" type="video/mp4">
12450 ,#+HTML: <source src="movie.ogg" type="video/ogg">
12451 Your browser does not support the video tag.
12455 #+texinfo: @noindent
12459 <video controls="controls" width="350">
12460 <source src="movie.mp4" type="video/mp4">
12461 <source src="movie.ogg" type="video/ogg">
12462 <p>Your browser does not support the video tag.</p>
12466 #+vindex: org-html-html5-elements
12467 When special blocks do not have a corresponding HTML5 element, the
12468 HTML exporter reverts to standard translation (see
12469 ~org-html-html5-elements~). For example, =#+BEGIN_lederhosen= exports
12470 to ~<div class="lederhosen">~.
12472 Special blocks cannot have headlines. For the HTML exporter to wrap
12473 the headline and its contents in ~<section>~ or ~<article>~ tags, set
12474 the =HTML_CONTAINER= property for the headline.
12476 *** HTML preamble and postamble
12478 :DESCRIPTION: Inserting preamble and postamble.
12480 #+vindex: org-html-preamble
12481 #+vindex: org-html-postamble
12482 #+vindex: org-html-preamble-format
12483 #+vindex: org-html-postamble-format
12484 #+vindex: org-html-validation-link
12485 #+vindex: org-export-creator-string
12486 #+vindex: org-export-time-stamp-file
12488 The HTML exporter has delineations for preamble and postamble. The
12489 default value for ~org-html-preamble~ is ~t~, which makes the HTML
12490 exporter insert the preamble. See the variable
12491 ~org-html-preamble-format~ for the format string.
12493 Set ~org-html-preamble~ to a string to override the default format
12494 string. If the string is a function, the HTML exporter expects the
12495 function to return a string upon execution. The HTML exporter inserts
12496 this string in the preamble. The HTML exporter does not insert
12497 a preamble if ~org-html-preamble~ is set ~nil~.
12499 The default value for ~org-html-postamble~ is ~auto~, which makes the
12500 HTML exporter build a postamble from looking up author's name, email
12501 address, creator's name, and date. Set ~org-html-postamble~ to ~t~ to
12502 insert the postamble in the format specified in the
12503 ~org-html-postamble-format~ variable. The HTML exporter does not
12504 insert a postamble if ~org-html-postamble~ is set to ~nil~.
12506 *** Quoting HTML tags
12508 :DESCRIPTION: Using direct HTML in Org files.
12511 The HTML export back-end transforms =<= and =>= to =<= and =>=.
12513 To include raw HTML code in the Org file so the HTML export back-end
12514 can insert that HTML code in the output, use this inline syntax:
12515 =@@html:...@@=. For example:
12517 : @@html:<b>@@bold text@@html:</b>@@
12519 #+cindex: @samp{HTML}, keyword
12520 #+cindex: @samp{BEGIN_EXPORT html}
12521 For larger raw HTML code blocks, use these HTML export code blocks:
12524 ,#+HTML: Literal HTML code for export
12526 ,#+BEGIN_EXPORT html
12527 All lines between these markers are exported literally
12531 *** Links in HTML export
12533 :DESCRIPTION: Inserting and formatting links.
12535 #+cindex: links, in HTML export
12536 #+cindex: internal links, in HTML export
12537 #+cindex: external links, in HTML export
12539 The HTML export back-end transforms Org's internal links (see
12540 [[*Internal Links]]) to equivalent HTML links in the output. The back-end
12541 similarly handles Org's automatic links created by radio targets (see
12542 [[*Radio Targets]]) similarly. For Org links to external files, the
12543 back-end transforms the links to /relative/ paths.
12545 #+vindex: org-html-link-org-files-as-html
12546 For Org links to other =.org= files, the back-end automatically
12547 changes the file extension to =.html= and makes file paths relative.
12548 If the =.org= files have an equivalent =.html= version at the same
12549 location, then the converted links should work without any further
12550 manual intervention. However, to disable this automatic path
12551 translation, set ~org-html-link-org-files-as-html~ to ~nil~. When
12552 disabled, the HTML export back-end substitutes the ID-based links in
12553 the HTML output. For more about linking files when publishing to
12554 a directory, see [[*Publishing links]].
12556 Org files can also have special directives to the HTML export
12557 back-end. For example, by using =#+ATTR_HTML= lines to specify new
12558 format attributes to ~<a>~ or ~<img>~ tags. This example shows
12559 changing the link's title and style:
12561 #+cindex: @samp{ATTR_HTML}, keyword
12563 ,#+ATTR_HTML: :title The Org mode homepage :style color:red;
12564 [[https://orgmode.org]]
12567 *** Tables in HTML export
12569 :DESCRIPTION: How to modify the formatting of tables.
12571 #+cindex: tables, in HTML
12572 #+vindex: org-export-html-table-tag
12574 The HTML export back-end uses ~org-html-table-default-attributes~ when
12575 exporting Org tables to HTML. By default, the exporter does not draw
12576 frames and cell borders. To change for this for a table, use the
12577 following lines before the table in the Org file:
12579 #+cindex: @samp{CAPTION}, keyword
12580 #+cindex: @samp{ATTR_HTML}, keyword
12582 ,#+CAPTION: This is a table with lines around and between cells
12583 ,#+ATTR_HTML: border="2" rules="all" frame="border"
12586 The HTML export back-end preserves column groupings in Org tables (see
12587 [[*Column Groups]]) when exporting to HTML.
12589 Additional options for customizing tables for HTML export.
12591 - ~org-html-table-align-individual-fields~ ::
12593 #+vindex: org-html-table-align-individual-fields
12594 Non-~nil~ attaches style attributes for alignment to each table
12597 - ~org-html-table-caption-above~ ::
12599 #+vindex: org-html-table-caption-above
12600 Non-~nil~ places caption string at the beginning of the table.
12602 - ~org-html-table-data-tags~ ::
12604 #+vindex: org-html-table-data-tags
12605 Opening and ending tags for table data fields.
12607 - ~org-html-table-default-attributes~ ::
12609 #+vindex: org-html-table-default-attributes
12610 Default attributes and values for table tags.
12612 - ~org-html-table-header-tags~ ::
12614 #+vindex: org-html-table-header-tags
12615 Opening and ending tags for table's header fields.
12617 - ~org-html-table-row-tags~ ::
12619 #+vindex: org-html-table-row-tags
12620 Opening and ending tags for table rows.
12622 - ~org-html-table-use-header-tags-for-first-column~ ::
12624 #+vindex: org-html-table-use-header-tags-for-first-column
12625 Non-~nil~ formats column one in tables with header tags.
12627 *** Images in HTML export
12629 :DESCRIPTION: How to insert figures into HTML output.
12631 #+cindex: images, inline in HTML
12632 #+cindex: inlining images in HTML
12634 The HTML export back-end has features to convert Org image links to
12635 HTML inline images and HTML clickable image links.
12637 #+vindex: org-html-inline-images
12638 When the link in the Org file has no description, the HTML export
12639 back-end by default in-lines that image. For example:
12640 =[[file:myimg.jpg]]= is in-lined, while =[[file:myimg.jpg][the image]]= links to the text,
12641 =the image=. For more details, see the variable
12642 ~org-html-inline-images~.
12644 On the other hand, if the description part of the Org link is itself
12645 another link, such as =file:= or =http:= URL pointing to an image, the
12646 HTML export back-end in-lines this image and links to the main image.
12647 This Org syntax enables the back-end to link low-resolution thumbnail
12648 to the high-resolution version of the image, as shown in this example:
12650 : [[file:highres.jpg][file:thumb.jpg]]
12652 To change attributes of in-lined images, use =#+ATTR_HTML= lines in
12653 the Org file. This example shows realignment to right, and adds ~alt~
12654 and ~title~ attributes in support of text viewers and modern web
12655 accessibility standards.
12657 #+cindex: @samp{CAPTION}, keyword
12658 #+cindex: @samp{ATTR_HTML}, keyword
12660 ,#+CAPTION: A black cat stalking a spider
12661 ,#+ATTR_HTML: :alt cat/spider image :title Action! :align right
12665 #+texinfo: @noindent
12666 The HTML export back-end copies the =http= links from the Org file as
12669 *** Math formatting in HTML export
12671 :DESCRIPTION: Beautiful math also on the web.
12676 #+cindex: ImageMagick
12678 #+vindex: org-html-mathjax-options~
12679 LaTeX math snippets (see [[*LaTeX fragments]]) can be displayed in two
12680 different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax]],
12681 which should work out of the box with Org[fn:121]. Some MathJax
12682 display options can be configured via ~org-html-mathjax-options~, or
12683 in the buffer. For example, with the following settings,
12686 ,#+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
12687 ,#+HTML_MATHJAX: cancel.js noErrors.js
12690 #+texinfo: @noindent
12691 equation labels are displayed on the left margin and equations are
12692 five em from the left margin. In addition, it loads the two MathJax
12693 extensions =cancel.js= and =noErrors.js=[fn:122].
12695 #+vindex: org-html-mathjax-template
12696 See the docstring of ~org-html-mathjax-options~ for all supported
12697 variables. The MathJax template can be configure via
12698 ~org-html-mathjax-template~.
12700 If you prefer, you can also request that LaTeX fragments are processed
12701 into small images that will be inserted into the browser page. Before
12702 the availability of MathJax, this was the default method for Org
12703 files. This method requires that the dvipng program, dvisvgm or
12704 ImageMagick suite is available on your system. You can still get this
12707 : #+OPTIONS: tex:dvipng
12709 : #+OPTIONS: tex:dvisvgm
12711 #+texinfo: @noindent
12714 : #+OPTIONS: tex:imagemagick
12716 *** Text areas in HTML export
12718 :DESCRIPTION: An alternate way to show an example.
12721 #+cindex: text areas, in HTML
12722 Before Org mode's Babel, one popular approach to publishing code in
12723 HTML was by using =:textarea=. The advantage of this approach was
12724 that copying and pasting was built into browsers with simple
12725 JavaScript commands. Even editing before pasting was made simple.
12727 The HTML export back-end can create such text areas. It requires an
12728 =#+ATTR_HTML= line as shown in the example below with the =:textarea=
12729 option. This must be followed by either an example or a source code
12730 block. Other Org block types do not honor the =:textarea= option.
12732 By default, the HTML export back-end creates a text area 80 characters
12733 wide and height just enough to fit the content. Override these
12734 defaults with =:width= and =:height= options on the =#+ATTR_HTML=
12738 ,#+ATTR_HTML: :textarea t :width 40
12740 (defun org-xor (a b)
12748 :DESCRIPTION: Changing the appearance of the output.
12750 #+cindex: CSS, for HTML export
12751 #+cindex: HTML export, CSS
12753 #+vindex: org-export-html-todo-kwd-class-prefix
12754 #+vindex: org-export-html-tag-class-prefix
12755 You can modify the CSS style definitions for the exported file. The
12756 HTML exporter assigns the following special CSS classes[fn:123] to
12757 appropriate parts of the document---your style specifications may
12758 change these, in addition to any of the standard classes like for
12759 headlines, tables, etc.
12761 | ~p.author~ | author information, including email |
12762 | ~p.date~ | publishing date |
12763 | ~p.creator~ | creator info, about org mode version |
12764 | ~.title~ | document title |
12765 | ~.subtitle~ | document subtitle |
12766 | ~.todo~ | TODO keywords, all not-done states |
12767 | ~.done~ | the DONE keywords, all states that count as done |
12768 | ~.WAITING~ | each TODO keyword also uses a class named after itself |
12769 | ~.timestamp~ | timestamp |
12770 | ~.timestamp-kwd~ | keyword associated with a timestamp, like =SCHEDULED= |
12771 | ~.timestamp-wrapper~ | span around keyword plus timestamp |
12772 | ~.tag~ | tag in a headline |
12773 | ~._HOME~ | each tag uses itself as a class, "@" replaced by "_" |
12774 | ~.target~ | target for links |
12775 | ~.linenr~ | the line number in a code example |
12776 | ~.code-highlighted~ | for highlighting referenced code lines |
12777 | ~div.outline-N~ | div for outline level N (headline plus text) |
12778 | ~div.outline-text-N~ | extra div for text at outline level N |
12779 | ~.section-number-N~ | section number in headlines, different for each level |
12780 | ~.figure-number~ | label like "Figure 1:" |
12781 | ~.table-number~ | label like "Table 1:" |
12782 | ~.listing-number~ | label like "Listing 1:" |
12783 | ~div.figure~ | how to format an in-lined image |
12784 | ~pre.src~ | formatted source code |
12785 | ~pre.example~ | normal example |
12786 | ~p.verse~ | verse paragraph |
12787 | ~div.footnotes~ | footnote section headline |
12788 | ~p.footnote~ | footnote definition paragraph, containing a footnote |
12789 | ~.footref~ | a footnote reference number (always a <sup>) |
12790 | ~.footnum~ | footnote number in footnote definition (always <sup>) |
12791 | ~.org-svg~ | default class for a linked =.svg= image |
12793 #+vindex: org-html-style-default
12794 #+vindex: org-html-head
12795 #+vindex: org-html-head-extra
12796 #+cindex: @samp{HTML_INCLUDE_STYLE}, keyword
12797 The HTML export back-end includes a compact default style in each
12798 exported HTML file. To override the default style with another style,
12799 use these keywords in the Org file. They will replace the global
12800 defaults the HTML exporter uses.
12802 #+cindex: @samp{HTML_HEAD}, keyword
12803 #+cindex: @samp{HTML_HEAD_EXTRA}, keyword
12805 ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
12806 ,#+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
12809 #+vindex: org-html-head-include-default-style
12810 To just turn off the default style, customize
12811 ~org-html-head-include-default-style~ variable, or use this option
12812 line in the Org file.
12814 #+cindex: @samp{html-style}, @samp{OPTIONS} item
12815 : #+OPTIONS: html-style:nil
12817 For longer style definitions, either use several =HTML_HEAD= and
12818 =HTML_HEAD_EXTRA= keywords, or use ~<style> ... </style>~ blocks
12819 around them. Both of these approaches can avoid referring to an
12822 #+cindex: @samp{HTML_CONTAINER_CLASS}, property
12823 In order to add styles to a sub-tree, use the =HTML_CONTAINER_CLASS=
12824 property to assign a class to the tree. In order to specify CSS
12825 styles for a particular headline, you can use the id specified in
12826 a =CUSTOM_ID= property.
12828 Never change the ~org-html-style-default~ constant. Instead use other
12829 simpler ways of customizing as described above.
12831 *** JavaScript supported display of web pages
12833 :DESCRIPTION: Info and folding in a web browser.
12834 :ALT_TITLE: JavaScript support
12837 Sebastian Rose has written a JavaScript program especially designed to
12838 enhance the web viewing experience of HTML files created with Org.
12839 This program enhances large files in two different ways of viewing.
12840 One is an /Info/-like mode where each section is displayed separately
12841 and navigation can be done with the {{{kbd(n)}}} and {{{kbd(p)}}}
12842 keys, and some other keys as well, press {{{kbd(?)}}} for an overview
12843 of the available keys. The second one has a /folding/ view, much like
12844 Org provides inside Emacs. The script is available at
12845 https://orgmode.org/org-info.js and the documentation at
12846 https://orgmode.org/worg/code/org-info-js/. The script is hosted on
12847 https://orgmode.org, but for reliability, prefer installing it on your
12850 To use this program, just add this line to the Org file:
12852 #+cindex: @samp{INFOJS_OPT}, keyword
12853 : #+INFOJS_OPT: view:info toc:nil
12855 #+texinfo: @noindent
12856 The HTML header now has the code needed to automatically invoke the
12857 script. For setting options, use the syntax from the above line for
12858 options described below:
12862 The path to the script. The default is to grab the script from
12863 [[https://orgmode.org/org-info.js]], but you might want to have
12864 a local copy and use a path like =../scripts/org-info.js=.
12868 Initial view when the website is first shown. Possible values are:
12870 | =info= | Info-like interface with one section per page |
12871 | =overview= | Folding interface, initially showing only top-level |
12872 | =content= | Folding interface, starting with all headlines visible |
12873 | =showall= | Folding interface, all headlines and text visible |
12877 Maximum headline level still considered as an independent section
12878 for info and folding modes. The default is taken from
12879 ~org-export-headline-levels~, i.e., the =H= switch in =OPTIONS=.
12880 If this is smaller than in ~org-export-headline-levels~, each
12881 info/folding section can still contain child headlines.
12885 Should the table of contents /initially/ be visible? Even when
12886 =nil=, you can always get to the "toc" with {{{kbd(i)}}}.
12890 The depth of the table of contents. The defaults are taken from
12891 the variables ~org-export-headline-levels~ and
12892 ~org-export-with-toc~.
12896 Does the CSS of the page specify a fixed position for the "toc"?
12897 If yes, the toc is displayed as a section.
12901 Should there be short contents (children) in each section? Make
12902 this =above= if the section should be above initial text.
12906 Headings are highlighted when the mouse is over them. Should be
12907 =underline= (default) or a background color like =#cccccc=.
12911 Should view-toggle buttons be everywhere? When =nil= (the
12912 default), only one such button is present.
12914 #+texinfo: @noindent
12915 #+vindex: org-infojs-options
12916 #+vindex: org-export-html-use-infojs
12917 You can choose default values for these options by customizing the
12918 variable ~org-infojs-options~. If you always want to apply the script
12919 to your pages, configure the variable ~org-export-html-use-infojs~.
12923 :DESCRIPTION: Exporting to @LaTeX{} and processing to PDF.
12925 #+cindex: @LaTeX{} export
12926 #+cindex: PDF export
12928 The LaTeX export back-end can handle complex documents, incorporate
12929 standard or custom LaTeX document classes, generate documents using
12930 alternate LaTeX engines, and produce fully linked PDF files with
12931 indexes, bibliographies, and tables of contents, destined for
12932 interactive online viewing or high-quality print publication.
12934 While the details are covered in-depth in this section, here are some
12935 quick references to variables for the impatient: for engines, see
12936 ~org-latex-compiler~; for build sequences, see
12937 ~org-latex-pdf-process~; for packages, see
12938 ~org-latex-default-packages-alist~ and ~org-latex-packages-alist~.
12940 An important note about the LaTeX export back-end: it is sensitive to
12941 blank lines in the Org document. That's because LaTeX itself depends
12942 on blank lines to tell apart syntactical elements, such as paragraphs.
12944 *** LaTeX/PDF export commands
12946 :DESCRIPTION: For producing @LaTeX{} and PDF documents.
12949 - {{{kbd(C-c C-e l l)}}} (~org-latex-export-to-latex~) ::
12951 #+kindex: C-c C-e l l
12952 #+findex: org-latex-export-to-latex~
12953 Export to a LaTeX file with a =.tex= extension. For
12954 =myfile.org=, Org exports to =myfile.tex=, overwriting without
12957 - {{{kbd(C-c C-e l L)}}} (~org-latex-export-as-latex~) ::
12959 #+kindex: C-c C-e l L
12960 #+findex: org-latex-export-as-latex
12961 Export to a temporary buffer. Do not create a file.
12963 - {{{kbd(C-c C-e l p)}}} (~org-latex-export-to-pdf~) ::
12965 #+kindex: C-c C-e l p
12966 #+findex: org-latex-export-to-pdf
12967 Export as LaTeX file and convert it to PDF file.
12969 - {{{kbd(C-c C-e l o)}}} ::
12971 #+kindex: C-c C-e l o
12972 Export as LaTeX file and convert it to PDF, then open the PDF
12973 using the default viewer.
12975 - {{{kbd(M-x org-export-region-as-latex)}}} ::
12977 Convert the region to LaTeX under the assumption that it was in Org
12978 mode syntax before. This is a global command that can be invoked in
12981 #+vindex: org-latex-compiler
12982 #+vindex: org-latex-bibtex-compiler
12983 #+vindex: org-latex-default-packages-alist
12987 #+cindex: @samp{LATEX_COMPILER}, keyword
12988 The LaTeX export back-end can use any of these LaTeX engines:
12989 =pdflatex=, =xelatex=, and =lualatex=. These engines compile LaTeX
12990 files with different compilers, packages, and output options. The
12991 LaTeX export back-end finds the compiler version to use from
12992 ~org-latex-compiler~ variable or the =#+LATEX_COMPILER= keyword in the
12993 Org file. See the docstring for the
12994 ~org-latex-default-packages-alist~ for loading packages with certain
12995 compilers. Also see ~org-latex-bibtex-compiler~ to set the
12996 bibliography compiler[fn:124].
12998 *** LaTeX specific export settings
13000 :DESCRIPTION: Unique to this @LaTeX{} back-end.
13003 The LaTeX export back-end has several additional keywords for
13004 customizing LaTeX output. Setting these keywords works similar to the
13005 general options (see [[*Export Settings]]).
13007 #+attr_texinfo: :sep ,
13009 #+cindex: @samp{DESCRIPTION}, keyword
13010 #+vindex: org-latex-hyperref-template
13011 #+vindex: org-latex-title-command
13012 The document's description. The description along with author
13013 name, keywords, and related file metadata are inserted in the
13014 output file by the hyperref package. See
13015 ~org-latex-hyperref-template~ for customizing metadata items.
13016 See ~org-latex-title-command~ for typesetting description into
13017 the document's front matter. Use multiple =DESCRIPTION= keywords
13018 for long descriptions.
13022 #+cindex: @samp{LATEX_CLASS}, keyword
13023 #+vindex: org-latex-default-class
13024 #+vindex: org-latex-classes
13025 This is LaTeX document class, such as /article/, /report/,
13026 /book/, and so on, which contain predefined preamble and headline
13027 level mapping that the LaTeX export back-end needs. The back-end
13028 reads the default class name from the ~org-latex-default-class~
13029 variable. Org has /article/ as the default class. A valid
13030 default class must be an element of ~org-latex-classes~.
13032 - =LATEX_CLASS_OPTIONS= ::
13034 #+cindex: @samp{LATEX_CLASS_OPTIONS}, keyword
13035 Options the LaTeX export back-end uses when calling the LaTeX
13038 - =LATEX_COMPILER= ::
13040 #+cindex: @samp{LATEX_COMPILER}, keyword
13041 #+vindex: org-latex-compiler
13042 The compiler, such as =pdflatex=, =xelatex=, =lualatex=, for
13043 producing the PDF. See ~org-latex-compiler~.
13045 - =LATEX_HEADER=, =LATEX_HEADER_EXTRA= ::
13047 #+cindex: @samp{LATEX_HEADER}, keyword
13048 #+cindex: @samp{LATEX_HEADER_EXTRA}, keyword
13049 #+vindex: org-latex-classes
13050 Arbitrary lines to add to the document's preamble, before the
13051 hyperref settings. See ~org-latex-classes~ for adjusting the
13052 structure and order of the LaTeX headers.
13056 #+cindex: @samp{KEYWORDS}, keyword
13057 #+vindex: org-latex-hyperref-template
13058 #+vindex: org-latex-title-command
13059 The keywords for the document. The description along with author
13060 name, keywords, and related file metadata are inserted in the
13061 output file by the hyperref package. See
13062 ~org-latex-hyperref-template~ for customizing metadata items.
13063 See ~org-latex-title-command~ for typesetting description into
13064 the document's front matter. Use multiple =KEYWORDS= lines if
13069 #+cindex: @samp{SUBTITLE}, keyword
13070 #+vindex: org-latex-subtitle-separate
13071 #+vindex: org-latex-subtitle-format
13072 The document's subtitle. It is typeset as per
13073 ~org-latex-subtitle-format~. If ~org-latex-subtitle-separate~ is
13074 non-~nil~, it is typed as part of the ~\title~ macro. See
13075 ~org-latex-hyperref-template~ for customizing metadata items.
13076 See ~org-latex-title-command~ for typesetting description
13077 into the document's front matter.
13079 The following sections have further details.
13081 *** LaTeX header and sectioning structure
13083 :DESCRIPTION: Setting up the export file structure.
13084 :ALT_TITLE: LaTeX header and sectioning
13086 #+cindex: @LaTeX{} class
13087 #+cindex: @LaTeX{} sectioning structure
13088 #+cindex: @LaTeX{} header
13089 #+cindex: header, for @LaTeX{} files
13090 #+cindex: sectioning structure, for @LaTeX{} export
13092 The LaTeX export back-end converts the first three of Org's outline
13093 levels into LaTeX headlines. The remaining Org levels are exported as
13094 lists. To change this globally for the cut-off point between levels
13095 and lists, (see [[*Export Settings]]).
13097 By default, the LaTeX export back-end uses the /article/ class.
13099 #+vindex: org-latex-default-class
13100 #+vindex: org-latex-classes
13101 #+vindex: org-latex-default-packages-alist
13102 #+vindex: org-latex-packages-alist
13103 To change the default class globally, edit ~org-latex-default-class~.
13104 To change the default class locally in an Org file, add option lines
13105 =#+LATEX_CLASS: myclass=. To change the default class for just a part
13106 of the Org file, set a sub-tree property, =EXPORT_LATEX_CLASS=. The
13107 class name entered here must be valid member of ~org-latex-classes~.
13108 This variable defines a header template for each class into which the
13109 exporter splices the values of ~org-latex-default-packages-alist~ and
13110 ~org-latex-packages-alist~. Use the same three variables to define
13111 custom sectioning or custom classes.
13113 #+cindex: @samp{LATEX_CLASS}, keyword
13114 #+cindex: @samp{LATEX_CLASS_OPTIONS}, keyword
13115 #+cindex: @samp{EXPORT_LATEX_CLASS}, property
13116 #+cindex: @samp{EXPORT_LATEX_CLASS_OPTIONS}, property
13117 The LaTeX export back-end sends the =LATEX_CLASS_OPTIONS= keyword and
13118 =EXPORT_LATEX_CLASS_OPTIONS= property as options to the LaTeX
13119 ~\documentclass~ macro. The options and the syntax for specifying
13120 them, including enclosing them in square brackets, follow LaTeX
13123 : #+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn]
13125 #+cindex: @samp{LATEX_HEADER}, keyword
13126 #+cindex: @samp{LATEX_HEADER_EXTRA}, keyword
13127 The LaTeX export back-end appends values from =LATEX_HEADER= and
13128 =LATEX_HEADER_EXTRA= keywords to the LaTeX header. The docstring for
13129 ~org-latex-classes~ explains in more detail. Also note that LaTeX
13130 export back-end does not append =LATEX_HEADER_EXTRA= to the header
13131 when previewing LaTeX snippets (see [[*Previewing LaTeX fragments]]).
13133 A sample Org file with the above headers:
13136 ,#+LATEX_CLASS: article
13137 ,#+LATEX_CLASS_OPTIONS: [a4paper]
13138 ,#+LATEX_HEADER: \usepackage{xyz}
13146 *** Quoting LaTeX code
13148 :DESCRIPTION: Incorporating literal @LaTeX{} code.
13151 The LaTeX export back-end can insert any arbitrary LaTeX code, see
13152 [[*Embedded LaTeX]]. There are three ways to embed such code in the Org
13153 file and they all use different quoting syntax.
13155 #+cindex: inline, in @LaTeX{} export
13156 Inserting in-line quoted with @ symbols:
13158 : Code embedded in-line @@latex:any arbitrary LaTeX code@@ in a paragraph.
13160 #+cindex: @samp{LATEX}, keyword
13161 Inserting as one or more keyword lines in the Org file:
13163 : #+LATEX: any arbitrary LaTeX code
13165 #+cindex: @samp{BEGIN_EXPORT latex}
13166 Inserting as an export block in the Org file, where the back-end
13167 exports any code between begin and end markers:
13170 ,#+BEGIN_EXPORT latex
13171 any arbitrary LaTeX code
13175 *** Tables in LaTeX export
13177 :DESCRIPTION: Options for exporting tables to @LaTeX{}.
13179 #+cindex: tables, in @LaTeX{} export
13181 The LaTeX export back-end can pass several LaTeX attributes for table
13182 contents and layout. Besides specifying label and caption (see
13183 [[*Images and Tables]]), the other valid LaTeX attributes include:
13185 #+attr_texinfo: :sep ,
13188 #+vindex: org-latex-default-table-mode
13189 The LaTeX export back-end wraps the table differently depending
13190 on the mode for accurate rendering of math symbols. Mode is
13191 either =table=, =math=, =inline-math= or =verbatim=.
13193 For =math= or =inline-math= mode, LaTeX export back-end wraps the
13194 table in a math environment, but every cell in it is exported
13195 as-is. The LaTeX export back-end determines the default mode
13196 from ~org-latex-default-table-mode~. The LaTeX export back-end
13197 merges contiguous tables in the same mode into a single
13200 - =:environment= ::
13202 #+vindex: org-latex-default-table-environment
13203 Set the default LaTeX table environment for the LaTeX export
13204 back-end to use when exporting Org tables. Common LaTeX table
13205 environments are provided by these packages: tabularx, longtable,
13206 array, tabu, and bmatrix. For packages, such as tabularx and
13207 tabu, or any newer replacements, include them in the
13208 ~org-latex-packages-alist~ variable so the LaTeX export back-end
13209 can insert the appropriate load package headers in the converted
13210 LaTeX file. Look in the docstring for the
13211 ~org-latex-packages-alist~ variable for configuring these
13212 packages for LaTeX snippet previews, if any.
13216 Use =CAPTION= keyword to set a simple caption for a table (see
13217 [[*Images and Tables]]). For custom captions, use =:caption=
13218 attribute, which accepts raw LaTeX code. =:caption= value
13219 overrides =CAPTION= value.
13221 - =:float=, =:placement= ::
13223 The table environments by default are not floats in LaTeX. To
13224 make them floating objects use =:float= with one of the following
13225 options: =sideways=, =multicolumn=, =t=, and =nil=.
13227 LaTeX floats can also have additional layout =:placement=
13228 attributes. These are the usual =[h t b p ! H]= permissions
13229 specified in square brackets. Note that for =:float sideways=
13230 tables, the LaTeX export back-end ignores =:placement=
13233 - =:align=, =:font=, =:width= ::
13235 The LaTeX export back-end uses these attributes for regular
13236 tables to set their alignments, fonts, and widths.
13240 When =:spread= is non-~nil~, the LaTeX export back-end spreads or
13241 shrinks the table by the =:width= for tabu and longtabu
13242 environments. =:spread= has no effect if =:width= is not set.
13244 - =:booktabs=, =:center=, =:rmlines= ::
13246 #+vindex: org-latex-tables-booktabs
13247 #+vindex: org-latex-tables-centered
13248 All three commands are toggles. =:booktabs= brings in modern
13249 typesetting enhancements to regular tables. The booktabs package
13250 has to be loaded through ~org-latex-packages-alist~. =:center=
13251 is for centering the table. =:rmlines= removes all but the very
13252 first horizontal line made of ASCII characters from "table.el"
13255 - =:math-prefix=, =:math-suffix=, =:math-arguments= ::
13257 The LaTeX export back-end inserts =:math-prefix= string value in
13258 a math environment before the table. The LaTeX export back-end
13259 inserts =:math-suffix= string value in a math environment after
13260 the table. The LaTeX export back-end inserts =:math-arguments=
13261 string value between the macro name and the table's contents.
13262 =:math-arguments= comes in use for matrix macros that require
13263 more than one argument, such as =qbordermatrix=.
13265 LaTeX table attributes help formatting tables for a wide range of
13266 situations, such as matrix product or spanning multiple pages:
13269 ,#+ATTR_LATEX: :environment longtable :align l|lp{3cm}r|l
13273 ,#+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
13276 ,#+ATTR_LATEX: :mode math :environment bmatrix
13281 Set the caption with the LaTeX command
13282 =\bicaption{HeadingA}{HeadingB}=:
13285 ,#+ATTR_LATEX: :caption \bicaption{HeadingA}{HeadingB}
13290 *** Images in LaTeX export
13292 :DESCRIPTION: How to insert figures into @LaTeX{} output.
13294 #+cindex: images, inline in LaTeX
13295 #+cindex: inlining images in LaTeX
13296 #+cindex: @samp{ATTR_LATEX}, keyword
13298 The LaTeX export back-end processes image links in Org files that do
13299 not have descriptions, such as these links =[[file:img.jpg]]= or
13300 =[[./img.jpg]]=, as direct image insertions in the final PDF output. In
13301 the PDF, they are no longer links but actual images embedded on the
13302 page. The LaTeX export back-end uses =\includegraphics= macro to
13303 insert the image. But for TikZ (http://sourceforge.net/projects/pgf/)
13304 images, the back-end uses an ~\input~ macro wrapped within
13305 a ~tikzpicture~ environment.
13307 For specifying image =:width=, =:height=, and other =:options=, use
13311 ,#+ATTR_LATEX: :width 5cm :options angle=90
13312 [[./img/sed-hr4049.pdf]]
13315 For custom commands for captions, use the =:caption= attribute. It
13316 overrides the default =#+CAPTION= value:
13319 ,#+ATTR_LATEX: :caption \bicaption{HeadingA}{HeadingB}
13320 [[./img/sed-hr4049.pdf]]
13323 When captions follow the method as described in [[*Images and Tables]],
13324 the LaTeX export back-end wraps the picture in a floating =figure=
13325 environment. To float an image without specifying a caption, set the
13326 =:float= attribute to one of the following:
13330 For a standard =figure= environment; used by default whenever an
13331 image has a caption.
13335 To span the image across multiple columns of a page; the back-end
13336 wraps the image in a =figure*= environment.
13340 For text to flow around the image on the right; the figure
13341 occupies the left half of the page.
13345 For a new page with the image sideways, rotated ninety degrees,
13346 in a =sidewaysfigure= environment; overrides =:placement=
13351 To avoid a =:float= even if using a caption.
13353 #+texinfo: @noindent
13354 Use the =placement= attribute to modify a floating environment's
13358 ,#+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement {r}{0.4\textwidth}
13362 #+vindex: org-latex-images-centered
13363 #+cindex: center image in LaTeX export
13364 #+cindex: image, centering in LaTeX export
13365 The LaTeX export back-end centers all images by default. Setting
13366 =:center= to =nil= disables centering. To disable centering globally,
13367 set ~org-latex-images-centered~ to =t=.
13369 Set the =:comment-include= attribute to non-~nil~ value for the LaTeX
13370 export back-end to comment out the =\includegraphics= macro.
13372 *** Plain lists in LaTeX export
13374 :DESCRIPTION: Attributes specific to lists.
13377 #+cindex: plain lists, in @LaTeX{} export
13378 #+cindex: @samp{ATTR_LATEX}, keyword
13379 The LaTeX export back-end accepts the =environment= and =options=
13380 attributes for plain lists. Both attributes work together for
13381 customizing lists, as shown in the examples:
13384 ,#+LATEX_HEADER: \usepackage[inline]{enumitem}
13385 Some ways to say "Hello":
13386 ,#+ATTR_LATEX: :environment itemize*
13387 ,#+ATTR_LATEX: :options [label={}, itemjoin={,}, itemjoin*={, and}]
13393 Since LaTeX supports only four levels of nesting for lists, use an
13394 external package, such as =enumitem= in LaTeX, for levels deeper than
13398 ,#+LATEX_HEADER: \usepackage{enumitem}
13399 ,#+LATEX_HEADER: \renewlist{itemize}{itemize}{9}
13400 ,#+LATEX_HEADER: \setlist[itemize]{label=$\circ$}
13408 *** Source blocks in LaTeX export
13410 :DESCRIPTION: Attributes specific to source code blocks.
13412 #+cindex: source blocks, in @LaTeX{} export
13413 #+cindex: @samp{ATTR_LATEX}, keyword
13415 The LaTeX export back-end can make source code blocks into floating
13416 objects through the attributes =:float= and =:options=. For =:float=:
13420 Makes a source block float; by default floats any source block
13425 Spans the source block across multiple columns of a page.
13429 Avoids a =:float= even if using a caption; useful for source code
13430 blocks that may not fit on a page.
13433 ,#+ATTR_LATEX: :float nil
13434 ,#+BEGIN_SRC emacs-lisp
13435 Lisp code that may not fit in a single page.
13439 #+vindex: org-latex-listings-options
13440 #+vindex: org-latex-minted-options
13441 The LaTeX export back-end passes string values in =:options= to LaTeX
13442 packages for customization of that specific source block. In the
13443 example below, the =:options= are set for Minted. Minted is a source
13444 code highlighting LaTeX package with many configurable options.
13447 ,#+ATTR_LATEX: :options commentstyle=\bfseries
13448 ,#+BEGIN_SRC emacs-lisp
13450 (if (< n 2) n (+ (Fib (- n 1)) (Fib (- n 2)))))
13454 To apply similar configuration options for all source blocks in
13455 a file, use the ~org-latex-listings-options~ and
13456 ~org-latex-minted-options~ variables.
13458 *** Example blocks in LaTeX export
13460 :DESCRIPTION: Attributes specific to example blocks.
13462 #+cindex: example blocks, in @LaTeX{} export
13463 #+cindex: verbatim blocks, in @LaTeX{} export
13464 #+cindex: @samp{ATTR_LATEX}, keyword
13466 The LaTeX export back-end wraps the contents of example blocks in
13467 a =verbatim= environment. To change this behavior to use another
13468 environment globally, specify an appropriate export filter (see
13469 [[*Advanced Configuration]]). To change this behavior to use another
13470 environment for each block, use the =:environment= parameter to
13471 specify a custom environment.
13474 ,#+ATTR_LATEX: :environment myverbatim
13476 This sentence is false.
13480 *** Special blocks in LaTeX export
13482 :DESCRIPTION: Attributes specific to special blocks.
13485 #+cindex: special blocks, in @LaTeX{} export
13486 #+cindex: abstract, in @LaTeX{} export
13487 #+cindex: proof, in @LaTeX{} export
13488 #+cindex: @samp{ATTR_LATEX}, keyword
13490 For other special blocks in the Org file, the LaTeX export back-end
13491 makes a special environment of the same name. The back-end also takes
13492 =:options=, if any, and appends as-is to that environment's opening
13493 string. For example:
13497 We demonstrate how to solve the Syracuse problem.
13500 ,#+ATTR_LATEX: :options [Proof of important theorem]
13503 Therefore, any even number greater than 2 is the sum of two primes.
13507 #+texinfo: @noindent
13512 We demonstrate how to solve the Syracuse problem.
13515 \begin{proof}[Proof of important theorem]
13517 Therefore, any even number greater than 2 is the sum of two primes.
13521 If you need to insert a specific caption command, use =:caption=
13522 attribute. It overrides standard =CAPTION= value, if any. For
13526 ,#+ATTR_LATEX: :caption \MyCaption{HeadingA}
13532 *** Horizontal rules in LaTeX export
13534 :DESCRIPTION: Attributes specific to horizontal rules.
13536 #+cindex: horizontal rules, in @LaTeX{} export
13537 #+cindex: @samp{ATTR_LATEX}, keyword
13539 The LaTeX export back-end converts horizontal rules by the specified
13540 =:width= and =:thickness= attributes. For example:
13543 ,#+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
13549 :DESCRIPTION: Exporting to Markdown.
13551 #+cindex: Markdown export
13553 The Markdown export back-end, "md", converts an Org file to Markdown
13554 format, as defined at http://daringfireball.net/projects/markdown/.
13556 Since it is built on top of the HTML back-end (see [[*HTML Export]]), it
13557 converts every Org construct not defined in Markdown syntax, such as
13560 *** Markdown export commands
13565 - {{{kbd(C-c C-e m m)}}} (~org-md-export-to-markdown~) ::
13567 #+kindex: C-c C-c m m
13568 #+findex: org-md-export-to-markdown
13569 Export to a text file with Markdown syntax. For =myfile.org=,
13570 Org exports to =myfile.md=, overwritten without warning.
13572 - {{{kbd(C-c C-e m M)}}} (~org-md-export-as-markdown~) ::
13574 #+kindex: C-c C-c m M
13575 #+findex: org-md-export-as-markdown
13576 Export to a temporary buffer. Does not create a file.
13578 - {{{kbd(C-c C-e m o)}}} ::
13580 #+kindex: C-c C-e m o
13581 Export as a text file with Markdown syntax, then open it.
13583 *** Header and sectioning structure
13588 #+vindex: org-md-headline-style
13589 Based on ~org-md-headline-style~, Markdown export can generate
13590 headlines of both /atx/ and /setext/ types. /atx/ limits headline
13591 levels to two whereas /setext/ limits headline levels to six. Beyond
13592 these limits, the export back-end converts headlines to lists. To set
13593 a limit to a level before the absolute limit (see [[*Export Settings]]).
13595 ** OpenDocument Text Export
13597 :DESCRIPTION: Exporting to OpenDocument Text.
13600 #+cindex: OpenDocument
13601 #+cindex: export, OpenDocument
13602 #+cindex: LibreOffice
13604 The ODT export back-end handles creating of OpenDocument Text (ODT)
13605 format. Documents created by this exporter use the
13606 {{{cite(OpenDocument-v1.2 specification)}}}[fn:125] and are compatible
13607 with LibreOffice 3.4.
13609 *** Pre-requisites for ODT export
13611 :DESCRIPTION: Required packages.
13615 The ODT export back-end relies on the zip program to create the final
13616 compressed ODT output. Check if =zip= is locally available and
13617 executable. Without it, export cannot finish.
13619 *** ODT export commands
13621 :DESCRIPTION: Invoking export.
13624 - {{{kbd(C-c C-e o o)}}} (~org-export-to-odt~) ::
13626 #+kindex: C-c C-e o o
13627 #+findex: org-export-to-odt
13628 Export as OpenDocument Text file.
13630 #+cindex: @samp{EXPORT_FILE_NAME}, property
13631 #+vindex: org-odt-preferred-output-format
13633 If ~org-odt-preferred-output-format~ is specified, the ODT export
13634 back-end automatically converts the exported file to that format.
13636 For =myfile.org=, Org exports to =myfile.odt=, overwriting
13637 without warning. The ODT export back-end exports a region only
13638 if a region was active.
13640 If the selected region is a single tree, the ODT export back-end
13641 makes the tree head the document title. Incidentally, {{{kbd(C-c
13642 @)}}} selects the current sub-tree. If the tree head entry has,
13643 or inherits, an =EXPORT_FILE_NAME= property, the ODT export
13644 back-end uses that for file name.
13646 - {{{kbd(C-c C-e o O)}}} ::
13648 #+kindex: C-c C-e o O
13649 Export as an OpenDocument Text file and open the resulting file.
13651 #+vindex: org-export-odt-preferred-output-format
13652 If ~org-export-odt-preferred-output-format~ is specified, open
13653 the converted file instead. See [[*Automatically exporting to
13656 *** ODT specific export settings
13658 :DESCRIPTION: Configuration options.
13661 The ODT export back-end has several additional keywords for
13662 customizing ODT output. Setting these keywords works similar to the
13663 general options (see [[*Export Settings]]).
13667 #+cindex: @samp{DESCRIPTION}, keyword
13668 This is the document's description, which the ODT export back-end
13669 inserts as document metadata. For long descriptions, use
13670 multiple lines, prefixed with =DESCRIPTION=.
13674 #+cindex: @samp{KEYWORDS}, keyword
13675 The keywords for the document. The ODT export back-end inserts
13676 the description along with author name, keywords, and related
13677 file metadata as metadata in the output file. Use multiple
13678 =KEYWORDS= if necessary.
13680 - =ODT_STYLES_FILE= ::
13682 #+cindex: @samp{ODT_STYLES_FILE}, keyword
13683 #+vindex: org-odt-styles-file
13684 The ODT export back-end uses the ~org-odt-styles-file~ by
13685 default. See [[*Applying custom styles]] for details.
13689 #+cindex: @samp{SUBTITLE}, keyword
13690 The document subtitle.
13692 *** Extending ODT export
13694 :DESCRIPTION: Producing DOC, PDF files.
13697 The ODT export back-end can produce documents in other formats besides
13698 ODT using a specialized ODT converter process. Its common interface
13699 works with popular converters to produce formats such as =doc=, or
13700 convert a document from one format, say =csv=, to another format, say
13703 #+cindex: @file{unoconv}
13704 #+vindex: org-odt-convert-process
13705 Customize ~org-odt-convert-process~ variable to point to =unoconv=,
13706 which is the ODT's preferred converter. Working installations of
13707 LibreOffice would already have =unoconv= installed. Alternatively,
13708 other converters may be substituted here. See [[*Configuring
13709 a document converter]].
13711 **** Automatically exporting to other formats
13716 #+vindex: org-odt-preferred-output-format
13717 If ODT format is just an intermediate step to get to other formats,
13718 such as =doc=, =docx=, =rtf=, or =pdf=, etc., then extend the ODT
13719 export back-end to directly produce that format. Specify the final
13720 format in the ~org-odt-preferred-output-format~ variable. This is one
13721 way to extend (see [[*ODT export commands]]).
13723 **** Converting between document formats
13728 The Org export back-end is made to be inter-operable with a wide range
13729 of text document format converters. Newer generation converters, such
13730 as LibreOffice and Pandoc, can handle hundreds of formats at once.
13731 Org provides a consistent interaction with whatever converter is
13732 installed. Here are some generic commands:
13734 - {{{kbd(M-x org-odt-convert)}}} ::
13736 #+findex: org-odt-convert
13737 Convert an existing document from one format to another. With
13738 a prefix argument, opens the newly produced file.
13740 *** Applying custom styles
13742 :DESCRIPTION: Styling the output.
13744 #+cindex: styles, custom
13745 #+cindex: template, custom
13747 The ODT export back-end comes with many OpenDocument styles (see
13748 [[*Working with OpenDocument style files]]). To expand or further
13749 customize these built-in style sheets, either edit the style sheets
13750 directly or generate them using an application such as LibreOffice.
13751 The example here shows creating a style using LibreOffice.
13753 **** Applying custom styles: the easy way
13758 1. Create a sample =example.org= file with settings as shown below,
13759 and export it to ODT format.
13761 : #+OPTIONS: H:10 num:t
13763 2. Open the above =example.odt= using LibreOffice. Use the /Stylist/
13764 to locate the target styles, which typically have the "Org" prefix.
13765 Open one, modify, and save as either OpenDocument Text (ODT) or
13766 OpenDocument Template (OTT) file.
13769 #+vindex: org-odt-styles-file
13770 Customize the variable ~org-odt-styles-file~ and point it to the
13771 newly created file. For additional configuration options, see
13772 [[x-overriding-factory-styles][Overriding factory styles]].
13774 #+cindex: @samp{ODT_STYLES_FILE}, keyword
13775 To apply an ODT style to a particular file, use the
13776 =ODT_STYLES_FILE= keyword as shown in the example below:
13778 : #+ODT_STYLES_FILE: "/path/to/example.ott"
13780 #+texinfo: @noindent
13783 : #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
13785 **** Using third-party styles and templates
13790 The ODT export back-end relies on many templates and style names.
13791 Using third-party styles and templates can lead to mismatches.
13792 Templates derived from built in ODT templates and styles seem to have
13795 *** Links in ODT export
13797 :DESCRIPTION: Handling and formatting links.
13799 #+cindex: links, in ODT export
13801 ODT exporter creates native cross-references for internal links. It
13802 creates Internet-style links for all other links.
13804 A link with no description and pointing to a regular, un-itemized,
13805 outline heading is replaced with a cross-reference and section number
13808 A =\ref{label}=-style reference to an image, table etc., is replaced
13809 with a cross-reference and sequence number of the labeled entity. See
13810 [[*Labels and captions in ODT export]].
13812 *** Tables in ODT export
13814 :DESCRIPTION: Org tables conversions.
13817 #+cindex: tables, in ODT export
13819 The ODT export back-end handles native Org mode tables (see [[*Tables]])
13820 and simple =table.el= tables. Complex =table.el= tables having column
13821 or row spans are not supported. Such tables are stripped from the
13824 By default, the ODT export back-end exports a table with top and
13825 bottom frames and with ruled lines separating row and column groups
13826 (see [[*Column Groups]]). All tables are typeset to occupy the same
13827 width. The ODT export back-end honors any table alignments and
13828 relative widths for columns (see [[*Column Width and Alignment]]).
13830 Note that the ODT export back-end interprets column widths as weighted
13831 ratios, the default weight being 1.
13833 #+cindex: @samp{ATTR_ODT}, keyword
13834 Specifying =:rel-width= property on an =ATTR_ODT= line controls the
13835 width of the table. For example:
13838 ,#+ATTR_ODT: :rel-width 50
13839 | Area/Month | Jan | Feb | Mar | Sum |
13840 |---------------+-------+-------+-------+-------|
13842 | <l13> | <r5> | <r5> | <r5> | <r6> |
13843 | North America | 1 | 21 | 926 | 948 |
13844 | Middle East | 6 | 75 | 844 | 925 |
13845 | Asia Pacific | 9 | 27 | 790 | 826 |
13846 |---------------+-------+-------+-------+-------|
13847 | Sum | 16 | 123 | 2560 | 2699 |
13850 On export, the above table takes 50% of text width area. The exporter
13851 sizes the columns in the ratio: 13:5:5:5:6. The first column is
13852 left-aligned and rest of the columns, right-aligned. Vertical rules
13853 separate the header and the last column. Horizontal rules separate
13854 the header and the last row.
13856 For even more customization, create custom table styles and associate
13857 them with a table using the =ATTR_ODT= keyword. See [[*Customizing
13858 tables in ODT export]].
13860 *** Images in ODT export
13862 :DESCRIPTION: Inserting images.
13864 #+cindex: images, embedding in ODT
13865 #+cindex: embedding images in ODT
13867 **** Embedding images
13872 The ODT export back-end processes image links in Org files that do not
13873 have descriptions, such as these links =[[file:img.jpg]]= or =[[./img.jpg]]=,
13874 as direct image insertions in the final output. Either of these
13881 **** Embedding clickable images
13886 For clickable images, provide a link whose description is another link
13887 to an image file. For example, to embed an image
13888 =org-mode-unicorn.png= which when clicked jumps to https://orgmode.org
13889 website, do the following
13891 : [[https://orgmode.org][./org-mode-unicorn.png]]
13893 **** Sizing and scaling of embedded images
13898 #+cindex: @samp{ATTR_ODT}, keyword
13900 Control the size and scale of the embedded images with the =ATTR_ODT=
13903 #+cindex: identify, ImageMagick
13904 #+vindex: org-odt-pixels-per-inch
13905 The ODT export back-end starts with establishing the size of the image
13906 in the final document. The dimensions of this size are measured in
13907 centimeters. The back-end then queries the image file for its
13908 dimensions measured in pixels. For this measurement, the back-end
13909 relies on ImageMagick's identify program or Emacs ~create-image~ and
13910 ~image-size~ API. ImageMagick is the preferred choice for large file
13911 sizes or frequent batch operations. The back-end then converts the
13912 pixel dimensions using ~org-odt-pixels-per-inch~ into the familiar 72
13913 dpi or 96 dpi. The default value for this is in
13914 ~display-pixels-per-inch~, which can be tweaked for better results
13915 based on the capabilities of the output device. Here are some common
13916 image scaling operations:
13918 - Explicitly size the image ::
13920 To embed =img.png= as a 10 cm x 10 cm image, do the following:
13923 ,#+ATTR_ODT: :width 10 :height 10
13927 - Scale the image ::
13929 To embed =img.png= at half its size, do the following:
13932 ,#+ATTR_ODT: :scale 0.5
13936 - Scale the image to a specific width ::
13938 To embed =img.png= with a width of 10 cm while retaining the
13939 original height:width ratio, do the following:
13942 ,#+ATTR_ODT: :width 10
13946 - Scale the image to a specific height ::
13948 To embed =img.png= with a height of 10 cm while retaining the
13949 original height:width ratio, do the following:
13952 ,#+ATTR_ODT: :height 10
13956 **** Anchoring of images
13961 #+cindex: @samp{ATTR_ODT}, keyword
13962 The ODT export back-end can anchor images to ="as-char"=,
13963 ="paragraph"=, or ="page"=. Set the preferred anchor using the
13964 =:anchor= property of the =ATTR_ODT= line.
13966 To create an image that is anchored to a page:
13969 ,#+ATTR_ODT: :anchor "page"
13973 *** Math formatting in ODT export
13975 :DESCRIPTION: Formatting @LaTeX{} fragments.
13978 The ODT exporter has special support for handling math.
13980 **** LaTeX math snippets
13982 :DESCRIPTION: Embedding in @LaTeX{} format.
13985 LaTeX math snippets (see [[*LaTeX fragments]]) can be embedded in the ODT
13986 document in one of the following ways:
13991 Add this line to the Org file. This option is activated on
13996 With this option, LaTeX fragments are first converted into MathML
13997 fragments using an external LaTeX-to-MathML converter program.
13998 The resulting MathML fragments are then embedded as an
13999 OpenDocument Formula in the exported document.
14001 #+vindex: org-latex-to-mathml-convert-command
14002 #+vindex: org-latex-to-mathml-jar-file
14003 You can specify the LaTeX-to-MathML converter by customizing the
14004 variables ~org-latex-to-mathml-convert-command~ and
14005 ~org-latex-to-mathml-jar-file~.
14007 If you prefer to use MathToWeb[fn:126] as your converter, you can
14008 configure the above variables as shown below.
14010 #+begin_src emacs-lisp
14011 (setq org-latex-to-mathml-convert-command
14012 "java -jar %j -unicode -force -df %o %I"
14013 org-latex-to-mathml-jar-file
14014 "/path/to/mathtoweb.jar")
14017 To use LaTeXML[fn:127] use
14019 #+begin_src emacs-lisp
14020 (setq org-latex-to-mathml-convert-command
14021 "latexmlmath \"%i\" --presentationmathml=%o")
14024 To quickly verify the reliability of the LaTeX-to-MathML
14025 converter, use the following commands:
14027 - {{{kbd(M-x org-export-as-odf)}}} ::
14029 Convert a LaTeX math snippet to an OpenDocument formula
14032 - {{{kbd(M-x org-export-as-odf-and-open)}}} ::
14034 Convert a LaTeX math snippet to an OpenDocument formula
14035 (=.odf=) file and open the formula file with the
14036 system-registered application.
14042 #+cindex: ImageMagick
14043 Add this line to the Org file. This option is activated on
14046 : #+OPTIONS: tex:dvipng
14048 : #+OPTIONS: tex:dvisvgm
14050 #+texinfo: @noindent
14053 : #+OPTIONS: tex:imagemagick
14055 Under this option, LaTeX fragments are processed into PNG or SVG
14056 images and the resulting images are embedded in the exported
14057 document. This method requires dvipng program, dvisvgm or
14058 ImageMagick programs.
14060 **** MathML and OpenDocument formula files
14062 :DESCRIPTION: Embedding in native format.
14065 When embedding LaTeX math snippets in ODT documents is not reliable,
14066 there is one more option to try. Embed an equation by linking to its
14067 MathML (=.mml=) source or its OpenDocument formula (=.odf=) file as
14070 : [[./equation.mml]]
14072 #+texinfo: @noindent
14075 : [[./equation.odf]]
14077 *** Labels and captions in ODT export
14079 :DESCRIPTION: Rendering objects.
14082 ODT format handles labeling and captioning of objects based on their
14083 types. Inline images, tables, LaTeX fragments, and Math formulas are
14084 numbered and captioned separately. Each object also gets a unique
14085 sequence number based on its order of first appearance in the Org
14086 file. Each category has its own sequence. A caption is just a label
14087 applied to these objects.
14090 ,#+CAPTION: Bell curve
14091 ,#+NAME: fig:SED-HR4049
14095 When rendered, it may show as follows in the exported document:
14097 : Figure 2: Bell curve
14099 #+vindex: org-odt-category-map-alist
14100 To modify the category component of the caption, customize the option
14101 ~org-odt-category-map-alist~. For example, to tag embedded images
14102 with the string "Illustration" instead of the default string "Figure",
14103 use the following setting:
14105 #+begin_src emacs-lisp
14106 (setq org-odt-category-map-alist
14107 '(("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
14110 With the above modification, the previous example changes to:
14112 : Illustration 2: Bell curve
14114 *** Literal examples in ODT export
14116 :DESCRIPTION: For source code and example blocks.
14119 The ODT export back-end supports literal examples (see [[*Literal
14120 Examples]]) with full fontification. Internally, the ODT export
14121 back-end relies on =htmlfontify.el= to generate the style definitions
14122 needed for fancy listings. The auto-generated styles get =OrgSrc=
14123 prefix and inherit colors from the faces used by Emacs Font Lock
14124 library for that source language.
14126 #+vindex: org-odt-fontify-srcblocks
14127 For custom fontification styles, customize the
14128 ~org-odt-create-custom-styles-for-srcblocks~ option.
14130 #+vindex: org-odt-create-custom-styles-for-srcblocks
14131 To turn off fontification of literal examples, customize the
14132 ~org-odt-fontify-srcblocks~ option.
14134 *** Advanced topics in ODT export
14136 :DESCRIPTION: For power users.
14139 The ODT export back-end has extensive features useful for power users
14140 and frequent uses of ODT formats.
14142 **** Configuring a document converter
14144 :DESCRIPTION: Registering a document converter.
14148 #+cindex: doc, docx, rtf
14149 #+cindex: converter
14151 The ODT export back-end works with popular converters with little or
14152 no extra configuration. See [[*Extending ODT export]]. The following is
14153 for unsupported converters or tweaking existing defaults.
14155 - Register the converter ::
14157 #+vindex: org-export-odt-convert-processes
14158 Add the name of the converter to the ~org-odt-convert-processes~
14159 variable. Note that it also requires how the converter is
14160 invoked on the command line. See the variable's docstring for
14163 - Configure its capabilities ::
14165 #+vindex: org-export-odt-convert-capabilities
14166 Specify which formats the converter can handle by customizing the
14167 variable ~org-odt-convert-capabilities~. Use the entry for the
14168 default values in this variable for configuring the new
14169 converter. Also see its docstring for details.
14171 - Choose the converter ::
14173 #+vindex: org-export-odt-convert-process
14174 Select the newly added converter as the preferred one by
14175 customizing the option ~org-odt-convert-process~.
14177 **** Working with OpenDocument style files
14179 :DESCRIPTION: Exploring internals.
14182 #+cindex: styles, custom
14183 #+cindex: template, custom
14185 This section explores the internals of the ODT exporter; the means by which
14186 it produces styled documents; the use of automatic and custom OpenDocument
14189 The ODT exporter relies on two files for generating its output. These
14190 files are bundled with the distribution under the directory pointed to
14191 by the variable ~org-odt-styles-dir~. The two files are:
14193 - =OrgOdtStyles.xml= <<x-orgodtstyles-xml>> ::
14195 This file contributes to the =styles.xml= file of the final ODT
14196 document. This file gets modified for the following purposes:
14198 1. To control outline numbering based on user settings;
14200 2. To add styles generated by =htmlfontify.el= for fontification of
14203 - =OrgOdtContentTemplate.xml= <<x-orgodtcontenttemplate-xml>> ::
14205 This file contributes to the =content.xml= file of the final ODT
14206 document. The contents of the Org outline are inserted between the
14207 =<office:text>= ... =</office:text>= elements of this file.
14209 Apart from serving as a template file for the final =content.xml=,
14210 the file serves the following purposes:
14212 1. It contains automatic styles for formatting of tables which are
14213 referenced by the exporter;
14215 2. It contains =<text:sequence-decl>= ... =</text:sequence-decl>=
14216 elements that control numbering of tables, images, equations, and
14219 <<x-overriding-factory-styles>> The following two variables control
14220 the location from where the ODT exporter picks up the custom styles
14221 and content template files. Customize these variables to override the
14222 factory styles used by the exporter.
14224 - ~org-odt-styles-file~ ::
14226 The ODT export back-end uses the file pointed to by this
14227 variable, such as =styles.xml=, for the final output. It can
14228 take one of the following values:
14232 Use this file instead of the default =styles.xml=
14234 - =FILE.odt= or =FILE.ott= ::
14236 Use the =styles.xml= contained in the specified OpenDocument
14237 Text or Template file
14239 - =FILE.odt= or =FILE.ott= and a subset of included files ::
14241 Use the =styles.xml= contained in the specified OpenDocument
14242 Text or Template file. Additionally extract the specified
14243 member files and embed those within the final ODT document.
14245 Use this option if the =styles.xml= file references additional
14246 files like header and footer images.
14250 Use the default =styles.xml=.
14252 - ~org-odt-content-template-file~ ::
14254 Use this variable to specify the blank =content.xml= used in the
14257 **** Creating one-off styles
14259 :DESCRIPTION: Customizing styles, highlighting...
14263 The ODT export back-end can read embedded raw OpenDocument XML from
14264 the Org file. Such direct formatting is useful for one-off instances.
14266 - Embedding ODT tags as part of regular text ::
14268 Enclose OpenDocument syntax in =@@odt:...@@= for inline markup.
14269 For example, to highlight a region of text do the following:
14272 @@odt:<text:span text:style-name="Highlight">This is highlighted
14273 text</text:span>@@. But this is regular text.
14276 *Hint:* To see the above example in action, edit the =styles.xml=
14277 (see [[x-orgodtstyles-xml][Factory styles]]) and add a custom /Highlight/ style as shown
14281 <style:style style:name="Highlight" style:family="text">
14282 <style:text-properties fo:background-color="#ff0000"/>
14286 - Embedding a one-line OpenDocument XML ::
14288 #+cindex: @samp{ODT}, keyword
14289 The ODT export back-end can read one-liner options with =#+ODT:=
14290 in the Org file. For example, to force a page break:
14293 ,#+ODT: <text:p text:style-name="PageBreak"/>
14296 *Hint:* To see the above example in action, edit your
14297 =styles.xml= (see [[x-orgodtstyles-xml][Factory styles]]) and add a custom =PageBreak=
14298 style as shown below.
14301 <style:style style:name="PageBreak" style:family="paragraph"
14302 style:parent-style-name="Text_20_body">
14303 <style:paragraph-properties fo:break-before="page"/>
14307 - Embedding a block of OpenDocument XML ::
14309 The ODT export back-end can also read ODT export blocks for
14310 OpenDocument XML. Such blocks use the =#+BEGIN_EXPORT odt=
14311 ... =#+END_EXPORT= constructs.
14313 For example, to create a one-off paragraph that uses bold text,
14317 ,#+BEGIN_EXPORT odt
14318 <text:p text:style-name="Text_20_body_20_bold">
14319 This paragraph is specially formatted and uses bold text.
14324 **** Customizing tables in ODT export
14326 :DESCRIPTION: Defining table templates.
14329 #+cindex: tables, in ODT export
14330 #+cindex: @samp{ATTR_ODT}, keyword
14332 Override the default table format by specifying a custom table style
14333 with the =#+ATTR_ODT= line. For a discussion on default formatting of
14334 tables, see [[*Tables in ODT export]].
14336 This feature closely mimics the way table templates are defined in the
14337 OpenDocument-v1.2 specification.[fn:128]
14339 #+vindex: org-odt-table-styles
14340 For quick preview of this feature, install the settings below and export the
14341 table that follows:
14343 #+begin_src emacs-lisp
14344 (setq org-export-odt-table-styles
14345 (append org-export-odt-table-styles
14346 '(("TableWithHeaderRowAndColumn" "Custom"
14347 ((use-first-row-styles . t)
14348 (use-first-column-styles . t)))
14349 ("TableWithFirstRowandLastRow" "Custom"
14350 ((use-first-row-styles . t)
14351 (use-last-row-styles . t))))))
14355 ,#+ATTR_ODT: :style TableWithHeaderRowAndColumn
14356 | Name | Phone | Age |
14357 | Peter | 1234 | 17 |
14358 | Anna | 4321 | 25 |
14361 The example above used =Custom= template and installed two table
14362 styles =TableWithHeaderRowAndColumn= and
14363 =TableWithFirstRowandLastRow=. *Important:* The OpenDocument styles
14364 needed for producing the above template were pre-defined. They are
14365 available in the section marked =Custom Table Template= in
14366 =OrgOdtContentTemplate.xml= (see [[x-orgodtcontenttemplate-xml][Factory styles]]). For adding new
14367 templates, define new styles there.
14369 To use this feature proceed as follows:
14371 1. Create a table template[fn:129].
14373 A table template is set of =table-cell= and =paragraph= styles for
14374 each of the following table cell categories:
14386 The names for the above styles must be chosen based on the name of
14387 the table template using a well-defined convention.
14389 The naming convention is better illustrated with an example. For
14390 a table template with the name =Custom=, the needed style names are
14391 listed in the following table.
14393 | Cell type | Cell style | Paragraph style |
14394 |--------------+------------------------------+-----------------------------------|
14395 | Body | =CustomTableCell= | =CustomTableParagraph= |
14396 | First column | =CustomFirstColumnTableCell= | =CustomFirstColumnTableParagraph= |
14397 | Last column | =CustomLastColumnTableCell= | =CustomLastColumnTableParagraph= |
14398 | First row | =CustomFirstRowTableCell= | =CustomFirstRowTableParagraph= |
14399 | Last row | =CustomLastRowTableCell= | =CustomLastRowTableParagraph= |
14400 | Even row | =CustomEvenRowTableCell= | =CustomEvenRowTableParagraph= |
14401 | Odd row | =CustomOddRowTableCell= | =CustomOddRowTableParagraph= |
14402 | Even column | =CustomEvenColumnTableCell= | =CustomEvenColumnTableParagraph= |
14403 | Odd column | =CustomOddColumnTableCell= | =CustomOddColumnTableParagraph= |
14405 To create a table template with the name =Custom=, define the above
14406 styles in the =<office:automatic-styles>= ...
14407 =</office:automatic-styles>= element of the content template file
14408 (see [[x-orgodtcontenttemplate-xml][Factory styles]]).
14410 2. Define a table style[fn:130].
14412 #+vindex: org-odt-table-styles
14413 To define a table style, create an entry for the style in the
14414 variable ~org-odt-table-styles~ and specify the following:
14416 - the name of the table template created in step (1),
14417 - the set of cell styles in that template that are to be activated.
14419 For example, the entry below defines two different table styles
14420 =TableWithHeaderRowAndColumn= and =TableWithFirstRowandLastRow=
14421 based on the same template =Custom=. The styles achieve their
14422 intended effect by selectively activating the individual cell
14423 styles in that template.
14425 #+begin_src emacs-lisp
14426 (setq org-export-odt-table-styles
14427 (append org-export-odt-table-styles
14428 '(("TableWithHeaderRowAndColumn" "Custom"
14429 ((use-first-row-styles . t)
14430 (use-first-column-styles . t)))
14431 ("TableWithFirstRowandLastRow" "Custom"
14432 ((use-first-row-styles . t)
14433 (use-last-row-styles . t))))))
14436 3. Associate a table with the table style.
14438 To do this, specify the table style created in step (2) as part of
14439 the =ATTR_ODT= line as shown below.
14442 ,#+ATTR_ODT: :style TableWithHeaderRowAndColumn
14443 | Name | Phone | Age |
14444 | Peter | 1234 | 17 |
14445 | Anna | 4321 | 25 |
14448 **** Validating OpenDocument XML
14450 :DESCRIPTION: Debugging corrupted OpenDocument files.
14454 Sometimes ODT format files may not open due to =.odt= file corruption.
14455 To verify if such a file is corrupt, validate it against the
14456 OpenDocument Relax NG Compact (RNC) syntax schema. But first the
14457 =.odt= files have to be decompressed using =zip=. Note that =.odt=
14458 files are ZIP archives: [[info:emacs::File Archives]]. The contents of
14459 ODT files are in XML. For general help with validation---and
14460 schema-sensitive editing---of XML files:
14461 [[info:nxml-mode::Introduction]].
14463 #+vindex: org-export-odt-schema-dir
14464 Customize ~org-odt-schema-dir~ to point to a directory with
14465 OpenDocument RNC files and the needed schema-locating rules. The ODT
14466 export back-end takes care of updating the
14467 ~rng-schema-locating-files~.
14471 :DESCRIPTION: Exporting to Org.
14474 #+cindex: Org export
14475 /org/ export back-end creates a normalized version of the Org document
14476 in current buffer. The exporter evaluates Babel code (see [[*Evaluating
14477 Code Blocks]]) and removes content specific to other back-ends.
14479 *** Org export commands
14484 - {{{kbd(C-c C-e O o)}}} (~org-org-export-to-org~) ::
14486 #+kindex: C-c C-e O o
14487 #+findex: org-org-export-to-org
14488 Export as an Org file with a =.org= extension. For =myfile.org=,
14489 Org exports to =myfile.org.org=, overwriting without warning.
14491 - {{{kbd(C-c C-e O v)}}} (~~) ::
14493 #+kindex: C-c C-e O v
14494 Export to an Org file, then open it.
14498 :DESCRIPTION: Exporting to Texinfo.
14501 *** Texinfo export commands
14503 :DESCRIPTION: Invoking commands.
14506 - {{{kbd(C-c C-e i t)}}} (~org-texinfo-export-to-texinfo~) ::
14508 #+kindex: C-c C-e i t
14509 #+findex: org-texinfo-export-to-texinfo
14510 Export as a Texinfo file with =.texi= extension. For
14511 =myfile.org=, Org exports to =myfile.texi=, overwriting without
14514 - {{{kbd(C-c C-e i i)}}} (~org-texinfo-export-to-info~) ::
14516 #+kindex: C-c C-e i i
14517 #+findex: org-texinfo-export-to-info
14518 #+vindex: org-texinfo-info-process
14519 Export to Texinfo format first and then process it to make an
14520 Info file. To generate other formats, such as DocBook, customize
14521 the ~org-texinfo-info-process~ variable.
14523 *** Texinfo specific export settings
14525 :DESCRIPTION: Setting the environment.
14528 The Texinfo export back-end has several additional keywords for
14529 customizing Texinfo output. Setting these keywords works similar to
14530 the general options (see [[*Export Settings]]).
14534 #+cindex: @samp{SUBTITLE}, keyword
14535 The document subtitle.
14539 #+cindex: @samp{SUBAUTHOR}, keyword
14540 Additional authors for the document.
14542 - =TEXINFO_FILENAME= ::
14544 #+cindex: @samp{TEXINFO_FILENAME}, keyword
14545 The Texinfo filename.
14547 - =TEXINFO_CLASS= ::
14549 #+cindex: @samp{TEXINFO_CLASS}, keyword
14550 #+vindex: org-texinfo-default-class
14551 The default document class (~org-texinfo-default-class~), which
14552 must be a member of ~org-texinfo-classes~.
14554 - =TEXINFO_HEADER= ::
14556 #+cindex: @samp{TEXINFO_HEADER}, keyword
14557 Arbitrary lines inserted at the end of the header.
14559 - =TEXINFO_POST_HEADER= ::
14561 #+cindex: @samp{TEXINFO_POST_HEADER}, keyword
14562 Arbitrary lines inserted after the end of the header.
14564 - =TEXINFO_DIR_CATEGORY= ::
14566 #+cindex: @samp{TEXINFO_DIR_CATEGORY}, keyword
14567 The directory category of the document.
14569 - =TEXINFO_DIR_TITLE= ::
14571 #+cindex: @samp{TEXINFO_DIR_TITLE}, keyword
14572 The directory title of the document.
14574 - =TEXINFO_DIR_DESC= ::
14576 #+cindex: @samp{TEXINFO_DIR_DESC}, keyword
14577 The directory description of the document.
14579 - =TEXINFO_PRINTED_TITLE= ::
14581 #+cindex: @samp{TEXINFO_PRINTED_TITLE}, keyword
14582 The printed title of the document.
14584 *** Texinfo file header
14586 :DESCRIPTION: Generating the header.
14589 #+cindex: @samp{TEXINFO_FILENAME}, keyword
14590 After creating the header for a Texinfo file, the Texinfo back-end
14591 automatically generates a name and destination path for the Info file.
14592 To override this default with a more sensible path and name, specify
14593 the =TEXINFO_FILENAME= keyword.
14595 #+vindex: org-texinfo-coding-system
14596 #+cindex: @samp{TEXINFO_HEADER}, keyword
14597 Along with the output's file name, the Texinfo header also contains
14598 language details (see [[*Export Settings]]) and encoding system as set in
14599 the ~org-texinfo-coding-system~ variable. Insert =TEXINFO_HEADER=
14600 keywords for each additional command in the header, for example:
14602 : #+TEXINFO_HEADER: @synindex
14604 #+cindex: @samp{TEXINFO_CLASS}, keyword
14605 #+vindex: org-texinfo-classes
14606 Instead of repeatedly installing the same set of commands, define
14607 a class in ~org-texinfo-classes~ once, and then activate it in the
14608 document by setting the =TEXINFO_CLASS= keyword to that class.
14610 *** Texinfo title and copyright page
14612 :DESCRIPTION: Creating preamble pages.
14615 #+cindex: @samp{TEXINFO_PRINTED_TITLE}, keyword
14616 The default template for hard copy output has a title page with
14617 =TITLE= and =AUTHOR= keywords (see [[*Export Settings]]). To replace the
14618 regular title with something different for the printed version, use
14619 the =TEXINFO_PRINTED_TITLE= and =SUBTITLE= keywords. Both expect raw
14620 Texinfo code for setting their values.
14622 #+cindex: @samp{SUBAUTHOR}, keyword
14623 If one =AUTHOR= line is not sufficient, add multiple =SUBAUTHOR=
14624 keywords. They have to be set in raw Texinfo code.
14627 ,#+AUTHOR: Jane Smith
14628 ,#+SUBAUTHOR: John Doe
14629 ,#+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt{tex,@*} Is Broken in @TeX{}
14632 #+cindex: @samp{COPYING}, property
14633 Copying material is defined in a dedicated headline with a non-~nil~
14634 =COPYING= property. The back-end inserts the contents within
14635 a =@copying= command at the beginning of the document. The heading
14636 itself does not appear in the structure of the document.
14638 Copyright information is printed on the back of the title page.
14646 This is a short example of a complete Texinfo file, version 1.0.
14648 Copyright \copy 2016 Free Software Foundation, Inc.
14651 *** Info directory file
14653 :DESCRIPTION: Installing a manual in Info file hierarchy.
14656 #+cindex: @samp{dir} file, in Texinfo export
14657 #+cindex: Info directory file, in Texinfo export
14658 #+cindex: @code{install-info}, in Texinfo export
14660 #+cindex: @samp{TEXINFO_DIR_CATEGORY}, keyword
14661 #+cindex: @samp{TEXINFO_DIR_TITLE}, keyword
14662 #+cindex: @samp{TEXINFO_DIR_DESC}, keyword
14663 The end result of the Texinfo export process is the creation of an
14664 Info file. This Info file's metadata has variables for category,
14665 title, and description: =TEXINFO_DIR_CATEGORY=, =TEXINFO_DIR_TITLE=,
14666 and =TEXINFO_DIR_DESC= keywords that establish where in the Info
14667 hierarchy the file fits.
14669 Here is an example that writes to the Info directory file:
14672 ,#+TEXINFO_DIR_CATEGORY: Emacs
14673 ,#+TEXINFO_DIR_TITLE: Org Mode: (org)
14674 ,#+TEXINFO_DIR_DESC: Outline-based notes management and organizer
14677 *** Headings and sectioning structure
14679 :DESCRIPTION: Building document structure.
14682 #+vindex: org-texinfo-classes
14683 #+vindex: org-texinfo-default-class
14684 #+cindex: @samp{TEXINFO_CLASS}, keyword
14685 The Texinfo export back-end uses a pre-defined scheme to convert Org
14686 headlines to equivalent Texinfo structuring commands. A scheme like
14687 this maps top-level headlines to numbered chapters tagged as
14688 ~@chapter~ and lower-level headlines to unnumbered chapters tagged as
14689 ~@unnumbered~. To override such mappings to introduce ~@part~ or
14690 other Texinfo structuring commands, define a new class in
14691 ~org-texinfo-classes~. Activate the new class with the
14692 =TEXINFO_CLASS= keyword. When no new class is defined and activated,
14693 the Texinfo export back-end defaults to the
14694 ~org-texinfo-default-class~.
14696 If an Org headline's level has no associated Texinfo structuring
14697 command, or is below a certain threshold (see [[*Export Settings]]), then
14698 the Texinfo export back-end makes it into a list item.
14700 #+cindex: @samp{APPENDIX}, property
14701 The Texinfo export back-end makes any headline with a non-~nil~
14702 =APPENDIX= property into an appendix. This happens independent of the
14703 Org headline level or the =TEXINFO_CLASS= keyword.
14705 #+cindex: @samp{ALT_TITLE}, property
14706 #+cindex: @samp{DESCRIPTION}, property
14707 The Texinfo export back-end creates a menu entry after the Org
14708 headline for each regular sectioning structure. To override this with
14709 a shorter menu entry, use the =ALT_TITLE= property (see [[*Table of
14710 Contents]]). Texinfo menu entries also have an option for a longer
14711 =DESCRIPTION= property. Here's an example that uses both to override
14712 the default menu entry:
14715 ,* Controlling Screen Display
14717 :ALT_TITLE: Display
14718 :DESCRIPTION: Controlling Screen Display
14722 #+cindex: Top node, in Texinfo export
14723 The text before the first headline belongs to the /Top/ node, i.e.,
14724 the node in which a reader enters an Info manual. As such, it is
14725 expected not to appear in printed output generated from the =.texi=
14726 file. See [[info:texinfo::The%20Top%20Node]], for more information.
14730 :DESCRIPTION: Creating indices.
14733 #+cindex: @samp{CINDEX}, keyword
14734 #+cindex: concept index, in Texinfo export
14735 #+cindex: @samp{FINDEX}, keyword
14736 #+cindex: function index, in Texinfo export
14737 #+cindex: @samp{KINDEX}, keyword
14738 #+cindex: keystroke index, in Texinfo export
14739 #+cindex: @samp{PINDEX}, keyword
14740 #+cindex: program index, in Texinfo export
14741 #+cindex: @samp{TINDEX}, keyword
14742 #+cindex: data type index, in Texinfo export
14743 #+cindex: @samp{VINDEX}, keyword
14744 #+cindex: variable index, in Texinfo export
14745 The Texinfo export back-end recognizes these indexing keywords if used
14746 in the Org file: =CINDEX=, =FINDEX=, =KINDEX=, =PINDEX=, =TINDEX= and
14747 =VINDEX=. Write their value as verbatim Texinfo code; in particular,
14748 ={=, =}= and =@= characters need to be escaped with =@= if they do not
14749 belong to a Texinfo command.
14751 : #+CINDEX: Defining indexing entries
14753 #+cindex: @samp{INDEX}, property
14754 For the back-end to generate an index entry for a headline, set the
14755 =INDEX= property to =cp= or =vr=. These abbreviations come from
14756 Texinfo that stand for concept index and variable index. The Texinfo
14757 manual has abbreviations for all other kinds of indexes. The back-end
14758 exports the headline as an unnumbered chapter or section command, and
14759 then inserts the index after its contents.
14768 *** Quoting Texinfo code
14770 :DESCRIPTION: Incorporating literal Texinfo code.
14773 Use any of the following three methods to insert or escape raw Texinfo
14776 #+cindex: @samp{TEXINFO}, keyword
14777 #+cindex: @samp{BEGIN_EXPORT texinfo}
14779 Richard @@texinfo:@sc{@@Stallman@@texinfo:}@@ commence' GNU.
14781 ,#+TEXINFO: @need800
14782 This paragraph is preceded by...
14784 ,#+BEGIN_EXPORT texinfo
14785 @auindex Johnson, Mark
14786 @auindex Lakoff, George
14790 *** Plain lists in Texinfo export
14792 :DESCRIPTION: List attributes.
14795 #+cindex: @samp{ATTR_TEXINFO}, keyword
14796 #+cindex: two-column tables, in Texinfo export
14798 #+cindex: table types, in Texinfo export
14799 The Texinfo export back-end by default converts description lists in
14800 the Org file using the default command =@table=, which results in
14801 a table with two columns. To change this behavior, specify
14802 =:table-type= with =ftable= or =vtable= attributes. For more
14803 information, see [[info:texinfo::Two-column Tables]].
14805 #+vindex: org-texinfo-table-default-markup
14806 The Texinfo export back-end by default also applies a text highlight
14807 based on the defaults stored in ~org-texinfo-table-default-markup~.
14808 To override the default highlight command, specify another one with
14809 the =:indic= attribute.
14811 #+cindex: multiple items in Texinfo lists
14812 Org syntax is limited to one entry per list item. Nevertheless, the
14813 Texinfo export back-end can split that entry according to any text
14814 provided through the =:sep= attribute. Each part then becomes a new
14815 entry in the first column of the table.
14817 The following example illustrates all the attributes above:
14820 ,#+ATTR_TEXINFO: :table-type vtable :sep , :indic asis
14821 - foo, bar :: This is the common text for variables foo and bar.
14824 #+texinfo: @noindent
14831 This is the common text for variables foo and bar.
14835 *** Tables in Texinfo export
14837 :DESCRIPTION: Table attributes.
14840 #+cindex: @samp{ATTR_TEXINFO}, keyword
14841 When exporting tables, the Texinfo export back-end uses the widest
14842 cell width in each column. To override this and instead specify as
14843 fractions of line length, use the =:columns= attribute. See example
14847 ,#+ATTR_TEXINFO: :columns .5 .5
14848 | a cell | another cell |
14851 *** Images in Texinfo export
14853 :DESCRIPTION: Image attributes.
14856 #+cindex: @samp{ATTR_TEXINFO}, keyword
14857 Insert a file link to the image in the Org file, and the Texinfo
14858 export back-end inserts the image. These links must have the usual
14859 supported image extensions and no descriptions. To scale the image,
14860 use =:width= and =:height= attributes. For alternate text, use =:alt=
14861 and specify the text using Texinfo code, as shown in the example:
14864 ,#+ATTR_TEXINFO: :width 1in :alt Alternate @i{text}
14868 *** Special blocks in Texinfo export
14870 :DESCRIPTION: Special block attributes.
14873 #+cindex: @samp{ATTR_TEXINFO}, keyword
14875 The Texinfo export back-end converts special blocks to commands with
14876 the same name. It also adds any =:options= attributes to the end of
14877 the command, as shown in this example:
14880 ,#+ATTR_TEXINFO: :options org-org-export-to-org ...
14882 A somewhat obsessive function name.
14886 #+texinfo: @noindent
14890 @defun org-org-export-to-org ...
14891 A somewhat obsessive function name.
14895 *** A Texinfo example
14897 :DESCRIPTION: Processing Org to Texinfo.
14900 Here is a more detailed example Org file. See
14901 [[info:texinfo::GNU%20Sample%20Texts]] for an equivalent example using
14905 ,#+TITLE: GNU Sample {{{version}}}
14906 ,#+SUBTITLE: for version {{{version}}}, {{{updated}}}
14907 ,#+AUTHOR: A.U. Thor
14908 ,#+EMAIL: bug-sample@gnu.org
14910 ,#+OPTIONS: ':t toc:t author:t email:t
14913 ,#+MACRO: version 2.0
14914 ,#+MACRO: updated last updated 4 March 2014
14916 ,#+TEXINFO_FILENAME: sample.info
14917 ,#+TEXINFO_HEADER: @syncodeindex pg cp
14919 ,#+TEXINFO_DIR_CATEGORY: Texinfo documentation system
14920 ,#+TEXINFO_DIR_TITLE: sample: (sample)
14921 ,#+TEXINFO_DIR_DESC: Invoking sample
14923 ,#+TEXINFO_PRINTED_TITLE: GNU Sample
14925 This manual is for GNU Sample (version {{{version}}},
14933 This manual is for GNU Sample (version {{{version}}},
14934 {{{updated}}}), which is an example in the Texinfo documentation.
14936 Copyright \copy 2016 Free Software Foundation, Inc.
14939 Permission is granted to copy, distribute and/or modify this
14940 document under the terms of the GNU Free Documentation License,
14941 Version 1.3 or any later version published by the Free Software
14942 Foundation; with no Invariant Sections, with no Front-Cover Texts,
14943 and with no Back-Cover Texts. A copy of the license is included in
14944 the section entitled "GNU Free Documentation License".
14950 ,#+CINDEX: invoking @command{sample}
14952 This is a sample manual. There is no sample program to invoke, but
14953 if there were, you could see its basic usage and command line
14956 ,* GNU Free Documentation License
14961 ,#+TEXINFO: @include fdl.texi
14969 ** iCalendar Export
14971 :DESCRIPTION: Exporting to iCalendar.
14973 #+cindex: iCalendar export
14975 A large part of Org mode's interoperability success is its ability to
14976 easily export to or import from external applications. The iCalendar
14977 export back-end takes calendar data from Org files and exports to the
14978 standard iCalendar format.
14980 #+vindex: org-icalendar-include-todo
14981 #+vindex: org-icalendar-use-deadline
14982 #+vindex: org-icalendar-use-scheduled
14983 The iCalendar export back-end can also incorporate TODO entries based
14984 on the configuration of the ~org-icalendar-include-todo~ variable.
14985 The back-end exports plain timestamps as =VEVENT=, TODO items as
14986 =VTODO=, and also create events from deadlines that are in non-TODO
14987 items. The back-end uses the deadlines and scheduling dates in Org
14988 TODO items for setting the start and due dates for the iCalendar TODO
14989 entry. Consult the ~org-icalendar-use-deadline~ and
14990 ~org-icalendar-use-scheduled~ variables for more details.
14992 #+vindex: org-icalendar-categories
14993 #+vindex: org-icalendar-alarm-time
14994 For tags on the headline, the iCalendar export back-end makes them
14995 into iCalendar categories. To tweak the inheritance of tags and TODO
14996 states, configure the variable ~org-icalendar-categories~. To assign
14997 clock alarms based on time, configure the ~org-icalendar-alarm-time~
15000 #+vindex: org-icalendar-store-UID
15001 #+cindex: @samp{ID}, property
15002 The iCalendar format standard requires globally unique identifier---or
15003 UID---for each entry. The iCalendar export back-end creates UIDs
15004 during export. To save a copy of the UID in the Org file set the
15005 variable ~org-icalendar-store-UID~. The back-end looks for the =ID=
15006 property of the entry for re-using the same UID for subsequent
15009 Since a single Org entry can result in multiple iCalendar
15010 entries---timestamp, deadline, scheduled item, or TODO item---Org adds
15011 prefixes to the UID, depending on which part of the Org entry
15012 triggered the creation of the iCalendar entry. Prefixing ensures UIDs
15013 remains unique, yet enable synchronization programs trace the
15016 - {{{kbd(C-c C-e c f)}}} (~org-icalendar-export-to-ics~) ::
15018 #+kindex: C-c C-e c f
15019 #+findex: org-icalendar-export-to-ics
15020 Create iCalendar entries from the current Org buffer and store
15021 them in the same directory, using a file extension =.ics=.
15023 - {{{kbd(C-c C-e c a)}}} (~org-icalendar-export-agenda-files~) ::
15025 #+kindex: C-c C-e c a
15026 #+findex: org-icalendar-export-agenda-files
15027 Create iCalendar entries from Org files in ~org-agenda-files~ and
15028 store in a separate iCalendar file for each Org file.
15030 - {{{kbd(C-c C-e c c)}}} (~org-icalendar-combine-agenda-files~) ::
15032 #+kindex: C-c C-e c c
15033 #+findex: org-icalendar-combine-agenda-files
15034 #+vindex: org-icalendar-combined-agenda-file
15035 Create a combined iCalendar file from Org files in
15036 ~org-agenda-files~ and write it to
15037 ~org-icalendar-combined-agenda-file~ file name.
15039 #+cindex: @samp{SUMMARY}, property
15040 #+cindex: @samp{DESCRIPTION}, property
15041 #+cindex: @samp{LOCATION}, property
15042 #+cindex: @samp{TIMEZONE}, property
15043 The iCalendar export back-end includes =SUMMARY=, =DESCRIPTION=,
15044 =LOCATION= and =TIMEZONE= properties from the Org entries when
15045 exporting. To force the back-end to inherit the =LOCATION= and
15046 =TIMEZONE= properties, configure the ~org-use-property-inheritance~
15049 #+vindex: org-icalendar-include-body
15050 When Org entries do not have =SUMMARY=, =DESCRIPTION= and =LOCATION=
15051 properties, the iCalendar export back-end derives the summary from the
15052 headline, and derives the description from the body of the Org item.
15053 The ~org-icalendar-include-body~ variable limits the maximum number of
15054 characters of the content are turned into its description.
15056 The =TIMEZONE= property can be used to specify a per-entry time zone,
15057 and is applied to any entry with timestamp information. Time zones
15058 should be specified as per the IANA time zone database format, e.g.,
15059 =Asia/Almaty=. Alternately, the property value can be =UTC=, to force
15060 UTC time for this entry only.
15062 Exporting to iCalendar format depends in large part on the
15063 capabilities of the destination application. Some are more lenient
15064 than others. Consult the Org mode FAQ for advice on specific
15067 ** Other Built-in Back-ends
15069 :DESCRIPTION: Exporting to a man page.
15072 Other export back-ends included with Org are:
15074 - =ox-man.el=: Export to a man page.
15076 To activate such back-ends, either customize ~org-export-backends~ or
15077 load directly with ~(require 'ox-man)~. On successful load, the
15078 back-end adds new keys in the export dispatcher (see [[*The Export
15081 Follow the comment section of such files, for example, =ox-man.el=,
15082 for usage and configuration details.
15084 ** Advanced Configuration
15086 :DESCRIPTION: Fine-tuning the export output.
15094 #+vindex: org-export-before-processing-hook
15095 #+vindex: org-export-before-parsing-hook
15096 The export process executes two hooks before the actual exporting
15097 begins. The first hook, ~org-export-before-processing-hook~, runs
15098 before any expansions of macros, Babel code, and include keywords in
15099 the buffer. The second hook, ~org-export-before-parsing-hook~, runs
15100 before the buffer is parsed.
15102 Functions added to these hooks are called with a single argument: the
15103 export back-end actually used, as a symbol. You may use them for
15104 heavy duty structural modifications of the document. For example, you
15105 can remove every headline in the buffer during export like this:
15107 #+begin_src emacs-lisp
15108 (defun my-headline-removal (backend)
15109 "Remove all headlines in the current buffer.
15110 BACKEND is the export back-end being used, as a symbol."
15112 (lambda () (delete-region (point) (line-beginning-position 2)))))
15114 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
15122 #+cindex: Filters, exporting
15123 Filters are lists of functions to be applied to certain parts for
15124 a given back-end. The output from the first function in the filter is
15125 passed on to the next function in the filter. The final output is the
15126 output from the final function in the filter.
15128 The Org export process has many filter sets applicable to different
15129 types of objects, plain text, parse trees, export options, and final
15130 output formats. The filters are named after the element type or
15131 object type: ~org-export-filter-TYPE-functions~, where {{{var(TYPE)}}}
15132 is the type targeted by the filter. Valid types are:
15134 #+attr_texinfo: :columns 0.33 0.33 0.33
15135 | body | bold | babel-call |
15136 | center-block | clock | code |
15137 | diary-sexp | drawer | dynamic-block |
15138 | entity | example-block | export-block |
15139 | export-snippet | final-output | fixed-width |
15140 | footnote-definition | footnote-reference | headline |
15141 | horizontal-rule | inline-babel-call | inline-src-block |
15142 | inlinetask | italic | item |
15143 | keyword | latex-environment | latex-fragment |
15144 | line-break | link | node-property |
15145 | options | paragraph | parse-tree |
15146 | plain-list | plain-text | planning |
15147 | property-drawer | quote-block | radio-target |
15148 | section | special-block | src-block |
15149 | statistics-cookie | strike-through | subscript |
15150 | superscript | table | table-cell |
15151 | table-row | target | timestamp |
15152 | underline | verbatim | verse-block |
15154 Here is an example filter that replaces non-breaking spaces ~ ~ in the
15155 Org buffer with =~= for the LaTeX back-end.
15157 #+begin_src emacs-lisp
15158 (defun my-latex-filter-nobreaks (text backend info)
15159 "Ensure \" \" are properly handled in LaTeX export."
15160 (when (org-export-derived-backend-p backend 'latex)
15161 (replace-regexp-in-string " " "~" text)))
15163 (add-to-list 'org-export-filter-plain-text-functions
15164 'my-latex-filter-nobreaks)
15167 A filter requires three arguments: the code to be transformed, the
15168 name of the back-end, and some optional information about the export
15169 process. The third argument can be safely ignored. Note the use of
15170 ~org-export-derived-backend-p~ predicate that tests for /latex/
15171 back-end or any other back-end, such as /beamer/, derived from
15174 *** Defining filters for individual files
15179 The Org export can filter not just for back-ends, but also for
15180 specific files through the =BIND= keyword. Here is an example with
15181 two filters; one removes brackets from time stamps, and the other
15182 removes strike-through text. The filter functions are defined in
15183 a code block in the same Org file, which is a handy location for
15187 ,#+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
15188 ,#+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
15189 ,#+BEGIN_SRC emacs-lisp :exports results :results none
15190 (defun tmp-f-timestamp (s backend info)
15191 (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
15192 (defun tmp-f-strike-through (s backend info) "")
15196 *** Extending an existing back-end
15201 Some parts of the conversion process can be extended for certain
15202 elements so as to introduce a new or revised translation. That is how
15203 the HTML export back-end was extended to handle Markdown format. The
15204 extensions work seamlessly so any aspect of filtering not done by the
15205 extended back-end is handled by the original back-end. Of all the
15206 export customization in Org, extending is very powerful as it operates
15207 at the parser level.
15209 For this example, make the /ascii/ back-end display the language used
15210 in a source code block. Also make it display only when some attribute
15211 is non-~nil~, like the following:
15213 : #+ATTR_ASCII: :language t
15215 Then extend ASCII back-end with a custom "my-ascii" back-end.
15217 #+begin_src emacs-lisp
15218 (defun my-ascii-src-block (src-block contents info)
15219 "Transcode a SRC-BLOCK element from Org to ASCII.
15220 CONTENTS is nil. INFO is a plist used as a communication
15222 (if (not (org-export-read-attribute :attr_ascii src-block :language))
15223 (org-export-with-backend 'ascii src-block contents info)
15225 (format ",--[ %s ]--\n%s`----"
15226 (org-element-property :language src-block)
15227 (replace-regexp-in-string
15229 (org-element-normalize-string
15230 (org-export-format-code-default src-block info)))))))
15232 (org-export-define-derived-backend 'my-ascii 'ascii
15233 :translate-alist '((src-block . my-ascii-src-block)))
15236 The ~my-ascii-src-block~ function looks at the attribute above the
15237 current element. If not true, hands over to /ascii/ back-end. If
15238 true, which it is in this example, it creates a box around the code
15239 and leaves room for the inserting a string for language. The last
15240 form creates the new back-end that springs to action only when
15241 translating ~src-block~ type elements.
15243 To use the newly defined back-end, evaluate the following from an Org
15246 #+begin_src emacs-lisp
15247 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
15250 Further steps to consider would be an interactive function,
15251 self-installing an item in the export dispatcher menu, and other
15252 user-friendly improvements.
15254 ** Export in Foreign Buffers
15256 :DESCRIPTION: Author tables and lists in Org syntax.
15259 The export back-ends in Org often include commands to convert selected
15260 regions. A convenient feature of this in-place conversion is that the
15261 exported output replaces the original source. Here are such
15264 - ~org-html-convert-region-to-html~ ::
15266 #+findex: org-html-convert-region-to-html
15267 Convert the selected region into HTML.
15269 - ~org-latex-convert-region-to-latex~ ::
15271 #+findex: org-latex-convert-region-to-latex
15272 Convert the selected region into LaTeX.
15274 - ~org-texinfo-convert-region-to-texinfo~ ::
15276 #+findex: org-texinfo-convert-region-to-texinfo
15277 Convert the selected region into Texinfo.
15279 - ~org-md-convert-region-to-md~ ::
15281 #+findex: org-md-convert-region-to-md
15282 Convert the selected region into Markdown.
15284 In-place conversions are particularly handy for quick conversion of
15285 tables and lists in foreign buffers. For example, turn on the minor
15286 mode {{{kbd(M-x orgstruct-mode)}}} in an HTML buffer, then use the
15287 convenient Org keyboard commands to create a list, select it, and
15288 covert it to HTML with {{{kbd(M-x org-html-convert-region-to-html)}}}.
15292 :DESCRIPTION: Create a web site of linked Org files.
15294 #+cindex: publishing
15296 Org includes a publishing management system that allows you to
15297 configure automatic HTML conversion of /projects/ composed of
15298 interlinked Org files. You can also configure Org to automatically
15299 upload your exported HTML pages and related attachments, such as
15300 images and source code files, to a web server.
15302 You can also use Org to convert files into PDF, or even combine HTML
15303 and PDF conversion so that files are available in both formats on the
15306 Publishing has been contributed to Org by David O'Toole.
15310 :DESCRIPTION: Defining projects.
15312 Publishing needs significant configuration to specify files,
15313 destination and many other properties of a project.
15315 *** The variable ~org-publish-project-alist~
15317 :DESCRIPTION: The central configuration variable.
15318 :ALT_TITLE: Project alist
15320 #+cindex: projects, for publishing
15322 #+vindex: org-publish-project-alist
15323 Publishing is configured almost entirely through setting the value of
15324 one variable, called ~org-publish-project-alist~. Each element of the
15325 list configures one project, and may be in one of the two following
15328 #+begin_src emacs-lisp
15329 ("project-name" :property value :property value ...)
15332 #+texinfo: @noindent
15333 i.e., a well-formed property list with alternating keys and values,
15336 #+begin_src emacs-lisp
15337 ("project-name" :components ("project-name" "project-name" ...))
15340 In both cases, projects are configured by specifying property values.
15341 A project defines the set of files that are to be published, as well
15342 as the publishing configuration to use when publishing those files.
15343 When a project takes the second form listed above, the individual
15344 members of the ~:components~ property are taken to be sub-projects,
15345 which group together files requiring different publishing options.
15346 When you publish such a "meta-project", all the components are also
15347 published, in the sequence given.
15349 *** Sources and destinations for files
15351 :DESCRIPTION: From here to there.
15352 :ALT_TITLE: Sources and destinations
15354 #+cindex: directories, for publishing
15356 Most properties are optional, but some should always be set. In
15357 particular, Org needs to know where to look for source files, and
15358 where to put published files.
15360 - ~:base-directory~ ::
15362 Directory containing publishing source files.
15364 - ~:publishing-directory~ ::
15366 Directory where output files are published. You can directly
15367 publish to a webserver using a file name syntax appropriate for
15368 the Emacs tramp package. Or you can publish to a local directory
15369 and use external tools to upload your website (see [[*Uploading
15372 - ~:preparation-function~ ::
15374 Function or list of functions to be called before starting the
15375 publishing process, for example, to run =make= for updating files
15376 to be published. Each preparation function is called with
15377 a single argument, the project property list.
15379 - ~:completion-function~ ::
15381 Function or list of functions called after finishing the
15382 publishing process, for example, to change permissions of the
15383 resulting files. Each completion function is called with
15384 a single argument, the project property list.
15386 *** Selecting files
15388 :DESCRIPTION: What files are part of the project?
15390 #+cindex: files, selecting for publishing
15392 By default, all files with extension =.org= in the base directory are
15393 considered part of the project. This can be modified by setting the
15394 following properties
15396 - ~:base-extension~ ::
15398 Extension---without the dot---of source files. This actually
15399 is a regular expression. Set this to the symbol ~any~ if you
15400 want to get all files in ~:base-directory~, even without
15405 Regular expression to match file names that should not be published,
15406 even though they have been selected on the basis of their extension.
15410 List of files to be included regardless of ~:base-extension~ and
15415 Non-~nil~ means, check base-directory recursively for files to
15418 *** Publishing action
15420 :DESCRIPTION: Setting the function doing the publishing.
15422 #+cindex: action, for publishing
15424 Publishing means that a file is copied to the destination directory
15425 and possibly transformed in the process. The default transformation
15426 is to export Org files as HTML files, and this is done by the function
15427 ~org-publish-org-to-html~ which calls the HTML exporter (see [[*HTML
15428 Export]]). But you can also publish your content as PDF files using
15429 ~org-publish-org-to-pdf~, or as ASCII, Texinfo, etc., using the
15430 corresponding functions.
15432 If you want to publish the Org file as an =.org= file but with
15433 /archived/, /commented/, and /tag-excluded/ trees removed, use
15434 ~org-publish-org-to-org~. This produces =file.org= and put it in the
15435 publishing directory. If you want a htmlized version of this file,
15436 set the parameter ~:htmlized-source~ to ~t~. It produces
15437 =file.org.html= in the publishing directory[fn:131].
15439 Other files like images only need to be copied to the publishing
15440 destination; for this you can use ~org-publish-attachment~. For
15441 non-Org files, you always need to specify the publishing function:
15443 - ~:publishing-function~ ::
15445 Function executing the publication of a file. This may also be
15446 a list of functions, which are all called in turn.
15448 - ~:plain-source~ ::
15450 Non-~nil~ means, publish plain source.
15452 - ~:htmlized-source~ ::
15454 Non-~nil~ means, publish htmlized source.
15456 The function must accept three arguments: a property list containing
15457 at least a ~:publishing-directory~ property, the name of the file to
15458 be published, and the path to the publishing directory of the output
15459 file. It should take the specified file, make the necessary
15460 transformation, if any, and place the result into the destination
15463 *** Options for the exporters
15465 :DESCRIPTION: Tweaking HTML/@LaTeX{} export.
15466 :ALT_TITLE: Publishing options
15468 #+cindex: options, for publishing
15469 #+cindex: publishing options
15471 The property list can be used to set many export options for the HTML
15472 and LaTeX exporters. In most cases, these properties correspond to
15473 user variables in Org. The table below lists these properties along
15474 with the variable they belong to. See the documentation string for
15475 the respective variable for details.
15477 #+vindex: org-publish-project-alist
15478 When a property is given a value in ~org-publish-project-alist~, its
15479 setting overrides the value of the corresponding user variable, if
15480 any, during publishing. Options set within a file (see [[*Export
15481 Settings]]), however, override everything.
15483 **** Generic properties
15488 | ~:archived-trees~ | ~org-export-with-archived-trees~ |
15489 | ~:exclude-tags~ | ~org-export-exclude-tags~ |
15490 | ~:headline-levels~ | ~org-export-headline-levels~ |
15491 | ~:language~ | ~org-export-default-language~ |
15492 | ~:preserve-breaks~ | ~org-export-preserve-breaks~ |
15493 | ~:section-numbers~ | ~org-export-with-section-numbers~ |
15494 | ~:select-tags~ | ~org-export-select-tags~ |
15495 | ~:with-author~ | ~org-export-with-author~ |
15496 | ~:with-broken-links~ | ~org-export-with-broken-links~ |
15497 | ~:with-clocks~ | ~org-export-with-clocks~ |
15498 | ~:with-creator~ | ~org-export-with-creator~ |
15499 | ~:with-date~ | ~org-export-with-date~ |
15500 | ~:with-drawers~ | ~org-export-with-drawers~ |
15501 | ~:with-email~ | ~org-export-with-email~ |
15502 | ~:with-emphasize~ | ~org-export-with-emphasize~ |
15503 | ~:with-fixed-width~ | ~org-export-with-fixed-width~ |
15504 | ~:with-footnotes~ | ~org-export-with-footnotes~ |
15505 | ~:with-latex~ | ~org-export-with-latex~ |
15506 | ~:with-planning~ | ~org-export-with-planning~ |
15507 | ~:with-priority~ | ~org-export-with-priority~ |
15508 | ~:with-properties~ | ~org-export-with-properties~ |
15509 | ~:with-special-strings~ | ~org-export-with-special-strings~ |
15510 | ~:with-sub-superscript~ | ~org-export-with-sub-superscripts~ |
15511 | ~:with-tables~ | ~org-export-with-tables~ |
15512 | ~:with-tags~ | ~org-export-with-tags~ |
15513 | ~:with-tasks~ | ~org-export-with-tasks~ |
15514 | ~:with-timestamps~ | ~org-export-with-timestamps~ |
15515 | ~:with-title~ | ~org-export-with-title~ |
15516 | ~:with-toc~ | ~org-export-with-toc~ |
15517 | ~:with-todo-keywords~ | ~org-export-with-todo-keywords~ |
15519 **** ASCII specific properties
15524 | ~:ascii-bullets~ | ~org-ascii-bullets~ |
15525 | ~:ascii-caption-above~ | ~org-ascii-caption-above~ |
15526 | ~:ascii-charset~ | ~org-ascii-charset~ |
15527 | ~:ascii-global-margin~ | ~org-ascii-global-margin~ |
15528 | ~:ascii-format-drawer-function~ | ~org-ascii-format-drawer-function~ |
15529 | ~:ascii-format-inlinetask-function~ | ~org-ascii-format-inlinetask-function~ |
15530 | ~:ascii-headline-spacing~ | ~org-ascii-headline-spacing~ |
15531 | ~:ascii-indented-line-width~ | ~org-ascii-indented-line-width~ |
15532 | ~:ascii-inlinetask-width~ | ~org-ascii-inlinetask-width~ |
15533 | ~:ascii-inner-margin~ | ~org-ascii-inner-margin~ |
15534 | ~:ascii-links-to-notes~ | ~org-ascii-links-to-notes~ |
15535 | ~:ascii-list-margin~ | ~org-ascii-list-margin~ |
15536 | ~:ascii-paragraph-spacing~ | ~org-ascii-paragraph-spacing~ |
15537 | ~:ascii-quote-margin~ | ~org-ascii-quote-margin~ |
15538 | ~:ascii-table-keep-all-vertical-lines~ | ~org-ascii-table-keep-all-vertical-lines~ |
15539 | ~:ascii-table-use-ascii-art~ | ~org-ascii-table-use-ascii-art~ |
15540 | ~:ascii-table-widen-columns~ | ~org-ascii-table-widen-columns~ |
15541 | ~:ascii-text-width~ | ~org-ascii-text-width~ |
15542 | ~:ascii-underline~ | ~org-ascii-underline~ |
15543 | ~:ascii-verbatim-format~ | ~org-ascii-verbatim-format~ |
15545 **** Beamer specific properties
15550 | ~:beamer-theme~ | ~org-beamer-theme~ |
15551 | ~:beamer-column-view-format~ | ~org-beamer-column-view-format~ |
15552 | ~:beamer-environments-extra~ | ~org-beamer-environments-extra~ |
15553 | ~:beamer-frame-default-options~ | ~org-beamer-frame-default-options~ |
15554 | ~:beamer-outline-frame-options~ | ~org-beamer-outline-frame-options~ |
15555 | ~:beamer-outline-frame-title~ | ~org-beamer-outline-frame-title~ |
15556 | ~:beamer-subtitle-format~ | ~org-beamer-subtitle-format~ |
15558 **** HTML specific properties
15563 | ~:html-allow-name-attribute-in-anchors~ | ~org-html-allow-name-attribute-in-anchors~ |
15564 | ~:html-checkbox-type~ | ~org-html-checkbox-type~ |
15565 | ~:html-container~ | ~org-html-container-element~ |
15566 | ~:html-divs~ | ~org-html-divs~ |
15567 | ~:html-doctype~ | ~org-html-doctype~ |
15568 | ~:html-extension~ | ~org-html-extension~ |
15569 | ~:html-footnote-format~ | ~org-html-footnote-format~ |
15570 | ~:html-footnote-separator~ | ~org-html-footnote-separator~ |
15571 | ~:html-footnotes-section~ | ~org-html-footnotes-section~ |
15572 | ~:html-format-drawer-function~ | ~org-html-format-drawer-function~ |
15573 | ~:html-format-headline-function~ | ~org-html-format-headline-function~ |
15574 | ~:html-format-inlinetask-function~ | ~org-html-format-inlinetask-function~ |
15575 | ~:html-head-extra~ | ~org-html-head-extra~ |
15576 | ~:html-head-include-default-style~ | ~org-html-head-include-default-style~ |
15577 | ~:html-head-include-scripts~ | ~org-html-head-include-scripts~ |
15578 | ~:html-head~ | ~org-html-head~ |
15579 | ~:html-home/up-format~ | ~org-html-home/up-format~ |
15580 | ~:html-html5-fancy~ | ~org-html-html5-fancy~ |
15581 | ~:html-indent~ | ~org-html-indent~ |
15582 | ~:html-infojs-options~ | ~org-html-infojs-options~ |
15583 | ~:html-infojs-template~ | ~org-html-infojs-template~ |
15584 | ~:html-inline-image-rules~ | ~org-html-inline-image-rules~ |
15585 | ~:html-inline-images~ | ~org-html-inline-images~ |
15586 | ~:html-link-home~ | ~org-html-link-home~ |
15587 | ~:html-link-org-files-as-html~ | ~org-html-link-org-files-as-html~ |
15588 | ~:html-link-up~ | ~org-html-link-up~ |
15589 | ~:html-link-use-abs-url~ | ~org-html-link-use-abs-url~ |
15590 | ~:html-mathjax-options~ | ~org-html-mathjax-options~ |
15591 | ~:html-mathjax-template~ | ~org-html-mathjax-template~ |
15592 | ~:html-metadata-timestamp-format~ | ~org-html-metadata-timestamp-format~ |
15593 | ~:html-postamble-format~ | ~org-html-postamble-format~ |
15594 | ~:html-postamble~ | ~org-html-postamble~ |
15595 | ~:html-preamble-format~ | ~org-html-preamble-format~ |
15596 | ~:html-preamble~ | ~org-html-preamble~ |
15597 | ~:html-table-align-individual-field~ | ~de{org-html-table-align-individual-fields~ |
15598 | ~:html-table-attributes~ | ~org-html-table-default-attributes~ |
15599 | ~:html-table-caption-above~ | ~org-html-table-caption-above~ |
15600 | ~:html-table-data-tags~ | ~org-html-table-data-tags~ |
15601 | ~:html-table-header-tags~ | ~org-html-table-header-tags~ |
15602 | ~:html-table-row-tags~ | ~org-html-table-row-tags~ |
15603 | ~:html-table-use-header-tags-for-first-column~ | ~org-html-table-use-header-tags-for-first-column~ |
15604 | ~:html-tag-class-prefix~ | ~org-html-tag-class-prefix~ |
15605 | ~:html-text-markup-alist~ | ~org-html-text-markup-alist~ |
15606 | ~:html-todo-kwd-class-prefix~ | ~org-html-todo-kwd-class-prefix~ |
15607 | ~:html-toplevel-hlevel~ | ~org-html-toplevel-hlevel~ |
15608 | ~:html-use-infojs~ | ~org-html-use-infojs~ |
15609 | ~:html-validation-link~ | ~org-html-validation-link~ |
15610 | ~:html-viewport~ | ~org-html-viewport~ |
15611 | ~:html-xml-declaration~ | ~org-html-xml-declaration~ |
15613 **** LaTeX specific properties
15618 | ~:latex-active-timestamp-format~ | ~org-latex-active-timestamp-format~ |
15619 | ~:latex-caption-above~ | ~org-latex-caption-above~ |
15620 | ~:latex-classes~ | ~org-latex-classes~ |
15621 | ~:latex-class~ | ~org-latex-default-class~ |
15622 | ~:latex-compiler~ | ~org-latex-compiler~ |
15623 | ~:latex-default-figure-position~ | ~org-latex-default-figure-position~ |
15624 | ~:latex-default-table-environment~ | ~org-latex-default-table-environment~ |
15625 | ~:latex-default-table-mode~ | ~org-latex-default-table-mode~ |
15626 | ~:latex-diary-timestamp-format~ | ~org-latex-diary-timestamp-format~ |
15627 | ~:latex-footnote-defined-format~ | ~org-latex-footnote-defined-format~ |
15628 | ~:latex-footnote-separator~ | ~org-latex-footnote-separator~ |
15629 | ~:latex-format-drawer-function~ | ~org-latex-format-drawer-function~ |
15630 | ~:latex-format-headline-function~ | ~org-latex-format-headline-function~ |
15631 | ~:latex-format-inlinetask-function~ | ~org-latex-format-inlinetask-function~ |
15632 | ~:latex-hyperref-template~ | ~org-latex-hyperref-template~ |
15633 | ~:latex-image-default-height~ | ~org-latex-image-default-height~ |
15634 | ~:latex-image-default-option~ | ~org-latex-image-default-option~ |
15635 | ~:latex-image-default-width~ | ~org-latex-image-default-width~ |
15636 | ~:latex-images-centered~ | ~org-latex-images-centered~ |
15637 | ~:latex-inactive-timestamp-format~ | ~org-latex-inactive-timestamp-format~ |
15638 | ~:latex-inline-image-rules~ | ~org-latex-inline-image-rules~ |
15639 | ~:latex-link-with-unknown-path-format~ | ~org-latex-link-with-unknown-path-format~ |
15640 | ~:latex-listings-langs~ | ~org-latex-listings-langs~ |
15641 | ~:latex-listings-options~ | ~org-latex-listings-options~ |
15642 | ~:latex-listings~ | ~org-latex-listings~ |
15643 | ~:latex-minted-langs~ | ~org-latex-minted-langs~ |
15644 | ~:latex-minted-options~ | ~org-latex-minted-options~ |
15645 | ~:latex-prefer-user-labels~ | ~org-latex-prefer-user-labels~ |
15646 | ~:latex-subtitle-format~ | ~org-latex-subtitle-format~ |
15647 | ~:latex-subtitle-separate~ | ~org-latex-subtitle-separate~ |
15648 | ~:latex-table-scientific-notation~ | ~org-latex-table-scientific-notation~ |
15649 | ~:latex-tables-booktabs~ | ~org-latex-tables-booktabs~ |
15650 | ~:latex-tables-centered~ | ~org-latex-tables-centered~ |
15651 | ~:latex-text-markup-alist~ | ~org-latex-text-markup-alist~ |
15652 | ~:latex-title-command~ | ~org-latex-title-command~ |
15653 | ~:latex-toc-command~ | ~org-latex-toc-command~ |
15655 **** Markdown specific properties
15660 | ~:md-footnote-format~ | ~org-md-footnote-format~ |
15661 | ~:md-footnotes-section~ | ~org-md-footnotes-section~ |
15662 | ~:md-headline-style~ | ~org-md-headline-style~ |
15664 **** ODT specific properties
15669 | ~:odt-content-template-file~ | ~org-odt-content-template-file~ |
15670 | ~:odt-display-outline-level~ | ~org-odt-display-outline-level~ |
15671 | ~:odt-fontify-srcblocks~ | ~org-odt-fontify-srcblocks~ |
15672 | ~:odt-format-drawer-function~ | ~org-odt-format-drawer-function~ |
15673 | ~:odt-format-headline-function~ | ~org-odt-format-headline-function~ |
15674 | ~:odt-format-inlinetask-function~ | ~org-odt-format-inlinetask-function~ |
15675 | ~:odt-inline-formula-rules~ | ~org-odt-inline-formula-rules~ |
15676 | ~:odt-inline-image-rules~ | ~org-odt-inline-image-rules~ |
15677 | ~:odt-pixels-per-inch~ | ~org-odt-pixels-per-inch~ |
15678 | ~:odt-styles-file~ | ~org-odt-styles-file~ |
15679 | ~:odt-table-styles~ | ~org-odt-table-styles~ |
15680 | ~:odt-use-date-fields~ | ~org-odt-use-date-fields~ |
15682 **** Texinfo specific properties
15687 | ~:texinfo-active-timestamp-format~ | ~org-texinfo-active-timestamp-format~ |
15688 | ~:texinfo-classes~ | ~org-texinfo-classes~ |
15689 | ~:texinfo-class~ | ~org-texinfo-default-class~ |
15690 | ~:texinfo-table-default-markup~ | ~org-texinfo-table-default-markup~ |
15691 | ~:texinfo-diary-timestamp-format~ | ~org-texinfo-diary-timestamp-format~ |
15692 | ~:texinfo-filename~ | ~org-texinfo-filename~ |
15693 | ~:texinfo-format-drawer-function~ | ~org-texinfo-format-drawer-function~ |
15694 | ~:texinfo-format-headline-function~ | ~org-texinfo-format-headline-function~ |
15695 | ~:texinfo-format-inlinetask-function~ | ~org-texinfo-format-inlinetask-function~ |
15696 | ~:texinfo-inactive-timestamp-format~ | ~org-texinfo-inactive-timestamp-format~ |
15697 | ~:texinfo-link-with-unknown-path-format~ | ~org-texinfo-link-with-unknown-path-format~ |
15698 | ~:texinfo-node-description-column~ | ~org-texinfo-node-description-column~ |
15699 | ~:texinfo-table-scientific-notation~ | ~org-texinfo-table-scientific-notation~ |
15700 | ~:texinfo-tables-verbatim~ | ~org-texinfo-tables-verbatim~ |
15701 | ~:texinfo-text-markup-alist~ | ~org-texinfo-text-markup-alist~ |
15703 *** Publishing links
15705 :DESCRIPTION: Which links keep working after publishing?
15707 #+cindex: links, publishing
15709 To create a link from one Org file to another, you would use something
15710 like =[[file:foo.org][The foo]]= or simply =[[file:foo.org]]= (see [[*External Links]]). When
15711 published, this link becomes a link to =foo.html=. You can thus
15712 interlink the pages of your "Org web" project and the links will work
15713 as expected when you publish them to HTML. If you also publish the
15714 Org source file and want to link to it, use an =http= link instead of
15715 a =file:= link, because =file= links are converted to link to the
15716 corresponding =.html= file.
15718 You may also link to related files, such as images. Provided you are
15719 careful with relative file names, and provided you have also
15720 configured Org to upload the related files, these links will work too.
15721 See [[*Example: complex publishing configuration]], for an example of this
15724 Eventually, links between published documents can contain some search
15725 options (see [[*Search Options in File Links]]), which will be resolved to
15726 the appropriate location in the linked file. For example, once
15727 published to HTML, the following links all point to a dedicated anchor
15731 [[file:foo.org::*heading]]
15732 [[file:foo.org::#custom-id]]
15733 [[file:foo.org::target]]
15736 *** Generating a sitemap
15738 :DESCRIPTION: Generating a list of all pages.
15739 :ALT_TITLE: Site map
15741 #+cindex: sitemap, of published pages
15743 The following properties may be used to control publishing of
15744 a map of files for a given project.
15746 - ~:auto-sitemap~ ::
15748 When non-~nil~, publish a sitemap during
15749 ~org-publish-current-project~ or ~org-publish-all~.
15751 - ~:sitemap-filename~ ::
15753 Filename for output of sitemap. Defaults to =sitemap.org=, which
15754 becomes =sitemap.html=.
15756 - ~:sitemap-title~ ::
15758 Title of sitemap page. Defaults to name of file.
15760 - ~:sitemap-format-entry~ ::
15762 #+findex: org-publish-find-date
15763 #+findex: org-publish-find-property
15764 #+findex: org-publish-find-title
15765 With this option one can tell how a site-map entry is formatted
15766 in the site-map. It is a function called with three arguments:
15767 the file or directory name relative to base directory of the
15768 project, the site-map style and the current project. It is
15769 expected to return a string. Default value turns file names into
15770 links and use document titles as descriptions. For specific
15771 formatting needs, one can use ~org-publish-find-date~,
15772 ~org-publish-find-title~ and ~org-publish-find-property~, to
15773 retrieve additional information about published documents.
15775 - ~:sitemap-function~ ::
15777 Plug-in function to use for generation of the sitemap. It is
15778 called with two arguments: the title of the site-map and
15779 a representation of the files and directories involved in the
15780 project as a nested list, which can further be transformed using
15781 ~org-list-to-generic~, ~org-list-to-subtree~ and alike. Default
15782 value generates a plain list of links to all files in the
15785 - ~:sitemap-sort-folders~ ::
15787 Where folders should appear in the sitemap. Set this to ~first~
15788 (default) or ~last~ to display folders first or last,
15789 respectively. When set to ~ignore~, folders are ignored
15790 altogether. Any other value mixes files and folders. This
15791 variable has no effect when site-map style is ~tree~.
15793 - ~:sitemap-sort-files~ ::
15795 How the files are sorted in the site map. Set this to
15796 ~alphabetically~ (default), ~chronologically~ or
15797 ~anti-chronologically~. ~chronologically~ sorts the files with
15798 older date first while ~anti-chronologically~ sorts the files
15799 with newer date first. ~alphabetically~ sorts the files
15800 alphabetically. The date of a file is retrieved with
15801 ~org-publish-find-date~.
15803 - ~:sitemap-ignore-case~ ::
15805 Should sorting be case-sensitive? Default ~nil~.
15807 - ~:sitemap-file-entry-format~ ::
15809 With this option one can tell how a sitemap's entry is formatted
15810 in the sitemap. This is a format string with some escape
15811 sequences: ~%t~ stands for the title of the file, ~%a~ stands for
15812 the author of the file and ~%d~ stands for the date of the file.
15813 The date is retrieved with the ~org-publish-find-date~ function
15814 and formatted with ~org-publish-sitemap-date-format~. Default
15817 - ~:sitemap-date-format~ ::
15819 Format string for the ~format-time-string~ function that tells
15820 how a sitemap entry's date is to be formatted. This property
15821 bypasses ~org-publish-sitemap-date-format~ which defaults to
15824 *** Generating an index
15826 :DESCRIPTION: An index that reaches across pages.
15828 #+cindex: index, in a publishing project
15830 Org mode can generate an index across the files of a publishing project.
15834 When non-~nil~, generate in index in the file =theindex.org= and
15835 publish it as =theindex.html=.
15837 The file is created when first publishing a project with the
15838 ~:makeindex~ set. The file only contains a statement =#+INCLUDE:
15839 "theindex.inc"=. You can then build around this include statement by
15840 adding a title, style information, etc.
15842 #+cindex: @samp{INDEX}, keyword
15843 Index entries are specified with =INDEX= keyword. An entry that
15844 contains an exclamation mark creates a sub item.
15847 ,*** Curriculum Vitae
15849 ,#+INDEX: Application!CV
15854 :DESCRIPTION: How to get files up on the server.
15859 For those people already utilizing third party sync tools such as
15860 Rsync or Unison, it might be preferable not to use the built-in remote
15861 publishing facilities of Org mode which rely heavily on Tramp. Tramp,
15862 while very useful and powerful, tends not to be so efficient for
15863 multiple file transfer and has been known to cause problems under
15866 Specialized synchronization utilities offer several advantages. In
15867 addition to timestamp comparison, they also do content and
15868 permissions/attribute checks. For this reason you might prefer to
15869 publish your web to a local directory---possibly even /in place/ with
15870 your Org files---and then use Unison or Rsync to do the
15871 synchronization with the remote host.
15873 Since Unison, for example, can be configured as to which files to
15874 transfer to a certain remote destination, it can greatly simplify the
15875 project publishing definition. Simply keep all files in the correct
15876 location, process your Org files with ~org-publish~ and let the
15877 synchronization tool do the rest. You do not need, in this scenario,
15878 to include attachments such as JPG, CSS or PNG files in the project
15879 definition since the third-party tool syncs them.
15881 Publishing to a local directory is also much faster than to a remote
15882 one, so that you can afford more easily to republish entire projects.
15883 If you set ~org-publish-use-timestamps-flag~ to ~nil~, you gain the
15884 main benefit of re-including any changed external files such as source
15885 example files you might include with =INCLUDE= keyword. The timestamp
15886 mechanism in Org is not smart enough to detect if included files have
15889 ** Sample Configuration
15891 :DESCRIPTION: Example projects.
15894 Below we provide two example configurations. The first one is
15895 a simple project publishing only a set of Org files. The second
15896 example is more complex, with a multi-component project.
15898 *** Example: simple publishing configuration
15900 :DESCRIPTION: One-component publishing.
15901 :ALT_TITLE: Simple example
15904 This example publishes a set of Org files to the =public_html=
15905 directory on the local machine.
15907 #+begin_src emacs-lisp
15908 (setq org-publish-project-alist
15910 :base-directory "~/org/"
15911 :publishing-directory "~/public_html"
15912 :section-numbers nil
15913 :table-of-contents nil
15914 :style "<link rel=\"stylesheet\"
15915 href=\"../other/mystyle.css\"
15916 type=\"text/css\"/>")))
15919 *** Example: complex publishing configuration
15921 :DESCRIPTION: A multi-component publishing example.
15922 :ALT_TITLE: Complex example
15925 This more complicated example publishes an entire website, including
15926 Org files converted to HTML, image files, Emacs Lisp source code, and
15927 style sheets. The publishing directory is remote and private files
15930 To ensure that links are preserved, care should be taken to replicate
15931 your directory structure on the web server, and to use relative file
15932 paths. For example, if your Org files are kept in =~/org/= and your
15933 publishable images in =~/images/=, you would link to an image with
15935 : file:../images/myimage.png
15937 On the web server, the relative path to the image should be the same.
15938 You can accomplish this by setting up an =images/= folder in the right
15939 place on the web server, and publishing images to it.
15941 #+begin_src emacs-lisp
15942 (setq org-publish-project-alist
15944 :base-directory "~/org/"
15945 :base-extension "org"
15946 :publishing-directory "/ssh:user@host:~/html/notebook/"
15947 :publishing-function org-html-publish-to-html
15948 :exclude "PrivatePage.org" ;; regexp
15950 :section-numbers nil
15952 :html-head "<link rel=\"stylesheet\"
15953 href=\"../other/mystyle.css\" type=\"text/css\"/>"
15957 :base-directory "~/images/"
15958 :base-extension "jpg\\|gif\\|png"
15959 :publishing-directory "/ssh:user@host:~/html/images/"
15960 :publishing-function org-publish-attachment)
15963 :base-directory "~/other/"
15964 :base-extension "css\\|el"
15965 :publishing-directory "/ssh:user@host:~/html/other/"
15966 :publishing-function org-publish-attachment)
15967 ("website" :components ("orgfiles" "images" "other"))))
15970 ** Triggering Publication
15972 :DESCRIPTION: Publication commands.
15975 Once properly configured, Org can publish with the following commands:
15977 - {{{kbd(C-c C-e X)}}} (~org-publish~) ::
15979 #+kindex: C-c C-e X
15980 #+findex: org-publish
15981 Prompt for a specific project and publish all files that belong
15984 - {{{kbd(C-c C-e P)}}} (~org-publish-current-project~) ::
15986 #+kindex: C-c C-e P
15987 #+findex: org-publish-current-project
15988 Publish the project containing the current file.
15990 - {{{kbd(C-c C-e F)}}} (~org-publish-current-file~) ::
15992 #+kindex: C-c C-e F
15993 #+findex: org-publish-current-file
15994 Publish only the current file.
15996 - {{{kbd(C-c C-e E)}}} (~org-publish-all~) ::
15998 #+kindex: C-c C-e E
15999 #+findex: org-publish-all
16000 Publish every project.
16002 #+vindex: org-publish-use-timestamps-flag
16003 Org uses timestamps to track when a file has changed. The above
16004 functions normally only publish changed files. You can override this
16005 and force publishing of all files by giving a prefix argument to any
16006 of the commands above, or by customizing the variable
16007 ~org-publish-use-timestamps-flag~. This may be necessary in
16008 particular if files include other files via =SETUPFILE= or =INCLUDE=
16011 * Working with Source Code
16013 :DESCRIPTION: Export, evaluate, and tangle code blocks.
16015 #+cindex: source code, working with
16017 Source code here refers to any plain text collection of computer
16018 instructions, possibly with comments, written using a human-readable
16019 programming language. Org can manage source code in an Org document
16020 when the source code is identified with begin and end markers.
16021 Working with source code begins with identifying source code blocks.
16022 A source code block can be placed almost anywhere in an Org document;
16023 it is not restricted to the preamble or the end of the document.
16024 However, Org cannot manage a source code block if it is placed inside
16025 an Org comment or within a fixed width section.
16027 Here is an example source code block in the Emacs Lisp language:
16030 ,#+BEGIN_SRC emacs-lisp
16031 (defun org-xor (a b)
16037 Org can manage the source code in the block delimited by =#+BEGIN_SRC=
16038 ... =#+END_SRC= in several ways that can simplify housekeeping tasks
16039 essential to modern source code maintenance. Org can edit, format,
16040 extract, export, and publish source code blocks. Org can also compile
16041 and execute a source code block, then capture the results. The Org
16042 mode literature sometimes refers to source code blocks as /live code/
16043 blocks because they can alter the content of the Org document or the
16044 material that it exports. Users can control how live they want each
16045 source code block by tweaking the header arguments (see [[*Using
16046 Header Arguments]]) for compiling, execution, extraction, and
16049 Source code blocks are one of many Org block types, which also include
16050 =quote=, =export=, =verse=, =latex=, =example=, and =verbatim=. This
16051 section pertains to blocks between =#+BEGIN_SRC= and =#+END_SRC=.
16053 For editing and formatting a source code block, Org uses an
16054 appropriate Emacs major mode that includes features specifically
16055 designed for source code in that language.
16057 Org can extract one or more source code blocks and write them to one
16058 or more source files---a process known as /tangling/ in literate
16059 programming terminology.
16061 For exporting and publishing, Org's back-ends can format a source code
16062 block appropriately, often with native syntax highlighting.
16064 For executing and compiling a source code block, the user can
16065 configure Org to select the appropriate compiler. Org provides
16066 facilities to collect the result of the execution or compiler output,
16067 insert it into the Org document, and/or export it. In addition to
16068 text results, Org can insert links to other data types, including
16069 audio, video, and graphics. Org can also link a compiler error
16070 message to the appropriate line in the source code block.
16072 An important feature of Org's management of source code blocks is the
16073 ability to pass variables, functions, and results to one another using
16074 a common syntax for source code blocks in any language. Although most
16075 literate programming facilities are restricted to one language or
16076 another, Org's language-agnostic approach lets the literate programmer
16077 match each programming task with the appropriate computer language and
16078 to mix them all together in a single Org document. This
16079 interoperability among languages explains why Org's source code
16080 management facility was named /Org Babel/ by its originators, Eric
16081 Schulte and Dan Davison.
16083 Org mode fulfills the promise of easy verification and maintenance of
16084 publishing reproducible research by keeping text, data, code,
16085 configuration settings of the execution environment, the results of
16086 the execution, and associated narratives, claims, references, and
16087 internal and external links in a single Org document.
16089 Details of Org's facilities for working with source code are described
16090 in the following sections.
16092 ** Structure of Code Blocks
16094 :DESCRIPTION: Code block syntax described.
16096 #+cindex: code block, structure
16097 #+cindex: source code, block structure
16098 #+cindex: @samp{NAME} keyword, in source blocks
16099 #+cindex: @samp{BEGIN_SRC}
16101 Org offers two ways to structure source code in Org documents: in
16102 a source code block, and directly inline. Both specifications are
16105 A source code block conforms to this structure:
16109 ,#+BEGIN_SRC <language> <switches> <header arguments>
16114 Do not be put-off by having to remember the source block syntax. Org
16115 mode offers a command for wrapping existing text in a block (see
16116 [[*Structure Templates]]). Org also works with other completion systems
16117 in Emacs, some of which predate Org and have custom domain-specific
16118 languages for defining templates. Regular use of templates reduces
16119 errors, increases accuracy, and maintains consistency.
16121 #+cindex: source code, inline
16122 An inline code block conforms to this structure:
16124 : src_<language>{<body>}
16126 #+texinfo: @noindent
16129 : src_<language>[<header arguments>]{<body>}
16131 - =#+NAME: <name>= ::
16133 Optional. Names the source block so it can be called, like
16134 a function, from other source blocks or inline code to evaluate
16135 or to capture the results. Code from other blocks, other files,
16136 and from table formulas (see [[*The spreadsheet]]) can use the name
16137 to reference a source block. This naming serves the same purpose
16138 as naming Org tables. Org mode requires unique names. For
16139 duplicate names, Org mode's behavior is undefined.
16141 - =#+BEGIN_SRC= ... =#+END_SRC= ::
16143 Mandatory. They mark the start and end of a block that Org
16144 requires. The =#+BEGIN_SRC= line takes additional arguments, as
16149 #+cindex: language, in code blocks
16150 Mandatory. It is the identifier of the source code language in
16151 the block. See [[*Languages]], for identifiers of supported
16156 #+cindex: switches, in code blocks
16157 Optional. Switches provide finer control of the code execution,
16158 export, and format (see the discussion of switches in [[*Literal
16161 - =<header arguments>= ::
16163 #+cindex: header arguments, in code blocks
16164 Optional. Heading arguments control many aspects of evaluation,
16165 export and tangling of code blocks (see [[*Using Header Arguments]]).
16166 Using Org's properties feature, header arguments can be
16167 selectively applied to the entire buffer or specific sub-trees of
16172 Source code in the dialect of the specified language identifier.
16174 ** Using Header Arguments
16176 :DESCRIPTION: Different ways to set header arguments.
16179 Org comes with many header arguments common to all languages. New
16180 header arguments are added for specific languages as they become
16181 available for use in source code blocks. A header argument is
16182 specified with an initial colon followed by the argument's name in
16185 Since header arguments can be set in several ways, Org prioritizes
16186 them in case of overlaps or conflicts by giving local settings
16187 a higher priority. Header values in function calls, for example,
16188 override header values from global defaults.
16190 *** System-wide header arguments
16194 #+vindex: org-babel-default-header-args
16196 #+vindex: org-babel-default-header-args
16197 System-wide values of header arguments can be specified by customizing
16198 the ~org-babel-default-header-args~ variable, which defaults to the
16203 :results => "replace"
16209 The example below sets =:noweb= header arguments to =yes=, which makes
16210 Org expand =:noweb= references by default.
16212 #+begin_src emacs-lisp
16213 (setq org-babel-default-header-args
16214 (cons '(:noweb . "yes")
16215 (assq-delete-all :noweb org-babel-default-header-args)))
16218 #+cindex: language specific default header arguments
16219 #+cindex: default header arguments per language
16220 Each language can have separate default header arguments by
16221 customizing the variable ~org-babel-default-header-args:<LANG>~, where
16222 {{{var(<LANG>)}}} is the name of the language. For details, see the
16223 language-specific online documentation at
16224 https://orgmode.org/worg/org-contrib/babel/.
16226 *** Header arguments in Org mode properties
16231 For header arguments applicable to the buffer, use =PROPERTY= keyword
16232 anywhere in the Org file (see [[*Property Syntax]]).
16234 The following example makes all the R code blocks execute in the same
16235 session. Setting =:results= to =silent= ignores the results of
16236 executions for all blocks, not just R code blocks; no results inserted
16240 ,#+PROPERTY: header-args:R :session *R*
16241 ,#+PROPERTY: header-args :results silent
16244 #+vindex: org-use-property-inheritance
16245 Header arguments set through Org's property drawers (see [[*Property
16246 Syntax]]) apply at the sub-tree level on down. Since these property
16247 drawers can appear anywhere in the file hierarchy, Org uses outermost
16248 call or source block to resolve the values. Org ignores
16249 ~org-use-property-inheritance~ setting.
16251 In this example, =:cache= defaults to =yes= for all code blocks in the
16257 :header-args: :cache yes
16261 #+kindex: C-c C-x p
16262 #+findex: org-set-property
16263 Properties defined through ~org-set-property~ function, bound to
16264 {{{kbd(C-c C-x p)}}}, apply to all active languages. They override
16265 properties set in ~org-babel-default-header-args~.
16267 #+cindex: language specific header arguments properties
16268 #+cindex: header arguments per language
16269 Language-specific header arguments are also read from properties
16270 =header-args:<LANG>= where {{{var(<LANG>)}}} is the language
16271 identifier. For example,
16276 :header-args:clojure: :session *clojure-1*
16277 :header-args:R: :session *R*
16281 :header-args:clojure: :session *clojure-2*
16285 #+texinfo: @noindent
16286 would force separate sessions for Clojure blocks in =Heading= and
16287 =Subheading=, but use the same session for all R blocks. Blocks in
16288 =Subheading= inherit settings from =Heading=.
16290 *** Code block specific header arguments
16295 Header arguments are most commonly set at the source code block level,
16296 on the =#+BEGIN_SRC= line. Arguments set at this level take
16297 precedence over those set in the ~org-babel-default-header-args~
16298 variable, and also those set as header properties.
16300 In the following example, setting =:results= to =silent= makes it
16301 ignore results of the code execution. Setting =:exports= to =code=
16302 exports only the body of the code block to HTML or LaTeX.
16306 ,#+BEGIN_SRC haskell :results silent :exports code :var n=0
16308 fac n = n * fac (n-1)
16312 The same header arguments in an inline code block:
16314 : src_haskell[:exports both]{fac 5}
16316 #+cindex: @samp{HEADER}, keyword
16317 Code block header arguments can span multiple lines using =#+HEADER:=
16318 on each line. Note that Org currently accepts the plural spelling of
16319 =#+HEADER:= only as a convenience for backward-compatibility. It may
16320 be removed at some point.
16322 Multi-line header arguments on an unnamed code block:
16325 ,#+HEADER: :var data1=1
16326 ,#+BEGIN_SRC emacs-lisp :var data2=2
16327 (message "data1:%S, data2:%S" data1 data2)
16334 Multi-line header arguments on a named code block:
16337 ,#+NAME: named-block
16338 ,#+HEADER: :var data=2
16339 ,#+BEGIN_SRC emacs-lisp
16340 (message "data:%S" data)
16343 ,#+RESULTS: named-block
16347 *** Header arguments in function calls
16352 Header arguments in function calls are the most specific and override
16353 all other settings in case of an overlap. They get the highest
16354 priority. Two =#+CALL:= examples are shown below. For the complete
16355 syntax of =CALL= keyword, see [[*Evaluating Code Blocks]].
16357 In this example, =:exports results= header argument is applied to the
16358 evaluation of the =#+CALL:= line.
16360 : #+CALL: factorial(n=5) :exports results
16362 In this example, =:session special= header argument is applied to the
16363 evaluation of =factorial= code block.
16365 : #+CALL: factorial[:session special](n=5)
16367 ** Environment of a Code Block
16369 :DESCRIPTION: Arguments, sessions, working directory...
16372 *** Passing arguments
16377 #+cindex: passing arguments to code blocks
16378 #+cindex: arguments, in code blocks
16379 #+cindex: @samp{var}, header argument
16380 Use =var= for passing arguments to source code blocks. The specifics
16381 of variables in code blocks vary by the source language and are
16382 covered in the language-specific documentation. The syntax for =var=,
16383 however, is the same for all languages. This includes declaring
16384 a variable, and assigning a default value.
16386 The following syntax is used to pass arguments to code blocks using
16387 the =var= header argument.
16391 #+texinfo: @noindent
16392 {{{var(NAME)}}} is the name of the variable bound in the code block
16393 body. {{{var(ASSIGN)}}} is a literal value, such as a string,
16394 a number, a reference to a table, a list, a literal example, another
16395 code block---with or without arguments---or the results of evaluating
16398 Here are examples of passing values by reference:
16402 A table named with a =NAME= keyword.
16405 ,#+NAME: example-table
16411 ,#+NAME: table-length
16412 ,#+BEGIN_SRC emacs-lisp :var table=example-table
16416 ,#+RESULTS: table-length
16420 When passing a table, you can treat specially the row, or the
16421 column, containing labels for the columns, or the rows, in the
16424 #+cindex: @samp{colnames}, header argument
16425 The =colnames= header argument accepts =yes=, =no=, or =nil=
16426 values. The default value is =nil=: if an input table has column
16427 names---because the second row is a horizontal rule---then Org
16428 removes the column names, processes the table, puts back the
16429 column names, and then writes the table to the results block.
16430 Using =yes=, Org does the same to the first row, even if the
16431 initial table does not contain any horizontal rule. When set to
16432 =no=, Org does not pre-process column names at all.
16441 ,#+BEGIN_SRC python :var tab=less-cols :colnames nil
16442 return [[val + '*' for val in row] for row in tab]
16452 #+cindex: @samp{rownames}, header argument
16453 Similarly, the =rownames= header argument can take two values:
16454 =yes= or =no=. When set to =yes=, Org removes the first column,
16455 processes the table, puts back the first column, and then writes
16456 the table to the results block. The default is =no=, which means
16457 Org does not pre-process the first column. Note that Emacs Lisp
16458 code blocks ignore =rownames= header argument because of the ease
16459 of table-handling in Emacs.
16462 ,#+NAME: with-rownames
16463 | one | 1 | 2 | 3 | 4 | 5 |
16464 | two | 6 | 7 | 8 | 9 | 10 |
16466 ,#+BEGIN_SRC python :var tab=with-rownames :rownames yes
16467 return [[val + 10 for val in row] for row in tab]
16471 | one | 11 | 12 | 13 | 14 | 15 |
16472 | two | 16 | 17 | 18 | 19 | 20 |
16477 A simple named list.
16480 ,#+NAME: example-list
16486 ,#+BEGIN_SRC emacs-lisp :var x=example-list
16494 Note that only the top level list items are passed along. Nested
16495 list items are ignored.
16497 - code block without arguments ::
16499 A code block name, as assigned by =NAME= keyword from the example
16500 above, optionally followed by parentheses.
16503 ,#+BEGIN_SRC emacs-lisp :var length=table-length()
16511 - code block with arguments ::
16513 A code block name, as assigned by =NAME= keyword, followed by
16514 parentheses and optional arguments passed within the parentheses.
16518 ,#+BEGIN_SRC emacs-lisp :var input=8
16526 ,#+BEGIN_SRC emacs-lisp :var input=double(input=1)
16530 ,#+RESULTS: squared
16534 - literal example ::
16536 A literal example block named with a =NAME= keyword.
16539 ,#+NAME: literal-example
16545 ,#+NAME: read-literal-example
16546 ,#+BEGIN_SRC emacs-lisp :var x=literal-example
16547 (concatenate #'string x " for you.")
16550 ,#+RESULTS: read-literal-example
16551 : A literal example
16552 : on two lines for you.
16555 Indexing variable values enables referencing portions of a variable.
16556 Indexes are 0 based with negative values counting backwards from the
16557 end. If an index is separated by commas then each subsequent section
16558 indexes as the next dimension. Note that this indexing occurs
16559 /before/ other table-related header arguments are applied, such as
16560 =hlines=, =colnames= and =rownames=. The following example assigns
16561 the last cell of the first row the table =example-table= to the
16565 ,#+NAME: example-table
16571 ,#+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
16579 Two integers separated by a colon reference a range of variable
16580 values. In that case the entire inclusive range is referenced. For
16581 example the following assigns the middle three rows of =example-table=
16585 ,#+NAME: example-table
16592 ,#+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
16602 To pick the entire range, use an empty index, or the single character
16603 =*=. =0:-1= does the same thing. Example below shows how to
16604 reference the first column only.
16607 ,#+NAME: example-table
16613 ,#+BEGIN_SRC emacs-lisp :var data=example-table[,0]
16621 Index referencing can be used for tables and code blocks. Index
16622 referencing can handle any number of dimensions. Commas delimit
16623 multiple dimensions, as shown below.
16627 ,#+BEGIN_SRC emacs-lisp
16628 '(((1 2 3) (4 5 6) (7 8 9))
16629 ((10 11 12) (13 14 15) (16 17 18))
16630 ((19 20 21) (22 23 24) (25 26 27)))
16633 ,#+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
16641 Note that row names and column names are not removed prior to variable
16642 indexing. You need to take them into account, even when =colnames= or
16643 =rownames= header arguments remove them.
16645 Emacs lisp code can also set the values for variables. To
16646 differentiate a value from Lisp code, Org interprets any value
16647 starting with =(=, =[=, ='= or =`= as Emacs Lisp code. The result of
16648 evaluating that code is then assigned to the value of that variable.
16649 The following example shows how to reliably query and pass the file
16650 name of the Org mode buffer to a code block using headers. We need
16651 reliability here because the file's name could change once the code in
16652 the block starts executing.
16655 ,#+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
16660 Note that values read from tables and lists are not mistakenly
16661 evaluated as Emacs Lisp code, as illustrated in the following example.
16667 ,#+HEADER: :var data=table[0,0]
16681 #+cindex: using sessions in code blocks
16682 #+cindex: @samp{session}, header argument
16683 Two code blocks can share the same environment. The =session= header
16684 argument is for running multiple source code blocks under one session.
16685 Org runs code blocks with the same session name in the same
16686 interpreter process.
16690 Default. Each code block gets a new interpreter process to
16691 execute. The process terminates once the block is evaluated.
16693 - {{{var(STRING)}}} ::
16695 Any string besides =none= turns that string into the name of that
16696 session. For example, =:session STRING= names it =STRING=. If
16697 =session= has no value, then the session name is derived from the
16698 source language identifier. Subsequent blocks with the same
16699 source code language use the same session. Depending on the
16700 language, state variables, code from other blocks, and the
16701 overall interpreted environment may be shared. Some interpreted
16702 languages support concurrent sessions when subsequent source code
16703 language blocks change session names.
16705 Only languages that provide interactive evaluation can have session
16706 support. Not all languages provide this support, such as C and ditaa.
16707 Even languages, such as Python and Haskell, that do support
16708 interactive evaluation impose limitations on allowable language
16709 constructs that can run interactively. Org inherits those limitations
16710 for those code blocks running in a session.
16712 *** Choosing a working directory
16717 #+cindex: working directory, in a code block
16718 #+cindex: @samp{dir}, header argument
16719 The =dir= header argument specifies the default directory during code
16720 block execution. If it is absent, then the directory associated with
16721 the current buffer is used. In other words, supplying =:dir PATH=
16722 temporarily has the same effect as changing the current directory with
16723 {{{kbd(M-x cd PATH)}}}, and then not setting =dir=. Under the
16724 surface, =dir= simply sets the value of the Emacs variable
16725 ~default-directory~.
16727 For example, to save the plot file in the =Work/= folder of the home
16728 directory---notice tilde is expanded:
16731 ,#+BEGIN_SRC R :file myplot.png :dir ~/Work
16732 matplot(matrix(rnorm(100), 10), type="l")
16736 To evaluate the code block on a remote machine, supply a remote
16737 directory name using Tramp syntax. For example:
16740 ,#+BEGIN_SRC R :file plot.png :dir /scp:dand@yakuba.princeton.edu:
16741 plot(1:10, main=system("hostname", intern=TRUE))
16745 Org first captures the text results as usual for insertion in the Org
16746 file. Then Org also inserts a link to the remote file, thanks to
16747 Emacs Tramp. Org constructs the remote path to the file name from
16748 =dir= and ~default-directory~, as illustrated here:
16750 : [[file:/scp:dand@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
16752 When =dir= is used with =session=, Org sets the starting directory for
16753 a new session. But Org does not alter the directory of an already
16756 Do not use =dir= with =:exports results= or with =:exports both= to
16757 avoid Org inserting incorrect links to remote files. That is because
16758 Org does not expand ~default directory~ to avoid some underlying
16759 portability issues.
16761 *** Inserting headers and footers
16766 #+cindex: headers, in code blocks
16767 #+cindex: footers, in code blocks
16768 #+cindex: @samp{prologue}, header argument
16769 The =prologue= header argument is for appending to the top of the code
16770 block for execution, like a reset instruction. For example, you may
16771 use =:prologue "reset"= in a Gnuplot code block or, for every such
16774 #+begin_src emacs-lisp
16775 (add-to-list 'org-babel-default-header-args:gnuplot
16776 '((:prologue . "reset")))
16780 #+cindex: @samp{epilogue}, header argument
16781 Likewise, the value of the =epilogue= header argument is for appending
16782 to the end of the code block for execution.
16784 ** Evaluating Code Blocks
16786 :DESCRIPTION: Place results of evaluation in the Org buffer.
16788 #+cindex: code block, evaluating
16789 #+cindex: source code, evaluating
16790 #+cindex: @samp{RESULTS}, keyword
16792 A note about security: With code evaluation comes the risk of harm.
16793 Org safeguards by prompting for user's permission before executing any
16794 code in the source block. To customize this safeguard, or disable it,
16795 see [[*Code Evaluation and Security Issues]].
16797 *** How to evaluate source code
16802 Org captures the results of the code block evaluation and inserts them
16803 in the Org file, right after the code block. The insertion point is
16804 after a newline and the =RESULTS= keyword. Org creates the =RESULTS=
16805 keyword if one is not already there.
16807 By default, Org enables only Emacs Lisp code blocks for execution.
16808 See [[*Languages]] to enable other languages.
16811 #+kindex: C-c C-v e
16812 #+findex: org-babel-execute-src-block
16813 Org provides many ways to execute code blocks. {{{kbd(C-c C-c)}}} or
16814 {{{kbd(C-c C-v e)}}} with the point on a code block[fn:132] calls the
16815 ~org-babel-execute-src-block~ function, which executes the code in the
16816 block, collects the results, and inserts them in the buffer.
16818 #+cindex: @samp{CALL}, keyword
16819 #+vindex: org-babel-inline-result-wrap
16820 By calling a named code block[fn:133] from an Org mode buffer or
16821 a table. Org can call the named code blocks from the current Org mode
16822 buffer or from the "Library of Babel" (see [[*Library of Babel]]).
16824 The syntax for =CALL= keyword is:
16827 ,#+CALL: <name>(<arguments>)
16828 ,#+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
16831 The syntax for inline named code blocks is:
16834 ... call_<name>(<arguments>) ...
16835 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
16838 When inline syntax is used, the result is wrapped based on the
16839 variable ~org-babel-inline-result-wrap~, which by default is set to
16840 ~"=%s="~ to produce verbatim text suitable for markup.
16844 This is the name of the code block (see [[*Structure of Code
16845 Blocks]]) to be evaluated in the current document. If the block is
16846 located in another file, start =<name>= with the file name
16847 followed by a colon. For example, in order to execute a block
16848 named =clear-data= in =file.org=, you can write the following:
16850 : #+CALL: file.org:clear-data()
16854 Org passes arguments to the code block using standard function
16855 call syntax. For example, a =#+CALL:= line that passes =4= to
16856 a code block named =double=, which declares the header argument
16857 =:var n=2=, would be written as:
16859 : #+CALL: double(n=4)
16861 #+texinfo: @noindent
16862 Note how this function call syntax is different from the header
16865 - =<inside header arguments>= ::
16867 Org passes inside header arguments to the named code block using
16868 the header argument syntax. Inside header arguments apply to
16869 code block evaluation. For example, =[:results output]= collects
16870 results printed to stdout during code execution of that block.
16871 Note how this header argument syntax is different from the
16872 function call syntax.
16874 - =<end header arguments>= ::
16876 End header arguments affect the results returned by the code
16877 block. For example, =:results html= wraps the results in
16878 a =#+BEGIN_EXPORT html= block before inserting the results in the
16881 *** Limit code block evaluation
16886 #+cindex: @samp{eval}, header argument
16887 #+cindex: control code block evaluation
16888 The =eval= header argument can limit evaluation of specific code
16889 blocks and =CALL= keyword. It is useful for protection against
16890 evaluating untrusted code blocks by prompting for a confirmation.
16892 - =never= or =no= ::
16894 Org never evaluates the source code.
16898 Org prompts the user for permission to evaluate the source code.
16900 - =never-export= or =no-export= ::
16902 Org does not evaluate the source code when exporting, yet the
16903 user can evaluate it interactively.
16905 - =query-export= ::
16907 Org prompts the user for permission to evaluate the source code
16910 If =eval= header argument is not set, then Org determines whether to
16911 evaluate the source code from the ~org-confirm-babel-evaluate~
16912 variable (see [[*Code Evaluation and Security Issues]]).
16914 *** Cache results of evaluation
16919 #+cindex: @samp{cache}, header argument
16920 #+cindex: cache results of code evaluation
16921 The =cache= header argument is for caching results of evaluating code
16922 blocks. Caching results can avoid re-evaluating a code block that
16923 have not changed since the previous run. To benefit from the cache
16924 and avoid redundant evaluations, the source block must have a result
16925 already present in the buffer, and neither the header
16926 arguments---including the value of =var= references---nor the text of
16927 the block itself has changed since the result was last computed. This
16928 feature greatly helps avoid long-running calculations. For some edge
16929 cases, however, the cached results may not be reliable.
16931 The caching feature is best for when code blocks are pure functions,
16932 that is functions that return the same value for the same input
16933 arguments (see [[*Environment of a Code Block]]), and that do not have
16934 side effects, and do not rely on external variables other than the
16935 input arguments. Functions that depend on a timer, file system
16936 objects, and random number generators are clearly unsuitable for
16939 A note of warning: when =cache= is used in a session, caching may
16940 cause unexpected results.
16942 When the caching mechanism tests for any source code changes, it does
16943 not expand Noweb style references (see [[*Noweb Reference Syntax]]). For
16944 reasons why, see http://thread.gmane.org/gmane.emacs.orgmode/79046.
16946 The =cache= header argument can have one of two values: =yes= or =no=.
16950 Default. No caching of results; code block evaluated every
16955 Whether to run the code or return the cached results is
16956 determined by comparing the SHA1 hash value of the combined code
16957 block and arguments passed to it. This hash value is packed on
16958 the =#+RESULTS:= line from previous evaluation. When hash values
16959 match, Org does not evaluate the code block. When hash values
16960 mismatch, Org evaluates the code block, inserts the results,
16961 recalculates the hash value, and updates =#+RESULTS:= line.
16963 In this example, both functions are cached. But =caller= runs only if
16964 the result from =random= has changed since the last run.
16968 ,#+BEGIN_SRC R :cache yes
16972 ,#+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
16976 ,#+BEGIN_SRC emacs-lisp :var x=random :cache yes
16980 ,#+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
16984 ** Results of Evaluation
16986 :DESCRIPTION: Choosing a results type, post-processing...
16988 #+cindex: code block, results of evaluation
16989 #+cindex: source code, results of evaluation
16991 #+cindex: @samp{results}, header argument
16992 How Org handles results of a code block execution depends on many
16993 header arguments working together. The primary determinant, however,
16994 is the =results= header argument. It accepts four classes of options.
16995 Each code block can take only one option per class:
16999 For how the results should be collected from the code block;
17003 For which type of result the code block will return; affects how
17004 Org processes and inserts results in the Org buffer;
17008 For the result; affects how Org processes and inserts results in
17013 For processing results after evaluation of the code block;
17020 Collection options specify the results. Choose one of the options;
17021 they are mutually exclusive.
17025 Default. Functional mode. Org gets the value by wrapping the
17026 code in a function definition in the language of the source
17027 block. That is why when using =:results value=, code should
17028 execute like a function and return a value. For languages like
17029 Python, an explicit ~return~ statement is mandatory when using
17030 =:results value=. Result is the value returned by the last
17031 statement in the code block.
17033 When evaluating the code block in a session (see [[*Environment of
17034 a Code Block]]), Org passes the code to an interpreter running as
17035 an interactive Emacs inferior process. Org gets the value from
17036 the source code interpreter's last statement output. Org has to
17037 use language-specific methods to obtain the value. For example,
17038 from the variable ~_~ in Python and Ruby, and the value of
17039 ~.Last.value~ in R.
17043 Scripting mode. Org passes the code to an external process
17044 running the interpreter. Org returns the contents of the
17045 standard output stream as text results.
17047 When using a session, Org passes the code to the interpreter
17048 running as an interactive Emacs inferior process. Org
17049 concatenates any text output from the interpreter and returns the
17050 collection as a result.
17052 Note that this collection is not the same as that would be
17053 collected from stdout of a non-interactive interpreter running as
17054 an external process. Compare for example these two blocks:
17057 ,#+BEGIN_SRC python :results output
17068 In the above non-session mode, the "2" is not printed; so it does
17069 not appear in results.
17072 ,#+BEGIN_SRC python :results output :session
17084 In the above session, the interactive interpreter receives and
17085 prints "2". Results show that.
17092 Type tells what result types to expect from the execution of the code
17093 block. Choose one of the options; they are mutually exclusive. The
17094 default behavior is to automatically determine the result type.
17096 #+attr_texinfo: :sep ,
17097 - =table=, =vector= ::
17099 Interpret the results as an Org table. If the result is a single
17100 value, create a table with one row and one column. Usage
17101 example: =:results value table=.
17103 #+cindex: @samp{hlines}, header argument
17104 In-between each table row or below the table headings, sometimes
17105 results have horizontal lines, which are also known as "hlines".
17106 The =hlines= argument with the default =no= value strips such
17107 lines from the input table. For most code, this is desirable, or
17108 else those =hline= symbols raise unbound variable errors.
17109 A =yes= accepts such lines, as demonstrated in the following
17121 ,#+BEGIN_SRC python :var tab=many-cols :hlines no
17125 ,#+RESULTS: no-hline
17131 ,#+BEGIN_SRC python :var tab=many-cols :hlines yes
17145 Interpret the results as an Org list. If the result is a single
17146 value, create a list of one element.
17148 - =scalar=, =verbatim= ::
17150 Interpret literally and insert as quoted text. Do not create
17151 a table. Usage example: =:results value verbatim=.
17155 Interpret as a filename. Save the results of execution of the
17156 code block to that file, then insert a link to it. You can
17157 control both the filename and the description associated to the
17160 #+cindex: @samp{file}, header argument
17161 #+cindex: @samp{output-dir}, header argument
17162 Org first tries to generate the filename from the value of the
17163 =file= header argument and the directory specified using the
17164 =output-dir= header arguments. If =output-dir= is not specified,
17165 Org assumes it is the current directory.
17168 ,#+BEGIN_SRC asymptote :results value file :file circle.pdf :output-dir img/
17174 #+cindex: @samp{file-ext}, header argument
17175 If =file= is missing, Org generates the base name of the output
17176 file from the name of the code block, and its extension from the
17177 =file-ext= header argument. In that case, both the name and the
17178 extension are mandatory.[fn:150]
17182 ,#+BEGIN_SRC asymptote :results value file :file-ext pdf
17188 #+cindex: @samp{file-desc}, header argument
17189 The =file-desc= header argument defines the description (see
17190 [[*Link Format]]) for the link. If =file-desc= has no value, Org
17191 uses the generated file name for both the "link" and
17192 "description" parts of the link.
17194 #+cindex: @samp{sep}, header argument
17195 By default, Org assumes that a table written to a file has
17196 TAB-delimited output. You can choose a different separator with
17197 the =sep= header argument.
17204 Format pertains to the type of the result returned by the code block.
17205 Choose one of the options; they are mutually exclusive. The default
17206 follows from the type specified above.
17208 #+attr_texinfo: :sep ,
17211 Result enclosed in a code block. Useful for parsing. Usage
17212 example: =:results value code=.
17216 Result wrapped in a =RESULTS= drawer. Useful for containing
17217 =raw= or =org= results for later scripting and automated
17218 processing. Usage example: =:results value drawer=.
17222 Results enclosed in a =BEGIN_EXPORT html= block. Usage example:
17223 =:results value html=.
17227 Results enclosed in a =BEGIN_EXPORT latex= block. Usage example:
17228 =:results value latex=.
17230 - =link=, =graphics= ::
17232 Result is a link to the file specified in =:file= header
17233 argument. However, unlike plain =:file=, nothing is written to
17234 the disk. The block is used for its side-effects only, as in the
17238 ,#+begin_src shell :results link :file "download.tar.gz"
17239 wget -c "http://example.com/download.tar.gz"
17245 Results enclosed in a =BEGIN_SRC org= block. For comma-escape,
17246 either {{{kbd(TAB)}}} in the block, or export the file. Usage
17247 example: =:results value org=.
17251 Result converted to pretty-print source code. Enclosed in a code
17252 block. Languages supported: Emacs Lisp, Python, and Ruby. Usage
17253 example: =:results value pp=.
17257 Interpreted as raw Org mode. Inserted directly into the buffer.
17258 Aligned if it is a table. Usage example: =:results value raw=.
17260 #+cindex: @samp{wrap}, header argument
17261 The =wrap= header argument unconditionnally marks the results block by
17262 appending strings to =#+BEGIN_= and =#+END_=. If no string is
17263 specified, Org wraps the results in a =#+BEGIN_results=
17264 ... =#+END_results= block. It takes precedent over the =results=
17265 value listed above. E.g.,
17268 ,#+BEGIN_SRC emacs-lisp :results html :wrap EXPORT markdown
17269 "<blink>Welcome back to the 90's</blink>"
17273 ,#+BEGIN_EXPORT markdown
17274 <blink>Welcome back to the 90's</blink>
17283 Handling options after collecting the results.
17287 Do not insert results in the Org mode buffer, but echo them in
17288 the minibuffer. Usage example: =:results output silent=.
17292 Default. Insert results in the Org buffer. Remove previous
17293 results. Usage example: =:results output replace=.
17297 Append results to the Org buffer. Latest results are at the
17298 bottom. Does not remove previous results. Usage example:
17299 =:results output append=.
17303 Prepend results to the Org buffer. Latest results are at the
17304 top. Does not remove previous results. Usage example: =:results
17307 *** Post-processing
17312 #+cindex: @samp{post}, header argument
17313 #+cindex: @samp{*this*}, in @samp{post} header argument
17314 The =post= header argument is for post-processing results from block
17315 evaluation. When =post= has any value, Org binds the results to
17316 ~*this*~ variable for easy passing to =var= header argument
17317 specifications (see [[*Environment of a Code Block]]). That makes results
17318 available to other code blocks, or even for direct Emacs Lisp code
17321 The following two examples illustrate =post= header argument in
17322 action. The first one shows how to attach an =ATTR_LATEX= keyword
17327 ,#+BEGIN_SRC sh :var data="" :var width="\\textwidth" :results output
17328 echo "#+ATTR_LATEX: :width $width"
17332 ,#+HEADER: :file /tmp/it.png
17333 ,#+BEGIN_SRC dot :post attr_wrap(width="5cm", data=*this*) :results drawer
17343 ,#+ATTR_LATEX :width 5cm
17344 [[file:/tmp/it.png]]
17348 The second example shows use of =colnames= header argument in =post=
17349 to pass data between code blocks.
17353 ,#+BEGIN_SRC emacs-lisp :var tbl="" fmt="%.3f"
17354 (mapcar (lambda (row)
17355 (mapcar (lambda (cell)
17363 ,#+BEGIN_SRC R :colnames yes :post round-tbl[:colnames yes](*this*)
17365 data.frame(foo=rnorm(1))
17374 ** Exporting Code Blocks
17376 :DESCRIPTION: Export contents and/or results.
17378 #+cindex: code block, exporting
17379 #+cindex: source code, exporting
17381 It is possible to export the /code/ of code blocks, the /results/ of
17382 code block evaluation, /both/ the code and the results of code block
17383 evaluation, or /none/. Org defaults to exporting /code/ for most
17384 languages. For some languages, such as ditaa, Org defaults to
17385 /results/. To export just the body of code blocks, see [[*Literal
17386 Examples]]. To selectively export sub-trees of an Org document, see
17389 #+cindex: @samp{exports}, header argument
17390 The =exports= header argument is to specify if that part of the Org
17391 file is exported to, say, HTML or LaTeX formats.
17395 The default. The body of code is included into the exported
17396 file. Example: =:exports code=.
17400 The results of evaluation of the code is included in the exported
17401 file. Example: =:exports results=.
17405 Both the code and results of evaluation are included in the
17406 exported file. Example: =:exports both=.
17410 Neither the code nor the results of evaluation is included in the
17411 exported file. Whether the code is evaluated at all depends on
17412 other options. Example: =:exports none=.
17414 #+vindex: org-export-use-babel
17415 To stop Org from evaluating code blocks to speed exports, use the
17416 header argument =:eval never-export= (see [[*Evaluating Code Blocks]]).
17417 To stop Org from evaluating code blocks for greater security, set the
17418 ~org-export-use-babel~ variable to ~nil~, but understand that header
17419 arguments will have no effect.
17421 Turning off evaluation comes in handy when batch processing. For
17422 example, markup languages for wikis, which have a high risk of
17423 untrusted code. Stopping code block evaluation also stops evaluation
17424 of all header arguments of the code block. This may not be desirable
17425 in some circumstances. So during export, to allow evaluation of just
17426 the header arguments but not any code evaluation in the source block,
17427 set =:eval never-export= (see [[*Evaluating Code Blocks]]).
17429 Org never evaluates code blocks in commented sub-trees when exporting
17430 (see [[*Comment Lines]]). On the other hand, Org does evaluate code
17431 blocks in sub-trees excluded from export (see [[*Export Settings]]).
17433 ** Extracting Source Code
17435 :DESCRIPTION: Create pure source code files.
17438 #+cindex: source code, extracting
17439 #+cindex: code block, extracting source code
17441 Extracting source code from code blocks is a basic task in literate
17442 programming. Org has features to make this easy. In literate
17443 programming parlance, documents on creation are /woven/ with code and
17444 documentation, and on export, the code is tangled for execution by
17445 a computer. Org facilitates weaving and tangling for producing,
17446 maintaining, sharing, and exporting literate programming documents.
17447 Org provides extensive customization options for extracting source
17450 When Org tangles code blocks, it expands, merges, and transforms them.
17451 Then Org recomposes them into one or more separate files, as
17452 configured through the options. During this tangling process, Org
17453 expands variables in the source code, and resolves any Noweb style
17454 references (see [[*Noweb Reference Syntax]]).
17456 *** Header arguments
17461 #+cindex: @samp{tangle}, header argument
17462 The =tangle= header argument specifies if the code block is exported
17467 Export the code block to source file. The file name for the
17468 source file is derived from the name of the Org file, and the
17469 file extension is derived from the source code language
17470 identifier. Example: =:tangle yes=.
17474 The default. Do not extract the code in a source code file.
17475 Example: =:tangle no=.
17477 - {{{var(FILENAME)}}} ::
17479 Export the code block to source file whose file name is derived
17480 from any string passed to the =tangle= header argument. Org
17481 derives the file name as being relative to the directory of the
17482 Org file's location. Example: =:tangle FILENAME=.
17484 #+cindex: @samp{mkdirp}, header argument
17485 The =mkdirp= header argument creates parent directories for tangled
17486 files if the directory does not exist. =yes= enables directory
17487 creation and =no= inhibits directory creation.
17489 #+cindex: @samp{comments}, header argument
17490 The =comments= header argument controls inserting comments into
17491 tangled files. These are above and beyond whatever comments may
17492 already exist in the code block.
17496 The default. Do not insert any extra comments during tangling.
17500 Wrap the code block in comments. Include links pointing back to
17501 the place in the Org file from where the code was tangled.
17505 Kept for backward compatibility; same as =link=.
17509 Nearest headline text from Org file is inserted as comment. The
17510 exact text that is inserted is picked from the leading context of
17515 Includes both =link= and =org= options.
17519 Includes =link= option, expands Noweb references (see [[*Noweb
17520 Reference Syntax]]), and wraps them in link comments inside the
17521 body of the code block.
17523 #+cindex: @samp{padline}, header argument
17524 The =padline= header argument controls insertion of newlines to pad
17525 source code in the tangled file.
17529 Default. Insert a newline before and after each code block in
17534 Do not insert newlines to pad the tangled code blocks.
17536 #+cindex: @samp{shebang}, header argument
17537 The =shebang= header argument can turn results into executable script
17538 files. By setting it to a string value---for example, =:shebang
17539 "#!/bin/bash"=---Org inserts that string as the first line of the
17540 tangled file that the code block is extracted to. Org then turns on
17541 the tangled file's executable permission.
17543 #+cindex: @samp{tangle-mode}, header argument
17544 The =tangle-mode= header argument specifies what permissions to set
17545 for tangled files by ~set-file-modes~. For example, to make
17546 a read-only tangled file, use =:tangle-mode (identity #o444)=. To
17547 make it executable, use =:tangle-mode (identity #o755)=. It also
17548 overrides executable permission granted by =shebang=. When multiple
17549 source code blocks tangle to a single file with different and
17550 conflicting =tangle-mode= header arguments, Org's behavior is
17553 #+cindex: @samp{no-expand}, header argument
17554 By default Org expands code blocks during tangling. The =no-expand=
17555 header argument turns off such expansions. Note that one side-effect
17556 of expansion by ~org-babel-expand-src-block~ also assigns values (see
17557 [[*Environment of a Code Block]]) to variables. Expansions also replace
17558 Noweb references with their targets (see [[*Noweb Reference Syntax]]).
17559 Some of these expansions may cause premature assignment, hence this
17560 option. This option makes a difference only for tangling. It has no
17561 effect when exporting since code blocks for execution have to be
17569 - ~org-babel-tangle~ ::
17571 #+findex: org-babel-tangle
17572 #+kindex: C-c C-v t
17573 Tangle the current file. Bound to {{{kbd(C-c C-v t)}}}.
17575 With prefix argument only tangle the current code block.
17577 - ~org-babel-tangle-file~ ::
17579 #+findex: org-babel-tangle-file
17580 #+kindex: C-c C-v f
17581 Choose a file to tangle. Bound to {{{kbd(C-c C-v f)}}}.
17588 - ~org-babel-post-tangle-hook~ ::
17590 #+vindex: org-babel-post-tangle-hook
17591 This hook is run from within code files tangled by
17592 ~org-babel-tangle~, making it suitable for post-processing,
17593 compilation, and evaluation of code in the tangled files.
17595 *** Jumping between code and Org
17600 #+findex: org-babel-tangle-jump-to-org
17601 Debuggers normally link errors and messages back to the source code.
17602 But for tangled files, we want to link back to the Org file, not to
17603 the tangled source file. To make this extra jump, Org uses
17604 ~org-babel-tangle-jump-to-org~ function with two additional source
17605 code block header arguments:
17607 1. Set =padline= to true---this is the default setting.
17608 2. Set =comments= to =link=, which makes Org insert links to the Org
17613 :DESCRIPTION: List of supported code block languages.
17615 #+cindex: babel, languages
17616 #+cindex: source code, languages
17617 #+cindex: code block, languages
17619 Code blocks in the following languages are supported.
17621 | Language | Identifier | Language | Identifier |
17622 |------------+--------------+----------------+--------------|
17623 | Asymptote | =asymptote= | Lua | =lua= |
17624 | Awk | =awk= | MATLAB | =matlab= |
17625 | C | =C= | Mscgen | =mscgen= |
17626 | C++ | =C++= | Objective Caml | =ocaml= |
17627 | Clojure | =clojure= | Octave | =octave= |
17628 | CSS | =css= | Org mode | =org= |
17629 | D | =d= | Oz | =oz= |
17630 | ditaa | =ditaa= | Perl | =perl= |
17631 | Emacs Calc | =calc= | Plantuml | =plantuml= |
17632 | Emacs Lisp | =emacs-lisp= | Processing.js | =processing= |
17633 | Fortran | =fortran= | Python | =python= |
17634 | Gnuplot | =gnuplot= | R | =R= |
17635 | GNU Screen | =screen= | Ruby | =ruby= |
17636 | Graphviz | =dot= | Sass | =sass= |
17637 | Haskell | =haskell= | Scheme | =scheme= |
17638 | Java | =java= | Sed | =sed= |
17639 | Javascript | =js= | shell | =sh= |
17640 | LaTeX | =latex= | SQL | =sql= |
17641 | Ledger | =ledger= | SQLite | =sqlite= |
17642 | Lilypond | =lilypond= | Vala | =vala= |
17643 | Lisp | =lisp= | | |
17645 Additional documentation for some languages is at
17646 https://orgmode.org/worg/org-contrib/babel/languages.html.
17648 #+vindex: org-babel-load-languages
17649 By default, only Emacs Lisp is enabled for evaluation. To enable or
17650 disable other languages, customize the ~org-babel-load-languages~
17651 variable either through the Emacs customization interface, or by
17652 adding code to the init file as shown next.
17654 In this example, evaluation is disabled for Emacs Lisp, and enabled
17657 #+begin_src emacs-lisp
17658 (org-babel-do-load-languages
17659 'org-babel-load-languages
17660 '((emacs-lisp . nil)
17664 Note that this is not the only way to enable a language. Org also
17665 enables languages when loaded with ~require~ statement. For example,
17666 the following enables execution of Clojure code blocks:
17668 #+begin_src emacs-lisp
17669 (require 'ob-clojure)
17672 ** Editing Source Code
17674 :DESCRIPTION: Language major-mode editing.
17676 #+cindex: code block, editing
17677 #+cindex: source code, editing
17680 Use {{{kbd(C-c ')}}} to edit the current code block. It opens a new
17681 major-mode edit buffer containing the body of the source code block,
17682 ready for any edits. Use {{{kbd(C-c ')}}} again to close the buffer
17683 and return to the Org buffer.
17686 #+vindex: org-edit-src-auto-save-idle-delay
17687 #+cindex: auto-save, in code block editing
17688 {{{kbd(C-x C-s)}}} saves the buffer and updates the contents of the
17689 Org buffer. Set ~org-edit-src-auto-save-idle-delay~ to save the base
17690 buffer after a certain idle delay time. Set
17691 ~org-edit-src-turn-on-auto-save~ to auto-save this buffer into
17692 a separate file using Auto-save mode.
17694 While editing the source code in the major mode, the Org Src minor
17695 mode remains active. It provides these customization variables as
17696 described below. For even more variables, look in the customization
17697 group ~org-edit-structure~.
17699 - ~org-src-lang-modes~ ::
17701 #+vindex: org-src-lang-modes
17702 If an Emacs major-mode named ~<LANG>-mode~ exists, where
17703 {{{var(<LANG>)}}} is the language identifier from code block's
17704 header line, then the edit buffer uses that major mode. Use this
17705 variable to arbitrarily map language identifiers to major modes.
17707 - ~org-src-window-setup~ ::
17709 #+vindex: org-src-window-setup
17710 For specifying Emacs window arrangement when the new edit buffer
17713 - ~org-src-preserve-indentation~ ::
17715 #+cindex: indentation, in code blocks
17716 #+vindex: org-src-preserve-indentation
17717 Default is ~nil~. Source code is indented. This indentation
17718 applies during export or tangling, and depending on the context,
17719 may alter leading spaces and tabs. When non-~nil~, source code
17720 is aligned with the leftmost column. No lines are modified
17721 during export or tangling, which is very useful for white-space
17722 sensitive languages, such as Python.
17724 - ~org-src-ask-before-returning-to-edit-buffer~ ::
17726 #+vindex: org-src-ask-before-returning-to-edit-buffer
17727 When ~nil~, Org returns to the edit buffer without further
17728 prompts. The default prompts for a confirmation.
17730 #+vindex: org-src-fontify-natively
17731 #+vindex: org-src-block-faces
17732 Set ~org-src-fontify-natively~ to non-~nil~ to turn on native code
17733 fontification in the /Org/ buffer. Fontification of code blocks can
17734 give visual separation of text and code on the display page. To
17735 further customize the appearance of ~org-block~ for specific
17736 languages, customize ~org-src-block-faces~. The following example
17737 shades the background of regular blocks, and colors source blocks only
17738 for Python and Emacs Lisp languages.
17740 #+begin_src emacs-lisp
17742 (set-face-attribute 'org-block nil :background
17744 (face-attribute 'default :background) 3))
17746 (setq org-src-block-faces '(("emacs-lisp" (:background "#EEE2FF"))
17747 ("python" (:background "#E5FFB8"))))
17750 ** Noweb Reference Syntax
17752 :DESCRIPTION: Literate programming in Org mode.
17754 #+cindex: code block, Noweb reference
17755 #+cindex: syntax, Noweb
17756 #+cindex: source code, Noweb reference
17758 Org supports named blocks in Noweb[fn:134] style syntax:
17760 : <<CODE-BLOCK-ID>>
17762 Org can replace the construct with the source code, or the results of
17763 evaluation, of the code block identified as {{{var(CODE-BLOCK-ID)}}}.
17765 #+cindex: @samp{noweb}, header argument
17766 The =noweb= header argument controls expansion of Noweb syntax
17767 references. Expansions occur when source code blocks are evaluated,
17768 tangled, or exported.
17772 Default. No expansion of Noweb syntax references in the body of
17773 the code when evaluating, tangling, or exporting.
17777 Expansion of Noweb syntax references in the body of the code
17778 block when evaluating, tangling, or exporting.
17782 Expansion of Noweb syntax references in the body of the code
17783 block when tangling. No expansion when evaluating or exporting.
17787 Expansion of Noweb syntax references in the body of the code
17788 block when evaluating or tangling. No expansion when exporting.
17790 - =strip-export= ::
17792 Expansion of Noweb syntax references in the body of the code
17793 block when expanding prior to evaluating or tangling. Removes
17794 Noweb syntax references when exporting.
17798 Expansion of Noweb syntax references in the body of the code
17799 block only before evaluating.
17801 In the following example,
17804 ,#+NAME: initialization
17805 ,#+BEGIN_SRC emacs-lisp
17806 (setq sentence "Never a foot too far, even.")
17809 ,#+BEGIN_SRC emacs-lisp :noweb yes
17815 #+texinfo: @noindent
17816 the second code block is expanded as
17819 ,#+BEGIN_SRC emacs-lisp :noweb yes
17820 (setq sentence "Never a foot too far, even.")
17825 Noweb insertions honor prefix characters that appear before the Noweb
17826 syntax reference. This behavior is illustrated in the following
17827 example. Because the =<<example>>= Noweb reference appears behind the
17828 SQL comment syntax, each line of the expanded Noweb reference is
17835 multi-line body of example
17839 #+texinfo: @noindent
17843 ,#+BEGIN_SRC sql :noweb yes
17848 #+texinfo: @noindent
17852 ,#+BEGIN_SRC sql :noweb yes
17854 ---multi-line body of example
17858 Since this change does not affect Noweb replacement text without
17859 newlines in them, inline Noweb references are acceptable.
17861 This feature can also be used for management of indentation in
17862 exported code snippets. With:
17866 ,#+BEGIN_SRC python :exports none
17867 print('do things when true')
17871 ,#+begin_src python :exports none
17872 print('do things when false')
17876 #+texinfo: @noindent
17880 ,#+begin_src python :noweb yes :results output
17888 #+texinfo: @noindent
17893 print('do things when true')
17895 print('do things when false')
17898 #+cindex: @samp{noweb-ref}, header argument
17899 When expanding Noweb style references, Org concatenates code blocks by
17900 matching the reference name to either the code block name or, if none
17901 is found, to the =noweb-ref= header argument.
17903 For simple concatenation, set this =noweb-ref= header argument at the
17904 sub-tree or file level. In the example Org file shown next, the body
17905 of the source code in each block is extracted for concatenation to
17906 a pure code file when tangled.
17909 ,#+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
17912 ,* the mount point of the fullest disk
17914 :header-args: :noweb-ref fullest-disk
17917 ,** query all mounted disks
17922 ,** strip the header row
17927 ,** output mount point of fullest disk
17929 |awk '{if (u < +$5) {u = +$5; m = $6}} END {print m}'
17933 #+cindex: @samp{noweb-sep}, header argument
17934 By default a newline separates each noweb reference concatenation. To
17935 change this newline separator, edit the =noweb-sep= header argument.
17937 Eventually, Org can include the results of a code block rather than
17938 its body. To that effect, append parentheses, possibly including
17939 arguments, to the code block name, as shown below.
17941 : <<code-block-name(optional arguments)>>
17943 Note that when using the above approach to a code block's results, the
17944 code block name set by =NAME= keyword is required; the reference set
17945 by =noweb-ref= does not work in that case.
17947 Here is an example that demonstrates how the exported content changes
17948 when Noweb style references are used with parentheses versus without.
17953 ,#+BEGIN_SRC python :var num=0 :results output :exports none
17958 #+texinfo: @noindent
17962 ,#+BEGIN_SRC text :noweb yes
17967 #+texinfo: @noindent
17972 Below, a similar Noweb style reference is used, but with parentheses,
17973 while setting a variable =num= to 10:
17976 ,#+BEGIN_SRC text :noweb yes
17977 <<some-code(num=10)>>
17981 #+texinfo: @noindent
17982 Note that now the expansion contains the results of the code block
17983 =some-code=, not the code block itself:
17987 ** Library of Babel
17989 :DESCRIPTION: Use and contribute to a library of useful code blocks.
17991 #+cindex: babel, library of
17992 #+cindex: source code, library
17993 #+cindex: code block, library
17995 The "Library of Babel" is a collection of code blocks. Like
17996 a function library, these code blocks can be called from other Org
17997 files. A collection of useful code blocks is available on [[https://orgmode.org/worg/library-of-babel.html][Worg]]. For
17998 remote code block evaluation syntax, see [[*Evaluating Code Blocks]].
18000 #+kindex: C-c C-v i
18001 #+findex: org-babel-lob-ingest
18002 For any user to add code to the library, first save the code in
18003 regular code blocks of an Org file, and then load the Org file with
18004 ~org-babel-lob-ingest~, which is bound to {{{kbd(C-c C-v i)}}}.
18006 ** Key bindings and Useful Functions
18008 :DESCRIPTION: Work quickly with code blocks.
18010 #+cindex: code block, key bindings
18012 Many common Org mode key sequences are re-bound depending on
18015 Active key bindings in code blocks:
18018 #+findex: org-babel-execute-src-block
18020 #+findex: org-babel-open-src-block-result
18022 #+findex: org-babel-load-in-session
18024 #+findex: org-babel-pop-to-session
18025 #+attr_texinfo: :columns 0.2 0.55
18026 | Key binding | Function |
18027 |--------------------+-----------------------------------|
18028 | {{{kbd(C-c C-c)}}} | ~org-babel-execute-src-block~ |
18029 | {{{kbd(C-c C-o)}}} | ~org-babel-open-src-block-result~ |
18030 | {{{kbd(M-UP)}}} | ~org-babel-load-in-session~ |
18031 | {{{kbd(M-DOWN)}}} | ~org-babel-pop-to-session~ |
18033 Active key bindings in Org mode buffer:
18035 #+kindex: C-c C-v p
18036 #+kindex: C-c C-v C-p
18037 #+kindex: C-c C-v n
18038 #+kindex: C-c C-v C-n
18039 #+kindex: C-c C-v e
18040 #+kindex: C-c C-v C-e
18041 #+kindex: C-c C-v o
18042 #+kindex: C-c C-v C-o
18043 #+kindex: C-c C-v v
18044 #+kindex: C-c C-v C-v
18045 #+kindex: C-c C-v u
18046 #+kindex: C-c C-v C-u
18047 #+kindex: C-c C-v g
18048 #+kindex: C-c C-v C-g
18049 #+kindex: C-c C-v r
18050 #+kindex: C-c C-v C-r
18051 #+kindex: C-c C-v b
18052 #+kindex: C-c C-v C-b
18053 #+kindex: C-c C-v s
18054 #+kindex: C-c C-v C-s
18055 #+kindex: C-c C-v d
18056 #+kindex: C-c C-v C-d
18057 #+kindex: C-c C-v t
18058 #+kindex: C-c C-v C-t
18059 #+kindex: C-c C-v f
18060 #+kindex: C-c C-v C-f
18061 #+kindex: C-c C-v c
18062 #+kindex: C-c C-v C-c
18063 #+kindex: C-c C-v j
18064 #+kindex: C-c C-v C-j
18065 #+kindex: C-c C-v l
18066 #+kindex: C-c C-v C-l
18067 #+kindex: C-c C-v i
18068 #+kindex: C-c C-v C-i
18069 #+kindex: C-c C-v I
18070 #+kindex: C-c C-v C-I
18071 #+kindex: C-c C-v z
18072 #+kindex: C-c C-v C-z
18073 #+kindex: C-c C-v a
18074 #+kindex: C-c C-v C-a
18075 #+kindex: C-c C-v h
18076 #+kindex: C-c C-v C-h
18077 #+kindex: C-c C-v x
18078 #+kindex: C-c C-v C-x
18079 #+findex: org-babel-previous-src-block
18080 #+findex: org-babel-next-src-block
18081 #+findex: org-babel-execute-maybe
18082 #+findex: org-babel-open-src-block-result
18083 #+findex: org-babel-expand-src-block
18084 #+findex: org-babel-goto-src-block-head
18085 #+findex: org-babel-goto-named-src-block
18086 #+findex: org-babel-goto-named-result
18087 #+findex: org-babel-execute-buffer
18088 #+findex: org-babel-execute-subtree
18089 #+findex: org-babel-demarcate-block
18090 #+findex: org-babel-tangle
18091 #+findex: org-babel-tangle-file
18092 #+findex: org-babel-check-src-block
18093 #+findex: org-babel-insert-header-arg
18094 #+findex: org-babel-load-in-session
18095 #+findex: org-babel-lob-ingest
18096 #+findex: org-babel-view-src-block-info
18097 #+findex: org-babel-switch-to-session-with-code
18098 #+findex: org-babel-sha1-hash
18099 #+findex: org-babel-describe-bindings
18100 #+findex: org-babel-do-key-sequence-in-edit-buffer
18101 #+attr_texinfo: :columns 0.45 0.55
18102 | Key binding | Function |
18103 |------------------------------------------------+--------------------------------------------|
18104 | {{{kbd(C-c C-v p)}}} or {{{kbd(C-c C-v C-p)}}} | ~org-babel-previous-src-block~ |
18105 | {{{kbd(C-c C-v n)}}} or {{{kbd(C-c C-v C-n)}}} | ~org-babel-next-src-block~ |
18106 | {{{kbd(C-c C-v e)}}} or {{{kbd(C-c C-v C-e)}}} | ~org-babel-execute-maybe~ |
18107 | {{{kbd(C-c C-v o)}}} or {{{kbd(C-c C-v C-o)}}} | ~org-babel-open-src-block-result~ |
18108 | {{{kbd(C-c C-v v)}}} or {{{kbd(C-c C-v C-v)}}} | ~org-babel-expand-src-block~ |
18109 | {{{kbd(C-c C-v u)}}} or {{{kbd(C-c C-v C-u)}}} | ~org-babel-goto-src-block-head~ |
18110 | {{{kbd(C-c C-v g)}}} or {{{kbd(C-c C-v C-g)}}} | ~org-babel-goto-named-src-block~ |
18111 | {{{kbd(C-c C-v r)}}} or {{{kbd(C-c C-v C-r)}}} | ~org-babel-goto-named-result~ |
18112 | {{{kbd(C-c C-v b)}}} or {{{kbd(C-c C-v C-b)}}} | ~org-babel-execute-buffer~ |
18113 | {{{kbd(C-c C-v s)}}} or {{{kbd(C-c C-v C-s)}}} | ~org-babel-execute-subtree~ |
18114 | {{{kbd(C-c C-v d)}}} or {{{kbd(C-c C-v C-d)}}} | ~org-babel-demarcate-block~ |
18115 | {{{kbd(C-c C-v t)}}} or {{{kbd(C-c C-v C-t)}}} | ~org-babel-tangle~ |
18116 | {{{kbd(C-c C-v f)}}} or {{{kbd(C-c C-v C-f)}}} | ~org-babel-tangle-file~ |
18117 | {{{kbd(C-c C-v c)}}} or {{{kbd(C-c C-v C-c)}}} | ~org-babel-check-src-block~ |
18118 | {{{kbd(C-c C-v j)}}} or {{{kbd(C-c C-v C-j)}}} | ~org-babel-insert-header-arg~ |
18119 | {{{kbd(C-c C-v l)}}} or {{{kbd(C-c C-v C-l)}}} | ~org-babel-load-in-session~ |
18120 | {{{kbd(C-c C-v i)}}} or {{{kbd(C-c C-v C-i)}}} | ~org-babel-lob-ingest~ |
18121 | {{{kbd(C-c C-v I)}}} or {{{kbd(C-c C-v C-I)}}} | ~org-babel-view-src-block-info~ |
18122 | {{{kbd(C-c C-v z)}}} or {{{kbd(C-c C-v C-z)}}} | ~org-babel-switch-to-session-with-code~ |
18123 | {{{kbd(C-c C-v a)}}} or {{{kbd(C-c C-v C-a)}}} | ~org-babel-sha1-hash~ |
18124 | {{{kbd(C-c C-v h)}}} or {{{kbd(C-c C-v C-h)}}} | ~org-babel-describe-bindings~ |
18125 | {{{kbd(C-c C-v x)}}} or {{{kbd(C-c C-v C-x)}}} | ~org-babel-do-key-sequence-in-edit-buffer~ |
18129 :DESCRIPTION: Call functions from the command line.
18131 #+cindex: code block, batch execution
18132 #+cindex: source code, batch execution
18134 Org mode features, including working with source code facilities can
18135 be invoked from the command line. This enables building shell scripts
18136 for batch processing, running automated system tasks, and expanding
18137 Org mode's usefulness.
18139 The sample script shows batch processing of multiple files using
18140 ~org-babel-tangle~.
18144 # Tangle files with Org mode
18146 emacs -Q --batch --eval "
18148 (require 'ob-tangle)
18149 (dolist (file command-line-args-left)
18150 (with-current-buffer (find-file-noselect file)
18151 (org-babel-tangle))))
18157 :DESCRIPTION: All the rest which did not fit elsewhere.
18162 :DESCRIPTION: M-@key{TAB} guesses completions.
18164 #+cindex: completion, of @TeX{} symbols
18165 #+cindex: completion, of TODO keywords
18166 #+cindex: completion, of dictionary words
18167 #+cindex: completion, of option keywords
18168 #+cindex: completion, of tags
18169 #+cindex: completion, of property keys
18170 #+cindex: completion, of link abbreviations
18171 #+cindex: @TeX{} symbol completion
18172 #+cindex: TODO keywords completion
18173 #+cindex: dictionary word completion
18174 #+cindex: option keyword completion
18175 #+cindex: tag completion
18176 #+cindex: link abbreviations, completion of
18178 Org has in-buffer completions. Unlike minibuffer completions, which
18179 are useful for quick command interactions, Org's in-buffer completions
18180 are more suitable for content creation in Org documents. Type one or
18181 more letters and invoke the hot key to complete the text in-place.
18182 Depending on the context and the keys, Org offers different types of
18183 completions. No minibuffer is involved. Such mode-specific hot keys
18184 have become an integral part of Emacs and Org provides several
18187 - {{{kbd(M-TAB)}}} ::
18190 Complete word at point.
18192 - At the beginning of a headline, complete TODO keywords.
18194 - After =\=, complete TeX symbols supported by the exporter.
18196 - After =*=, complete headlines in the current buffer so that
18197 they can be used in search links like:
18199 : [[*find this headline]]
18201 - After =:= in a headline, complete tags. Org deduces the list
18202 of tags from the =TAGS= in-buffer option (see [[*Setting Tags]]),
18203 the variable ~org-tag-alist~, or from all tags used in the
18206 - After =:= and not in a headline, complete property keys. The
18207 list of keys is constructed dynamically from all keys used in
18208 the current buffer.
18210 - After =[=, complete link abbreviations (see [[*Link
18213 - After =#+=, complete the special keywords like =TYP_TODO= or
18214 file-specific =OPTIONS=. After option keyword is complete,
18215 pressing {{{kbd(M-TAB)}}} again inserts example settings for
18218 - After =STARTUP= keyword, complete startup items.
18220 - When point is anywhere else, complete dictionary words using
18223 ** Structure Templates
18225 :DESCRIPTION: Quick insertion of structural elements.
18227 #+cindex: template insertion
18228 #+cindex: insertion, of templates
18230 With just a few keystrokes, it is possible to insert empty structural
18231 blocks, such as =#+BEGIN_SRC= ... =#+END_SRC=, or to wrap existing
18232 text in such a block.
18234 - {{{kbd(C-c C-\,)}}} (~org-insert-structure-template~) ::
18236 #+findex: org-insert-structure-template
18238 Prompt for a type of block structure, and insert the block at
18239 point. If the region is active, it is wrapped in the block.
18240 First prompts the user for keys, which are used to look up
18241 a structure type from the variable below. If the key is
18242 {{{kbd(TAB)}}}, {{{kbd(RET)}}}, or {{{kbd(SPC)}}}, the user is
18243 prompted to enter a block type.
18245 #+vindex: org-structure-template-alist
18246 Available structure types are defined in
18247 ~org-structure-template-alist~, see the docstring for adding or
18251 #+cindex: template expansion
18252 #+cindex: insertion, of templates
18253 #+vindex: org-tempo-keywords-alist
18254 Org Tempo expands snippets to structures defined in
18255 ~org-structure-template-alist~ and ~org-tempo-keywords-alist~. For
18256 example, {{{kbd(< s TAB)}}} creates a code block. Enable it by
18257 customizing ~org-modules~ or add ~(require 'org-tempo)~ to your Emacs
18261 #+attr_texinfo: :columns 0.1 0.9
18262 | {{{kbd(a)}}} | =#+BEGIN_EXPORT ascii= ... =#+END_EXPORT= |
18263 | {{{kbd(c)}}} | =#+BEGIN_CENTER= ... =#+END_CENTER= |
18264 | {{{kbd(C)}}} | =#+BEGIN_COMMENT= ... =#+END_COMMENT= |
18265 | {{{kbd(e)}}} | =#+BEGIN_EXAMPLE= ... =#+END_EXAMPLE= |
18266 | {{{kbd(h)}}} | =#+BEGIN_EXPORT html= ... =#+END_EXPORT= |
18267 | {{{kbd(l)}}} | =#+BEGIN_EXPORT latex= ... =#+END_EXPORT= |
18268 | {{{kbd(q)}}} | =#+BEGIN_QUOTE= ... =#+END_QUOTE= |
18269 | {{{kbd(s)}}} | =#+BEGIN_SRC= ... =#+END_SRC= |
18270 | {{{kbd(v)}}} | =#+BEGIN_VERSE= ... =#+END_VERSE= |
18275 :DESCRIPTION: Electric commands at the beginning of a headline.
18277 #+cindex: speed keys
18279 Single keystrokes can execute custom commands in an Org file when the
18280 cursor is on a headline. Without the extra burden of a meta or
18281 modifier key, Speed Keys can speed navigation or execute custom
18282 commands. Besides faster navigation, Speed Keys may come in handy on
18283 small mobile devices that do not have full keyboards. Speed Keys may
18284 also work on TTY devices known for their problems when entering Emacs
18287 #+vindex: org-use-speed-commands
18288 By default, Org has Speed Keys disabled. To activate Speed Keys, set
18289 the variable ~org-use-speed-commands~ to a non-~nil~ value. To
18290 trigger a Speed Key, the cursor must be at the beginning of an Org
18291 headline, before any of the stars.
18293 #+vindex: org-speed-commands-user
18294 #+findex: org-speed-command-help
18295 Org comes with a pre-defined list of Speed Keys. To add or modify
18296 Speed Keys, customize the variable, ~org-speed-commands-user~. For
18297 more details, see the variable's docstring. With Speed Keys
18298 activated, {{{kbd(M-x org-speed-command-help)}}}, or {{{kbd(?)}}} when
18299 cursor is at the beginning of an Org headline, shows currently active
18300 Speed Keys, including the user-defined ones.
18302 ** Code Evaluation and Security Issues
18304 :DESCRIPTION: Org files evaluate in-line code.
18305 :ALT_TITLE: Code Evaluation Security
18308 Unlike plain text, running code comes with risk. Each source code
18309 block, in terms of risk, is equivalent to an executable file. Org
18310 therefore puts a few confirmation prompts by default. This is to
18311 alert the casual user from accidentally running untrusted code.
18313 For users who do not run code blocks or write code regularly, Org's
18314 default settings should suffice. However, some users may want to
18315 tweak the prompts for fewer interruptions. To weigh the risks of
18316 automatic execution of code blocks, here are some details about code
18319 Org evaluates code in the following circumstances:
18321 - /Source code blocks/ ::
18323 Org evaluates source code blocks in an Org file during export.
18324 Org also evaluates a source code block with the {{{kbd(C-c
18325 C-c)}}} key chord. Users exporting or running code blocks must
18326 load files only from trusted sources. Be wary of customizing
18327 variables that remove or alter default security measures.
18329 #+attr_texinfo: :options org-confirm-babel-evaluate
18331 When ~t~, Org prompts the user for confirmation before executing
18332 each code block. When ~nil~, Org executes code blocks without
18333 prompting the user for confirmation. When this option is set to
18334 a custom function, Org invokes the function with these two
18335 arguments: the source code language and the body of the code
18336 block. The custom function must return either a ~t~ or ~nil~,
18337 which determines if the user is prompted. Each source code
18338 language can be handled separately through this function
18342 For example, here is how to execute ditaa code blocks without
18345 #+begin_src emacs-lisp
18346 (defun my-org-confirm-babel-evaluate (lang body)
18347 (not (string= lang "ditaa"))) ;don't ask for ditaa
18348 (setq org-confirm-babel-evaluate #'my-org-confirm-babel-evaluate)
18351 - /Following =shell= and =elisp= links/ ::
18353 Org has two link types that can directly evaluate code (see
18354 [[*External Links]]). Because such code is not visible, these links
18355 have a potential risk. Org therefore prompts the user when it
18356 encounters such links. The customization variables are:
18358 #+attr_texinfo: :options org-confirm-shell-link-function
18360 Function that prompts the user before executing a shell link.
18363 #+attr_texinfo: :options org-confirm-elisp-link-function
18365 Function that prompts the user before executing an Emacs Lisp link.
18368 - /Formulas in tables/ ::
18370 Formulas in tables (see [[*The spreadsheet]]) are code that is
18371 evaluated either by the Calc interpreter, or by the Emacs Lisp
18376 :DESCRIPTION: Adapting Org to your taste.
18378 #+cindex: customization
18379 #+cindex: options, for customization
18380 #+cindex: variables, for customization
18382 Org has more than 500 variables for customization. They can be
18383 accessed through the usual {{{kbd(M-x org-customize)}}} command. Or
18384 through the Org menu: Org \rarr Customization \rarr Browse Org Group.
18386 Org also has per-file settings for some variables (see [[*Summary of
18387 In-Buffer Settings]]).
18389 ** Summary of In-Buffer Settings
18391 :DESCRIPTION: Overview of keywords.
18392 :ALT_TITLE: In-buffer Settings
18394 #+cindex: in-buffer settings
18395 #+cindex: special keywords
18397 In-buffer settings start with =#+=, followed by a keyword, a colon,
18398 and then a word for each setting. Org accepts multiple settings on
18399 the same line. Org also accepts multiple lines for a keyword. This
18400 manual describes these settings throughout. A summary follows here.
18402 #+cindex: refresh set-up
18403 {{{kbd(C-c C-c)}}} activates any changes to the in-buffer settings.
18404 Closing and reopening the Org file in Emacs also activates the
18407 #+attr_texinfo: :sep ,
18408 - =#+ARCHIVE: %s_done= ::
18410 #+cindex: @samp{ARCHIVE}, keyword
18411 #+vindex: org-archive-location
18412 Sets the archive location of the agenda file. The corresponding
18413 variable is ~org-archive-location~.
18417 #+cindex: @samp{CATEGORY}, keyword
18418 Sets the category of the agenda file, which applies to the entire
18421 - =#+COLUMNS: %25ITEM ...= ::
18423 #+cindex: @samp{COLUMNS}, property
18424 Set the default format for columns view. This format applies
18425 when columns view is invoked in locations where no =COLUMNS=
18428 - =#+CONSTANTS: name1=value1 ...= ::
18430 #+cindex: @samp{CONSTANTS}, keyword
18431 #+vindex: org-table-formula-constants
18432 #+vindex: org-table-formula
18433 Set file-local values for constants that table formulas can use.
18434 This line sets the local variable
18435 ~org-table-formula-constants-local~. The global version of this
18436 variable is ~org-table-formula-constants~.
18438 - =#+FILETAGS: :tag1:tag2:tag3:= ::
18440 #+cindex: @samp{FILETAGS}, keyword
18441 Set tags that all entries in the file inherit from, including the
18444 - =#+LINK: linkword replace= ::
18446 #+cindex: @samp{LINK}, keyword
18447 #+vindex: org-link-abbrev-alist
18448 Each line specifies one abbreviation for one link. Use multiple
18449 =LINK= keywords for more, see [[*Link Abbreviations]]. The
18450 corresponding variable is ~org-link-abbrev-alist~.
18452 - =#+PRIORITIES: highest lowest default= ::
18454 #+cindex: @samp{PRIORITIES}, keyword
18455 #+vindex: org-highest-priority
18456 #+vindex: org-lowest-priority
18457 #+vindex: org-default-priority
18458 This line sets the limits and the default for the priorities.
18459 All three must be either letters A--Z or numbers 0--9. The
18460 highest priority must have a lower ASCII number than the lowest
18463 - =#+PROPERTY: Property_Name Value= ::
18465 #+cindex: @samp{PROPERTY}, keyword
18466 This line sets a default inheritance value for entries in the
18467 current buffer, most useful for specifying the allowed values of
18470 - =#+SETUPFILE: file= ::
18472 #+cindex: @samp{SETUPFILE}, keyword
18473 The setup file or a URL pointing to such file is for additional
18474 in-buffer settings. Org loads this file and parses it for any
18475 settings in it only when Org opens the main file. If URL is
18476 specified, the contents are downloaded and stored in a temporary
18477 file cache. {{{kbd(C-c C-c)}}} on the settings line parses and
18478 loads the file, and also resets the temporary file cache. Org
18479 also parses and loads the document during normal exporting
18480 process. Org parses the contents of this document as if it was
18481 included in the buffer. It can be another Org file. To visit
18482 the file---not a URL---use {{{kbd(C-c ')}}} while the cursor is
18483 on the line with the file name.
18487 #+cindex: @samp{STARTUP}, keyword
18488 Startup options Org uses when first visiting a file.
18490 #+vindex: org-startup-folded
18491 The first set of options deals with the initial visibility of the
18492 outline tree. The corresponding variable for global default
18493 settings is ~org-startup-folded~ with a default value of ~t~,
18494 which is the same as ~overview~.
18498 Top-level headlines only.
18506 No folding on any entry.
18508 - =showeverything= ::
18510 Show even drawer contents.
18512 #+vindex: org-startup-indented
18513 Dynamic virtual indentation is controlled by the variable
18514 ~org-startup-indented~.[fn:136]
18518 Start with ~org-indent-mode~ turned on.
18522 Start with ~org-indent-mode~ turned off.
18524 #+vindex: org-startup-align-all-tables
18525 Aligns tables consistently upon visiting a file. The corresponding
18526 variable is ~org-startup-align-all-tables~ with ~nil~ as default
18535 Do not align tables on startup.
18537 #+vindex: org-startup-shrink-all-tables
18538 Shrink table columns with a width cookie. The corresponding
18539 variable is ~org-startup-shrink-all-tables~ with ~nil~ as default
18542 #+vindex: org-startup-with-inline-images
18543 When visiting a file, inline images can be automatically displayed.
18544 The corresponding variable is ~org-startup-with-inline-images~,
18545 with a default value ~nil~ to avoid delays when visiting a file.
18547 - =inlineimages= ::
18549 Show inline images.
18551 - =noinlineimages= ::
18553 Do not show inline images on startup.
18555 #+vindex: org-log-done
18556 #+vindex: org-log-note-clock-out
18557 #+vindex: org-log-repeat
18558 Logging the closing and reopening of TODO items and clock
18559 intervals can be configured using these options (see variables
18560 ~org-log-done~, ~org-log-note-clock-out~, and ~org-log-repeat~).
18564 Record a timestamp when an item is marked DONE.
18568 Record timestamp and a note when DONE.
18572 Do not record when items are marked DONE.
18576 Record a time when reinstating a repeating item.
18578 - =lognoterepeat= ::
18580 Record a note when reinstating a repeating item.
18584 Do not record when reinstating repeating item.
18586 - =lognoteclock-out= ::
18588 Record a note when clocking out.
18590 - =nolognoteclock-out= ::
18592 Do not record a note when clocking out.
18594 - =logreschedule= ::
18596 Record a timestamp when scheduling time changes.
18598 - =lognotereschedule= ::
18600 Record a note when scheduling time changes.
18602 - =nologreschedule= ::
18604 Do not record when a scheduling date changes.
18606 - =logredeadline= ::
18608 Record a timestamp when deadline changes.
18610 - =lognoteredeadline= ::
18612 Record a note when deadline changes.
18614 - =nologredeadline= ::
18616 Do not record when a deadline date changes.
18620 Record a timestamp when refiling.
18622 - =lognoterefile= ::
18624 Record a note when refiling.
18628 Do not record when refiling.
18630 #+vindex: org-hide-leading-stars
18631 #+vindex: org-odd-levels-only
18632 Here are the options for hiding leading stars in outline headings,
18633 and for indenting outlines. The corresponding variables are
18634 ~org-hide-leading-stars~ and ~org-odd-levels-only~, both with
18635 a default setting ~nil~ (meaning =showstars= and =oddeven=).
18639 Make all but one of the stars starting a headline invisible.
18643 Show all stars starting a headline.
18647 Virtual indentation according to outline level.
18651 No virtual indentation according to outline level.
18655 Allow only odd outline levels (1, 3, ...).
18659 Allow all outline levels.
18661 #+vindex: org-put-time-stamp-overlays
18662 #+vindex: org-time-stamp-overlay-formats
18663 To turn on custom format overlays over timestamps (variables
18664 ~org-put-time-stamp-overlays~ and ~org-time-stamp-overlay-formats~),
18669 Overlay custom time format.
18671 #+vindex: constants-unit-system
18672 The following options influence the table spreadsheet (variable
18673 ~constants-unit-system~).
18677 =constants.el= should use the c-g-s unit system.
18681 =constants.el= should use the SI unit system.
18683 #+vindex: org-footnote-define-inline
18684 #+vindex: org-footnote-auto-label
18685 #+vindex: org-footnote-auto-adjust
18686 To influence footnote settings, use the following keywords. The
18687 corresponding variables are ~org-footnote-define-inline~,
18688 ~org-footnote-auto-label~, and ~org-footnote-auto-adjust~.
18692 Define footnotes inline.
18696 Define footnotes in separate section.
18700 Define footnotes near first reference, but not inline.
18704 Prompt for footnote labels.
18708 Create =[fn:1]=-like labels automatically (default).
18712 Offer automatic label for editing or confirmation.
18716 Automatically renumber and sort footnotes.
18720 Do not renumber and sort automatically.
18722 #+vindex: org-hide-block-startup
18723 To hide blocks on startup, use these keywords. The corresponding
18724 variable is ~org-hide-block-startup~.
18728 Hide all begin/end blocks on startup.
18730 - =nohideblocks= ::
18732 Do not hide blocks on startup.
18734 #+vindex: org-pretty-entities
18735 The display of entities as UTF-8 characters is governed by the
18736 variable ~org-pretty-entities~ and the keywords
18738 - =entitiespretty= ::
18740 Show entities as UTF-8 characters where possible.
18742 - =entitiesplain= ::
18744 Leave entities plain.
18746 - =#+TAGS: TAG1(c1) TAG2(c2)= ::
18748 #+cindex: @samp{TAGS}, keyword
18749 #+vindex: org-tag-alist
18750 These lines (several such lines are allowed) specify the valid
18751 tags in this file, and (potentially) the corresponding /fast tag
18752 selection/ keys. The corresponding variable is ~org-tag-alist~.
18754 - =#+TODO:=, =#+SEQ_TODO:=, =#+TYP_TODO:= ::
18756 #+cindex: @samp{SEQ_TODO}, keyword
18757 #+cindex: @samp{TODO}, keyword
18758 #+cindex: @samp{TYP_TODO}, keyword
18759 #+vindex: org-todo-keywords
18760 These lines set the TODO keywords and their interpretation in the
18761 current file. The corresponding variable is ~org-todo-keywords~.
18763 ** The Very Busy {{{kbd(C-c C-c)}}} Key
18765 :DESCRIPTION: When in doubt, press @kbd{C-c C-c}.
18768 #+cindex: @kbd{C-c C-c}, overview
18770 The {{{kbd(C-c C-c)}}} key in Org serves many purposes depending on
18771 the context. It is probably the most over-worked, multi-purpose key
18772 combination in Org. Its uses are well documented throughout this
18773 manual, but here is a consolidated list for easy reference.
18775 - If any highlights shown in the buffer from the creation of a sparse
18776 tree, or from clock display, remove such highlights.
18778 - If the cursor is in one of the special =KEYWORD= lines, scan the
18779 buffer for these lines and update the information. Also reset the
18780 Org file cache used to temporary store the contents of URLs used as
18781 values for keywords like =SETUPFILE=.
18783 - If the cursor is inside a table, realign the table. The table
18784 realigns even if automatic table editor is turned off.
18786 - If the cursor is on a =TBLFM= keyword, re-apply the formulas to the
18789 - If the current buffer is a capture buffer, close the note and file
18790 it. With a prefix argument, also jump to the target location after
18793 - If the cursor is on a =<<<target>>>=, update radio targets and
18794 corresponding links in this buffer.
18796 - If the cursor is on a property line or at the start or end of
18797 a property drawer, offer property commands.
18799 - If the cursor is at a footnote reference, go to the corresponding
18800 definition, and /vice versa/.
18802 - If the cursor is on a statistics cookie, update it.
18804 - If the cursor is in a plain list item with a checkbox, toggle the
18805 status of the checkbox.
18807 - If the cursor is on a numbered item in a plain list, renumber the
18810 - If the cursor is on the =#+BEGIN= line of a dynamic block, the block
18813 - If the cursor is at a timestamp, fix the day name in the timestamp.
18815 ** A Cleaner Outline View
18817 :DESCRIPTION: Getting rid of leading stars in the outline.
18818 :ALT_TITLE: Clean View
18820 #+cindex: hiding leading stars
18821 #+cindex: dynamic indentation
18822 #+cindex: odd-levels-only outlines
18823 #+cindex: clean outline view
18825 Org's default outline with stars and no indents can become too
18826 cluttered for short documents. For /book-like/ long documents, the
18827 effect is not as noticeable. Org provides an alternate stars and
18828 indentation scheme, as shown on the right in the following table. It
18829 uses only one star and indents text to line with the heading:
18832 ,* Top level headline | * Top level headline
18833 ,** Second level | * Second level
18834 ,*** Third level | * Third level
18835 some text | some text
18836 ,*** Third level | * Third level
18837 more text | more text
18838 ,* Another top level headline | * Another top level headline
18841 #+texinfo: @noindent
18842 #+cindex: Indent mode
18843 #+findex: org-indent-mode
18844 To turn this mode on, use the minor mode, ~org-indent-mode~. Text
18845 lines that are not headlines are prefixed with spaces to vertically
18846 align with the headline text[fn:137].
18848 #+vindex: org-indent-indentation-per-level
18849 To make more horizontal space, the headlines are shifted by two stars.
18850 This can be configured by the ~org-indent-indentation-per-level~
18851 variable. Only one star on each headline is visible, the rest are
18852 masked with the same font color as the background.
18854 Note that turning on ~org-indent-mode~ sets ~org-hide-leading-stars~
18855 to ~t~ and ~org-adapt-indentation~ to ~nil~.
18857 #+vindex: org-startup-indented
18858 To globally turn on ~org-indent-mode~ for all files, customize the
18859 variable ~org-startup-indented~.
18861 To turn on indenting for individual files, use =STARTUP= keyword as
18864 : #+STARTUP: indent
18866 Indent on startup makes Org use hard spaces to align text with
18867 headings as shown in examples below.
18869 - /Indentation of text below headlines/ ::
18871 Indent text to align with the headline.
18875 more text, now indented
18878 #+vindex: org-adapt-indentation
18879 Org supports this with paragraph filling, line wrapping, and
18880 structure editing, preserving or adapting the indentation as
18881 appropriate[fn:138].
18883 - /Hiding leading stars/ ::
18885 #+vindex: org-hide-leading-stars
18886 Org can make leading stars invisible. For global preference,
18887 configure the variable ~org-hide-leading-stars~. For per-file
18888 preference, use these file =STARTUP= options:
18891 ,#+STARTUP: hidestars
18892 ,#+STARTUP: showstars
18895 With stars hidden, the tree is shown as:
18898 ,* Top level headline
18904 #+texinfo: @noindent
18905 #+vindex: org-hide, face
18906 Because Org makes the font color the same as the background color
18907 to hide to stars, sometimes ~org-hide~ face may need tweaking to
18908 get the effect right. For some black and white combinations,
18909 ~grey90~ on a white background might mask the stars better.
18913 #+vindex: org-odd-levels-only
18914 Using stars for only odd levels, 1, 3, 5, ..., can also clean up
18915 the clutter. This removes two stars from each level[fn:139].
18916 For Org to properly handle this cleaner structure during edits
18917 and exports, configure the variable ~org-odd-levels-only~. To
18918 set this per-file, use either one of the following lines:
18922 ,#+STARTUP: oddeven
18925 To switch between single and double stars layouts, use {{{kbd(M-x
18926 org-convert-to-odd-levels)}}} and {{{kbd(M-x
18927 org-convert-to-oddeven-levels)}}}.
18929 ** Using Org on a TTY
18931 :DESCRIPTION: Using Org on a tty.
18932 :ALT_TITLE: TTY Keys
18934 #+cindex: tty key bindings
18936 Org provides alternative key bindings for TTY and modern mobile
18937 devices that cannot handle cursor keys and complex modifier key
18938 chords. Some of these workarounds may be more cumbersome than
18939 necessary. Users should look into customizing these further based on
18940 their usage needs. For example, the normal {{{kbd(S-<cursor>)}}} for
18941 editing timestamp might be better with {{{kbd(C-c .)}}} chord.
18943 #+attr_texinfo: :columns 0.2 0.28 0.15 0.21
18944 | Default | Alternative 1 | Speed key | Alternative 2 |
18945 |----------------------+--------------------------+--------------+----------------------|
18946 | {{{kbd(S-TAB)}}} | {{{kbd(C-u TAB)}}} | {{{kbd(C)}}} | |
18947 | {{{kbd(M-LEFT)}}} | {{{kbd(C-c C-x l)}}} | {{{kbd(l)}}} | {{{kbd(Esc LEFT)}}} |
18948 | {{{kbd(M-S-LEFT)}}} | {{{kbd(C-c C-x L)}}} | {{{kbd(L)}}} | |
18949 | {{{kbd(M-RIGHT)}}} | {{{kbd(C-c C-x r)}}} | {{{kbd(r)}}} | {{{kbd(Esc RIGHT)}}} |
18950 | {{{kbd(M-S-RIGHT)}}} | {{{kbd(C-c C-x R)}}} | {{{kbd(R)}}} | |
18951 | {{{kbd(M-UP)}}} | {{{kbd(C-c C-x u)}}} | | {{{kbd(Esc UP)}}} |
18952 | {{{kbd(M-S-UP)}}} | {{{kbd(C-c C-x U)}}} | {{{kbd(U)}}} | |
18953 | {{{kbd(M-DOWN)}}} | {{{kbd(C-c C-x d)}}} | | {{{kbd(Esc DOWN)}}} |
18954 | {{{kbd(M-S-DOWN)}}} | {{{kbd(C-c C-x D)}}} | {{{kbd(D)}}} | |
18955 | {{{kbd(S-RET)}}} | {{{kbd(C-c C-x c)}}} | | |
18956 | {{{kbd(M-RET)}}} | {{{kbd(C-c C-x m)}}} | | {{{kbd(Esc RET)}}} |
18957 | {{{kbd(M-S-RET)}}} | {{{kbd(C-c C-x M)}}} | | |
18958 | {{{kbd(S-LEFT)}}} | {{{kbd(C-c LEFT)}}} | | |
18959 | {{{kbd(S-RIGHT)}}} | {{{kbd(C-c RIGHT)}}} | | |
18960 | {{{kbd(S-UP)}}} | {{{kbd(C-c UP)}}} | | |
18961 | {{{kbd(S-DOWN)}}} | {{{kbd(C-c DOWN)}}} | | |
18962 | {{{kbd(C-S-LEFT)}}} | {{{kbd(C-c C-x LEFT)}}} | | |
18963 | {{{kbd(C-S-RIGHT)}}} | {{{kbd(C-c C-x RIGHT)}}} | | |
18965 ** Interaction with Other Packages
18967 :DESCRIPTION: With other Emacs packages.
18968 :ALT_TITLE: Interaction
18970 #+cindex: packages, interaction with other
18972 Org's compatibility and the level of interaction with other Emacs
18973 packages are documented here.
18975 *** Packages that Org cooperates with
18977 :DESCRIPTION: Packages Org cooperates with.
18978 :ALT_TITLE: Cooperation
18981 - =calc.el= by Dave Gillespie ::
18982 #+cindex: @file{calc.el}
18984 Org uses the Calc package for implementing spreadsheet
18985 functionality in its tables (see [[*The spreadsheet]]). Org also
18986 uses Calc for embedded calculations. See [[info:calc:Embedded%20Mode][GNU Emacs Calc Manual]].
18988 - =constants.el= by Carsten Dominik ::
18989 #+cindex: @file{constants.el}
18990 #+vindex: org-table-formula-constants
18992 Org can use names for constants in formulas in tables. Org can
18993 also use calculation suffixes for units, such as =M= for =Mega=.
18994 For a standard collection of such constants, install the
18995 =constants= package. Install version 2.0 of this package,
18996 available at [[http://www.astro.uva.nl/~dominik/Tools]]. Org checks
18997 if the function ~constants-get~ has been autoloaded.
18998 Installation instructions are in the file =constants.el=.
19000 - =cdlatex.el= by Carsten Dominik ::
19001 #+cindex: @file{cdlatex.el}
19003 Org mode can make use of the CDLaTeX package to efficiently enter
19004 LaTeX fragments into Org files. See [[*Using CDLaTeX to enter
19007 - =imenu.el= by Ake Stenhoff and Lars Lindberg ::
19008 #+cindex: @file{imenu.el}
19010 Imenu creates dynamic menus based on an index of items in a file.
19011 Org mode supports Imenu menus. Enable it with a mode hook as
19014 #+begin_src emacs-lisp
19015 (add-hook 'org-mode-hook
19016 (lambda () (imenu-add-to-menubar "Imenu")))
19019 #+vindex: org-imenu-depth
19020 By default the index is two levels deep---you can modify the
19021 depth using the option ~org-imenu-depth~.
19023 - =speedbar.el= by Eric\nbsp{}M.\nbsp{}Ludlam ::
19024 #+cindex: @file{speedbar.el}
19026 Speedbar package creates a special Emacs frame for displaying
19027 files and index items in files. Org mode supports Speedbar;
19028 users can drill into Org files directly from the Speedbar. The
19029 {{{kbd(<)}}} in the Speedbar frame tweaks the agenda commands to
19030 that file or to a subtree.
19032 - =table.el= by Takaaki Ota ::
19033 #+cindex: table editor, @file{table.el}
19034 #+cindex: @file{table.el}
19036 Complex ASCII tables with automatic line wrapping, column- and
19037 row-spanning, and alignment can be created using the Emacs table
19038 package by Takaaki Ota. Org mode recognizes such tables and
19039 exports them properly. {{{kbd(C-c ')}}} to edit these tables in
19040 a special buffer, much like Org's code blocks. Because of
19041 interference with other Org mode functionality, Takaaki Ota
19042 tables cannot be edited directly in the Org buffer.
19044 - {{{kbd(C-c ')}}} (~org-edit-special~) ::
19047 #+findex: org-edit-special
19048 Edit a =table.el= table. Works when the cursor is in
19049 a =table.el= table.
19051 - {{{kbd(C-c ~)}}} (~org-table-create-with-table.el~) ::
19054 #+findex: org-table-create-with-table.el
19055 Insert a =table.el= table. If there is already a table at
19056 point, this command converts it between the =table.el=
19057 format and the Org mode format. See the documentation
19058 string of the command ~org-convert-table~ for the
19059 restrictions under which this is possible.
19061 *** Packages that conflict with Org mode
19063 :DESCRIPTION: Packages that lead to conflicts.
19064 :ALT_TITLE: Conflicts
19067 #+cindex: shift-selection-mode
19068 #+vindex: org-support-shift-select
19069 In Emacs, ~shift-selection-mode~ combines cursor motions with shift
19070 key to enlarge regions. Emacs sets this mode by default. This
19071 conflicts with Org's use of {{{kbd(S-<cursor>)}}} commands to change
19072 timestamps, TODO keywords, priorities, and item bullet types, etc.
19073 Since {{{kbd(S-<cursor>)}}} commands outside of specific contexts do
19074 not do anything, Org offers the variable ~org-support-shift-select~
19075 for customization. Org mode accommodates shift selection by (i)
19076 making it available outside of the special contexts where special
19077 commands apply, and (ii) extending an existing active region even if
19078 the cursor moves across a special context.
19080 - =cua.el= by Kim\nbsp{}F.\nbsp{}Storm ::
19082 #+cindex: @file{cua.el}
19083 #+vindex: org-replace-disputed-keys
19084 Org key bindings conflict with {{{kbd(S-<cursor>)}}} keys used by
19085 CUA mode. For Org to relinquish these bindings to CUA mode,
19086 configure the variable ~org-replace-disputed-keys~. When set,
19087 Org moves the following key bindings in Org files, and in the
19088 agenda buffer---but not during date selection.
19090 #+attr_texinfo: :columns 0.4 0.4
19091 | {{{kbd(S-UP)}}} \rArr{} {{{kbd(M-p)}}} | {{{kbd(S-DOWN)}}} \rArr{} {{{kbd(M-n)}}} |
19092 | {{{kbd(S-LEFT)}}} \rArr{} {{{kbd(M--)}}} | {{{kbd(S-RIGHT)}}} \rArr{} {{{kbd(M-+)}}} |
19093 | {{{kbd(C-S-LEFT)}}} \rArr{} {{{kbd(M-S--)}}} | {{{kbd(C-S-RIGHT)}}} \rArr{} {{{kbd(M-S-+)}}} |
19095 #+vindex: org-disputed-keys
19096 Yes, these are unfortunately more difficult to remember. If you
19097 want to have other replacement keys, look at the variable
19098 ~org-disputed-keys~.
19100 - =ecomplete.el= by Lars Magne Ingebrigtsen ::
19102 #+cindex: @file{ecomplete.el}
19103 Ecomplete provides "electric" address completion in address
19104 header lines in message buffers. Sadly Orgtbl mode cuts
19105 Ecomplete's power supply: no completion happens when Orgtbl mode
19106 is enabled in message buffers while entering text in address
19107 header lines. If one wants to use ecomplete one should /not/
19108 follow the advice to automagically turn on Orgtbl mode in message
19109 buffers (see [[*The Orgtbl Minor Mode]]), but instead---after
19110 filling in the message headers---turn on Orgtbl mode manually
19111 when needed in the messages body.
19113 - =filladapt.el= by Kyle Jones ::
19115 #+cindex: @file{filladapt.el}
19116 Org mode tries to do the right thing when filling paragraphs,
19117 list items and other elements. Many users reported problems
19118 using both =filladapt.el= and Org mode, so a safe thing to do is
19119 to disable filladapt like this:
19121 #+begin_src emacs-lisp
19122 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
19125 - =viper.el= by Michael Kifer ::
19126 #+cindex: @file{viper.el}
19129 Viper uses {{{kbd(C-c /)}}} and therefore makes this key not
19130 access the corresponding Org mode command ~org-sparse-tree~. You
19131 need to find another key for this command, or override the key in
19132 ~viper-vi-global-user-map~ with
19134 #+begin_src emacs-lisp
19135 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
19138 - =windmove.el= by Hovav Shacham ::
19139 #+cindex: @file{windmove.el}
19141 This package also uses the {{{kbd(S-<cursor>)}}} keys, so
19142 everything written in the paragraph above about CUA mode also
19143 applies here. If you want to make the windmove function active
19144 in locations where Org mode does not have special functionality
19145 on {{{kbd(S-<cursor>)}}}, add this to your configuration:
19147 #+begin_src emacs-lisp
19148 ;; Make windmove work in Org mode:
19149 (add-hook 'org-shiftup-final-hook 'windmove-up)
19150 (add-hook 'org-shiftleft-final-hook 'windmove-left)
19151 (add-hook 'org-shiftdown-final-hook 'windmove-down)
19152 (add-hook 'org-shiftright-final-hook 'windmove-right)
19155 - =yasnippet.el= ::
19157 #+cindex: @file{yasnippet.el}
19158 The way Org mode binds the {{{kbd(TAB)}}} key (binding to ~[tab]~
19159 instead of ~"\t"~) overrules YASnippet's access to this key. The
19160 following code fixed this problem:
19162 #+begin_src emacs-lisp
19163 (add-hook 'org-mode-hook
19165 (setq-local yas/trigger-key [tab])
19166 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
19169 The latest version of YASnippet does not play well with Org mode.
19170 If the above code does not fix the conflict, start by defining
19171 the following function:
19173 #+begin_src emacs-lisp
19174 (defun yas/org-very-safe-expand ()
19175 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
19178 Then, tell Org mode to use that function:
19180 #+begin_src emacs-lisp
19181 (add-hook 'org-mode-hook
19183 (make-variable-buffer-local 'yas/trigger-key)
19184 (setq yas/trigger-key [tab])
19185 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
19186 (define-key yas/keymap [tab] 'yas/next-field)))
19191 :DESCRIPTION: Encrypting Org files.
19194 Org Crypt encrypts the text of an entry, but not the headline, or
19195 properties. Behind the scene, it uses the Emacs EasyPG library to
19196 encrypt and decrypt files.
19198 #+vindex: org-crypt-tag-matcher
19199 Any text below a headline that has a =crypt= tag is automatically
19200 encrypted when the file is saved. To use a different tag, customize
19201 the ~org-crypt-tag-matcher~ setting.
19203 Here is a suggestion for Org Crypt settings in Emacs init file:
19205 #+begin_src emacs-lisp
19206 (require 'org-crypt)
19207 (org-crypt-use-before-save-magic)
19208 (setq org-tags-exclude-from-inheritance '("crypt"))
19210 (setq org-crypt-key nil)
19211 ;; GPG key to use for encryption
19212 ;; Either the Key ID or set to nil to use symmetric encryption.
19214 (setq auto-save-default nil)
19215 ;; Auto-saving does not cooperate with org-crypt.el: so you need to
19216 ;; turn it off if you plan to use org-crypt.el quite often. Otherwise,
19217 ;; you'll get an (annoying) message each time you start Org.
19219 ;; To turn it off only locally, you can insert this:
19221 ;; # -*- buffer-auto-save-file-name: nil; -*-
19224 It's possible to use different keys for different headings by
19225 specifying the respective key as property =CRYPTKEY=, e.g.:
19228 ,* Totally secret :crypt:
19230 :CRYPTKEY: 0x0123456789012345678901234567890123456789
19234 Excluding the =crypt= tag from inheritance prevents already encrypted
19235 text from being encrypted again.
19239 :DESCRIPTION: How to hack your way around.
19240 :APPENDIX: Appendix
19244 This appendix describes some ways a user can extend the functionality
19249 :DESCRIPTION: How to reach into Org's internals.
19253 Org has a large number of hook variables for adding functionality.
19254 This appendix illustrates using a few. A complete list of hooks with
19255 documentation is maintained by the Worg project at
19256 https://orgmode.org/worg/doc.html#hooks.
19260 :DESCRIPTION: Available extensions.
19262 #+cindex: add-on packages
19264 Various authors wrote a large number of add-on packages for Org.
19266 These packages are not part of Emacs, but they are distributed as
19267 contributed packages with the separate release available at
19268 https://orgmode.org. See the =contrib/README= file in the source code
19269 directory for a list of contributed files. Worg page with more
19270 information is at: https://orgmode.org/worg/org-contrib/.
19272 ** Adding Hyperlink Types
19274 :DESCRIPTION: New custom link types.
19276 #+cindex: hyperlinks, adding new types
19278 Org has many built-in hyperlink types (see [[*Hyperlinks]]), and an
19279 interface for adding new link types. The following example shows the
19280 process of adding Org links to Unix man pages, which look like this
19282 : [[man:printf][The printf manual]]
19284 #+texinfo: @noindent
19285 The following =org-man.el= file implements it
19287 #+begin_src emacs-lisp
19288 ;;; org-man.el - Support for links to man pages in Org mode
19291 (org-link-set-parameters "man"
19292 :follow org-man-command
19293 :export #'org-man-export
19294 :store #'org-man-store-link)
19296 (defcustom org-man-command 'man
19297 "The Emacs command to be used to display a man page."
19299 :type '(choice (const man) (const woman)))
19301 (defun org-man-store-link ()
19302 "Store a link to a man page."
19303 (when (memq major-mode '(Man-mode woman-mode))
19304 ;; This is a man page, we do make this link.
19305 (let* ((page (org-man-get-page-name))
19306 (link (concat "man:" page))
19307 (description (format "Man page for %s" page)))
19308 (org-store-link-props
19311 :description description))))
19313 (defun org-man-get-page-name ()
19314 "Extract the page name from the buffer name."
19315 ;; This works for both `Man-mode' and `woman-mode'.
19316 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
19317 (match-string 1 (buffer-name))
19318 (error "Cannot create link to this man page")))
19320 (defun org-man-export (link description format)
19321 "Export a man page link from Org files."
19322 (let ((path (format "http://man.he.net/?topic=%s§ion=all" link))
19323 (desc (or description link)))
19325 (`html (format "<a target=\"_blank\" href=\"%s\">%s</a>" path desc))
19326 (`latex (format "\\href{%s}{%s}" path desc))
19327 (`texinfo (format "@uref{%s,%s}" path desc))
19328 (`ascii (format "%s (%s)" desc path))
19332 ;;; org-man.el ends here
19335 #+texinfo: @noindent
19336 To activate links to man pages in Org, enter this in the Emacs init
19339 #+begin_src emacs-lisp
19343 #+texinfo: @noindent
19344 A review of =org-man.el=:
19346 1. First, ~(require 'org)~ ensures =org.el= is loaded.
19350 #+findex: org-link-set-parameters
19351 #+vindex: org-link-parameters
19352 Then ~org-link-set-parameters~ defines a new link type with =man=
19353 prefix and associates functions for following, exporting and
19354 storing such links. See the variable ~org-link-parameters~ for
19355 a complete list of possible associations.
19357 3. The rest of the file implements necessary variables and functions.
19359 For example, ~org-man-store-link~ is responsible for storing a link
19360 when ~org-store-link~ (see [[*Handling Links]]) is called from a buffer
19361 displaying a man page. It first checks if the ~major-mode~ is
19362 appropriate. If check fails, the function returns ~nil~, which
19363 means it isn't responsible for creating a link to the current
19364 buffer. Otherwise the function makes a link string by combining
19365 the =man:= prefix with the man topic. It also provides a default
19366 description. The function ~org-insert-link~ can insert it back
19367 into an Org buffer later on.
19369 ** Adding Export Back-ends
19371 :DESCRIPTION: How to write new export back-ends.
19373 #+cindex: Export, writing back-ends
19375 Org's export engine makes it easy for writing new back-ends. The
19376 framework on which the engine was built makes it easy to derive new
19377 back-ends from existing ones.
19379 #+findex: org-export-define-backend
19380 #+findex: org-export-define-derived-backend
19381 The two main entry points to the export engine are:
19382 ~org-export-define-backend~ and ~org-export-define-derived-backend~.
19383 To grok these functions, see =ox-latex.el= for an example of defining
19384 a new back-end from scratch, and =ox-beamer.el= for an example of
19385 deriving from an existing engine.
19387 For creating a new back-end from scratch, first set its name as
19388 a symbol in an alist consisting of elements and export functions. To
19389 make the back-end visible to the export dispatcher, set ~:menu-entry~
19390 keyword. For export options specific to this back-end, set the
19393 For creating a new back-end from an existing one, set
19394 ~:translate-alist~ to an alist of export functions. This alist
19395 replaces the parent back-end functions.
19397 For complete documentation, see [[https://orgmode.org/worg/dev/org-export-reference.html][the Org Export Reference on Worg]].
19399 ** Tables in Arbitrary Syntax
19401 :DESCRIPTION: Orgtbl for LaTeX and other programs.
19403 #+cindex: tables, in other modes
19404 #+cindex: lists, in other modes
19405 #+cindex: Orgtbl mode
19407 Due to Org's success in handling tables with Orgtbl, a frequently
19408 requested feature is the use of Org's table functions in other modes,
19409 e.g., LaTeX. This would be hard to do in a general way without
19410 complicated customization nightmares. Moreover, that would take Org
19411 away from its simplicity roots that Orgtbl has proven. There is,
19412 however, an alternate approach to accomplishing the same.
19414 This approach involves implementing a custom /translate/ function that
19415 operates on a native Org /source table/ to produce a table in another
19416 format. This strategy would keep the excellently working Orgtbl
19417 simple and isolate complications, if any, confined to the translate
19418 function. To add more alien table formats, we just add more translate
19419 functions. Also the burden of developing custom translate functions
19420 for new table formats is in the hands of those who know those formats
19425 :DESCRIPTION: Sending and receiving radio tables.
19427 #+cindex: radio tables
19429 Radio tables are target locations for translated tables that are not near
19430 their source. Org finds the target location and inserts the translated
19433 The key to finding the target location is the magic words =BEGIN/END
19434 RECEIVE ORGTBL=. They have to appear as comments in the current mode.
19435 If the mode is C, then:
19438 /* BEGIN RECEIVE ORGTBL table_name */
19439 /* END RECEIVE ORGTBL table_name */
19442 #+texinfo: @noindent
19443 At the location of source, Org needs a special line to direct Orgtbl
19444 to translate and to find the target for inserting the translated
19445 table. For example:
19447 #+cindex: @samp{ORGTBL}, keyword
19448 : #+ORGTBL: SEND table_name translation_function arguments ...
19450 #+texinfo: @noindent
19451 =table_name= is the table's reference name, which is also used in the
19452 receiver lines, and the =translation_function= is the Lisp function
19453 that translates. This line, in addition, may also contain alternating
19454 key and value arguments at the end. The translation function gets
19455 these values as a property list. A few standard parameters are
19456 already recognized and acted upon before the translation function is
19461 Skip the first N lines of the table. Hlines do count; include
19462 them if they are to be skipped.
19464 - =:skipcols (n1 n2 ...)= ::
19466 List of columns to be skipped. First Org automatically discards
19467 columns with calculation marks and then sends the table to the
19468 translator function, which then skips columns as specified in
19471 #+texinfo: @noindent
19472 To keep the source table intact in the buffer without being disturbed
19473 when the source file is compiled or otherwise being worked on, use one
19474 of these strategies:
19476 - Place the table in a block comment. For example, in C mode you
19477 could wrap the table between =/*= and =*/= lines.
19479 - Put the table after an "end" statement. For example ~\bye~ in TeX
19480 and ~\end{document}~ in LaTeX.
19482 - Comment and un-comment each line of the table during edits. The
19483 {{{kbd(M-x orgtbl-toggle-comment)}}} command makes toggling easy.
19485 *** A LaTeX example of radio tables
19487 :DESCRIPTION: Step by step, almost a tutorial.
19488 :ALT_TITLE: A LaTeX example
19490 #+cindex: @LaTeX{}, and Orgtbl mode
19492 To wrap a source table in LaTeX, use the =comment= environment
19493 provided by =comment.sty=[fn:140]. To activate it, put
19494 ~\usepackage{comment}~ in the document header. Orgtbl mode inserts
19495 a radio table skeleton[fn:139] with the command {{{kbd(M-x
19496 orgtbl-insert-radio-table)}}}, which prompts for a table name. For
19497 example, if =salesfigures= is the name, the template inserts:
19500 % BEGIN RECEIVE ORGTBL salesfigures
19501 % END RECEIVE ORGTBL salesfigures
19503 ,#+ORGTBL: SEND salesfigures orgtbl-to-latex
19508 #+vindex: LaTeX-verbatim-environments
19509 #+texinfo: @noindent
19510 The line =#+ORGTBL: SEND= tells Orgtbl mode to use the function
19511 ~orgtbl-to-latex~ to convert the table to LaTeX format, then insert
19512 the table at the target (receive) location named =salesfigures=. Now
19513 the table is ready for data entry. It can even use spreadsheet
19517 % BEGIN RECEIVE ORGTBL salesfigures
19518 % END RECEIVE ORGTBL salesfigures
19520 ,#+ORGTBL: SEND salesfigures orgtbl-to-latex
19521 | Month | Days | Nr sold | per day |
19522 |-------+------+---------+---------|
19523 | Jan | 23 | 55 | 2.4 |
19524 | Feb | 21 | 16 | 0.8 |
19525 | March | 22 | 278 | 12.6 |
19526 ,#+TBLFM: $4=$3/$2;%.1f
19527 % $ (optional extra dollar to keep Font Lock happy, see footnote)
19531 #+texinfo: @noindent
19532 After editing, {{{kbd(C-c C-c)}}} inserts the translated table at the
19533 target location, between the two marker lines.
19535 For hand-made custom tables, note that the translator needs to skip
19536 the first two lines of the source table. Also the command has to
19537 /splice/ out the target table without the header and footer.
19540 \begin{tabular}{lrrr}
19541 Month & \multicolumn{1}{c}{Days} & Nr.\ sold & per day\\
19542 % BEGIN RECEIVE ORGTBL salesfigures
19543 % END RECEIVE ORGTBL salesfigures
19547 ,#+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
19548 | Month | Days | Nr sold | per day |
19549 |-------+------+---------+---------|
19550 | Jan | 23 | 55 | 2.4 |
19551 | Feb | 21 | 16 | 0.8 |
19552 | March | 22 | 278 | 12.6 |
19553 ,#+TBLFM: $4=$3/$2;%.1f
19557 The LaTeX translator function ~orgtbl-to-latex~ is already part of
19558 Orgtbl mode and uses a =tabular= environment to typeset the table and
19559 marks horizontal lines with ~\hline~. For additional parameters to
19560 control output, see [[*Translator functions]]:
19562 - ~:splice nil/t~ ::
19564 When non-~nil~, return only table body lines; not wrapped in
19565 tabular environment. Default is ~nil~.
19569 Format to warp each field. It should contain =%s= for the
19570 original field value. For example, to wrap each field value in
19571 dollar symbol, you could use =:fmt "$%s$"=. Format can also wrap
19572 a property list with column numbers and formats, for example
19573 =:fmt (2 "$%s$" 4 "%s\\%%")=. In place of a string, a function
19574 of one argument can be used; the function must return a formatted
19579 Format numbers as exponentials. The spec should have =%s= twice
19580 for inserting mantissa and exponent, for example
19581 ="%s\\times10^{%s}"=. This may also be a property list with
19582 column numbers and formats, for example =:efmt (2
19583 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")=. After
19584 {{{var(EFMT)}}} has been applied to a value, {{{var(FMT)}}}---see
19585 above---is also be applied. Functions with two arguments can be
19586 supplied instead of strings. By default, no special formatting
19589 *** Translator functions
19591 :DESCRIPTION: Copy and modify.
19593 #+cindex: HTML, and Orgtbl mode
19594 #+cindex: translator function
19596 #+findex: orgtbl-to-csv
19597 #+findex: orgtbl-to-tsv
19598 #+findex: orgtbl-to-latex
19599 #+findex: orgtbl-to-html
19600 #+findex: orgtbl-to-texinfo
19601 #+findex: orgtbl-to-unicode
19602 #+findex: orgtbl-to-orgtbl
19603 #+findex: orgtbl-to-generic
19604 Orgtbl mode has built-in translator functions: ~orgtbl-to-csv~
19605 (comma-separated values), ~orgtbl-to-tsv~ (TAB-separated values),
19606 ~orgtbl-to-latex~, ~orgtbl-to-html~, ~orgtbl-to-texinfo~,
19607 ~orgtbl-to-unicode~ and ~orgtbl-to-orgtbl~. They use the generic
19608 translator, ~orgtbl-to-generic~, which delegates translations to
19609 various export back-ends.
19611 Properties passed to the function through the =ORGTBL SEND= line take
19612 precedence over properties defined inside the function. For example,
19613 this overrides the default LaTeX line endings, ~\\~, with ~\\[2mm]~:
19615 : #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
19617 For a new language translator, define a converter function. It can be
19618 a generic function, such as shown in this example. It marks
19619 a beginning and ending of a table with =!BTBL!= and =!ETBL!=;
19620 a beginning and ending of lines with =!BL!= and =!EL!=; and uses a TAB
19621 for a field separator:
19623 #+begin_src emacs-lisp
19624 (defun orgtbl-to-language (table params)
19625 "Convert the orgtbl-mode TABLE to language."
19628 (org-combine-plists
19629 '(:tstart "!BTBL!" :tend "!ETBL!" :lstart "!BL!" :lend "!EL!" :sep "\t")
19633 #+texinfo: @noindent
19634 The documentation for the ~orgtbl-to-generic~ function shows
19635 a complete list of parameters, each of which can be passed through to
19636 ~orgtbl-to-latex~, ~orgtbl-to-texinfo~, and any other function using
19637 that generic function.
19639 For complicated translations the generic translator function could be
19640 replaced by a custom translator function. Such a custom function must
19641 take two arguments and return a single string containing the formatted
19642 table. The first argument is the table whose lines are a list of
19643 fields or the symbol ~hline~. The second argument is the property
19644 list consisting of parameters specified in the =#+ORGTBL: SEND= line.
19645 Please share your translator functions by posting them to the Org
19646 users mailing list, at mailto:emacs-orgmode@gnu.org.
19650 :DESCRIPTION: Automatically filled blocks.
19652 #+cindex: dynamic blocks
19654 Org supports /dynamic blocks/ in Org documents. They are inserted
19655 with begin and end markers like any other code block, but the contents
19656 are updated automatically by a user function. For example, {{{kbd(C-c
19657 C-x C-r)}}} inserts a dynamic table that updates the work time (see
19658 [[*Clocking Work Time]]).
19660 Dynamic blocks can have names and function parameters. The syntax is
19661 similar to source code block specifications:
19664 ,#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
19669 These commands update dynamic blocks:
19671 - {{{kbd(C-c C-x C-u)}}} (~org-dblock-update~) ::
19673 #+kindex: C-c C-x C-u
19674 #+findex: org-dblock-update
19675 Update dynamic block at point.
19677 - {{{kbd(C-u C-c C-x C-u)}}} ::
19679 #+kindex: C-u C-c C-x C-u
19680 Update all dynamic blocks in the current file.
19682 Before updating a dynamic block, Org removes content between the
19683 =BEGIN= and =END= markers. Org then reads the parameters on the
19684 =BEGIN= line for passing to the writer function. If the function
19685 expects to access the removed content, then Org expects an extra
19686 parameter, =:content=, on the =BEGIN= line.
19688 The syntax for naming a writer function with a dynamic block labelled
19689 =myblock= is: ~org-dblock-write:myblock~. Parameters come from the
19692 The following is an example of a dynamic block and a block writer function
19693 that updates the time when the function was last run:
19696 ,#+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
19701 #+texinfo: @noindent
19702 The dynamic block's writer function:
19704 #+begin_src emacs-lisp
19705 (defun org-dblock-write:block-update-time (params)
19706 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
19707 (insert "Last block update at: "
19708 (format-time-string fmt))))
19711 To keep dynamic blocks up-to-date in an Org file, use the function,
19712 ~org-update-all-dblocks~ in hook, such as ~before-save-hook~. The
19713 ~org-update-all-dblocks~ function does not run if the file is not in
19716 #+findex: org-narrow-to-block
19717 Dynamic blocks, like any other block, can be narrowed with
19718 ~org-narrow-to-block~.
19720 ** Special Agenda Views
19722 :DESCRIPTION: Customized views.
19724 #+cindex: agenda views, user-defined
19726 #+vindex: org-agenda-skip-function
19727 #+vindex: org-agenda-skip-function-global
19728 Org provides a special hook to further limit items in agenda views:
19729 ~agenda~, ~agenda*~[fn:142], ~todo~, ~alltodo~, ~tags~, ~tags-todo~,
19730 ~tags-tree~. Specify a custom function that tests inclusion of every
19731 matched item in the view. This function can also skip as much as is
19734 For a global condition applicable to agenda views, use the
19735 ~org-agenda-skip-function-global~ variable. Org uses a global
19736 condition with ~org-agenda-skip-function~ for custom searching.
19738 This example defines a function for a custom view showing TODO items
19739 with =waiting= status. Manually this is a multi-step search process,
19740 but with a custom view, this can be automated as follows:
19742 The custom function searches the subtree for the =waiting= tag and
19743 returns ~nil~ on match. Otherwise it gives the location from where
19744 the search continues.
19746 #+begin_src emacs-lisp
19747 (defun my-skip-unless-waiting ()
19748 "Skip trees that are not waiting"
19749 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
19750 (if (re-search-forward ":waiting:" subtree-end t)
19751 nil ; tag found, do not skip
19752 subtree-end))) ; tag not found, continue after end of subtree
19755 To use this custom function in a custom agenda command:
19757 #+begin_src emacs-lisp
19758 (org-add-agenda-custom-command
19759 '("b" todo "PROJECT"
19760 ((org-agenda-skip-function 'my-skip-unless-waiting)
19761 (org-agenda-overriding-header "Projects waiting for something: "))))
19764 #+vindex: org-agenda-overriding-header
19765 Note that this also binds ~org-agenda-overriding-header~ to a more
19766 meaningful string suitable for the agenda view.
19768 #+vindex: org-odd-levels-only
19769 #+vindex: org-agenda-skip-function
19770 Search for entries with a limit set on levels for the custom search.
19771 This is a general approach to creating custom searches in Org. To
19772 include all levels, use =LEVEL>0=[fn:143]. Then to selectively pick
19773 the matched entries, use ~org-agenda-skip-function~, which also
19774 accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and
19775 ~org-agenda-skip-subtree-if~. For example:
19777 - ~(org-agenda-skip-entry-if 'scheduled)~ ::
19779 Skip current entry if it has been scheduled.
19781 - ~(org-agenda-skip-entry-if 'notscheduled)~ ::
19783 Skip current entry if it has not been scheduled.
19785 - ~(org-agenda-skip-entry-if 'deadline)~ ::
19787 Skip current entry if it has a deadline.
19789 - ~(org-agenda-skip-entry-if 'scheduled 'deadline)~ ::
19791 Skip current entry if it has a deadline, or if it is scheduled.
19793 - ~(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))~ ::
19795 Skip current entry if the TODO keyword is TODO or WAITING.
19797 - ~(org-agenda-skip-entry-if 'todo 'done)~ ::
19799 Skip current entry if the TODO keyword marks a DONE state.
19801 - ~(org-agenda-skip-entry-if 'timestamp)~ ::
19803 Skip current entry if it has any timestamp, may also be deadline
19806 - ~(org-agenda-skip-entry-if 'regexp "regular expression")~ ::
19808 Skip current entry if the regular expression matches in the
19811 - ~(org-agenda-skip-entry-if 'notregexp "regular expression")~ ::
19813 Skip current entry unless the regular expression matches.
19815 - ~(org-agenda-skip-subtree-if 'regexp "regular expression")~ ::
19817 Same as above, but check and skip the entire subtree.
19819 The following is an example of a search for =waiting= without the
19822 #+begin_src emacs-lisp
19823 (org-add-agenda-custom-command
19824 '("b" todo "PROJECT"
19825 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
19826 'regexp ":waiting:"))
19827 (org-agenda-overriding-header "Projects waiting for something: "))))
19830 ** Speeding Up Your Agendas
19832 :DESCRIPTION: Tips on how to speed up your agendas.
19834 #+cindex: agenda views, optimization
19836 Some agenda commands slow down when the Org files grow in size or
19837 number. Here are tips to speed up:
19839 - Reduce the number of Org agenda files to avoid slowdowns due to hard drive
19842 - Reduce the number of DONE and archived headlines so agenda
19843 operations that skip over these can finish faster.
19845 - Do not dim blocked tasks:
19846 #+vindex: org-agenda-dim-blocked-tasks
19848 #+begin_src emacs-lisp
19849 (setq org-agenda-dim-blocked-tasks nil)
19852 - Stop preparing agenda buffers on startup:
19853 #+vindex: org-startup-folded
19854 #+vindex: org-agenda-inhibit-startup
19856 #+begin_src emacs-lisp
19857 (setq org-agenda-inhibit-startup nil)
19860 - Disable tag inheritance for agendas:
19861 #+vindex: org-agenda-show-inherited-tags
19862 #+vindex: org-agenda-use-tag-inheritance
19864 #+begin_src emacs-lisp
19865 (setq org-agenda-use-tag-inheritance nil)
19868 These options can be applied to selected agenda views. For more
19869 details about generation of agenda views, see the docstrings for the
19870 relevant variables, and this [[https://orgmode.org/worg/agenda-optimization.html][dedicated Worg page]] for agenda
19873 ** Extracting Agenda Information
19875 :DESCRIPTION: Post-processing agenda information.
19877 #+cindex: agenda, pipe
19878 #+cindex: scripts, for agenda processing
19880 Org provides commands to access agendas through Emacs batch mode.
19881 Through this command-line interface, agendas are automated for further
19882 processing or printing.
19884 #+vindex: org-agenda-custom-commands
19885 #+findex: org-batch-agenda
19886 ~org-batch-agenda~ creates an agenda view in ASCII and outputs to
19887 standard output. This command takes one string parameter. When
19888 string consists of a single character, Org uses it as a key to
19889 ~org-agenda-custom-commands~. These are the same ones available
19890 through the agenda dispatcher (see [[*The Agenda Dispatcher]]).
19892 This example command line directly prints the TODO list to the printer:
19894 : emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
19896 When the string parameter length is two or more characters, Org
19897 matches it with tags/TODO strings. For example, this example command
19898 line prints items tagged with =shop=, but excludes items tagged with
19902 emacs -batch -l ~/.emacs \
19903 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
19906 #+texinfo: @noindent
19907 An example showing on-the-fly parameter modifications:
19910 emacs -batch -l ~/.emacs \
19911 -eval '(org-batch-agenda "a" \
19912 org-agenda-span (quote month) \
19913 org-agenda-include-diary nil \
19914 org-agenda-files (quote ("~/org/project.org")))' \
19918 #+texinfo: @noindent
19919 which produces an agenda for the next 30 days from just the
19920 =~/org/projects.org= file.
19922 #+findex: org-batch-agenda-csv
19923 For structured processing of agenda output, use ~org-batch-agenda-csv~
19924 with the following fields:
19926 - category :: The category of the item
19927 - head :: The headline, without TODO keyword, TAGS and PRIORITY
19928 - type :: The type of the agenda entry, can be
19930 | ~todo~ | selected in TODO match |
19931 | ~tagsmatch~ | selected in tags match |
19932 | ~diary~ | imported from diary |
19933 | ~deadline~ | a deadline |
19934 | ~scheduled~ | scheduled |
19935 | ~timestamp~ | appointment, selected by timestamp |
19936 | ~closed~ | entry was closed on date |
19937 | ~upcoming-deadline~ | warning about nearing deadline |
19938 | ~past-scheduled~ | forwarded scheduled item |
19939 | ~block~ | entry has date block including date |
19941 - todo :: The TODO keyword, if any
19942 - tags :: All tags including inherited ones, separated by colons
19943 - date :: The relevant date, like =2007-2-14=
19944 - time :: The time, like =15:00-16:50=
19945 - extra :: String with extra planning info
19946 - priority-l :: The priority letter if any was given
19947 - priority-n :: The computed numerical priority
19949 #+texinfo: @noindent
19950 If the selection of the agenda item was based on a timestamp,
19951 including those items with =DEADLINE= and =SCHEDULED= keywords, then
19952 Org includes date and time in the output.
19954 If the selection of the agenda item was based on a timestamp (or
19955 deadline/scheduled), then Org includes date and time in the output.
19957 Here is an example of a post-processing script in Perl. It takes the
19958 CSV output from Emacs and prints with a checkbox:
19963 # define the Emacs command to run
19964 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
19966 # run it and capture the output
19967 $agenda = qx{$cmd 2>/dev/null};
19969 # loop over all lines
19970 foreach $line (split(/\n/,$agenda)) {
19971 # get the individual values
19972 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
19973 $priority_l,$priority_n) = split(/,/,$line);
19974 # process and print
19975 print "[ ] $head\n";
19979 ** Using the Property API
19981 :DESCRIPTION: Writing programs that use entry properties.
19983 #+cindex: API, for properties
19984 #+cindex: properties, API
19986 Here is a description of the functions that can be used to work with
19989 #+attr_texinfo: :options org-entry-properties &optional pom which
19991 Get all properties of the entry at point-or-marker {{{var(POM)}}}.
19992 This includes the TODO keyword, the tags, time strings for deadline,
19993 scheduled, and clocking, and any additional properties defined in the
19994 entry. The return value is an alist. Keys may occur multiple times
19995 if the property key was used several times. {{{var(POM)}}} may also
19996 be ~nil~, in which case the current entry is used. If
19997 {{{var(WHICH)}}} is ~nil~ or ~all~, get all properties. If
19998 {{{var(WHICH)}}} is ~special~ or ~standard~, only get that subclass.
20001 #+vindex: org-use-property-inheritance
20002 #+findex: org-insert-property-drawer
20003 #+attr_texinfo: :options org-entry-get pom property &optional inherit
20005 Get value of {{{var(PROPERTY)}}} for entry at point-or-marker
20006 {{{var(POM)}}}. By default, this only looks at properties defined
20007 locally in the entry. If {{{var(INHERIT)}}} is non-~nil~ and the
20008 entry does not have the property, then also check higher levels of the
20009 hierarchy. If {{{var(INHERIT)}}} is the symbol ~selective~, use
20010 inheritance if and only if the setting of
20011 ~org-use-property-inheritance~ selects {{{var(PROPERTY)}}} for
20015 #+attr_texinfo: :options org-entry-delete pom property
20017 Delete the property {{{var(PROPERTY)}}} from entry at point-or-marker
20021 #+attr_texinfo: :options org-entry-put pom property value
20023 Set {{{var(PROPERTY)}}} to {{{var(VALUES)}}} for entry at
20024 point-or-marker POM.
20027 #+attr_texinfo: :options org-buffer-property-keys &optional include-specials
20029 Get all property keys in the current buffer.
20032 #+attr_texinfo: :options org-insert-property-drawer
20034 Insert a property drawer for the current entry. Also
20037 #+attr_texinfo: :options org-entry-put-multivalued-property pom property &rest values
20039 Set {{{var(PROPERTY)}}} at point-or-marker {{{var(POM)}}} to
20040 {{{var(VALUES)}}}. {{{var(VALUES)}}} should be a list of strings.
20041 They are concatenated, with spaces as separators.
20044 #+attr_texinfo: :options org-entry-get-multivalued-property pom property
20046 Treat the value of the property {{{var(PROPERTY)}}} as
20047 a whitespace-separated list of values and return the values as a list
20051 #+attr_texinfo: :options org-entry-add-to-multivalued-property pom property value
20053 Treat the value of the property {{{var(PROPERTY)}}} as
20054 a whitespace-separated list of values and make sure that
20055 {{{var(VALUE)}}} is in this list.
20058 #+attr_texinfo: :options org-entry-remove-from-multivalued-property pom property value
20060 Treat the value of the property {{{var(PROPERTY)}}} as
20061 a whitespace-separated list of values and make sure that
20062 {{{var(VALUE)}}} is /not/ in this list.
20065 #+attr_texinfo: :options org-entry-member-in-multivalued-property pom property value
20067 Treat the value of the property {{{var(PROPERTY)}}} as
20068 a whitespace-separated list of values and check if {{{var(VALUE)}}} is
20072 #+attr_texinfo: :options org-property-allowed-value-functions
20074 Hook for functions supplying allowed values for a specific property.
20075 The functions must take a single argument, the name of the property,
20076 and return a flat list of allowed values. If =:ETC= is one of the
20077 values, use the values as completion help, but allow also other values
20078 to be entered. The functions must return ~nil~ if they are not
20079 responsible for this property.
20082 ** Using the Mapping API
20084 :DESCRIPTION: Mapping over all or selected entries.
20086 #+cindex: API, for mapping
20087 #+cindex: mapping entries, API
20089 Org has sophisticated mapping capabilities to find all entries
20090 satisfying certain criteria. Internally, this functionality is used
20091 to produce agenda views, but there is also an API that can be used to
20092 execute arbitrary functions for each or selected entries. The main
20093 entry point for this API is:
20095 #+attr_texinfo: :options org-map-entries func &optional match scope &rest skip
20097 Call {{{(var(FUNC))}}} at each headline selected by {{{var(MATCH)}}}
20098 in {{{var(SCOPE)}}}.
20100 {{{var(FUNC)}}} is a function or a Lisp form. With the cursor
20101 positioned at the beginning of the headline, call the function without
20102 arguments. Org returns an alist of return values of calls to the
20105 To avoid preserving point, Org wraps the call to {{{var(FUNC)}}} in
20106 save-excursion form. After evaluation, Org moves the cursor to the
20107 end of the line that was just processed. Search continues from that
20108 point forward. This may not always work as expected under some
20109 conditions, such as if the current sub-tree was removed by a previous
20110 archiving operation. In such rare circumstances, Org skips the next
20111 entry entirely when it should not. To stop Org from such skips, make
20112 {{{var(FUNC)}}} set the variable ~org-map-continue-from~ to a specific
20115 {{{var(MATCH)}}} is a tags/property/TODO match. Org iterates only
20116 matched headlines. Org iterates over all headlines when
20117 {{{var(MATCH)}}} is ~nil~ or ~t~.
20119 {{{var(SCOPE)}}} determines the scope of this command. It can be any
20124 The current buffer, respecting the restriction, if any.
20128 The subtree started with the entry at point.
20132 The entries within the active region, if any.
20136 The current buffer, without restriction.
20138 - ~file-with-archives~ ::
20140 The current buffer, and any archives associated with it.
20146 - ~agenda-with-archives~ ::
20148 All agenda files with any archive files associated with them.
20150 - ~(file1 file2 ...)~ ::
20152 If this is a list, all files in the list are scanned.
20154 #+texinfo: @noindent
20155 The remaining arguments are treated as settings for the scanner's
20156 skipping facilities. Valid arguments are:
20160 Skip trees with the archive tag.
20164 Skip trees with the COMMENT keyword.
20166 - function or Lisp form ::
20168 #+vindex: org-agenda-skip-function
20169 Used as value for ~org-agenda-skip-function~, so whenever the
20170 function returns ~t~, {{{var(FUNC)}}} is called for that entry
20171 and search continues from the point where the function leaves it.
20174 The mapping routine can call any arbitrary function, even functions
20175 that change meta data or query the property API (see [[*Using the
20176 Property API]]). Here are some handy functions:
20178 #+attr_texinfo: :options org-todo &optional arg
20180 Change the TODO state of the entry. See the docstring of the
20181 functions for the many possible values for the argument
20185 #+attr_texinfo: :options org-priority &optional action
20187 Change the priority of the entry. See the docstring of this function
20188 for the possible values for {{{var(ACTION)}}}.
20191 #+attr_texinfo: :options org-toggle-tag tag &optional onoff
20193 Toggle the tag {{{var(TAG)}}} in the current entry. Setting
20194 {{{var(ONOFF)}}} to either ~on~ or ~off~ does not toggle tag, but
20195 ensure that it is either on or off.
20198 #+attr_texinfo: :options org-promote
20200 Promote the current entry.
20203 #+attr_texinfo: :options org-demote
20205 Demote the current entry.
20208 This example turns all entries tagged with =TOMORROW= into TODO
20209 entries with keyword =UPCOMING=. Org ignores entries in comment trees
20212 #+begin_src emacs-lisp
20213 (org-map-entries '(org-todo "UPCOMING")
20214 "+TOMORROW" 'file 'archive 'comment)
20217 The following example counts the number of entries with TODO keyword
20218 =WAITING=, in all agenda files.
20220 #+begin_src emacs-lisp
20221 (length (org-map-entries t "/+WAITING" 'agenda))
20226 :DESCRIPTION: Viewing and capture on a mobile device.
20227 :APPENDIX: Appendix
20230 #+cindex: smartphone
20232 #+cindex: MobileOrg
20234 MobileOrg is a companion mobile app that runs on iOS and Android
20235 devices. MobileOrg enables offline-views and capture support for an
20236 Org mode system that is rooted on a "real" computer. MobileOrg can
20237 record changes to existing entries.
20239 The [[https://github.com/MobileOrg/][iOS implementation]] for the /iPhone/iPod Touch/iPad/ series of
20240 devices, was started by Richard Moreland and is now in the hands of
20241 Sean Escriva. Android users should check out [[http://wiki.github.com/matburt/mobileorg-android/][MobileOrg Android]] by
20242 Matt Jones. Though the two implementations are not identical, they
20243 offer similar features.
20245 This appendix describes Org's support for agenda view formats
20246 compatible with MobileOrg. It also describes synchronizing changes,
20247 such as to notes, between MobileOrg and the computer.
20249 To change tags and TODO states in MobileOrg, first customize the
20250 variables ~org-todo-keywords~ and ~org-tag-alist~. These should cover
20251 all the important tags and TODO keywords, even if Org files use only
20252 some of them. Though MobileOrg has in-buffer settings, it understands
20253 TODO states /sets/ (see [[*Setting up keywords for individual files]]) and
20254 /mutually exclusive/ tags (see [[*Setting Tags]]) only for those set in
20257 ** Setting Up the Staging Area
20259 :DESCRIPTION: For the mobile device.
20262 MobileOrg needs access to a file directory on a server to interact
20263 with Emacs. With a public server, consider encrypting the files.
20264 MobileOrg version 1.5 supports encryption for the iPhone. Org also
20265 requires =openssl= installed on the local computer. To turn on
20266 encryption, set the same password in MobileOrg and in Emacs. Set the
20267 password in the variable ~org-mobile-use-encryption~[fn:144]. Note
20268 that even after MobileOrg encrypts the file contents, the file name
20269 remains visible on the file systems of the local computer, the server,
20270 and the mobile device.
20272 For a server to host files, consider options like [[http://dropbox.com][Dropbox.com]]
20273 account[fn:145]. On first connection, MobileOrg creates a directory
20274 =MobileOrg= on Dropbox. Pass its location to Emacs through an
20275 initialisation file variable as follows:
20277 #+begin_src emacs-lisp
20278 (setq org-mobile-directory "~/Dropbox/MobileOrg")
20281 Org copies files to the above directory for MobileOrg. Org also uses
20282 the same directory for sharing notes between Org and MobileOrg.
20284 ** Pushing to MobileOrg
20286 :DESCRIPTION: Uploading Org files and agendas.
20289 #+vindex: org-mobile-files
20290 #+vindex: org-directory
20291 Org pushes files listed in ~org-mobile-files~ to
20292 ~org-mobile-directory~. Files include agenda files (as listed in
20293 ~org-agenda-files~). Customize ~org-mobile-files~ to add other files.
20294 File names are staged with paths relative to ~org-directory~, so all
20295 files should be inside this directory[fn:146].
20297 Push creates a special Org file =agendas.org= with custom agenda views
20298 defined by the user[fn:147].
20300 Finally, Org writes the file =index.org=, containing links to other
20301 files. MobileOrg reads this file first from the server to determine
20302 what other files to download for agendas. For faster downloads,
20303 MobileOrg only reads files whose checksums[fn:148] have changed.
20305 ** Pulling from MobileOrg
20307 :DESCRIPTION: Integrating captured and flagged items.
20310 When MobileOrg synchronizes with the server, it pulls the Org files
20311 for viewing. It then appends to the file =mobileorg.org= on the
20312 server the captured entries, pointers to flagged and changed entries.
20313 Org integrates its data in an inbox file format.
20316 #+vindex: org-mobile-inbox-for-pull
20317 Org moves all entries found in =mobileorg.org=[fn:149] and appends
20318 them to the file pointed to by the variable
20319 ~org-mobile-inbox-for-pull~. Each captured entry and each editing
20320 event is a top-level entry in the inbox file.
20322 2. After moving the entries, Org attempts changes to MobileOrg. Some
20323 changes are applied directly and without user interaction.
20324 Examples include changes to tags, TODO state, headline and body
20325 text. Entries for further action are tagged as =FLAGGED=. Org
20326 marks entries with problems with an error message in the inbox.
20327 They have to be resolved manually.
20329 3. Org generates an agenda view for flagged entries for user
20330 intervention to clean up. For notes stored in flagged entries,
20331 MobileOrg displays them in the echo area when the cursor is on the
20332 corresponding agenda item.
20337 Pressing {{{kbd(?)}}} displays the entire flagged note in
20338 another window. Org also pushes it to the kill ring. To
20339 store flagged note as a normal note, use {{{kbd(? z C-y C-c
20340 C-c)}}}. Pressing{{{kbd(?)}}} twice does these things: first
20341 it removes the =FLAGGED= tag; second, it removes the flagged
20342 note from the property drawer; third, it signals that manual
20343 editing of the flagged entry is now finished.
20345 #+kindex: ? @r{(Agenda dispatcher)}
20346 From the agenda dispatcher, {{{kbd(?)}}} returns to the view to finish
20347 processing flagged entries. Note that these entries may not be the
20348 most recent since MobileOrg searches files that were last pulled. To
20349 get an updated agenda view with changes since the last pull, pull
20352 * History and Acknowledgments
20354 :DESCRIPTION: How Org came into being.
20363 Org was born in 2003, out of frustration over the user interface of
20364 the Emacs Outline mode. I was trying to organize my notes and
20365 projects, and using Emacs seemed to be the natural way to go.
20366 However, having to remember eleven different commands with two or
20367 three keys per command, only to hide and show parts of the outline
20368 tree, that seemed entirely unacceptable to me. Also, when using
20369 outlines to take notes, I constantly wanted to restructure the tree,
20370 organizing it parallel to my thoughts and plans. /Visibility cycling/
20371 and /structure editing/ were originally implemented in the package
20372 =outline-magic.el=, but quickly moved to the more general =org.el=.
20373 As this environment became comfortable for project planning, the next
20374 step was adding /TODO entries/, basic /timestamps/, and /table
20375 support/. These areas highlighted the two main goals that Org still
20376 has today: to be a new, outline-based, plain text mode with innovative
20377 and intuitive editing features, and to incorporate project planning
20378 functionality directly into a notes file.
20380 Since the first release, literally thousands of emails to me or to the
20381 [[mailto:emacs-orgmode@gnu.org][mailing list]] have provided a constant stream of bug reports, feedback,
20382 new ideas, and sometimes patches and add-on code. Many thanks to
20383 everyone who has helped to improve this package. I am trying to keep
20384 here a list of the people who had significant influence in shaping one
20385 or more aspects of Org. The list may not be complete, if I have
20386 forgotten someone, please accept my apologies and let me know.
20388 Before I get to this list, a few special mentions are in order:
20390 - Bastien Guerry ::
20392 Bastien has written a large number of extensions to Org (most of
20393 them integrated into the core by now), including the LaTeX
20394 exporter and the plain list parser. His support during the early
20395 days was central to the success of this project. Bastien also
20396 invented Worg, helped establishing the Web presence of Org, and
20397 sponsored hosting costs for the orgmode.org website. Bastien
20398 stepped in as maintainer of Org between 2011 and 2013, at a time
20399 when I desperately needed a break.
20401 - Eric Schulte and Dan Davison ::
20403 Eric and Dan are jointly responsible for the Org Babel system,
20404 which turns Org into a multi-language environment for evaluating
20405 code and doing literate programming and reproducible research.
20406 This has become one of Org's killer features that define what Org
20411 John has contributed a number of great ideas and patches directly
20412 to Org, including the attachment system (=org-attach.el=),
20413 integration with Apple Mail (=org-mac-message.el=), hierarchical
20414 dependencies of TODO items, habit tracking (=org-habits.el=), and
20415 encryption (=org-crypt.el=). Also, the capture system is really
20416 an extended copy of his great =remember.el=.
20418 - Sebastian Rose ::
20420 Without Sebastian, the HTML/XHTML publishing of Org would be the
20421 pitiful work of an ignorant amateur. Sebastian has pushed this
20422 part of Org onto a much higher level. He also wrote
20423 =org-info.js=, a Java script for displaying webpages derived from
20424 Org using an Info-like or a folding interface with single-key
20427 #+texinfo: @noindent
20428 See below for the full list of contributions! Again, please let me
20429 know what I am missing here!
20436 I (Bastien) have been maintaining Org between 2011 and 2013. This
20437 appendix would not be complete without adding a few more
20438 acknowledgments and thanks.
20440 I am first grateful to Carsten for his trust while handing me over the
20441 maintainership of Org. His unremitting support is what really helped
20442 me getting more confident over time, with both the community and the
20445 When I took over maintainership, I knew I would have to make Org more
20446 collaborative than ever, as I would have to rely on people that are
20447 more knowledgeable than I am on many parts of the code. Here is
20448 a list of the persons I could rely on, they should really be
20449 considered co-maintainers, either of the code or the community:
20453 Eric is maintaining the Babel parts of Org. His reactivity here
20454 kept me away from worrying about possible bugs here and let me
20455 focus on other parts.
20457 - Nicolas Goaziou ::
20459 Nicolas is maintaining the consistency of the deepest parts of
20460 Org. His work on =org-element.el= and =ox.el= has been
20461 outstanding, and it opened the doors for many new ideas and
20462 features. He rewrote many of the old exporters to use the new
20463 export engine, and helped with documenting this major change.
20464 More importantly (if that's possible), he has been more than
20465 reliable during all the work done for Org 8.0, and always very
20466 reactive on the mailing list.
20470 Achim rewrote the building process of Org, turning some /ad hoc/
20471 tools into a flexible and conceptually clean process. He
20472 patiently coped with the many hiccups that such a change can
20477 The Org mode mailing list would not be such a nice place without
20478 Nick, who patiently helped users so many times. It is impossible
20479 to overestimate such a great help, and the list would not be so
20480 active without him.
20482 I received support from so many users that it is clearly impossible to
20483 be fair when shortlisting a few of them, but Org's history would not
20484 be complete if the ones above were not mentioned in this manual.
20486 ** List of Contributions
20491 - Russel Adams came up with the idea for drawers.
20493 - Thomas Baumann wrote =org-bbdb.el= and =org-mhe.el=.
20495 - Christophe Bataillon created the great unicorn logo that we use on
20496 the Org mode website.
20498 - Alex Bochannek provided a patch for rounding timestamps.
20500 - Jan Böcker wrote =org-docview.el=.
20502 - Brad Bozarth showed how to pull RSS feed data into Org files.
20504 - Tom Breton wrote =org-choose.el=.
20506 - Charles Cave's suggestion sparked the implementation of templates
20507 for Remember, which are now templates for capture.
20509 - Pavel Chalmoviansky influenced the agenda treatment of items with
20512 - Gregory Chernov patched support for Lisp forms into table
20513 calculations and improved XEmacs compatibility, in particular by
20514 porting =nouline.el= to XEmacs.
20516 - Sacha Chua suggested copying some linking code from Planner.
20518 - Baoqiu Cui contributed the DocBook exporter.
20520 - Eddward DeVilla proposed and tested checkbox statistics. He also
20521 came up with the idea of properties, and that there should be an API
20524 - Nick Dokos tracked down several nasty bugs.
20526 - Kees Dullemond used to edit projects lists directly in HTML and so
20527 inspired some of the early development, including HTML export. He
20528 also asked for a way to narrow wide table columns.
20530 - Thomas\nbsp{}S.\nbsp{}Dye contributed documentation on Worg and helped
20531 integrating the Org Babel documentation into the manual.
20533 - Christian Egli converted the documentation into Texinfo format,
20534 inspired the agenda, patched CSS formatting into the HTML exporter,
20535 and wrote =org-taskjuggler.el=.
20537 - David Emery provided a patch for custom CSS support in exported HTML
20540 - Nic Ferrier contributed mailcap and XOXO support.
20542 - Miguel\nbsp{}A.\nbsp{}Figueroa-Villanueva implemented hierarchical checkboxes.
20544 - John Foerch figured out how to make incremental search show context
20545 around a match in a hidden outline tree.
20547 - Raimar Finken wrote =org-git-line.el=.
20549 - Mikael Fornius works as a mailing list moderator.
20551 - Austin Frank works as a mailing list moderator.
20553 - Eric Fraga drove the development of Beamer export with ideas and
20556 - Barry Gidden did proofreading the manual in preparation for the book
20557 publication through Network Theory Ltd.
20559 - Niels Giesen had the idea to automatically archive DONE trees.
20561 - Nicolas Goaziou rewrote much of the plain list code.
20563 - Kai Grossjohann pointed out key-binding conflicts with other
20566 - Brian Gough of Network Theory Ltd publishes the Org mode manual as
20569 - Bernt Hansen has driven much of the support for auto-repeating
20570 tasks, task state change logging, and the clocktable. His clear
20571 explanations have been critical when we started to adopt the Git
20572 version control system.
20574 - Manuel Hermenegildo has contributed various ideas, small fixes and
20577 - Phil Jackson wrote =org-irc.el=.
20579 - Scott Jaderholm proposed footnotes, control over whitespace between
20580 folded entries, and column view for properties.
20582 - Matt Jones wrote MobileOrg Android.
20584 - Tokuya Kameshima wrote =org-wl.el= and =org-mew.el=.
20586 - Shidai Liu ("Leo") asked for embedded LaTeX and tested it. He also
20587 provided frequent feedback and some patches.
20589 - Matt Lundin has proposed last-row references for table formulas and
20590 named invisible anchors. He has also worked a lot on the FAQ.
20592 - David Maus wrote =org-atom.el=, maintains the issues file for Org,
20593 and is a prolific contributor on the mailing list with competent
20594 replies, small fixes and patches.
20596 - Jason\nbsp{}F.\nbsp{}McBrayer suggested agenda export to CSV format.
20598 - Max Mikhanosha came up with the idea of refiling.
20600 - Dmitri Minaev sent a patch to set priority limits on a per-file
20603 - Stefan Monnier provided a patch to keep the Emacs Lisp compiler
20606 - Richard Moreland wrote MobileOrg for the iPhone.
20608 - Rick Moynihan proposed allowing multiple TODO sequences in a file
20609 and being able to quickly restrict the agenda to a subtree.
20611 - Todd Neal provided patches for links to Info files and Elisp forms.
20613 - Greg Newman refreshed the unicorn logo into its current form.
20615 - Tim O'Callaghan suggested in-file links, search options for general
20616 file links, and tags.
20618 - Osamu Okano wrote =orgcard2ref.pl=, a Perl program to create a text
20619 version of the reference card.
20621 - Takeshi Okano translated the manual and David O'Toole's tutorial
20624 - Oliver Oppitz suggested multi-state TODO items.
20626 - Scott Otterson sparked the introduction of descriptive text for
20627 links, among other things.
20629 - Pete Phillips helped during the development of the TAGS feature,
20630 and provided frequent feedback.
20632 - Martin Pohlack provided the code snippet to bundle character
20633 insertion into bundles of 20 for undo.
20635 - T.\nbsp{}V.\nbsp{}Raman reported bugs and suggested improvements.
20637 - Matthias Rempe (Oelde) provided ideas, Windows support, and quality
20640 - Paul Rivier provided the basic implementation of named footnotes.
20641 He also acted as mailing list moderator for some time.
20643 - Kevin Rogers contributed code to access VM files on remote hosts.
20645 - Frank Ruell solved the mystery of the =keymapp nil= bug, a conflict
20648 - Jason Riedy generalized the send-receive mechanism for Orgtbl
20649 tables with extensive patches.
20651 - Philip Rooke created the Org reference card, provided lots of
20652 feedback, developed and applied standards to the Org documentation.
20654 - Christian Schlauer proposed angular brackets around links, among
20657 - Paul Sexton wrote =org-ctags.el=.
20659 - Tom Shannon's =organizer-mode.el= inspired linking to VM/BBDB/Gnus.
20661 - Ilya Shlyakhter proposed the Archive Sibling, line numbering in
20662 literal examples, and remote highlighting for referenced code lines.
20664 - Stathis Sideris wrote the =ditaa.jar= ASCII to PNG converter that is
20665 now packaged into Org's =contrib/= directory.
20667 - Daniel Sinder came up with the idea of internal archiving by locking
20670 - Dale Smith proposed link abbreviations.
20672 - James TD Smith has contributed a large number of patches for
20673 useful tweaks and features.
20675 - Adam Spiers asked for global linking commands, inspired the link
20676 extension system, added support for Mairix, and proposed the mapping
20679 - Ulf Stegemann created the table to translate special symbols to
20680 HTML, LaTeX, UTF-8, Latin-1 and ASCII.
20682 - Andy Stewart contributed code to =org-w3m.el=, to copy
20683 HTML content with links transformation to Org syntax.
20685 - David O'Toole wrote =org-publish.el= and drafted the
20686 manual chapter about publishing.
20688 - Jambunathan\nbsp{}K.\nbsp{}contributed the ODT exporter.
20690 - Sebastien Vauban reported many issues with LaTeX and Beamer export
20691 and enabled source code highlighting in Gnus.
20693 - Stefan Vollmar organized a video-recorded talk at the
20694 Max-Planck-Institute for Neurology. He also inspired the creation
20695 of a concept index for HTML export.
20697 - Jürgen Vollmer contributed code generating the table of contents in
20700 - Samuel Wales has provided important feedback and bug reports.
20702 - Chris Wallace provided a patch implementing the =QUOTE= block.
20704 - David Wainberg suggested archiving, and improvements to the
20707 - Carsten Wimmer suggested some changes and helped fix a bug in
20710 - Roland Winkler requested additional key bindings to make Org work on
20713 - Piotr Zielinski wrote =org-mouse.el=, proposed agenda
20714 blocks and contributed various ideas and code snippets.
20716 - Marco Wahl wrote =org-eww.el=.
20718 * GNU Free Documentation License
20721 :DESCRIPTION: The license for this documentation.
20724 #+texinfo: @include doclicense.texi
20729 :DESCRIPTION: An index of Org's concepts and features.
20734 :DESCRIPTION: Key bindings and where they are described.
20738 * Command and Function Index
20740 :DESCRIPTION: Command names and some internal functions.
20746 :DESCRIPTION: Variables mentioned in the manual.
20750 This is not a complete index of variables and faces, only the ones
20751 that are mentioned in the manual. For a more complete list, use
20752 {{{kbd(M-x org-customize)}}} and then click yourself through the tree.
20759 This manual is for Org version {{{version}}}.
20761 Copyright \copy 2004--2018 Free Software Foundation, Inc.
20764 Permission is granted to copy, distribute and/or modify this document
20765 under the terms of the GNU Free Documentation License, Version 1.3 or
20766 any later version published by the Free Software Foundation; with no
20767 Invariant Sections, with the Front-Cover Texts being "A GNU Manual,"
20768 and with the Back-Cover Texts as in (a) below. A copy of the license
20769 is included in the section entitled "GNU Free Documentation License."
20771 (a) The FSF's Back-Cover Text is: "You have the freedom to copy and
20772 modify this GNU manual."
20775 * Export Setup :noexport:
20777 #+subtitle: Release {{{version}}}
20778 #+author: by Carsten Dominik
20779 #+subauthor: with contributions by Bastien Guerry, Nicolas Goaziou, Eric Schulte, Jambunathan K, Dan Davison, Thomas Dye, David O'Toole, and Philip Rooke.
20780 #+date: {{{modification-time}}}
20783 # XXX: We cannot use TODO keyword as a node starts with "TODO".
20784 #+todo: REVIEW FIXME | DONE
20785 #+property: header-args :eval no
20786 #+startup: overview nologdone
20788 #+export_file_name: org.texi
20790 #+texinfo_dir_category: Emacs editing modes
20791 #+texinfo_dir_title: Org Mode: (org)
20792 #+texinfo_dir_desc: Outline-based notes management and organizer
20794 # Use proper quote and backtick for code sections in PDF output
20795 # Cf. Texinfo manual 14.2
20796 #+texinfo_header: @set txicodequoteundirected
20797 #+texinfo_header: @set txicodequotebacktick
20800 #+texinfo_header: @set MAINTAINERSITE @uref{https://orgmode.org,maintainers webpage}
20801 #+texinfo_header: @set MAINTAINER Carsten Dominik
20802 #+texinfo_header: @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20803 #+texinfo_header: @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
20805 #+options: H:4 num:t toc:t author:t \n:nil ::t |:t ^:nil -:t f:t *:t <:t e:t ':t
20806 #+options: d:nil todo:nil pri:nil tags:not-in-toc stat:nil broken-links:mark
20807 #+select_tags: export
20808 #+exclude_tags: noexport
20810 #+macro: cite @@texinfo:@cite{@@$1@@texinfo:}@@
20811 #+macro: var @@texinfo:@var{@@$1@@texinfo:}@@
20813 # The "version" macro returns major.minor version number. This is
20814 # sufficient since bugfix releases are not expected to add features
20815 # and therefore imply manual modifications.
20816 #+macro: version (eval (mapconcat #'identity (cl-subseq (split-string (org-version) "\\.") 0 -1) "."))
20818 # The "kbd" macro turns KBD into @kbd{KBD}. Additionnally, it
20819 # encloses case-sensitive special keys (SPC, RET...) within @key{...}.
20820 #+macro: kbd (eval (let ((case-fold-search nil) (regexp (regexp-opt '("SPC" "RET" "LFD" "TAB" "BS" "ESC" "DELETE" "SHIFT" "Ctrl" "Meta" "Alt" "Cmd" "Super" "UP" "LEFT" "RIGHT" "DOWN") 'words))) (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (replace-regexp-in-string regexp "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t))))
20824 [fn:1] If you do not use Font Lock globally turn it on in Org buffer
20825 with ~(add-hook 'org-mode-hook 'turn-on-font-lock)~.
20827 [fn:2] Please consider subscribing to the mailing list in order to
20828 minimize the work the mailing list moderators have to do.
20830 [fn:3] See the variables ~org-special-ctrl-a/e~, ~org-special-ctrl-k~,
20831 and ~org-ctrl-k-protect-subtree~ to configure special behavior of
20832 {{{kbd(C-a)}}}, {{{kbd(C-e)}}}, and {{{kbd(C-k)}}} in headlines. Note
20833 also that clocking only works with headings indented less than 30
20836 [fn:4] See, however, the option ~org-cycle-emulate-tab~.
20838 [fn:5] The indirect buffer contains the entire buffer, but is narrowed
20839 to the current tree. Editing the indirect buffer also changes the
20840 original buffer, but without affecting visibility in that buffer. For
20841 more information about indirect buffers, see [[info:emacs:Indirect%20Buffers][GNU Emacs Manual]].
20843 [fn:6] When ~org-agenda-inhibit-startup~ is non-~nil~, Org does not
20844 honor the default visibility state when first opening a file for the
20845 agenda (see [[*Speeding Up Your Agendas]]).
20847 [fn:7] See also the variable ~org-show-context-detail~ to decide how
20848 much context is shown around each match.
20850 [fn:8] This depends on the option ~org-remove-highlights-with-change~.
20852 [fn:9] When using =*= as a bullet, lines must be indented so that they
20853 are not interpreted as headlines. Also, when you are hiding leading
20854 stars to get a clean outline view, plain list items starting with
20855 a star may be hard to distinguish from true headlines. In short: even
20856 though =*= is supported, it may be better to not use it for plain list
20859 [fn:10] You can filter out any of them by configuring
20860 ~org-plain-list-ordered-item-terminator~.
20862 [fn:11] You can also get =a.=, =A.=, =a)= and =A)= by configuring
20863 ~org-list-allow-alphabetical~. To minimize confusion with normal
20864 text, those are limited to one character only. Beyond that limit,
20865 bullets automatically become numbers.
20867 [fn:12] If there's a checkbox in the item, the cookie must be put
20868 /before/ the checkbox. If you have activated alphabetical lists, you
20869 can also use counters like =[@b]=.
20871 [fn:13] If you do not want the item to be split, customize the
20872 variable ~org-M-RET-may-split-line~.
20874 [fn:14] If you want to cycle around items that way, you may customize
20875 ~org-list-use-circular-motion~.
20877 [fn:15] See ~org-list-use-circular-motion~ for a cyclic behavior.
20879 [fn:16] Many desktops intercept {{{kbd(M-TAB)}}} to switch windows.
20880 Use {{{kbd(C-M-i)}}} or {{{kbd(ESC TAB)}}} instead.
20882 [fn:17] The corresponding in-buffer setting is: =#+STARTUP: fninline=
20883 or =#+STARTUP: nofninline=.
20885 [fn:18] The corresponding in-buffer options are =#+STARTUP: fnadjust=
20886 and =#+STARTUP: nofnadjust=.
20888 [fn:19] To insert a vertical bar into a table field, use =\vert= or,
20889 inside a word =abc\vert{}def=.
20891 [fn:20] Org understands references typed by the user as =B4=, but it
20892 does not use this syntax when offering a formula for editing. You can
20893 customize this behavior using the variable
20894 ~org-table-use-standard-references~.
20896 [fn:21] The computation time scales as O(N^2) because table
20897 {{{var(FOO)}}} is parsed for each field to be copied.
20899 [fn:22] The file =constants.el= can supply the values of constants in
20900 two different unit systems, =SI= and =cgs=. Which one is used depends
20901 on the value of the variable ~constants-unit-system~. You can use the
20902 =STARTUP= options =constSI= and =constcgs= to set this value for the
20905 [fn:23] The printf reformatting is limited in precision because the
20906 value passed to it is converted into an "integer" or "double". The
20907 "integer" is limited in size by truncating the signed value to 32
20908 bits. The "double" is limited in precision to 64 bits overall which
20909 leaves approximately 16 significant decimal digits.
20911 [fn:24] Such names must start with an alphabetic character and use
20912 only alphanumeric/underscore characters.
20914 [fn:25] To insert a link targeting a headline, in-buffer completion
20915 can be used. Just type a star followed by a few optional letters into
20916 the buffer and press {{{kbd(M-TAB)}}}. All headlines in the current
20917 buffer are offered as completions.
20919 [fn:26] When targeting a =NAME= keyword, =CAPTION= keyword is
20920 mandatory in order to get proper numbering (see [[*Images and Tables]]).
20922 [fn:27] The actual behavior of the search depends on the value of the
20923 variable ~org-link-search-must-match-exact-headline~. If its value is
20924 ~nil~, then a fuzzy text search is done. If it is ~t~, then only the
20925 exact headline is matched, ignoring spaces and statistic cookies. If
20926 the value is ~query-to-create~, then an exact headline is searched; if
20927 it is not found, then the user is queried to create it.
20929 [fn:28] If the headline contains a timestamp, it is removed from the
20930 link, which results in a wrong link---you should avoid putting
20931 a timestamp in the headline.
20933 [fn:29] The Org Id library must first be loaded, either through
20934 ~org-customize~, by enabling ~id~ in ~org-modules~, or by adding
20935 ~(require 'org-id)~ in your Emacs init file.
20937 [fn:30] Note that you do not have to use this command to insert
20938 a link. Links in Org are plain text, and you can type or paste them
20939 straight into the buffer. By using this command, the links are
20940 automatically enclosed in double brackets, and you will be asked for
20941 the optional descriptive text.
20943 [fn:31] After insertion of a stored link, the link will be removed
20944 from the list of stored links. To keep it in the list later use, use
20945 a triple {{{kbd(C-u)}}} prefix argument to {{{kbd(C-c C-l)}}}, or
20946 configure the option ~org-keep-stored-link-after-insertion~.
20948 [fn:32] This works if a function has been defined in the ~:complete~
20949 property of a link in ~org-link-parameters~.
20951 [fn:33] See the variable ~org-display-internal-link-with-indirect-buffer~.
20953 [fn:34] The variable ~org-startup-with-inline-images~ can be set
20954 within a buffer with the =STARTUP= options =inlineimages= and
20957 [fn:35] For backward compatibility, line numbers can also follow a
20960 [fn:36] Of course, you can make a document that contains only long
20961 lists of TODO items, but this is not required.
20963 [fn:37] Changing the variable ~org-todo-keywords~ only becomes
20964 effective after restarting Org mode in a buffer.
20966 [fn:38] This is also true for the {{{kbd(t)}}} command in the timeline
20967 and agenda buffers.
20969 [fn:39] All characters are allowed except =@=, =^= and =!=, which have
20970 a special meaning here.
20972 [fn:40] Check also the variable ~org-fast-tag-selection-include-todo~,
20973 it allows you to change the TODO state through the tags interface
20974 ([[*Setting Tags]]), in case you like to mingle the two concepts. Note
20975 that this means you need to come up with unique keys across both sets
20978 [fn:41] Org mode parses these lines only when Org mode is activated
20979 after visiting a file. {{{kbd(C-c C-c)}}} with the cursor in a line
20980 starting with =#+= is simply restarting Org mode for the current
20983 [fn:42] The corresponding in-buffer setting is: =#+STARTUP: logdone=.
20985 [fn:43] The corresponding in-buffer setting is: =#+STARTUP:
20988 [fn:44] See the variable ~org-log-states-order-reversed~.
20990 [fn:45] Note that the =LOGBOOK= drawer is unfolded when pressing
20991 {{{kbd(SPC)}}} in the agenda to show an entry---use {{{kbd(C-u
20992 SPC)}}} to keep it folded here.
20994 [fn:46] It is possible that Org mode records two timestamps when you
20995 are using both ~org-log-done~ and state change logging. However, it
20996 never prompts for two notes: if you have configured both, the state
20997 change recording note takes precedence and cancel the closing note.
20999 [fn:47] See also the option ~org-priority-start-cycle-with-default~.
21001 [fn:48] To keep subtasks out of the global TODO list, see the
21002 ~org-agenda-todo-list-sublevels~.
21004 [fn:49] With the exception of description lists. But you can allow it
21005 by modifying ~org-list-automatic-rules~ accordingly.
21007 [fn:50] Set the variable ~org-hierarchical-checkbox-statistics~ if you
21008 want such cookies to count all checkboxes below the cookie, not just
21009 those belonging to direct children.
21011 [fn:51] {{{kbd(C-u C-c C-c)}}} on the /first/ item of a list with no
21012 checkbox adds checkboxes to the rest of the list.
21014 [fn:52] As with all these in-buffer settings, pressing {{{kbd(C-c
21015 C-c)}}} activates any changes in the line.
21017 [fn:53] This is only true if the search does not involve more complex
21018 tests including properties (see [[*Property Searches]]).
21020 [fn:54] To extend this default list to all tags used in all agenda
21021 files (see [[*Agenda Views]]), customize the variable
21022 ~org-complete-tags-always-offer-all-agenda-tags~.
21024 [fn:55] Keys are automatically assigned to tags that have no
21027 [fn:56] If more than one summary type applies to the same property,
21028 the parent values are computed according to the first of them.
21030 [fn:57] An age is defined as a duration, using effort modifiers
21031 defined in ~org-effort-durations~, e.g., =3d 1h=. If any value in the
21032 column is as such, the summary is also an effort duration.
21034 [fn:58] Please note that the =COLUMNS= definition must be on a single
21035 line; it is wrapped here only because of formatting constraints.
21037 [fn:59] Contributed packages are not part of Emacs, but are
21038 distributed with the main distribution of Org---visit
21039 [[https://orgmode.org]].
21041 [fn:60] The Org date format is inspired by the standard ISO 8601
21042 date/time format. To use an alternative format, see [[*Custom time
21043 format]]. The day name is optional when you type the date yourself.
21044 However, any date inserted or modified by Org adds that day name, for
21045 reading convenience.
21047 [fn:61] When working with the standard diary sexp functions, you need
21048 to be very careful with the order of the arguments. That order
21049 depends evilly on the variable ~calendar-date-style~. For example, to
21050 specify a date December 12, 2005, the call might look like
21051 =(diary-date 12 1 2005)= or =(diary-date 1 12 2005)= or =(diary-date
21052 2005 12 1)=, depending on the settings. This has been the source of
21053 much confusion. Org mode users can resort to special versions of
21054 these functions like ~org-date~ or ~org-anniversary~. These work just
21055 like the corresponding ~diary-~ functions, but with stable ISO order
21056 of arguments (year, month, day) wherever applicable, independent of
21057 the value of ~calendar-date-style~.
21059 [fn:62] See the variable ~org-read-date-prefer-future~. You may set
21060 that variable to the symbol ~time~ to even make a time before now
21061 shift the date to tomorrow.
21063 [fn:63] If you do not need/want the calendar, configure the variable
21064 ~org-popup-calendar-for-date-prompt~.
21066 [fn:64] If you find this distracting, turn off the display with
21067 ~org-read-date-display-live~.
21069 [fn:65] It will still be listed on that date after it has been marked
21070 DONE. If you do not like this, set the variable
21071 ~org-agenda-skip-scheduled-if-done~.
21073 [fn:66] The =SCHEDULED= and =DEADLINE= dates are inserted on the line
21074 right below the headline. Do not put any text between this line and
21077 [fn:67] Note the corresponding =STARTUP= options =logredeadline=,
21078 =lognoteredeadline=, and =nologredeadline=.
21080 [fn:68] Note the corresponding =STARTUP= options =logreschedule=,
21081 =lognotereschedule=, and =nologreschedule=.
21083 [fn:69] In fact, the target state is taken from, in this sequence, the
21084 =REPEAT_TO_STATE= property, the variable ~org-todo-repeat-to-state~ if
21085 it is a string, the previous TODO state if ~org-todo-repeat-to-state~
21086 is ~t~, or the first state of the TODO state sequence.
21088 [fn:70] You can change this using the option ~org-log-repeat~, or the
21089 =STARTUP= options =logrepeat=, =lognoterepeat=, and =nologrepeat=.
21090 With =lognoterepeat=, you will also be prompted for a note.
21092 [fn:71] Clocking only works if all headings are indented with less
21093 than 30 stars. This is a hard-coded limitation of ~lmax~ in
21096 [fn:72] To resume the clock under the assumption that you have worked
21097 on this task while outside Emacs, use ~(setq org-clock-persist t)~.
21099 [fn:73] To add an effort estimate "on the fly", hook a function doing
21100 this to ~org-clock-in-prepare-hook~.
21102 [fn:74] The last reset of the task is recorded by the =LAST_REPEAT=
21105 [fn:75] See also the variable ~org-clock-mode-line-total~.
21107 [fn:76] The corresponding in-buffer setting is: =#+STARTUP:
21110 [fn:77] Language terms can be set through the variable
21111 ~org-clock-clocktable-language-setup~.
21113 [fn:78] Note that all parameters must be specified in a single
21114 line---the line is broken here only to fit it into the manual.
21116 [fn:79] On computers using macOS, idleness is based on actual user
21117 idleness, not just Emacs' idle time. For X11, you can install
21118 a utility program =x11idle.c=, available in the =contrib/scripts/=
21119 directory of the Org Git distribution, or install the xprintidle
21120 package and set it to the variable ~org-clock-x11idle-program-name~ if
21121 you are running Debian, to get the same general treatment of idleness.
21122 On other systems, idle time refers to Emacs idle time only.
21124 [fn:80] Please note the pitfalls of summing hierarchical data in
21125 a flat list ([[*Using Column View in the Agenda]]).
21127 [fn:81] Org used to offer four different targets for date/week tree
21128 capture. Now, Org automatically translates these to use
21129 ~file+olp+datetree~, applying the ~:time-prompt~ and ~:tree-type~
21130 properties. Please rewrite your date/week-tree targets using
21131 ~file+olp+datetree~ since the older targets are now deprecated.
21133 [fn:82] A date tree is an outline structure with years on the highest
21134 level, months or ISO weeks as sublevels and then dates on the lowest
21135 level. Tags are allowed in the tree structure.
21137 [fn:83] If you need one of these sequences literally, escape the =%=
21140 [fn:84] If you define your own link types (see [[*Adding Hyperlink
21141 Types]]), any property you store with ~org-store-link-props~ can be
21142 accessed in capture templates in a similar way.
21144 [fn:85] This is always the other, not the user. See the variable
21145 ~org-from-is-user-regexp~.
21147 [fn:86] If you move entries or Org files from one directory to
21148 another, you may want to configure ~org-attach-directory~ to contain
21151 [fn:87] Note the corresponding =STARTUP= options =logrefile=,
21152 =lognoterefile=, and =nologrefile=.
21154 [fn:88] If the value of that variable is not a list, but a single file
21155 name, then the list of agenda files in maintained in that external
21158 [fn:89] When using the dispatcher, pressing {{{kbd(<)}}} before
21159 selecting a command actually limits the command to the current file,
21160 and ignores ~org-agenda-files~ until the next dispatcher command.
21162 [fn:90] For backward compatibility, you can also press {{{kbd(1)}}} to
21163 restrict to the current buffer.
21165 [fn:91] For backward compatibility, you can also press {{{kbd(0)}}} to
21166 restrict to the current region/subtree.
21168 [fn:92] For backward compatibility, the universal prefix argument
21169 {{{kbd(C-u)}}} causes all TODO entries to be listed before the agenda.
21170 This feature is deprecated, use the dedicated TODO list, or a block
21171 agenda instead (see [[*Block agenda]]).
21173 [fn:93] The variable ~org-anniversary~ used in the example is just
21174 like ~diary-anniversary~, but the argument order is always according
21175 to ISO and therefore independent of the value of
21176 ~calendar-date-style~.
21178 [fn:94] You can, however, disable this by setting
21179 ~org-agenda-search-headline-for-time~ variable to a ~nil~ value.
21181 [fn:95] Custom commands can preset a filter by binding the variable
21182 ~org-agenda-tag-filter-preset~ as an option. This filter is then
21183 applied to the view and persists as a basic filter through refreshes
21184 and more secondary filtering. The filter is a global property of the
21185 entire agenda view---in a block agenda, you should only set this in
21186 the global options section, not in the section of an individual block.
21188 [fn:96] Only tags filtering is respected here, effort filtering is
21191 [fn:97] You can also create persistent custom functions through
21192 ~org-agenda-bulk-custom-functions~.
21194 [fn:98] This file is parsed for the agenda when
21195 ~org-agenda-include-diary~ is set.
21197 [fn:99] You can provide a description for a prefix key by inserting
21198 a cons cell with the prefix and the description.
21200 [fn:100] /Planned/ means here that these entries have some planning
21201 information attached to them, like a time-stamp, a scheduled or
21202 a deadline string. See ~org-agenda-entry-types~ on how to set what
21203 planning information is taken into account.
21205 [fn:101] For HTML you need to install Hrvoje Niksic's =htmlize.el=
21206 from [[https://github.com/hniksic/emacs-htmlize][Hrvoje Niksic's repository]].
21208 [fn:102] To create PDF output, the Ghostscript ps2pdf utility must be
21209 installed on the system. Selecting a PDF file also creates the
21212 [fn:103] If you want to store standard views like the weekly agenda or
21213 the global TODO list as well, you need to define custom commands for
21214 them in order to be able to specify file names.
21216 [fn:104] Quoting depends on the system you use, please check the FAQ
21219 [fn:105] This works automatically for the HTML backend (it requires
21220 version 1.34 of the =htmlize.el= package, which you need to install).
21221 Fontified code chunks in LaTeX can be achieved using either the
21222 listings package or the [[https://github.com/gpoore/minted][minted]] package. Refer to
21223 ~org-export-latex-listings~ for details.
21225 [fn:106] Source code in code blocks may also be evaluated either
21226 interactively or on export. See [[*Working with Source Code]] for more
21227 information on evaluating code blocks.
21229 [fn:107] Adding =-k= to =-n -r= /keeps/ the labels in the source code
21230 while using line numbers for the links, which might be useful to
21231 explain those in an Org mode example code.
21233 [fn:108] Upon exit, lines starting with =*=, =,*=, =#+= and =,#+= get
21234 a comma prepended, to keep them from being interpreted by Org as
21235 outline nodes or special syntax. These commas are stripped when
21236 editing with {{{kbd(C-c ')}}}, and also before export.
21238 [fn:109] You may select a different-mode with the variable
21239 ~org-edit-fixed-width-region-mode~.
21241 [fn:110] You can turn this on by default by setting the variable
21242 ~org-pretty-entities~, or on a per-file base with the =STARTUP= option
21245 [fn:111] This behavior can be disabled with =-= export setting (see
21246 [[*Export Settings]]).
21248 [fn:112] LaTeX is a macro system based on Donald\nbsp{}E.\nbsp{}Knuth's TeX
21249 system. Many of the features described here as "LaTeX" are really
21250 from TeX, but for simplicity I am blurring this distinction.
21252 [fn:113] When MathJax is used, only the environments recognized by
21253 MathJax are processed. When dvipng, dvisvgm, or ImageMagick suite is
21254 used to create images, any LaTeX environment is handled.
21256 [fn:114] These are respectively available at
21257 [[http://sourceforge.net/projects/dvipng/]], [[http://dvisvgm.bplaced.net/]]
21258 and from the ImageMagick suite. Choose the converter by setting the
21259 variable ~org-preview-latex-default-process~ accordingly.
21261 [fn:115] Org mode has a method to test if the cursor is inside such
21262 a fragment, see the documentation of the function
21263 ~org-inside-LaTeX-fragment-p~.
21265 [fn:116] The variable ~org-export-date-timestamp-format~ defines how
21266 this timestamp are exported.
21268 [fn:117] At the moment, some export back-ends do not obey this
21269 specification. For example, LaTeX export excludes every unnumbered
21270 headline from the table of contents.
21272 [fn:118] Since commas separate the arguments, commas within arguments
21273 have to be escaped with the backslash character. So only those
21274 backslash characters before a comma need escaping with another
21275 backslash character.
21277 [fn:119] For a less drastic behavior, consider using a select tag (see
21278 [[*Export Settings]]) instead.
21280 [fn:120] If =BEAMER_ENV= is set, Org export adds =B_environment= tag
21281 to make it visible. The tag serves as a visual aid and has no
21282 semantic relevance.
21284 [fn:121] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by
21285 [[http://www.mathjax.org][MathJax]].
21287 [fn:122] 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
21290 [fn:123] If the classes on TODO keywords and tags lead to conflicts,
21291 use the variables ~org-html-todo-kwd-class-prefix~ and
21292 ~org-html-tag-class-prefix~ to make them unique.
21294 [fn:124] This does not allow setting different bibliography compilers
21295 for different files. However, "smart" LaTeX compilation systems, such
21296 as latexmk, can select the correct bibliography compiler.
21298 [fn:125] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications
21299 (OpenDocument) Version 1.2]].
21301 [fn:126] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]].
21303 [fn:127] See [[http://dlmf.nist.gov/LaTeXML/]].
21305 [fn:128] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]]
21307 [fn:129] See the =<table:table-template>= element of the
21308 OpenDocument-v1.2 specification.
21310 [fn:130] See the attributes =table:template-name=,
21311 =table:use-first-row-styles=, =table:use-last-row-styles=,
21312 =table:use-first-column-styles=, =table:use-last-column-styles=,
21313 =table:use-banding-rows-styles=, and =table:use-banding-column-styles=
21314 of the =<table:table>= element in the OpenDocument-v1.2 specification.
21316 [fn:131] If the publishing directory is the same as the source
21317 directory, =file.org= is exported as =file.org.org=, so you probably
21318 do not want to do this.
21320 [fn:132] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used
21321 to remove code evaluation from the {{{kbd(C-c C-c)}}} key binding.
21323 [fn:133] Actually, the constructs =call_<name>()= and =src_<lang>{}=
21324 are not evaluated when they appear in a keyword line---i.e. lines
21325 starting with =#+KEYWORD:=, see [[*Summary of In-Buffer Settings]].
21327 [fn:134] For Noweb literate programming details, see
21328 http://www.cs.tufts.edu/~nr/noweb/.
21330 [fn:135] For more information, please refer to the commentary section
21333 [fn:136] Note that ~org-indent-mode~ also sets the ~wrap-prefix~
21334 property, such that ~visual-line-mode~ (or purely setting ~word-wrap~)
21335 wraps long lines (including headlines) correctly indented.
21337 [fn:137] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly
21338 for indenting and wrapping long lines of headlines or text. This
21339 minor mode handles ~visual-line-mode~ and directly applied settings
21340 through ~word-wrap~.
21342 [fn:138] Also see the variable ~org-adapt-indentation~.
21344 [fn:139] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 4 stars, and so
21347 [fn:140] https://ctan.org/tex-archive/macros/latex/contrib/comment?lang=en
21349 [fn:141] If the =TBLFM= keyword contains an odd number of dollar
21350 characters, this may cause problems with Font Lock in LaTeX mode. As
21351 shown in the example you can fix this by adding an extra line inside
21352 the =comment= environment that is used to balance the dollar
21353 expressions. If you are using AUCTeX with the font-latex library,
21354 a much better solution is to add the =comment= environment to the
21355 variable ~LaTeX-verbatim-environments~.
21357 [fn:142] The ~agenda*~ view is the same as ~agenda~ except that it
21358 only considers /appointments/, i.e., scheduled and deadline items that
21359 have a time specification =[h]h:mm= in their time-stamps.
21361 [fn:143] Note that, for ~org-odd-levels-only~, a level number
21362 corresponds to order in the hierarchy, not to the number of stars.
21364 [fn:144] If Emacs is configured for safe storing of passwords, then
21365 configure the variable, ~org-mobile-encryption-password~; please read
21366 the docstring of that variable.
21368 [fn:145] An alternative is to use a WebDAV server. MobileOrg
21369 documentation has details of WebDAV server configuration. Additional
21370 help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]].
21372 [fn:146] Symbolic links in ~org-directory~ need to have the same name
21375 [fn:147] While creating the agendas, Org mode forces ID properties on
21376 all referenced entries, so that these entries can be uniquely
21377 identified if MobileOrg flags them for further action. To avoid
21378 setting properties configure the variable
21379 ~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode then relies
21380 on outline paths, assuming they are unique.
21382 [fn:148] Checksums are stored automatically in the file
21385 [fn:149] The file will be empty after this operation.
21387 [fn:150] Due to the way this header arg is implemented, it implies
21388 “:results file”. Therefore if it is set for multiple blocks at once
21389 (by a subtree or buffer property for example), all blocks will be forced
21390 to produce file results. This is seldom desired behavior, so it is
21391 recommended to set this header only on a per-block basis. It is possible
21392 that this aspect of the implementation might change in the future.
21395 * Local variables :noexport:
21398 # org-footnote-section: "Footnotes"
21399 # org-footnote-define-inline: nil
21400 # org-footnote-auto-label: t