3 @setfilename ../../info/org
4 @settitle The Org Manual
6 @include org-version.inc
8 @c Use proper quote and backtick for code sections in PDF output
9 @c Cf. Texinfo manual 14.2
10 @set txicodequoteundirected
11 @set txicodequotebacktick
13 @c Version and Contact Info
14 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page}
15 @set AUTHOR Carsten Dominik
16 @set MAINTAINER Carsten Dominik
17 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
18 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
23 @c -----------------------------------------------------------------------------
25 @c Macro definitions for commands and keys
26 @c =======================================
28 @c The behavior of the key/command macros will depend on the flag cmdnames
29 @c When set, commands names are shown. When clear, they are not shown.
33 @c Below we define the following macros for Org key tables:
35 @c orgkey{key} A key item
36 @c orgcmd{key,cmd} Key with command name
37 @c xorgcmd{key,cmd} Key with command name as @itemx
38 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
39 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
40 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
41 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
42 @c different functions, so format as @itemx
43 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
44 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
45 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
47 @c a key but no command
59 @c one key with a command
60 @c Inserts: @item KEY COMMAND
61 @macro orgcmd{key,command}
66 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
69 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
78 @c One key with one command, formatted using @itemx
79 @c Inserts: @itemx KEY COMMAND
80 @macro xorgcmd{key,command}
85 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
88 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
97 @c one key with a command, bit do not index the key
98 @c Inserts: @item KEY COMMAND
99 @macro orgcmdnki{key,command}
103 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
106 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
114 @c one key with a command, and special text to replace key in item
115 @c Inserts: @item TEXT COMMAND
116 @macro orgcmdtkc{text,key,command}
121 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
124 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
133 @c two keys with one command
134 @c Inserts: @item KEY1 or KEY2 COMMAND
135 @macro orgcmdkkc{key1,key2,command}
141 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
144 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
150 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
154 @c Two keys with one command name, but different functions, so format as
156 @c Inserts: @item KEY1
157 @c @itemx KEY2 COMMAND
158 @macro orgcmdkxkc{key1,key2,command}
165 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
169 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
180 @c Same as previous, but use "or short"
181 @c Inserts: @item KEY1 or short KEY2 COMMAND
182 @macro orgcmdkskc{key1,key2,command}
188 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
191 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
197 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
201 @c Same as previous, but use @itemx
202 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
203 @macro xorgcmdkskc{key1,key2,command}
209 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
212 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
218 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
222 @c two keys with two commands
223 @c Inserts: @item KEY1 COMMAND1
224 @c @itemx KEY2 COMMAND2
225 @macro orgcmdkkcc{key1,key2,command1,command2}
232 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
233 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
236 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
237 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
247 @c -----------------------------------------------------------------------------
250 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
253 @c Subheadings inside a table.
254 @macro tsubheading{text}
256 @subsubheading \text\
264 This manual is for Org version @value{VERSION}.
266 Copyright @copyright{} 2004--2013 Free Software Foundation, Inc.
269 Permission is granted to copy, distribute and/or modify this document
270 under the terms of the GNU Free Documentation License, Version 1.3 or
271 any later version published by the Free Software Foundation; with no
272 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
273 and with the Back-Cover Texts as in (a) below. A copy of the license
274 is included in the section entitled ``GNU Free Documentation License.''
276 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
277 modify this GNU manual.''
281 @dircategory Emacs editing modes
283 * Org Mode: (org). Outline-based notes management and organizer
287 @title The Org Manual
289 @subtitle Release @value{VERSION}
290 @author by Carsten Dominik
291 with contributions by Bastien Guerry, Nicolas Goaziou, Eric Schulte,
292 Jambunathan K, Dan Davison, Thomas Dye, David O'Toole, and Philip Rooke.
294 @c The following two commands start the copyright page.
296 @vskip 0pt plus 1filll
300 @c Output the short table of contents at the beginning.
303 @c Output the table of contents at the beginning.
307 @c FIXME These hand-written next,prev,up node pointers make editing a lot
308 @c harder. There should be no need for them, makeinfo can do it
309 @c automatically for any document with a normal structure.
310 @node Top, Introduction, (dir), (dir)
317 * Introduction:: Getting started
318 * Document structure:: A tree works like your brain
319 * Tables:: Pure magic for quick formatting
320 * Hyperlinks:: Notes in context
321 * TODO items:: Every tree branch can be a TODO item
322 * Tags:: Tagging headlines and matching sets of tags
323 * Properties and columns:: Storing information about an entry
324 * Dates and times:: Making items useful for planning
325 * Capture - Refile - Archive:: The ins and outs for projects
326 * Agenda views:: Collecting information into views
327 * Markup:: Prepare text for rich export
328 * Exporting:: Sharing and publishing notes
329 * Publishing:: Create a web site of linked Org files
330 * Working with source code:: Export, evaluate, and tangle code blocks
331 * Miscellaneous:: All the rest which did not fit elsewhere
332 * Hacking:: How to hack your way around
333 * MobileOrg:: Viewing and capture on a mobile device
334 * History and acknowledgments:: How Org came into being
335 * GNU Free Documentation License:: The license for this documentation.
336 * Main Index:: An index of Org's concepts and features
337 * Key Index:: Key bindings and where they are described
338 * Command and Function Index:: Command names and some internal functions
339 * Variable Index:: Variables mentioned in the manual
342 --- The Detailed Node Listing ---
346 * Summary:: Brief summary of what Org does
347 * Installation:: Installing Org
348 * Activation:: How to activate Org for certain buffers
349 * Feedback:: Bug reports, ideas, patches etc.
350 * Conventions:: Typesetting conventions in the manual
354 * Outlines:: Org is based on Outline mode
355 * Headlines:: How to typeset Org tree headlines
356 * Visibility cycling:: Show and hide, much simplified
357 * Motion:: Jumping to other headlines
358 * Structure editing:: Changing sequence and level of headlines
359 * Sparse trees:: Matches embedded in context
360 * Plain lists:: Additional structure within an entry
361 * Drawers:: Tucking stuff away
362 * Blocks:: Folding blocks
363 * Footnotes:: How footnotes are defined in Org's syntax
364 * Orgstruct mode:: Structure editing outside Org
365 * Org syntax:: Formal description of Org's syntax
369 * Global and local cycling:: Cycling through various visibility states
370 * Initial visibility:: Setting the initial visibility state
371 * Catching invisible edits:: Preventing mistakes when editing invisible parts
373 Global and local cycling
375 * Initial visibility:: Setting the initial visibility state
376 * Catching invisible edits:: Preventing mistakes when editing invisible parts
380 * Built-in table editor:: Simple tables
381 * Column width and alignment:: Overrule the automatic settings
382 * Column groups:: Grouping to trigger vertical lines
383 * Orgtbl mode:: The table editor as minor mode
384 * The spreadsheet:: The table editor has spreadsheet capabilities
385 * Org-Plot:: Plotting from org tables
389 * References:: How to refer to another field or range
390 * Formula syntax for Calc:: Using Calc to compute stuff
391 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
392 * Durations and time values:: How to compute durations and time values
393 * Field and range formulas:: Formula for specific (ranges of) fields
394 * Column formulas:: Formulas valid for an entire column
395 * Lookup functions:: Lookup functions for searching tables
396 * Editing and debugging formulas:: Fixing formulas
397 * Updating the table:: Recomputing all dependent fields
398 * Advanced features:: Field and column names, parameters and automatic recalc
402 * Link format:: How links in Org are formatted
403 * Internal links:: Links to other places in the current file
404 * External links:: URL-like links to the world
405 * Handling links:: Creating, inserting and following
406 * Using links outside Org:: Linking from my C source code?
407 * Link abbreviations:: Shortcuts for writing complex links
408 * Search options:: Linking to a specific location
409 * Custom searches:: When the default search is not enough
413 * Radio targets:: Make targets trigger links in plain text
417 * TODO basics:: Marking and displaying TODO entries
418 * TODO extensions:: Workflow and assignments
419 * Progress logging:: Dates and notes for progress
420 * Priorities:: Some things are more important than others
421 * Breaking down tasks:: Splitting a task into manageable pieces
422 * Checkboxes:: Tick-off lists
424 Extended use of TODO keywords
426 * Workflow states:: From TODO to DONE in steps
427 * TODO types:: I do this, Fred does the rest
428 * Multiple sets in one file:: Mixing it all, and still finding your way
429 * Fast access to TODO states:: Single letter selection of a state
430 * Per-file keywords:: Different files, different requirements
431 * Faces for TODO keywords:: Highlighting states
432 * TODO dependencies:: When one task needs to wait for others
436 * Closing items:: When was this entry marked DONE?
437 * Tracking TODO state changes:: When did the status change?
438 * Tracking your habits:: How consistent have you been?
442 * Tag inheritance:: Tags use the tree structure of the outline
443 * Setting tags:: How to assign tags to a headline
444 * Tag groups:: Use one tag to search for several tags
445 * Tag searches:: Searching for combinations of tags
447 Properties and columns
449 * Property syntax:: How properties are spelled out
450 * Special properties:: Access to other Org mode features
451 * Property searches:: Matching property values
452 * Property inheritance:: Passing values down the tree
453 * Column view:: Tabular viewing and editing
454 * Property API:: Properties for Lisp programmers
458 * Defining columns:: The COLUMNS format property
459 * Using column view:: How to create and use column view
460 * Capturing column view:: A dynamic block for column view
464 * Scope of column definitions:: Where defined, where valid?
465 * Column attributes:: Appearance and content of a column
469 * Timestamps:: Assigning a time to a tree entry
470 * Creating timestamps:: Commands which insert timestamps
471 * Deadlines and scheduling:: Planning your work
472 * Clocking work time:: Tracking how long you spend on a task
473 * Effort estimates:: Planning work effort in advance
474 * Relative timer:: Notes with a running timer
475 * Countdown timer:: Starting a countdown timer for a task
479 * The date/time prompt:: How Org mode helps you entering date and time
480 * Custom time format:: Making dates look different
482 Deadlines and scheduling
484 * Inserting deadline/schedule:: Planning items
485 * Repeated tasks:: Items that show up again and again
489 * Clocking commands:: Starting and stopping a clock
490 * The clock table:: Detailed reports
491 * Resolving idle time:: Resolving time when you've been idle
493 Capture - Refile - Archive
495 * Capture:: Capturing new stuff
496 * Attachments:: Add files to tasks
497 * RSS feeds:: Getting input from RSS feeds
498 * Protocols:: External (e.g., Browser) access to Emacs and Org
499 * Refile and copy:: Moving/copying a tree from one place to another
500 * Archiving:: What to do with finished projects
504 * Setting up capture:: Where notes will be stored
505 * Using capture:: Commands to invoke and terminate capture
506 * Capture templates:: Define the outline of different note types
510 * Template elements:: What is needed for a complete template entry
511 * Template expansion:: Filling in information about time and context
512 * Templates in contexts:: Only show a template in a specific context
516 * Moving subtrees:: Moving a tree to an archive file
517 * Internal archiving:: Switch off a tree but keep it in the file
521 * Agenda files:: Files being searched for agenda information
522 * Agenda dispatcher:: Keyboard access to agenda views
523 * Built-in agenda views:: What is available out of the box?
524 * Presentation and sorting:: How agenda items are prepared for display
525 * Agenda commands:: Remote editing of Org trees
526 * Custom agenda views:: Defining special searches and views
527 * Exporting agenda views:: Writing a view to a file
528 * Agenda column view:: Using column view for collected entries
530 The built-in agenda views
532 * Weekly/daily agenda:: The calendar page with current tasks
533 * Global TODO list:: All unfinished action items
534 * Matching tags and properties:: Structured information with fine-tuned search
535 * Timeline:: Time-sorted view for single file
536 * Search view:: Find entries by searching for text
537 * Stuck projects:: Find projects you need to review
539 Presentation and sorting
541 * Categories:: Not all tasks are equal
542 * Time-of-day specifications:: How the agenda knows the time
543 * Sorting agenda items:: The order of things
544 * Filtering/limiting agenda items:: Dynamically narrow the agenda
548 * Storing searches:: Type once, use often
549 * Block agenda:: All the stuff you need in a single buffer
550 * Setting options:: Changing the rules
552 Markup for rich export
554 * Structural markup elements:: The basic structure as seen by the exporter
555 * Images and tables:: Images, tables and caption mechanism
556 * Literal examples:: Source code examples with special formatting
557 * Include files:: Include additional files into a document
558 * Index entries:: Making an index
559 * Macro replacement:: Use macros to create templates
560 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
561 * Special blocks:: Containers targeted at export back-ends
563 Structural markup elements
565 * Document title:: Where the title is taken from
566 * Headings and sections:: The document structure as seen by the exporter
567 * Table of contents:: The if and where of the table of contents
569 * Paragraphs:: Paragraphs
570 * Footnote markup:: Footnotes
571 * Emphasis and monospace:: Bold, italic, etc.
572 * Horizontal rules:: Make a line
573 * Comment lines:: What will *not* be exported
577 * Special symbols:: Greek letters and other symbols
578 * Subscripts and superscripts:: Simple syntax for raising/lowering text
579 * @LaTeX{} fragments:: Complex formulas made easy
580 * Previewing @LaTeX{} fragments:: What will this snippet look like?
581 * CDLaTeX mode:: Speed up entering of formulas
585 * The export dispatcher:: The main exporter interface
586 * Export back-ends:: Built-in export formats
587 * Export settings:: Generic export settings
588 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
589 * Beamer export:: Exporting as a Beamer presentation
590 * HTML export:: Exporting to HTML
591 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
592 * Markdown export:: Exporting to Markdown
593 * OpenDocument text export:: Exporting to OpenDocument Text
594 * iCalendar export:: Exporting to iCalendar
595 * Other built-in back-ends:: Exporting to @code{Texinfo}, a man page, or Org
596 * Export in foreign buffers:: Author tables in lists in Org syntax
597 * Advanced configuration:: Fine-tuning the export output
601 * HTML Export commands:: How to invoke HTML export
602 * HTML doctypes:: Org can export to various (X)HTML flavors
603 * HTML preamble and postamble:: How to insert a preamble and a postamble
604 * Quoting HTML tags:: Using direct HTML in Org mode
605 * Links in HTML export:: How links will be interpreted and formatted
606 * Tables in HTML export:: How to modify the formatting of tables
607 * Images in HTML export:: How to insert figures into HTML output
608 * Math formatting in HTML export:: Beautiful math also on the web
609 * Text areas in HTML export:: An alternative way to show an example
610 * CSS support:: Changing the appearance of the output
611 * JavaScript support:: Info and Folding in a web browser
613 @LaTeX{} and PDF export
615 * @LaTeX{} export commands:: How to export to LaTeX and PDF
616 * Header and sectioning:: Setting up the export file structure
617 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
618 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
620 OpenDocument text export
622 * Pre-requisites for ODT export:: What packages ODT exporter relies on
623 * ODT export commands:: How to invoke ODT export
624 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
625 * Applying custom styles:: How to apply custom styles to the output
626 * Links in ODT export:: How links will be interpreted and formatted
627 * Tables in ODT export:: How Tables are exported
628 * Images in ODT export:: How to insert images
629 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
630 * Labels and captions in ODT export:: How captions are rendered
631 * Literal examples in ODT export:: How source and example blocks are formatted
632 * Advanced topics in ODT export:: Read this if you are a power user
634 Math formatting in ODT export
636 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
637 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
639 Advanced topics in ODT export
641 * Configuring a document converter:: How to register a document converter
642 * Working with OpenDocument style files:: Explore the internals
643 * Creating one-off styles:: How to produce custom highlighting etc
644 * Customizing tables in ODT export:: How to define and use Table templates
645 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
649 * Configuration:: Defining projects
650 * Uploading files:: How to get files up on the server
651 * Sample configuration:: Example projects
652 * Triggering publication:: Publication commands
656 * Project alist:: The central configuration variable
657 * Sources and destinations:: From here to there
658 * Selecting files:: What files are part of the project?
659 * Publishing action:: Setting the function doing the publishing
660 * Publishing options:: Tweaking HTML/@LaTeX{} export
661 * Publishing links:: Which links keep working after publishing?
662 * Sitemap:: Generating a list of all pages
663 * Generating an index:: An index that reaches across pages
667 * Simple example:: One-component publishing
668 * Complex example:: A multi-component publishing example
670 Working with source code
672 * Structure of code blocks:: Code block syntax described
673 * Editing source code:: Language major-mode editing
674 * Exporting code blocks:: Export contents and/or results
675 * Extracting source code:: Create pure source code files
676 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
677 * Library of Babel:: Use and contribute to a library of useful code blocks
678 * Languages:: List of supported code block languages
679 * Header arguments:: Configure code block functionality
680 * Results of evaluation:: How evaluation results are handled
681 * Noweb reference syntax:: Literate programming in Org mode
682 * Key bindings and useful functions:: Work quickly with code blocks
683 * Batch execution:: Call functions from the command line
687 * Using header arguments:: Different ways to set header arguments
688 * Specific header arguments:: List of header arguments
690 Using header arguments
692 * System-wide header arguments:: Set global default values
693 * Language-specific header arguments:: Set default values by language
694 * Header arguments in Org mode properties:: Set default values for a buffer or heading
695 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
696 * Code block specific header arguments:: The most common way to set values
697 * Header arguments in function calls:: The most specific level
699 Specific header arguments
701 * var:: Pass arguments to code blocks
702 * Results:: Specify the type of results and how they will
703 be collected and handled
704 * file:: Specify a path for file output
705 * file-desc:: Specify a description for file results
706 * dir:: Specify the default (possibly remote)
707 directory for code block execution
708 * exports:: Export code and/or results
709 * tangle:: Toggle tangling and specify file name
710 * mkdirp:: Toggle creation of parent directories of target
711 files during tangling
712 * comments:: Toggle insertion of comments in tangled
714 * padline:: Control insertion of padding lines in tangled
716 * no-expand:: Turn off variable assignment and noweb
717 expansion during tangling
718 * session:: Preserve the state of code evaluation
719 * noweb:: Toggle expansion of noweb references
720 * noweb-ref:: Specify block's noweb reference resolution target
721 * noweb-sep:: String used to separate noweb references
722 * cache:: Avoid re-evaluating unchanged code blocks
723 * sep:: Delimiter for writing tabular results outside Org
724 * hlines:: Handle horizontal lines in tables
725 * colnames:: Handle column names in tables
726 * rownames:: Handle row names in tables
727 * shebang:: Make tangled files executable
728 * tangle-mode:: Set permission of tangled files
729 * eval:: Limit evaluation of specific code blocks
730 * wrap:: Mark source block evaluation results
731 * post:: Post processing of code block results
732 * prologue:: Text to prepend to code block body
733 * epilogue:: Text to append to code block body
737 * Completion:: M-TAB knows what you need
738 * Easy templates:: Quick insertion of structural elements
739 * Speed keys:: Electric commands at the beginning of a headline
740 * Code evaluation security:: Org mode files evaluate inline code
741 * Customization:: Adapting Org to your taste
742 * In-buffer settings:: Overview of the #+KEYWORDS
743 * The very busy C-c C-c key:: When in doubt, press C-c C-c
744 * Clean view:: Getting rid of leading stars in the outline
745 * TTY keys:: Using Org on a tty
746 * Interaction:: Other Emacs packages
747 * org-crypt:: Encrypting Org files
749 Interaction with other packages
751 * Cooperation:: Packages Org cooperates with
752 * Conflicts:: Packages that lead to conflicts
756 * Hooks:: How to reach into Org's internals
757 * Add-on packages:: Available extensions
758 * Adding hyperlink types:: New custom link types
759 * Adding export back-ends:: How to write new export back-ends
760 * Context-sensitive commands:: How to add functionality to such commands
761 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
762 * Dynamic blocks:: Automatically filled blocks
763 * Special agenda views:: Customized views
764 * Speeding up your agendas:: Tips on how to speed up your agendas
765 * Extracting agenda information:: Post-processing of agenda information
766 * Using the property API:: Writing programs that use entry properties
767 * Using the mapping API:: Mapping over all or selected entries
769 Tables and lists in arbitrary syntax
771 * Radio tables:: Sending and receiving radio tables
772 * A @LaTeX{} example:: Step by step, almost a tutorial
773 * Translator functions:: Copy and modify
774 * Radio lists:: Sending and receiving lists
778 * Setting up the staging area:: Where to interact with the mobile device
779 * Pushing to MobileOrg:: Uploading Org files and agendas
780 * Pulling from MobileOrg:: Integrating captured and flagged items
786 @chapter Introduction
790 * Summary:: Brief summary of what Org does
791 * Installation:: Installing Org
792 * Activation:: How to activate Org for certain buffers
793 * Feedback:: Bug reports, ideas, patches etc.
794 * Conventions:: Typesetting conventions in the manual
801 Org is a mode for keeping notes, maintaining TODO lists, and project planning
802 with a fast and effective plain-text system. It also is an authoring system
803 with unique support for literate programming and reproducible research.
805 Org is implemented on top of Outline mode, which makes it possible to keep
806 the content of large files well structured. Visibility cycling and structure
807 editing help to work with the tree. Tables are easily created with a
808 built-in table editor. Plain text URL-like links connect to websites,
809 emails, Usenet messages, BBDB entries, and any files related to the projects.
811 Org develops organizational tasks around notes files that contain lists or
812 information about projects as plain text. Project planning and task
813 management makes use of metadata which is part of an outline node. Based on
814 this data, specific entries can be extracted in queries and create dynamic
815 @i{agenda views} that also integrate the Emacs calendar and diary. Org can
816 be used to implement many different project planning schemes, such as David
819 Org files can serve as a single source authoring system with export to many
820 different formats such as HTML, @LaTeX{}, Open Document, and Markdown. New
821 export backends can be derived from existing ones, or defined from scratch.
823 Org files can include source code blocks, which makes Org uniquely suited for
824 authoring technical documents with code examples. Org source code blocks are
825 fully functional; they can be evaluated in place and their results can be
826 captured in the file. This makes it possible to create a single file
827 reproducible research compendium.
829 Org keeps simple things simple. When first fired up, it should feel like a
830 straightforward, easy to use outliner. Complexity is not imposed, but a
831 large amount of functionality is available when needed. Org is a toolbox.
832 Many users usilize only a (very personal) fraction of Org's capabilities, and
833 know that there is more whenever they need it.
835 All of this is achieved with strictly plain text files, the most portable and
836 future-proof file format. Org runs in Emacs. Emacs is one of the most
837 widely ported programs, so that Org mode is available on every major
841 There is a website for Org which provides links to the newest
842 version of Org, as well as additional information, frequently asked
843 questions (FAQ), links to tutorials, etc. This page is located at
844 @uref{http://orgmode.org}.
845 @cindex print edition
847 An earlier version (7.3) of this manual is available as a
848 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from
854 @section Installation
858 Org is part of recent distributions of GNU Emacs, so you normally don't need
859 to install it. If, for one reason or another, you want to install Org on top
860 of this pre-packaged version, there are three ways to do it:
863 @item By using Emacs package system.
864 @item By downloading Org as an archive.
865 @item By using Org's git repository.
868 We @b{strongly recommend} to stick to a single installation method.
870 @subsubheading Using Emacs packaging system
872 Recent Emacs distributions include a packaging system which lets you install
873 Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
874 You need to do this in a session where no @code{.org} file has been visited.
875 Then, to make sure your Org configuration is taken into account, initialize
876 the package system with @code{(package-initialize)} in your @file{.emacs}
877 before setting any Org option. If you want to use Org's package repository,
878 check out the @uref{http://orgmode.org/elpa.html, Org ELPA page}.
880 @subsubheading Downloading Org as an archive
882 You can download Org latest release from @uref{http://orgmode.org/, Org's
883 website}. In this case, make sure you set the load-path correctly in your
887 (add-to-list 'load-path "~/path/to/orgdir/lisp")
890 The downloaded archive contains contributed libraries that are not included
891 in Emacs. If you want to use them, add the @file{contrib} directory to your
895 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
898 Optionally, you can compile the files and/or install them in your system.
899 Run @code{make help} to list compilation and installation options.
901 @subsubheading Using Org's git repository
903 You can clone Org's repository and install Org like this:
907 $ git clone git://orgmode.org/org-mode.git
911 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
912 version in @file{org-version.el} and Org's autoloads in
913 @file{org-loaddefs.el}.
915 Remember to add the correct load-path as described in the method above.
917 You can also compile with @code{make}, generate the documentation with
918 @code{make doc}, create a local configuration with @code{make config} and
919 install Org with @code{make install}. Please run @code{make help} to get
920 the list of compilation/installation options.
922 For more detailed explanations on Org's build system, please check the Org
923 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
931 @cindex global key bindings
932 @cindex key bindings, global
935 @findex org-store-link
938 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
939 default. If you are using an earlier version of Emacs, add this line to your
943 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
946 Org mode buffers need font-lock to be turned on: this is the default in
947 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
948 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
950 There are compatibility issues between Org mode and some other Elisp
951 packages, please take the time to check the list (@pxref{Conflicts}).
953 The four Org commands @command{org-store-link}, @command{org-capture},
954 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
955 global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
956 suggested bindings for these keys, please modify the keys to your own
959 (global-set-key "\C-cl" 'org-store-link)
960 (global-set-key "\C-ca" 'org-agenda)
961 (global-set-key "\C-cc" 'org-capture)
962 (global-set-key "\C-cb" 'org-iswitchb)
965 @cindex Org mode, turning on
966 To turn on Org mode in a file that does not have the extension @file{.org},
967 make the first line of a file look like this:
970 MY PROJECTS -*- mode: org; -*-
973 @vindex org-insert-mode-line-in-empty-file
974 @noindent which will select Org mode for this buffer no matter what
975 the file's name is. See also the variable
976 @code{org-insert-mode-line-in-empty-file}.
978 Many commands in Org work on the region if the region is @i{active}. To make
979 use of this, you need to have @code{transient-mark-mode}
980 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
981 in Emacs 22 you need to do this yourself with
983 (transient-mark-mode 1)
985 @noindent If you do not like @code{transient-mark-mode}, you can create an
986 active region by using the mouse to select a region, or pressing
987 @kbd{C-@key{SPC}} twice before moving the cursor.
996 If you find problems with Org, or if you have questions, remarks, or ideas
997 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
998 If you are not a member of the mailing list, your mail will be passed to the
999 list after a moderator has approved it@footnote{Please consider subscribing
1000 to the mailing list, in order to minimize the work the mailing list
1001 moderators have to do.}.
1003 For bug reports, please first try to reproduce the bug with the latest
1004 version of Org available---if you are running an outdated version, it is
1005 quite possible that the bug has been fixed already. If the bug persists,
1006 prepare a report and provide as much information as possible, including the
1007 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1008 (@kbd{M-x org-version RET}), as well as the Org related setup in
1009 @file{.emacs}. The easiest way to do this is to use the command
1011 @kbd{M-x org-submit-bug-report RET}
1013 @noindent which will put all this information into an Emacs mail buffer so
1014 that you only need to add your description. If you are not sending the Email
1015 from within Emacs, please copy and paste the content into your Email program.
1017 Sometimes you might face a problem due to an error in your Emacs or Org mode
1018 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1019 customizations and reproduce the problem. Doing so often helps you determine
1020 if the problem is with your customization or with Org mode itself. You can
1021 start a typical minimal session with a command like the example below.
1024 $ emacs -Q -l /path/to/minimal-org.el
1027 However if you are using Org mode as distributed with Emacs, a minimal setup
1028 is not necessary. In that case it is sufficient to start Emacs as
1029 @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
1033 ;;; Minimal setup to load latest `org-mode'
1035 ;; activate debugging
1036 (setq debug-on-error t
1040 ;; add latest org-mode to load path
1041 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1042 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1045 If an error occurs, a backtrace can be very useful (see below on how to
1046 create one). Often a small example file helps, along with clear information
1050 @item What exactly did you do?
1051 @item What did you expect to happen?
1052 @item What happened instead?
1054 @noindent Thank you for helping to improve this program.
1056 @subsubheading How to create a useful backtrace
1058 @cindex backtrace of an error
1059 If working with Org produces an error with a message you don't
1060 understand, you may have hit a bug. The best way to report this is by
1061 providing, in addition to what was mentioned above, a @emph{backtrace}.
1062 This is information from the built-in debugger about where and how the
1063 error occurred. Here is how to produce a useful backtrace:
1067 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1068 contains much more information if it is produced with uncompiled code.
1071 @kbd{C-u M-x org-reload RET}
1074 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1077 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1078 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1080 Do whatever you have to do to hit the error. Don't forget to
1081 document the steps you take.
1083 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1084 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1085 attach it to your bug report.
1089 @section Typesetting conventions used in this manual
1091 @subsubheading TODO keywords, tags, properties, etc.
1093 Org mainly uses three types of keywords: TODO keywords, tags and property
1094 names. In this manual we use the following conventions:
1099 TODO keywords are written with all capitals, even if they are
1103 User-defined tags are written in lowercase; built-in tags with special
1104 meaning are written with all capitals.
1107 User-defined properties are capitalized; built-in properties with
1108 special meaning are written with all capitals.
1111 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1112 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1113 environment). They are written in uppercase in the manual to enhance its
1114 readability, but you can use lowercase in your Org files@footnote{Easy
1115 templates insert lowercase keywords and Babel dynamically inserts
1118 @subsubheading Keybindings and commands
1124 The manual suggests a few global keybindings, in particular @kbd{C-c a} for
1125 @code{org-agenda} and @kbd{C-c c} for @code{org-capture}. These are only
1126 suggestions, but the rest of the manual assumes that these keybindings are in
1127 place in order to list commands by key access.
1129 Also, the manual lists both the keys and the corresponding commands for
1130 accessing a functionality. Org mode often uses the same key for different
1131 functions, depending on context. The command that is bound to such keys has
1132 a generic name, like @code{org-metaright}. In the manual we will, wherever
1133 possible, give the function that is internally called by the generic command.
1134 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1135 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1136 will be listed to call @code{org-table-move-column-right}. If you prefer,
1137 you can compile the manual without the command names by unsetting the flag
1138 @code{cmdnames} in @file{org.texi}.
1140 @node Document structure
1141 @chapter Document structure
1142 @cindex document structure
1143 @cindex structure of document
1145 Org is based on Outline mode and provides flexible commands to
1146 edit the structure of the document.
1149 * Outlines:: Org is based on Outline mode
1150 * Headlines:: How to typeset Org tree headlines
1151 * Visibility cycling:: Show and hide, much simplified
1152 * Motion:: Jumping to other headlines
1153 * Structure editing:: Changing sequence and level of headlines
1154 * Sparse trees:: Matches embedded in context
1155 * Plain lists:: Additional structure within an entry
1156 * Drawers:: Tucking stuff away
1157 * Blocks:: Folding blocks
1158 * Footnotes:: How footnotes are defined in Org's syntax
1159 * Orgstruct mode:: Structure editing outside Org
1160 * Org syntax:: Formal description of Org's syntax
1166 @cindex Outline mode
1168 Org is implemented on top of Outline mode. Outlines allow a
1169 document to be organized in a hierarchical structure, which (at least
1170 for me) is the best representation of notes and thoughts. An overview
1171 of this structure is achieved by folding (hiding) large parts of the
1172 document to show only the general document structure and the parts
1173 currently being worked on. Org greatly simplifies the use of
1174 outlines by compressing the entire show/hide functionality into a single
1175 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1180 @cindex outline tree
1181 @vindex org-special-ctrl-a/e
1182 @vindex org-special-ctrl-k
1183 @vindex org-ctrl-k-protect-subtree
1185 Headlines define the structure of an outline tree. The headlines in Org
1186 start with one or more stars, on the left margin@footnote{See the variables
1187 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1188 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1189 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1190 headings indented less then 30 stars.}. For example:
1193 * Top level headline
1200 * Another top level headline
1203 @noindent Some people find the many stars too noisy and would prefer an
1204 outline that has whitespace followed by a single star as headline
1205 starters. @ref{Clean view}, describes a setup to realize this.
1207 @vindex org-cycle-separator-lines
1208 An empty line after the end of a subtree is considered part of it and
1209 will be hidden when the subtree is folded. However, if you leave at
1210 least two empty lines, one empty line will remain visible after folding
1211 the subtree, in order to structure the collapsed view. See the
1212 variable @code{org-cycle-separator-lines} to modify this behavior.
1214 @node Visibility cycling
1215 @section Visibility cycling
1216 @cindex cycling, visibility
1217 @cindex visibility cycling
1218 @cindex trees, visibility
1219 @cindex show hidden text
1223 * Global and local cycling:: Cycling through various visibility states
1224 * Initial visibility:: Setting the initial visibility state
1225 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1228 @node Global and local cycling
1229 @subsection Global and local cycling
1231 Outlines make it possible to hide parts of the text in the buffer.
1232 Org uses just two commands, bound to @key{TAB} and
1233 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1235 @cindex subtree visibility states
1236 @cindex subtree cycling
1237 @cindex folded, subtree visibility state
1238 @cindex children, subtree visibility state
1239 @cindex subtree, subtree visibility state
1241 @orgcmd{@key{TAB},org-cycle}
1242 @emph{Subtree cycling}: Rotate current subtree among the states
1245 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1246 '-----------------------------------'
1249 @vindex org-cycle-emulate-tab
1250 @vindex org-cycle-global-at-bob
1251 The cursor must be on a headline for this to work@footnote{see, however,
1252 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1253 beginning of the buffer and the first line is not a headline, then
1254 @key{TAB} actually runs global cycling (see below)@footnote{see the
1255 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1256 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1258 @cindex global visibility states
1259 @cindex global cycling
1260 @cindex overview, global visibility state
1261 @cindex contents, global visibility state
1262 @cindex show all, global visibility state
1263 @orgcmd{S-@key{TAB},org-global-cycle}
1264 @itemx C-u @key{TAB}
1265 @emph{Global cycling}: Rotate the entire buffer among the states
1268 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1269 '--------------------------------------'
1272 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1273 CONTENTS view up to headlines of level N will be shown. Note that inside
1274 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1276 @cindex show all, command
1277 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1278 Show all, including drawers.
1279 @cindex revealing context
1280 @orgcmd{C-c C-r,org-reveal}
1281 Reveal context around point, showing the current entry, the following heading
1282 and the hierarchy above. Useful for working near a location that has been
1283 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1284 (@pxref{Agenda commands}). With a prefix argument show, on each
1285 level, all sibling headings. With a double prefix argument, also show the
1286 entire subtree of the parent.
1287 @cindex show branches, command
1288 @orgcmd{C-c C-k,show-branches}
1289 Expose all the headings of the subtree, CONTENT view for just one subtree.
1290 @cindex show children, command
1291 @orgcmd{C-c @key{TAB},show-children}
1292 Expose all direct children of the subtree. With a numeric prefix argument N,
1293 expose all children down to level N@.
1294 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1295 Show the current subtree in an indirect buffer@footnote{The indirect
1298 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1301 (see the Emacs manual for more information about indirect buffers)
1303 will contain the entire buffer, but will be narrowed to the current
1304 tree. Editing the indirect buffer will also change the original buffer,
1305 but without affecting visibility in that buffer.}. With a numeric
1306 prefix argument N, go up to level N and then take that tree. If N is
1307 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1308 the previously used indirect buffer.
1309 @orgcmd{C-c C-x v,org-copy-visible}
1310 Copy the @i{visible} text in the region into the kill ring.
1314 * Initial visibility:: Setting the initial visibility state
1315 * Catching invisible edits:: Preventing mistakes when editing invisible parts
1318 @node Initial visibility
1319 @subsection Initial visibility
1321 @cindex visibility, initialize
1322 @vindex org-startup-folded
1323 @vindex org-agenda-inhibit-startup
1324 @cindex @code{overview}, STARTUP keyword
1325 @cindex @code{content}, STARTUP keyword
1326 @cindex @code{showall}, STARTUP keyword
1327 @cindex @code{showeverything}, STARTUP keyword
1329 When Emacs first visits an Org file, the global state is set to OVERVIEW,
1330 i.e., only the top level headlines are visible@footnote{When
1331 @code{org-agenda-inhibit-startup} is non-@code{nil}, Org will not honor the default
1332 visibility state when first opening a file for the agenda (@pxref{Speeding up
1333 your agendas}).} This can be configured through the variable
1334 @code{org-startup-folded}, or on a per-file basis by adding one of the
1335 following lines anywhere in the buffer:
1341 #+STARTUP: showeverything
1344 The startup visibility options are ignored when the file is open for the
1345 first time during the agenda generation: if you want the agenda to honor
1346 the startup visibility, set @code{org-agenda-inhibit-startup} to @code{nil}.
1348 @cindex property, VISIBILITY
1350 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1351 and columns}) will get their visibility adapted accordingly. Allowed values
1352 for this property are @code{folded}, @code{children}, @code{content}, and
1356 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1357 Switch back to the startup visibility of the buffer, i.e., whatever is
1358 requested by startup options and @samp{VISIBILITY} properties in individual
1362 @node Catching invisible edits
1363 @subsection Catching invisible edits
1365 @vindex org-catch-invisible-edits
1366 @cindex edits, catching invisible
1367 Sometimes you may inadvertently edit an invisible part of the buffer and be
1368 confused on what has been edited and how to undo the mistake. Setting
1369 @code{org-catch-invisible-edits} to non-@code{nil} will help prevent this. See the
1370 docstring of this option on how Org should catch invisible edits and process
1375 @cindex motion, between headlines
1376 @cindex jumping, to headlines
1377 @cindex headline navigation
1378 The following commands jump to other headlines in the buffer.
1381 @orgcmd{C-c C-n,outline-next-visible-heading}
1383 @orgcmd{C-c C-p,outline-previous-visible-heading}
1385 @orgcmd{C-c C-f,org-forward-same-level}
1386 Next heading same level.
1387 @orgcmd{C-c C-b,org-backward-same-level}
1388 Previous heading same level.
1389 @orgcmd{C-c C-u,outline-up-heading}
1390 Backward to higher level heading.
1391 @orgcmd{C-c C-j,org-goto}
1392 Jump to a different place without changing the current outline
1393 visibility. Shows the document structure in a temporary buffer, where
1394 you can use the following keys to find your destination:
1395 @vindex org-goto-auto-isearch
1397 @key{TAB} @r{Cycle visibility.}
1398 @key{down} / @key{up} @r{Next/previous visible headline.}
1399 @key{RET} @r{Select this location.}
1400 @kbd{/} @r{Do a Sparse-tree search}
1401 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1402 n / p @r{Next/previous visible headline.}
1403 f / b @r{Next/previous headline same level.}
1405 0-9 @r{Digit argument.}
1408 @vindex org-goto-interface
1410 See also the option @code{org-goto-interface}.
1413 @node Structure editing
1414 @section Structure editing
1415 @cindex structure editing
1416 @cindex headline, promotion and demotion
1417 @cindex promotion, of subtrees
1418 @cindex demotion, of subtrees
1419 @cindex subtree, cut and paste
1420 @cindex pasting, of subtrees
1421 @cindex cutting, of subtrees
1422 @cindex copying, of subtrees
1423 @cindex sorting, of subtrees
1424 @cindex subtrees, cut and paste
1427 @orgcmd{M-@key{RET},org-insert-heading}
1428 @vindex org-M-RET-may-split-line
1429 Insert a new heading/item with the same level as the one at point.
1430 If the cursor is in a plain list item, a new item is created
1431 (@pxref{Plain lists}). To prevent this behavior in lists, call the
1432 command with a prefix argument. When this command is used in the
1433 middle of a line, the line is split and the rest of the line becomes
1434 the new item or headline@footnote{If you do not want the line to be
1435 split, customize the variable @code{org-M-RET-may-split-line}.}. If
1436 the command is used at the @emph{beginning} of a headline, the new
1437 headline is created before the current line. If the command is used
1438 at the @emph{end} of a folded subtree (i.e., behind the ellipses at
1439 the end of a headline), then a headline will be
1440 inserted after the end of the subtree. Calling this command with
1441 @kbd{C-u C-u} will unconditionally respect the headline's content and
1442 create a new item at the end of the parent subtree.
1443 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1444 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1445 current heading, the new heading is placed after the body instead of before
1446 it. This command works from anywhere in the entry.
1447 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1448 @vindex org-treat-insert-todo-heading-as-state-change
1449 Insert new TODO entry with same level as current heading. See also the
1450 variable @code{org-treat-insert-todo-heading-as-state-change}.
1451 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1452 Insert new TODO entry with same level as current heading. Like
1453 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1455 @orgcmd{@key{TAB},org-cycle}
1456 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1457 become a child of the previous one. The next @key{TAB} makes it a parent,
1458 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1459 to the initial level.
1460 @orgcmd{M-@key{left},org-do-promote}
1461 Promote current heading by one level.
1462 @orgcmd{M-@key{right},org-do-demote}
1463 Demote current heading by one level.
1464 @orgcmd{M-S-@key{left},org-promote-subtree}
1465 Promote the current subtree by one level.
1466 @orgcmd{M-S-@key{right},org-demote-subtree}
1467 Demote the current subtree by one level.
1468 @orgcmd{M-S-@key{up},org-move-subtree-up}
1469 Move subtree up (swap with previous subtree of same
1471 @orgcmd{M-S-@key{down},org-move-subtree-down}
1472 Move subtree down (swap with next subtree of same level).
1473 @orgcmd{M-h,org-mark-element}
1474 Mark the element at point. Hitting repeatedly will mark subsequent elements
1475 of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it,
1476 hitting @key{M-h} immediately again will mark the next one.
1477 @orgcmd{C-c @@,org-mark-subtree}
1478 Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
1479 of the same level than the marked subtree.
1480 @orgcmd{C-c C-x C-w,org-cut-subtree}
1481 Kill subtree, i.e., remove it from buffer but save in kill ring.
1482 With a numeric prefix argument N, kill N sequential subtrees.
1483 @orgcmd{C-c C-x M-w,org-copy-subtree}
1484 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1485 sequential subtrees.
1486 @orgcmd{C-c C-x C-y,org-paste-subtree}
1487 Yank subtree from kill ring. This does modify the level of the subtree to
1488 make sure the tree fits in nicely at the yank position. The yank level can
1489 also be specified with a numeric prefix argument, or by yanking after a
1490 headline marker like @samp{****}.
1491 @orgcmd{C-y,org-yank}
1492 @vindex org-yank-adjusted-subtrees
1493 @vindex org-yank-folded-subtrees
1494 Depending on the options @code{org-yank-adjusted-subtrees} and
1495 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1496 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1497 C-x C-y}. With the default settings, no level adjustment will take place,
1498 but the yanked tree will be folded unless doing so would swallow text
1499 previously visible. Any prefix argument to this command will force a normal
1500 @code{yank} to be executed, with the prefix passed along. A good way to
1501 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1502 yank, it will yank previous kill items plainly, without adjustment and
1504 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1505 Clone a subtree by making a number of sibling copies of it. You will be
1506 prompted for the number of copies to make, and you can also specify if any
1507 timestamps in the entry should be shifted. This can be useful, for example,
1508 to create a number of tasks related to a series of lectures to prepare. For
1509 more details, see the docstring of the command
1510 @code{org-clone-subtree-with-time-shift}.
1511 @orgcmd{C-c C-w,org-refile}
1512 Refile entry or region to a different location. @xref{Refile and copy}.
1513 @orgcmd{C-c ^,org-sort}
1514 Sort same-level entries. When there is an active region, all entries in the
1515 region will be sorted. Otherwise the children of the current headline are
1516 sorted. The command prompts for the sorting method, which can be
1517 alphabetically, numerically, by time (first timestamp with active preferred,
1518 creation time, scheduled time, deadline time), by priority, by TODO keyword
1519 (in the sequence the keywords have been defined in the setup) or by the value
1520 of a property. Reverse sorting is possible as well. You can also supply
1521 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1522 sorting will be case-sensitive.
1523 @orgcmd{C-x n s,org-narrow-to-subtree}
1524 Narrow buffer to current subtree.
1525 @orgcmd{C-x n b,org-narrow-to-block}
1526 Narrow buffer to current block.
1527 @orgcmd{C-x n w,widen}
1528 Widen buffer to remove narrowing.
1529 @orgcmd{C-c *,org-toggle-heading}
1530 Turn a normal line or plain list item into a headline (so that it becomes a
1531 subheading at its location). Also turn a headline into a normal line by
1532 removing the stars. If there is an active region, turn all lines in the
1533 region into headlines. If the first line in the region was an item, turn
1534 only the item lines into headlines. Finally, if the first line is a
1535 headline, remove the stars from all headlines in the region.
1538 @cindex region, active
1539 @cindex active region
1540 @cindex transient mark mode
1541 When there is an active region (Transient Mark mode), promotion and
1542 demotion work on all headlines in the region. To select a region of
1543 headlines, it is best to place both point and mark at the beginning of a
1544 line, mark at the beginning of the first headline, and point at the line
1545 just after the last headline to change. Note that when the cursor is
1546 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1551 @section Sparse trees
1552 @cindex sparse trees
1553 @cindex trees, sparse
1554 @cindex folding, sparse trees
1555 @cindex occur, command
1557 @vindex org-show-hierarchy-above
1558 @vindex org-show-following-heading
1559 @vindex org-show-siblings
1560 @vindex org-show-entry-below
1561 An important feature of Org mode is the ability to construct @emph{sparse
1562 trees} for selected information in an outline tree, so that the entire
1563 document is folded as much as possible, but the selected information is made
1564 visible along with the headline structure above it@footnote{See also the
1565 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1566 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1567 control on how much context is shown around each match.}. Just try it out
1568 and you will see immediately how it works.
1570 Org mode contains several commands for creating such trees, all these
1571 commands can be accessed through a dispatcher:
1574 @orgcmd{C-c /,org-sparse-tree}
1575 This prompts for an extra key to select a sparse-tree creating command.
1576 @orgcmd{C-c / r,org-occur}
1577 @vindex org-remove-highlights-with-change
1578 Prompts for a regexp and shows a sparse tree with all matches. If
1579 the match is in a headline, the headline is made visible. If the match is in
1580 the body of an entry, headline and body are made visible. In order to
1581 provide minimal context, also the full hierarchy of headlines above the match
1582 is shown, as well as the headline following the match. Each match is also
1583 highlighted; the highlights disappear when the buffer is changed by an
1584 editing command@footnote{This depends on the option
1585 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1586 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1587 so several calls to this command can be stacked.
1588 @orgcmdkkc{M-g n,M-g M-n,next-error}
1589 Jump to the next sparse tree match in this buffer.
1590 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1591 Jump to the previous sparse tree match in this buffer.
1595 @vindex org-agenda-custom-commands
1596 For frequently used sparse trees of specific search strings, you can
1597 use the option @code{org-agenda-custom-commands} to define fast
1598 keyboard access to specific sparse trees. These commands will then be
1599 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1603 (setq org-agenda-custom-commands
1604 '(("f" occur-tree "FIXME")))
1607 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1608 a sparse tree matching the string @samp{FIXME}.
1610 The other sparse tree commands select headings based on TODO keywords,
1611 tags, or properties and will be discussed later in this manual.
1614 @cindex printing sparse trees
1615 @cindex visible text, printing
1616 To print a sparse tree, you can use the Emacs command
1617 @code{ps-print-buffer-with-faces} which does not print invisible parts
1618 of the document @footnote{This does not work under XEmacs, because
1619 XEmacs uses selective display for outlining, not text properties.}.
1620 Or you can use @kbd{C-c C-e C-v} to export only the visible part of
1621 the document and print the resulting file.
1624 @section Plain lists
1626 @cindex lists, plain
1627 @cindex lists, ordered
1628 @cindex ordered lists
1630 Within an entry of the outline tree, hand-formatted lists can provide
1631 additional structure. They also provide a way to create lists of checkboxes
1632 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1633 (@pxref{Exporting}) can parse and format them.
1635 Org knows ordered lists, unordered lists, and description lists.
1638 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1639 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1640 they will be seen as top-level headlines. Also, when you are hiding leading
1641 stars to get a clean outline view, plain list items starting with a star may
1642 be hard to distinguish from true headlines. In short: even though @samp{*}
1643 is supported, it may be better to not use it for plain list items.} as
1646 @vindex org-plain-list-ordered-item-terminator
1647 @vindex org-list-allow-alphabetical
1648 @emph{Ordered} list items start with a numeral followed by either a period or
1649 a right parenthesis@footnote{You can filter out any of them by configuring
1650 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1651 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1652 @samp{A)} by configuring @code{org-list-allow-alphabetical}. To minimize
1653 confusion with normal text, those are limited to one character only. Beyond
1654 that limit, bullets will automatically fallback to numbers.}. If you want a
1655 list to start with a different value (e.g., 20), start the text of the item
1656 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1657 must be put @emph{before} the checkbox. If you have activated alphabetical
1658 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1659 be used in any item of the list in order to enforce a particular numbering.
1661 @emph{Description} list items are unordered list items, and contain the
1662 separator @samp{ :: } to distinguish the description @emph{term} from the
1666 Items belonging to the same list must have the same indentation on the first
1667 line. In particular, if an ordered list reaches number @samp{10.}, then the
1668 2--digit numbers must be written left-aligned with the other numbers in the
1669 list. An item ends before the next line that is less or equally indented
1670 than its bullet/number.
1672 @vindex org-list-empty-line-terminates-plain-lists
1673 A list ends whenever every item has ended, which means before any line less
1674 or equally indented than items at top level. It also ends before two blank
1675 lines@footnote{See also @code{org-list-empty-line-terminates-plain-lists}.}.
1676 In that case, all items are closed. Here is an example:
1680 ** Lord of the Rings
1681 My favorite scenes are (in this order)
1682 1. The attack of the Rohirrim
1683 2. Eowyn's fight with the witch king
1684 + this was already my favorite scene in the book
1685 + I really like Miranda Otto.
1686 3. Peter Jackson being shot by Legolas
1688 He makes a really funny face when it happens.
1689 But in the end, no individual scenes matter but the film as a whole.
1690 Important actors in this film are:
1691 - @b{Elijah Wood} :: He plays Frodo
1692 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1693 him very well from his role as Mikey Walsh in @i{The Goonies}.
1697 Org supports these lists by tuning filling and wrapping commands to deal with
1698 them correctly@footnote{Org only changes the filling settings for Emacs. For
1699 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1700 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1701 properly (@pxref{Exporting}). Since indentation is what governs the
1702 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1703 blocks can be indented to signal that they belong to a particular item.
1705 @vindex org-list-demote-modify-bullet
1706 @vindex org-list-indent-offset
1707 If you find that using a different bullet for a sub-list (than that used for
1708 the current list-level) improves readability, customize the variable
1709 @code{org-list-demote-modify-bullet}. To get a greater difference of
1710 indentation between items and their sub-items, customize
1711 @code{org-list-indent-offset}.
1713 @vindex org-list-automatic-rules
1714 The following commands act on items when the cursor is in the first line of
1715 an item (the line with the bullet or number). Some of them imply the
1716 application of automatic rules to keep list structure intact. If some of
1717 these actions get in your way, configure @code{org-list-automatic-rules}
1718 to disable them individually.
1721 @orgcmd{@key{TAB},org-cycle}
1722 @cindex cycling, in plain lists
1723 @vindex org-cycle-include-plain-lists
1724 Items can be folded just like headline levels. Normally this works only if
1725 the cursor is on a plain list item. For more details, see the variable
1726 @code{org-cycle-include-plain-lists}. If this variable is set to
1727 @code{integrate}, plain list items will be treated like low-level
1728 headlines. The level of an item is then given by the indentation of the
1729 bullet/number. Items are always subordinate to real headlines, however; the
1730 hierarchies remain completely separated. In a new item with no text yet, the
1731 first @key{TAB} demotes the item to become a child of the previous
1732 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1733 and eventually get it back to its initial position.
1734 @orgcmd{M-@key{RET},org-insert-heading}
1735 @vindex org-M-RET-may-split-line
1736 @vindex org-list-automatic-rules
1737 Insert new item at current level. With a prefix argument, force a new
1738 heading (@pxref{Structure editing}). If this command is used in the middle
1739 of an item, that item is @emph{split} in two, and the second part becomes the
1740 new item@footnote{If you do not want the item to be split, customize the
1741 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1742 @emph{before item's body}, the new item is created @emph{before} the current
1747 @kindex M-S-@key{RET}
1749 Insert a new item with a checkbox (@pxref{Checkboxes}).
1750 @kindex S-@key{down}
1753 @cindex shift-selection-mode
1754 @vindex org-support-shift-select
1755 @vindex org-list-use-circular-motion
1756 Jump to the previous/next item in the current list@footnote{If you want to
1757 cycle around items that way, you may customize
1758 @code{org-list-use-circular-motion}.}, but only if
1759 @code{org-support-shift-select} is off. If not, you can still use paragraph
1760 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1763 @kindex M-@key{down}
1766 Move the item including subitems up/down@footnote{See
1767 @code{org-list-use-circular-motion} for a cyclic behavior.} (swap with
1768 previous/next item of same indentation). If the list is ordered, renumbering
1770 @kindex M-@key{left}
1771 @kindex M-@key{right}
1774 Decrease/increase the indentation of an item, leaving children alone.
1775 @kindex M-S-@key{left}
1776 @kindex M-S-@key{right}
1777 @item M-S-@key{left}
1778 @itemx M-S-@key{right}
1779 Decrease/increase the indentation of the item, including subitems.
1780 Initially, the item tree is selected based on current indentation. When
1781 these commands are executed several times in direct succession, the initially
1782 selected region is used, even if the new indentation would imply a different
1783 hierarchy. To use the new hierarchy, break the command chain with a cursor
1786 As a special case, using this command on the very first item of a list will
1787 move the whole list. This behavior can be disabled by configuring
1788 @code{org-list-automatic-rules}. The global indentation of a list has no
1789 influence on the text @emph{after} the list.
1792 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1793 state of the checkbox. In any case, verify bullets and indentation
1794 consistency in the whole list.
1796 @vindex org-plain-list-ordered-item-terminator
1798 Cycle the entire list level through the different itemize/enumerate bullets
1799 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1800 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1801 and its indentation. With a numeric prefix argument N, select the Nth bullet
1802 from this list. If there is an active region when calling this, selected
1803 text will be changed into an item. With a prefix argument, all lines will be
1804 converted to list items. If the first line already was a list item, any item
1805 marker will be removed from the list. Finally, even without an active
1806 region, a normal line will be converted into a list item.
1809 Turn a plain list item into a headline (so that it becomes a subheading at
1810 its location). @xref{Structure editing}, for a detailed explanation.
1813 Turn the whole plain list into a subtree of the current heading. Checkboxes
1814 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1816 @kindex S-@key{left}
1817 @kindex S-@key{right}
1819 @vindex org-support-shift-select
1820 This command also cycles bullet styles when the cursor in on the bullet or
1821 anywhere in an item line, details depending on
1822 @code{org-support-shift-select}.
1824 @cindex sorting, of plain list
1826 Sort the plain list. You will be prompted for the sorting method:
1827 numerically, alphabetically, by time, by checked status for check lists,
1828 or by a custom function.
1834 @cindex visibility cycling, drawers
1836 @cindex org-insert-drawer
1838 Sometimes you want to keep information associated with an entry, but you
1839 normally don't want to see it. For this, Org mode has @emph{drawers}. They
1840 can contain anything but a headline and another drawer. Drawers look like
1844 ** This is a headline
1845 Still outside the drawer
1847 This is inside the drawer.
1852 You can interactively insert drawers at point by calling
1853 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1854 region, this command will put the region inside the drawer. With a prefix
1855 argument, this command calls @code{org-insert-property-drawer} and add a
1856 property drawer right below the current headline. Completion over drawer
1857 keywords is also possible using @key{M-TAB}.
1859 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1860 show the entry, but keep the drawer collapsed to a single line. In order to
1861 look inside the drawer, you need to move the cursor to the drawer line and
1862 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1863 storing properties (@pxref{Properties and columns}), and you can also arrange
1864 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1865 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1866 want to store a quick note in the LOGBOOK drawer, in a similar way to state
1872 Add a time-stamped note to the LOGBOOK drawer.
1875 @vindex org-export-with-drawers
1876 @vindex org-export-with-properties
1877 You can select the name of the drawers which should be exported with
1878 @code{org-export-with-drawers}. In that case, drawer contents will appear in
1879 export output. Property drawers are not affected by this variable: configure
1880 @code{org-export-with-properties} instead.
1885 @vindex org-hide-block-startup
1886 @cindex blocks, folding
1887 Org mode uses begin...end blocks for various purposes from including source
1888 code examples (@pxref{Literal examples}) to capturing time logging
1889 information (@pxref{Clocking work time}). These blocks can be folded and
1890 unfolded by pressing TAB in the begin line. You can also get all blocks
1891 folded at startup by configuring the option @code{org-hide-block-startup}
1892 or on a per-file basis by using
1894 @cindex @code{hideblocks}, STARTUP keyword
1895 @cindex @code{nohideblocks}, STARTUP keyword
1897 #+STARTUP: hideblocks
1898 #+STARTUP: nohideblocks
1905 Org mode supports the creation of footnotes. In contrast to the
1906 @file{footnote.el} package, Org mode's footnotes are designed for work on
1907 a larger document, not only for one-off documents like emails.
1909 A footnote is started by a footnote marker in square brackets in column 0, no
1910 indentation allowed. It ends at the next footnote definition, headline, or
1911 after two consecutive empty lines. The footnote reference is simply the
1912 marker in square brackets, inside text. For example:
1915 The Org homepage[fn:1] now looks a lot better than it used to.
1917 [fn:1] The link is: http://orgmode.org
1920 Org mode extends the number-based syntax to @emph{named} footnotes and
1921 optional inline definition. Using plain numbers as markers (as
1922 @file{footnote.el} does) is supported for backward compatibility, but not
1923 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1924 @LaTeX{}}). Here are the valid references:
1928 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1929 recommended because something like @samp{[1]} could easily be part of a code
1932 A named footnote reference, where @code{name} is a unique label word, or, for
1933 simplicity of automatic creation, a number.
1934 @item [fn:: This is the inline definition of this footnote]
1935 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1937 @item [fn:name: a definition]
1938 An inline definition of a footnote, which also specifies a name for the note.
1939 Since Org allows multiple references to the same note, you can then use
1940 @code{[fn:name]} to create additional references.
1943 @vindex org-footnote-auto-label
1944 Footnote labels can be created automatically, or you can create names yourself.
1945 This is handled by the variable @code{org-footnote-auto-label} and its
1946 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1949 @noindent The following command handles footnotes:
1954 The footnote action command.
1956 When the cursor is on a footnote reference, jump to the definition. When it
1957 is at a definition, jump to the (first) reference.
1959 @vindex org-footnote-define-inline
1960 @vindex org-footnote-section
1961 @vindex org-footnote-auto-adjust
1962 Otherwise, create a new footnote. Depending on the option
1963 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1964 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1965 definition will be placed right into the text as part of the reference, or
1966 separately into the location determined by the option
1967 @code{org-footnote-section}.
1969 When this command is called with a prefix argument, a menu of additional
1972 s @r{Sort the footnote definitions by reference sequence. During editing,}
1973 @r{Org makes no effort to sort footnote definitions into a particular}
1974 @r{sequence. If you want them sorted, use this command, which will}
1975 @r{also move entries according to @code{org-footnote-section}. Automatic}
1976 @r{sorting after each insertion/deletion can be configured using the}
1977 @r{option @code{org-footnote-auto-adjust}.}
1978 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1979 @r{after each insertion/deletion can be configured using the option}
1980 @r{@code{org-footnote-auto-adjust}.}
1981 S @r{Short for first @code{r}, then @code{s} action.}
1982 n @r{Normalize the footnotes by collecting all definitions (including}
1983 @r{inline definitions) into a special section, and then numbering them}
1984 @r{in sequence. The references will then also be numbers. This is}
1985 @r{meant to be the final step before finishing a document (e.g., sending}
1987 d @r{Delete the footnote at point, and all definitions of and references}
1990 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1991 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1992 renumbering and sorting footnotes can be automatic after each insertion or
1997 If the cursor is on a footnote reference, jump to the definition. If it is a
1998 the definition, jump back to the reference. When called at a footnote
1999 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
2003 @item C-c C-o @r{or} mouse-1/2
2004 Footnote labels are also links to the corresponding definition/reference, and
2005 you can use the usual commands to follow these links.
2008 @node Orgstruct mode
2009 @section The Orgstruct minor mode
2010 @cindex Orgstruct mode
2011 @cindex minor mode for structure editing
2013 If you like the intuitive way the Org mode structure editing and list
2014 formatting works, you might want to use these commands in other modes like
2015 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
2016 this possible. Toggle the mode with @kbd{M-x orgstruct-mode RET}, or
2017 turn it on by default, for example in Message mode, with one of:
2020 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2021 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2024 When this mode is active and the cursor is on a line that looks to Org like a
2025 headline or the first line of a list item, most structure editing commands
2026 will work, even if the same keys normally have different functionality in the
2027 major mode you are using. If the cursor is not in one of those special
2028 lines, Orgstruct mode lurks silently in the shadows.
2030 When you use @code{orgstruct++-mode}, Org will also export indentation and
2031 autofill settings into that mode, and detect item context after the first
2034 @vindex orgstruct-heading-prefix-regexp
2035 You can also use Org structure editing to fold and unfold headlines in
2036 @emph{any} file, provided you defined @code{orgstruct-heading-prefix-regexp}:
2037 the regular expression must match the local prefix to use before Org's
2038 headlines. For example, if you set this variable to @code{";; "} in Emacs
2039 Lisp files, you will be able to fold and unfold headlines in Emacs Lisp
2040 commented lines. Some commands like @code{org-demote} are disabled when the
2041 prefix is set, but folding/unfolding will work correctly.
2047 A reference document providing a formal description of Org's syntax is
2048 available as @uref{http://orgmode.org/worg/dev/org-syntax.html, a draft on
2049 Worg}, written and maintained by Nicolas Goaziou. It defines Org's core
2050 internal concepts such as @code{headlines}, @code{sections}, @code{affiliated
2051 keywords}, @code{(greater) elements} and @code{objects}. Each part of an Org
2052 file falls into one of the categories above.
2054 To explore the abstract structure of an Org buffer, run this in a buffer:
2057 M-: (org-element-parse-buffer) RET
2060 It will output a list containing the buffer's content represented as an
2061 abstract structure. The export engine relies on the information stored in
2062 this list. Most interactive commands (e.g., for structure editing) also
2063 rely on the syntactic meaning of the surrounding context.
2068 @cindex editing tables
2070 Org comes with a fast and intuitive table editor. Spreadsheet-like
2071 calculations are supported using the Emacs @file{calc} package
2072 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2075 * Built-in table editor:: Simple tables
2076 * Column width and alignment:: Overrule the automatic settings
2077 * Column groups:: Grouping to trigger vertical lines
2078 * Orgtbl mode:: The table editor as minor mode
2079 * The spreadsheet:: The table editor has spreadsheet capabilities
2080 * Org-Plot:: Plotting from org tables
2083 @node Built-in table editor
2084 @section The built-in table editor
2085 @cindex table editor, built-in
2087 Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
2088 the first non-whitespace character is considered part of a table. @samp{|}
2089 is also the column separator@footnote{To insert a vertical bar into a table
2090 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2091 might look like this:
2094 | Name | Phone | Age |
2095 |-------+-------+-----|
2096 | Peter | 1234 | 17 |
2097 | Anna | 4321 | 25 |
2100 A table is re-aligned automatically each time you press @key{TAB} or
2101 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2102 the next field (@key{RET} to the next row) and creates new table rows
2103 at the end of the table or before horizontal lines. The indentation
2104 of the table is set by the first line. Any line starting with
2105 @samp{|-} is considered as a horizontal separator line and will be
2106 expanded on the next re-align to span the whole table width. So, to
2107 create the above table, you would only type
2114 @noindent and then press @key{TAB} to align the table and start filling in
2115 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2116 @kbd{C-c @key{RET}}.
2118 @vindex org-enable-table-editor
2119 @vindex org-table-auto-blank-field
2120 When typing text into a field, Org treats @key{DEL},
2121 @key{Backspace}, and all character keys in a special way, so that
2122 inserting and deleting avoids shifting other fields. Also, when
2123 typing @emph{immediately after the cursor was moved into a new field
2124 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2125 field is automatically made blank. If this behavior is too
2126 unpredictable for you, configure the options
2127 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2130 @tsubheading{Creation and conversion}
2131 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2132 Convert the active region to a table. If every line contains at least one
2133 TAB character, the function assumes that the material is tab separated.
2134 If every line contains a comma, comma-separated values (CSV) are assumed.
2135 If not, lines are split at whitespace into fields. You can use a prefix
2136 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2137 C-u} forces TAB, @kbd{C-u C-u C-u} will prompt for a regular expression to
2138 match the separator, and a numeric argument N indicates that at least N
2139 consecutive spaces, or alternatively a TAB will be the separator.
2141 If there is no active region, this command creates an empty Org
2142 table. But it is easier just to start typing, like
2143 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2145 @tsubheading{Re-aligning and field motion}
2146 @orgcmd{C-c C-c,org-table-align}
2147 Re-align the table and don't move to another field.
2149 @orgcmd{<TAB>,org-table-next-field}
2150 Re-align the table, move to the next field. Creates a new row if
2153 @orgcmd{S-@key{TAB},org-table-previous-field}
2154 Re-align, move to previous field.
2156 @orgcmd{@key{RET},org-table-next-row}
2157 Re-align the table and move down to next row. Creates a new row if
2158 necessary. At the beginning or end of a line, @key{RET} still does
2159 NEWLINE, so it can be used to split a table.
2161 @orgcmd{M-a,org-table-beginning-of-field}
2162 Move to beginning of the current table field, or on to the previous field.
2163 @orgcmd{M-e,org-table-end-of-field}
2164 Move to end of the current table field, or on to the next field.
2166 @tsubheading{Column and row editing}
2167 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2168 Move the current column left/right.
2170 @orgcmd{M-S-@key{left},org-table-delete-column}
2171 Kill the current column.
2173 @orgcmd{M-S-@key{right},org-table-insert-column}
2174 Insert a new column to the left of the cursor position.
2176 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2177 Move the current row up/down.
2179 @orgcmd{M-S-@key{up},org-table-kill-row}
2180 Kill the current row or horizontal line.
2182 @orgcmd{M-S-@key{down},org-table-insert-row}
2183 Insert a new row above the current row. With a prefix argument, the line is
2184 created below the current one.
2186 @orgcmd{C-c -,org-table-insert-hline}
2187 Insert a horizontal line below current row. With a prefix argument, the line
2188 is created above the current line.
2190 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2191 Insert a horizontal line below current row, and move the cursor into the row
2194 @orgcmd{C-c ^,org-table-sort-lines}
2195 Sort the table lines in the region. The position of point indicates the
2196 column to be used for sorting, and the range of lines is the range
2197 between the nearest horizontal separator lines, or the entire table. If
2198 point is before the first column, you will be prompted for the sorting
2199 column. If there is an active region, the mark specifies the first line
2200 and the sorting column, while point should be in the last line to be
2201 included into the sorting. The command prompts for the sorting type
2202 (alphabetically, numerically, or by time). When called with a prefix
2203 argument, alphabetic sorting will be case-sensitive.
2205 @tsubheading{Regions}
2206 @orgcmd{C-c C-x M-w,org-table-copy-region}
2207 Copy a rectangular region from a table to a special clipboard. Point and
2208 mark determine edge fields of the rectangle. If there is no active region,
2209 copy just the current field. The process ignores horizontal separator lines.
2211 @orgcmd{C-c C-x C-w,org-table-cut-region}
2212 Copy a rectangular region from a table to a special clipboard, and
2213 blank all fields in the rectangle. So this is the ``cut'' operation.
2215 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2216 Paste a rectangular region into a table.
2217 The upper left corner ends up in the current field. All involved fields
2218 will be overwritten. If the rectangle does not fit into the present table,
2219 the table is enlarged as needed. The process ignores horizontal separator
2222 @orgcmd{M-@key{RET},org-table-wrap-region}
2223 Split the current field at the cursor position and move the rest to the line
2224 below. If there is an active region, and both point and mark are in the same
2225 column, the text in the column is wrapped to minimum width for the given
2226 number of lines. A numeric prefix argument may be used to change the number
2227 of desired lines. If there is no region, but you specify a prefix argument,
2228 the current field is made blank, and the content is appended to the field
2231 @tsubheading{Calculations}
2232 @cindex formula, in tables
2233 @cindex calculations, in tables
2234 @cindex region, active
2235 @cindex active region
2236 @cindex transient mark mode
2237 @orgcmd{C-c +,org-table-sum}
2238 Sum the numbers in the current column, or in the rectangle defined by
2239 the active region. The result is shown in the echo area and can
2240 be inserted with @kbd{C-y}.
2242 @orgcmd{S-@key{RET},org-table-copy-down}
2243 @vindex org-table-copy-increment
2244 When current field is empty, copy from first non-empty field above. When not
2245 empty, copy current field down to next row and move cursor along with it.
2246 Depending on the option @code{org-table-copy-increment}, integer field
2247 values will be incremented during copy. Integers that are too large will not
2248 be incremented. Also, a @code{0} prefix argument temporarily disables the
2249 increment. This key is also used by shift-selection and related modes
2250 (@pxref{Conflicts}).
2252 @tsubheading{Miscellaneous}
2253 @orgcmd{C-c `,org-table-edit-field}
2254 Edit the current field in a separate window. This is useful for fields that
2255 are not fully visible (@pxref{Column width and alignment}). When called with
2256 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2257 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2258 window follow the cursor through the table and always show the current
2259 field. The follow mode exits automatically when the cursor leaves the table,
2260 or when you repeat this command with @kbd{C-u C-u C-c `}.
2262 @item M-x org-table-import RET
2263 Import a file as a table. The table should be TAB or whitespace
2264 separated. Use, for example, to import a spreadsheet table or data
2265 from a database, because these programs generally can write
2266 TAB-separated text files. This command works by inserting the file into
2267 the buffer and then converting the region to a table. Any prefix
2268 argument is passed on to the converter, which uses it to determine the
2270 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2271 Tables can also be imported by pasting tabular text into the Org
2272 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2273 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2275 @item M-x org-table-export RET
2276 @findex org-table-export
2277 @vindex org-table-export-default-format
2278 Export the table, by default as a TAB-separated file. Use for data
2279 exchange with, for example, spreadsheet or database programs. The format
2280 used to export the file can be configured in the option
2281 @code{org-table-export-default-format}. You may also use properties
2282 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2283 name and the format for table export in a subtree. Org supports quite
2284 general formats for exported tables. The exporter format is the same as the
2285 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2286 detailed description.
2289 If you don't like the automatic table editor because it gets in your
2290 way on lines which you would like to start with @samp{|}, you can turn
2294 (setq org-enable-table-editor nil)
2297 @noindent Then the only table command that still works is
2298 @kbd{C-c C-c} to do a manual re-align.
2300 @node Column width and alignment
2301 @section Column width and alignment
2302 @cindex narrow columns in tables
2303 @cindex alignment in tables
2305 The width of columns is automatically determined by the table editor. And
2306 also the alignment of a column is determined automatically from the fraction
2307 of number-like versus non-number fields in the column.
2309 Sometimes a single field or a few fields need to carry more text, leading to
2310 inconveniently wide columns. Or maybe you want to make a table with several
2311 columns having a fixed width, regardless of content. To set@footnote{This
2312 feature does not work on XEmacs.} the width of a column, one field anywhere
2313 in the column may contain just the string @samp{<N>} where @samp{N} is an
2314 integer specifying the width of the column in characters. The next re-align
2315 will then set the width of this column to this value.
2319 |---+------------------------------| |---+--------|
2321 | 1 | one | | 1 | one |
2322 | 2 | two | ----\ | 2 | two |
2323 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2324 | 4 | four | | 4 | four |
2325 |---+------------------------------| |---+--------|
2330 Fields that are wider become clipped and end in the string @samp{=>}.
2331 Note that the full text is still in the buffer but is hidden.
2332 To see the full text, hold the mouse over the field---a tool-tip window
2333 will show the full content. To edit such a field, use the command
2334 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2335 open a new window with the full field. Edit it and finish with @kbd{C-c
2338 @vindex org-startup-align-all-tables
2339 When visiting a file containing a table with narrowed columns, the
2340 necessary character hiding has not yet happened, and the table needs to
2341 be aligned before it looks nice. Setting the option
2342 @code{org-startup-align-all-tables} will realign all tables in a file
2343 upon visiting, but also slow down startup. You can also set this option
2344 on a per-file basis with:
2351 If you would like to overrule the automatic alignment of number-rich columns
2352 to the right and of string-rich column to the left, you can use @samp{<r>},
2353 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2354 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2355 also combine alignment and field width like this: @samp{<r10>}.
2357 Lines which only contain these formatting cookies will be removed
2358 automatically when exporting the document.
2361 @section Column groups
2362 @cindex grouping columns in tables
2364 When Org exports tables, it does so by default without vertical
2365 lines because that is visually more satisfying in general. Occasionally
2366 however, vertical lines can be useful to structure a table into groups
2367 of columns, much like horizontal lines can do for groups of rows. In
2368 order to specify column groups, you can use a special row where the
2369 first field contains only @samp{/}. The further fields can either
2370 contain @samp{<} to indicate that this column should start a group,
2371 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2372 and @samp{>}) to make a column
2373 a group of its own. Boundaries between column groups will upon export be
2374 marked with vertical lines. Here is an example:
2377 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2378 |---+-----+-----+-----+---------+------------|
2379 | / | < | | > | < | > |
2380 | 1 | 1 | 1 | 1 | 1 | 1 |
2381 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2382 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2383 |---+-----+-----+-----+---------+------------|
2384 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2387 It is also sufficient to just insert the column group starters after
2388 every vertical line you would like to have:
2391 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2392 |----+-----+-----+-----+---------+------------|
2397 @section The Orgtbl minor mode
2399 @cindex minor mode for tables
2401 If you like the intuitive way the Org table editor works, you
2402 might also want to use it in other modes like Text mode or Mail mode.
2403 The minor mode Orgtbl mode makes this possible. You can always toggle
2404 the mode with @kbd{M-x orgtbl-mode RET}. To turn it on by default, for
2405 example in Message mode, use
2408 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2411 Furthermore, with some special setup, it is possible to maintain tables
2412 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2413 construct @LaTeX{} tables with the underlying ease and power of
2414 Orgtbl mode, including spreadsheet capabilities. For details, see
2415 @ref{Tables in arbitrary syntax}.
2417 @node The spreadsheet
2418 @section The spreadsheet
2419 @cindex calculations, in tables
2420 @cindex spreadsheet capabilities
2421 @cindex @file{calc} package
2423 The table editor makes use of the Emacs @file{calc} package to implement
2424 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2425 derive fields from other fields. While fully featured, Org's implementation
2426 is not identical to other spreadsheets. For example, Org knows the concept
2427 of a @emph{column formula} that will be applied to all non-header fields in a
2428 column without having to copy the formula to each relevant field. There is
2429 also a formula debugger, and a formula editor with features for highlighting
2430 fields in the table corresponding to the references at the point in the
2431 formula, moving these references by arrow keys
2434 * References:: How to refer to another field or range
2435 * Formula syntax for Calc:: Using Calc to compute stuff
2436 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2437 * Durations and time values:: How to compute durations and time values
2438 * Field and range formulas:: Formula for specific (ranges of) fields
2439 * Column formulas:: Formulas valid for an entire column
2440 * Lookup functions:: Lookup functions for searching tables
2441 * Editing and debugging formulas:: Fixing formulas
2442 * Updating the table:: Recomputing all dependent fields
2443 * Advanced features:: Field and column names, parameters and automatic recalc
2447 @subsection References
2450 To compute fields in the table from other fields, formulas must
2451 reference other fields or ranges. In Org, fields can be referenced
2452 by name, by absolute coordinates, and by relative coordinates. To find
2453 out what the coordinates of a field are, press @kbd{C-c ?} in that
2454 field, or press @kbd{C-c @}} to toggle the display of a grid.
2456 @subsubheading Field references
2457 @cindex field references
2458 @cindex references, to fields
2460 Formulas can reference the value of another field in two ways. Like in
2461 any other spreadsheet, you may reference fields with a letter/number
2462 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2463 @vindex org-table-use-standard-references
2464 However, Org prefers@footnote{Org will understand references typed by the
2465 user as @samp{B4}, but it will not use this syntax when offering a formula
2466 for editing. You can customize this behavior using the option
2467 @code{org-table-use-standard-references}.} to use another, more general
2468 representation that looks like this:
2470 @@@var{row}$@var{column}
2473 Column specifications can be absolute like @code{$1},
2474 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2475 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2476 @code{$<} and @code{$>} are immutable references to the first and last
2477 column, respectively, and you can use @code{$>>>} to indicate the third
2478 column from the right.
2480 The row specification only counts data lines and ignores horizontal separator
2481 lines (hlines). Like with columns, you can use absolute row numbers
2482 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2483 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2484 immutable references the first and last@footnote{For backward compatibility
2485 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2486 a stable way to the 5th and 12th field in the last row of the table.
2487 However, this syntax is deprecated, it should not be used for new documents.
2488 Use @code{@@>$} instead.} row in the table, respectively. You may also
2489 specify the row relative to one of the hlines: @code{@@I} refers to the first
2490 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2491 line above the current line, @code{@@+I} to the first such line below the
2492 current line. You can also write @code{@@III+2} which is the second data line
2493 after the third hline in the table.
2495 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2496 i.e., to the row/column for the field being computed. Also, if you omit
2497 either the column or the row part of the reference, the current row/column is
2500 Org's references with @emph{unsigned} numbers are fixed references
2501 in the sense that if you use the same reference in the formula for two
2502 different fields, the same field will be referenced each time.
2503 Org's references with @emph{signed} numbers are floating
2504 references because the same reference operator can reference different
2505 fields depending on the field being calculated by the formula.
2507 Here are a few examples:
2510 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2511 $5 @r{column 5 in the current row (same as @code{E&})}
2512 @@2 @r{current column, row 2}
2513 @@-1$-3 @r{the field one row up, three columns to the left}
2514 @@-I$2 @r{field just under hline above current row, column 2}
2515 @@>$5 @r{field in the last row, in column 5}
2518 @subsubheading Range references
2519 @cindex range references
2520 @cindex references, to ranges
2522 You may reference a rectangular range of fields by specifying two field
2523 references connected by two dots @samp{..}. If both fields are in the
2524 current row, you may simply use @samp{$2..$7}, but if at least one field
2525 is in a different row, you need to use the general @code{@@row$column}
2526 format at least for the first field (i.e the reference must start with
2527 @samp{@@} in order to be interpreted correctly). Examples:
2530 $1..$3 @r{first three fields in the current row}
2531 $P..$Q @r{range, using column names (see under Advanced)}
2532 $<<<..$>> @r{start in third column, continue to the last but one}
2533 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2534 @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
2535 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2538 @noindent Range references return a vector of values that can be fed
2539 into Calc vector functions. Empty fields in ranges are normally suppressed,
2540 so that the vector contains only the non-empty fields. For other options
2541 with the mode switches @samp{E}, @samp{N} and examples @pxref{Formula syntax
2544 @subsubheading Field coordinates in formulas
2545 @cindex field coordinates
2546 @cindex coordinates, of field
2547 @cindex row, of field coordinates
2548 @cindex column, of field coordinates
2550 One of the very first actions during evaluation of Calc formulas and Lisp
2551 formulas is to substitute @code{@@#} and @code{$#} in the formula with the
2552 row or column number of the field where the current result will go to. The
2553 traditional Lisp formula equivalents are @code{org-table-current-dline} and
2554 @code{org-table-current-column}. Examples:
2557 @item if(@@# % 2, $#, string(""))
2558 Insert column number on odd rows, set field to empty on even rows.
2559 @item $2 = '(identity remote(FOO, @@@@#$1))
2560 Copy text or values of each row of column 1 of the table named @code{FOO}
2561 into column 2 of the current table.
2562 @item @@3 = 2 * remote(FOO, @@1$$#)
2563 Insert the doubled value of each column of row 1 of the table named
2564 @code{FOO} into row 3 of the current table.
2567 @noindent For the second/third example, the table named @code{FOO} must have
2568 at least as many rows/columns as the current table. Note that this is
2569 inefficient@footnote{The computation time scales as O(N^2) because the table
2570 named @code{FOO} is parsed for each field to be read.} for large number of
2573 @subsubheading Named references
2574 @cindex named references
2575 @cindex references, named
2576 @cindex name, of column or field
2577 @cindex constants, in calculations
2580 @vindex org-table-formula-constants
2581 @samp{$name} is interpreted as the name of a column, parameter or
2582 constant. Constants are defined globally through the option
2583 @code{org-table-formula-constants}, and locally (for the file) through a
2587 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2591 @vindex constants-unit-system
2592 @pindex constants.el
2593 Also properties (@pxref{Properties and columns}) can be used as
2594 constants in table formulas: for a property @samp{:Xyz:} use the name
2595 @samp{$PROP_Xyz}, and the property will be searched in the current
2596 outline entry and in the hierarchy above it. If you have the
2597 @file{constants.el} package, it will also be used to resolve constants,
2598 including natural constants like @samp{$h} for Planck's constant, and
2599 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2600 supply the values of constants in two different unit systems, @code{SI}
2601 and @code{cgs}. Which one is used depends on the value of the variable
2602 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2603 @code{constSI} and @code{constcgs} to set this value for the current
2604 buffer.}. Column names and parameters can be specified in special table
2605 lines. These are described below, see @ref{Advanced features}. All
2606 names must start with a letter, and further consist of letters and
2609 @subsubheading Remote references
2610 @cindex remote references
2611 @cindex references, remote
2612 @cindex references, to a different table
2613 @cindex name, of column or field
2614 @cindex constants, in calculations
2615 @cindex #+NAME, for table
2617 You may also reference constants, fields and ranges from a different table,
2618 either in the current file or even in a different file. The syntax is
2621 remote(NAME-OR-ID,REF)
2625 where NAME can be the name of a table in the current file as set by a
2626 @code{#+NAME: Name} line before the table. It can also be the ID of an
2627 entry, even in a different file, and the reference then refers to the first
2628 table in that entry. REF is an absolute field or range reference as
2629 described above for example @code{@@3$3} or @code{$somename}, valid in the
2632 @node Formula syntax for Calc
2633 @subsection Formula syntax for Calc
2634 @cindex formula syntax, Calc
2635 @cindex syntax, of formulas
2637 A formula can be any algebraic expression understood by the Emacs @file{Calc}
2638 package. Note that @file{calc} has the non-standard convention that @samp{/}
2639 has lower precedence than @samp{*}, so that @samp{a/b*c} is interpreted as
2640 @samp{a/(b*c)}. Before evaluation by @code{calc-eval} (@pxref{Calling Calc
2641 from Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc,
2642 GNU Emacs Calc Manual}), variable substitution takes place according to the
2643 rules described above.
2644 @cindex vectors, in table calculations
2645 The range vectors can be directly fed into the Calc vector functions
2646 like @samp{vmean} and @samp{vsum}.
2648 @cindex format specifier
2649 @cindex mode, for @file{calc}
2650 @vindex org-calc-default-modes
2651 A formula can contain an optional mode string after a semicolon. This
2652 string consists of flags to influence Calc and other modes during
2653 execution. By default, Org uses the standard Calc modes (precision
2654 12, angular units degrees, fraction and symbolic modes off). The display
2655 format, however, has been changed to @code{(float 8)} to keep tables
2656 compact. The default settings can be configured using the option
2657 @code{org-calc-default-modes}.
2659 @noindent List of modes:
2663 Set the internal Calc calculation precision to 20 digits.
2664 @item @code{n3}, @code{s3}, @code{e2}, @code{f4}
2665 Normal, scientific, engineering or fixed format of the result of Calc passed
2666 back to Org. Calc formatting is unlimited in precision as long as the Calc
2667 calculation precision is greater.
2668 @item @code{D}, @code{R}
2669 Degree and radian angle modes of Calc.
2670 @item @code{F}, @code{S}
2671 Fraction and symbolic modes of Calc.
2672 @item @code{T}, @code{t}
2673 Duration computations in Calc or Lisp, @pxref{Durations and time values}.
2675 If and how to consider empty fields. Without @samp{E} empty fields in range
2676 references are suppressed so that the Calc vector or Lisp list contains only
2677 the non-empty fields. With @samp{E} the empty fields are kept. For empty
2678 fields in ranges or empty field references the value @samp{nan} (not a
2679 number) is used in Calc formulas and the empty string is used for Lisp
2680 formulas. Add @samp{N} to use 0 instead for both formula types. For the
2681 value of a field the mode @samp{N} has higher precedence than @samp{E}.
2683 Interpret all fields as numbers, use 0 for non-numbers. See the next section
2684 to see how this is essential for computations with Lisp formulas. In Calc
2685 formulas it is used only occasionally because there number strings are
2686 already interpreted as numbers without @samp{N}.
2688 Literal, for Lisp formulas only. See the next section.
2692 Unless you use large integer numbers or high-precision-calculation and
2693 -display for floating point numbers you may alternatively provide a
2694 @samp{printf} format specifier to reformat the Calc result after it has been
2695 passed back to Org instead of letting Calc already do the
2696 formatting@footnote{The @samp{printf} reformatting is limited in precision
2697 because the value passed to it is converted into an @samp{integer} or
2698 @samp{double}. The @samp{integer} is limited in size by truncating the
2699 signed value to 32 bits. The @samp{double} is limited in precision to 64
2700 bits overall which leaves approximately 16 significant decimal digits.}. A
2704 $1+$2 @r{Sum of first and second field}
2705 $1+$2;%.2f @r{Same, format result to two decimals}
2706 exp($2)+exp($1) @r{Math functions can be used}
2707 $0;%.1f @r{Reformat current cell to 1 decimal}
2708 ($3-32)*5/9 @r{Degrees F -> C conversion}
2709 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2710 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2711 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2712 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2715 Calc also contains a complete set of logical operations, (@pxref{Logical
2716 Operations, , Logical Operations, calc, GNU Emacs Calc Manual}). For example
2719 @item if($1 < 20, teen, string(""))
2720 "teen" if age $1 is less than 20, else the Org table result field is set to
2721 empty with the empty string.
2722 @item if("$1" == "nan" || "$2" == "nan", string(""), $1 + $2); E
2723 Sum of the first two columns. When at least one of the input fields is empty
2724 the Org table result field is set to empty.
2725 @item if(typeof(vmean($1..$7)) == 12, string(""), vmean($1..$7); E
2726 Mean value of a range unless there is any empty field. Every field in the
2727 range that is empty is replaced by @samp{nan} which lets @samp{vmean} result
2728 in @samp{nan}. Then @samp{typeof == 12} detects the @samp{nan} from
2729 @samp{vmean} and the Org table result field is set to empty. Use this when
2730 the sample set is expected to never have missing values.
2731 @item if("$1..$7" == "[]", string(""), vmean($1..$7))
2732 Mean value of a range with empty fields skipped. Every field in the range
2733 that is empty is skipped. When all fields in the range are empty the mean
2734 value is not defined and the Org table result field is set to empty. Use
2735 this when the sample set can have a variable size.
2736 @item vmean($1..$7); EN
2737 To complete the example before: Mean value of a range with empty fields
2738 counting as samples with value 0. Use this only when incomplete sample sets
2739 should be padded with 0 to the full size.
2742 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2743 and use them in formula syntax for Calc.
2745 @node Formula syntax for Lisp
2746 @subsection Emacs Lisp forms as formulas
2747 @cindex Lisp forms, as table formulas
2749 It is also possible to write a formula in Emacs Lisp. This can be useful
2750 for string manipulation and control structures, if Calc's functionality is
2753 If a formula starts with a single-quote followed by an opening parenthesis,
2754 then it is evaluated as a Lisp form. The evaluation should return either a
2755 string or a number. Just as with @file{calc} formulas, you can specify modes
2756 and a printf format after a semicolon.
2758 With Emacs Lisp forms, you need to be conscious about the way field
2759 references are interpolated into the form. By default, a reference will be
2760 interpolated as a Lisp string (in double-quotes) containing the field. If
2761 you provide the @samp{N} mode switch, all referenced elements will be numbers
2762 (non-number fields will be zero) and interpolated as Lisp numbers, without
2763 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2764 literally, without quotes. I.e., if you want a reference to be interpreted
2765 as a string by the Lisp form, enclose the reference operator itself in
2766 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2767 fields, so you can embed them in list or vector syntax.
2769 Here are a few examples---note how the @samp{N} mode is used when we do
2770 computations in Lisp:
2773 @item '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2774 Swap the first two characters of the content of column 1.
2776 Add columns 1 and 2, equivalent to Calc's @code{$1+$2}.
2777 @item '(apply '+ '($1..$4));N
2778 Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}.
2781 @node Durations and time values
2782 @subsection Durations and time values
2783 @cindex Duration, computing
2784 @cindex Time, computing
2785 @vindex org-table-duration-custom-format
2787 If you want to compute time values use the @code{T} flag, either in Calc
2788 formulas or Elisp formulas:
2792 | Task 1 | Task 2 | Total |
2793 |---------+----------+----------|
2794 | 2:12 | 1:47 | 03:59:00 |
2795 | 3:02:20 | -2:07:00 | 0.92 |
2796 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2800 Input duration values must be of the form @code{HH:MM[:SS]}, where seconds
2801 are optional. With the @code{T} flag, computed durations will be displayed
2802 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2803 computed durations will be displayed according to the value of the option
2804 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2805 will display the result as a fraction of hours (see the second formula in the
2808 Negative duration values can be manipulated as well, and integers will be
2809 considered as seconds in addition and subtraction.
2811 @node Field and range formulas
2812 @subsection Field and range formulas
2813 @cindex field formula
2814 @cindex range formula
2815 @cindex formula, for individual table field
2816 @cindex formula, for range of fields
2818 To assign a formula to a particular field, type it directly into the field,
2819 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2820 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2821 the formula will be stored as the formula for this field, evaluated, and the
2822 current field will be replaced with the result.
2825 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2826 below the table. If you type the equation in the 4th field of the 3rd data
2827 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2828 inserting/deleting/swapping columns and rows with the appropriate commands,
2829 @i{absolute references} (but not relative ones) in stored formulas are
2830 modified in order to still reference the same field. To avoid this, in
2831 particular in range references, anchor ranges at the table borders (using
2832 @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines using the
2833 @code{@@I} notation. Automatic adaptation of field references does of course
2834 not happen if you edit the table structure with normal editing
2835 commands---then you must fix the equations yourself.
2837 Instead of typing an equation into the field, you may also use the following
2841 @orgcmd{C-u C-c =,org-table-eval-formula}
2842 Install a new formula for the current field. The command prompts for a
2843 formula with default taken from the @samp{#+TBLFM:} line, applies
2844 it to the current field, and stores it.
2847 The left-hand side of a formula can also be a special expression in order to
2848 assign the formula to a number of different fields. There is no keyboard
2849 shortcut to enter such range formulas. To add them, use the formula editor
2850 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2855 Column formula, valid for the entire column. This is so common that Org
2856 treats these formulas in a special way, see @ref{Column formulas}.
2858 Row formula, applies to all fields in the specified row. @code{@@>=} means
2861 Range formula, applies to all fields in the given rectangular range. This
2862 can also be used to assign a formula to some but not all fields in a row.
2864 Named field, see @ref{Advanced features}.
2867 @node Column formulas
2868 @subsection Column formulas
2869 @cindex column formula
2870 @cindex formula, for table column
2872 When you assign a formula to a simple column reference like @code{$3=}, the
2873 same formula will be used in all fields of that column, with the following
2874 very convenient exceptions: (i) If the table contains horizontal separator
2875 hlines with rows above and below, everything before the first such hline is
2876 considered part of the table @emph{header} and will not be modified by column
2877 formulas. Therefore a header is mandatory when you use column formulas and
2878 want to add hlines to group rows, like for example to separate a total row at
2879 the bottom from the summand rows above. (ii) Fields that already get a value
2880 from a field/range formula will be left alone by column formulas. These
2881 conditions make column formulas very easy to use.
2883 To assign a formula to a column, type it directly into any field in the
2884 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2885 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2886 the formula will be stored as the formula for the current column, evaluated
2887 and the current field replaced with the result. If the field contains only
2888 @samp{=}, the previously stored formula for this column is used. For each
2889 column, Org will only remember the most recently used formula. In the
2890 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2891 left-hand side of a column formula cannot be the name of column, it must be
2892 the numeric column reference or @code{$>}.
2894 Instead of typing an equation into the field, you may also use the
2898 @orgcmd{C-c =,org-table-eval-formula}
2899 Install a new formula for the current column and replace current field with
2900 the result of the formula. The command prompts for a formula, with default
2901 taken from the @samp{#+TBLFM} line, applies it to the current field and
2902 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2903 will apply it to that many consecutive fields in the current column.
2906 @node Lookup functions
2907 @subsection Lookup functions
2908 @cindex lookup functions in tables
2909 @cindex table lookup functions
2911 Org has three predefined Emacs Lisp functions for lookups in tables.
2913 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2914 @findex org-lookup-first
2915 Searches for the first element @code{S} in list @code{S-LIST} for which
2919 is @code{t}; returns the value from the corresponding position in list
2920 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2921 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2922 order as the corresponding parameters are in the call to
2923 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2924 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2926 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2927 @findex org-lookup-last
2928 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2929 element for which @code{PREDICATE} is @code{t}.
2930 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2931 @findex org-lookup-all
2932 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2933 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2934 values. This function can not be used by itself in a formula, because it
2935 returns a list of values. However, powerful lookups can be built when this
2936 function is combined with other Emacs Lisp functions.
2939 If the ranges used in these functions contain empty fields, the @code{E} mode
2940 for the formula should usually be specified: otherwise empty fields will not be
2941 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2942 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2943 element of @code{R-LIST}.
2945 These three functions can be used to implement associative arrays, count
2946 matching cells, rank results, group data etc. For practical examples
2947 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2950 @node Editing and debugging formulas
2951 @subsection Editing and debugging formulas
2952 @cindex formula editing
2953 @cindex editing, of table formulas
2955 @vindex org-table-use-standard-references
2956 You can edit individual formulas in the minibuffer or directly in the field.
2957 Org can also prepare a special buffer with all active formulas of a table.
2958 When offering a formula for editing, Org converts references to the standard
2959 format (like @code{B3} or @code{D&}) if possible. If you prefer to only work
2960 with the internal format (like @code{@@3$2} or @code{$4}), configure the
2961 option @code{org-table-use-standard-references}.
2964 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2965 Edit the formula associated with the current column/field in the
2966 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2967 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2968 Re-insert the active formula (either a
2969 field formula, or a column formula) into the current field, so that you
2970 can edit it directly in the field. The advantage over editing in the
2971 minibuffer is that you can use the command @kbd{C-c ?}.
2972 @orgcmd{C-c ?,org-table-field-info}
2973 While editing a formula in a table field, highlight the field(s)
2974 referenced by the reference at the cursor position in the formula.
2976 @findex org-table-toggle-coordinate-overlays
2978 Toggle the display of row and column numbers for a table, using overlays
2979 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2980 time the table is aligned; you can force it with @kbd{C-c C-c}.
2982 @findex org-table-toggle-formula-debugger
2984 Toggle the formula debugger on and off
2985 (@command{org-table-toggle-formula-debugger}). See below.
2986 @orgcmd{C-c ',org-table-edit-formulas}
2987 Edit all formulas for the current table in a special buffer, where the
2988 formulas will be displayed one per line. If the current field has an
2989 active formula, the cursor in the formula editor will mark it.
2990 While inside the special buffer, Org will automatically highlight
2991 any field or range reference at the cursor position. You may edit,
2992 remove and add formulas, and use the following commands:
2995 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2996 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2997 prefix, also apply the new formulas to the entire table.
2998 @orgcmd{C-c C-q,org-table-fedit-abort}
2999 Exit the formula editor without installing changes.
3000 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
3001 Toggle all references in the formula editor between standard (like
3002 @code{B3}) and internal (like @code{@@3$2}).
3003 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
3004 Pretty-print or indent Lisp formula at point. When in a line containing
3005 a Lisp formula, format the formula according to Emacs Lisp rules.
3006 Another @key{TAB} collapses the formula back again. In the open
3007 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
3008 @orgcmd{M-@key{TAB},lisp-complete-symbol}
3009 Complete Lisp symbols, just like in Emacs Lisp mode.
3011 @kindex S-@key{down}
3012 @kindex S-@key{left}
3013 @kindex S-@key{right}
3014 @findex org-table-fedit-ref-up
3015 @findex org-table-fedit-ref-down
3016 @findex org-table-fedit-ref-left
3017 @findex org-table-fedit-ref-right
3018 @item S-@key{up}/@key{down}/@key{left}/@key{right}
3019 Shift the reference at point. For example, if the reference is
3020 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
3021 This also works for relative references and for hline references.
3022 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
3023 Move the test line for column formulas in the Org buffer up and
3025 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
3026 Scroll the window displaying the table.
3028 @findex org-table-toggle-coordinate-overlays
3030 Turn the coordinate grid in the table on and off.
3034 Making a table field blank does not remove the formula associated with
3035 the field, because that is stored in a different line (the @samp{#+TBLFM}
3036 line)---during the next recalculation the field will be filled again.
3037 To remove a formula from a field, you have to give an empty reply when
3038 prompted for the formula, or to edit the @samp{#+TBLFM} line.
3041 You may edit the @samp{#+TBLFM} directly and re-apply the changed
3042 equations with @kbd{C-c C-c} in that line or with the normal
3043 recalculation commands in the table.
3045 @anchor{Using multiple #+TBLFM lines}
3046 @subsubheading Using multiple #+TBLFM lines
3047 @cindex #+TBLFM line, multiple
3049 @cindex #+TBLFM, switching
3052 You may apply the formula temporarily. This is useful when you
3053 switch the formula. Place multiple @samp{#+TBLFM} lines right
3054 after the table, and then press @kbd{C-c C-c} on the formula to
3055 apply. Here is an example:
3067 Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields:
3079 Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you
3080 will get the following result of applying only the first @samp{#+TBLFM} line.
3091 @subsubheading Debugging formulas
3092 @cindex formula debugging
3093 @cindex debugging, of table formulas
3094 When the evaluation of a formula leads to an error, the field content
3095 becomes the string @samp{#ERROR}. If you would like see what is going
3096 on during variable substitution and calculation in order to find a bug,
3097 turn on formula debugging in the @code{Tbl} menu and repeat the
3098 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
3099 field. Detailed information will be displayed.
3101 @node Updating the table
3102 @subsection Updating the table
3103 @cindex recomputing table fields
3104 @cindex updating, table
3106 Recalculation of a table is normally not automatic, but needs to be
3107 triggered by a command. See @ref{Advanced features}, for a way to make
3108 recalculation at least semi-automatic.
3110 In order to recalculate a line of a table or the entire table, use the
3114 @orgcmd{C-c *,org-table-recalculate}
3115 Recalculate the current row by first applying the stored column formulas
3116 from left to right, and all field/range formulas in the current row.
3122 Recompute the entire table, line by line. Any lines before the first
3123 hline are left alone, assuming that these are part of the table header.
3125 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3126 Iterate the table by recomputing it until no further changes occur.
3127 This may be necessary if some computed fields use the value of other
3128 fields that are computed @i{later} in the calculation sequence.
3129 @item M-x org-table-recalculate-buffer-tables RET
3130 @findex org-table-recalculate-buffer-tables
3131 Recompute all tables in the current buffer.
3132 @item M-x org-table-iterate-buffer-tables RET
3133 @findex org-table-iterate-buffer-tables
3134 Iterate all tables in the current buffer, in order to converge table-to-table
3138 @node Advanced features
3139 @subsection Advanced features
3141 If you want the recalculation of fields to happen automatically, or if you
3142 want to be able to assign @i{names}@footnote{Such names must start by an
3143 alphabetic character and use only alphanumeric/underscore characters.} to
3144 fields and columns, you need to reserve the first column of the table for
3145 special marking characters.
3148 @orgcmd{C-#,org-table-rotate-recalc-marks}
3149 Rotate the calculation mark in first column through the states @samp{ },
3150 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
3151 change all marks in the region.
3154 Here is an example of a table that collects exam results of students and
3155 makes use of these features:
3159 |---+---------+--------+--------+--------+-------+------|
3160 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3161 |---+---------+--------+--------+--------+-------+------|
3162 | ! | | P1 | P2 | P3 | Tot | |
3163 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
3164 | ^ | | m1 | m2 | m3 | mt | |
3165 |---+---------+--------+--------+--------+-------+------|
3166 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3167 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3168 |---+---------+--------+--------+--------+-------+------|
3169 | | Average | | | | 25.0 | |
3170 | ^ | | | | | at | |
3171 | $ | max=50 | | | | | |
3172 |---+---------+--------+--------+--------+-------+------|
3173 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3177 @noindent @b{Important}: please note that for these special tables,
3178 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3179 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3180 to the field itself. The column formulas are not applied in rows with
3183 @cindex marking characters, tables
3184 The marking characters have the following meaning:
3188 The fields in this line define names for the columns, so that you may
3189 refer to a column as @samp{$Tot} instead of @samp{$6}.
3191 This row defines names for the fields @emph{above} the row. With such
3192 a definition, any formula in the table may use @samp{$m1} to refer to
3193 the value @samp{10}. Also, if you assign a formula to a names field, it
3194 will be stored as @samp{$name=...}.
3196 Similar to @samp{^}, but defines names for the fields in the row
3199 Fields in this row can define @emph{parameters} for formulas. For
3200 example, if a field in a @samp{$} row contains @samp{max=50}, then
3201 formulas in this table can refer to the value 50 using @samp{$max}.
3202 Parameters work exactly like constants, only that they can be defined on
3205 Fields in this row are automatically recalculated when pressing
3206 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3207 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3208 lines will be left alone by this command.
3210 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3211 not for automatic recalculation. Use this when automatic
3212 recalculation slows down editing too much.
3214 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3215 All lines that should be recalculated should be marked with @samp{#}
3218 Do not export this line. Useful for lines that contain the narrowing
3219 @samp{<N>} markers or column group markers.
3222 Finally, just to whet your appetite for what can be done with the
3223 fantastic @file{calc.el} package, here is a table that computes the Taylor
3224 series of degree @code{n} at location @code{x} for a couple of
3229 |---+-------------+---+-----+--------------------------------------|
3230 | | Func | n | x | Result |
3231 |---+-------------+---+-----+--------------------------------------|
3232 | # | exp(x) | 1 | x | 1 + x |
3233 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3234 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3235 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3236 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3237 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3238 |---+-------------+---+-----+--------------------------------------|
3239 #+TBLFM: $5=taylor($2,$4,$3);n3
3245 @cindex graph, in tables
3246 @cindex plot tables using Gnuplot
3249 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3250 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3251 @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
3252 that you have both Gnuplot and Gnuplot mode installed on your system, then
3253 call @code{org-plot/gnuplot} on the following table.
3257 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3258 | Sede | Max cites | H-index |
3259 |-----------+-----------+---------|
3260 | Chile | 257.72 | 21.39 |
3261 | Leeds | 165.77 | 19.68 |
3262 | Sao Paolo | 71.00 | 11.50 |
3263 | Stockholm | 134.19 | 14.33 |
3264 | Morelia | 257.56 | 17.67 |
3268 Notice that Org Plot is smart enough to apply the table's headers as labels.
3269 Further control over the labels, type, content, and appearance of plots can
3270 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3271 for a complete list of Org-plot options. For more information and examples
3272 see the Org-plot tutorial at
3273 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3275 @subsubheading Plot Options
3279 Specify any @command{gnuplot} option to be set when graphing.
3282 Specify the title of the plot.
3285 Specify which column of the table to use as the @code{x} axis.
3288 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3289 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3290 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3294 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3297 Specify a @code{with} option to be inserted for every col being plotted
3298 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3299 Defaults to @code{lines}.
3302 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3305 List of labels to be used for the @code{deps} (defaults to the column headers
3309 Specify an entire line to be inserted in the Gnuplot script.
3312 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3313 flat mapping rather than a @code{3d} slope.
3316 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3317 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3320 If you want total control, you can specify a script file (place the file name
3321 between double-quotes) which will be used to plot. Before plotting, every
3322 instance of @code{$datafile} in the specified script will be replaced with
3323 the path to the generated data file. Note: even if you set this option, you
3324 may still want to specify the plot type, as that can impact the content of
3332 Like HTML, Org provides links inside a file, external links to
3333 other files, Usenet articles, emails, and much more.
3336 * Link format:: How links in Org are formatted
3337 * Internal links:: Links to other places in the current file
3338 * External links:: URL-like links to the world
3339 * Handling links:: Creating, inserting and following
3340 * Using links outside Org:: Linking from my C source code?
3341 * Link abbreviations:: Shortcuts for writing complex links
3342 * Search options:: Linking to a specific location
3343 * Custom searches:: When the default search is not enough
3347 @section Link format
3349 @cindex format, of links
3351 Org will recognize plain URL-like links and activate them as
3352 clickable links. The general link format, however, looks like this:
3355 [[link][description]] @r{or alternatively} [[link]]
3359 Once a link in the buffer is complete (all brackets present), Org
3360 will change the display so that @samp{description} is displayed instead
3361 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3362 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3363 which by default is an underlined face. You can directly edit the
3364 visible part of a link. Note that this can be either the @samp{link}
3365 part (if there is no description) or the @samp{description} part. To
3366 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3369 If you place the cursor at the beginning or just behind the end of the
3370 displayed text and press @key{BACKSPACE}, you will remove the
3371 (invisible) bracket at that location. This makes the link incomplete
3372 and the internals are again displayed as plain text. Inserting the
3373 missing bracket hides the link internals again. To show the
3374 internal structure of all links, use the menu entry
3375 @code{Org->Hyperlinks->Literal links}.
3377 @node Internal links
3378 @section Internal links
3379 @cindex internal links
3380 @cindex links, internal
3381 @cindex targets, for links
3383 @cindex property, CUSTOM_ID
3384 If the link does not look like a URL, it is considered to be internal in the
3385 current file. The most important case is a link like
3386 @samp{[[#my-custom-id]]} which will link to the entry with the
3387 @code{CUSTOM_ID} property @samp{my-custom-id}. You are responsible yourself
3388 to make sure these custom IDs are unique in a file.
3390 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3391 lead to a text search in the current file.
3393 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3394 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3395 point to the corresponding headline. The preferred match for a text link is
3396 a @i{dedicated target}: the same string in double angular brackets, like
3397 @samp{<<My Target>>}.
3400 If no dedicated target exists, the link will then try to match the exact name
3401 of an element within the buffer. Naming is done with the @code{#+NAME}
3402 keyword, which has to be put in the line before the element it refers to, as
3403 in the following example
3412 If none of the above succeeds, Org will search for a headline that is exactly
3413 the link text but may also include a TODO keyword and tags@footnote{To insert
3414 a link targeting a headline, in-buffer completion can be used. Just type
3415 a star followed by a few optional letters into the buffer and press
3416 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3419 During export, internal links will be used to mark objects and assign them
3420 a number. Marked objects will then be referenced by links pointing to them.
3421 In particular, links without a description will appear as the number assigned
3422 to the marked object@footnote{When targeting a @code{#+NAME} keyword,
3423 @code{#+CAPTION} keyword is mandatory in order to get proper numbering
3424 (@pxref{Images and tables}).}. In the following excerpt from an Org buffer
3428 - <<target>>another item
3429 Here we refer to item [[target]].
3433 The last sentence will appear as @samp{Here we refer to item 2} when
3436 In non-Org files, the search will look for the words in the link text. In
3437 the above example the search would be for @samp{my target}.
3439 Following a link pushes a mark onto Org's own mark ring. You can
3440 return to the previous position with @kbd{C-c &}. Using this command
3441 several times in direct succession goes back to positions recorded
3445 * Radio targets:: Make targets trigger links in plain text
3449 @subsection Radio targets
3450 @cindex radio targets
3451 @cindex targets, radio
3452 @cindex links, radio targets
3454 Org can automatically turn any occurrences of certain target names
3455 in normal text into a link. So without explicitly creating a link, the
3456 text connects to the target radioing its position. Radio targets are
3457 enclosed by triple angular brackets. For example, a target @samp{<<<My
3458 Target>>>} causes each occurrence of @samp{my target} in normal text to
3459 become activated as a link. The Org file is scanned automatically
3460 for radio targets only when the file is first loaded into Emacs. To
3461 update the target list during editing, press @kbd{C-c C-c} with the
3462 cursor on or at a target.
3464 @node External links
3465 @section External links
3466 @cindex links, external
3467 @cindex external links
3475 @cindex USENET links
3480 Org supports links to files, websites, Usenet and email messages, BBDB
3481 database entries and links to both IRC conversations and their logs.
3482 External links are URL-like locators. They start with a short identifying
3483 string followed by a colon. There can be no space after the colon. The
3484 following list shows examples for each link type.
3487 http://www.astro.uva.nl/~dominik @r{on the web}
3488 doi:10.1000/182 @r{DOI for an electronic resource}
3489 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3490 /home/dominik/images/jupiter.jpg @r{same as above}
3491 file:papers/last.pdf @r{file, relative path}
3492 ./papers/last.pdf @r{same as above}
3493 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3494 /myself@@some.where:papers/last.pdf @r{same as above}
3495 file:sometextfile::NNN @r{file, jump to line number}
3496 file:projects.org @r{another Org file}
3497 file:projects.org::some words @r{text search in Org file}@footnote{
3498 The actual behavior of the search will depend on the value of
3499 the option @code{org-link-search-must-match-exact-headline}. If its value
3500 is @code{nil}, then a fuzzy text search will be done. If it is t, then only the
3501 exact headline will be matched. If the value is @code{'query-to-create},
3502 then an exact headline will be searched; if it is not found, then the user
3503 will be queried to create it.}
3504 file:projects.org::*task title @r{heading search in Org file}
3505 file+sys:/path/to/file @r{open via OS, like double-click}
3506 file+emacs:/path/to/file @r{force opening by Emacs}
3507 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3508 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3509 news:comp.emacs @r{Usenet link}
3510 mailto:adent@@galaxy.net @r{Mail link}
3511 mhe:folder @r{MH-E folder link}
3512 mhe:folder#id @r{MH-E message link}
3513 rmail:folder @r{RMAIL folder link}
3514 rmail:folder#id @r{RMAIL message link}
3515 gnus:group @r{Gnus group link}
3516 gnus:group#id @r{Gnus article link}
3517 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3518 irc:/irc.com/#emacs/bob @r{IRC link}
3519 info:org#External links @r{Info node link}
3520 shell:ls *.org @r{A shell command}
3521 elisp:org-agenda @r{Interactive Elisp command}
3522 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3526 @cindex WANDERLUST links
3527 On top of these built-in link types, some are available through the
3528 @code{contrib/} directory (@pxref{Installation}). For example, these links
3529 to VM or Wanderlust messages are available when you load the corresponding
3530 libraries from the @code{contrib/} directory:
3533 vm:folder @r{VM folder link}
3534 vm:folder#id @r{VM message link}
3535 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3536 vm-imap:account:folder @r{VM IMAP folder link}
3537 vm-imap:account:folder#id @r{VM IMAP message link}
3538 wl:folder @r{WANDERLUST folder link}
3539 wl:folder#id @r{WANDERLUST message link}
3542 For customizing Org to add new link types @ref{Adding hyperlink types}.
3544 A link should be enclosed in double brackets and may contain a descriptive
3545 text to be displayed instead of the URL (@pxref{Link format}), for example:
3548 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3552 If the description is a file name or URL that points to an image, HTML
3553 export (@pxref{HTML export}) will inline the image as a clickable
3554 button. If there is no description at all and the link points to an
3556 that image will be inlined into the exported HTML file.
3558 @cindex square brackets, around links
3559 @cindex plain text external links
3560 Org also finds external links in the normal text and activates them
3561 as links. If spaces must be part of the link (for example in
3562 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3563 about the end of the link, enclose them in square brackets.
3565 @node Handling links
3566 @section Handling links
3567 @cindex links, handling
3569 Org provides methods to create a link in the correct syntax, to
3570 insert it into an Org file, and to follow the link.
3573 @orgcmd{C-c l,org-store-link}
3574 @cindex storing links
3575 Store a link to the current location. This is a @emph{global} command (you
3576 must create the key binding yourself) which can be used in any buffer to
3577 create a link. The link will be stored for later insertion into an Org
3578 buffer (see below). What kind of link will be created depends on the current
3581 @b{Org mode buffers}@*
3582 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3583 to the target. Otherwise it points to the current headline, which will also
3584 be the description@footnote{If the headline contains a timestamp, it will be
3585 removed from the link and result in a wrong link---you should avoid putting
3586 timestamp in the headline.}.
3588 @vindex org-id-link-to-org-use-id
3589 @cindex property, CUSTOM_ID
3590 @cindex property, ID
3591 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3592 will be stored. In addition or alternatively (depending on the value of
3593 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3594 be created and/or used to construct a link@footnote{The library
3595 @file{org-id.el} must first be loaded, either through @code{org-customize} by
3596 enabling @code{org-id} in @code{org-modules}, or by adding @code{(require
3597 'org-id)} in your @file{.emacs}.}. So using this command in Org buffers will
3598 potentially create two links: a human-readable from the custom ID, and one
3599 that is globally unique and works even if the entry is moved from file to
3600 file. Later, when inserting the link, you need to decide which one to use.
3602 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3603 Pretty much all Emacs mail clients are supported. The link will point to the
3604 current article, or, in some GNUS buffers, to the group. The description is
3605 constructed from the author and the subject.
3607 @b{Web browsers: W3 and W3M}@*
3608 Here the link will be the current URL, with the page title as description.
3610 @b{Contacts: BBDB}@*
3611 Links created in a BBDB buffer will point to the current entry.
3614 @vindex org-irc-link-to-logs
3615 For IRC links, if you set the option @code{org-irc-link-to-logs} to @code{t},
3616 a @samp{file:/} style link to the relevant point in the logs for the current
3617 conversation is created. Otherwise an @samp{irc:/} style link to the
3618 user/channel/server under the point will be stored.
3621 For any other files, the link will point to the file, with a search string
3622 (@pxref{Search options}) pointing to the contents of the current line. If
3623 there is an active region, the selected words will form the basis of the
3624 search string. If the automatically created link is not working correctly or
3625 accurately enough, you can write custom functions to select the search string
3626 and to do the search for particular file types---see @ref{Custom searches}.
3627 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3630 When the cursor is in an agenda view, the created link points to the
3631 entry referenced by the current line.
3634 @orgcmd{C-c C-l,org-insert-link}
3635 @cindex link completion
3636 @cindex completion, of links
3637 @cindex inserting links
3638 @vindex org-keep-stored-link-after-insertion
3639 Insert a link@footnote{Note that you don't have to use this command to
3640 insert a link. Links in Org are plain text, and you can type or paste them
3641 straight into the buffer. By using this command, the links are automatically
3642 enclosed in double brackets, and you will be asked for the optional
3643 descriptive text.}. This prompts for a link to be inserted into the buffer.
3644 You can just type a link, using text for an internal link, or one of the link
3645 type prefixes mentioned in the examples above. The link will be inserted
3646 into the buffer@footnote{After insertion of a stored link, the link will be
3647 removed from the list of stored links. To keep it in the list later use, use
3648 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3649 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3650 If some text was selected when this command is called, the selected text
3651 becomes the default description.
3653 @b{Inserting stored links}@*
3654 All links stored during the
3655 current session are part of the history for this prompt, so you can access
3656 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3658 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3659 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3660 defined through link abbreviations (@pxref{Link abbreviations}). If you
3661 press @key{RET} after inserting only the @var{prefix}, Org will offer
3662 specific completion support for some link types@footnote{This works by
3663 calling a special function @code{org-PREFIX-complete-link}.} For
3664 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3665 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3666 @key{RET}} you can complete contact names.
3668 @cindex file name completion
3669 @cindex completion, of file names
3670 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3671 a file will be inserted and you may use file name completion to select
3672 the name of the file. The path to the file is inserted relative to the
3673 directory of the current Org file, if the linked file is in the current
3674 directory or in a sub-directory of it, or if the path is written relative
3675 to the current directory using @samp{../}. Otherwise an absolute path
3676 is used, if possible with @samp{~/} for your home directory. You can
3677 force an absolute path with two @kbd{C-u} prefixes.
3679 @item C-c C-l @ @r{(with cursor on existing link)}
3680 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3681 link and description parts of the link.
3683 @cindex following links
3684 @orgcmd{C-c C-o,org-open-at-point}
3685 @vindex org-file-apps
3686 @vindex org-link-frame-setup
3687 Open link at point. This will launch a web browser for URLs (using
3688 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3689 the corresponding links, and execute the command in a shell link. When the
3690 cursor is on an internal link, this command runs the corresponding search.
3691 When the cursor is on a TAG list in a headline, it creates the corresponding
3692 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3693 date. Furthermore, it will visit text and remote files in @samp{file:} links
3694 with Emacs and select a suitable application for local non-text files.
3695 Classification of files is based on file extension only. See option
3696 @code{org-file-apps}. If you want to override the default application and
3697 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3698 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3699 If the cursor is on a headline, but not on a link, offer all links in the
3700 headline and entry text. If you want to setup the frame configuration for
3701 following links, customize @code{org-link-frame-setup}.
3704 @vindex org-return-follows-link
3705 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3712 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3713 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3717 @vindex org-display-internal-link-with-indirect-buffer
3718 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3719 internal links to be displayed in another window@footnote{See the
3720 option @code{org-display-internal-link-with-indirect-buffer}}.
3722 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3723 @cindex inlining images
3724 @cindex images, inlining
3725 @vindex org-startup-with-inline-images
3726 @cindex @code{inlineimages}, STARTUP keyword
3727 @cindex @code{noinlineimages}, STARTUP keyword
3728 Toggle the inline display of linked images. Normally this will only inline
3729 images that have no description part in the link, i.e., images that will also
3730 be inlined during export. When called with a prefix argument, also display
3731 images that do have a link description. You can ask for inline images to be
3732 displayed at startup by configuring the variable
3733 @code{org-startup-with-inline-images}@footnote{with corresponding
3734 @code{#+STARTUP} keywords @code{inlineimages} and @code{noinlineimages}}.
3735 @orgcmd{C-c %,org-mark-ring-push}
3737 Push the current position onto the mark ring, to be able to return
3738 easily. Commands following an internal link do this automatically.
3740 @orgcmd{C-c &,org-mark-ring-goto}
3741 @cindex links, returning to
3742 Jump back to a recorded position. A position is recorded by the
3743 commands following internal links, and by @kbd{C-c %}. Using this
3744 command several times in direct succession moves through a ring of
3745 previously recorded positions.
3747 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3748 @cindex links, finding next/previous
3749 Move forward/backward to the next link in the buffer. At the limit of
3750 the buffer, the search fails once, and then wraps around. The key
3751 bindings for this are really too long; you might want to bind this also
3752 to @kbd{C-n} and @kbd{C-p}
3754 (add-hook 'org-load-hook
3756 (define-key org-mode-map "\C-n" 'org-next-link)
3757 (define-key org-mode-map "\C-p" 'org-previous-link)))
3761 @node Using links outside Org
3762 @section Using links outside Org
3764 You can insert and follow links that have Org syntax not only in
3765 Org, but in any Emacs buffer. For this, you should create two
3766 global commands, like this (please select suitable global keys
3770 (global-set-key "\C-c L" 'org-insert-link-global)
3771 (global-set-key "\C-c o" 'org-open-at-point-global)
3774 @node Link abbreviations
3775 @section Link abbreviations
3776 @cindex link abbreviations
3777 @cindex abbreviation, links
3779 Long URLs can be cumbersome to type, and often many similar links are
3780 needed in a document. For this you can use link abbreviations. An
3781 abbreviated link looks like this
3784 [[linkword:tag][description]]
3788 @vindex org-link-abbrev-alist
3789 where the tag is optional.
3790 The @i{linkword} must be a word, starting with a letter, followed by
3791 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3792 according to the information in the variable @code{org-link-abbrev-alist}
3793 that relates the linkwords to replacement text. Here is an example:
3797 (setq org-link-abbrev-alist
3798 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3799 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3800 ("google" . "http://www.google.com/search?q=")
3801 ("gmap" . "http://maps.google.com/maps?q=%s")
3802 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3803 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3807 If the replacement text contains the string @samp{%s}, it will be
3808 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3809 url-encode the tag (see the example above, where we need to encode
3810 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3811 to a custom function, and replace it by the resulting string.
3813 If the replacement text doesn't contain any specifier, it will simply
3814 be appended to the string in order to create the link.
3816 Instead of a string, you may also specify a function that will be
3817 called with the tag as the only argument to create the link.
3819 With the above setting, you could link to a specific bug with
3820 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3821 @code{[[google:OrgMode]]}, show the map location of the Free Software
3822 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3823 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3824 what the Org author is doing besides Emacs hacking with
3825 @code{[[ads:Dominik,C]]}.
3827 If you need special abbreviations just for a single Org buffer, you
3828 can define them in the file with
3832 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3833 #+LINK: google http://www.google.com/search?q=%s
3837 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3838 complete link abbreviations. You may also define a function
3839 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3840 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3841 not accept any arguments, and return the full link with prefix.
3843 @node Search options
3844 @section Search options in file links
3845 @cindex search option in file links
3846 @cindex file links, searching
3848 File links can contain additional information to make Emacs jump to a
3849 particular location in the file when following a link. This can be a
3850 line number or a search option after a double@footnote{For backward
3851 compatibility, line numbers can also follow a single colon.} colon. For
3852 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3853 links}) to a file, it encodes the words in the current line as a search
3854 string that can be used to find this line back later when following the
3855 link with @kbd{C-c C-o}.
3857 Here is the syntax of the different ways to attach a search to a file
3858 link, together with an explanation:
3861 [[file:~/code/main.c::255]]
3862 [[file:~/xx.org::My Target]]
3863 [[file:~/xx.org::*My Target]]
3864 [[file:~/xx.org::#my-custom-id]]
3865 [[file:~/xx.org::/regexp/]]
3872 Search for a link target @samp{<<My Target>>}, or do a text search for
3873 @samp{my target}, similar to the search in internal links, see
3874 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3875 link will become an HTML reference to the corresponding named anchor in
3878 In an Org file, restrict search to headlines.
3880 Link to a heading with a @code{CUSTOM_ID} property
3882 Do a regular expression search for @code{regexp}. This uses the Emacs
3883 command @code{occur} to list all matches in a separate window. If the
3884 target file is in Org mode, @code{org-occur} is used to create a
3885 sparse tree with the matches.
3886 @c If the target file is a directory,
3887 @c @code{grep} will be used to search all files in the directory.
3890 As a degenerate case, a file link with an empty file name can be used
3891 to search the current file. For example, @code{[[file:::find me]]} does
3892 a search for @samp{find me} in the current file, just as
3893 @samp{[[find me]]} would.
3895 @node Custom searches
3896 @section Custom Searches
3897 @cindex custom search strings
3898 @cindex search strings, custom
3900 The default mechanism for creating search strings and for doing the
3901 actual search related to a file link may not work correctly in all
3902 cases. For example, Bib@TeX{} database files have many entries like
3903 @samp{year="1993"} which would not result in good search strings,
3904 because the only unique identification for a Bib@TeX{} entry is the
3907 @vindex org-create-file-search-functions
3908 @vindex org-execute-file-search-functions
3909 If you come across such a problem, you can write custom functions to set
3910 the right search string for a particular file type, and to do the search
3911 for the string in the file. Using @code{add-hook}, these functions need
3912 to be added to the hook variables
3913 @code{org-create-file-search-functions} and
3914 @code{org-execute-file-search-functions}. See the docstring for these
3915 variables for more information. Org actually uses this mechanism
3916 for Bib@TeX{} database files, and you can use the corresponding code as
3917 an implementation example. See the file @file{org-bibtex.el}.
3923 Org mode does not maintain TODO lists as separate documents@footnote{Of
3924 course, you can make a document that contains only long lists of TODO items,
3925 but this is not required.}. Instead, TODO items are an integral part of the
3926 notes file, because TODO items usually come up while taking notes! With Org
3927 mode, simply mark any entry in a tree as being a TODO item. In this way,
3928 information is not duplicated, and the entire context from which the TODO
3929 item emerged is always present.
3931 Of course, this technique for managing TODO items scatters them
3932 throughout your notes file. Org mode compensates for this by providing
3933 methods to give you an overview of all the things that you have to do.
3936 * TODO basics:: Marking and displaying TODO entries
3937 * TODO extensions:: Workflow and assignments
3938 * Progress logging:: Dates and notes for progress
3939 * Priorities:: Some things are more important than others
3940 * Breaking down tasks:: Splitting a task into manageable pieces
3941 * Checkboxes:: Tick-off lists
3945 @section Basic TODO functionality
3947 Any headline becomes a TODO item when it starts with the word
3948 @samp{TODO}, for example:
3951 *** TODO Write letter to Sam Fortune
3955 The most important commands to work with TODO entries are:
3958 @orgcmd{C-c C-t,org-todo}
3959 @cindex cycling, of TODO states
3960 @vindex org-use-fast-todo-selection
3962 Rotate the TODO state of the current item among
3965 ,-> (unmarked) -> TODO -> DONE --.
3966 '--------------------------------'
3969 If TODO keywords have fast access keys (see @ref{Fast access to TODO
3970 states}), you will be prompted for a TODO keyword through the fast selection
3971 interface; this is the default behavior when
3972 @code{org-use-fast-todo-selection} is non-@code{nil}.
3974 The same rotation can also be done ``remotely'' from the timeline and agenda
3975 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3977 @orgkey{C-u C-c C-t}
3978 When TODO keywords have no selection keys, select a specific keyword using
3979 completion; otherwise force cycling through TODO states with no prompt. When
3980 @code{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
3981 selection interface.
3983 @kindex S-@key{right}
3984 @kindex S-@key{left}
3985 @item S-@key{right} @ @r{/} @ S-@key{left}
3986 @vindex org-treat-S-cursor-todo-selection-as-state-change
3987 Select the following/preceding TODO state, similar to cycling. Useful
3988 mostly if more than two TODO states are possible (@pxref{TODO
3989 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3990 with @code{shift-selection-mode}. See also the variable
3991 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3992 @orgcmd{C-c / t,org-show-todo-tree}
3993 @cindex sparse tree, for TODO
3994 @vindex org-todo-keywords
3995 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3996 entire buffer, but shows all TODO items (with not-DONE state) and the
3997 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3998 / T}), search for a specific TODO@. You will be prompted for the keyword,
3999 and you can also give a list of keywords like @code{KWD1|KWD2|...} to list
4000 entries that match any one of these keywords. With a numeric prefix argument
4001 N, show the tree for the Nth keyword in the option @code{org-todo-keywords}.
4002 With two prefix arguments, find all TODO states, both un-done and done.
4003 @orgcmd{C-c a t,org-todo-list}
4004 Show the global TODO list. Collects the TODO items (with not-DONE states)
4005 from all agenda files (@pxref{Agenda views}) into a single buffer. The new
4006 buffer will be in @code{agenda-mode}, which provides commands to examine and
4007 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
4008 @xref{Global TODO list}, for more information.
4009 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
4010 Insert a new TODO entry below the current one.
4014 @vindex org-todo-state-tags-triggers
4015 Changing a TODO state can also trigger tag changes. See the docstring of the
4016 option @code{org-todo-state-tags-triggers} for details.
4018 @node TODO extensions
4019 @section Extended use of TODO keywords
4020 @cindex extended TODO keywords
4022 @vindex org-todo-keywords
4023 By default, marked TODO entries have one of only two states: TODO and
4024 DONE@. Org mode allows you to classify TODO items in more complex ways
4025 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
4026 special setup, the TODO keyword system can work differently in different
4029 Note that @i{tags} are another way to classify headlines in general and
4030 TODO items in particular (@pxref{Tags}).
4033 * Workflow states:: From TODO to DONE in steps
4034 * TODO types:: I do this, Fred does the rest
4035 * Multiple sets in one file:: Mixing it all, and still finding your way
4036 * Fast access to TODO states:: Single letter selection of a state
4037 * Per-file keywords:: Different files, different requirements
4038 * Faces for TODO keywords:: Highlighting states
4039 * TODO dependencies:: When one task needs to wait for others
4042 @node Workflow states
4043 @subsection TODO keywords as workflow states
4044 @cindex TODO workflow
4045 @cindex workflow states as TODO keywords
4047 You can use TODO keywords to indicate different @emph{sequential} states
4048 in the process of working on an item, for example@footnote{Changing
4049 this variable only becomes effective after restarting Org mode in a
4053 (setq org-todo-keywords
4054 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
4057 The vertical bar separates the TODO keywords (states that @emph{need
4058 action}) from the DONE states (which need @emph{no further action}). If
4059 you don't provide the separator bar, the last state is used as the DONE
4061 @cindex completion, of TODO keywords
4062 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
4063 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
4064 also use a numeric prefix argument to quickly select a specific state. For
4065 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
4066 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
4067 define many keywords, you can use in-buffer completion
4068 (@pxref{Completion}) or even a special one-key selection scheme
4069 (@pxref{Fast access to TODO states}) to insert these words into the
4070 buffer. Changing a TODO state can be logged with a timestamp, see
4071 @ref{Tracking TODO state changes}, for more information.
4074 @subsection TODO keywords as types
4076 @cindex names as TODO keywords
4077 @cindex types as TODO keywords
4079 The second possibility is to use TODO keywords to indicate different
4080 @emph{types} of action items. For example, you might want to indicate
4081 that items are for ``work'' or ``home''. Or, when you work with several
4082 people on a single project, you might want to assign action items
4083 directly to persons, by using their names as TODO keywords. This would
4084 be set up like this:
4087 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
4090 In this case, different keywords do not indicate a sequence, but rather
4091 different types. So the normal work flow would be to assign a task to a
4092 person, and later to mark it DONE@. Org mode supports this style by adapting
4093 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
4094 @kbd{t} command in the timeline and agenda buffers.}. When used several
4095 times in succession, it will still cycle through all names, in order to first
4096 select the right type for a task. But when you return to the item after some
4097 time and execute @kbd{C-c C-t} again, it will switch from any name directly
4098 to DONE@. Use prefix arguments or completion to quickly select a specific
4099 name. You can also review the items of a specific TODO type in a sparse tree
4100 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
4101 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
4102 from all agenda files into a single buffer, you would use the numeric prefix
4103 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
4105 @node Multiple sets in one file
4106 @subsection Multiple keyword sets in one file
4107 @cindex TODO keyword sets
4109 Sometimes you may want to use different sets of TODO keywords in
4110 parallel. For example, you may want to have the basic
4111 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
4112 separate state indicating that an item has been canceled (so it is not
4113 DONE, but also does not require action). Your setup would then look
4117 (setq org-todo-keywords
4118 '((sequence "TODO" "|" "DONE")
4119 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
4120 (sequence "|" "CANCELED")))
4123 The keywords should all be different, this helps Org mode to keep track
4124 of which subsequence should be used for a given entry. In this setup,
4125 @kbd{C-c C-t} only operates within a subsequence, so it switches from
4126 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
4127 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
4128 select the correct sequence. Besides the obvious ways like typing a
4129 keyword or using completion, you may also apply the following commands:
4132 @kindex C-S-@key{right}
4133 @kindex C-S-@key{left}
4134 @kindex C-u C-u C-c C-t
4135 @item C-u C-u C-c C-t
4136 @itemx C-S-@key{right}
4137 @itemx C-S-@key{left}
4138 These keys jump from one TODO subset to the next. In the above example,
4139 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
4140 @code{DONE} to @code{REPORT}, and any of the words in the second row to
4141 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
4142 @code{shift-selection-mode} (@pxref{Conflicts}).
4143 @kindex S-@key{right}
4144 @kindex S-@key{left}
4147 @kbd{S-@key{left}} and @kbd{S-@key{right}} and walk through @emph{all}
4148 keywords from all sets, so for example @kbd{S-@key{right}} would switch
4149 from @code{DONE} to @code{REPORT} in the example above. See also
4150 @ref{Conflicts}, for a discussion of the interaction with
4151 @code{shift-selection-mode}.
4154 @node Fast access to TODO states
4155 @subsection Fast access to TODO states
4157 If you would like to quickly change an entry to an arbitrary TODO state
4158 instead of cycling through the states, you can set up keys for single-letter
4159 access to the states. This is done by adding the selection character after
4160 each keyword, in parentheses@footnote{All characters are allowed except
4161 @code{@@^!}, which have a special meaning here.}. For example:
4164 (setq org-todo-keywords
4165 '((sequence "TODO(t)" "|" "DONE(d)")
4166 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4167 (sequence "|" "CANCELED(c)")))
4170 @vindex org-fast-tag-selection-include-todo
4171 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4172 will be switched to this state. @kbd{SPC} can be used to remove any TODO
4173 keyword from an entry.@footnote{Check also the option
4174 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4175 state through the tags interface (@pxref{Setting tags}), in case you like to
4176 mingle the two concepts. Note that this means you need to come up with
4177 unique keys across both sets of keywords.}
4179 @node Per-file keywords
4180 @subsection Setting up keywords for individual files
4181 @cindex keyword options
4182 @cindex per-file keywords
4187 It can be very useful to use different aspects of the TODO mechanism in
4188 different files. For file-local settings, you need to add special lines
4189 to the file which set the keywords and interpretation for that file
4190 only. For example, to set one of the two examples discussed above, you
4191 need one of the following lines, starting in column zero anywhere in the
4195 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4197 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4198 interpretation, but it means the same as @code{#+TODO}), or
4200 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4203 A setup for using several sets in parallel would be:
4207 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4211 @cindex completion, of option keywords
4213 @noindent To make sure you are using the correct keyword, type
4214 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4216 @cindex DONE, final TODO keyword
4217 Remember that the keywords after the vertical bar (or the last keyword
4218 if no bar is there) must always mean that the item is DONE (although you
4219 may use a different word). After changing one of these lines, use
4220 @kbd{C-c C-c} with the cursor still in the line to make the changes
4221 known to Org mode@footnote{Org mode parses these lines only when
4222 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
4223 cursor in a line starting with @samp{#+} is simply restarting Org mode
4224 for the current buffer.}.
4226 @node Faces for TODO keywords
4227 @subsection Faces for TODO keywords
4228 @cindex faces, for TODO keywords
4230 @vindex org-todo @r{(face)}
4231 @vindex org-done @r{(face)}
4232 @vindex org-todo-keyword-faces
4233 Org mode highlights TODO keywords with special faces: @code{org-todo}
4234 for keywords indicating that an item still has to be acted upon, and
4235 @code{org-done} for keywords indicating that an item is finished. If
4236 you are using more than 2 different states, you might want to use
4237 special faces for some of them. This can be done using the option
4238 @code{org-todo-keyword-faces}. For example:
4242 (setq org-todo-keyword-faces
4243 '(("TODO" . org-warning) ("STARTED" . "yellow")
4244 ("CANCELED" . (:foreground "blue" :weight bold))))
4248 While using a list with face properties as shown for CANCELED @emph{should}
4249 work, this does not always seem to be the case. If necessary, define a
4250 special face and use that. A string is interpreted as a color. The option
4251 @code{org-faces-easy-properties} determines if that color is interpreted as a
4252 foreground or a background color.
4254 @node TODO dependencies
4255 @subsection TODO dependencies
4256 @cindex TODO dependencies
4257 @cindex dependencies, of TODO states
4259 @vindex org-enforce-todo-dependencies
4260 @cindex property, ORDERED
4261 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4262 dependencies. Usually, a parent TODO task should not be marked DONE until
4263 all subtasks (defined as children tasks) are marked as DONE@. And sometimes
4264 there is a logical sequence to a number of (sub)tasks, so that one task
4265 cannot be acted upon before all siblings above it are done. If you customize
4266 the option @code{org-enforce-todo-dependencies}, Org will block entries
4267 from changing state to DONE while they have children that are not DONE@.
4268 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4269 will be blocked until all earlier siblings are marked DONE@. Here is an
4273 * TODO Blocked until (two) is done
4282 ** TODO b, needs to wait for (a)
4283 ** TODO c, needs to wait for (a) and (b)
4287 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4288 @vindex org-track-ordered-property-with-tag
4289 @cindex property, ORDERED
4290 Toggle the @code{ORDERED} property of the current entry. A property is used
4291 for this behavior because this should be local to the current entry, not
4292 inherited like a tag. However, if you would like to @i{track} the value of
4293 this property with a tag for better visibility, customize the option
4294 @code{org-track-ordered-property-with-tag}.
4295 @orgkey{C-u C-u C-u C-c C-t}
4296 Change TODO state, circumventing any state blocking.
4299 @vindex org-agenda-dim-blocked-tasks
4300 If you set the option @code{org-agenda-dim-blocked-tasks}, TODO entries
4301 that cannot be closed because of such dependencies will be shown in a dimmed
4302 font or even made invisible in agenda views (@pxref{Agenda views}).
4304 @cindex checkboxes and TODO dependencies
4305 @vindex org-enforce-todo-dependencies
4306 You can also block changes of TODO states by looking at checkboxes
4307 (@pxref{Checkboxes}). If you set the option
4308 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4309 checkboxes will be blocked from switching to DONE.
4311 If you need more complex dependency structures, for example dependencies
4312 between entries in different trees or files, check out the contributed
4313 module @file{org-depend.el}.
4316 @node Progress logging
4317 @section Progress logging
4318 @cindex progress logging
4319 @cindex logging, of progress
4321 Org mode can automatically record a timestamp and possibly a note when
4322 you mark a TODO item as DONE, or even each time you change the state of
4323 a TODO item. This system is highly configurable; settings can be on a
4324 per-keyword basis and can be localized to a file or even a subtree. For
4325 information on how to clock working time for a task, see @ref{Clocking
4329 * Closing items:: When was this entry marked DONE?
4330 * Tracking TODO state changes:: When did the status change?
4331 * Tracking your habits:: How consistent have you been?
4335 @subsection Closing items
4337 The most basic logging is to keep track of @emph{when} a certain TODO
4338 item was finished. This is achieved with@footnote{The corresponding
4339 in-buffer setting is: @code{#+STARTUP: logdone}}
4342 (setq org-log-done 'time)
4345 @vindex org-closed-keep-when-no-todo
4347 Then each time you turn an entry from a TODO (not-done) state into any of the
4348 DONE states, a line @samp{CLOSED: [timestamp]} will be inserted just after
4349 the headline. If you turn the entry back into a TODO item through further
4350 state cycling, that line will be removed again. If you turn the entry back
4351 to a non-TODO state (by pressing @key{C-c C-t SPC} for example), that line
4352 will also be removed, unless you set @code{org-closed-keep-when-no-todo} to
4353 non-@code{nil}. If you want to record a note along with the timestamp,
4354 use@footnote{The corresponding in-buffer setting is: @code{#+STARTUP:
4358 (setq org-log-done 'note)
4362 You will then be prompted for a note, and that note will be stored below
4363 the entry with a @samp{Closing Note} heading.
4365 In the timeline (@pxref{Timeline}) and in the agenda
4366 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4367 display the TODO items with a @samp{CLOSED} timestamp on each day,
4368 giving you an overview of what has been done.
4370 @node Tracking TODO state changes
4371 @subsection Tracking TODO state changes
4372 @cindex drawer, for state change recording
4374 @vindex org-log-states-order-reversed
4375 @vindex org-log-into-drawer
4376 @cindex property, LOG_INTO_DRAWER
4377 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4378 might want to keep track of when a state change occurred and maybe take a
4379 note about this change. You can either record just a timestamp, or a
4380 time-stamped note for a change. These records will be inserted after the
4381 headline as an itemized list, newest first@footnote{See the option
4382 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4383 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4384 Customize @code{org-log-into-drawer} to get this behavior---the recommended
4385 drawer for this is called @code{LOGBOOK}@footnote{Note that the
4386 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4387 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4388 overrule the setting of this variable for a subtree by setting a
4389 @code{LOG_INTO_DRAWER} property.
4391 Since it is normally too much to record a note for every state, Org mode
4392 expects configuration on a per-keyword basis for this. This is achieved by
4393 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4394 with timestamp) in parentheses after each keyword. For example, with the
4398 (setq org-todo-keywords
4399 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4402 To record a timestamp without a note for TODO keywords configured with
4403 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4406 @vindex org-log-done
4407 You not only define global TODO keywords and fast access keys, but also
4408 request that a time is recorded when the entry is set to
4409 DONE@footnote{It is possible that Org mode will record two timestamps
4410 when you are using both @code{org-log-done} and state change logging.
4411 However, it will never prompt for two notes---if you have configured
4412 both, the state change recording note will take precedence and cancel
4413 the @samp{Closing Note}.}, and that a note is recorded when switching to
4414 WAIT or CANCELED@. The setting for WAIT is even more special: the
4415 @samp{!} after the slash means that in addition to the note taken when
4416 entering the state, a timestamp should be recorded when @i{leaving} the
4417 WAIT state, if and only if the @i{target} state does not configure
4418 logging for entering it. So it has no effect when switching from WAIT
4419 to DONE, because DONE is configured to record a timestamp only. But
4420 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4421 setting now triggers a timestamp even though TODO has no logging
4424 You can use the exact same syntax for setting logging preferences local
4427 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4430 @cindex property, LOGGING
4431 In order to define logging settings that are local to a subtree or a
4432 single item, define a LOGGING property in this entry. Any non-empty
4433 LOGGING property resets all logging settings to @code{nil}. You may then turn
4434 on logging for this specific tree using STARTUP keywords like
4435 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4436 settings like @code{TODO(!)}. For example
4439 * TODO Log each state with only a time
4441 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4443 * TODO Only log when switching to WAIT, and when repeating
4445 :LOGGING: WAIT(@@) logrepeat
4447 * TODO No logging at all
4453 @node Tracking your habits
4454 @subsection Tracking your habits
4457 Org has the ability to track the consistency of a special category of TODOs,
4458 called ``habits''. A habit has the following properties:
4462 You have enabled the @code{habits} module by customizing @code{org-modules}.
4464 The habit is a TODO item, with a TODO keyword representing an open state.
4466 The property @code{STYLE} is set to the value @code{habit}.
4468 The TODO has a scheduled date, usually with a @code{.+} style repeat
4469 interval. A @code{++} style may be appropriate for habits with time
4470 constraints, e.g., must be done on weekends, or a @code{+} style for an
4471 unusual habit that can have a backlog, e.g., weekly reports.
4473 The TODO may also have minimum and maximum ranges specified by using the
4474 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4475 three days, but at most every two days.
4477 You must also have state logging for the @code{DONE} state enabled
4478 (@pxref{Tracking TODO state changes}), in order for historical data to be
4479 represented in the consistency graph. If it is not enabled it is not an
4480 error, but the consistency graphs will be largely meaningless.
4483 To give you an idea of what the above rules look like in action, here's an
4484 actual habit with some history:
4488 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4489 - State "DONE" from "TODO" [2009-10-15 Thu]
4490 - State "DONE" from "TODO" [2009-10-12 Mon]
4491 - State "DONE" from "TODO" [2009-10-10 Sat]
4492 - State "DONE" from "TODO" [2009-10-04 Sun]
4493 - State "DONE" from "TODO" [2009-10-02 Fri]
4494 - State "DONE" from "TODO" [2009-09-29 Tue]
4495 - State "DONE" from "TODO" [2009-09-25 Fri]
4496 - State "DONE" from "TODO" [2009-09-19 Sat]
4497 - State "DONE" from "TODO" [2009-09-16 Wed]
4498 - State "DONE" from "TODO" [2009-09-12 Sat]
4501 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4505 What this habit says is: I want to shave at most every 2 days (given by the
4506 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4507 today is the 15th, then the habit first appears in the agenda on Oct 17,
4508 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4509 after four days have elapsed.
4511 What's really useful about habits is that they are displayed along with a
4512 consistency graph, to show how consistent you've been at getting that task
4513 done in the past. This graph shows every day that the task was done over the
4514 past three weeks, with colors for each day. The colors used are:
4518 If the task wasn't to be done yet on that day.
4520 If the task could have been done on that day.
4522 If the task was going to be overdue the next day.
4524 If the task was overdue on that day.
4527 In addition to coloring each day, the day is also marked with an asterisk if
4528 the task was actually done that day, and an exclamation mark to show where
4529 the current day falls in the graph.
4531 There are several configuration variables that can be used to change the way
4532 habits are displayed in the agenda.
4535 @item org-habit-graph-column
4536 The buffer column at which the consistency graph should be drawn. This will
4537 overwrite any text in that column, so it is a good idea to keep your habits'
4538 titles brief and to the point.
4539 @item org-habit-preceding-days
4540 The amount of history, in days before today, to appear in consistency graphs.
4541 @item org-habit-following-days
4542 The number of days after today that will appear in consistency graphs.
4543 @item org-habit-show-habits-only-for-today
4544 If non-@code{nil}, only show habits in today's agenda view. This is set to true by
4548 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4549 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4550 bring them back. They are also subject to tag filtering, if you have habits
4551 which should only be done in certain contexts, for example.
4557 If you use Org mode extensively, you may end up with enough TODO items that
4558 it starts to make sense to prioritize them. Prioritizing can be done by
4559 placing a @emph{priority cookie} into the headline of a TODO item, like this
4562 *** TODO [#A] Write letter to Sam Fortune
4566 @vindex org-priority-faces
4567 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4568 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4569 treated just like priority @samp{B}. Priorities make a difference only for
4570 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4571 have no inherent meaning to Org mode. The cookies can be highlighted with
4572 special faces by customizing @code{org-priority-faces}.
4574 Priorities can be attached to any outline node; they do not need to be TODO
4580 @findex org-priority
4581 Set the priority of the current headline (@command{org-priority}). The
4582 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4583 When you press @key{SPC} instead, the priority cookie is removed from the
4584 headline. The priorities can also be changed ``remotely'' from the timeline
4585 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4587 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4588 @vindex org-priority-start-cycle-with-default
4589 Increase/decrease priority of current headline@footnote{See also the option
4590 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4591 also used to modify timestamps (@pxref{Creating timestamps}). See also
4592 @ref{Conflicts}, for a discussion of the interaction with
4593 @code{shift-selection-mode}.
4596 @vindex org-highest-priority
4597 @vindex org-lowest-priority
4598 @vindex org-default-priority
4599 You can change the range of allowed priorities by setting the options
4600 @code{org-highest-priority}, @code{org-lowest-priority}, and
4601 @code{org-default-priority}. For an individual buffer, you may set
4602 these values (highest, lowest, default) like this (please make sure that
4603 the highest priority is earlier in the alphabet than the lowest
4606 @cindex #+PRIORITIES
4611 @node Breaking down tasks
4612 @section Breaking tasks down into subtasks
4613 @cindex tasks, breaking down
4614 @cindex statistics, for TODO items
4616 @vindex org-agenda-todo-list-sublevels
4617 It is often advisable to break down large tasks into smaller, manageable
4618 subtasks. You can do this by creating an outline tree below a TODO item,
4619 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4620 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4621 the overview over the fraction of subtasks that are already completed, insert
4622 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4623 be updated each time the TODO status of a child changes, or when pressing
4624 @kbd{C-c C-c} on the cookie. For example:
4627 * Organize Party [33%]
4628 ** TODO Call people [1/2]
4632 ** DONE Talk to neighbor
4635 @cindex property, COOKIE_DATA
4636 If a heading has both checkboxes and TODO children below it, the meaning of
4637 the statistics cookie become ambiguous. Set the property
4638 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4641 @vindex org-hierarchical-todo-statistics
4642 If you would like to have the statistics cookie count any TODO entries in the
4643 subtree (not just direct children), configure
4644 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4645 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4649 * Parent capturing statistics [2/20]
4651 :COOKIE_DATA: todo recursive
4655 If you would like a TODO entry to automatically change to DONE
4656 when all children are done, you can use the following setup:
4659 (defun org-summary-todo (n-done n-not-done)
4660 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4661 (let (org-log-done org-log-states) ; turn off logging
4662 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4664 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4668 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4669 large number of subtasks (@pxref{Checkboxes}).
4676 @vindex org-list-automatic-rules
4677 Every item in a plain list@footnote{With the exception of description
4678 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4679 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4680 it with the string @samp{[ ]}. This feature is similar to TODO items
4681 (@pxref{TODO items}), but is more lightweight. Checkboxes are not included
4682 in the global TODO list, so they are often great to split a task into a
4683 number of simple steps. Or you can use them in a shopping list. To toggle a
4684 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4685 @file{org-mouse.el}).
4687 Here is an example of a checkbox list.
4690 * TODO Organize party [2/4]
4691 - [-] call people [1/3]
4696 - [ ] think about what music to play
4697 - [X] talk to the neighbors
4700 Checkboxes work hierarchically, so if a checkbox item has children that
4701 are checkboxes, toggling one of the children checkboxes will make the
4702 parent checkbox reflect if none, some, or all of the children are
4705 @cindex statistics, for checkboxes
4706 @cindex checkbox statistics
4707 @cindex property, COOKIE_DATA
4708 @vindex org-checkbox-hierarchical-statistics
4709 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4710 indicating how many checkboxes present in this entry have been checked off,
4711 and the total number of checkboxes present. This can give you an idea on how
4712 many checkboxes remain, even without opening a folded entry. The cookies can
4713 be placed into a headline or into (the first line of) a plain list item.
4714 Each cookie covers checkboxes of direct children structurally below the
4715 headline/item on which the cookie appears@footnote{Set the option
4716 @code{org-checkbox-hierarchical-statistics} if you want such cookies to
4717 count all checkboxes below the cookie, not just those belonging to direct
4718 children.}. You have to insert the cookie yourself by typing either
4719 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4720 result, as in the examples above. With @samp{[%]} you get information about
4721 the percentage of checkboxes checked (in the above example, this would be
4722 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4723 count either checkboxes below the heading or TODO states of children, and it
4724 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4725 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4727 @cindex blocking, of checkboxes
4728 @cindex checkbox blocking
4729 @cindex property, ORDERED
4730 If the current outline node has an @code{ORDERED} property, checkboxes must
4731 be checked off in sequence, and an error will be thrown if you try to check
4732 off a box while there are unchecked boxes above it.
4734 @noindent The following commands work with checkboxes:
4737 @orgcmd{C-c C-c,org-toggle-checkbox}
4738 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4739 With a single prefix argument, add an empty checkbox or remove the current
4740 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4741 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4742 considered to be an intermediate state.
4743 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4744 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4745 double prefix argument, set it to @samp{[-]}, which is considered to be an
4749 If there is an active region, toggle the first checkbox in the region
4750 and set all remaining boxes to the same status as the first. With a prefix
4751 arg, add or remove the checkbox for all items in the region.
4753 If the cursor is in a headline, toggle checkboxes in the region between
4754 this headline and the next (so @emph{not} the entire subtree).
4756 If there is no active region, just toggle the checkbox at point.
4758 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4759 Insert a new item with a checkbox. This works only if the cursor is already
4760 in a plain list item (@pxref{Plain lists}).
4761 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4762 @vindex org-track-ordered-property-with-tag
4763 @cindex property, ORDERED
4764 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4765 be checked off in sequence. A property is used for this behavior because
4766 this should be local to the current entry, not inherited like a tag.
4767 However, if you would like to @i{track} the value of this property with a tag
4768 for better visibility, customize @code{org-track-ordered-property-with-tag}.
4769 @orgcmd{C-c #,org-update-statistics-cookies}
4770 Update the statistics cookie in the current outline entry. When called with
4771 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4772 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4773 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4774 changing TODO states. If you delete boxes/entries or add/change them by
4775 hand, use this command to get things back into sync.
4781 @cindex headline tagging
4782 @cindex matching, tags
4783 @cindex sparse tree, tag based
4785 An excellent way to implement labels and contexts for cross-correlating
4786 information is to assign @i{tags} to headlines. Org mode has extensive
4789 @vindex org-tag-faces
4790 Every headline can contain a list of tags; they occur at the end of the
4791 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4792 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4793 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4794 Tags will by default be in bold face with the same color as the headline.
4795 You may specify special faces for specific tags using the option
4796 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4797 (@pxref{Faces for TODO keywords}).
4800 * Tag inheritance:: Tags use the tree structure of the outline
4801 * Setting tags:: How to assign tags to a headline
4802 * Tag groups:: Use one tag to search for several tags
4803 * Tag searches:: Searching for combinations of tags
4806 @node Tag inheritance
4807 @section Tag inheritance
4808 @cindex tag inheritance
4809 @cindex inheritance, of tags
4810 @cindex sublevels, inclusion into tags match
4812 @i{Tags} make use of the hierarchical structure of outline trees. If a
4813 heading has a certain tag, all subheadings will inherit the tag as
4814 well. For example, in the list
4817 * Meeting with the French group :work:
4818 ** Summary by Frank :boss:notes:
4819 *** TODO Prepare slides for him :action:
4823 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4824 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4825 explicitly marked with those tags. You can also set tags that all entries in
4826 a file should inherit just as if these tags were defined in a hypothetical
4827 level zero that surrounds the entire file. Use a line like this@footnote{As
4828 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4829 changes in the line.}:
4833 #+FILETAGS: :Peter:Boss:Secret:
4837 @vindex org-use-tag-inheritance
4838 @vindex org-tags-exclude-from-inheritance
4839 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4840 To turn it off entirely, use @code{org-use-tag-inheritance}.
4842 @vindex org-tags-match-list-sublevels
4843 When a headline matches during a tags search while tag inheritance is turned
4844 on, all the sublevels in the same tree will (for a simple match form) match
4845 as well@footnote{This is only true if the search does not involve more
4846 complex tests including properties (@pxref{Property searches}).}. The list
4847 of matches may then become very long. If you only want to see the first tags
4848 match in a subtree, configure @code{org-tags-match-list-sublevels} (not
4851 @vindex org-agenda-use-tag-inheritance
4852 Tag inheritance is relevant when the agenda search tries to match a tag,
4853 either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4854 types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4855 have your tags correctly set in the agenda, so that tag filtering works fine,
4856 with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4857 this: the default value includes all agenda types, but setting this to @code{nil}
4858 can really speed up agenda generation.
4861 @section Setting tags
4862 @cindex setting tags
4863 @cindex tags, setting
4866 Tags can simply be typed into the buffer at the end of a headline.
4867 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4868 also a special command for inserting tags:
4871 @orgcmd{C-c C-q,org-set-tags-command}
4872 @cindex completion, of tags
4873 @vindex org-tags-column
4874 Enter new tags for the current headline. Org mode will either offer
4875 completion or a special single-key interface for setting tags, see
4876 below. After pressing @key{RET}, the tags will be inserted and aligned
4877 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4878 tags in the current buffer will be aligned to that column, just to make
4879 things look nice. TAGS are automatically realigned after promotion,
4880 demotion, and TODO state changes (@pxref{TODO basics}).
4882 @orgcmd{C-c C-c,org-set-tags-command}
4883 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4886 @vindex org-tag-alist
4887 Org supports tag insertion based on a @emph{list of tags}. By
4888 default this list is constructed dynamically, containing all tags
4889 currently used in the buffer. You may also globally specify a hard list
4890 of tags with the variable @code{org-tag-alist}. Finally you can set
4891 the default tags for a given file with lines like
4895 #+TAGS: @@work @@home @@tennisclub
4896 #+TAGS: laptop car pc sailboat
4899 If you have globally defined your preferred set of tags using the
4900 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4901 in a specific file, add an empty TAGS option line to that file:
4907 @vindex org-tag-persistent-alist
4908 If you have a preferred set of tags that you would like to use in every file,
4909 in addition to those defined on a per-file basis by TAGS option lines, then
4910 you may specify a list of tags with the variable
4911 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4912 by adding a STARTUP option line to that file:
4918 By default Org mode uses the standard minibuffer completion facilities for
4919 entering tags. However, it also implements another, quicker, tag selection
4920 method called @emph{fast tag selection}. This allows you to select and
4921 deselect tags with just a single key press. For this to work well you should
4922 assign unique letters to most of your commonly used tags. You can do this
4923 globally by configuring the variable @code{org-tag-alist} in your
4924 @file{.emacs} file. For example, you may find the need to tag many items in
4925 different files with @samp{:@@home:}. In this case you can set something
4929 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4932 @noindent If the tag is only relevant to the file you are working on, then you
4933 can instead set the TAGS option line as:
4936 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4939 @noindent The tags interface will show the available tags in a splash
4940 window. If you want to start a new line after a specific tag, insert
4941 @samp{\n} into the tag list
4944 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4947 @noindent or write them in two lines:
4950 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4951 #+TAGS: laptop(l) pc(p)
4955 You can also group together tags that are mutually exclusive by using
4959 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4962 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4963 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4965 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4966 these lines to activate any changes.
4969 To set these mutually exclusive groups in the variable @code{org-tag-alist},
4970 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4971 of the braces. Similarly, you can use @code{:newline} to indicate a line
4972 break. The previous example would be set globally by the following
4976 (setq org-tag-alist '((:startgroup . nil)
4977 ("@@work" . ?w) ("@@home" . ?h)
4978 ("@@tennisclub" . ?t)
4980 ("laptop" . ?l) ("pc" . ?p)))
4983 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4984 automatically present you with a special interface, listing inherited tags,
4985 the tags of the current headline, and a list of all valid tags with
4986 corresponding keys@footnote{Keys will automatically be assigned to tags which
4987 have no configured keys.}. In this interface, you can use the following
4992 Pressing keys assigned to tags will add or remove them from the list of
4993 tags in the current line. Selecting a tag in a group of mutually
4994 exclusive tags will turn off any other tags from that group.
4997 Enter a tag in the minibuffer, even if the tag is not in the predefined
4998 list. You will be able to complete on all tags present in the buffer.
4999 You can also add several tags: just separate them with a comma.
5003 Clear all tags for this line.
5006 Accept the modified set.
5008 Abort without installing changes.
5010 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
5012 Turn off groups of mutually exclusive tags. Use this to (as an
5013 exception) assign several tags from such a group.
5015 Toggle auto-exit after the next change (see below).
5016 If you are using expert mode, the first @kbd{C-c} will display the
5021 This method lets you assign tags to a headline with very few keys. With
5022 the above setup, you could clear the current tags and set @samp{@@home},
5023 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
5024 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
5025 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
5026 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
5027 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
5028 @key{RET} @key{RET}}.
5030 @vindex org-fast-tag-selection-single-key
5031 If you find that most of the time you need only a single key press to
5032 modify your list of tags, set @code{org-fast-tag-selection-single-key}.
5033 Then you no longer have to press @key{RET} to exit fast tag selection---it
5034 will immediately exit after the first change. If you then occasionally
5035 need more keys, press @kbd{C-c} to turn off auto-exit for the current tag
5036 selection process (in effect: start selection with @kbd{C-c C-c C-c}
5037 instead of @kbd{C-c C-c}). If you set the variable to the value
5038 @code{expert}, the special window is not even shown for single-key tag
5039 selection, it comes up only when you press an extra @kbd{C-c}.
5045 @cindex tags, groups
5046 In a set of mutually exclusive tags, the first tag can be defined as a
5047 @emph{group tag}. When you search for a group tag, it will return matches
5048 for all members in the group. In an agenda view, filtering by a group tag
5049 will display headlines tagged with at least one of the members of the
5050 group. This makes tag searches and filters even more flexible.
5052 You can set group tags by inserting a colon between the group tag and other
5053 tags---beware that all whitespaces are mandatory so that Org can parse this
5057 #+TAGS: @{ @@read : @@read_book @@read_ebook @}
5060 In this example, @samp{@@read} is a @emph{group tag} for a set of three
5061 tags: @samp{@@read}, @samp{@@read_book} and @samp{@@read_ebook}.
5063 You can also use the @code{:grouptags} keyword directly when setting
5064 @code{org-tag-alist}:
5067 (setq org-tag-alist '((:startgroup . nil)
5070 ("@@read_book" . nil)
5071 ("@@read_ebook" . nil)
5075 You cannot nest group tags or use a group tag as a tag in another group.
5078 @vindex org-group-tags
5079 If you want to ignore group tags temporarily, toggle group tags support
5080 with @command{org-toggle-tags-groups}, bound to @kbd{C-c C-x q}. If you
5081 want to disable tag groups completely, set @code{org-group-tags} to @code{nil}.
5084 @section Tag searches
5085 @cindex tag searches
5086 @cindex searching for tags
5088 Once a system of tags has been set up, it can be used to collect related
5089 information into special lists.
5092 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5093 Create a sparse tree with all headlines matching a tags/property/TODO search.
5094 With a @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5095 @xref{Matching tags and properties}.
5096 @orgcmd{C-c a m,org-tags-view}
5097 Create a global list of tag matches from all agenda files. @xref{Matching
5098 tags and properties}.
5099 @orgcmd{C-c a M,org-tags-view}
5100 @vindex org-tags-match-list-sublevels
5101 Create a global list of tag matches from all agenda files, but check
5102 only TODO items and force checking subitems (see the option
5103 @code{org-tags-match-list-sublevels}).
5106 These commands all prompt for a match string which allows basic Boolean logic
5107 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
5108 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
5109 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
5110 string is rich and allows also matching against TODO keywords, entry levels
5111 and properties. For a complete description with many examples, see
5112 @ref{Matching tags and properties}.
5115 @node Properties and columns
5116 @chapter Properties and columns
5119 A property is a key-value pair associated with an entry. Properties can be
5120 set so they are associated with a single entry, with every entry in a tree,
5121 or with every entry in an Org mode file.
5123 There are two main applications for properties in Org mode. First,
5124 properties are like tags, but with a value. Imagine maintaining a file where
5125 you document bugs and plan releases for a piece of software. Instead of
5126 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
5127 property, say @code{:Release:}, that in different subtrees has different
5128 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
5129 implement (very basic) database capabilities in an Org buffer. Imagine
5130 keeping track of your music CDs, where properties could be things such as the
5131 album, artist, date of release, number of tracks, and so on.
5133 Properties can be conveniently edited and viewed in column view
5134 (@pxref{Column view}).
5137 * Property syntax:: How properties are spelled out
5138 * Special properties:: Access to other Org mode features
5139 * Property searches:: Matching property values
5140 * Property inheritance:: Passing values down the tree
5141 * Column view:: Tabular viewing and editing
5142 * Property API:: Properties for Lisp programmers
5145 @node Property syntax
5146 @section Property syntax
5147 @cindex property syntax
5148 @cindex drawer, for properties
5150 Properties are key-value pairs. When they are associated with a single entry
5151 or with a tree they need to be inserted into a special
5152 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
5153 is specified on a single line, with the key (surrounded by colons)
5154 first, and the value after it. Here is an example:
5159 *** Goldberg Variations
5161 :Title: Goldberg Variations
5162 :Composer: J.S. Bach
5164 :Publisher: Deutsche Grammophon
5169 Depending on the value of @code{org-use-property-inheritance}, a property set
5170 this way will either be associated with a single entry, or the sub-tree
5171 defined by the entry, see @ref{Property inheritance}.
5173 You may define the allowed values for a particular property @samp{:Xyz:}
5174 by setting a property @samp{:Xyz_ALL:}. This special property is
5175 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
5176 the entire tree. When allowed values are defined, setting the
5177 corresponding property becomes easier and is less prone to typing
5178 errors. For the example with the CD collection, we can predefine
5179 publishers and the number of disks in a box like this:
5184 :NDisks_ALL: 1 2 3 4
5185 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
5189 If you want to set properties that can be inherited by any entry in a
5190 file, use a line like
5191 @cindex property, _ALL
5194 #+PROPERTY: NDisks_ALL 1 2 3 4
5197 Contrary to properties set from a special drawer, you have to refresh the
5198 buffer with @kbd{C-c C-c} to activate this change.
5200 If you want to add to the value of an existing property, append a @code{+} to
5201 the property name. The following results in the property @code{var} having
5202 the value ``foo=1 bar=2''.
5205 #+PROPERTY: var foo=1
5206 #+PROPERTY: var+ bar=2
5209 It is also possible to add to the values of inherited properties. The
5210 following results in the @code{genres} property having the value ``Classic
5211 Baroque'' under the @code{Goldberg Variations} subtree.
5219 *** Goldberg Variations
5221 :Title: Goldberg Variations
5222 :Composer: J.S. Bach
5224 :Publisher: Deutsche Grammophon
5229 Note that a property can only have one entry per Drawer.
5231 @vindex org-global-properties
5232 Property values set with the global variable
5233 @code{org-global-properties} can be inherited by all entries in all
5237 The following commands help to work with properties:
5240 @orgcmd{M-@key{TAB},pcomplete}
5241 After an initial colon in a line, complete property keys. All keys used
5242 in the current file will be offered as possible completions.
5243 @orgcmd{C-c C-x p,org-set-property}
5244 Set a property. This prompts for a property name and a value. If
5245 necessary, the property drawer is created as well.
5246 @item C-u M-x org-insert-drawer RET
5247 @cindex org-insert-drawer
5248 Insert a property drawer into the current entry. The drawer will be
5249 inserted early in the entry, but after the lines with planning
5250 information like deadlines.
5251 @orgcmd{C-c C-c,org-property-action}
5252 With the cursor in a property drawer, this executes property commands.
5253 @orgcmd{C-c C-c s,org-set-property}
5254 Set a property in the current entry. Both the property and the value
5255 can be inserted using completion.
5256 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5257 Switch property at point to the next/previous allowed value.
5258 @orgcmd{C-c C-c d,org-delete-property}
5259 Remove a property from the current entry.
5260 @orgcmd{C-c C-c D,org-delete-property-globally}
5261 Globally remove a property, from all entries in the current file.
5262 @orgcmd{C-c C-c c,org-compute-property-at-point}
5263 Compute the property at point, using the operator and scope from the
5264 nearest column format definition.
5267 @node Special properties
5268 @section Special properties
5269 @cindex properties, special
5271 Special properties provide an alternative access method to Org mode features,
5272 like the TODO state or the priority of an entry, discussed in the previous
5273 chapters. This interface exists so that you can include these states in a
5274 column view (@pxref{Column view}), or to use them in queries. The following
5275 property names are special and (except for @code{:CATEGORY:}) should not be
5276 used as keys in the properties drawer:
5278 @cindex property, special, ID
5279 @cindex property, special, TODO
5280 @cindex property, special, TAGS
5281 @cindex property, special, ALLTAGS
5282 @cindex property, special, CATEGORY
5283 @cindex property, special, PRIORITY
5284 @cindex property, special, DEADLINE
5285 @cindex property, special, SCHEDULED
5286 @cindex property, special, CLOSED
5287 @cindex property, special, TIMESTAMP
5288 @cindex property, special, TIMESTAMP_IA
5289 @cindex property, special, CLOCKSUM
5290 @cindex property, special, CLOCKSUM_T
5291 @cindex property, special, BLOCKED
5292 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5293 @cindex property, special, ITEM
5294 @cindex property, special, FILE
5296 ID @r{A globally unique ID used for synchronization during}
5297 @r{iCalendar or MobileOrg export.}
5298 TODO @r{The TODO keyword of the entry.}
5299 TAGS @r{The tags defined directly in the headline.}
5300 ALLTAGS @r{All tags, including inherited ones.}
5301 CATEGORY @r{The category of an entry.}
5302 PRIORITY @r{The priority of the entry, a string with a single letter.}
5303 DEADLINE @r{The deadline time string, without the angular brackets.}
5304 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5305 CLOSED @r{When was this entry closed?}
5306 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5307 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5308 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5309 @r{must be run first to compute the values in the current buffer.}
5310 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5311 @r{@code{org-clock-sum-today} must be run first to compute the}
5312 @r{values in the current buffer.}
5313 BLOCKED @r{"t" if task is currently blocked by children or siblings}
5314 ITEM @r{The headline of the entry.}
5315 FILE @r{The filename the entry is located in.}
5318 @node Property searches
5319 @section Property searches
5320 @cindex properties, searching
5321 @cindex searching, of properties
5323 To create sparse trees and special lists with selection based on properties,
5324 the same commands are used as for tag searches (@pxref{Tag searches}).
5327 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5328 Create a sparse tree with all matching entries. With a
5329 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5330 @orgcmd{C-c a m,org-tags-view}
5331 Create a global list of tag/property matches from all agenda files.
5332 @xref{Matching tags and properties}.
5333 @orgcmd{C-c a M,org-tags-view}
5334 @vindex org-tags-match-list-sublevels
5335 Create a global list of tag matches from all agenda files, but check
5336 only TODO items and force checking of subitems (see the option
5337 @code{org-tags-match-list-sublevels}).
5340 The syntax for the search string is described in @ref{Matching tags and
5343 There is also a special command for creating sparse trees based on a
5348 Create a sparse tree based on the value of a property. This first
5349 prompts for the name of a property, and then for a value. A sparse tree
5350 is created with all entries that define this property with the given
5351 value. If you enclose the value in curly braces, it is interpreted as
5352 a regular expression and matched against the property values.
5355 @node Property inheritance
5356 @section Property Inheritance
5357 @cindex properties, inheritance
5358 @cindex inheritance, of properties
5360 @vindex org-use-property-inheritance
5361 The outline structure of Org mode documents lends itself to an
5362 inheritance model of properties: if the parent in a tree has a certain
5363 property, the children can inherit this property. Org mode does not
5364 turn this on by default, because it can slow down property searches
5365 significantly and is often not needed. However, if you find inheritance
5366 useful, you can turn it on by setting the variable
5367 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5368 all properties inherited from the parent, to a list of properties
5369 that should be inherited, or to a regular expression that matches
5370 inherited properties. If a property has the value @code{nil}, this is
5371 interpreted as an explicit undefine of the property, so that inheritance
5372 search will stop at this value and return @code{nil}.
5374 Org mode has a few properties for which inheritance is hard-coded, at
5375 least for the special applications for which they are used:
5377 @cindex property, COLUMNS
5380 The @code{:COLUMNS:} property defines the format of column view
5381 (@pxref{Column view}). It is inherited in the sense that the level
5382 where a @code{:COLUMNS:} property is defined is used as the starting
5383 point for a column view table, independently of the location in the
5384 subtree from where columns view is turned on.
5386 @cindex property, CATEGORY
5387 For agenda view, a category set through a @code{:CATEGORY:} property
5388 applies to the entire subtree.
5390 @cindex property, ARCHIVE
5391 For archiving, the @code{:ARCHIVE:} property may define the archive
5392 location for the entire subtree (@pxref{Moving subtrees}).
5394 @cindex property, LOGGING
5395 The LOGGING property may define logging settings for an entry or a
5396 subtree (@pxref{Tracking TODO state changes}).
5400 @section Column view
5402 A great way to view and edit properties in an outline tree is
5403 @emph{column view}. In column view, each outline node is turned into a
5404 table row. Columns in this table provide access to properties of the
5405 entries. Org mode implements columns by overlaying a tabular structure
5406 over the headline of each item. While the headlines have been turned
5407 into a table row, you can still change the visibility of the outline
5408 tree. For example, you get a compact table by switching to CONTENTS
5409 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5410 is active), but you can still open, read, and edit the entry below each
5411 headline. Or, you can switch to column view after executing a sparse
5412 tree command and in this way get a table only for the selected items.
5413 Column view also works in agenda buffers (@pxref{Agenda views}) where
5414 queries have collected selected items, possibly from a number of files.
5417 * Defining columns:: The COLUMNS format property
5418 * Using column view:: How to create and use column view
5419 * Capturing column view:: A dynamic block for column view
5422 @node Defining columns
5423 @subsection Defining columns
5424 @cindex column view, for properties
5425 @cindex properties, column view
5427 Setting up a column view first requires defining the columns. This is
5428 done by defining a column format line.
5431 * Scope of column definitions:: Where defined, where valid?
5432 * Column attributes:: Appearance and content of a column
5435 @node Scope of column definitions
5436 @subsubsection Scope of column definitions
5438 To define a column format for an entire file, use a line like
5442 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5445 To specify a format that only applies to a specific tree, add a
5446 @code{:COLUMNS:} property to the top node of that tree, for example:
5449 ** Top node for columns view
5451 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5455 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5456 for the entry itself, and for the entire subtree below it. Since the
5457 column definition is part of the hierarchical structure of the document,
5458 you can define columns on level 1 that are general enough for all
5459 sublevels, and more specific columns further down, when you edit a
5460 deeper part of the tree.
5462 @node Column attributes
5463 @subsubsection Column attributes
5464 A column definition sets the attributes of a column. The general
5465 definition looks like this:
5468 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5472 Except for the percent sign and the property name, all items are
5473 optional. The individual parts have the following meaning:
5476 @var{width} @r{An integer specifying the width of the column in characters.}
5477 @r{If omitted, the width will be determined automatically.}
5478 @var{property} @r{The property that should be edited in this column.}
5479 @r{Special properties representing meta data are allowed here}
5480 @r{as well (@pxref{Special properties})}
5481 @var{title} @r{The header text for the column. If omitted, the property}
5483 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5484 @r{parent nodes are computed from the children.}
5485 @r{Supported summary types are:}
5486 @{+@} @r{Sum numbers in this column.}
5487 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5488 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5489 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5490 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5491 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5492 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5493 @{min@} @r{Smallest number in column.}
5494 @{max@} @r{Largest number.}
5495 @{mean@} @r{Arithmetic mean of numbers.}
5496 @{:min@} @r{Smallest time value in column.}
5497 @{:max@} @r{Largest time value.}
5498 @{:mean@} @r{Arithmetic mean of time values.}
5499 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5500 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5501 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5502 @{est+@} @r{Add low-high estimates.}
5506 Be aware that you can only have one summary type for any property you
5507 include. Subsequent columns referencing the same property will all display the
5508 same summary information.
5510 The @code{est+} summary type requires further explanation. It is used for
5511 combining estimates, expressed as low-high ranges. For example, instead
5512 of estimating a particular task will take 5 days, you might estimate it as
5513 5--6 days if you're fairly confident you know how much work is required, or
5514 1--10 days if you don't really know what needs to be done. Both ranges
5515 average at 5.5 days, but the first represents a more predictable delivery.
5517 When combining a set of such estimates, simply adding the lows and highs
5518 produces an unrealistically wide result. Instead, @code{est+} adds the
5519 statistical mean and variance of the sub-tasks, generating a final estimate
5520 from the sum. For example, suppose you had ten tasks, each of which was
5521 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5522 of 5 to 20 days, representing what to expect if everything goes either
5523 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5524 full job more realistically, at 10--15 days.
5526 Here is an example for a complete columns definition, along with allowed
5530 :COLUMNS: %25ITEM %9Approved(Approved?)@{X@} %Owner %11Status \@footnote{Please note that the COLUMNS definition must be on a single line---it is wrapped here only because of formatting constraints.}
5531 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5532 :Owner_ALL: Tammy Mark Karl Lisa Don
5533 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5534 :Approved_ALL: "[ ]" "[X]"
5538 The first column, @samp{%25ITEM}, means the first 25 characters of the
5539 item itself, i.e., of the headline. You probably always should start the
5540 column definition with the @samp{ITEM} specifier. The other specifiers
5541 create columns @samp{Owner} with a list of names as allowed values, for
5542 @samp{Status} with four different possible values, and for a checkbox
5543 field @samp{Approved}. When no width is given after the @samp{%}
5544 character, the column will be exactly as wide as it needs to be in order
5545 to fully display all values. The @samp{Approved} column does have a
5546 modified title (@samp{Approved?}, with a question mark). Summaries will
5547 be created for the @samp{Time_Estimate} column by adding time duration
5548 expressions like HH:MM, and for the @samp{Approved} column, by providing
5549 an @samp{[X]} status if all children have been checked. The
5550 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5551 sums of CLOCK intervals in the subtree, either for all clocks or just for
5554 @node Using column view
5555 @subsection Using column view
5558 @tsubheading{Turning column view on and off}
5559 @orgcmd{C-c C-x C-c,org-columns}
5560 @vindex org-columns-default-format
5561 Turn on column view. If the cursor is before the first headline in the file,
5562 column view is turned on for the entire file, using the @code{#+COLUMNS}
5563 definition. If the cursor is somewhere inside the outline, this command
5564 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5565 defines a format. When one is found, the column view table is established
5566 for the tree starting at the entry that contains the @code{:COLUMNS:}
5567 property. If no such property is found, the format is taken from the
5568 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5569 and column view is established for the current entry and its subtree.
5570 @orgcmd{r,org-columns-redo}
5571 Recreate the column view, to include recent changes made in the buffer.
5572 @orgcmd{g,org-columns-redo}
5574 @orgcmd{q,org-columns-quit}
5576 @tsubheading{Editing values}
5577 @item @key{left} @key{right} @key{up} @key{down}
5578 Move through the column view from field to field.
5579 @kindex S-@key{left}
5580 @kindex S-@key{right}
5581 @item S-@key{left}/@key{right}
5582 Switch to the next/previous allowed value of the field. For this, you
5583 have to have specified allowed values for a property.
5585 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5586 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5587 Same as @kbd{S-@key{left}/@key{right}}
5588 @orgcmd{e,org-columns-edit-value}
5589 Edit the property at point. For the special properties, this will
5590 invoke the same interface that you normally use to change that
5591 property. For example, when editing a TAGS property, the tag completion
5592 or fast selection interface will pop up.
5593 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5594 When there is a checkbox at point, toggle it.
5595 @orgcmd{v,org-columns-show-value}
5596 View the full value of this property. This is useful if the width of
5597 the column is smaller than that of the value.
5598 @orgcmd{a,org-columns-edit-allowed}
5599 Edit the list of allowed values for this property. If the list is found
5600 in the hierarchy, the modified value is stored there. If no list is
5601 found, the new value is stored in the first entry that is part of the
5602 current column view.
5603 @tsubheading{Modifying the table structure}
5604 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5605 Make the column narrower/wider by one character.
5606 @orgcmd{S-M-@key{right},org-columns-new}
5607 Insert a new column, to the left of the current column.
5608 @orgcmd{S-M-@key{left},org-columns-delete}
5609 Delete the current column.
5612 @node Capturing column view
5613 @subsection Capturing column view
5615 Since column view is just an overlay over a buffer, it cannot be
5616 exported or printed directly. If you want to capture a column view, use
5617 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5618 of this block looks like this:
5620 @cindex #+BEGIN, columnview
5623 #+BEGIN: columnview :hlines 1 :id "label"
5628 @noindent This dynamic block has the following parameters:
5632 This is the most important parameter. Column view is a feature that is
5633 often localized to a certain (sub)tree, and the capture block might be
5634 at a different location in the file. To identify the tree whose view to
5635 capture, you can use 4 values:
5636 @cindex property, ID
5638 local @r{use the tree in which the capture block is located}
5639 global @r{make a global view, including all headings in the file}
5640 "file:@var{path-to-file}"
5641 @r{run column view at the top of this file}
5642 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5643 @r{property with the value @i{label}. You can use}
5644 @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for}
5645 @r{the current entry and copy it to the kill-ring.}
5648 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5649 an hline before each headline with level @code{<= @var{N}}.
5651 When set to @code{t}, force column groups to get vertical lines.
5653 When set to a number, don't capture entries below this level.
5654 @item :skip-empty-rows
5655 When set to @code{t}, skip rows where the only non-empty specifier of the
5656 column view is @code{ITEM}.
5661 The following commands insert or update the dynamic block:
5664 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5665 Insert a dynamic block capturing a column view. You will be prompted
5666 for the scope or ID of the view.
5667 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5668 Update dynamic block at point. The cursor needs to be in the
5669 @code{#+BEGIN} line of the dynamic block.
5670 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5671 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5672 you have several clock table blocks, column-capturing blocks or other dynamic
5676 You can add formulas to the column view table and you may add plotting
5677 instructions in front of the table---these will survive an update of the
5678 block. If there is a @code{#+TBLFM:} after the table, the table will
5679 actually be recalculated automatically after an update.
5681 An alternative way to capture and process property values into a table is
5682 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5683 package@footnote{Contributed packages are not part of Emacs, but are
5684 distributed with the main distribution of Org (visit
5685 @uref{http://orgmode.org}).}. It provides a general API to collect
5686 properties from entries in a certain scope, and arbitrary Lisp expressions to
5687 process these values before inserting them into a table or a dynamic block.
5690 @section The Property API
5691 @cindex properties, API
5692 @cindex API, for properties
5694 There is a full API for accessing and changing properties. This API can
5695 be used by Emacs Lisp programs to work with properties and to implement
5696 features based on them. For more information see @ref{Using the
5699 @node Dates and times
5700 @chapter Dates and times
5706 To assist project planning, TODO items can be labeled with a date and/or
5707 a time. The specially formatted string carrying the date and time
5708 information is called a @emph{timestamp} in Org mode. This may be a
5709 little confusing because timestamp is often used to indicate when
5710 something was created or last changed. However, in Org mode this term
5711 is used in a much wider sense.
5714 * Timestamps:: Assigning a time to a tree entry
5715 * Creating timestamps:: Commands which insert timestamps
5716 * Deadlines and scheduling:: Planning your work
5717 * Clocking work time:: Tracking how long you spend on a task
5718 * Effort estimates:: Planning work effort in advance
5719 * Relative timer:: Notes with a running timer
5720 * Countdown timer:: Starting a countdown timer for a task
5725 @section Timestamps, deadlines, and scheduling
5727 @cindex ranges, time
5732 A timestamp is a specification of a date (possibly with a time or a range of
5733 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5734 simplest form, the day name is optional when you type the date yourself.
5735 However, any dates inserted or modified by Org will add that day name, for
5736 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5737 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5738 date/time format. To use an alternative format, see @ref{Custom time
5739 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5740 tree entry. Its presence causes entries to be shown on specific dates in the
5741 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5744 @item Plain timestamp; Event; Appointment
5747 A simple timestamp just assigns a date/time to an item. This is just
5748 like writing down an appointment or event in a paper agenda. In the
5749 timeline and agenda displays, the headline of an entry associated with a
5750 plain timestamp will be shown exactly on that date.
5753 * Meet Peter at the movies
5754 <2006-11-01 Wed 19:15>
5755 * Discussion on climate change
5756 <2006-11-02 Thu 20:00-22:00>
5759 @item Timestamp with repeater interval
5760 @cindex timestamp, with repeater interval
5761 A timestamp may contain a @emph{repeater interval}, indicating that it
5762 applies not only on the given date, but again and again after a certain
5763 interval of N days (d), weeks (w), months (m), or years (y). The
5764 following will show up in the agenda every Wednesday:
5767 * Pick up Sam at school
5768 <2007-05-16 Wed 12:30 +1w>
5771 @item Diary-style sexp entries
5772 For more complex date specifications, Org mode supports using the special
5773 sexp diary entries implemented in the Emacs calendar/diary
5774 package@footnote{When working with the standard diary sexp functions, you
5775 need to be very careful with the order of the arguments. That order depends
5776 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5777 versions, @code{european-calendar-style}). For example, to specify a date
5778 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5779 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5780 the settings. This has been the source of much confusion. Org mode users
5781 can resort to special versions of these functions like @code{org-date} or
5782 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5783 functions, but with stable ISO order of arguments (year, month, day) wherever
5784 applicable, independent of the value of @code{calendar-date-style}.}. For
5785 example with optional time
5788 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5789 <%%(diary-float t 4 2)>
5792 @item Time/Date range
5795 Two timestamps connected by @samp{--} denote a range. The headline
5796 will be shown on the first and last day of the range, and on any dates
5797 that are displayed and fall in the range. Here is an example:
5800 ** Meeting in Amsterdam
5801 <2004-08-23 Mon>--<2004-08-26 Thu>
5804 @item Inactive timestamp
5805 @cindex timestamp, inactive
5806 @cindex inactive timestamp
5807 Just like a plain timestamp, but with square brackets instead of
5808 angular ones. These timestamps are inactive in the sense that they do
5809 @emph{not} trigger an entry to show up in the agenda.
5812 * Gillian comes late for the fifth time
5818 @node Creating timestamps
5819 @section Creating timestamps
5820 @cindex creating timestamps
5821 @cindex timestamps, creating
5823 For Org mode to recognize timestamps, they need to be in the specific
5824 format. All commands listed below produce timestamps in the correct
5828 @orgcmd{C-c .,org-time-stamp}
5829 Prompt for a date and insert a corresponding timestamp. When the cursor is
5830 at an existing timestamp in the buffer, the command is used to modify this
5831 timestamp instead of inserting a new one. When this command is used twice in
5832 succession, a time range is inserted.
5834 @orgcmd{C-c !,org-time-stamp-inactive}
5835 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5842 @vindex org-time-stamp-rounding-minutes
5843 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5844 contains date and time. The default time can be rounded to multiples of 5
5845 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5848 Normalize timestamp, insert/fix day name if missing or wrong.
5850 @orgcmd{C-c <,org-date-from-calendar}
5851 Insert a timestamp corresponding to the cursor date in the Calendar.
5853 @orgcmd{C-c >,org-goto-calendar}
5854 Access the Emacs calendar for the current date. If there is a
5855 timestamp in the current line, go to the corresponding date
5858 @orgcmd{C-c C-o,org-open-at-point}
5859 Access the agenda for the date given by the timestamp or -range at
5860 point (@pxref{Weekly/daily agenda}).
5862 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5863 Change date at cursor by one day. These key bindings conflict with
5864 shift-selection and related modes (@pxref{Conflicts}).
5866 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5867 Change the item under the cursor in a timestamp. The cursor can be on a
5868 year, month, day, hour or minute. When the timestamp contains a time range
5869 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5870 shifting the time block with constant length. To change the length, modify
5871 the second time. Note that if the cursor is in a headline and not at a
5872 timestamp, these same keys modify the priority of an item.
5873 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5874 related modes (@pxref{Conflicts}).
5876 @orgcmd{C-c C-y,org-evaluate-time-range}
5877 @cindex evaluate time range
5878 Evaluate a time range by computing the difference between start and end.
5879 With a prefix argument, insert result after the time range (in a table: into
5880 the following column).
5885 * The date/time prompt:: How Org mode helps you entering date and time
5886 * Custom time format:: Making dates look different
5889 @node The date/time prompt
5890 @subsection The date/time prompt
5891 @cindex date, reading in minibuffer
5892 @cindex time, reading in minibuffer
5894 @vindex org-read-date-prefer-future
5895 When Org mode prompts for a date/time, the default is shown in default
5896 date/time format, and the prompt therefore seems to ask for a specific
5897 format. But it will in fact accept date/time information in a variety of
5898 formats. Generally, the information should start at the beginning of the
5899 string. Org mode will find whatever information is in
5900 there and derive anything you have not specified from the @emph{default date
5901 and time}. The default is usually the current date and time, but when
5902 modifying an existing timestamp, or when entering the second stamp of a
5903 range, it is taken from the stamp in the buffer. When filling in
5904 information, Org mode assumes that most of the time you will want to enter a
5905 date in the future: if you omit the month/year and the given day/month is
5906 @i{before} today, it will assume that you mean a future date@footnote{See the
5907 variable @code{org-read-date-prefer-future}. You may set that variable to
5908 the symbol @code{time} to even make a time before now shift the date to
5909 tomorrow.}. If the date has been automatically shifted into the future, the
5910 time prompt will show this with @samp{(=>F).}
5912 For example, let's assume that today is @b{June 13, 2006}. Here is how
5913 various inputs will be interpreted, the items filled in by Org mode are
5917 3-2-5 @result{} 2003-02-05
5918 2/5/3 @result{} 2003-02-05
5919 14 @result{} @b{2006}-@b{06}-14
5920 12 @result{} @b{2006}-@b{07}-12
5921 2/5 @result{} @b{2007}-02-05
5922 Fri @result{} nearest Friday after the default date
5923 sep 15 @result{} @b{2006}-09-15
5924 feb 15 @result{} @b{2007}-02-15
5925 sep 12 9 @result{} 2009-09-12
5926 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5927 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5928 w4 @result{} ISO week for of the current year @b{2006}
5929 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5930 2012-w04-5 @result{} Same as above
5933 Furthermore you can specify a relative date by giving, as the @emph{first}
5934 thing in the input: a plus/minus sign, a number and a letter ([hdwmy]) to
5935 indicate change in hours, days, weeks, months, or years. With a single plus
5936 or minus, the date is always relative to today. With a double plus or minus,
5937 it is relative to the default date. If instead of a single letter, you use
5938 the abbreviation of day name, the date will be the Nth such day, e.g.:
5943 +4d @result{} four days from today
5944 +4 @result{} same as above
5945 +2w @result{} two weeks from today
5946 ++5 @result{} five days from default date
5947 +2tue @result{} second Tuesday from now
5948 -wed @result{} last Wednesday
5951 @vindex parse-time-months
5952 @vindex parse-time-weekdays
5953 The function understands English month and weekday abbreviations. If
5954 you want to use unabbreviated names and/or other languages, configure
5955 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5957 @vindex org-read-date-force-compatible-dates
5958 Not all dates can be represented in a given Emacs implementation. By default
5959 Org mode forces dates into the compatibility range 1970--2037 which works on
5960 all Emacs implementations. If you want to use dates outside of this range,
5961 read the docstring of the variable
5962 @code{org-read-date-force-compatible-dates}.
5964 You can specify a time range by giving start and end times or by giving a
5965 start time and a duration (in HH:MM format). Use one or two dash(es) as the
5966 separator in the former case and use '+' as the separator in the latter
5970 11am-1:15pm @result{} 11:00-13:15
5971 11am--1:15pm @result{} same as above
5972 11am+2:15 @result{} same as above
5975 @cindex calendar, for selecting date
5976 @vindex org-popup-calendar-for-date-prompt
5977 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5978 you don't need/want the calendar, configure the variable
5979 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5980 prompt, either by clicking on a date in the calendar, or by pressing
5981 @key{RET}, the date selected in the calendar will be combined with the
5982 information entered at the prompt. You can control the calendar fully
5983 from the minibuffer:
5990 @kindex S-@key{right}
5991 @kindex S-@key{left}
5992 @kindex S-@key{down}
5994 @kindex M-S-@key{right}
5995 @kindex M-S-@key{left}
5998 @key{RET} @r{Choose date at cursor in calendar.}
5999 mouse-1 @r{Select date by clicking on it.}
6000 S-@key{right}/@key{left} @r{One day forward/backward.}
6001 S-@key{down}/@key{up} @r{One week forward/backward.}
6002 M-S-@key{right}/@key{left} @r{One month forward/backward.}
6003 > / < @r{Scroll calendar forward/backward by one month.}
6004 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
6007 @vindex org-read-date-display-live
6008 The actions of the date/time prompt may seem complex, but I assure you they
6009 will grow on you, and you will start getting annoyed by pretty much any other
6010 way of entering a date/time out there. To help you understand what is going
6011 on, the current interpretation of your input will be displayed live in the
6012 minibuffer@footnote{If you find this distracting, turn the display off with
6013 @code{org-read-date-display-live}.}.
6015 @node Custom time format
6016 @subsection Custom time format
6017 @cindex custom date/time format
6018 @cindex time format, custom
6019 @cindex date format, custom
6021 @vindex org-display-custom-times
6022 @vindex org-time-stamp-custom-formats
6023 Org mode uses the standard ISO notation for dates and times as it is
6024 defined in ISO 8601. If you cannot get used to this and require another
6025 representation of date and time to keep you happy, you can get it by
6026 customizing the options @code{org-display-custom-times} and
6027 @code{org-time-stamp-custom-formats}.
6030 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
6031 Toggle the display of custom formats for dates and times.
6035 Org mode needs the default format for scanning, so the custom date/time
6036 format does not @emph{replace} the default format---instead it is put
6037 @emph{over} the default format using text properties. This has the
6038 following consequences:
6041 You cannot place the cursor onto a timestamp anymore, only before or
6044 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
6045 each component of a timestamp. If the cursor is at the beginning of
6046 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
6047 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
6048 time will be changed by one minute.
6050 If the timestamp contains a range of clock times or a repeater, these
6051 will not be overlaid, but remain in the buffer as they were.
6053 When you delete a timestamp character-by-character, it will only
6054 disappear from the buffer after @emph{all} (invisible) characters
6055 belonging to the ISO timestamp have been removed.
6057 If the custom timestamp format is longer than the default and you are
6058 using dates in tables, table alignment will be messed up. If the custom
6059 format is shorter, things do work as expected.
6063 @node Deadlines and scheduling
6064 @section Deadlines and scheduling
6066 A timestamp may be preceded by special keywords to facilitate planning:
6070 @cindex DEADLINE keyword
6072 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
6073 to be finished on that date.
6075 @vindex org-deadline-warning-days
6076 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
6077 On the deadline date, the task will be listed in the agenda. In
6078 addition, the agenda for @emph{today} will carry a warning about the
6079 approaching or missed deadline, starting
6080 @code{org-deadline-warning-days} before the due date, and continuing
6081 until the entry is marked DONE@. An example:
6084 *** TODO write article about the Earth for the Guide
6085 DEADLINE: <2004-02-29 Sun>
6086 The editor in charge is [[bbdb:Ford Prefect]]
6089 You can specify a different lead time for warnings for a specific
6090 deadline using the following syntax. Here is an example with a warning
6091 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is
6092 deactivated if the task gets scheduled and you set
6093 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
6096 @cindex SCHEDULED keyword
6098 Meaning: you are planning to start working on that task on the given
6101 @vindex org-agenda-skip-scheduled-if-done
6102 The headline will be listed under the given date@footnote{It will still
6103 be listed on that date after it has been marked DONE@. If you don't like
6104 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
6105 addition, a reminder that the scheduled date has passed will be present
6106 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
6107 the task will automatically be forwarded until completed.
6110 *** TODO Call Trillian for a date on New Years Eve.
6111 SCHEDULED: <2004-12-25 Sat>
6114 @vindex org-scheduled-delay-days
6115 @vindex org-agenda-skip-scheduled-delay-if-deadline
6116 If you want to @emph{delay} the display of this task in the agenda, use
6117 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
6118 25th but will appear two days later. In case the task contains a repeater,
6119 the delay is considered to affect all occurrences; if you want the delay to
6120 only affect the first scheduled occurrence of the task, use @code{--2d}
6121 instead. See @code{org-scheduled-delay-days} and
6122 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
6123 control this globally or per agenda.
6126 @b{Important:} Scheduling an item in Org mode should @i{not} be
6127 understood in the same way that we understand @i{scheduling a meeting}.
6128 Setting a date for a meeting is just a simple appointment, you should
6129 mark this entry with a simple plain timestamp, to get this item shown
6130 on the date where it applies. This is a frequent misunderstanding by
6131 Org users. In Org mode, @i{scheduling} means setting a date when you
6132 want to start working on an action item.
6135 You may use timestamps with repeaters in scheduling and deadline
6136 entries. Org mode will issue early and late warnings based on the
6137 assumption that the timestamp represents the @i{nearest instance} of
6138 the repeater. However, the use of diary sexp entries like
6140 @code{<%%(diary-float t 42)>}
6142 in scheduling and deadline timestamps is limited. Org mode does not
6143 know enough about the internals of each sexp function to issue early and
6144 late warnings. However, it will show the item on each day where the
6148 * Inserting deadline/schedule:: Planning items
6149 * Repeated tasks:: Items that show up again and again
6152 @node Inserting deadline/schedule
6153 @subsection Inserting deadlines or schedules
6155 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
6156 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
6157 any text between this line and the headline.} a deadline or to schedule
6162 @orgcmd{C-c C-d,org-deadline}
6163 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
6164 in the line directly following the headline. Any CLOSED timestamp will be
6165 removed. When called with a prefix arg, an existing deadline will be removed
6166 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
6167 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
6168 and @code{nologredeadline}}, a note will be taken when changing an existing
6171 @orgcmd{C-c C-s,org-schedule}
6172 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
6173 happen in the line directly following the headline. Any CLOSED timestamp
6174 will be removed. When called with a prefix argument, remove the scheduling
6175 date from the entry. Depending on the variable
6176 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
6177 keywords @code{logreschedule}, @code{lognotereschedule}, and
6178 @code{nologreschedule}}, a note will be taken when changing an existing
6181 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
6184 Mark the current entry for agenda action. After you have marked the entry
6185 like this, you can open the agenda or the calendar to find an appropriate
6186 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
6187 schedule the marked item.
6189 @orgcmd{C-c / d,org-check-deadlines}
6190 @cindex sparse tree, for deadlines
6191 @vindex org-deadline-warning-days
6192 Create a sparse tree with all deadlines that are either past-due, or
6193 which will become due within @code{org-deadline-warning-days}.
6194 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
6195 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
6196 all deadlines due tomorrow.
6198 @orgcmd{C-c / b,org-check-before-date}
6199 Sparse tree for deadlines and scheduled items before a given date.
6201 @orgcmd{C-c / a,org-check-after-date}
6202 Sparse tree for deadlines and scheduled items after a given date.
6205 Note that @code{org-schedule} and @code{org-deadline} supports
6206 setting the date by indicating a relative time: e.g., +1d will set
6207 the date to the next day after today, and --1w will set the date
6208 to the previous week before any current timestamp.
6210 @node Repeated tasks
6211 @subsection Repeated tasks
6212 @cindex tasks, repeated
6213 @cindex repeated tasks
6215 Some tasks need to be repeated again and again. Org mode helps to
6216 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
6217 or plain timestamp. In the following example
6219 ** TODO Pay the rent
6220 DEADLINE: <2005-10-01 Sat +1m>
6223 the @code{+1m} is a repeater; the intended interpretation is that the task
6224 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6225 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
6226 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
6227 and a special warning period in a deadline entry, the repeater should come
6228 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6230 @vindex org-todo-repeat-to-state
6231 Deadlines and scheduled items produce entries in the agenda when they are
6232 over-due, so it is important to be able to mark such an entry as completed
6233 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
6234 keyword DONE, it will no longer produce entries in the agenda. The problem
6235 with this is, however, that then also the @emph{next} instance of the
6236 repeated entry will not be active. Org mode deals with this in the following
6237 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6238 shift the base date of the repeating timestamp by the repeater interval, and
6239 immediately set the entry state back to TODO@footnote{In fact, the target
6240 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6241 the variable @code{org-todo-repeat-to-state}. If neither of these is
6242 specified, the target state defaults to the first state of the TODO state
6243 sequence.}. In the example above, setting the state to DONE would actually
6244 switch the date like this:
6247 ** TODO Pay the rent
6248 DEADLINE: <2005-11-01 Tue +1m>
6251 To mark a task with a repeater as @code{DONE}, use @kbd{C-- 1 C-c C-t}
6252 (i.e., @code{org-todo} with a numeric prefix argument of -1.)
6254 @vindex org-log-repeat
6255 A timestamp@footnote{You can change this using the option
6256 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6257 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
6258 will also be prompted for a note.} will be added under the deadline, to keep
6259 a record that you actually acted on the previous instance of this deadline.
6261 As a consequence of shifting the base date, this entry will no longer be
6262 visible in the agenda when checking past dates, but all future instances
6265 With the @samp{+1m} cookie, the date shift will always be exactly one
6266 month. So if you have not paid the rent for three months, marking this
6267 entry DONE will still keep it as an overdue deadline. Depending on the
6268 task, this may not be the best way to handle it. For example, if you
6269 forgot to call your father for 3 weeks, it does not make sense to call
6270 him 3 times in a single day to make up for it. Finally, there are tasks
6271 like changing batteries which should always repeat a certain time
6272 @i{after} the last time you did it. For these tasks, Org mode has
6273 special repeaters @samp{++} and @samp{.+}. For example:
6277 DEADLINE: <2008-02-10 Sun ++1w>
6278 Marking this DONE will shift the date by at least one week,
6279 but also by as many weeks as it takes to get this date into
6280 the future. However, it stays on a Sunday, even if you called
6281 and marked it done on Saturday.
6282 ** TODO Check the batteries in the smoke detectors
6283 DEADLINE: <2005-11-01 Tue .+1m>
6284 Marking this DONE will shift the date to one month after
6288 @vindex org-agenda-skip-scheduled-if-deadline-is-shown
6289 You may have both scheduling and deadline information for a specific task.
6290 If the repeater is set for the scheduling information only, you probably want
6291 the repeater to be ignored after the deadline. If so, set the variable
6292 @code{org-agenda-skip-scheduled-if-deadline-is-shown} to
6293 @code{repeated-after-deadline}. If you want both scheduling and deadline
6294 information to repeat after the same interval, set the same repeater for both
6297 An alternative to using a repeater is to create a number of copies of a task
6298 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6299 created for this purpose, it is described in @ref{Structure editing}.
6302 @node Clocking work time
6303 @section Clocking work time
6304 @cindex clocking time
6305 @cindex time clocking
6307 Org mode allows you to clock the time you spend on specific tasks in a
6308 project. When you start working on an item, you can start the clock. When
6309 you stop working on that task, or when you mark the task done, the clock is
6310 stopped and the corresponding time interval is recorded. It also computes
6311 the total time spent on each subtree@footnote{Clocking only works if all
6312 headings are indented with less than 30 stars. This is a hardcoded
6313 limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
6314 history or tasks recently clocked, so that you can jump quickly between a
6315 number of tasks absorbing your time.
6317 To save the clock history across Emacs sessions, use
6319 (setq org-clock-persist 'history)
6320 (org-clock-persistence-insinuate)
6322 When you clock into a new task after resuming Emacs, the incomplete
6323 clock@footnote{To resume the clock under the assumption that you have worked
6324 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6325 will be found (@pxref{Resolving idle time}) and you will be prompted about
6329 * Clocking commands:: Starting and stopping a clock
6330 * The clock table:: Detailed reports
6331 * Resolving idle time:: Resolving time when you've been idle
6334 @node Clocking commands
6335 @subsection Clocking commands
6338 @orgcmd{C-c C-x C-i,org-clock-in}
6339 @vindex org-clock-into-drawer
6340 @vindex org-clock-continuously
6341 @cindex property, LOG_INTO_DRAWER
6342 Start the clock on the current item (clock-in). This inserts the CLOCK
6343 keyword together with a timestamp. If this is not the first clocking of
6344 this item, the multiple CLOCK lines will be wrapped into a
6345 @code{:LOGBOOK:} drawer (see also the variable
6346 @code{org-clock-into-drawer}). You can also overrule
6347 the setting of this variable for a subtree by setting a
6348 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6349 When called with a @kbd{C-u} prefix argument,
6350 select the task from a list of recently clocked tasks. With two @kbd{C-u
6351 C-u} prefixes, clock into the task at point and mark it as the default task;
6352 the default task will then always be available with letter @kbd{d} when
6353 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6354 continuous clocking by starting the clock when the last clock stopped.@*
6355 @cindex property: CLOCK_MODELINE_TOTAL
6356 @cindex property: LAST_REPEAT
6357 @vindex org-clock-modeline-total
6358 While the clock is running, the current clocking time is shown in the mode
6359 line, along with the title of the task. The clock time shown will be all
6360 time ever clocked for this task and its children. If the task has an effort
6361 estimate (@pxref{Effort estimates}), the mode line displays the current
6362 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6363 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6364 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6365 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6366 will be shown. More control over what time is shown can be exercised with
6367 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6368 @code{current} to show only the current clocking instance, @code{today} to
6369 show all time clocked on this tasks today (see also the variable
6370 @code{org-extend-today-until}), @code{all} to include all time, or
6371 @code{auto} which is the default@footnote{See also the variable
6372 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6373 mode line entry will pop up a menu with clocking options.
6375 @orgcmd{C-c C-x C-o,org-clock-out}
6376 @vindex org-log-note-clock-out
6377 Stop the clock (clock-out). This inserts another timestamp at the same
6378 location where the clock was last started. It also directly computes
6379 the resulting time and inserts it after the time range as @samp{=>
6380 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6381 possibility to record an additional note together with the clock-out
6382 timestamp@footnote{The corresponding in-buffer setting is:
6383 @code{#+STARTUP: lognoteclock-out}}.
6384 @orgcmd{C-c C-x C-x,org-clock-in-last}
6385 @vindex org-clock-continuously
6386 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6387 select the task from the clock history. With two @kbd{C-u} prefixes,
6388 force continuous clocking by starting the clock when the last clock
6390 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6391 Update the effort estimate for the current clock task.
6394 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6395 Recompute the time interval after changing one of the timestamps. This
6396 is only necessary if you edit the timestamps directly. If you change
6397 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6398 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6399 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6400 clock duration keeps the same.
6401 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6402 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6403 the one of the previous (or the next clock) timestamp by the same duration.
6404 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6405 by five minutes, then the clocked-in timestamp of the next clock will be
6406 increased by five minutes.
6407 @orgcmd{C-c C-t,org-todo}
6408 Changing the TODO state of an item to DONE automatically stops the clock
6409 if it is running in this same item.
6410 @orgcmd{C-c C-x C-q,org-clock-cancel}
6411 Cancel the current clock. This is useful if a clock was started by
6412 mistake, or if you ended up working on something else.
6413 @orgcmd{C-c C-x C-j,org-clock-goto}
6414 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6415 prefix arg, select the target task from a list of recently clocked tasks.
6416 @orgcmd{C-c C-x C-d,org-clock-display}
6417 @vindex org-remove-highlights-with-change
6418 Display time summaries for each subtree in the current buffer. This puts
6419 overlays at the end of each headline, showing the total time recorded under
6420 that heading, including the time of any subheadings. You can use visibility
6421 cycling to study the tree, but the overlays disappear when you change the
6422 buffer (see variable @code{org-remove-highlights-with-change}) or press
6426 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6427 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6428 worked on or closed during a day.
6430 @strong{Important:} note that both @code{org-clock-out} and
6431 @code{org-clock-in-last} can have a global keybinding and will not
6432 modify the window disposition.
6434 @node The clock table
6435 @subsection The clock table
6436 @cindex clocktable, dynamic block
6437 @cindex report, of clocked time
6439 Org mode can produce quite complex reports based on the time clocking
6440 information. Such a report is called a @emph{clock table}, because it is
6441 formatted as one or several Org tables.
6444 @orgcmd{C-c C-x C-r,org-clock-report}
6445 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6446 report as an Org mode table into the current file. When the cursor is
6447 at an existing clock table, just update it. When called with a prefix
6448 argument, jump to the first clock report in the current document and
6449 update it. The clock table always includes also trees with
6450 @code{:ARCHIVE:} tag.
6451 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6452 Update dynamic block at point. The cursor needs to be in the
6453 @code{#+BEGIN} line of the dynamic block.
6454 @orgkey{C-u C-c C-x C-u}
6455 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6456 you have several clock table blocks in a buffer.
6457 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6458 Shift the current @code{:block} interval and update the table. The cursor
6459 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6460 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6464 Here is an example of the frame for a clock table as it is inserted into the
6465 buffer with the @kbd{C-c C-x C-r} command:
6467 @cindex #+BEGIN, clocktable
6469 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6473 @vindex org-clocktable-defaults
6474 The @samp{BEGIN} line specifies a number of options to define the scope,
6475 structure, and formatting of the report. Defaults for all these options can
6476 be configured in the variable @code{org-clocktable-defaults}.
6478 @noindent First there are options that determine which clock entries are to
6481 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6482 @r{Clocks at deeper levels will be summed into the upper level.}
6483 :scope @r{The scope to consider. This can be any of the following:}
6484 nil @r{the current buffer or narrowed region}
6485 file @r{the full current buffer}
6486 subtree @r{the subtree where the clocktable is located}
6487 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6488 tree @r{the surrounding level 1 tree}
6489 agenda @r{all agenda files}
6490 ("file"..) @r{scan these files}
6491 file-with-archives @r{current file and its archives}
6492 agenda-with-archives @r{all agenda files, including archives}
6493 :block @r{The time block to consider. This block is specified either}
6494 @r{absolutely, or relative to the current time and may be any of}
6496 2007-12-31 @r{New year eve 2007}
6497 2007-12 @r{December 2007}
6498 2007-W50 @r{ISO-week 50 in 2007}
6499 2007-Q2 @r{2nd quarter in 2007}
6500 2007 @r{the year 2007}
6501 today, yesterday, today-@var{N} @r{a relative day}
6502 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6503 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6504 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6505 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6506 :tstart @r{A time string specifying when to start considering times.}
6507 @r{Relative times like @code{"<-2w>"} can also be used. See}
6508 @r{@ref{Matching tags and properties} for relative time syntax.}
6509 :tend @r{A time string specifying when to stop considering times.}
6510 @r{Relative times like @code{"<now>"} can also be used. See}
6511 @r{@ref{Matching tags and properties} for relative time syntax.}
6512 :wstart @r{The starting day of the week. The default is 1 for monday.}
6513 :mstart @r{The starting day of the month. The default 1 is for the first}
6514 @r{day of the month.}
6515 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6516 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6517 :stepskip0 @r{Do not show steps that have zero time.}
6518 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6519 :tags @r{A tags match to select entries that should contribute. See}
6520 @r{@ref{Matching tags and properties} for the match syntax.}
6523 Then there are options which determine the formatting of the table. These
6524 options are interpreted by the function @code{org-clocktable-write-default},
6525 but you can specify your own function using the @code{:formatter} parameter.
6527 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6528 :lang @r{Language@footnote{Language terms can be set through the variable @code{org-clock-clocktable-language-setup}.} to use for descriptive cells like "Task".}
6529 :link @r{Link the item headlines in the table to their origins.}
6530 :narrow @r{An integer to limit the width of the headline column in}
6531 @r{the org table. If you write it like @samp{50!}, then the}
6532 @r{headline will also be shortened in export.}
6533 :indent @r{Indent each headline field according to its level.}
6534 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6535 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6536 :level @r{Should a level number column be included?}
6537 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6538 @r{All are overwritten except if there is an explicit @code{:narrow}}
6539 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6540 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6541 :properties @r{List of properties that should be shown in the table. Each}
6542 @r{property will get its own column.}
6543 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6544 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6545 @r{As a special case, @samp{:formula %} adds a column with % time.}
6546 @r{If you do not specify a formula here, any existing formula}
6547 @r{below the clock table will survive updates and be evaluated.}
6548 :formatter @r{A function to format clock data and insert it into the buffer.}
6550 To get a clock summary of the current level 1 tree, for the current
6551 day, you could write
6553 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6557 and to use a specific time range you could write@footnote{Note that all
6558 parameters must be specified in a single line---the line is broken here
6559 only to fit it into the manual.}
6561 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6562 :tend "<2006-08-10 Thu 12:00>"
6565 A range starting a week ago and ending right now could be written as
6567 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6570 A summary of the current subtree with % times would be
6572 #+BEGIN: clocktable :scope subtree :link t :formula %
6575 A horizontally compact representation of everything clocked during last week
6578 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6582 @node Resolving idle time
6583 @subsection Resolving idle time and continuous clocking
6585 @subsubheading Resolving idle time
6586 @cindex resolve idle time
6587 @vindex org-clock-x11idle-program-name
6589 @cindex idle, resolve, dangling
6590 If you clock in on a work item, and then walk away from your
6591 computer---perhaps to take a phone call---you often need to ``resolve'' the
6592 time you were away by either subtracting it from the current clock, or
6593 applying it to another one.
6595 @vindex org-clock-idle-time
6596 By customizing the variable @code{org-clock-idle-time} to some integer, such
6597 as 10 or 15, Emacs can alert you when you get back to your computer after
6598 being idle for that many minutes@footnote{On computers using Mac OS X,
6599 idleness is based on actual user idleness, not just Emacs' idle time. For
6600 X11, you can install a utility program @file{x11idle.c}, available in the
6601 @code{contrib/scripts} directory of the Org git distribution, or install the
6602 @file{xprintidle} package and set it to the variable
6603 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6604 same general treatment of idleness. On other systems, idle time refers to
6605 Emacs idle time only.}, and ask what you want to do with the idle time.
6606 There will be a question waiting for you when you get back, indicating how
6607 much idle time has passed (constantly updated with the current amount), as
6608 well as a set of choices to correct the discrepancy:
6612 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6613 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6614 effectively changing nothing, or enter a number to keep that many minutes.
6616 If you use the shift key and press @kbd{K}, it will keep however many minutes
6617 you request and then immediately clock out of that task. If you keep all of
6618 the minutes, this is the same as just clocking out of the current task.
6620 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6621 the clock, and then check back in from the moment you returned.
6623 To keep none of the minutes and just clock out at the start of the away time,
6624 use the shift key and press @kbd{S}. Remember that using shift will always
6625 leave you clocked out, no matter which option you choose.
6627 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6628 canceling you subtract the away time, and the resulting clock amount is less
6629 than a minute, the clock will still be canceled rather than clutter up the
6630 log with an empty entry.
6633 What if you subtracted those away minutes from the current clock, and now
6634 want to apply them to a new clock? Simply clock in to any task immediately
6635 after the subtraction. Org will notice that you have subtracted time ``on
6636 the books'', so to speak, and will ask if you want to apply those minutes to
6637 the next task you clock in on.
6639 There is one other instance when this clock resolution magic occurs. Say you
6640 were clocked in and hacking away, and suddenly your cat chased a mouse who
6641 scared a hamster that crashed into your UPS's power button! You suddenly
6642 lose all your buffers, but thanks to auto-save you still have your recent Org
6643 mode changes, including your last clock in.
6645 If you restart Emacs and clock into any task, Org will notice that you have a
6646 dangling clock which was never clocked out from your last session. Using
6647 that clock's starting time as the beginning of the unaccounted-for period,
6648 Org will ask how you want to resolve that time. The logic and behavior is
6649 identical to dealing with away time due to idleness; it is just happening due
6650 to a recovery event rather than a set amount of idle time.
6652 You can also check all the files visited by your Org agenda for dangling
6653 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6655 @subsubheading Continuous clocking
6656 @cindex continuous clocking
6657 @vindex org-clock-continuously
6659 You may want to start clocking from the time when you clocked out the
6660 previous task. To enable this systematically, set @code{org-clock-continuously}
6661 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6662 last clocked entry for this session, and start the new clock from there.
6664 If you only want this from time to time, use three universal prefix arguments
6665 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6667 @node Effort estimates
6668 @section Effort estimates
6669 @cindex effort estimates
6671 @cindex property, Effort
6672 @vindex org-effort-property
6673 If you want to plan your work in a very detailed way, or if you need to
6674 produce offers with quotations of the estimated work effort, you may want to
6675 assign effort estimates to entries. If you are also clocking your work, you
6676 may later want to compare the planned effort with the actual working time, a
6677 great way to improve planning estimates. Effort estimates are stored in a
6678 special property @samp{Effort}@footnote{You may change the property being
6679 used with the variable @code{org-effort-property}.}. You can set the effort
6680 for an entry with the following commands:
6683 @orgcmd{C-c C-x e,org-set-effort}
6684 Set the effort estimate for the current entry. With a numeric prefix
6685 argument, set it to the Nth allowed value (see below). This command is also
6686 accessible from the agenda with the @kbd{e} key.
6687 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6688 Modify the effort estimate of the item currently being clocked.
6691 Clearly the best way to work with effort estimates is through column view
6692 (@pxref{Column view}). You should start by setting up discrete values for
6693 effort estimates, and a @code{COLUMNS} format that displays these values
6694 together with clock sums (if you want to clock your time). For a specific
6698 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6699 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6703 @vindex org-global-properties
6704 @vindex org-columns-default-format
6705 or, even better, you can set up these values globally by customizing the
6706 variables @code{org-global-properties} and @code{org-columns-default-format}.
6707 In particular if you want to use this setup also in the agenda, a global
6708 setup may be advised.
6710 The way to assign estimates to individual items is then to switch to column
6711 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6712 value. The values you enter will immediately be summed up in the hierarchy.
6713 In the column next to it, any clocked time will be displayed.
6715 @vindex org-agenda-columns-add-appointments-to-effort-sum
6716 If you switch to column view in the daily/weekly agenda, the effort column
6717 will summarize the estimated work effort for each day@footnote{Please note
6718 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6719 column view}).}, and you can use this to find space in your schedule. To get
6720 an overview of the entire part of the day that is committed, you can set the
6721 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6722 appointments on a day that take place over a specified time interval will
6723 then also be added to the load estimate of the day.
6725 Effort estimates can be used in secondary agenda filtering that is triggered
6726 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6727 these estimates defined consistently, two or three key presses will narrow
6728 down the list to stuff that fits into an available time slot.
6730 @node Relative timer
6731 @section Taking notes with a relative timer
6732 @cindex relative timer
6734 When taking notes during, for example, a meeting or a video viewing, it can
6735 be useful to have access to times relative to a starting time. Org provides
6736 such a relative timer and make it easy to create timed notes.
6739 @orgcmd{C-c C-x .,org-timer}
6740 Insert a relative time into the buffer. The first time you use this, the
6741 timer will be started. When called with a prefix argument, the timer is
6743 @orgcmd{C-c C-x -,org-timer-item}
6744 Insert a description list item with the current relative time. With a prefix
6745 argument, first reset the timer to 0.
6746 @orgcmd{M-@key{RET},org-insert-heading}
6747 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6749 @c for key sequences with a comma, command name macros fail :(
6752 Pause the timer, or continue it if it is already paused
6753 (@command{org-timer-pause-or-continue}).
6754 @c removed the sentence because it is redundant to the following item
6755 @kindex C-u C-c C-x ,
6757 Stop the timer. After this, you can only start a new timer, not continue the
6758 old one. This command also removes the timer from the mode line.
6759 @orgcmd{C-c C-x 0,org-timer-start}
6760 Reset the timer without inserting anything into the buffer. By default, the
6761 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6762 specific starting offset. The user is prompted for the offset, with a
6763 default taken from a timer string at point, if any, So this can be used to
6764 restart taking notes after a break in the process. When called with a double
6765 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6766 by a certain amount. This can be used to fix timer strings if the timer was
6767 not started at exactly the right moment.
6770 @node Countdown timer
6771 @section Countdown timer
6772 @cindex Countdown timer
6776 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6777 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6779 @code{org-timer-set-timer} prompts the user for a duration and displays a
6780 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6781 default countdown value. Giving a prefix numeric argument overrides this
6784 @node Capture - Refile - Archive
6785 @chapter Capture - Refile - Archive
6788 An important part of any organization system is the ability to quickly
6789 capture new ideas and tasks, and to associate reference material with them.
6790 Org does this using a process called @i{capture}. It also can store files
6791 related to a task (@i{attachments}) in a special directory. Once in the
6792 system, tasks and projects need to be moved around. Moving completed project
6793 trees to an archive file keeps the system compact and fast.
6796 * Capture:: Capturing new stuff
6797 * Attachments:: Add files to tasks
6798 * RSS feeds:: Getting input from RSS feeds
6799 * Protocols:: External (e.g., Browser) access to Emacs and Org
6800 * Refile and copy:: Moving/copying a tree from one place to another
6801 * Archiving:: What to do with finished projects
6808 Capture lets you quickly store notes with little interruption of your work
6809 flow. Org's method for capturing new items is heavily inspired by John
6810 Wiegley excellent @file{remember.el} package. Up to version 6.36, Org
6811 used a special setup for @file{remember.el}, then replaced it with
6812 @file{org-remember.el}. As of version 8.0, @file{org-remember.el} has
6813 been completely replaced by @file{org-capture.el}.
6815 If your configuration depends on @file{org-remember.el}, you need to update
6816 it and use the setup described below. To convert your
6817 @code{org-remember-templates}, run the command
6819 @kbd{M-x org-capture-import-remember-templates RET}
6821 @noindent and then customize the new variable with @kbd{M-x
6822 customize-variable org-capture-templates}, check the result, and save the
6826 * Setting up capture:: Where notes will be stored
6827 * Using capture:: Commands to invoke and terminate capture
6828 * Capture templates:: Define the outline of different note types
6831 @node Setting up capture
6832 @subsection Setting up capture
6834 The following customization sets a default target file for notes, and defines
6835 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6836 suggestion.} for capturing new material.
6838 @vindex org-default-notes-file
6841 (setq org-default-notes-file (concat org-directory "/notes.org"))
6842 (define-key global-map "\C-cc" 'org-capture)
6847 @subsection Using capture
6850 @orgcmd{C-c c,org-capture}
6851 Call the command @code{org-capture}. Note that this keybinding is global and
6852 not active by default: you need to install it. If you have templates
6854 defined @pxref{Capture templates}, it will offer these templates for
6855 selection or use a new Org outline node as the default template. It will
6856 insert the template into the target file and switch to an indirect buffer
6857 narrowed to this new node. You may then insert the information you want.
6859 @orgcmd{C-c C-c,org-capture-finalize}
6860 Once you have finished entering information into the capture buffer, @kbd{C-c
6861 C-c} will return you to the window configuration before the capture process,
6862 so that you can resume your work without further distraction. When called
6863 with a prefix arg, finalize and then jump to the captured item.
6865 @orgcmd{C-c C-w,org-capture-refile}
6866 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6867 a different place. Please realize that this is a normal refiling command
6868 that will be executed---so the cursor position at the moment you run this
6869 command is important. If you have inserted a tree with a parent and
6870 children, first move the cursor back to the parent. Any prefix argument
6871 given to this command will be passed on to the @code{org-refile} command.
6873 @orgcmd{C-c C-k,org-capture-kill}
6874 Abort the capture process and return to the previous state.
6878 You can also call @code{org-capture} in a special way from the agenda, using
6879 the @kbd{k c} key combination. With this access, any timestamps inserted by
6880 the selected capture template will default to the cursor date in the agenda,
6881 rather than to the current date.
6883 To find the locations of the last stored capture, use @code{org-capture} with
6888 Visit the target location of a capture template. You get to select the
6889 template in the usual way.
6890 @orgkey{C-u C-u C-c c}
6891 Visit the last stored capture item in its buffer.
6894 @vindex org-capture-bookmark
6895 @cindex org-capture-last-stored
6896 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6897 automatically be created unless you set @code{org-capture-bookmark} to
6900 To insert the capture at point in an Org buffer, call @code{org-capture} with
6901 a @code{C-0} prefix argument.
6903 @node Capture templates
6904 @subsection Capture templates
6905 @cindex templates, for Capture
6907 You can use templates for different types of capture items, and
6908 for different target locations. The easiest way to create such templates is
6909 through the customize interface.
6913 Customize the variable @code{org-capture-templates}.
6916 Before we give the formal description of template definitions, let's look at
6917 an example. Say you would like to use one template to create general TODO
6918 entries, and you want to put these entries under the heading @samp{Tasks} in
6919 your file @file{~/org/gtd.org}. Also, a date tree in the file
6920 @file{journal.org} should capture journal entries. A possible configuration
6925 (setq org-capture-templates
6926 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6927 "* TODO %?\n %i\n %a")
6928 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6929 "* %?\nEntered on %U\n %i\n %a")))
6933 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6937 [[file:@var{link to where you initiated capture}]]
6941 During expansion of the template, @code{%a} has been replaced by a link to
6942 the location from where you called the capture command. This can be
6943 extremely useful for deriving tasks from emails, for example. You fill in
6944 the task definition, press @kbd{C-c C-c} and Org returns you to the same
6945 place where you started the capture process.
6947 To define special keys to capture to a particular template without going
6948 through the interactive template selection, you can create your key binding
6952 (define-key global-map "\C-cx"
6953 (lambda () (interactive) (org-capture nil "x")))
6957 * Template elements:: What is needed for a complete template entry
6958 * Template expansion:: Filling in information about time and context
6959 * Templates in contexts:: Only show a template in a specific context
6962 @node Template elements
6963 @subsubsection Template elements
6965 Now lets look at the elements of a template definition. Each entry in
6966 @code{org-capture-templates} is a list with the following items:
6970 The keys that will select the template, as a string, characters
6971 only, for example @code{"a"} for a template to be selected with a
6972 single key, or @code{"bt"} for selection with two keys. When using
6973 several keys, keys using the same prefix key must be sequential
6974 in the list and preceded by a 2-element entry explaining the
6975 prefix key, for example
6977 ("b" "Templates for marking stuff to buy")
6979 @noindent If you do not define a template for the @kbd{C} key, this key will
6980 be used to open the customize buffer for this complex variable.
6983 A short string describing the template, which will be shown during
6987 The type of entry, a symbol. Valid values are:
6991 An Org mode node, with a headline. Will be filed as the child of the target
6992 entry or as a top-level entry. The target file should be an Org mode file.
6994 A plain list item, placed in the first plain list at the target
6995 location. Again the target file should be an Org file.
6997 A checkbox item. This only differs from the plain list item by the
7000 a new line in the first table at the target location. Where exactly the
7001 line will be inserted depends on the properties @code{:prepend} and
7002 @code{:table-line-pos} (see below).
7004 Text to be inserted as it is.
7008 @vindex org-default-notes-file
7009 Specification of where the captured item should be placed. In Org mode
7010 files, targets usually define a node. Entries will become children of this
7011 node. Other types will be added to the table or list in the body of this
7012 node. Most target specifications contain a file name. If that file name is
7013 the empty string, it defaults to @code{org-default-notes-file}. A file can
7014 also be given as a variable, function, or Emacs Lisp form.
7019 @item (file "path/to/file")
7020 Text will be placed at the beginning or end of that file.
7022 @item (id "id of existing org entry")
7023 Filing as child of this entry, or in the body of the entry.
7025 @item (file+headline "path/to/file" "node headline")
7026 Fast configuration if the target heading is unique in the file.
7028 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
7029 For non-unique headings, the full path is safer.
7031 @item (file+regexp "path/to/file" "regexp to find location")
7032 Use a regular expression to position the cursor.
7034 @item (file+datetree "path/to/file")
7035 Will create a heading in a date tree for today's date@footnote{Datetree
7036 headlines for years accept tags, so if you use both @code{* 2013 :noexport:}
7037 and @code{* 2013} in your file, the capture will refile the note to the first
7040 @item (file+datetree+prompt "path/to/file")
7041 Will create a heading in a date tree, but will prompt for the date.
7043 @item (file+function "path/to/file" function-finding-location)
7044 A function to find the right location in the file.
7047 File to the entry that is currently being clocked.
7049 @item (function function-finding-location)
7050 Most general way, write your own function to find both
7055 The template for creating the capture item. If you leave this empty, an
7056 appropriate default template will be used. Otherwise this is a string with
7057 escape codes, which will be replaced depending on time and context of the
7058 capture call. The string with escapes may be loaded from a template file,
7059 using the special syntax @code{(file "path/to/template")}. See below for
7063 The rest of the entry is a property list of additional options.
7064 Recognized properties are:
7068 Normally new captured information will be appended at
7069 the target location (last child, last table line, last list item...).
7070 Setting this property will change that.
7072 @item :immediate-finish
7073 When set, do not offer to edit the information, just
7074 file it away immediately. This makes sense if the template only needs
7075 information that can be added automatically.
7078 Set this to the number of lines to insert
7079 before and after the new item. Default 0, only common other value is 1.
7082 Start the clock in this item.
7085 Keep the clock running when filing the captured entry.
7088 If starting the capture interrupted a clock, restart that clock when finished
7089 with the capture. Note that @code{:clock-keep} has precedence over
7090 @code{:clock-resume}. When setting both to @code{t}, the current clock will
7091 run and the previous one will not be resumed.
7094 Do not narrow the target buffer, simply show the full buffer. Default is to
7095 narrow it so that you only see the new material.
7097 @item :table-line-pos
7098 Specification of the location in the table where the new line should be
7099 inserted. It should be a string like @code{"II-3"} meaning that the new
7100 line should become the third line before the second horizontal separator
7104 If the target file was not yet visited when capture was invoked, kill the
7105 buffer again after capture is completed.
7109 @node Template expansion
7110 @subsubsection Template expansion
7112 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
7113 these sequences literally, escape the @kbd{%} with a backslash.} allow
7114 dynamic insertion of content. The templates are expanded in the order given here:
7117 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
7118 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
7119 @r{For convenience, %:keyword (see below) placeholders}
7120 @r{within the expression will be expanded prior to this.}
7121 @r{The sexp must return a string.}
7122 %<...> @r{The result of format-time-string on the ... format specification.}
7123 %t @r{Timestamp, date only.}
7124 %T @r{Timestamp, with date and time.}
7125 %u, %U @r{Like the above, but inactive timestamps.}
7126 %i @r{Initial content, the region when capture is called while the}
7127 @r{region is active.}
7128 @r{The entire text will be indented like @code{%i} itself.}
7129 %a @r{Annotation, normally the link created with @code{org-store-link}.}
7130 %A @r{Like @code{%a}, but prompt for the description part.}
7131 %l @r{Like %a, but only insert the literal link.}
7132 %c @r{Current kill ring head.}
7133 %x @r{Content of the X clipboard.}
7134 %k @r{Title of the currently clocked task.}
7135 %K @r{Link to the currently clocked task.}
7136 %n @r{User name (taken from @code{user-full-name}).}
7137 %f @r{File visited by current buffer when org-capture was called.}
7138 %F @r{Full path of the file or directory visited by current buffer.}
7139 %:keyword @r{Specific information for certain link types, see below.}
7140 %^g @r{Prompt for tags, with completion on tags in target file.}
7141 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
7142 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
7143 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
7144 %^C @r{Interactive selection of which kill or clip to use.}
7145 %^L @r{Like @code{%^C}, but insert as link.}
7146 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
7147 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
7148 @r{You may specify a default value and a completion table with}
7149 @r{%^@{prompt|default|completion2|completion3...@}.}
7150 @r{The arrow keys access a prompt-specific history.}
7151 %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
7152 @r{a number, starting from 1.}
7153 %? @r{After completing the template, position cursor here.}
7157 For specific link types, the following keywords will be
7158 defined@footnote{If you define your own link types (@pxref{Adding
7159 hyperlink types}), any property you store with
7160 @code{org-store-link-props} can be accessed in capture templates in a
7163 @vindex org-from-is-user-regexp
7165 Link type | Available keywords
7166 ---------------------------------+----------------------------------------------
7167 bbdb | %:name %:company
7168 irc | %:server %:port %:nick
7169 vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
7170 | %:from %:fromname %:fromaddress
7171 | %:to %:toname %:toaddress
7172 | %:date @r{(message date header field)}
7173 | %:date-timestamp @r{(date as active timestamp)}
7174 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
7175 | %:fromto @r{(either "to NAME" or "from NAME")@footnote{This will always be the other, not the user. See the variable @code{org-from-is-user-regexp}.}}
7176 gnus | %:group, @r{for messages also all email fields}
7178 info | %:file %:node
7183 To place the cursor after template expansion use:
7186 %? @r{After completing the template, position cursor here.}
7189 @node Templates in contexts
7190 @subsubsection Templates in contexts
7192 @vindex org-capture-templates-contexts
7193 To control whether a capture template should be accessible from a specific
7194 context, you can customize @code{org-capture-templates-contexts}. Let's say
7195 for example that you have a capture template @code{"p"} for storing Gnus
7196 emails containing patches. Then you would configure this option like this:
7199 (setq org-capture-templates-contexts
7200 '(("p" (in-mode . "message-mode"))))
7203 You can also tell that the command key @code{"p"} should refer to another
7204 template. In that case, add this command key like this:
7207 (setq org-capture-templates-contexts
7208 '(("p" "q" (in-mode . "message-mode"))))
7211 See the docstring of the variable for more information.
7214 @section Attachments
7217 @vindex org-attach-directory
7218 It is often useful to associate reference material with an outline node/task.
7219 Small chunks of plain text can simply be stored in the subtree of a project.
7220 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
7221 files that live elsewhere on your computer or in the cloud, like emails or
7222 source code files belonging to a project. Another method is @i{attachments},
7223 which are files located in a directory belonging to an outline node. Org
7224 uses directories named by the unique ID of each entry. These directories are
7225 located in the @file{data} directory which lives in the same directory where
7226 your Org file lives@footnote{If you move entries or Org files from one
7227 directory to another, you may want to configure @code{org-attach-directory}
7228 to contain an absolute path.}. If you initialize this directory with
7229 @code{git init}, Org will automatically commit changes when it sees them.
7230 The attachment system has been contributed to Org by John Wiegley.
7232 In cases where it seems better to do so, you can also attach a directory of your
7233 choice to an entry. You can also make children inherit the attachment
7234 directory from a parent, so that an entire subtree uses the same attached
7237 @noindent The following commands deal with attachments:
7240 @orgcmd{C-c C-a,org-attach}
7241 The dispatcher for commands related to the attachment system. After these
7242 keys, a list of commands is displayed and you must press an additional key
7243 to select a command:
7246 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7247 @vindex org-attach-method
7248 Select a file and move it into the task's attachment directory. The file
7249 will be copied, moved, or linked, depending on @code{org-attach-method}.
7250 Note that hard links are not supported on all systems.
7256 Attach a file using the copy/move/link method.
7257 Note that hard links are not supported on all systems.
7259 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7260 Create a new attachment as an Emacs buffer.
7262 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7263 Synchronize the current task with its attachment directory, in case you added
7264 attachments yourself.
7266 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7267 @vindex org-file-apps
7268 Open current task's attachment. If there is more than one, prompt for a
7269 file name first. Opening will follow the rules set by @code{org-file-apps}.
7270 For more details, see the information on following hyperlinks
7271 (@pxref{Handling links}).
7273 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7274 Also open the attachment, but force opening the file in Emacs.
7276 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7277 Open the current task's attachment directory.
7279 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7280 Also open the directory, but force using @command{dired} in Emacs.
7282 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7283 Select and delete a single attachment.
7285 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7286 Delete all of a task's attachments. A safer way is to open the directory in
7287 @command{dired} and delete from there.
7289 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7290 @cindex property, ATTACH_DIR
7291 Set a specific directory as the entry's attachment directory. This works by
7292 putting the directory path into the @code{ATTACH_DIR} property.
7294 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7295 @cindex property, ATTACH_DIR_INHERIT
7296 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7297 same directory for attachments as the parent does.
7306 Org can add and change entries based on information found in RSS feeds and
7307 Atom feeds. You could use this to make a task out of each new podcast in a
7308 podcast feed. Or you could use a phone-based note-creating service on the
7309 web to import tasks into Org. To access feeds, configure the variable
7310 @code{org-feed-alist}. The docstring of this variable has detailed
7311 information. Here is just an example:
7315 (setq org-feed-alist
7317 "http://rss.slashdot.org/Slashdot/slashdot"
7318 "~/txt/org/feeds.org" "Slashdot Entries")))
7323 will configure that new items from the feed provided by
7324 @code{rss.slashdot.org} will result in new entries in the file
7325 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7326 the following command is used:
7329 @orgcmd{C-c C-x g,org-feed-update-all}
7331 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7333 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7334 Prompt for a feed name and go to the inbox configured for this feed.
7337 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7338 it will store information about the status of items in the feed, to avoid
7339 adding the same item several times.
7341 For more information, including how to read atom feeds, see
7342 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7345 @section Protocols for external access
7346 @cindex protocols, for external access
7349 You can set up Org for handling protocol calls from outside applications that
7350 are passed to Emacs through the @file{emacsserver}. For example, you can
7351 configure bookmarks in your web browser to send a link to the current page to
7352 Org and create a note from it using capture (@pxref{Capture}). Or you
7353 could create a bookmark that will tell Emacs to open the local source file of
7354 a remote website you are looking at with the browser. See
7355 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7356 documentation and setup instructions.
7358 @node Refile and copy
7359 @section Refile and copy
7360 @cindex refiling notes
7361 @cindex copying notes
7363 When reviewing the captured data, you may want to refile or to copy some of
7364 the entries into a different list, for example into a project. Cutting,
7365 finding the right location, and then pasting the note is cumbersome. To
7366 simplify this process, you can use the following special command:
7369 @orgcmd{C-c M-w,org-copy}
7371 Copying works like refiling, except that the original note is not deleted.
7372 @orgcmd{C-c C-w,org-refile}
7374 @vindex org-reverse-note-order
7375 @vindex org-refile-targets
7376 @vindex org-refile-use-outline-path
7377 @vindex org-outline-path-complete-in-steps
7378 @vindex org-refile-allow-creating-parent-nodes
7379 @vindex org-log-refile
7380 @vindex org-refile-use-cache
7381 @vindex org-refile-keep
7382 Refile the entry or region at point. This command offers possible locations
7383 for refiling the entry and lets you select one with completion. The item (or
7384 all items in the region) is filed below the target heading as a subitem.
7385 Depending on @code{org-reverse-note-order}, it will be either the first or
7387 By default, all level 1 headlines in the current buffer are considered to be
7388 targets, but you can have more complex definitions across a number of files.
7389 See the variable @code{org-refile-targets} for details. If you would like to
7390 select a location via a file-path-like completion along the outline path, see
7391 the variables @code{org-refile-use-outline-path} and
7392 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7393 create new nodes as new parents for refiling on the fly, check the
7394 variable @code{org-refile-allow-creating-parent-nodes}.
7395 When the variable @code{org-log-refile}@footnote{with corresponding
7396 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7397 and @code{nologrefile}} is set, a timestamp or a note will be
7398 recorded when an entry has been refiled.
7399 @orgkey{C-u C-c C-w}
7400 Use the refile interface to jump to a heading.
7401 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7402 Jump to the location where @code{org-refile} last moved a tree to.
7404 Refile as the child of the item currently being clocked.
7406 Refile and keep the entry in place. Also see @code{org-refile-keep} to make
7407 this the default behavior, and beware that this may result in duplicated
7408 @code{ID} properties.
7409 @orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C-w,org-refile-cache-clear}
7410 Clear the target cache. Caching of refile targets can be turned on by
7411 setting @code{org-refile-use-cache}. To make the command see new possible
7412 targets, you have to clear the cache with this command.
7419 When a project represented by a (sub)tree is finished, you may want
7420 to move the tree out of the way and to stop it from contributing to the
7421 agenda. Archiving is important to keep your working files compact and global
7422 searches like the construction of agenda views fast.
7425 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7426 @vindex org-archive-default-command
7427 Archive the current entry using the command specified in the variable
7428 @code{org-archive-default-command}.
7432 * Moving subtrees:: Moving a tree to an archive file
7433 * Internal archiving:: Switch off a tree but keep it in the file
7436 @node Moving subtrees
7437 @subsection Moving a tree to the archive file
7438 @cindex external archiving
7440 The most common archiving action is to move a project tree to another file,
7444 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7445 @vindex org-archive-location
7446 Archive the subtree starting at the cursor position to the location
7447 given by @code{org-archive-location}.
7448 @orgkey{C-u C-c C-x C-s}
7449 Check if any direct children of the current headline could be moved to
7450 the archive. To do this, each subtree is checked for open TODO entries.
7451 If none are found, the command offers to move it to the archive
7452 location. If the cursor is @emph{not} on a headline when this command
7453 is invoked, the level 1 trees will be checked.
7456 @cindex archive locations
7457 The default archive location is a file in the same directory as the
7458 current file, with the name derived by appending @file{_archive} to the
7459 current file name. You can also choose what heading to file archived
7460 items under, with the possibility to add them to a datetree in a file.
7461 For information and examples on how to specify the file and the heading,
7462 see the documentation string of the variable
7463 @code{org-archive-location}.
7465 There is also an in-buffer option for setting this variable, for
7466 example@footnote{For backward compatibility, the following also works:
7467 If there are several such lines in a file, each specifies the archive
7468 location for the text below it. The first such line also applies to any
7469 text before its definition. However, using this method is
7470 @emph{strongly} deprecated as it is incompatible with the outline
7471 structure of the document. The correct method for setting multiple
7472 archive locations in a buffer is using properties.}:
7476 #+ARCHIVE: %s_done::
7479 @cindex property, ARCHIVE
7481 If you would like to have a special ARCHIVE location for a single entry
7482 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7483 location as the value (@pxref{Properties and columns}).
7485 @vindex org-archive-save-context-info
7486 When a subtree is moved, it receives a number of special properties that
7487 record context information like the file from where the entry came, its
7488 outline path the archiving time etc. Configure the variable
7489 @code{org-archive-save-context-info} to adjust the amount of information
7493 @node Internal archiving
7494 @subsection Internal archiving
7496 If you want to just switch off (for agenda views) certain subtrees without
7497 moving them to a different file, you can use the @code{ARCHIVE tag}.
7499 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7500 its location in the outline tree, but behaves in the following way:
7503 @vindex org-cycle-open-archived-trees
7504 It does not open when you attempt to do so with a visibility cycling
7505 command (@pxref{Visibility cycling}). You can force cycling archived
7506 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7507 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7508 @code{show-all} will open archived subtrees.
7510 @vindex org-sparse-tree-open-archived-trees
7511 During sparse tree construction (@pxref{Sparse trees}), matches in
7512 archived subtrees are not exposed, unless you configure the option
7513 @code{org-sparse-tree-open-archived-trees}.
7515 @vindex org-agenda-skip-archived-trees
7516 During agenda view construction (@pxref{Agenda views}), the content of
7517 archived trees is ignored unless you configure the option
7518 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7519 be included. In the agenda you can press @kbd{v a} to get archives
7520 temporarily included.
7522 @vindex org-export-with-archived-trees
7523 Archived trees are not exported (@pxref{Exporting}), only the headline
7524 is. Configure the details using the variable
7525 @code{org-export-with-archived-trees}.
7527 @vindex org-columns-skip-archived-trees
7528 Archived trees are excluded from column view unless the variable
7529 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7532 The following commands help manage the ARCHIVE tag:
7535 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7536 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7537 the headline changes to a shadowed face, and the subtree below it is
7539 @orgkey{C-u C-c C-x a}
7540 Check if any direct children of the current headline should be archived.
7541 To do this, each subtree is checked for open TODO entries. If none are
7542 found, the command offers to set the ARCHIVE tag for the child. If the
7543 cursor is @emph{not} on a headline when this command is invoked, the
7544 level 1 trees will be checked.
7545 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7546 Cycle a tree even if it is tagged with ARCHIVE.
7547 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7548 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7549 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7550 entry becomes a child of that sibling and in this way retains a lot of its
7551 original context, including inherited tags and approximate position in the
7557 @chapter Agenda views
7558 @cindex agenda views
7560 Due to the way Org works, TODO items, time-stamped items, and
7561 tagged headlines can be scattered throughout a file or even a number of
7562 files. To get an overview of open action items, or of events that are
7563 important for a particular date, this information must be collected,
7564 sorted and displayed in an organized way.
7566 Org can select items based on various criteria and display them
7567 in a separate buffer. Seven different view types are provided:
7571 an @emph{agenda} that is like a calendar and shows information
7574 a @emph{TODO list} that covers all unfinished
7577 a @emph{match view}, showings headlines based on the tags, properties, and
7578 TODO state associated with them,
7580 a @emph{timeline view} that shows all events in a single Org file,
7581 in time-sorted view,
7583 a @emph{text search view} that shows all entries from multiple files
7584 that contain specified keywords,
7586 a @emph{stuck projects view} showing projects that currently don't move
7589 @emph{custom views} that are special searches and combinations of different
7594 The extracted information is displayed in a special @emph{agenda
7595 buffer}. This buffer is read-only, but provides commands to visit the
7596 corresponding locations in the original Org files, and even to
7597 edit these files remotely.
7599 @vindex org-agenda-window-setup
7600 @vindex org-agenda-restore-windows-after-quit
7601 Two variables control how the agenda buffer is displayed and whether the
7602 window configuration is restored when the agenda exits:
7603 @code{org-agenda-window-setup} and
7604 @code{org-agenda-restore-windows-after-quit}.
7607 * Agenda files:: Files being searched for agenda information
7608 * Agenda dispatcher:: Keyboard access to agenda views
7609 * Built-in agenda views:: What is available out of the box?
7610 * Presentation and sorting:: How agenda items are prepared for display
7611 * Agenda commands:: Remote editing of Org trees
7612 * Custom agenda views:: Defining special searches and views
7613 * Exporting agenda views:: Writing a view to a file
7614 * Agenda column view:: Using column view for collected entries
7618 @section Agenda files
7619 @cindex agenda files
7620 @cindex files for agenda
7622 @vindex org-agenda-files
7623 The information to be shown is normally collected from all @emph{agenda
7624 files}, the files listed in the variable
7625 @code{org-agenda-files}@footnote{If the value of that variable is not a
7626 list, but a single file name, then the list of agenda files will be
7627 maintained in that external file.}. If a directory is part of this list,
7628 all files with the extension @file{.org} in this directory will be part
7631 Thus, even if you only work with a single Org file, that file should
7632 be put into the list@footnote{When using the dispatcher, pressing
7633 @kbd{<} before selecting a command will actually limit the command to
7634 the current file, and ignore @code{org-agenda-files} until the next
7635 dispatcher command.}. You can customize @code{org-agenda-files}, but
7636 the easiest way to maintain it is through the following commands
7638 @cindex files, adding to agenda list
7640 @orgcmd{C-c [,org-agenda-file-to-front}
7641 Add current file to the list of agenda files. The file is added to
7642 the front of the list. If it was already in the list, it is moved to
7643 the front. With a prefix argument, file is added/moved to the end.
7644 @orgcmd{C-c ],org-remove-file}
7645 Remove current file from the list of agenda files.
7647 @cindex cycling, of agenda files
7648 @orgcmd{C-',org-cycle-agenda-files}
7650 Cycle through agenda file list, visiting one file after the other.
7651 @kindex M-x org-iswitchb
7652 @item M-x org-iswitchb RET
7653 Command to use an @code{iswitchb}-like interface to switch to and between Org
7658 The Org menu contains the current list of files and can be used
7659 to visit any of them.
7661 If you would like to focus the agenda temporarily on a file not in
7662 this list, or on just one file in the list, or even on only a subtree in a
7663 file, then this can be done in different ways. For a single agenda command,
7664 you may press @kbd{<} once or several times in the dispatcher
7665 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7666 extended period, use the following commands:
7669 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7670 Permanently restrict the agenda to the current subtree. When with a
7671 prefix argument, or with the cursor before the first headline in a file,
7672 the agenda scope is set to the entire file. This restriction remains in
7673 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7674 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7675 agenda view, the new restriction takes effect immediately.
7676 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7677 Remove the permanent restriction created by @kbd{C-c C-x <}.
7681 When working with @file{speedbar.el}, you can use the following commands in
7685 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7686 Permanently restrict the agenda to the item---either an Org file or a subtree
7687 in such a file---at the cursor in the Speedbar frame.
7688 If there is a window displaying an agenda view, the new restriction takes
7690 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7691 Lift the restriction.
7694 @node Agenda dispatcher
7695 @section The agenda dispatcher
7696 @cindex agenda dispatcher
7697 @cindex dispatching agenda commands
7698 The views are created through a dispatcher, which should be bound to a
7699 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7700 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7701 is accessed and list keyboard access to commands accordingly. After
7702 pressing @kbd{C-c a}, an additional letter is required to execute a
7703 command. The dispatcher offers the following default commands:
7707 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7709 Create a list of all TODO items (@pxref{Global TODO list}).
7711 Create a list of headlines matching a TAGS expression (@pxref{Matching
7712 tags and properties}).
7714 Create the timeline view for the current buffer (@pxref{Timeline}).
7716 Create a list of entries selected by a boolean expression of keywords
7717 and/or regular expressions that must or must not occur in the entry.
7719 @vindex org-agenda-text-search-extra-files
7720 Search for a regular expression in all agenda files and additionally in
7721 the files listed in @code{org-agenda-text-search-extra-files}. This
7722 uses the Emacs command @code{multi-occur}. A prefix argument can be
7723 used to specify the number of context lines for each match, default is
7726 Create a list of stuck projects (@pxref{Stuck projects}).
7728 Restrict an agenda command to the current buffer@footnote{For backward
7729 compatibility, you can also press @kbd{1} to restrict to the current
7730 buffer.}. After pressing @kbd{<}, you still need to press the character
7731 selecting the command.
7733 If there is an active region, restrict the following agenda command to
7734 the region. Otherwise, restrict it to the current subtree@footnote{For
7735 backward compatibility, you can also press @kbd{0} to restrict to the
7736 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7737 character selecting the command.
7740 @vindex org-agenda-sticky
7741 Toggle sticky agenda views. By default, Org maintains only a single agenda
7742 buffer and rebuilds it each time you change the view, to make sure everything
7743 is always up to date. If you switch between views often and the build time
7744 bothers you, you can turn on sticky agenda buffers (make this the default by
7745 customizing the variable @code{org-agenda-sticky}). With sticky agendas, the
7746 dispatcher only switches to the selected view, you need to update it by hand
7747 with @kbd{r} or @kbd{g}. You can toggle sticky agenda view any time with
7748 @code{org-toggle-sticky-agenda}.
7751 You can also define custom commands that will be accessible through the
7752 dispatcher, just like the default commands. This includes the
7753 possibility to create extended agenda buffers that contain several
7754 blocks together, for example the weekly agenda, the global TODO list and
7755 a number of special tags matches. @xref{Custom agenda views}.
7757 @node Built-in agenda views
7758 @section The built-in agenda views
7760 In this section we describe the built-in views.
7763 * Weekly/daily agenda:: The calendar page with current tasks
7764 * Global TODO list:: All unfinished action items
7765 * Matching tags and properties:: Structured information with fine-tuned search
7766 * Timeline:: Time-sorted view for single file
7767 * Search view:: Find entries by searching for text
7768 * Stuck projects:: Find projects you need to review
7771 @node Weekly/daily agenda
7772 @subsection The weekly/daily agenda
7774 @cindex weekly agenda
7775 @cindex daily agenda
7777 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7778 paper agenda, showing all the tasks for the current week or day.
7781 @cindex org-agenda, command
7782 @orgcmd{C-c a a,org-agenda-list}
7783 Compile an agenda for the current week from a list of Org files. The agenda
7784 shows the entries for each day. With a numeric prefix@footnote{For backward
7785 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7786 listed before the agenda. This feature is deprecated, use the dedicated TODO
7787 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7788 C-c a a}) you may set the number of days to be displayed.
7791 @vindex org-agenda-span
7792 @vindex org-agenda-ndays
7793 @vindex org-agenda-start-day
7794 @vindex org-agenda-start-on-weekday
7795 The default number of days displayed in the agenda is set by the variable
7796 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7797 variable can be set to any number of days you want to see by default in the
7798 agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
7799 @code{year}. For weekly agendas, the default is to start on the previous
7800 monday (see @code{org-agenda-start-on-weekday}). You can also set the start
7801 date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
7802 start the agenda ten days from today in the future.
7804 Remote editing from the agenda buffer means, for example, that you can
7805 change the dates of deadlines and appointments from the agenda buffer.
7806 The commands available in the Agenda buffer are listed in @ref{Agenda
7809 @subsubheading Calendar/Diary integration
7810 @cindex calendar integration
7811 @cindex diary integration
7813 Emacs contains the calendar and diary by Edward M. Reingold. The
7814 calendar displays a three-month calendar with holidays from different
7815 countries and cultures. The diary allows you to keep track of
7816 anniversaries, lunar phases, sunrise/set, recurrent appointments
7817 (weekly, monthly) and more. In this way, it is quite complementary to
7818 Org. It can be very useful to combine output from Org with
7821 In order to include entries from the Emacs diary into Org mode's
7822 agenda, you only need to customize the variable
7825 (setq org-agenda-include-diary t)
7828 @noindent After that, everything will happen automatically. All diary
7829 entries including holidays, anniversaries, etc., will be included in the
7830 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7831 @key{RET} can be used from the agenda buffer to jump to the diary
7832 file in order to edit existing diary entries. The @kbd{i} command to
7833 insert new entries for the current date works in the agenda buffer, as
7834 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7835 Sunrise/Sunset times, show lunar phases and to convert to other
7836 calendars, respectively. @kbd{c} can be used to switch back and forth
7837 between calendar and agenda.
7839 If you are using the diary only for sexp entries and holidays, it is
7840 faster to not use the above setting, but instead to copy or even move
7841 the entries into an Org file. Org mode evaluates diary-style sexp
7842 entries, and does it faster because there is no overhead for first
7843 creating the diary display. Note that the sexp entries must start at
7844 the left margin, no whitespace is allowed before them. For example,
7845 the following segment of an Org file will be processed and entries
7846 will be made in the agenda:
7849 * Birthdays and similar stuff
7851 %%(org-calendar-holiday) ; special function for holiday names
7853 %%(org-anniversary 1956 5 14)@footnote{@code{org-anniversary} is just like @code{diary-anniversary}, but the argument order is always according to ISO and therefore independent of the value of @code{calendar-date-style}.} Arthur Dent is %d years old
7854 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7857 @subsubheading Anniversaries from BBDB
7858 @cindex BBDB, anniversaries
7859 @cindex anniversaries, from BBDB
7861 If you are using the Big Brothers Database to store your contacts, you will
7862 very likely prefer to store anniversaries in BBDB rather than in a
7863 separate Org or diary file. Org supports this and will show BBDB
7864 anniversaries as part of the agenda. All you need to do is to add the
7865 following to one of your agenda files:
7872 %%(org-bbdb-anniversaries)
7875 You can then go ahead and define anniversaries for a BBDB record. Basically,
7876 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7877 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7878 followed by a space and the class of the anniversary (@samp{birthday} or
7879 @samp{wedding}, or a format string). If you omit the class, it will default to
7880 @samp{birthday}. Here are a few examples, the header for the file
7881 @file{org-bbdb.el} contains more detailed information.
7887 2008-04-14 %s released version 6.01 of org mode, %d years ago
7890 After a change to BBDB, or for the first agenda display during an Emacs
7891 session, the agenda display will suffer a short delay as Org updates its
7892 hash with anniversaries. However, from then on things will be very fast---much
7893 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7894 in an Org or Diary file.
7896 @subsubheading Appointment reminders
7897 @cindex @file{appt.el}
7898 @cindex appointment reminders
7902 Org can interact with Emacs appointments notification facility. To add the
7903 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7904 This command lets you filter through the list of your appointments and add
7905 only those belonging to a specific category or matching a regular expression.
7906 It also reads a @code{APPT_WARNTIME} property which will then override the
7907 value of @code{appt-message-warning-time} for this appointment. See the
7908 docstring for details.
7910 @node Global TODO list
7911 @subsection The global TODO list
7912 @cindex global TODO list
7913 @cindex TODO list, global
7915 The global TODO list contains all unfinished TODO items formatted and
7916 collected into a single place.
7919 @orgcmd{C-c a t,org-todo-list}
7920 Show the global TODO list. This collects the TODO items from all agenda
7921 files (@pxref{Agenda views}) into a single buffer. By default, this lists
7922 items with a state the is not a DONE state. The buffer is in
7923 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7924 entries directly from that buffer (@pxref{Agenda commands}).
7925 @orgcmd{C-c a T,org-todo-list}
7926 @cindex TODO keyword matching
7927 @vindex org-todo-keywords
7928 Like the above, but allows selection of a specific TODO keyword. You can
7929 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7930 prompted for a keyword, and you may also specify several keywords by
7931 separating them with @samp{|} as the boolean OR operator. With a numeric
7932 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7934 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7935 a prefix argument to this command to change the selected TODO keyword,
7936 for example @kbd{3 r}. If you often need a search for a specific
7937 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7938 Matching specific TODO keywords can also be done as part of a tags
7939 search (@pxref{Tag searches}).
7942 Remote editing of TODO items means that you can change the state of a
7943 TODO entry with a single key press. The commands available in the
7944 TODO list are described in @ref{Agenda commands}.
7946 @cindex sublevels, inclusion into TODO list
7947 Normally the global TODO list simply shows all headlines with TODO
7948 keywords. This list can become very long. There are two ways to keep
7952 @vindex org-agenda-todo-ignore-scheduled
7953 @vindex org-agenda-todo-ignore-deadlines
7954 @vindex org-agenda-todo-ignore-timestamp
7955 @vindex org-agenda-todo-ignore-with-date
7956 Some people view a TODO item that has been @emph{scheduled} for execution or
7957 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7958 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7959 @code{org-agenda-todo-ignore-deadlines},
7960 @code{org-agenda-todo-ignore-timestamp} and/or
7961 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7964 @vindex org-agenda-todo-list-sublevels
7965 TODO items may have sublevels to break up the task into subtasks. In
7966 such cases it may be enough to list only the highest level TODO headline
7967 and omit the sublevels from the global list. Configure the variable
7968 @code{org-agenda-todo-list-sublevels} to get this behavior.
7971 @node Matching tags and properties
7972 @subsection Matching tags and properties
7973 @cindex matching, of tags
7974 @cindex matching, of properties
7978 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7979 or have properties (@pxref{Properties and columns}), you can select headlines
7980 based on this metadata and collect them into an agenda buffer. The match
7981 syntax described here also applies when creating sparse trees with @kbd{C-c /
7985 @orgcmd{C-c a m,org-tags-view}
7986 Produce a list of all headlines that match a given set of tags. The
7987 command prompts for a selection criterion, which is a boolean logic
7988 expression with tags, like @samp{+work+urgent-withboss} or
7989 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7990 define a custom command for it (@pxref{Agenda dispatcher}).
7991 @orgcmd{C-c a M,org-tags-view}
7992 @vindex org-tags-match-list-sublevels
7993 @vindex org-agenda-tags-todo-honor-ignore-options
7994 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7995 not-DONE state and force checking subitems (see variable
7996 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7997 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7998 specific TODO keywords together with a tags match is also possible, see
8002 The commands available in the tags list are described in @ref{Agenda
8005 @subsubheading Match syntax
8007 @cindex Boolean logic, for tag/property searches
8008 A search string can use Boolean operators @samp{&} for @code{AND} and
8009 @samp{|} for @code{OR}@. @samp{&} binds more strongly than @samp{|}.
8010 Parentheses are not implemented. Each element in the search is either a
8011 tag, a regular expression matching tags, or an expression like
8012 @code{PROPERTY OPERATOR VALUE} with a comparison operator, accessing a
8013 property value. Each element may be preceded by @samp{-}, to select
8014 against it, and @samp{+} is syntactic sugar for positive selection. The
8015 @code{AND} operator @samp{&} is optional when @samp{+} or @samp{-} is
8016 present. Here are some examples, using only tags.
8020 Select headlines tagged @samp{:work:}.
8022 Select headlines tagged @samp{:work:} and @samp{:boss:}.
8024 Select headlines tagged @samp{:work:}, but discard those also tagged
8027 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
8028 @item work|laptop+night
8029 Like before, but require the @samp{:laptop:} lines to be tagged also
8033 @cindex regular expressions, with tags search
8034 Instead of a tag, you may also specify a regular expression enclosed in curly
8035 braces. For example,
8036 @samp{work+@{^boss.*@}} matches headlines that contain the tag
8037 @samp{:work:} and any tag @i{starting} with @samp{boss}.
8039 @cindex group tags, as regular expressions
8040 Group tags (@pxref{Tag groups}) are expanded as regular expressions. E.g.,
8041 if @samp{:work:} is a group tag for the group @samp{:work:lab:conf:}, then
8042 searching for @samp{work} will search for @samp{@{\(?:work\|lab\|conf\)@}}
8043 and searching for @samp{-work} will search for all headlines but those with
8044 one of the tags in the group (i.e., @samp{-@{\(?:work\|lab\|conf\)@}}).
8046 @cindex TODO keyword matching, with tags search
8047 @cindex level, require for tags/property match
8048 @cindex category, require for tags/property match
8049 @vindex org-odd-levels-only
8050 You may also test for properties (@pxref{Properties and columns}) at the same
8051 time as matching tags. The properties may be real properties, or special
8052 properties that represent other metadata (@pxref{Special properties}). For
8053 example, the ``property'' @code{TODO} represents the TODO keyword of the
8054 entry and the ``property'' @code{PRIORITY} represents the PRIORITY keyword of
8055 the entry. The ITEM special property cannot currently be used in tags/property
8056 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
8057 ,skipping entries based on regexp}.}.
8059 In addition to the @pxref{Special properties}, one other ``property'' can
8060 also be used. @code{LEVEL} represents the level of an entry. So a search
8061 @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines that have
8062 the tag @samp{boss} and are @emph{not} marked with the TODO keyword DONE@.
8063 In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not count
8064 the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
8066 Here are more examples:
8069 @item work+TODO="WAITING"
8070 Select @samp{:work:}-tagged TODO lines with the specific TODO
8071 keyword @samp{WAITING}.
8072 @item work+TODO="WAITING"|home+TODO="WAITING"
8073 Waiting tasks both at work and at home.
8076 When matching properties, a number of different operators can be used to test
8077 the value of a property. Here is a complex example:
8080 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
8081 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
8085 The type of comparison will depend on how the comparison value is written:
8088 If the comparison value is a plain number, a numerical comparison is done,
8089 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
8090 @samp{>=}, and @samp{<>}.
8092 If the comparison value is enclosed in double-quotes,
8093 a string comparison is done, and the same operators are allowed.
8095 If the comparison value is enclosed in double-quotes @emph{and} angular
8096 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
8097 assumed to be date/time specifications in the standard Org way, and the
8098 comparison will be done accordingly. Special values that will be recognized
8099 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
8100 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
8101 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
8102 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
8103 respectively, can be used.
8105 If the comparison value is enclosed
8106 in curly braces, a regexp match is performed, with @samp{=} meaning that the
8107 regexp matches the property value, and @samp{<>} meaning that it does not
8111 So the search string in the example finds entries tagged @samp{:work:} but
8112 not @samp{:boss:}, which also have a priority value @samp{A}, a
8113 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
8114 property that is numerically smaller than 2, a @samp{:With:} property that is
8115 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
8116 on or after October 11, 2008.
8118 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
8119 other properties will slow down the search. However, once you have paid the
8120 price by accessing one property, testing additional properties is cheap
8123 You can configure Org mode to use property inheritance during a search, but
8124 beware that this can slow down searches considerably. See @ref{Property
8125 inheritance}, for details.
8127 For backward compatibility, and also for typing speed, there is also a
8128 different way to test TODO states in a search. For this, terminate the
8129 tags/property part of the search string (which may include several terms
8130 connected with @samp{|}) with a @samp{/} and then specify a Boolean
8131 expression just for TODO keywords. The syntax is then similar to that for
8132 tags, but should be applied with care: for example, a positive selection on
8133 several TODO keywords cannot meaningfully be combined with boolean AND@.
8134 However, @emph{negative selection} combined with AND can be meaningful. To
8135 make sure that only lines are checked that actually have any TODO keyword
8136 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
8137 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
8138 not match TODO keywords in a DONE state. Examples:
8142 Same as @samp{work+TODO="WAITING"}
8143 @item work/!-WAITING-NEXT
8144 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
8146 @item work/!+WAITING|+NEXT
8147 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
8152 @subsection Timeline for a single file
8153 @cindex timeline, single file
8154 @cindex time-sorted view
8156 The timeline summarizes all time-stamped items from a single Org mode
8157 file in a @emph{time-sorted view}. The main purpose of this command is
8158 to give an overview over events in a project.
8161 @orgcmd{C-c a L,org-timeline}
8162 Show a time-sorted view of the Org file, with all time-stamped items.
8163 When called with a @kbd{C-u} prefix, all unfinished TODO entries
8164 (scheduled or not) are also listed under the current date.
8168 The commands available in the timeline buffer are listed in
8169 @ref{Agenda commands}.
8172 @subsection Search view
8175 @cindex searching, for text
8177 This agenda view is a general text search facility for Org mode entries.
8178 It is particularly useful to find notes.
8181 @orgcmd{C-c a s,org-search-view}
8182 This is a special search that lets you select entries by matching a substring
8183 or specific words using a boolean logic.
8185 For example, the search string @samp{computer equipment} will find entries
8186 that contain @samp{computer equipment} as a substring. If the two words are
8187 separated by more space or a line break, the search will still match.
8188 Search view can also search for specific keywords in the entry, using Boolean
8189 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
8190 will search for note entries that contain the keywords @code{computer}
8191 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
8192 not matched by the regular expression @code{8\.11[bg]}, meaning to
8193 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
8194 word search, other @samp{+} characters are optional. For more details, see
8195 the docstring of the command @code{org-search-view}.
8197 @vindex org-agenda-text-search-extra-files
8198 Note that in addition to the agenda files, this command will also search
8199 the files listed in @code{org-agenda-text-search-extra-files}.
8201 @node Stuck projects
8202 @subsection Stuck projects
8203 @pindex GTD, Getting Things Done
8205 If you are following a system like David Allen's GTD to organize your
8206 work, one of the ``duties'' you have is a regular review to make sure
8207 that all projects move along. A @emph{stuck} project is a project that
8208 has no defined next actions, so it will never show up in the TODO lists
8209 Org mode produces. During the review, you need to identify such
8210 projects and define next actions for them.
8213 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
8214 List projects that are stuck.
8217 @vindex org-stuck-projects
8218 Customize the variable @code{org-stuck-projects} to define what a stuck
8219 project is and how to find it.
8222 You almost certainly will have to configure this view before it will
8223 work for you. The built-in default assumes that all your projects are
8224 level-2 headlines, and that a project is not stuck if it has at least
8225 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
8227 Let's assume that you, in your own way of using Org mode, identify
8228 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
8229 indicate a project that should not be considered yet. Let's further
8230 assume that the TODO keyword DONE marks finished projects, and that NEXT
8231 and TODO indicate next actions. The tag @@SHOP indicates shopping and
8232 is a next action even without the NEXT tag. Finally, if the project
8233 contains the special word IGNORE anywhere, it should not be listed
8234 either. In this case you would start by identifying eligible projects
8235 with a tags/todo match@footnote{@xref{Tag searches}.}
8236 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
8237 IGNORE in the subtree to identify projects that are not stuck. The
8238 correct customization for this is
8241 (setq org-stuck-projects
8242 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
8246 Note that if a project is identified as non-stuck, the subtree of this entry
8247 will still be searched for stuck projects.
8249 @node Presentation and sorting
8250 @section Presentation and sorting
8251 @cindex presentation, of agenda items
8253 @vindex org-agenda-prefix-format
8254 @vindex org-agenda-tags-column
8255 Before displaying items in an agenda view, Org mode visually prepares the
8256 items and sorts them. Each item occupies a single line. The line starts
8257 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
8258 of the item and other important information. You can customize in which
8259 column tags will be displayed through @code{org-agenda-tags-column}. You can
8260 also customize the prefix using the option @code{org-agenda-prefix-format}.
8261 This prefix is followed by a cleaned-up version of the outline headline
8262 associated with the item.
8265 * Categories:: Not all tasks are equal
8266 * Time-of-day specifications:: How the agenda knows the time
8267 * Sorting agenda items:: The order of things
8268 * Filtering/limiting agenda items:: Dynamically narrow the agenda
8272 @subsection Categories
8276 The category is a broad label assigned to each agenda item. By default,
8277 the category is simply derived from the file name, but you can also
8278 specify it with a special line in the buffer, like this@footnote{For
8279 backward compatibility, the following also works: if there are several
8280 such lines in a file, each specifies the category for the text below it.
8281 The first category also applies to any text before the first CATEGORY
8282 line. However, using this method is @emph{strongly} deprecated as it is
8283 incompatible with the outline structure of the document. The correct
8284 method for setting multiple categories in a buffer is using a
8292 @cindex property, CATEGORY
8293 If you would like to have a special CATEGORY for a single entry or a
8294 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8295 special category you want to apply as the value.
8298 The display in the agenda buffer looks best if the category is not
8299 longer than 10 characters.
8302 You can set up icons for category by customizing the
8303 @code{org-agenda-category-icon-alist} variable.
8305 @node Time-of-day specifications
8306 @subsection Time-of-day specifications
8307 @cindex time-of-day specification
8309 Org mode checks each agenda item for a time-of-day specification. The
8310 time can be part of the timestamp that triggered inclusion into the
8311 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8312 ranges can be specified with two timestamps, like
8314 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8316 In the headline of the entry itself, a time(range) may also appear as
8317 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8318 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8319 specifications in diary entries are recognized as well.
8321 For agenda display, Org mode extracts the time and displays it in a
8322 standard 24 hour format as part of the prefix. The example times in
8323 the previous paragraphs would end up in the agenda like this:
8326 8:30-13:00 Arthur Dent lies in front of the bulldozer
8327 12:45...... Ford Prefect arrives and takes Arthur to the pub
8328 19:00...... The Vogon reads his poem
8329 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8333 If the agenda is in single-day mode, or for the display of today, the
8334 timed entries are embedded in a time grid, like
8337 8:00...... ------------------
8338 8:30-13:00 Arthur Dent lies in front of the bulldozer
8339 10:00...... ------------------
8340 12:00...... ------------------
8341 12:45...... Ford Prefect arrives and takes Arthur to the pub
8342 14:00...... ------------------
8343 16:00...... ------------------
8344 18:00...... ------------------
8345 19:00...... The Vogon reads his poem
8346 20:00...... ------------------
8347 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8350 @vindex org-agenda-use-time-grid
8351 @vindex org-agenda-time-grid
8352 The time grid can be turned on and off with the variable
8353 @code{org-agenda-use-time-grid}, and can be configured with
8354 @code{org-agenda-time-grid}.
8356 @node Sorting agenda items
8357 @subsection Sorting agenda items
8358 @cindex sorting, of agenda items
8359 @cindex priorities, of agenda items
8360 Before being inserted into a view, the items are sorted. How this is
8361 done depends on the type of view.
8364 @vindex org-agenda-files
8365 For the daily/weekly agenda, the items for each day are sorted. The
8366 default order is to first collect all items containing an explicit
8367 time-of-day specification. These entries will be shown at the beginning
8368 of the list, as a @emph{schedule} for the day. After that, items remain
8369 grouped in categories, in the sequence given by @code{org-agenda-files}.
8370 Within each category, items are sorted by priority (@pxref{Priorities}),
8371 which is composed of the base priority (2000 for priority @samp{A}, 1000
8372 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8373 overdue scheduled or deadline items.
8375 For the TODO list, items remain in the order of categories, but within
8376 each category, sorting takes place according to priority
8377 (@pxref{Priorities}). The priority used for sorting derives from the
8378 priority cookie, with additions depending on how close an item is to its due
8381 For tags matches, items are not sorted at all, but just appear in the
8382 sequence in which they are found in the agenda files.
8385 @vindex org-agenda-sorting-strategy
8386 Sorting can be customized using the variable
8387 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8388 the estimated effort of an entry (@pxref{Effort estimates}).
8390 @node Filtering/limiting agenda items
8391 @subsection Filtering/limiting agenda items
8393 Agenda built-in or customized commands are statically defined. Agenda
8394 filters and limits provide two ways of dynamically narrowing down the list of
8395 agenda entries: @emph{filters} and @emph{limits}. Filters only act on the
8396 display of the items, while limits take effect before the list of agenda
8397 entries is built. Filters are more often used interactively, while limits are
8398 mostly useful when defined as local variables within custom agenda commands.
8400 @subsubheading Filtering in the agenda
8401 @cindex filtering, by tag, category, top headline and effort, in agenda
8402 @cindex tag filtering, in agenda
8403 @cindex category filtering, in agenda
8404 @cindex top headline filtering, in agenda
8405 @cindex effort filtering, in agenda
8406 @cindex query editing, in agenda
8409 @orgcmd{/,org-agenda-filter-by-tag}
8410 @vindex org-agenda-tag-filter-preset
8411 Filter the agenda view with respect to a tag and/or effort estimates. The
8412 difference between this and a custom agenda command is that filtering is very
8413 fast, so that you can switch quickly between different filters without having
8414 to recreate the agenda.@footnote{Custom commands can preset a filter by
8415 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8416 filter will then be applied to the view and persist as a basic filter through
8417 refreshes and more secondary filtering. The filter is a global property of
8418 the entire agenda view---in a block agenda, you should only set this in the
8419 global options section, not in the section of an individual block.}
8421 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8422 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8423 tag (including any tags that do not have a selection character). The command
8424 then hides all entries that do not contain or inherit this tag. When called
8425 with prefix arg, remove the entries that @emph{do} have the tag. A second
8426 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8427 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8428 will be narrowed by requiring or forbidding the selected additional tag.
8429 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8430 immediately use the @kbd{\} command.
8432 @vindex org-sort-agenda-noeffort-is-high
8433 In order to filter for effort estimates, you should set up allowed
8434 efforts globally, for example
8436 (setq org-global-properties
8437 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8439 You can then filter for an effort by first typing an operator, one of
8440 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8441 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8442 The filter will then restrict to entries with effort smaller-or-equal, equal,
8443 or larger-or-equal than the selected value. If the digits 0--9 are not used
8444 as fast access keys to tags, you can also simply press the index digit
8445 directly without an operator. In this case, @kbd{<} will be assumed. For
8446 application of the operator, entries without a defined effort will be treated
8447 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
8448 for tasks without effort definition, press @kbd{?} as the operator.
8450 Org also supports automatic, context-aware tag filtering. If the variable
8451 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8452 that function can decide which tags should be excluded from the agenda
8453 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8454 as a sub-option key and runs the auto exclusion logic. For example, let's
8455 say you use a @code{Net} tag to identify tasks which need network access, an
8456 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8457 calls. You could auto-exclude these tags based on the availability of the
8458 Internet, and outside of business hours, with something like this:
8462 (defun org-my-auto-exclude-function (tag)
8464 ((string= tag "Net")
8465 (/= 0 (call-process "/sbin/ping" nil nil nil
8466 "-c1" "-q" "-t1" "mail.gnu.org")))
8467 ((or (string= tag "Errand") (string= tag "Call"))
8468 (let ((hour (nth 2 (decode-time))))
8469 (or (< hour 8) (> hour 21)))))
8472 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8476 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8477 Narrow the current agenda filter by an additional condition. When called with
8478 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8479 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8480 @kbd{-} as the first key after the @kbd{/} command.
8489 @item @r{in} search view
8490 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8491 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8492 add a positive search term prefixed by @samp{+}, indicating that this search
8493 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8494 negative search term which @i{must not} occur/match in the entry for it to be
8498 @orgcmd{<,org-agenda-filter-by-category}
8499 @vindex org-agenda-category-filter-preset
8501 Filter the current agenda view with respect to the category of the item at
8502 point. Pressing @code{<} another time will remove this filter. You can add
8503 a filter preset through the option @code{org-agenda-category-filter-preset}
8506 @orgcmd{^,org-agenda-filter-by-top-headline}
8507 Filter the current agenda view and only display the siblings and the parent
8508 headline of the one at point.
8510 @orgcmd{=,org-agenda-filter-by-regexp}
8511 @vindex org-agenda-regexp-filter-preset
8513 Filter the agenda view by a regular expression: only show agenda entries
8514 matching the regular expression the user entered. When called with a prefix
8515 argument, it will filter @emph{out} entries matching the regexp. With two
8516 universal prefix arguments, it will remove all the regexp filters, which can
8517 be accumulated. You can add a filter preset through the option
8518 @code{org-agenda-category-filter-preset} (see below.)
8520 @orgcmd{|,org-agenda-filter-remove-all}
8521 Remove all filters in the current agenda view.
8524 @subsubheading Setting limits for the agenda
8525 @cindex limits, in agenda
8526 @vindex org-agenda-max-entries
8527 @vindex org-agenda-max-effort
8528 @vindex org-agenda-max-todos
8529 @vindex org-agenda-max-tags
8531 Here is a list of options that you can set, either globally, or locally in
8532 your custom agenda views@pxref{Custom agenda views}.
8535 @item org-agenda-max-entries
8536 Limit the number of entries.
8537 @item org-agenda-max-effort
8538 Limit the duration of accumulated efforts (as minutes).
8539 @item org-agenda-max-todos
8540 Limit the number of entries with TODO keywords.
8541 @item org-agenda-max-tags
8542 Limit the number of tagged entries.
8545 When set to a positive integer, each option will exclude entries from other
8546 categories: for example, @code{(setq org-agenda-max-effort 100)} will limit
8547 the agenda to 100 minutes of effort and exclude any entry that has no effort
8548 property. If you want to include entries with no effort property, use a
8549 negative value for @code{org-agenda-max-effort}.
8551 One useful setup is to use @code{org-agenda-max-entries} locally in a custom
8552 command. For example, this custom command will display the next five entries
8553 with a @code{NEXT} TODO keyword.
8556 (setq org-agenda-custom-commands
8558 ((org-agenda-max-entries 5)))))
8561 Once you mark one of these five entry as @code{DONE}, rebuilding the agenda
8562 will again the next five entries again, including the first entry that was
8565 You can also dynamically set temporary limits@footnote{Those temporary limits
8566 are lost when rebuilding the agenda.}:
8569 @orgcmd{~,org-agenda-limit-interactively}
8570 This prompts for the type of limit to apply and its value.
8573 @node Agenda commands
8574 @section Commands in the agenda buffer
8575 @cindex commands, in agenda buffer
8577 Entries in the agenda buffer are linked back to the Org file or diary
8578 file where they originate. You are not allowed to edit the agenda
8579 buffer itself, but commands are provided to show and jump to the
8580 original entry location, and to edit the Org files ``remotely'' from
8581 the agenda buffer. In this way, all information is stored only once,
8582 removing the risk that your agenda and note files may diverge.
8584 Some commands can be executed with mouse clicks on agenda lines. For
8585 the other commands, the cursor needs to be in the desired line.
8588 @tsubheading{Motion}
8589 @cindex motion commands in agenda
8590 @orgcmd{n,org-agenda-next-line}
8591 Next line (same as @key{down} and @kbd{C-n}).
8592 @orgcmd{p,org-agenda-previous-line}
8593 Previous line (same as @key{up} and @kbd{C-p}).
8594 @tsubheading{View/Go to Org file}
8595 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8596 Display the original location of the item in another window.
8597 With prefix arg, make sure that the entire entry is made visible in the
8598 outline, not only the heading.
8600 @orgcmd{L,org-agenda-recenter}
8601 Display original location and recenter that window.
8603 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8604 Go to the original location of the item in another window.
8606 @orgcmd{@key{RET},org-agenda-switch-to}
8607 Go to the original location of the item and delete other windows.
8609 @orgcmd{F,org-agenda-follow-mode}
8610 @vindex org-agenda-start-with-follow-mode
8611 Toggle Follow mode. In Follow mode, as you move the cursor through
8612 the agenda buffer, the other window always shows the corresponding
8613 location in the Org file. The initial setting for this mode in new
8614 agenda buffers can be set with the variable
8615 @code{org-agenda-start-with-follow-mode}.
8617 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8618 Display the entire subtree of the current item in an indirect buffer. With a
8619 numeric prefix argument N, go up to level N and then take that tree. If N is
8620 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8621 previously used indirect buffer.
8623 @orgcmd{C-c C-o,org-agenda-open-link}
8624 Follow a link in the entry. This will offer a selection of any links in the
8625 text belonging to the referenced Org node. If there is only one link, it
8626 will be followed without a selection prompt.
8628 @tsubheading{Change display}
8629 @cindex display changing, in agenda
8632 Interactively select another agenda view and append it to the current view.
8636 Delete other windows.
8638 @orgcmdkskc{v d,d,org-agenda-day-view}
8639 @xorgcmdkskc{v w,w,org-agenda-week-view}
8640 @xorgcmd{v t,org-agenda-fortnight-view}
8641 @xorgcmd{v m,org-agenda-month-view}
8642 @xorgcmd{v y,org-agenda-year-view}
8643 @xorgcmd{v SPC,org-agenda-reset-view}
8644 @vindex org-agenda-span
8645 Switch to day/week/month/year view. When switching to day or week view, this
8646 setting becomes the default for subsequent agenda refreshes. Since month and
8647 year views are slow to create, they do not become the default. A numeric
8648 prefix argument may be used to jump directly to a specific day of the year,
8649 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8650 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8651 month view, a year may be encoded in the prefix argument as well. For
8652 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8653 specification has only one or two digits, it will be mapped to the interval
8654 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8655 @code{org-agenda-span}.
8657 @orgcmd{f,org-agenda-later}
8658 Go forward in time to display the following @code{org-agenda-current-span} days.
8659 For example, if the display covers a week, switch to the following week.
8660 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8662 @orgcmd{b,org-agenda-earlier}
8663 Go backward in time to display earlier dates.
8665 @orgcmd{.,org-agenda-goto-today}
8668 @orgcmd{j,org-agenda-goto-date}
8669 Prompt for a date and go there.
8671 @orgcmd{J,org-agenda-clock-goto}
8672 Go to the currently clocked-in task @i{in the agenda buffer}.
8674 @orgcmd{D,org-agenda-toggle-diary}
8675 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8677 @orgcmdkskc{v l,l,org-agenda-log-mode}
8679 @vindex org-log-done
8680 @vindex org-agenda-log-mode-items
8681 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8682 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8683 entries that have been clocked on that day. You can configure the entry
8684 types that should be included in log mode using the variable
8685 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8686 all possible logbook entries, including state changes. When called with two
8687 prefix arguments @kbd{C-u C-u}, show only logging information, nothing else.
8688 @kbd{v L} is equivalent to @kbd{C-u v l}.
8690 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8691 Include inactive timestamps into the current view. Only for weekly/daily
8692 agenda and timeline views.
8694 @orgcmd{v a,org-agenda-archives-mode}
8695 @xorgcmd{v A,org-agenda-archives-mode 'files}
8696 Toggle Archives mode. In Archives mode, trees that are marked
8697 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8698 capital @kbd{A}, even all archive files are included. To exit archives mode,
8699 press @kbd{v a} again.
8701 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8702 @vindex org-agenda-start-with-clockreport-mode
8703 @vindex org-clock-report-include-clocking-task
8704 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8705 always show a table with the clocked times for the time span and file scope
8706 covered by the current agenda view. The initial setting for this mode in new
8707 agenda buffers can be set with the variable
8708 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8709 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8710 contributions from entries that are hidden by agenda filtering@footnote{Only
8711 tags filtering will be respected here, effort filtering is ignored.}. See
8712 also the variable @code{org-clock-report-include-clocking-task}.
8715 @vindex org-agenda-clock-consistency-checks
8716 Show overlapping clock entries, clocking gaps, and other clocking problems in
8717 the current agenda range. You can then visit clocking lines and fix them
8718 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8719 information on how to customize the definition of what constituted a clocking
8720 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8723 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8724 @vindex org-agenda-start-with-entry-text-mode
8725 @vindex org-agenda-entry-text-maxlines
8726 Toggle entry text mode. In entry text mode, a number of lines from the Org
8727 outline node referenced by an agenda line will be displayed below the line.
8728 The maximum number of lines is given by the variable
8729 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8730 prefix argument will temporarily modify that number to the prefix value.
8732 @orgcmd{G,org-agenda-toggle-time-grid}
8733 @vindex org-agenda-use-time-grid
8734 @vindex org-agenda-time-grid
8735 Toggle the time grid on and off. See also the variables
8736 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8738 @orgcmd{r,org-agenda-redo}
8739 Recreate the agenda buffer, for example to reflect the changes after
8740 modification of the timestamps of items with @kbd{S-@key{left}} and
8741 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8742 argument is interpreted to create a selective list for a specific TODO
8744 @orgcmd{g,org-agenda-redo}
8747 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8748 Save all Org buffers in the current Emacs session, and also the locations of
8751 @orgcmd{C-c C-x C-c,org-agenda-columns}
8752 @vindex org-columns-default-format
8753 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8754 view format is taken from the entry at point, or (if there is no entry at
8755 point), from the first entry in the agenda view. So whatever the format for
8756 that entry would be in the original buffer (taken from a property, from a
8757 @code{#+COLUMNS} line, or from the default variable
8758 @code{org-columns-default-format}), will be used in the agenda.
8760 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8761 Remove the restriction lock on the agenda, if it is currently restricted to a
8762 file or subtree (@pxref{Agenda files}).
8764 @tsubheading{Secondary filtering and query editing}
8766 For a detailed description of these commands, see @pxref{Filtering/limiting
8769 @orgcmd{/,org-agenda-filter-by-tag}
8770 @vindex org-agenda-tag-filter-preset
8771 Filter the agenda view with respect to a tag and/or effort estimates.
8773 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8774 Narrow the current agenda filter by an additional condition.
8776 @orgcmd{<,org-agenda-filter-by-category}
8777 @vindex org-agenda-category-filter-preset
8779 Filter the current agenda view with respect to the category of the item at
8780 point. Pressing @code{<} another time will remove this filter.
8782 @orgcmd{^,org-agenda-filter-by-top-headline}
8783 Filter the current agenda view and only display the siblings and the parent
8784 headline of the one at point.
8786 @orgcmd{=,org-agenda-filter-by-regexp}
8787 @vindex org-agenda-regexp-filter-preset
8789 Filter the agenda view by a regular expression: only show agenda entries
8790 matching the regular expression the user entered. When called with a prefix
8791 argument, it will filter @emph{out} entries matching the regexp. With two
8792 universal prefix arguments, it will remove all the regexp filters, which can
8793 be accumulated. You can add a filter preset through the option
8794 @code{org-agenda-category-filter-preset} (see below.)
8796 @orgcmd{|,org-agenda-filter-remove-all}
8797 Remove all filters in the current agenda view.
8799 @tsubheading{Remote editing}
8800 @cindex remote editing, from agenda
8805 @cindex undoing remote-editing events
8806 @cindex remote editing, undo
8807 @orgcmd{C-_,org-agenda-undo}
8808 Undo a change due to a remote editing command. The change is undone
8809 both in the agenda buffer and in the remote buffer.
8811 @orgcmd{t,org-agenda-todo}
8812 Change the TODO state of the item, both in the agenda and in the
8815 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8816 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8817 Switch to the next/previous set of TODO keywords.
8819 @orgcmd{C-k,org-agenda-kill}
8820 @vindex org-agenda-confirm-kill
8821 Delete the current agenda item along with the entire subtree belonging
8822 to it in the original Org file. If the text to be deleted remotely
8823 is longer than one line, the kill needs to be confirmed by the user. See
8824 variable @code{org-agenda-confirm-kill}.
8826 @orgcmd{C-c C-w,org-agenda-refile}
8827 Refile the entry at point.
8829 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8830 @vindex org-archive-default-command
8831 Archive the subtree corresponding to the entry at point using the default
8832 archiving command set in @code{org-archive-default-command}. When using the
8833 @code{a} key, confirmation will be required.
8835 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8836 Toggle the ARCHIVE tag for the current headline.
8838 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8839 Move the subtree corresponding to the current entry to its @emph{archive
8842 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8843 Archive the subtree corresponding to the current headline. This means the
8844 entry will be moved to the configured archive location, most likely a
8847 @orgcmd{T,org-agenda-show-tags}
8848 @vindex org-agenda-show-inherited-tags
8849 Show all tags associated with the current item. This is useful if you have
8850 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8851 tags of a headline occasionally.
8853 @orgcmd{:,org-agenda-set-tags}
8854 Set tags for the current headline. If there is an active region in the
8855 agenda, change a tag for all headings in the region.
8859 Set the priority for the current item (@command{org-agenda-priority}).
8860 Org mode prompts for the priority character. If you reply with @key{SPC},
8861 the priority cookie is removed from the entry.
8863 @orgcmd{P,org-agenda-show-priority}
8864 Display weighted priority of current item.
8866 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8867 Increase the priority of the current item. The priority is changed in
8868 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8871 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8872 Decrease the priority of the current item.
8874 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8875 @vindex org-log-into-drawer
8876 Add a note to the entry. This note will be recorded, and then filed to the
8877 same location where state change notes are put. Depending on
8878 @code{org-log-into-drawer}, this may be inside a drawer.
8880 @orgcmd{C-c C-a,org-attach}
8881 Dispatcher for all command related to attachments.
8883 @orgcmd{C-c C-s,org-agenda-schedule}
8884 Schedule this item. With prefix arg remove the scheduling timestamp
8886 @orgcmd{C-c C-d,org-agenda-deadline}
8887 Set a deadline for this item. With prefix arg remove the deadline.
8889 @orgcmd{S-@key{right},org-agenda-do-date-later}
8890 Change the timestamp associated with the current line by one day into the
8891 future. If the date is in the past, the first call to this command will move
8893 With a numeric prefix argument, change it by that many days. For example,
8894 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8895 change the time by one hour. If you immediately repeat the command, it will
8896 continue to change hours even without the prefix arg. With a double @kbd{C-u
8897 C-u} prefix, do the same for changing minutes.@*
8898 The stamp is changed in the original Org file, but the change is not directly
8899 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8901 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8902 Change the timestamp associated with the current line by one day
8905 @orgcmd{>,org-agenda-date-prompt}
8906 Change the timestamp associated with the current line. The key @kbd{>} has
8907 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8909 @orgcmd{I,org-agenda-clock-in}
8910 Start the clock on the current item. If a clock is running already, it
8913 @orgcmd{O,org-agenda-clock-out}
8914 Stop the previously started clock.
8916 @orgcmd{X,org-agenda-clock-cancel}
8917 Cancel the currently running clock.
8919 @orgcmd{J,org-agenda-clock-goto}
8920 Jump to the running clock in another window.
8922 @orgcmd{k,org-agenda-capture}
8923 Like @code{org-capture}, but use the date at point as the default date for
8924 the capture template. See @code{org-capture-use-agenda-date} to make this
8925 the default behavior of @code{org-capture}.
8926 @cindex capturing, from agenda
8927 @vindex org-capture-use-agenda-date
8929 @tsubheading{Dragging agenda lines forward/backward}
8930 @cindex dragging, agenda lines
8932 @orgcmd{M-<up>,org-agenda-drag-line-backward}
8933 Drag the line at point backward one line@footnote{Moving agenda lines does
8934 not persist after an agenda refresh and does not modify the contributing
8935 @file{.org} files}. With a numeric prefix argument, drag backward by that
8938 @orgcmd{M-<down>,org-agenda-drag-line-forward}
8939 Drag the line at point forward one line. With a numeric prefix argument,
8940 drag forward by that many lines.
8942 @tsubheading{Bulk remote editing selected entries}
8943 @cindex remote editing, bulk, from agenda
8944 @vindex org-agenda-bulk-custom-functions
8946 @orgcmd{m,org-agenda-bulk-mark}
8947 Mark the entry at point for bulk action. With numeric prefix argument, mark
8948 that many successive entries.
8950 @orgcmd{*,org-agenda-bulk-mark-all}
8951 Mark all visible agenda entries for bulk action.
8953 @orgcmd{u,org-agenda-bulk-unmark}
8954 Unmark entry at point for bulk action.
8956 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8957 Unmark all marked entries for bulk action.
8959 @orgcmd{M-m,org-agenda-bulk-toggle}
8960 Toggle mark of the entry at point for bulk action.
8962 @orgcmd{M-*,org-agenda-bulk-toggle-all}
8963 Toggle marks of all visible entries for bulk action.
8965 @orgcmd{%,org-agenda-bulk-mark-regexp}
8966 Mark entries matching a regular expression for bulk action.
8968 @orgcmd{B,org-agenda-bulk-action}
8969 Bulk action: act on all marked entries in the agenda. This will prompt for
8970 another key to select the action to be applied. The prefix arg to @kbd{B}
8971 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8972 these special timestamps. By default, marks are removed after the bulk. If
8973 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
8974 @code{t} or hit @kbd{p} at the prompt.
8978 Toggle persistent marks.
8980 Archive all selected entries.
8982 Archive entries by moving them to their respective archive siblings.
8984 Change TODO state. This prompts for a single TODO keyword and changes the
8985 state of all selected entries, bypassing blocking and suppressing logging
8986 notes (but not timestamps).
8988 Add a tag to all selected entries.
8990 Remove a tag from all selected entries.
8992 Schedule all items to a new date. To shift existing schedule dates by a
8993 fixed number of days, use something starting with double plus at the prompt,
8994 for example @samp{++8d} or @samp{++2w}.
8996 Set deadline to a specific date.
8998 Prompt for a single refile target and move all entries. The entries will no
8999 longer be in the agenda; refresh (@kbd{g}) to bring them back.
9001 Reschedule randomly into the coming N days. N will be prompted for. With
9002 prefix arg (@kbd{C-u B S}), scatter only across weekdays.
9004 Apply a function@footnote{You can also create persistent custom functions
9005 through @code{org-agenda-bulk-custom-functions}.} to marked entries. For
9006 example, the function below sets the CATEGORY property of the entries to web.
9010 (defun set-category ()
9012 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
9013 (org-agenda-error)))
9014 (buffer (marker-buffer marker)))
9015 (with-current-buffer buffer
9020 (org-back-to-heading t)
9021 (org-set-property "CATEGORY" "web"))))))
9026 @tsubheading{Calendar commands}
9027 @cindex calendar commands, from agenda
9029 @orgcmd{c,org-agenda-goto-calendar}
9030 Open the Emacs calendar and move to the date at the agenda cursor.
9032 @orgcmd{c,org-calendar-goto-agenda}
9033 When in the calendar, compute and show the Org mode agenda for the
9036 @cindex diary entries, creating from agenda
9037 @orgcmd{i,org-agenda-diary-entry}
9038 @vindex org-agenda-diary-file
9039 Insert a new entry into the diary, using the date at the cursor and (for
9040 block entries) the date at the mark. This will add to the Emacs diary
9041 file@footnote{This file is parsed for the agenda when
9042 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
9043 command in the calendar. The diary file will pop up in another window, where
9044 you can add the entry.
9046 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
9047 Org will create entries (in Org mode syntax) in that file instead. Most
9048 entries will be stored in a date-based outline tree that will later make it
9049 easy to archive appointments from previous months/years. The tree will be
9050 built under an entry with a @code{DATE_TREE} property, or else with years as
9051 top-level entries. Emacs will prompt you for the entry text---if you specify
9052 it, the entry will be created in @code{org-agenda-diary-file} without further
9053 interaction. If you directly press @key{RET} at the prompt without typing
9054 text, the target file will be shown in another window for you to finish the
9055 entry there. See also the @kbd{k r} command.
9057 @orgcmd{M,org-agenda-phases-of-moon}
9058 Show the phases of the moon for the three months around current date.
9060 @orgcmd{S,org-agenda-sunrise-sunset}
9061 Show sunrise and sunset times. The geographical location must be set
9062 with calendar variables, see the documentation for the Emacs calendar.
9064 @orgcmd{C,org-agenda-convert-date}
9065 Convert the date at cursor into many other cultural and historic
9068 @orgcmd{H,org-agenda-holidays}
9069 Show holidays for three months around the cursor date.
9071 @item M-x org-icalendar-combine-agenda-files RET
9072 Export a single iCalendar file containing entries from all agenda files.
9073 This is a globally available command, and also available in the agenda menu.
9075 @tsubheading{Exporting to a file}
9076 @orgcmd{C-x C-w,org-agenda-write}
9077 @cindex exporting agenda views
9078 @cindex agenda views, exporting
9079 @vindex org-agenda-exporter-settings
9080 Write the agenda view to a file. Depending on the extension of the selected
9081 file name, the view will be exported as HTML (@file{.html} or @file{.htm}),
9082 Postscript (@file{.ps}), PDF (@file{.pdf}), Org (@file{.org}) and plain text
9083 (any other extension). When exporting to Org, only the body of original
9084 headlines are exported, not subtrees or inherited tags. When called with a
9085 @kbd{C-u} prefix argument, immediately open the newly created file. Use the
9086 variable @code{org-agenda-exporter-settings} to set options for
9087 @file{ps-print} and for @file{htmlize} to be used during export.
9089 @tsubheading{Quit and Exit}
9090 @orgcmd{q,org-agenda-quit}
9091 Quit agenda, remove the agenda buffer.
9093 @cindex agenda files, removing buffers
9094 @orgcmd{x,org-agenda-exit}
9095 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
9096 for the compilation of the agenda. Buffers created by the user to
9097 visit Org files will not be removed.
9101 @node Custom agenda views
9102 @section Custom agenda views
9103 @cindex custom agenda views
9104 @cindex agenda views, custom
9106 Custom agenda commands serve two purposes: to store and quickly access
9107 frequently used TODO and tags searches, and to create special composite
9108 agenda buffers. Custom agenda commands will be accessible through the
9109 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
9112 * Storing searches:: Type once, use often
9113 * Block agenda:: All the stuff you need in a single buffer
9114 * Setting options:: Changing the rules
9117 @node Storing searches
9118 @subsection Storing searches
9120 The first application of custom searches is the definition of keyboard
9121 shortcuts for frequently used searches, either creating an agenda
9122 buffer, or a sparse tree (the latter covering of course only the current
9125 @vindex org-agenda-custom-commands
9126 @cindex agenda views, main example
9127 @cindex agenda, as an agenda views
9128 @cindex agenda*, as an agenda views
9129 @cindex tags, as an agenda view
9130 @cindex todo, as an agenda view
9136 Custom commands are configured in the variable
9137 @code{org-agenda-custom-commands}. You can customize this variable, for
9138 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
9139 Lisp in @file{.emacs}. The following example contains all valid agenda
9144 (setq org-agenda-custom-commands
9147 ("w" todo "WAITING")
9148 ("W" todo-tree "WAITING")
9149 ("u" tags "+boss-urgent")
9150 ("v" tags-todo "+boss-urgent")
9151 ("U" tags-tree "+boss-urgent")
9152 ("f" occur-tree "\\<FIXME\\>")
9153 ("h" . "HOME+Name tags searches") ; description for "h" prefix
9154 ("hl" tags "+home+Lisa")
9155 ("hp" tags "+home+Peter")
9156 ("hk" tags "+home+Kim")))
9161 The initial string in each entry defines the keys you have to press
9162 after the dispatcher command @kbd{C-c a} in order to access the command.
9163 Usually this will be just a single character, but if you have many
9164 similar commands, you can also define two-letter combinations where the
9165 first character is the same in several combinations and serves as a
9166 prefix key@footnote{You can provide a description for a prefix key by
9167 inserting a cons cell with the prefix and the description.}. The second
9168 parameter is the search type, followed by the string or regular
9169 expression to be used for the matching. The example above will
9174 as a global search for agenda entries planned@footnote{@emph{Planned} means
9175 here that these entries have some planning information attached to them, like
9176 a time-stamp, a scheduled or a deadline string. See
9177 @code{org-agenda-entry-types} on how to set what planning information will be
9178 taken into account.} this week/day.
9180 as a global search for agenda entries planned this week/day, but only those
9181 with an hour specification like @code{[h]h:mm}---think of them as appointments.
9183 as a global search for TODO entries with @samp{WAITING} as the TODO
9186 as the same search, but only in the current buffer and displaying the
9187 results as a sparse tree
9189 as a global tags search for headlines marked @samp{:boss:} but not
9192 as the same search as @kbd{C-c a u}, but limiting the search to
9193 headlines that are also TODO items
9195 as the same search as @kbd{C-c a u}, but only in the current buffer and
9196 displaying the result as a sparse tree
9198 to create a sparse tree (again: current buffer only) with all entries
9199 containing the word @samp{FIXME}
9201 as a prefix command for a HOME tags search where you have to press an
9202 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
9203 Peter, or Kim) as additional tag to match.
9206 Note that the @code{*-tree} agenda views need to be called from an
9207 Org buffer as they operate on the current buffer only.
9210 @subsection Block agenda
9211 @cindex block agenda
9212 @cindex agenda, with block views
9214 Another possibility is the construction of agenda views that comprise
9215 the results of @emph{several} commands, each of which creates a block in
9216 the agenda buffer. The available commands include @code{agenda} for the
9217 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
9218 for the global TODO list (as constructed with @kbd{C-c a t}), and the
9219 matching commands discussed above: @code{todo}, @code{tags}, and
9220 @code{tags-todo}. Here are two examples:
9224 (setq org-agenda-custom-commands
9225 '(("h" "Agenda and Home-related tasks"
9229 ("o" "Agenda and Office-related tasks"
9237 This will define @kbd{C-c a h} to create a multi-block view for stuff
9238 you need to attend to at home. The resulting agenda buffer will contain
9239 your agenda for the current week, all TODO items that carry the tag
9240 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
9241 command @kbd{C-c a o} provides a similar view for office tasks.
9243 @node Setting options
9244 @subsection Setting options for custom commands
9245 @cindex options, for custom agenda views
9247 @vindex org-agenda-custom-commands
9248 Org mode contains a number of variables regulating agenda construction
9249 and display. The global variables define the behavior for all agenda
9250 commands, including the custom commands. However, if you want to change
9251 some settings just for a single custom view, you can do so. Setting
9252 options requires inserting a list of variable names and values at the
9253 right spot in @code{org-agenda-custom-commands}. For example:
9257 (setq org-agenda-custom-commands
9258 '(("w" todo "WAITING"
9259 ((org-agenda-sorting-strategy '(priority-down))
9260 (org-agenda-prefix-format " Mixed: ")))
9261 ("U" tags-tree "+boss-urgent"
9262 ((org-show-following-heading nil)
9263 (org-show-hierarchy-above nil)))
9265 ((org-agenda-files '("~org/notes.org"))
9266 (org-agenda-text-search-extra-files nil)))))
9271 Now the @kbd{C-c a w} command will sort the collected entries only by
9272 priority, and the prefix format is modified to just say @samp{ Mixed: }
9273 instead of giving the category of the entry. The sparse tags tree of
9274 @kbd{C-c a U} will now turn out ultra-compact, because neither the
9275 headline hierarchy above the match, nor the headline following the match
9276 will be shown. The command @kbd{C-c a N} will do a text search limited
9277 to only a single file.
9279 @vindex org-agenda-custom-commands
9280 For command sets creating a block agenda,
9281 @code{org-agenda-custom-commands} has two separate spots for setting
9282 options. You can add options that should be valid for just a single
9283 command in the set, and options that should be valid for all commands in
9284 the set. The former are just added to the command entry; the latter
9285 must come after the list of command entries. Going back to the block
9286 agenda example (@pxref{Block agenda}), let's change the sorting strategy
9287 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
9288 the results for GARDEN tags query in the opposite order,
9289 @code{priority-up}. This would look like this:
9293 (setq org-agenda-custom-commands
9294 '(("h" "Agenda and Home-related tasks"
9298 ((org-agenda-sorting-strategy '(priority-up)))))
9299 ((org-agenda-sorting-strategy '(priority-down))))
9300 ("o" "Agenda and Office-related tasks"
9307 As you see, the values and parentheses setting is a little complex.
9308 When in doubt, use the customize interface to set this variable---it
9309 fully supports its structure. Just one caveat: when setting options in
9310 this interface, the @emph{values} are just Lisp expressions. So if the
9311 value is a string, you need to add the double-quotes around the value
9314 @vindex org-agenda-custom-commands-contexts
9315 To control whether an agenda command should be accessible from a specific
9316 context, you can customize @code{org-agenda-custom-commands-contexts}. Let's
9317 say for example that you have an agenda command @code{"o"} displaying a view
9318 that you only need when reading emails. Then you would configure this option
9322 (setq org-agenda-custom-commands-contexts
9323 '(("o" (in-mode . "message-mode"))))
9326 You can also tell that the command key @code{"o"} should refer to another
9327 command key @code{"r"}. In that case, add this command key like this:
9330 (setq org-agenda-custom-commands-contexts
9331 '(("o" "r" (in-mode . "message-mode"))))
9334 See the docstring of the variable for more information.
9336 @node Exporting agenda views
9337 @section Exporting agenda views
9338 @cindex agenda views, exporting
9340 If you are away from your computer, it can be very useful to have a printed
9341 version of some agenda views to carry around. Org mode can export custom
9342 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
9343 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
9344 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
9345 a PDF file will also create the postscript file.}, and iCalendar files. If
9346 you want to do this only occasionally, use the command
9349 @orgcmd{C-x C-w,org-agenda-write}
9350 @cindex exporting agenda views
9351 @cindex agenda views, exporting
9352 @vindex org-agenda-exporter-settings
9353 Write the agenda view to a file. Depending on the extension of the selected
9354 file name, the view will be exported as HTML (extension @file{.html} or
9355 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
9356 @file{.ics}), or plain text (any other extension). Use the variable
9357 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
9358 for @file{htmlize} to be used during export, for example
9360 @vindex org-agenda-add-entry-text-maxlines
9361 @vindex htmlize-output-type
9362 @vindex ps-number-of-columns
9363 @vindex ps-landscape-mode
9365 (setq org-agenda-exporter-settings
9366 '((ps-number-of-columns 2)
9367 (ps-landscape-mode t)
9368 (org-agenda-add-entry-text-maxlines 5)
9369 (htmlize-output-type 'css)))
9373 If you need to export certain agenda views frequently, you can associate
9374 any custom agenda command with a list of output file names
9375 @footnote{If you want to store standard views like the weekly agenda
9376 or the global TODO list as well, you need to define custom commands for
9377 them in order to be able to specify file names.}. Here is an example
9378 that first defines custom commands for the agenda and the global
9379 TODO list, together with a number of files to which to export them.
9380 Then we define two block agenda commands and specify file names for them
9381 as well. File names can be relative to the current working directory,
9386 (setq org-agenda-custom-commands
9387 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
9388 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
9389 ("h" "Agenda and Home-related tasks"
9394 ("~/views/home.html"))
9395 ("o" "Agenda and Office-related tasks"
9400 ("~/views/office.ps" "~/calendars/office.ics"))))
9404 The extension of the file name determines the type of export. If it is
9405 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
9406 the buffer to HTML and save it to this file name. If the extension is
9407 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
9408 Postscript output. If the extension is @file{.ics}, iCalendar export is
9409 run export over all files that were used to construct the agenda, and
9410 limit the export to entries listed in the agenda. Any other
9411 extension produces a plain ASCII file.
9413 The export files are @emph{not} created when you use one of those
9414 commands interactively because this might use too much overhead.
9415 Instead, there is a special command to produce @emph{all} specified
9419 @orgcmd{C-c a e,org-store-agenda-views}
9420 Export all agenda views that have export file names associated with
9424 You can use the options section of the custom agenda commands to also
9425 set options for the export commands. For example:
9428 (setq org-agenda-custom-commands
9430 ((ps-number-of-columns 2)
9431 (ps-landscape-mode t)
9432 (org-agenda-prefix-format " [ ] ")
9433 (org-agenda-with-colors nil)
9434 (org-agenda-remove-tags t))
9439 This command sets two options for the Postscript exporter, to make it
9440 print in two columns in landscape format---the resulting page can be cut
9441 in two and then used in a paper agenda. The remaining settings modify
9442 the agenda prefix to omit category and scheduling information, and
9443 instead include a checkbox to check off items. We also remove the tags
9444 to make the lines compact, and we don't want to use colors for the
9445 black-and-white printer. Settings specified in
9446 @code{org-agenda-exporter-settings} will also apply, but the settings
9447 in @code{org-agenda-custom-commands} take precedence.
9450 From the command line you may also use
9452 emacs -eval (org-batch-store-agenda-views) -kill
9455 or, if you need to modify some parameters@footnote{Quoting depends on the
9456 system you use, please check the FAQ for examples.}
9458 emacs -eval '(org-batch-store-agenda-views \
9459 org-agenda-span (quote month) \
9460 org-agenda-start-day "2007-11-01" \
9461 org-agenda-include-diary nil \
9462 org-agenda-files (quote ("~/org/project.org")))' \
9466 which will create the agenda views restricted to the file
9467 @file{~/org/project.org}, without diary entries and with a 30-day
9470 You can also extract agenda information in a way that allows further
9471 processing by other programs. See @ref{Extracting agenda information}, for
9475 @node Agenda column view
9476 @section Using column view in the agenda
9477 @cindex column view, in agenda
9478 @cindex agenda, column view
9480 Column view (@pxref{Column view}) is normally used to view and edit
9481 properties embedded in the hierarchical structure of an Org file. It can be
9482 quite useful to use column view also from the agenda, where entries are
9483 collected by certain criteria.
9486 @orgcmd{C-c C-x C-c,org-agenda-columns}
9487 Turn on column view in the agenda.
9490 To understand how to use this properly, it is important to realize that the
9491 entries in the agenda are no longer in their proper outline environment.
9492 This causes the following issues:
9496 @vindex org-columns-default-format
9497 @vindex org-overriding-columns-format
9498 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9499 entries in the agenda are collected from different files, and different files
9500 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9501 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9502 currently set, and if so, takes the format from there. Otherwise it takes
9503 the format associated with the first item in the agenda, or, if that item
9504 does not have a specific format (defined in a property, or in its file), it
9505 uses @code{org-columns-default-format}.
9507 @cindex property, special, CLOCKSUM
9508 If any of the columns has a summary type defined (@pxref{Column attributes}),
9509 turning on column view in the agenda will visit all relevant agenda files and
9510 make sure that the computations of this property are up to date. This is
9511 also true for the special @code{CLOCKSUM} property. Org will then sum the
9512 values displayed in the agenda. In the daily/weekly agenda, the sums will
9513 cover a single day; in all other views they cover the entire block. It is
9514 vital to realize that the agenda may show the same entry @emph{twice} (for
9515 example as scheduled and as a deadline), and it may show two entries from the
9516 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9517 cases, the summation in the agenda will lead to incorrect results because
9518 some values will count double.
9520 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9521 the entire clocked time for this item. So even in the daily/weekly agenda,
9522 the clocksum listed in column view may originate from times outside the
9523 current view. This has the advantage that you can compare these values with
9524 a column listing the planned total effort for a task---one of the major
9525 applications for column view in the agenda. If you want information about
9526 clocked time in the displayed period use clock table mode (press @kbd{R} in
9530 @cindex property, special, CLOCKSUM_T
9531 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9532 always today's clocked time for this item. So even in the weekly agenda,
9533 the clocksum listed in column view only originates from today. This lets
9534 you compare the time you spent on a task for today, with the time already
9535 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9540 @chapter Markup for rich export
9542 When exporting Org mode documents, the exporter tries to reflect the
9543 structure of the document as accurately as possible in the back-end. Since
9544 export targets like HTML and @LaTeX{} allow much richer formatting, Org mode has
9545 rules on how to prepare text for rich export. This section summarizes the
9546 markup rules used in an Org mode buffer.
9549 * Structural markup elements:: The basic structure as seen by the exporter
9550 * Images and tables:: Images, tables and caption mechanism
9551 * Literal examples:: Source code examples with special formatting
9552 * Include files:: Include additional files into a document
9553 * Index entries:: Making an index
9554 * Macro replacement:: Use macros to create templates
9555 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9556 * Special blocks:: Containers targeted at export back-ends
9559 @node Structural markup elements
9560 @section Structural markup elements
9563 * Document title:: Where the title is taken from
9564 * Headings and sections:: The document structure as seen by the exporter
9565 * Table of contents:: The if and where of the table of contents
9567 * Paragraphs:: Paragraphs
9568 * Footnote markup:: Footnotes
9569 * Emphasis and monospace:: Bold, italic, etc.
9570 * Horizontal rules:: Make a line
9571 * Comment lines:: What will *not* be exported
9574 @node Document title
9575 @subheading Document title
9576 @cindex document title, markup rules
9579 The title of the exported document is taken from the special line
9583 #+TITLE: This is the title of the document
9587 If this line does not exist, the title will be the name of the file
9588 associated with the buffer, without extension, or the buffer name.
9590 @cindex property, EXPORT_TITLE
9591 If you are exporting only a subtree, its heading will become the title of the
9592 document. If the subtree has a property @code{EXPORT_TITLE}, that will take
9595 @node Headings and sections
9596 @subheading Headings and sections
9597 @cindex headings and sections, markup rules
9599 @vindex org-export-headline-levels
9600 The outline structure of the document as described in @ref{Document
9601 structure}, forms the basis for defining sections of the exported document.
9602 However, since the outline structure is also used for (for example) lists of
9603 tasks, only the first three outline levels will be used as headings. Deeper
9604 levels will become itemized lists. You can change the location of this
9605 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9606 per-file basis with a line
9613 @node Table of contents
9614 @subheading Table of contents
9615 @cindex table of contents, markup rules
9618 @vindex org-export-with-toc
9619 The table of contents is normally inserted directly before the first headline
9620 of the file. The depth of the table is by default the same as the number of
9621 headline levels, but you can choose a smaller number, or turn off the table
9622 of contents entirely, by configuring the variable @code{org-export-with-toc},
9623 or on a per-file basis with a line like
9626 #+OPTIONS: toc:2 (only to two levels in TOC)
9627 #+OPTIONS: toc:nil (no default TOC at all)
9630 If you would like to move the table of contents to a different location, you
9631 should turn off the default table using @code{org-export-with-toc} or
9632 @code{#+OPTIONS} and insert @code{#+TOC: headlines N} at the desired
9636 #+OPTIONS: toc:nil (no default TOC)
9638 #+TOC: headlines 2 (insert TOC here, with two headline levels)
9641 Multiple @code{#+TOC: headline} lines are allowed. The same @code{TOC}
9642 keyword can also generate a list of all tables (resp.@: all listings) with a
9643 caption in the buffer.
9646 #+TOC: listings (build a list of listings)
9647 #+TOC: tables (build a list of tables)
9650 @cindex property, ALT_TITLE
9651 The headline's title usually determines its corresponding entry in a table of
9652 contents. However, it is possible to specify an alternative title by
9653 setting @code{ALT_TITLE} property accordingly. It will then be used when
9658 @cindex lists, markup rules
9660 Plain lists as described in @ref{Plain lists}, are translated to the back-end's
9661 syntax for such lists. Most back-ends support unordered, ordered, and
9665 @subheading Paragraphs, line breaks, and quoting
9666 @cindex paragraphs, markup rules
9668 Paragraphs are separated by at least one empty line. If you need to enforce
9669 a line break within a paragraph, use @samp{\\} at the end of a line.
9671 To keep the line breaks in a region, but otherwise use normal formatting, you
9672 can use this construct, which can also be used to format poetry.
9674 @cindex #+BEGIN_VERSE
9677 Great clouds overhead
9678 Tiny black birds rise and fall
9685 When quoting a passage from another document, it is customary to format this
9686 as a paragraph that is indented on both the left and the right margin. You
9687 can include quotations in Org mode documents like this:
9689 @cindex #+BEGIN_QUOTE
9692 Everything should be made as simple as possible,
9693 but not any simpler -- Albert Einstein
9697 If you would like to center some text, do it like this:
9698 @cindex #+BEGIN_CENTER
9701 Everything should be made as simple as possible, \\
9707 @node Footnote markup
9708 @subheading Footnote markup
9709 @cindex footnotes, markup rules
9710 @cindex @file{footnote.el}
9712 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9713 by all back-ends. Org allows multiple references to the same note, and
9714 multiple footnotes side by side.
9716 @node Emphasis and monospace
9717 @subheading Emphasis and monospace
9719 @cindex underlined text, markup rules
9720 @cindex bold text, markup rules
9721 @cindex italic text, markup rules
9722 @cindex verbatim text, markup rules
9723 @cindex code text, markup rules
9724 @cindex strike-through text, markup rules
9725 @vindex org-fontify-emphasized-text
9726 @vindex org-emphasis-regexp-components
9727 @vindex org-emphasis-alist
9728 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
9729 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
9730 in the code and verbatim string is not processed for Org mode specific
9731 syntax, it is exported verbatim.
9733 To turn off fontification for marked up text, you can set
9734 @code{org-fontify-emphasized-text} to @code{nil}. To narrow down the list of
9735 available markup syntax, you can customize @code{org-emphasis-alist}. To fine
9736 tune what characters are allowed before and after the markup characters, you
9737 can tweak @code{org-emphasis-regexp-components}. Beware that changing one of
9738 the above variables will no take effect until you reload Org, for which you
9739 may need to restart Emacs.
9741 @node Horizontal rules
9742 @subheading Horizontal rules
9743 @cindex horizontal rules, markup rules
9744 A line consisting of only dashes, and at least 5 of them, will be exported as
9748 @subheading Comment lines
9749 @cindex comment lines
9750 @cindex exporting, not
9751 @cindex #+BEGIN_COMMENT
9753 Lines starting with zero or more whitespace characters followed by one
9754 @samp{#} and a whitespace are treated as comments and will never be exported.
9755 Also entire subtrees starting with the word @samp{COMMENT} will never be
9756 exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
9757 ... @samp{#+END_COMMENT} will not be exported.
9762 Toggle the COMMENT keyword at the beginning of an entry.
9766 @node Images and tables
9767 @section Images and Tables
9769 @cindex tables, markup rules
9772 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9773 the @file{table.el} package will be exported properly. For Org mode tables,
9774 the lines before the first horizontal separator line will become table header
9775 lines. You can use the following lines somewhere before the table to assign
9776 a caption and a label for cross references, and in the text you can refer to
9777 the object with @code{[[tab:basic-data]]} (@pxref{Internal links}):
9780 #+CAPTION: This is the caption for the next table (or link)
9781 #+NAME: tab:basic-data
9786 Optionally, the caption can take the form:
9788 #+CAPTION[Caption for list of tables]: Caption for table.
9791 @cindex inlined images, markup rules
9792 Some back-ends allow you to directly include images into the exported
9793 document. Org does this, if a link to an image files does not have
9794 a description part, for example @code{[[./img/a.jpg]]}. If you wish to
9795 define a caption for the image and maybe a label for internal cross
9796 references, make sure that the link is on a line by itself and precede it
9797 with @code{#+CAPTION} and @code{#+NAME} as follows:
9800 #+CAPTION: This is the caption for the next figure link (or table)
9801 #+NAME: fig:SED-HR4049
9806 Such images can be displayed within the buffer. @xref{Handling links,the
9807 discussion of image links}.
9809 Even though images and tables are prominent examples of captioned structures,
9810 the same caption mechanism can apply to many others (e.g., @LaTeX{}
9811 equations, source code blocks). Depending on the export back-end, those may
9812 or may not be handled.
9814 @node Literal examples
9815 @section Literal examples
9816 @cindex literal examples, markup rules
9817 @cindex code line references, markup rules
9819 You can include literal examples that should not be subjected to
9820 markup. Such examples will be typeset in monospace, so this is well suited
9821 for source code and similar examples.
9822 @cindex #+BEGIN_EXAMPLE
9826 Some example from a text file.
9830 Note that such blocks may be @i{indented} in order to align nicely with
9831 indented text and in particular with plain list structure (@pxref{Plain
9832 lists}). For simplicity when using small examples, you can also start the
9833 example lines with a colon followed by a space. There may also be additional
9834 whitespace before the colon:
9838 : Some example from a text file.
9841 @cindex formatting source code, markup rules
9842 If the example is source code from a programming language, or any other text
9843 that can be marked up by font-lock in Emacs, you can ask for the example to
9844 look like the fontified Emacs buffer@footnote{This works automatically for
9845 the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package,
9846 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9847 achieved using either the listings or the
9848 @url{http://code.google.com/p/minted, minted,} package. Refer to
9849 @code{org-latex-listings} documentation for details.}. This is done
9850 with the @samp{src} block, where you also need to specify the name of the
9851 major mode that should be used to fontify the example@footnote{Code in
9852 @samp{src} blocks may also be evaluated either interactively or on export.
9853 See @pxref{Working with source code} for more information on evaluating code
9854 blocks.}, see @ref{Easy templates} for shortcuts to easily insert code
9859 #+BEGIN_SRC emacs-lisp
9860 (defun org-xor (a b)
9866 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9867 switch to the end of the @code{BEGIN} line, to get the lines of the example
9868 numbered. If you use a @code{+n} switch, the numbering from the previous
9869 numbered snippet will be continued in the current one. In literal examples,
9870 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9871 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9872 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9873 link will remote-highlight the corresponding code line, which is kind of
9876 You can also add a @code{-r} switch which @i{removes} the labels from the
9877 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9878 labels in the source code while using line numbers for the links, which might
9879 be useful to explain those in an Org mode example code.}. With the @code{-n}
9880 switch, links to these references will be labeled by the line numbers from
9881 the code listing, otherwise links will use the labels with no parentheses.
9885 #+BEGIN_SRC emacs-lisp -n -r
9886 (save-excursion (ref:sc)
9887 (goto-char (point-min)) (ref:jump)
9889 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9893 @vindex org-coderef-label-format
9894 If the syntax for the label format conflicts with the language syntax, use a
9895 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9896 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9898 HTML export also allows examples to be published as text areas (@pxref{Text
9899 areas in HTML export}).
9901 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9902 so often, shortcuts are provided using the Easy templates facility
9903 (@pxref{Easy templates}).
9908 Edit the source code example at point in its native mode. This works by
9909 switching to a temporary buffer with the source code. You need to exit by
9910 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9911 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9912 from being interpreted by Org as outline nodes or special syntax. These
9913 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9914 The edited version will then replace the old version in the Org buffer.
9915 Fixed-width regions (where each line starts with a colon followed by a space)
9916 will be edited using @code{artist-mode}@footnote{You may select
9917 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9918 to allow creating ASCII drawings easily. Using this command in an empty line
9919 will create a new fixed-width region.
9922 Calling @code{org-store-link} while editing a source code example in a
9923 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9924 that it is unique in the current buffer, and insert it with the proper
9925 formatting like @samp{(ref:label)} at the end of the current line. Then the
9926 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9931 @section Include files
9932 @cindex include files, markup rules
9934 During export, you can include the content of another file. For example, to
9935 include your @file{.emacs} file, you could use:
9939 #+INCLUDE: "~/.emacs" src emacs-lisp
9943 The optional second and third parameter are the markup (e.g., @samp{quote},
9944 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9945 language for formatting the contents. The markup is optional; if it is not
9946 given, the text will be assumed to be in Org mode format and will be
9949 Contents of the included file will belong to the same structure (headline,
9950 item) containing the @code{INCLUDE} keyword. In particular, headlines within
9951 the file will become children of the current section. That behaviour can be
9952 changed by providing an additional keyword parameter, @code{:minlevel}. In
9953 that case, all headlines in the included file will be shifted so the one with
9954 the lowest level reaches that specified level. For example, to make a file
9955 become a sibling of the current top-level headline, use
9958 #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1
9961 You can also include a portion of a file by specifying a lines range using
9962 the @code{:lines} parameter. The line at the upper end of the range will not
9963 be included. The start and/or the end of the range may be omitted to use the
9967 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
9968 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
9969 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
9975 Visit the include file at point.
9979 @section Index entries
9980 @cindex index entries, for publishing
9982 You can specify entries that will be used for generating an index during
9983 publishing. This is done by lines starting with @code{#+INDEX}. An entry
9984 the contains an exclamation mark will create a sub item. See @ref{Generating
9985 an index} for more information.
9990 #+INDEX: Application!CV
9996 @node Macro replacement
9997 @section Macro replacement
9998 @cindex macro replacement, during export
10001 You can define text snippets with
10004 #+MACRO: name replacement text $1, $2 are arguments
10007 @noindent which can be referenced in
10008 paragraphs, verse blocks, table cells and some keywords with
10009 @code{@{@{@{name(arg1,arg2)@}@}@}}@footnote{Since commas separate arguments,
10010 commas within arguments have to be escaped with a backslash character.
10011 Conversely, backslash characters before a comma, and only them, need to be
10012 escaped with another backslash character.}. In addition to defined macros,
10013 @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc., will reference
10014 information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and similar lines.
10015 Also, @code{@{@{@{time(@var{FORMAT})@}@}@}} and
10016 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
10017 and to the modification time of the file being exported, respectively.
10018 @var{FORMAT} should be a format string understood by
10019 @code{format-time-string}.
10021 Macro expansion takes place during export.
10024 @node Embedded @LaTeX{}
10025 @section Embedded @LaTeX{}
10026 @cindex @TeX{} interpretation
10027 @cindex @LaTeX{} interpretation
10029 Plain ASCII is normally sufficient for almost all note taking. Exceptions
10030 include scientific notes, which often require mathematical symbols and the
10031 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
10032 Donald E. Knuth's @TeX{} system. Many of the features described here as
10033 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
10034 distinction.} is widely used to typeset scientific documents. Org mode
10035 supports embedding @LaTeX{} code into its files, because many academics are
10036 used to writing and reading @LaTeX{} source code, and because it can be
10037 readily processed to produce pretty output for a number of export back-ends.
10040 * Special symbols:: Greek letters and other symbols
10041 * Subscripts and superscripts:: Simple syntax for raising/lowering text
10042 * @LaTeX{} fragments:: Complex formulas made easy
10043 * Previewing @LaTeX{} fragments:: What will this snippet look like?
10044 * CDLaTeX mode:: Speed up entering of formulas
10047 @node Special symbols
10048 @subsection Special symbols
10049 @cindex math symbols
10050 @cindex special symbols
10051 @cindex @TeX{} macros
10052 @cindex @LaTeX{} fragments, markup rules
10053 @cindex HTML entities
10054 @cindex @LaTeX{} entities
10056 You can use @LaTeX{}-like syntax to insert special symbols like @samp{\alpha}
10057 to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
10058 for these symbols is available, just type @samp{\} and maybe a few letters,
10059 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
10060 code, Org mode allows these symbols to be present without surrounding math
10061 delimiters, for example:
10064 Angles are written as Greek letters \alpha, \beta and \gamma.
10067 @vindex org-entities
10068 During export, these symbols will be transformed into the native format of
10069 the exporter back-end. Strings like @code{\alpha} will be exported as
10070 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
10071 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
10072 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
10073 like this: @samp{\Aacute@{@}stor}.
10075 A large number of entities is provided, with names taken from both HTML and
10076 @LaTeX{}; see the variable @code{org-entities} for the complete list.
10077 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
10078 @samp{...} are all converted into special commands creating hyphens of
10079 different lengths or a compact set of dots.
10081 If you would like to see entities displayed as UTF-8 characters, use the
10082 following command@footnote{You can turn this on by default by setting the
10083 variable @code{org-pretty-entities}, or on a per-file base with the
10084 @code{#+STARTUP} option @code{entitiespretty}.}:
10087 @cindex @code{entitiespretty}, STARTUP keyword
10090 Toggle display of entities as UTF-8 characters. This does not change the
10091 buffer content which remains plain ASCII, but it overlays the UTF-8 character
10092 for display purposes only.
10095 @node Subscripts and superscripts
10096 @subsection Subscripts and superscripts
10098 @cindex superscript
10100 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and
10101 subscripts. Again, these can be used without embedding them in math-mode
10102 delimiters. To increase the readability of ASCII text, it is not necessary
10103 (but OK) to surround multi-character sub- and superscripts with curly braces.
10107 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
10108 the sun is R_@{sun@} = 6.96 x 10^8 m.
10111 @vindex org-use-sub-superscripts
10112 If you write a text where the underscore is often used in a different
10113 context, Org's convention to always interpret these as subscripts can get in
10114 your way. Configure the variable @code{org-use-sub-superscripts} to change
10115 this convention. For example, when setting this variable to @code{@{@}},
10116 @samp{a_b} will not be interpreted as a subscript, but @samp{a_@{b@}} will.
10121 In addition to showing entities as UTF-8 characters, this command will also
10122 format sub- and superscripts in a WYSIWYM way.
10125 @node @LaTeX{} fragments
10126 @subsection @LaTeX{} fragments
10127 @cindex @LaTeX{} fragments
10129 @vindex org-format-latex-header
10130 Going beyond symbols and sub- and superscripts, a full formula language is
10131 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
10132 to process these for several export back-ends. When exporting to @LaTeX{},
10133 the code is obviously left as it is. When exporting to HTML, Org invokes the
10134 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
10135 HTML export}) to process and display the math@footnote{If you plan to use
10136 this regularly or on pages with significant page views, you should install
10137 @file{MathJax} on your own server in order to limit the load of our server.}.
10138 Finally, it can also process the mathematical expressions into
10139 images@footnote{For this to work you need to be on a system with a working
10140 @LaTeX{} installation. You also need the @file{dvipng} program or the
10141 @file{convert}, respectively available at
10142 @url{http://sourceforge.net/projects/dvipng/} and from the @file{imagemagick}
10143 suite. The @LaTeX{} header that will be used when processing a fragment can
10144 be configured with the variable @code{org-format-latex-header}.} that can be
10145 displayed in a browser.
10147 @LaTeX{} fragments don't need any special marking at all. The following
10148 snippets will be identified as @LaTeX{} source code:
10151 Environments of any kind@footnote{When @file{MathJax} is used, only the
10152 environments recognized by @file{MathJax} will be processed. When
10153 @file{dvipng} program or @file{imagemagick} suite is used to create images,
10154 any @LaTeX{} environment will be handled.}. The only requirement is that the
10155 @code{\begin} and @code{\end} statements appear on a new line, at the
10156 beginning of the line or after whitespaces only.
10158 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
10159 currency specifications, single @samp{$} characters are only recognized as
10160 math delimiters if the enclosed text contains at most two line breaks, is
10161 directly attached to the @samp{$} characters with no whitespace in between,
10162 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
10163 For the other delimiters, there is no such restriction, so when in doubt, use
10164 @samp{\(...\)} as inline math delimiters.
10167 @noindent For example:
10174 If $a^2=b$ and \( b=2 \), then the solution must be
10175 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
10180 @c @vindex org-format-latex-options
10181 @c If you need any of the delimiter ASCII sequences for other purposes, you
10182 @c can configure the option @code{org-format-latex-options} to deselect the
10183 @c ones you do not wish to have interpreted by the @LaTeX{} converter.
10185 @vindex org-export-with-latex
10186 @LaTeX{} processing can be configured with the variable
10187 @code{org-export-with-latex}. The default setting is @code{t} which means
10188 @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{} back-ends.
10189 You can also set this variable on a per-file basis using one of these
10193 #+OPTIONS: tex:t @r{Do the right thing automatically (MathJax)}
10194 #+OPTIONS: tex:nil @r{Do not process @LaTeX{} fragments at all}
10195 #+OPTIONS: tex:verbatim @r{Verbatim export, for jsMath or so}
10198 @node Previewing @LaTeX{} fragments
10199 @subsection Previewing @LaTeX{} fragments
10200 @cindex @LaTeX{} fragments, preview
10202 @vindex org-latex-create-formula-image-program
10203 If you have @file{dvipng} or @file{imagemagick} installed@footnote{Choose the
10204 converter by setting the variable
10205 @code{org-latex-create-formula-image-program} accordingly.}, @LaTeX{}
10206 fragments can be processed to produce preview images of the typeset
10210 @kindex C-c C-x C-l
10212 Produce a preview image of the @LaTeX{} fragment at point and overlay it
10213 over the source code. If there is no fragment at point, process all
10214 fragments in the current entry (between two headlines). When called
10215 with a prefix argument, process the entire subtree. When called with
10216 two prefix arguments, or when the cursor is before the first headline,
10217 process the entire buffer.
10220 Remove the overlay preview images.
10223 @vindex org-format-latex-options
10224 You can customize the variable @code{org-format-latex-options} to influence
10225 some aspects of the preview. In particular, the @code{:scale} (and for HTML
10226 export, @code{:html-scale}) property can be used to adjust the size of the
10229 @vindex org-startup-with-latex-preview
10230 You can turn on the previewing of all @LaTeX{} fragments in a file with
10233 #+STARTUP: latexpreview
10236 To disable it, simply use
10239 #+STARTUP: nolatexpreview
10243 @subsection Using CD@LaTeX{} to enter math
10246 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
10247 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
10248 environments and math templates. Inside Org mode, you can make use of
10249 some of the features of CD@LaTeX{} mode. You need to install
10250 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
10251 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
10252 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
10253 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
10254 on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all
10258 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
10261 When this mode is enabled, the following features are present (for more
10262 details see the documentation of CD@LaTeX{} mode):
10266 Environment templates can be inserted with @kbd{C-c @{}.
10269 The @key{TAB} key will do template expansion if the cursor is inside a
10270 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
10271 inside such a fragment, see the documentation of the function
10272 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
10273 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
10274 correctly inside the first brace. Another @key{TAB} will get you into
10275 the second brace. Even outside fragments, @key{TAB} will expand
10276 environment abbreviations at the beginning of a line. For example, if
10277 you write @samp{equ} at the beginning of a line and press @key{TAB},
10278 this abbreviation will be expanded to an @code{equation} environment.
10279 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help RET}.
10283 @vindex cdlatex-simplify-sub-super-scripts
10284 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
10285 characters together with a pair of braces. If you use @key{TAB} to move
10286 out of the braces, and if the braces surround only a single character or
10287 macro, they are removed again (depending on the variable
10288 @code{cdlatex-simplify-sub-super-scripts}).
10291 Pressing the backquote @kbd{`} followed by a character inserts math
10292 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
10293 after the backquote, a help window will pop up.
10296 Pressing the single-quote @kbd{'} followed by another character modifies
10297 the symbol before point with an accent or a font. If you wait more than
10298 1.5 seconds after the single-quote, a help window will pop up. Character
10299 modification will work only inside @LaTeX{} fragments; outside the quote
10303 @node Special blocks
10304 @section Special blocks
10305 @cindex Special blocks
10307 Org syntax includes pre-defined blocks (@pxref{Paragraphs} and @ref{Literal
10308 examples}). It is also possible to create blocks containing raw code
10309 targeted at a specific back-end (e.g., @samp{#+BEGIN_LATEX}).
10311 Any other block is a @emph{special block}. Each export back-end decides if
10312 they should be exported, and how. When the block is ignored, its contents
10313 are still exported, as if the block were not there. For example, when
10314 exporting a @samp{#+BEGIN_TEST} block, HTML back-end wraps its contents
10315 within @samp{<div name="test">} tag. Refer to back-end specific
10316 documentation for more information.
10322 The Org mode export facilities can be used to export Org documents or parts
10323 of Org documents to a variety of other formats. In addition, these
10324 facilities can be used with @code{orgtbl-mode} and/or @code{orgstruct-mode}
10325 in foreign buffers so you can author tables and lists in Org syntax and
10326 convert them in place to the target language.
10328 ASCII export produces a readable and simple version of an Org file for
10329 printing and sharing notes. HTML export allows you to easily publish notes
10330 on the web, or to build full-fledged websites. @LaTeX{} export lets you use
10331 Org mode and its structured editing functions to create arbitrarily complex
10332 @LaTeX{} files for any kind of document. OpenDocument Text (ODT) export
10333 allows seamless collaboration across organizational boundaries. Markdown
10334 export lets you seamlessly collaborate with other developers. Finally, iCal
10335 export can extract entries with deadlines or appointments to produce a file
10336 in the iCalendar format.
10339 * The export dispatcher:: The main exporter interface
10340 * Export back-ends:: Built-in export formats
10341 * Export settings:: Generic export settings
10342 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
10343 * Beamer export:: Exporting as a Beamer presentation
10344 * HTML export:: Exporting to HTML
10345 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
10346 * Markdown export:: Exporting to Markdown
10347 * OpenDocument text export:: Exporting to OpenDocument Text
10348 * iCalendar export:: Exporting to iCalendar
10349 * Other built-in back-ends:: Exporting to @code{Texinfo}, a man page, or Org
10350 * Export in foreign buffers:: Author tables in lists in Org syntax
10351 * Advanced configuration:: Fine-tuning the export output
10354 @node The export dispatcher
10355 @section The export dispatcher
10356 @vindex org-export-dispatch-use-expert-ui
10357 @cindex Export, dispatcher
10359 The main entry point for export related tasks is the dispatcher, a
10360 hierarchical menu from which it is possible to select an export format and
10361 toggle export options@footnote{It is also possible to use a less intrusive
10362 interface by setting @code{org-export-dispatch-use-expert-ui} to a
10363 non-@code{nil} value. In that case, only a prompt is visible from the
10364 minibuffer. From there one can still switch back to regular menu by pressing
10365 @key{?}.} from which it is possible to select an export format and to toggle
10370 @orgcmd{C-c C-e,org-export-dispatch}
10372 Dispatch for export and publishing commands. When called with a @kbd{C-u}
10373 prefix argument, repeat the last export command on the current buffer while
10374 preserving toggled options. If the current buffer hasn't changed and subtree
10375 export was activated, the command will affect that same subtree.
10379 Normally the entire buffer is exported, but if there is an active region
10380 only that part of the buffer will be exported.
10382 Several export options (@pxref{Export settings}) can be toggled from the
10383 export dispatcher with the following key combinations:
10387 @vindex org-export-async-init-file
10388 Toggle asynchronous export. Asynchronous export uses an external Emacs
10389 process that is configured with a specified initialization file.
10391 While exporting asynchronously, the output is not displayed. It is stored in
10392 a list called ``the export stack'', and can be viewed from there. The stack
10393 can be reached by calling the dispatcher with a double @kbd{C-u} prefix
10394 argument, or with @kbd{&} key from the dispatcher.
10396 @vindex org-export-in-background
10397 To make this behaviour the default, customize the variable
10398 @code{org-export-in-background}.
10401 Toggle body-only export. Its effect depends on the back-end used.
10402 Typically, if the back-end has a header section (like @code{<head>...</head>}
10403 in the HTML back-end), a body-only export will not include this header.
10406 @vindex org-export-initial-scope
10407 Toggle subtree export. The top heading becomes the document title.
10409 You can change the default state of this option by setting
10410 @code{org-export-initial-scope}.
10413 Toggle visible-only export. Only export the text that is currently
10414 visible, i.e. not hidden by outline visibility in the buffer.
10418 @vindex org-export-copy-to-kill-ring
10419 With the exception of asynchronous export, a successful export process writes
10420 its output to the kill-ring. You can configure this behavior by altering the
10421 option @code{org-export-copy-to-kill-ring}.
10423 @node Export back-ends
10424 @section Export back-ends
10425 @cindex Export, back-ends
10427 An export back-end is a library that translates Org syntax into a foreign
10428 format. An export format is not available until the proper back-end has been
10431 @vindex org-export-backends
10432 By default, the following four back-ends are loaded: @code{ascii},
10433 @code{html}, @code{icalendar} and @code{latex}. It is possible to add more
10434 (or remove some) by customizing @code{org-export-backends}.
10436 Built-in back-ends include:
10439 @item ascii (ASCII format)
10440 @item beamer (@LaTeX{} Beamer format)
10441 @item html (HTML format)
10442 @item icalendar (iCalendar format)
10443 @item latex (@LaTeX{} format)
10444 @item man (Man page format)
10445 @item md (Markdown format)
10446 @item odt (OpenDocument Text format)
10447 @item texinfo (Texinfo format)
10450 Other back-ends might be found in the @code{contrib/} directory
10451 (@pxref{Installation}).
10453 @node Export settings
10454 @section Export settings
10455 @cindex Export, settings
10458 Export options can be set: globally with variables; for an individual file by
10459 making variables buffer-local with in-buffer settings (@pxref{In-buffer
10460 settings}), by setting individual keywords, or by specifying them in a
10461 compact form with the @code{#+OPTIONS} keyword; or for a tree by setting
10462 properties (@pxref{Properties and columns}). Options set at a specific level
10463 override options set at a more general level.
10465 @cindex #+SETUPFILE
10466 In-buffer settings may appear anywhere in the file, either directly or
10467 indirectly through a file included using @samp{#+SETUPFILE: filename} syntax.
10468 Option keyword sets tailored to a particular back-end can be inserted from
10469 the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert
10470 template} command by pressing @key{#}. To insert keywords individually,
10471 a good way to make sure the keyword is correct is to type @code{#+} and then
10472 to use @kbd{M-<TAB>} for completion.
10474 The export keywords available for every back-end, and their equivalent global
10475 variables, include:
10480 @vindex user-full-name
10481 The document author (@code{user-full-name}).
10485 @vindex org-export-creator-string
10486 Entity responsible for output generation (@code{org-export-creator-string}).
10490 @vindex org-export-date-timestamp-format
10491 A date or a time-stamp@footnote{The variable
10492 @code{org-export-date-timestamp-format} defines how this time-stamp will be
10496 @cindex #+DESCRIPTION
10497 The document description. Back-ends handle it as they see fit (e.g., for the
10498 XHTML meta tag), if at all. You can use several such keywords for long
10503 @vindex user-mail-address
10504 The email address (@code{user-mail-address}).
10508 The keywords defining the contents of the document. Back-ends handle it as
10509 they see fit (e.g., for the XHTML meta tag), if at all. You can use several
10510 such keywords if the list is long.
10514 @vindex org-export-default-language
10515 The language used for translating some strings
10516 (@code{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell
10517 Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
10521 @cindex #+SELECT_TAGS
10522 @vindex org-export-select-tags
10523 The tags that select a tree for export (@code{org-export-select-tags}). The
10524 default value is @code{:export:}. Within a subtree tagged with
10525 @code{:export:}, you can still exclude entries with @code{:noexport:} (see
10526 below). When headlines are selectively exported with @code{:export:}
10527 anywhere in a file, text before the first headline is ignored.
10530 @cindex #+EXCLUDE_TAGS
10531 @vindex org-export-exclude-tags
10532 The tags that exclude a tree from export (@code{org-export-exclude-tags}).
10533 The default value is @code{:noexport:}. Entries with the @code{:noexport:}
10534 tag will be unconditionally excluded from the export, even if they have an
10535 @code{:export:} tag.
10539 The title to be shown (otherwise derived from buffer's name). You can use
10540 several such keywords for long titles.
10543 The @code{#+OPTIONS} keyword is a compact@footnote{If you want to configure
10544 many options this way, you can use several @code{#+OPTIONS} lines.} form that
10545 recognizes the following arguments:
10549 @vindex org-export-with-smart-quotes
10550 Toggle smart quotes (@code{org-export-with-smart-quotes}).
10553 Toggle emphasized text (@code{org-export-with-emphasize}).
10556 @vindex org-export-with-special-strings
10557 Toggle conversion of special strings
10558 (@code{org-export-with-special-strings}).
10561 @vindex org-export-with-fixed-width
10562 Toggle fixed-width sections
10563 (@code{org-export-with-fixed-width}).
10566 @vindex org-export-with-timestamps
10567 Toggle inclusion of any time/date active/inactive stamps
10568 (@code{org-export-with-timestamps}).
10571 @vindex org-export-preserve-breaks
10572 Toggle line-break-preservation (@code{org-export-preserve-breaks}).
10575 @vindex org-export-with-sub-superscripts
10576 Toggle @TeX{}-like syntax for sub- and superscripts. If you write "^:@{@}",
10577 @samp{a_@{b@}} will be interpreted, but the simple @samp{a_b} will be left as
10578 it is (@code{org-export-with-sub-superscripts}).
10581 @vindex org-export-with-archived-trees
10582 Configure export of archived trees. Can be set to @code{headline} to only
10583 process the headline, skipping its contents
10584 (@code{org-export-with-archived-trees}).
10587 @vindex org-export-with-author
10588 Toggle inclusion of author name into exported file
10589 (@code{org-export-with-author}).
10592 @vindex org-export-with-clocks
10593 Toggle inclusion of CLOCK keywords (@code{org-export-with-clocks}).
10596 @vindex org-export-with-creator
10597 Configure inclusion of creator info into exported file. It may be set to
10598 @code{comment} (@code{org-export-with-creator}).
10601 @vindex org-export-with-drawers
10602 Toggle inclusion of drawers, or list drawers to include
10603 (@code{org-export-with-drawers}).
10606 @vindex org-export-with-entities
10607 Toggle inclusion of entities (@code{org-export-with-entities}).
10610 @vindex org-export-with-email
10611 Toggle inclusion of the author's e-mail into exported file
10612 (@code{org-export-with-email}).
10615 @vindex org-export-with-footnotes
10616 Toggle the inclusion of footnotes (@code{org-export-with-footnotes}).
10619 @vindex org-export-headline-levels
10620 Set the number of headline levels for export
10621 (@code{org-export-headline-levels}). Below that level, headlines are treated
10622 differently. In most back-ends, they become list items.
10625 @vindex org-export-with-inlinetasks
10626 Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}).
10629 @vindex org-export-with-section-numbers
10630 Toggle section-numbers (@code{org-export-with-section-numbers}). It can also
10631 be set to a number @samp{n}, so only headlines at that level or above will be
10635 @vindex org-export-with-planning
10636 Toggle export of planning information (@code{org-export-with-planning}).
10637 ``Planning information'' is the line containing the @code{SCHEDULED:}, the
10638 @code{DEADLINE:} or the @code{CLOSED:} cookies or a combination of them.
10641 @vindex org-export-with-priority
10642 Toggle inclusion of priority cookies (@code{org-export-with-priority}).
10645 @vindex org-export-with-properties
10646 Toggle inclusion of property drawers, or list properties to include
10647 (@code{org-export-with-properties}).
10650 @vindex org-export-with-statistics-cookies
10651 Toggle inclusion of statistics cookies
10652 (@code{org-export-with-statistics-cookies}).
10655 @vindex org-export-with-tags
10656 Toggle inclusion of tags, may also be @code{not-in-toc}
10657 (@code{org-export-with-tags}).
10660 @vindex org-export-with-tasks
10661 Toggle inclusion of tasks (TODO items), can be @code{nil} to remove all
10662 tasks, @code{todo} to remove DONE tasks, or a list of keywords to keep
10663 (@code{org-export-with-tasks}).
10666 @vindex org-export-with-latex
10667 Configure export of @LaTeX{} fragments and environments. It may be set to
10668 @code{verbatim} (@code{org-export-with-latex}).
10671 @vindex org-export-time-stamp-file
10672 Toggle inclusion of the creation time into exported file
10673 (@code{org-export-time-stamp-file}).
10676 @vindex org-export-with-toc
10677 Toggle inclusion of the table of contents, or set the level limit
10678 (@code{org-export-with-toc}).
10681 @vindex org-export-with-todo-keywords
10682 Toggle inclusion of TODO keywords into exported text
10683 (@code{org-export-with-todo-keywords}).
10686 @vindex org-export-with-tables
10687 Toggle inclusion of tables (@code{org-export-with-tables}).
10690 @cindex property, EXPORT_FILE_NAME
10691 When exporting only a subtree, each of the previous keywords@footnote{With
10692 the exception of @samp{SETUPFILE}.} can be overriden locally by special node
10693 properties. These begin with @samp{EXPORT_}, followed by the name of the
10694 keyword they supplant. For example, @samp{DATE} and @samp{OPTIONS} keywords
10695 become, respectively, @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}
10696 properties. Subtree export also supports the self-explicit
10697 @samp{EXPORT_FILE_NAME} property@footnote{There is no buffer-wide equivalent
10698 for this property. The file name in this case is derived from the file
10699 associated to the buffer, if possible, or asked to the user otherwise.}.
10702 @vindex org-export-allow-bind-keywords
10703 If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables
10704 can become buffer-local during export by using the BIND keyword. Its syntax
10705 is @samp{#+BIND: variable value}. This is particularly useful for in-buffer
10706 settings that cannot be changed using specific keywords.
10708 @node ASCII/Latin-1/UTF-8 export
10709 @section ASCII/Latin-1/UTF-8 export
10710 @cindex ASCII export
10711 @cindex Latin-1 export
10712 @cindex UTF-8 export
10714 ASCII export produces a simple and very readable version of an Org mode
10715 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10716 with special characters and symbols available in these encodings.
10718 @vindex org-ascii-links-to-notes
10719 Links are exported in a footnote-like style, with the descriptive part in the
10720 text and the link in a note before the next heading. See the variable
10721 @code{org-ascii-links-to-notes} for details and other options.
10723 @subheading ASCII export commands
10726 @orgcmd{C-c C-e t a/l/u,org-ascii-export-to-ascii}
10727 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
10728 will be @file{myfile.txt}. The file will be overwritten without warning.
10729 When the original file is @file{myfile.txt}, the resulting file becomes
10730 @file{myfile.txt.txt} in order to prevent data loss.
10731 @orgcmd{C-c C-e t A/L/U,org-ascii-export-as-ascii}
10732 Export to a temporary buffer. Do not create a file.
10735 @subheading Header and sectioning structure
10737 In the exported version, the first three outline levels become headlines,
10738 defining a general document structure. Additional levels are exported as
10739 lists. The transition can also occur at a different level (@pxref{Export
10742 @subheading Quoting ASCII text
10744 You can insert text that will only appear when using @code{ASCII} back-end
10745 with the following constructs:
10748 @cindex #+BEGIN_ASCII
10750 Text @@@@ascii:and additional text@@@@ within a paragraph.
10755 All lines in this block will appear only when using this back-end.
10759 @subheading ASCII specific attributes
10760 @cindex #+ATTR_ASCII
10761 @cindex horizontal rules, in ASCII export
10763 @code{ASCII} back-end only understands one attribute, @code{:width}, which
10764 specifies the length, in characters, of a given horizontal rule. It must be
10765 specified using an @code{ATTR_ASCII} line, directly preceding the rule.
10768 #+ATTR_ASCII: :width 10
10772 @node Beamer export
10773 @section Beamer export
10774 @cindex Beamer export
10776 The @LaTeX{} class @emph{Beamer} allows production of high quality
10777 presentations using @LaTeX{} and pdf processing. Org mode has special
10778 support for turning an Org mode file or tree into a Beamer presentation.
10780 @subheading Beamer export commands
10783 @orgcmd{C-c C-e l b,org-beamer-export-to-latex}
10784 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
10785 file will be @file{myfile.tex}. The file will be overwritten without
10787 @orgcmd{C-c C-e l B,org-beamer-export-as-latex}
10788 Export to a temporary buffer. Do not create a file.
10789 @orgcmd{C-c C-e l P,org-beamer-export-to-pdf}
10790 Export as @LaTeX{} and then process to PDF.
10792 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10795 @subheading Sectioning, Frames and Blocks
10797 Any tree with not-too-deep level nesting should in principle be exportable as
10798 a Beamer presentation. Headlines fall into three categories: sectioning
10799 elements, frames and blocks.
10803 @vindex org-beamer-frame-level
10804 Headlines become frames when their level is equal to
10805 @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line
10806 (@pxref{Export settings}).
10808 @cindex property, BEAMER_ENV
10809 Though, if a headline in the current tree has a @code{BEAMER_ENV} property
10810 set to either to @code{frame} or @code{fullframe}, its level overrides the
10811 variable. A @code{fullframe} is a frame with an empty (ignored) title.
10814 @vindex org-beamer-environments-default
10815 @vindex org-beamer-environments-extra
10816 All frame's children become @code{block} environments. Special block types
10817 can be enforced by setting headline's @code{BEAMER_ENV} property@footnote{If
10818 this property is set, the entry will also get a @code{:B_environment:} tag to
10819 make this visible. This tag has no semantic meaning, it is only a visual
10820 aid.} to an appropriate value (see @code{org-beamer-environments-default} for
10821 supported values and @code{org-beamer-environments-extra} for adding more).
10824 @cindex property, BEAMER_REF
10825 As a special case, if the @code{BEAMER_ENV} property is set to either
10826 @code{appendix}, @code{note}, @code{noteNH} or @code{againframe}, the
10827 headline will become, respectively, an appendix, a note (within frame or
10828 between frame, depending on its level), a note with its title ignored or an
10829 @code{\againframe} command. In the latter case, a @code{BEAMER_REF} property
10830 is mandatory in order to refer to the frame being resumed, and contents are
10833 Also, a headline with an @code{ignoreheading} environment will have its
10834 contents only inserted in the output. This special value is useful to have
10835 data between frames, or to properly close a @code{column} environment.
10838 @cindex property, BEAMER_ACT
10839 @cindex property, BEAMER_OPT
10840 Headlines also support @code{BEAMER_ACT} and @code{BEAMER_OPT} properties.
10841 The former is translated as an overlay/action specification, or a default
10842 overlay specification when enclosed within square brackets. The latter
10843 specifies options@footnote{The @code{fragile} option is added automatically
10844 if it contains code that requires a verbatim environment, though.} for the
10845 current frame or block. The export back-end will automatically wrap
10846 properties within angular or square brackets when appropriate.
10848 @cindex property, BEAMER_COL
10849 Moreover, headlines handle the @code{BEAMER_COL} property. Its value should
10850 be a decimal number representing the width of the column as a fraction of the
10851 total text width. If the headline has no specific environment, its title
10852 will be ignored and its contents will fill the column created. Otherwise,
10853 the block will fill the whole column and the title will be preserved. Two
10854 contiguous headlines with a non-@code{nil} @code{BEAMER_COL} value share the same
10855 @code{columns} @LaTeX{} environment. It will end before the next headline
10856 without such a property. This environment is generated automatically.
10857 Although, it can also be explicitly created, with a special @code{columns}
10858 value for @code{BEAMER_ENV} property (if it needs to be set up with some
10859 specific options, for example).
10861 @subheading Beamer specific syntax
10863 Beamer back-end is an extension of @LaTeX{} back-end. As such, all @LaTeX{}
10864 specific syntax (e.g., @samp{#+LATEX:} or @samp{#+ATTR_LATEX:}) is
10865 recognized. See @ref{@LaTeX{} and PDF export} for more information.
10867 @cindex #+BEAMER_THEME
10868 @cindex #+BEAMER_COLOR_THEME
10869 @cindex #+BEAMER_FONT_THEME
10870 @cindex #+BEAMER_INNER_THEME
10871 @cindex #+BEAMER_OUTER_THEME
10872 Beamer export introduces a number of keywords to insert code in the
10873 document's header. Four control appearance of the presentation:
10874 @code{#+BEAMER_THEME}, @code{#+BEAMER_COLOR_THEME},
10875 @code{#+BEAMER_FONT_THEME}, @code{#+BEAMER_INNER_THEME} and
10876 @code{#+BEAMER_OUTER_THEME}. All of them accept optional arguments
10877 within square brackets. The last one, @code{#+BEAMER_HEADER}, is more
10878 generic and allows you to append any line of code in the header.
10881 #+BEAMER_THEME: Rochester [height=20pt]
10882 #+BEAMER_COLOR_THEME: spruce
10885 Table of contents generated from @code{toc:t} @code{OPTION} keyword are
10886 wrapped within a @code{frame} environment. Those generated from a @code{TOC}
10887 keyword (@pxref{Table of contents}) are not. In that case, it is also
10888 possible to specify options, enclosed within square brackets.
10891 #+TOC: headlines [currentsection]
10894 Beamer specific code can be inserted with the following constructs:
10897 @cindex #+BEGIN_BEAMER
10902 All lines in this block will appear only when using this back-end.
10905 Text @@@@beamer:some code@@@@ within a paragraph.
10908 In particular, this last example can be used to add overlay specifications to
10909 objects whose type is among @code{bold}, @code{item}, @code{link},
10910 @code{radio-target} and @code{target}, when the value is enclosed within
10911 angular brackets and put at the beginning the object.
10914 A *@@@@beamer:<2->@@@@useful* feature
10917 @cindex #+ATTR_BEAMER
10918 Eventually, every plain list has support for @code{:environment},
10919 @code{:overlay} and @code{:options} attributes through
10920 @code{ATTR_BEAMER} affiliated keyword. The first one allows the use
10921 of a different environment, the second sets overlay specifications and
10922 the last one inserts optional arguments in current list environment.
10925 #+ATTR_BEAMER: :overlay +-
10930 @subheading Editing support
10932 You can turn on a special minor mode @code{org-beamer-mode} for faster
10940 @orgcmd{C-c C-b,org-beamer-select-environment}
10941 In @code{org-beamer-mode}, this key offers fast selection of a Beamer
10942 environment or the @code{BEAMER_COL} property.
10945 Also, a template for useful in-buffer settings or properties can be inserted
10946 into the buffer with @kbd{M-x org-beamer-insert-options-template}. Among
10947 other things, this will install a column view format which is very handy for
10948 editing special properties used by Beamer.
10950 @subheading An example
10952 Here is a simple example Org document that is intended for Beamer export.
10955 #+TITLE: Example Presentation
10956 #+AUTHOR: Carsten Dominik
10958 #+LATEX_CLASS: beamer
10959 #+LATEX_CLASS_OPTIONS: [presentation]
10960 #+BEAMER_THEME: Madrid
10961 #+COLUMNS: %45ITEM %10BEAMER_ENV(Env) %10BEAMER_ACT(Act) %4BEAMER_COL(Col) %8BEAMER_OPT(Opt)
10963 * This is the first structural section
10966 *** Thanks to Eric Fraga :B_block:BMCOL:
10971 for the first viable Beamer setup in Org
10972 *** Thanks to everyone else :B_block:BMCOL:
10978 for contributing to the discussion
10979 **** This will be formatted as a beamer note :B_note:
10983 ** Frame 2 (where we will not use columns)
10985 Please test this stuff!
10989 @section HTML export
10990 @cindex HTML export
10992 Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
10993 HTML formatting, in ways similar to John Gruber's @emph{markdown}
10994 language, but with additional support for tables.
10997 * HTML Export commands:: How to invoke HTML export
10998 * HTML doctypes:: Org can export to various (X)HTML flavors
10999 * HTML preamble and postamble:: How to insert a preamble and a postamble
11000 * Quoting HTML tags:: Using direct HTML in Org mode
11001 * Links in HTML export:: How links will be interpreted and formatted
11002 * Tables in HTML export:: How to modify the formatting of tables
11003 * Images in HTML export:: How to insert figures into HTML output
11004 * Math formatting in HTML export:: Beautiful math also on the web
11005 * Text areas in HTML export:: An alternative way to show an example
11006 * CSS support:: Changing the appearance of the output
11007 * JavaScript support:: Info and Folding in a web browser
11010 @node HTML Export commands
11011 @subsection HTML export commands
11014 @orgcmd{C-c C-e h h,org-html-export-to-html}
11015 Export as an HTML file. For an Org file @file{myfile.org},
11016 the HTML file will be @file{myfile.html}. The file will be overwritten
11019 Export as an HTML file and immediately open it with a browser.
11020 @orgcmd{C-c C-e h H,org-html-export-as-html}
11021 Export to a temporary buffer. Do not create a file.
11024 @c FIXME Exporting sublevels
11025 @c @cindex headline levels, for exporting
11026 @c In the exported version, the first 3 outline levels will become headlines,
11027 @c defining a general document structure. Additional levels will be exported as
11028 @c itemized lists. If you want that transition to occur at a different level,
11029 @c specify it with a numeric prefix argument. For example,
11032 @c @kbd{C-2 C-c C-e b}
11036 @c creates two levels of headings and does the rest as items.
11038 @node HTML doctypes
11039 @subsection HTML doctypes
11040 @vindex org-html-doctype
11041 @vindex org-html-doctype-alist
11043 Org can export to various (X)HTML flavors.
11045 Setting the variable @code{org-html-doctype} allows you to export to different
11046 (X)HTML variants. The exported HTML will be adjusted according to the syntax
11047 requirements of that variant. You can either set this variable to a doctype
11048 string directly, in which case the exporter will try to adjust the syntax
11049 automatically, or you can use a ready-made doctype. The ready-made options
11056 ``html4-transitional''
11062 ``xhtml-transitional''
11073 See the variable @code{org-html-doctype-alist} for details. The default is
11076 @subsubheading Fancy HTML5 export
11077 @vindex org-html-html5-fancy
11078 @vindex org-html-html5-elements
11080 HTML5 introduces several new element types. By default, Org will not make
11081 use of these element types, but you can set @code{org-html-html5-fancy} to
11082 @code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
11083 enable a few new block-level elements. These are created using arbitrary
11084 #+BEGIN and #+END blocks. For instance:
11103 #+ATTR_HTML: :controls controls :width 350
11105 #+HTML: <source src="movie.mp4" type="video/mp4">
11106 #+HTML: <source src="movie.ogg" type="video/ogg">
11107 Your browser does not support the video tag.
11114 <video controls="controls" width="350">
11115 <source src="movie.mp4" type="video/mp4">
11116 <source src="movie.ogg" type="video/ogg">
11117 <p>Your browser does not support the video tag.</p>
11121 Special blocks that do not correspond to HTML5 elements (see
11122 @code{org-html-html5-elements}) will revert to the usual behavior,
11123 i.e. @code{#+BEGIN_LEDERHOSEN} will still export to @samp{<div class="lederhosen">}.
11125 Headlines cannot appear within special blocks. To wrap a headline and its
11126 contents in e.g. @samp{<section>} or @samp{<article>} tags, set the
11127 @code{HTML_CONTAINER} property on the headline itself.
11129 @node HTML preamble and postamble
11130 @subsection HTML preamble and postamble
11131 @vindex org-html-preamble
11132 @vindex org-html-postamble
11133 @vindex org-html-preamble-format
11134 @vindex org-html-postamble-format
11135 @vindex org-html-validation-link
11136 @vindex org-export-creator-string
11137 @vindex org-export-time-stamp-file
11139 The HTML exporter lets you define a preamble and a postamble.
11141 The default value for @code{org-html-preamble} is @code{t}, which means
11142 that the preamble is inserted depending on the relevant format string in
11143 @code{org-html-preamble-format}.
11145 Setting @code{org-html-preamble} to a string will override the default format
11146 string. If you set it to a function, it will insert the output of the
11147 function, which must be a string. Setting to @code{nil} will not insert any
11150 The default value for @code{org-html-postamble} is @code{'auto}, which means
11151 that the HTML exporter will look for information about the author, the email,
11152 the creator and the date, and build the postamble from these values. Setting
11153 @code{org-html-postamble} to @code{t} will insert the postamble from the
11154 relevant format string found in @code{org-html-postamble-format}. Setting it
11155 to @code{nil} will not insert any postamble.
11157 @node Quoting HTML tags
11158 @subsection Quoting HTML tags
11160 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
11161 @samp{>} in HTML export. If you want to include raw HTML code, which
11162 should only appear in HTML export, mark it with @samp{@@@@html:} as in
11163 @samp{@@@@html:<b>@@@@bold text@@@@html:</b>@@@@}. For more extensive HTML
11164 that should be copied verbatim to the exported file use either
11167 @cindex #+BEGIN_HTML
11169 #+HTML: Literal HTML code for export
11173 @cindex #+BEGIN_HTML
11177 All lines between these markers are exported literally
11182 @node Links in HTML export
11183 @subsection Links in HTML export
11185 @cindex links, in HTML export
11186 @cindex internal links, in HTML export
11187 @cindex external links, in HTML export
11188 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
11189 includes automatic links created by radio targets (@pxref{Radio
11190 targets}). Links to external files will still work if the target file is on
11191 the same @i{relative} path as the published Org file. Links to other
11192 @file{.org} files will be translated into HTML links under the assumption
11193 that an HTML version also exists of the linked file, at the same relative
11194 path. @samp{id:} links can then be used to jump to specific entries across
11195 files. For information related to linking files while publishing them to a
11196 publishing directory see @ref{Publishing links}.
11198 If you want to specify attributes for links, you can do so using a special
11199 @code{#+ATTR_HTML} line to define attributes that will be added to the
11200 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
11201 and @code{style} attributes for a link:
11203 @cindex #+ATTR_HTML
11205 #+ATTR_HTML: :title The Org mode homepage :style color:red;
11206 [[http://orgmode.org]]
11209 @node Tables in HTML export
11210 @subsection Tables in HTML export
11211 @cindex tables, in HTML
11212 @vindex org-html-table-default-attributes
11214 Org mode tables are exported to HTML using the table attributes defined in
11215 @code{org-html-table-default-attributes}. The default setting makes tables
11216 without cell borders and frame. If you would like to change this for
11217 individual tables, place something like the following before the table:
11220 @cindex #+ATTR_HTML
11222 #+CAPTION: This is a table with lines around and between cells
11223 #+ATTR_HTML: :border 2 :rules all :frame border
11226 @vindex org-html-table-row-tags
11227 You can also modify the default tags used for each row by setting
11228 @code{org-html-table-row-tags}. See the docstring for an example on
11229 how to use this option.
11231 @node Images in HTML export
11232 @subsection Images in HTML export
11234 @cindex images, inline in HTML
11235 @cindex inlining images in HTML
11236 @vindex org-html-inline-images
11237 HTML export can inline images given as links in the Org file, and
11238 it can make an image the clickable part of a link. By
11239 default@footnote{But see the variable
11240 @code{org-html-inline-images}.}, images are inlined if a link does
11241 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
11242 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
11243 @samp{the image} that points to the image. If the description part
11244 itself is a @code{file:} link or a @code{http:} URL pointing to an
11245 image, this image will be inlined and activated so that clicking on the
11246 image will activate the link. For example, to include a thumbnail that
11247 will link to a high resolution version of the image, you could use:
11250 [[file:highres.jpg][file:thumb.jpg]]
11253 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
11254 In the example below we specify the @code{alt} and @code{title} attributes to
11255 support text viewers and accessibility, and align it to the right.
11258 @cindex #+ATTR_HTML
11260 #+CAPTION: A black cat stalking a spider
11261 #+ATTR_HTML: :alt cat/spider image :title Action! :align right
11266 You could use @code{http} addresses just as well.
11268 @node Math formatting in HTML export
11269 @subsection Math formatting in HTML export
11272 @cindex imagemagick
11274 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
11275 different ways on HTML pages. The default is to use the
11276 @uref{http://www.mathjax.org, MathJax system} which should work out of the
11277 box with Org mode installation because @uref{http://orgmode.org} serves
11278 @file{MathJax} for Org mode users for small applications and for testing
11279 purposes. @b{If you plan to use this regularly or on pages with significant
11280 page views, you should install@footnote{Installation instructions can be
11281 found on the MathJax website, see
11282 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
11283 your own server in order to limit the load of our server.} To configure
11284 @file{MathJax}, use the variable @code{org-html-mathjax-options} or
11285 insert something like the following into the buffer:
11288 #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
11291 @noindent See the docstring of the variable
11292 @code{org-html-mathjax-options} for the meaning of the parameters in
11295 If you prefer, you can also request that @LaTeX{} fragments are processed
11296 into small images that will be inserted into the browser page. Before the
11297 availability of MathJax, this was the default method for Org files. This
11298 method requires that the @file{dvipng} program or @file{imagemagick} suite is
11299 available on your system. You can still get this processing with
11302 #+OPTIONS: tex:dvipng
11308 #+OPTIONS: tex:imagemagick
11311 @node Text areas in HTML export
11312 @subsection Text areas in HTML export
11314 @cindex text areas, in HTML
11315 An alternative way to publish literal code examples in HTML is to use text
11316 areas, where the example can even be edited before pasting it into an
11317 application. It is triggered by @code{:textarea} attribute at an
11318 @code{example} or @code{src} block.
11320 You may also use @code{:height} and @code{:width} attributes to specify the
11321 height and width of the text area, which default to the number of lines in
11322 the example, and 80, respectively. For example
11325 #+ATTR_HTML: :textarea t :width 40
11327 (defun org-xor (a b)
11335 @subsection CSS support
11336 @cindex CSS, for HTML export
11337 @cindex HTML export, CSS
11339 @vindex org-html-todo-kwd-class-prefix
11340 @vindex org-html-tag-class-prefix
11341 You can modify the CSS style definitions for the exported file. The HTML
11342 exporter assigns the following special CSS classes@footnote{If the classes on
11343 TODO keywords and tags lead to conflicts, use the variables
11344 @code{org-html-todo-kwd-class-prefix} and @code{org-html-tag-class-prefix} to
11345 make them unique.} to appropriate parts of the document---your style
11346 specifications may change these, in addition to any of the standard classes
11347 like for headlines, tables, etc.
11349 p.author @r{author information, including email}
11350 p.date @r{publishing date}
11351 p.creator @r{creator info, about org mode version}
11352 .title @r{document title}
11353 .todo @r{TODO keywords, all not-done states}
11354 .done @r{the DONE keywords, all states that count as done}
11355 .WAITING @r{each TODO keyword also uses a class named after itself}
11356 .timestamp @r{timestamp}
11357 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
11358 .timestamp-wrapper @r{span around keyword plus timestamp}
11359 .tag @r{tag in a headline}
11360 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
11361 .target @r{target for links}
11362 .linenr @r{the line number in a code example}
11363 .code-highlighted @r{for highlighting referenced code lines}
11364 div.outline-N @r{div for outline level N (headline plus text))}
11365 div.outline-text-N @r{extra div for text at outline level N}
11366 .section-number-N @r{section number in headlines, different for each level}
11367 .figure-number @r{label like "Figure 1:"}
11368 .table-number @r{label like "Table 1:"}
11369 .listing-number @r{label like "Listing 1:"}
11370 div.figure @r{how to format an inlined image}
11371 pre.src @r{formatted source code}
11372 pre.example @r{normal example}
11373 p.verse @r{verse paragraph}
11374 div.footnotes @r{footnote section headline}
11375 p.footnote @r{footnote definition paragraph, containing a footnote}
11376 .footref @r{a footnote reference number (always a <sup>)}
11377 .footnum @r{footnote number in footnote definition (always <sup>)}
11380 @vindex org-html-style-default
11381 @vindex org-html-head-include-default-style
11382 @vindex org-html-head
11383 @vindex org-html-head-extra
11384 @cindex #+HTML_INCLUDE_STYLE
11385 Each exported file contains a compact default style that defines these
11386 classes in a basic way@footnote{This style is defined in the constant
11387 @code{org-html-style-default}, which you should not modify. To turn
11388 inclusion of these defaults off, customize
11389 @code{org-html-head-include-default-style} or set @code{html-style} to
11390 @code{nil} in an @code{OPTIONS} line.}. You may overwrite these settings, or
11391 add to them by using the variables @code{org-html-head} and
11392 @code{org-html-head-extra}. You can override the global values of these
11393 variables for each file by using these keywords:
11395 @cindex #+HTML_HEAD
11396 @cindex #+HTML_HEAD_EXTRA
11398 #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" />
11399 #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" />
11403 For longer style definitions, you can use several such lines. You could also
11404 directly write a @code{<style>} @code{</style>} section in this way, without
11405 referring to an external file.
11407 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
11408 property to assign a class to the tree. In order to specify CSS styles for a
11409 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
11412 @c FIXME: More about header and footer styles
11413 @c FIXME: Talk about links and targets.
11415 @node JavaScript support
11416 @subsection JavaScript supported display of web pages
11418 @cindex Rose, Sebastian
11419 Sebastian Rose has written a JavaScript program especially designed to
11420 enhance the web viewing experience of HTML files created with Org. This
11421 program allows you to view large files in two different ways. The first one
11422 is an @emph{Info}-like mode where each section is displayed separately and
11423 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
11424 as well, press @kbd{?} for an overview of the available keys). The second
11425 view type is a @emph{folding} view much like Org provides inside Emacs. The
11426 script is available at @url{http://orgmode.org/org-info.js} and you can find
11427 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
11428 We host the script at our site, but if you use it a lot, you might not want
11429 to be dependent on @url{http://orgmode.org} and prefer to install a local
11430 copy on your own web server.
11432 All it then takes to use this program is adding a single line to the Org
11435 @cindex #+INFOJS_OPT
11437 #+INFOJS_OPT: view:info toc:nil
11441 If this line is found, the HTML header will automatically contain the code
11442 needed to invoke the script. Using the line above, you can set the following
11446 path: @r{The path to the script. The default is to grab the script from}
11447 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
11448 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
11449 view: @r{Initial view when the website is first shown. Possible values are:}
11450 info @r{Info-like interface with one section per page.}
11451 overview @r{Folding interface, initially showing only top-level.}
11452 content @r{Folding interface, starting with all headlines visible.}
11453 showall @r{Folding interface, all headlines and text visible.}
11454 sdepth: @r{Maximum headline level that will still become an independent}
11455 @r{section for info and folding modes. The default is taken from}
11456 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
11457 @r{If this is smaller than in @code{org-export-headline-levels}, each}
11458 @r{info/folding section can still contain child headlines.}
11459 toc: @r{Should the table of contents @emph{initially} be visible?}
11460 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
11461 tdepth: @r{The depth of the table of contents. The defaults are taken from}
11462 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
11463 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
11464 @r{If yes, the toc will never be displayed as a section.}
11465 ltoc: @r{Should there be short contents (children) in each section?}
11466 @r{Make this @code{above} if the section should be above initial text.}
11467 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
11468 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
11469 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
11470 @r{default), only one such button will be present.}
11473 @vindex org-html-infojs-options
11474 @vindex org-html-use-infojs
11475 You can choose default values for these options by customizing the variable
11476 @code{org-html-infojs-options}. If you always want to apply the script to your
11477 pages, configure the variable @code{org-html-use-infojs}.
11479 @node @LaTeX{} and PDF export
11480 @section @LaTeX{} and PDF export
11481 @cindex @LaTeX{} export
11484 @LaTeX{} export can produce an arbitrarily complex LaTeX document of any
11485 standard or custom document class. With further processing@footnote{The
11486 default @LaTeX{} output is designed for processing with @code{pdftex} or
11487 @LaTeX{}. It includes packages that are not compatible with @code{xetex} and
11488 possibly @code{luatex}. The @LaTeX{} exporter can be configured to support
11489 alternative TeX engines, see the options
11490 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}.},
11491 which the @LaTeX{} exporter is able to control, this back-end is able to
11492 produce PDF output. Because the @LaTeX{} exporter can be configured to use
11493 the @code{hyperref} package, the default setup produces fully-linked PDF
11496 As in @LaTeX{}, blank lines are meaningful for this back-end: a paragraph
11497 will not be started if two contiguous syntactical elements are not separated
11500 This back-end also offers enhanced support for footnotes. Thus, it handles
11501 nested footnotes, footnotes in tables and footnotes in a list item's
11505 * @LaTeX{} export commands:: How to export to LaTeX and PDF
11506 * Header and sectioning:: Setting up the export file structure
11507 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
11508 * @LaTeX{} specific attributes:: Controlling @LaTeX{} output
11511 @node @LaTeX{} export commands
11512 @subsection @LaTeX{} export commands
11515 @orgcmd{C-c C-e l l,org-latex-export-to-latex}
11516 Export as a @LaTeX{} file. For an Org file @file{myfile.org}, the @LaTeX{}
11517 file will be @file{myfile.tex}. The file will be overwritten without
11519 @orgcmd{C-c C-e l L,org-latex-export-as-latex}
11520 Export to a temporary buffer. Do not create a file.
11521 @orgcmd{C-c C-e l p,org-latex-export-to-pdf}
11522 Export as @LaTeX{} and then process to PDF.
11524 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
11527 @node Header and sectioning
11528 @subsection Header and sectioning structure
11529 @cindex @LaTeX{} class
11530 @cindex @LaTeX{} sectioning structure
11531 @cindex @LaTeX{} header
11532 @cindex header, for @LaTeX{} files
11533 @cindex sectioning structure, for @LaTeX{} export
11535 By default, the first three outline levels become headlines, defining a
11536 general document structure. Additional levels are exported as @code{itemize}
11537 or @code{enumerate} lists. The transition can also occur at a different
11538 level (@pxref{Export settings}).
11540 By default, the @LaTeX{} output uses the class @code{article}.
11542 @vindex org-latex-default-class
11543 @vindex org-latex-classes
11544 @vindex org-latex-default-packages-alist
11545 @vindex org-latex-packages-alist
11546 You can change this globally by setting a different value for
11547 @code{org-latex-default-class} or locally by adding an option like
11548 @code{#+LATEX_CLASS: myclass} in your file, or with
11549 a @code{EXPORT_LATEX_CLASS} property that applies when exporting a region
11550 containing only this (sub)tree. The class must be listed in
11551 @code{org-latex-classes}. This variable defines a header template for each
11552 class@footnote{Into which the values of
11553 @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}
11554 are spliced.}, and allows you to define the sectioning structure for each
11555 class. You can also define your own classes there.
11557 @cindex #+LATEX_CLASS
11558 @cindex #+LATEX_CLASS_OPTIONS
11559 @cindex property, EXPORT_LATEX_CLASS
11560 @cindex property, EXPORT_LATEX_CLASS_OPTIONS
11561 The @code{LATEX_CLASS_OPTIONS} keyword or @code{EXPORT_LATEX_CLASS_OPTIONS}
11562 property can specify the options for the @code{\documentclass} macro. These
11563 options have to be provided, as expected by @LaTeX{}, within square brackets.
11565 @cindex #+LATEX_HEADER
11566 @cindex #+LATEX_HEADER_EXTRA
11567 You can also use the @code{LATEX_HEADER} and
11568 @code{LATEX_HEADER_EXTRA}@footnote{Unlike @code{LATEX_HEADER}, contents
11569 from @code{LATEX_HEADER_EXTRA} keywords will not be loaded when previewing
11570 @LaTeX{} snippets (@pxref{Previewing @LaTeX{} fragments}).} keywords in order
11571 to add lines to the header. See the docstring of @code{org-latex-classes} for
11574 An example is shown below.
11577 #+LATEX_CLASS: article
11578 #+LATEX_CLASS_OPTIONS: [a4paper]
11579 #+LATEX_HEADER: \usepackage@{xyz@}
11585 @node Quoting @LaTeX{} code
11586 @subsection Quoting @LaTeX{} code
11588 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
11589 inserted into the @LaTeX{} file. Furthermore, you can add special code that
11590 should only be present in @LaTeX{} export with the following constructs:
11593 @cindex #+BEGIN_LATEX
11595 Code within @@@@latex:some code@@@@ a paragraph.
11597 #+LATEX: Literal @LaTeX{} code for export
11600 All lines between these markers are exported literally
11604 @node @LaTeX{} specific attributes
11605 @subsection @LaTeX{} specific attributes
11606 @cindex #+ATTR_LATEX
11608 @LaTeX{} understands attributes specified in an @code{ATTR_LATEX} line. They
11609 affect tables, images, plain lists, special blocks and source blocks.
11611 @subsubheading Tables in @LaTeX{} export
11612 @cindex tables, in @LaTeX{} export
11614 For @LaTeX{} export of a table, you can specify a label and a caption
11615 (@pxref{Images and tables}). You can also use attributes to control table
11616 layout and contents. Valid @LaTeX{} attributes include:
11620 @vindex org-latex-default-table-mode
11621 Nature of table's contents. It can be set to @code{table}, @code{math},
11622 @code{inline-math} or @code{verbatim}. In particular, when in @code{math} or
11623 @code{inline-math} mode, every cell is exported as-is, horizontal rules are
11624 ignored and the table will be wrapped in a math environment. Also,
11625 contiguous tables sharing the same math mode will be wrapped within the same
11626 environment. Default mode is determined in
11627 @code{org-latex-default-table-mode}.
11629 @vindex org-latex-default-table-environment
11630 Environment used for the table. It can be set to any @LaTeX{} table
11631 environment, like @code{tabularx}@footnote{Requires adding the
11632 @code{tabularx} package to @code{org-latex-packages-alist}.},
11633 @code{longtable}, @code{array}, @code{tabu}@footnote{Requires adding the
11634 @code{tabu} package to @code{org-latex-packages-alist}.},
11635 @code{bmatrix}@enddots{} It defaults to
11636 @code{org-latex-default-table-environment} value.
11638 @code{#+CAPTION} keyword is the simplest way to set a caption for a table
11639 (@pxref{Images and tables}). If you need more advanced commands for that
11640 task, you can use @code{:caption} attribute instead. Its value should be raw
11641 @LaTeX{} code. It has precedence over @code{#+CAPTION}.
11644 Float environment for the table. Possible values are @code{sidewaystable},
11645 @code{multicolumn}, @code{t} and @code{nil}. When unspecified, a table with
11646 a caption will have a @code{table} environment. Moreover, @code{:placement}
11647 attribute can specify the positioning of the float.
11651 Set, respectively, the alignment string of the table, its font size and its
11652 width. They only apply on regular tables.
11654 Boolean specific to the @code{tabu} and @code{longtabu} environments, and
11655 only takes effect when used in conjunction with the @code{:width} attribute.
11656 When @code{:spread} is non-@code{nil}, the table will be spread or shrunk by the
11657 value of @code{:width}.
11661 @vindex org-latex-tables-booktabs
11662 @vindex org-latex-tables-centered
11663 They toggle, respectively, @code{booktabs} usage (assuming the package is
11664 properly loaded), table centering and removal of every horizontal rule but
11665 the first one (in a "table.el" table only). In particular,
11666 @code{org-latex-tables-booktabs} (respectively @code{org-latex-tables-centered})
11667 activates the first (respectively second) attribute globally.
11669 @itemx :math-suffix
11670 @itemx :math-arguments
11671 A string that will be inserted, respectively, before the table within the
11672 math environment, after the table within the math environment, and between
11673 the macro name and the contents of the table. The @code{:math-arguments}
11674 attribute is used for matrix macros that require more than one argument
11675 (e.g., @code{qbordermatrix}).
11678 Thus, attributes can be used in a wide array of situations, like writing
11679 a table that will span over multiple pages, or a matrix product:
11682 #+ATTR_LATEX: :environment longtable :align l|lp@{3cm@}r|l
11686 #+ATTR_LATEX: :mode math :environment bmatrix :math-suffix \times
11689 #+ATTR_LATEX: :mode math :environment bmatrix
11694 In the example below, @LaTeX{} command
11695 @code{\bicaption@{HeadingA@}@{HeadingB@}} will set the caption.
11698 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11704 @subsubheading Images in @LaTeX{} export
11705 @cindex images, inline in @LaTeX{}
11706 @cindex inlining images in @LaTeX{}
11708 Images that are linked to without a description part in the link, like
11709 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
11710 output file resulting from @LaTeX{} processing. Org will use an
11711 @code{\includegraphics} macro to insert the image@footnote{In the case of
11712 TikZ (@url{http://sourceforge.net/projects/pgf/}) images, it will become an
11713 @code{\input} macro wrapped within a @code{tikzpicture} environment.}.
11715 You can specify specify image width or height with, respectively,
11716 @code{:width} and @code{:height} attributes. It is also possible to add any
11717 other option with the @code{:options} attribute, as shown in the following
11721 #+ATTR_LATEX: :width 5cm :options angle=90
11722 [[./img/sed-hr4049.pdf]]
11725 If you need a specific command for the caption, use @code{:caption}
11726 attribute. It will override standard @code{#+CAPTION} value, if any.
11729 #+ATTR_LATEX: :caption \bicaption@{HeadingA@}@{HeadingB@}
11730 [[./img/sed-hr4049.pdf]]
11733 If you have specified a caption as described in @ref{Images and tables}, the
11734 picture will be wrapped into a @code{figure} environment and thus become
11735 a floating element. You can also ask Org to export an image as a float
11736 without specifying caption by setting the @code{:float} attribute. You may
11740 @code{t}: if you want to use the standard @samp{figure} environment. It is
11741 used by default if you provide a caption to the image.
11743 @code{multicolumn}: if you wish to include an image which spans multiple
11744 columns in a page. This will export the image wrapped in a @code{figure*}
11747 @code{wrap}: if you would like to let text flow around the image. It will
11748 make the figure occupy the left half of the page.
11750 @code{nil}: if you need to avoid any floating environment, even when
11751 a caption is provided.
11754 To modify the placement option of any floating environment, set the
11755 @code{placement} attribute.
11758 #+ATTR_LATEX: :float wrap :width 0.38\textwidth :placement @{r@}@{0.4\textwidth@}
11762 If the @code{:comment-include} attribute is set to a non-@code{nil} value,
11763 the @LaTeX{} @code{\includegraphics} macro will be commented out.
11765 @subsubheading Plain lists in @LaTeX{} export
11766 @cindex plain lists, in @LaTeX{} export
11768 Plain lists accept two optional attributes: @code{:environment} and
11769 @code{:options}. The first one allows the use of a non-standard
11770 environment (e.g., @samp{inparaenum}). The second one specifies
11771 optional arguments for that environment (square brackets may be
11775 #+ATTR_LATEX: :environment compactitem :options $\circ$
11776 - you need ``paralist'' package to reproduce this example.
11779 @subsubheading Source blocks in @LaTeX{} export
11780 @cindex source blocks, in @LaTeX{} export
11782 In addition to syntax defined in @ref{Literal examples}, names and captions
11783 (@pxref{Images and tables}), source blocks also accept a @code{:float}
11784 attribute. You may set it to:
11787 @code{t}: if you want to make the source block a float. It is the default
11788 value when a caption is provided.
11790 @code{multicolumn}: if you wish to include a source block which spans multiple
11793 @code{nil}: if you need to avoid any floating environment, even when a caption
11794 is provided. It is useful for source code that may not fit in a single page.
11798 #+ATTR_LATEX: :float nil
11799 #+BEGIN_SRC emacs-lisp
11800 Code that may not fit in a single page.
11804 @subsubheading Special blocks in @LaTeX{} export
11805 @cindex special blocks, in @LaTeX{} export
11807 In @LaTeX{} back-end, special blocks become environments of the same name.
11808 Value of @code{:options} attribute will be appended as-is to that
11809 environment's opening string. For example:
11812 #+ATTR_LATEX: :options [Proof of important theorem]
11815 Therefore, any even number greater than 2 is the sum of two primes.
11823 \begin@{proof@}[Proof of important theorem]
11825 Therefore, any even number greater than 2 is the sum of two primes.
11829 If you need to insert a specific caption command, use @code{:caption}
11830 attribute. It will override standard @code{#+CAPTION} value, if any. For
11834 #+ATTR_LATEX: :caption \MyCaption@{HeadingA@}
11840 @subsubheading Horizontal rules
11841 @cindex horizontal rules, in @LaTeX{} export
11843 Width and thickness of a given horizontal rule can be controlled with,
11844 respectively, @code{:width} and @code{:thickness} attributes:
11847 #+ATTR_LATEX: :width .6\textwidth :thickness 0.8pt
11851 @node Markdown export
11852 @section Markdown export
11853 @cindex Markdown export
11855 @code{md} export back-end generates Markdown syntax@footnote{Vanilla flavor,
11856 as defined at @url{http://daringfireball.net/projects/markdown/}.} for an Org
11859 It is built over HTML back-end: any construct not supported by Markdown
11860 syntax (e.g., tables) will be controlled and translated by @code{html}
11861 back-end (@pxref{HTML export}).
11863 @subheading Markdown export commands
11866 @orgcmd{C-c C-e m m,org-md-export-to-markdown}
11867 Export as a text file written in Markdown syntax. For an Org file,
11868 @file{myfile.org}, the resulting file will be @file{myfile.md}. The file
11869 will be overwritten without warning.
11870 @orgcmd{C-c C-e m M,org-md-export-as-markdown}
11871 Export to a temporary buffer. Do not create a file.
11873 Export as a text file with Markdown syntax, then open it.
11876 @subheading Header and sectioning structure
11878 @vindex org-md-headline-style
11879 Markdown export can generate both @code{atx} and @code{setext} types for
11880 headlines, according to @code{org-md-headline-style}. The former introduces
11881 a hard limit of two levels, whereas the latter pushes it to six. Headlines
11882 below that limit are exported as lists. You can also set a soft limit before
11883 that one (@pxref{Export settings}).
11885 @c begin opendocument
11887 @node OpenDocument text export
11888 @section OpenDocument text export
11890 @cindex OpenDocument
11891 @cindex export, OpenDocument
11892 @cindex LibreOffice
11894 Org mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
11895 (ODT) format. Documents created by this exporter use the
11896 @cite{OpenDocument-v1.2
11897 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11898 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
11899 are compatible with LibreOffice 3.4.
11902 * Pre-requisites for ODT export:: What packages ODT exporter relies on
11903 * ODT export commands:: How to invoke ODT export
11904 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
11905 * Applying custom styles:: How to apply custom styles to the output
11906 * Links in ODT export:: How links will be interpreted and formatted
11907 * Tables in ODT export:: How Tables are exported
11908 * Images in ODT export:: How to insert images
11909 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
11910 * Labels and captions in ODT export:: How captions are rendered
11911 * Literal examples in ODT export:: How source and example blocks are formatted
11912 * Advanced topics in ODT export:: Read this if you are a power user
11915 @node Pre-requisites for ODT export
11916 @subsection Pre-requisites for ODT export
11918 The ODT exporter relies on the @file{zip} program to create the final
11919 output. Check the availability of this program before proceeding further.
11921 @node ODT export commands
11922 @subsection ODT export commands
11924 @subsubheading Exporting to ODT
11925 @anchor{x-export-to-odt}
11927 @cindex region, active
11928 @cindex active region
11929 @cindex transient-mark-mode
11931 @orgcmd{C-c C-e o o,org-odt-export-to-odt}
11932 @cindex property EXPORT_FILE_NAME
11934 Export as OpenDocument Text file.
11936 @vindex org-odt-preferred-output-format
11937 If @code{org-odt-preferred-output-format} is specified, automatically convert
11938 the exported file to that format. @xref{x-export-to-other-formats, ,
11939 Automatically exporting to other formats}.
11941 For an Org file @file{myfile.org}, the ODT file will be
11942 @file{myfile.odt}. The file will be overwritten without warning. If there
11943 is an active region,@footnote{This requires @code{transient-mark-mode} to be
11944 turned on} only the region will be exported. If the selected region is a
11945 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
11946 tree head will become the document title. If the tree head entry has, or
11947 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
11951 Export as an OpenDocument Text file and open the resulting file.
11953 @vindex org-odt-preferred-output-format
11954 If @code{org-odt-preferred-output-format} is specified, open the converted
11955 file instead. @xref{x-export-to-other-formats, , Automatically exporting to
11959 @node Extending ODT export
11960 @subsection Extending ODT export
11962 The ODT exporter can interface with a variety of document
11963 converters and supports popular converters out of the box. As a result, you
11964 can use it to export to formats like @samp{doc} or convert a document from
11965 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
11967 @cindex @file{unoconv}
11968 @cindex LibreOffice
11969 If you have a working installation of LibreOffice, a document converter is
11970 pre-configured for you and you can use it right away. If you would like to
11971 use @file{unoconv} as your preferred converter, customize the variable
11972 @code{org-odt-convert-process} to point to @code{unoconv}. You can
11973 also use your own favorite converter or tweak the default settings of the
11974 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
11975 document converter}.
11977 @subsubheading Automatically exporting to other formats
11978 @anchor{x-export-to-other-formats}
11980 @vindex org-odt-preferred-output-format
11981 Very often, you will find yourself exporting to ODT format, only to
11982 immediately save the exported document to other formats like @samp{doc},
11983 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
11984 preferred output format by customizing the variable
11985 @code{org-odt-preferred-output-format}. This way, the export commands
11986 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
11987 format that is of immediate interest to you.
11989 @subsubheading Converting between document formats
11990 @anchor{x-convert-to-other-formats}
11992 There are many document converters in the wild which support conversion to
11993 and from various file formats, including, but not limited to the
11994 ODT format. LibreOffice converter, mentioned above, is one such
11995 converter. Once a converter is configured, you can interact with it using
11996 the following command.
11998 @vindex org-odt-convert
12001 @item M-x org-odt-convert RET
12002 Convert an existing document from one format to another. With a prefix
12003 argument, also open the newly produced file.
12006 @node Applying custom styles
12007 @subsection Applying custom styles
12008 @cindex styles, custom
12009 @cindex template, custom
12011 The ODT exporter ships with a set of OpenDocument styles
12012 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
12013 output. These factory styles, however, may not cater to your specific
12014 tastes. To customize the output, you can either modify the above styles
12015 files directly, or generate the required styles using an application like
12016 LibreOffice. The latter method is suitable for expert and non-expert
12017 users alike, and is described here.
12019 @subsubheading Applying custom styles: the easy way
12023 Create a sample @file{example.org} file with the below settings and export it
12027 #+OPTIONS: H:10 num:t
12031 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
12032 to locate the target styles---these typically have the @samp{Org} prefix---and
12033 modify those to your taste. Save the modified file either as an
12034 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
12037 @cindex #+ODT_STYLES_FILE
12038 @vindex org-odt-styles-file
12039 Customize the variable @code{org-odt-styles-file} and point it to the
12040 newly created file. For additional configuration options
12041 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
12043 If you would like to choose a style on a per-file basis, you can use the
12044 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
12047 #+ODT_STYLES_FILE: "/path/to/example.ott"
12053 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
12058 @subsubheading Using third-party styles and templates
12060 You can use third-party styles and templates for customizing your output.
12061 This will produce the desired output only if the template provides all
12062 style names that the @samp{ODT} exporter relies on. Unless this condition is
12063 met, the output is going to be less than satisfactory. So it is highly
12064 recommended that you only work with templates that are directly derived from
12065 the factory settings.
12067 @node Links in ODT export
12068 @subsection Links in ODT export
12069 @cindex links, in ODT export
12071 ODT exporter creates native cross-references for internal links. It creates
12072 Internet-style links for all other links.
12074 A link with no description and destined to a regular (un-itemized) outline
12075 heading is replaced with a cross-reference and section number of the heading.
12077 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
12078 with a cross-reference and sequence number of the labeled entity.
12079 @xref{Labels and captions in ODT export}.
12081 @node Tables in ODT export
12082 @subsection Tables in ODT export
12083 @cindex tables, in ODT export
12085 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
12086 tables is supported. However, export of complex @file{table.el} tables---tables
12087 that have column or row spans---is not supported. Such tables are
12088 stripped from the exported document.
12090 By default, a table is exported with top and bottom frames and with rules
12091 separating row and column groups (@pxref{Column groups}). Furthermore, all
12092 tables are typeset to occupy the same width. If the table specifies
12093 alignment and relative width for its columns (@pxref{Column width and
12094 alignment}) then these are honored on export.@footnote{The column widths are
12095 interpreted as weighted ratios with the default weight being 1}
12098 You can control the width of the table by specifying @code{:rel-width}
12099 property using an @code{#+ATTR_ODT} line.
12101 For example, consider the following table which makes use of all the rules
12105 #+ATTR_ODT: :rel-width 50
12106 | Area/Month | Jan | Feb | Mar | Sum |
12107 |---------------+-------+-------+-------+-------|
12109 | <l13> | <r5> | <r5> | <r5> | <r6> |
12110 | North America | 1 | 21 | 926 | 948 |
12111 | Middle East | 6 | 75 | 844 | 925 |
12112 | Asia Pacific | 9 | 27 | 790 | 826 |
12113 |---------------+-------+-------+-------+-------|
12114 | Sum | 16 | 123 | 2560 | 2699 |
12117 On export, the table will occupy 50% of text area. The columns will be sized
12118 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
12119 and rest of the columns will be right-aligned. There will be vertical rules
12120 after separating the header and last columns from other columns. There will
12121 be horizontal rules separating the header and last rows from other rows.
12123 If you are not satisfied with the above formatting options, you can create
12124 custom table styles and associate them with a table using the
12125 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
12127 @node Images in ODT export
12128 @subsection Images in ODT export
12129 @cindex images, embedding in ODT
12130 @cindex embedding images in ODT
12132 @subsubheading Embedding images
12133 You can embed images within the exported document by providing a link to the
12134 desired image file with no link description. For example, to embed
12135 @samp{img.png} do either of the following:
12145 @subsubheading Embedding clickable images
12146 You can create clickable images by providing a link whose description is a
12147 link to an image file. For example, to embed a image
12148 @file{org-mode-unicorn.png} which when clicked jumps to
12149 @uref{http://Orgmode.org} website, do the following
12152 [[http://orgmode.org][./org-mode-unicorn.png]]
12155 @subsubheading Sizing and scaling of embedded images
12158 You can control the size and scale of the embedded images using the
12159 @code{#+ATTR_ODT} attribute.
12161 @cindex identify, ImageMagick
12162 @vindex org-odt-pixels-per-inch
12163 The exporter specifies the desired size of the image in the final document in
12164 units of centimeters. In order to scale the embedded images, the exporter
12165 queries for pixel dimensions of the images using one of a) ImageMagick's
12166 @file{identify} program or b) Emacs `create-image' and `image-size'
12167 APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you
12168 routinely produce documents that have large images or you export your Org
12169 files that has images using a Emacs batch script, then the use of
12170 @file{ImageMagick} is mandatory.}. The pixel dimensions are subsequently
12171 converted in to units of centimeters using
12172 @code{org-odt-pixels-per-inch}. The default value of this variable is
12173 set to @code{display-pixels-per-inch}. You can tweak this variable to
12174 achieve the best results.
12176 The examples below illustrate the various possibilities.
12179 @item Explicitly size the image
12180 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
12183 #+ATTR_ODT: :width 10 :height 10
12187 @item Scale the image
12188 To embed @file{img.png} at half its size, do the following:
12191 #+ATTR_ODT: :scale 0.5
12195 @item Scale the image to a specific width
12196 To embed @file{img.png} with a width of 10 cm while retaining the original
12197 height:width ratio, do the following:
12200 #+ATTR_ODT: :width 10
12204 @item Scale the image to a specific height
12205 To embed @file{img.png} with a height of 10 cm while retaining the original
12206 height:width ratio, do the following
12209 #+ATTR_ODT: :height 10
12214 @subsubheading Anchoring of images
12217 You can control the manner in which an image is anchored by setting the
12218 @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
12219 of the the following three values for the @code{:anchor} property:
12220 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
12222 To create an image that is anchored to a page, do the following:
12224 #+ATTR_ODT: :anchor "page"
12228 @node Math formatting in ODT export
12229 @subsection Math formatting in ODT export
12231 The ODT exporter has special support for handling math.
12234 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
12235 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
12238 @node Working with @LaTeX{} math snippets
12239 @subsubheading Working with @LaTeX{} math snippets
12241 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
12242 document in one of the following ways:
12248 This option is activated on a per-file basis with
12254 With this option, @LaTeX{} fragments are first converted into MathML
12255 fragments using an external @LaTeX{}-to-MathML converter program. The
12256 resulting MathML fragments are then embedded as an OpenDocument Formula in
12257 the exported document.
12259 @vindex org-latex-to-mathml-convert-command
12260 @vindex org-latex-to-mathml-jar-file
12262 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
12263 @code{org-latex-to-mathml-convert-command} and
12264 @code{org-latex-to-mathml-jar-file}.
12266 If you prefer to use @file{MathToWeb}@footnote{See
12267 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
12268 converter, you can configure the above variables as shown below.
12271 (setq org-latex-to-mathml-convert-command
12272 "java -jar %j -unicode -force -df %o %I"
12273 org-latex-to-mathml-jar-file
12274 "/path/to/mathtoweb.jar")
12277 You can use the following commands to quickly verify the reliability of
12278 the @LaTeX{}-to-MathML converter.
12281 @item M-x org-odt-export-as-odf RET
12282 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
12284 @item M-x org-odt-export-as-odf-and-open RET
12285 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
12286 and open the formula file with the system-registered application.
12290 @cindex imagemagick
12293 This option is activated on a per-file basis with
12296 #+OPTIONS: tex:dvipng
12302 #+OPTIONS: tex:imagemagick
12305 With this option, @LaTeX{} fragments are processed into PNG images and the
12306 resulting images are embedded in the exported document. This method requires
12307 that the @file{dvipng} program or @file{imagemagick} suite be available on
12311 @node Working with MathML or OpenDocument formula files
12312 @subsubheading Working with MathML or OpenDocument formula files
12314 For various reasons, you may find embedding @LaTeX{} math snippets in an
12315 ODT document less than reliable. In that case, you can embed a
12316 math equation by linking to its MathML (@file{.mml}) source or its
12317 OpenDocument formula (@file{.odf}) file as shown below:
12329 @node Labels and captions in ODT export
12330 @subsection Labels and captions in ODT export
12332 You can label and caption various category of objects---an inline image, a
12333 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
12334 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
12335 each labeled or captioned object of a given category separately. As a
12336 result, each such object is assigned a sequence number based on order of it's
12337 appearance in the Org file.
12339 In the exported document, a user-provided caption is augmented with the
12340 category and sequence number. Consider the following inline image in an Org
12344 #+CAPTION: Bell curve
12345 #+LABEL: fig:SED-HR4049
12349 It could be rendered as shown below in the exported document.
12352 Figure 2: Bell curve
12355 @vindex org-odt-category-map-alist
12356 You can modify the category component of the caption by customizing the
12357 option @code{org-odt-category-map-alist}. For example, to tag all embedded
12358 images with the string @samp{Illustration} (instead of the default
12359 @samp{Figure}) use the following setting:
12362 (setq org-odt-category-map-alist
12363 (("__Figure__" "Illustration" "value" "Figure" org-odt--enumerable-image-p)))
12366 With this, previous image will be captioned as below in the exported
12370 Illustration 2: Bell curve
12373 @node Literal examples in ODT export
12374 @subsection Literal examples in ODT export
12376 Export of literal examples (@pxref{Literal examples}) with full fontification
12377 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
12378 generate all style definitions needed for a fancy listing.@footnote{Your
12379 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
12380 fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
12381 as prefix and inherit their color from the faces used by Emacs
12382 @code{font-lock} library for the source language.
12384 @vindex org-odt-fontify-srcblocks
12385 If you prefer to use your own custom styles for fontification, you can do
12386 so by customizing the option
12387 @code{org-odt-create-custom-styles-for-srcblocks}.
12389 @vindex org-odt-create-custom-styles-for-srcblocks
12390 You can turn off fontification of literal examples by customizing the
12391 option @code{org-odt-fontify-srcblocks}.
12393 @node Advanced topics in ODT export
12394 @subsection Advanced topics in ODT export
12396 If you rely heavily on ODT export, you may want to exploit the full
12397 set of features that the exporter offers. This section describes features
12398 that would be of interest to power users.
12401 * Configuring a document converter:: How to register a document converter
12402 * Working with OpenDocument style files:: Explore the internals
12403 * Creating one-off styles:: How to produce custom highlighting etc
12404 * Customizing tables in ODT export:: How to define and use Table templates
12405 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
12408 @node Configuring a document converter
12409 @subsubheading Configuring a document converter
12411 @cindex doc, docx, rtf
12414 The ODT exporter can work with popular converters with little or no
12415 extra configuration from your side. @xref{Extending ODT export}.
12416 If you are using a converter that is not supported by default or if you would
12417 like to tweak the default converter settings, proceed as below.
12420 @item Register the converter
12422 @vindex org-odt-convert-processes
12423 Name your converter and add it to the list of known converters by
12424 customizing the option @code{org-odt-convert-processes}. Also specify how
12425 the converter can be invoked via command-line to effect the conversion.
12427 @item Configure its capabilities
12429 @vindex org-odt-convert-capabilities
12430 @anchor{x-odt-converter-capabilities} Specify the set of formats the
12431 converter can handle by customizing the variable
12432 @code{org-odt-convert-capabilities}. Use the default value for this
12433 variable as a guide for configuring your converter. As suggested by the
12434 default setting, you can specify the full set of formats supported by the
12435 converter and not limit yourself to specifying formats that are related to
12436 just the OpenDocument Text format.
12438 @item Choose the converter
12440 @vindex org-odt-convert-process
12441 Select the newly added converter as the preferred one by customizing the
12442 option @code{org-odt-convert-process}.
12445 @node Working with OpenDocument style files
12446 @subsubheading Working with OpenDocument style files
12447 @cindex styles, custom
12448 @cindex template, custom
12450 This section explores the internals of the ODT exporter and the
12451 means by which it produces styled documents. Read this section if you are
12452 interested in exploring the automatic and custom OpenDocument styles used by
12455 @anchor{x-factory-styles}
12456 @subsubheading a) Factory styles
12458 The ODT exporter relies on two files for generating its output.
12459 These files are bundled with the distribution under the directory pointed to
12460 by the variable @code{org-odt-styles-dir}. The two files are:
12463 @anchor{x-orgodtstyles-xml}
12465 @file{OrgOdtStyles.xml}
12467 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
12468 document. This file gets modified for the following purposes:
12472 To control outline numbering based on user settings.
12475 To add styles generated by @file{htmlfontify.el} for fontification of code
12479 @anchor{x-orgodtcontenttemplate-xml}
12481 @file{OrgOdtContentTemplate.xml}
12483 This file contributes to the @file{content.xml} file of the final @samp{ODT}
12484 document. The contents of the Org outline are inserted between the
12485 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
12487 Apart from serving as a template file for the final @file{content.xml}, the
12488 file serves the following purposes:
12492 It contains automatic styles for formatting of tables which are referenced by
12496 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
12497 elements that control how various entities---tables, images, equations,
12498 etc.---are numbered.
12502 @anchor{x-overriding-factory-styles}
12503 @subsubheading b) Overriding factory styles
12504 The following two variables control the location from which the ODT
12505 exporter picks up the custom styles and content template files. You can
12506 customize these variables to override the factory styles used by the
12510 @anchor{x-org-odt-styles-file}
12512 @code{org-odt-styles-file}
12514 Use this variable to specify the @file{styles.xml} that will be used in the
12515 final output. You can specify one of the following values:
12518 @item A @file{styles.xml} file
12520 Use this file instead of the default @file{styles.xml}
12522 @item A @file{.odt} or @file{.ott} file
12524 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12527 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
12529 Use the @file{styles.xml} contained in the specified OpenDocument Text or
12530 Template file. Additionally extract the specified member files and embed
12531 those within the final @samp{ODT} document.
12533 Use this option if the @file{styles.xml} file references additional files
12534 like header and footer images.
12538 Use the default @file{styles.xml}
12541 @anchor{x-org-odt-content-template-file}
12543 @code{org-odt-content-template-file}
12545 Use this variable to specify the blank @file{content.xml} that will be used
12546 in the final output.
12549 @node Creating one-off styles
12550 @subsubheading Creating one-off styles
12552 There are times when you would want one-off formatting in the exported
12553 document. You can achieve this by embedding raw OpenDocument XML in the Org
12554 file. The use of this feature is better illustrated with couple of examples.
12557 @item Embedding ODT tags as part of regular text
12559 You can inline OpenDocument syntax by enclosing it within
12560 @samp{@@@@odt:...@@@@} markup. For example, to highlight a region of text do
12564 @@@@odt:<text:span text:style-name="Highlight">This is a highlighted
12565 text</text:span>@@@@. But this is a regular text.
12568 @strong{Hint:} To see the above example in action, edit your
12569 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12570 custom @samp{Highlight} style as shown below.
12573 <style:style style:name="Highlight" style:family="text">
12574 <style:text-properties fo:background-color="#ff0000"/>
12578 @item Embedding a one-line OpenDocument XML
12580 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
12581 directive. For example, to force a page break do the following:
12584 #+ODT: <text:p text:style-name="PageBreak"/>
12587 @strong{Hint:} To see the above example in action, edit your
12588 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
12589 custom @samp{PageBreak} style as shown below.
12592 <style:style style:name="PageBreak" style:family="paragraph"
12593 style:parent-style-name="Text_20_body">
12594 <style:paragraph-properties fo:break-before="page"/>
12598 @item Embedding a block of OpenDocument XML
12600 You can add a large block of OpenDocument XML using the
12601 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
12603 For example, to create a one-off paragraph that uses bold text, do the
12608 <text:p text:style-name="Text_20_body_20_bold">
12609 This paragraph is specially formatted and uses bold text.
12616 @node Customizing tables in ODT export
12617 @subsubheading Customizing tables in ODT export
12618 @cindex tables, in ODT export
12621 You can override the default formatting of the table by specifying a custom
12622 table style with the @code{#+ATTR_ODT} line. For a discussion on default
12623 formatting of tables @pxref{Tables in ODT export}.
12625 This feature closely mimics the way table templates are defined in the
12627 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
12628 OpenDocument-v1.2 Specification}}
12630 @vindex org-odt-table-styles
12631 To have a quick preview of this feature, install the below setting and
12632 export the table that follows:
12635 (setq org-odt-table-styles
12636 (append org-odt-table-styles
12637 '(("TableWithHeaderRowAndColumn" "Custom"
12638 ((use-first-row-styles . t)
12639 (use-first-column-styles . t)))
12640 ("TableWithFirstRowandLastRow" "Custom"
12641 ((use-first-row-styles . t)
12642 (use-last-row-styles . t))))))
12646 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12647 | Name | Phone | Age |
12648 | Peter | 1234 | 17 |
12649 | Anna | 4321 | 25 |
12652 In the above example, you used a template named @samp{Custom} and installed
12653 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
12654 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
12655 styles needed for producing the above template have been pre-defined for
12656 you. These styles are available under the section marked @samp{Custom
12657 Table Template} in @file{OrgOdtContentTemplate.xml}
12658 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
12659 additional templates you have to define these styles yourselves.
12661 To use this feature proceed as follows:
12665 Create a table template@footnote{See the @code{<table:table-template>}
12666 element of the OpenDocument-v1.2 specification}
12668 A table template is nothing but a set of @samp{table-cell} and
12669 @samp{paragraph} styles for each of the following table cell categories:
12683 The names for the above styles must be chosen based on the name of the table
12684 template using a well-defined convention.
12686 The naming convention is better illustrated with an example. For a table
12687 template with the name @samp{Custom}, the needed style names are listed in
12688 the following table.
12690 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
12691 @headitem Table cell type
12692 @tab @code{table-cell} style
12693 @tab @code{paragraph} style
12698 @tab @samp{CustomTableCell}
12699 @tab @samp{CustomTableParagraph}
12701 @tab @samp{CustomFirstColumnTableCell}
12702 @tab @samp{CustomFirstColumnTableParagraph}
12704 @tab @samp{CustomLastColumnTableCell}
12705 @tab @samp{CustomLastColumnTableParagraph}
12707 @tab @samp{CustomFirstRowTableCell}
12708 @tab @samp{CustomFirstRowTableParagraph}
12710 @tab @samp{CustomLastRowTableCell}
12711 @tab @samp{CustomLastRowTableParagraph}
12713 @tab @samp{CustomEvenRowTableCell}
12714 @tab @samp{CustomEvenRowTableParagraph}
12716 @tab @samp{CustomOddRowTableCell}
12717 @tab @samp{CustomOddRowTableParagraph}
12719 @tab @samp{CustomEvenColumnTableCell}
12720 @tab @samp{CustomEvenColumnTableParagraph}
12722 @tab @samp{CustomOddColumnTableCell}
12723 @tab @samp{CustomOddColumnTableParagraph}
12726 To create a table template with the name @samp{Custom}, define the above
12728 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
12729 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
12733 Define a table style@footnote{See the attributes @code{table:template-name},
12734 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
12735 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
12736 @code{table:use-banding-rows-styles}, and
12737 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
12738 the OpenDocument-v1.2 specification}
12740 @vindex org-odt-table-styles
12741 To define a table style, create an entry for the style in the variable
12742 @code{org-odt-table-styles} and specify the following:
12745 @item the name of the table template created in step (1)
12746 @item the set of cell styles in that template that are to be activated
12749 For example, the entry below defines two different table styles
12750 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
12751 based on the same template @samp{Custom}. The styles achieve their intended
12752 effect by selectively activating the individual cell styles in that template.
12755 (setq org-odt-table-styles
12756 (append org-odt-table-styles
12757 '(("TableWithHeaderRowAndColumn" "Custom"
12758 ((use-first-row-styles . t)
12759 (use-first-column-styles . t)))
12760 ("TableWithFirstRowandLastRow" "Custom"
12761 ((use-first-row-styles . t)
12762 (use-last-row-styles . t))))))
12766 Associate a table with the table style
12768 To do this, specify the table style created in step (2) as part of
12769 the @code{ATTR_ODT} line as shown below.
12772 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
12773 | Name | Phone | Age |
12774 | Peter | 1234 | 17 |
12775 | Anna | 4321 | 25 |
12779 @node Validating OpenDocument XML
12780 @subsubheading Validating OpenDocument XML
12782 Occasionally, you will discover that the document created by the
12783 ODT exporter cannot be opened by your favorite application. One of
12784 the common reasons for this is that the @file{.odt} file is corrupt. In such
12785 cases, you may want to validate the document against the OpenDocument RELAX
12786 NG Compact Syntax (RNC) schema.
12788 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
12789 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
12790 general help with validation (and schema-sensitive editing) of XML files:
12791 @inforef{Introduction,,nxml-mode}.
12793 @vindex org-odt-schema-dir
12794 If you have ready access to OpenDocument @file{.rnc} files and the needed
12795 schema-locating rules in a single folder, you can customize the variable
12796 @code{org-odt-schema-dir} to point to that directory. The ODT exporter
12797 will take care of updating the @code{rng-schema-locating-files} for you.
12799 @c end opendocument
12801 @node iCalendar export
12802 @section iCalendar export
12803 @cindex iCalendar export
12805 @vindex org-icalendar-include-todo
12806 @vindex org-icalendar-use-deadline
12807 @vindex org-icalendar-use-scheduled
12808 @vindex org-icalendar-categories
12809 @vindex org-icalendar-alarm-time
12810 Some people use Org mode for keeping track of projects, but still prefer a
12811 standard calendar application for anniversaries and appointments. In this
12812 case it can be useful to show deadlines and other time-stamped items in Org
12813 files in the calendar application. Org mode can export calendar information
12814 in the standard iCalendar format. If you also want to have TODO entries
12815 included in the export, configure the variable
12816 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
12817 and TODO items as VTODO@. It will also create events from deadlines that are
12818 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
12819 to set the start and due dates for the TODO entry@footnote{See the variables
12820 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
12821 As categories, it will use the tags locally defined in the heading, and the
12822 file/tree category@footnote{To add inherited tags or the TODO state,
12823 configure the variable @code{org-icalendar-categories}.}. See the variable
12824 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
12827 @vindex org-icalendar-store-UID
12828 @cindex property, ID
12829 The iCalendar standard requires each entry to have a globally unique
12830 identifier (UID). Org creates these identifiers during export. If you set
12831 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
12832 @code{:ID:} property of the entry and re-used next time you report this
12833 entry. Since a single entry can give rise to multiple iCalendar entries (as
12834 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
12835 prefixes to the UID, depending on what triggered the inclusion of the entry.
12836 In this way the UID remains unique, but a synchronization program can still
12837 figure out from which entry all the different instances originate.
12840 @orgcmd{C-c C-e c f,org-icalendar-export-to-ics}
12841 Create iCalendar entries for the current buffer and store them in the same
12842 directory, using a file extension @file{.ics}.
12843 @orgcmd{C-c C-e c a, org-icalendar-export-agenda-files}
12844 @vindex org-agenda-files
12845 Like @kbd{C-c C-e c f}, but do this for all files in
12846 @code{org-agenda-files}. For each of these files, a separate iCalendar
12847 file will be written.
12848 @orgcmd{C-c C-e c c,org-icalendar-combine-agenda-files}
12849 @vindex org-icalendar-combined-agenda-file
12850 Create a single large iCalendar file from all files in
12851 @code{org-agenda-files} and write it to the file given by
12852 @code{org-icalendar-combined-agenda-file}.
12855 @vindex org-use-property-inheritance
12856 @vindex org-icalendar-include-body
12857 @cindex property, SUMMARY
12858 @cindex property, DESCRIPTION
12859 @cindex property, LOCATION
12860 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
12861 property can be inherited from higher in the hierarchy if you configure
12862 @code{org-use-property-inheritance} accordingly.} properties if the selected
12863 entries have them. If not, the summary will be derived from the headline,
12864 and the description from the body (limited to
12865 @code{org-icalendar-include-body} characters).
12867 How this calendar is best read and updated, depends on the application
12868 you are using. The FAQ covers this issue.
12870 @node Other built-in back-ends
12871 @section Other built-in back-ends
12872 @cindex export back-ends, built-in
12873 @vindex org-export-backends
12875 On top of the aforementioned back-ends, Org comes with other built-in ones:
12878 @item @file{ox-man.el}: export to a man page.
12879 @item @file{ox-texinfo.el}: export to @code{Texinfo} format.
12880 @item @file{ox-org.el}: export to an Org document.
12883 To activate these export back-ends, customize @code{org-export-backends} or
12884 load them directly with e.g., @code{(require 'ox-texinfo)}. This will add
12885 new keys in the export dispatcher (@pxref{The export dispatcher}).
12887 See the comment section of these files for more information on how to use
12890 @node Export in foreign buffers
12891 @section Export in foreign buffers
12893 Most built-in back-ends come with a command to convert the selected region
12894 into a selected format and replace this region by the exported output. Here
12895 is a list of such conversion commands:
12898 @item org-html-convert-region-to-html
12899 Convert the selected region into HTML.
12900 @item org-latex-convert-region-to-latex
12901 Convert the selected region into @LaTeX{}.
12902 @item org-texinfo-convert-region-to-texinfo
12903 Convert the selected region into @code{Texinfo}.
12904 @item org-md-convert-region-to-md
12905 Convert the selected region into @code{MarkDown}.
12908 This is particularly useful for converting tables and lists in foreign
12909 buffers. E.g., in an HTML buffer, you can turn on @code{orgstruct-mode}, then
12910 use Org commands for editing a list, and finally select and convert the list
12911 with @code{M-x org-html-convert-region-to-html RET}.
12913 @node Advanced configuration
12914 @section Advanced configuration
12918 @vindex org-export-before-processing-hook
12919 @vindex org-export-before-parsing-hook
12920 Two hooks are run during the first steps of the export process. The first
12921 one, @code{org-export-before-processing-hook} is called before expanding
12922 macros, Babel code and include keywords in the buffer. The second one,
12923 @code{org-export-before-parsing-hook}, as its name suggests, happens just
12924 before parsing the buffer. Their main use is for heavy duties, that is
12925 duties involving structural modifications of the document. For example, one
12926 may want to remove every headline in the buffer during export. The following
12927 code can achieve this:
12931 (defun my-headline-removal (backend)
12932 "Remove all headlines in the current buffer.
12933 BACKEND is the export back-end being used, as a symbol."
12935 (lambda () (delete-region (point) (progn (forward-line) (point))))))
12937 (add-hook 'org-export-before-parsing-hook 'my-headline-removal)
12941 Note that functions used in these hooks require a mandatory argument,
12942 a symbol representing the back-end used.
12944 @subheading Filters
12946 @cindex Filters, exporting
12947 Filters are lists of functions applied on a specific part of the output from
12948 a given back-end. More explicitly, each time a back-end transforms an Org
12949 object or element into another language, all functions within a given filter
12950 type are called in turn on the string produced. The string returned by the
12951 last function will be the one used in the final output.
12953 There are filter sets for each type of element or object, for plain text,
12954 for the parse tree, for the export options and for the final output. They
12955 are all named after the same scheme: @code{org-export-filter-TYPE-functions},
12956 where @code{TYPE} is the type targeted by the filter. Valid types are:
12958 @multitable @columnfractions .33 .33 .33
12965 @item comment-block
12968 @item dynamic-block
12972 @tab export-snippet
12975 @tab footnote-definition
12976 @tab footnote-reference
12978 @tab horizontal-rule
12979 @tab inline-babel-call
12980 @item inline-src-block
12985 @tab latex-environment
12986 @item latex-fragment
12989 @item node-property
12996 @tab property-drawer
12998 @item quote-section
13001 @item special-block
13003 @tab statistics-cookie
13004 @item strike-through
13018 For example, the following snippet allows me to use non-breaking spaces in
13019 the Org buffer and get them translated into @LaTeX{} without using the
13020 @code{\nbsp} macro (where @code{_} stands for the non-breaking space):
13024 (defun my-latex-filter-nobreaks (text backend info)
13025 "Ensure \" \" are properly handled in LaTeX export."
13026 (when (org-export-derived-backend-p backend 'latex)
13027 (replace-regexp-in-string " " "~" text)))
13029 (add-to-list 'org-export-filter-plain-text-functions
13030 'my-latex-filter-nobreaks)
13034 Three arguments must be provided to a filter: the code being changed, the
13035 back-end used, and some information about the export process. You can safely
13036 ignore the third argument for most purposes. Note the use of
13037 @code{org-export-derived-backend-p}, which ensures that the filter will only
13038 be applied when using @code{latex} back-end or any other back-end derived
13039 from it (e.g., @code{beamer}).
13041 @subheading Defining filters for individual files
13043 You can customize the export for just a specific file by binding export
13044 filter variables using @code{#+BIND}. Here is an example where we introduce
13045 two filters, one to remove brackets from time stamps, and one to entirely
13046 remove any strike-through text. The functions doing the filtering are
13047 defined in an src block that allows the filter function definitions to exist
13048 in the file itself and ensures that the functions will be there when needed.
13051 #+BIND: org-export-filter-timestamp-functions (tmp-f-timestamp)
13052 #+BIND: org-export-filter-strike-through-functions (tmp-f-strike-through)
13053 #+begin_src emacs-lisp :exports results :results none
13054 (defun tmp-f-timestamp (s backend info)
13055 (replace-regexp-in-string "&[lg]t;\\|[][]" "" s))
13056 (defun tmp-f-strike-through (s backend info) "")
13060 @subheading Extending an existing back-end
13062 This is obviously the most powerful customization, since the changes happen
13063 at the parser level. Indeed, some export back-ends are built as extensions
13064 of other ones (e.g. Markdown back-end an extension of HTML back-end).
13066 Extending a back-end means that if an element type is not transcoded by the
13067 new back-end, it will be handled by the original one. Hence you can extend
13068 specific parts of a back-end without too much work.
13070 As an example, imagine we want the @code{ascii} back-end to display the
13071 language used in a source block, when it is available, but only when some
13072 attribute is non-@code{nil}, like the following:
13075 #+ATTR_ASCII: :language t
13078 Because that back-end is lacking in that area, we are going to create a new
13079 back-end, @code{my-ascii} that will do the job.
13083 (defun my-ascii-src-block (src-block contents info)
13084 "Transcode a SRC-BLOCK element from Org to ASCII.
13085 CONTENTS is nil. INFO is a plist used as a communication
13087 (if (not (org-export-read-attribute :attr_ascii src-block :language))
13088 (org-export-with-backend 'ascii src-block contents info)
13090 (format ",--[ %s ]--\n%s`----"
13091 (org-element-property :language src-block)
13092 (replace-regexp-in-string
13094 (org-element-normalize-string
13095 (org-export-format-code-default src-block info)))))))
13097 (org-export-define-derived-backend 'my-ascii 'ascii
13098 :translate-alist '((src-block . my-ascii-src-block)))
13102 The @code{my-ascii-src-block} function looks at the attribute above the
13103 element. If it isn’t true, it gives hand to the @code{ascii} back-end.
13104 Otherwise, it creates a box around the code, leaving room for the language.
13105 A new back-end is then created. It only changes its behaviour when
13106 translating @code{src-block} type element. Now, all it takes to use the new
13107 back-end is calling the following from an Org buffer:
13110 (org-export-to-buffer 'my-ascii "*Org MY-ASCII Export*")
13113 It is obviously possible to write an interactive function for this, install
13114 it in the export dispatcher menu, and so on.
13118 @chapter Publishing
13121 Org includes a publishing management system that allows you to configure
13122 automatic HTML conversion of @emph{projects} composed of interlinked org
13123 files. You can also configure Org to automatically upload your exported HTML
13124 pages and related attachments, such as images and source code files, to a web
13127 You can also use Org to convert files into PDF, or even combine HTML and PDF
13128 conversion so that files are available in both formats on the server.
13130 Publishing has been contributed to Org by David O'Toole.
13133 * Configuration:: Defining projects
13134 * Uploading files:: How to get files up on the server
13135 * Sample configuration:: Example projects
13136 * Triggering publication:: Publication commands
13139 @node Configuration
13140 @section Configuration
13142 Publishing needs significant configuration to specify files, destination
13143 and many other properties of a project.
13146 * Project alist:: The central configuration variable
13147 * Sources and destinations:: From here to there
13148 * Selecting files:: What files are part of the project?
13149 * Publishing action:: Setting the function doing the publishing
13150 * Publishing options:: Tweaking HTML/@LaTeX{} export
13151 * Publishing links:: Which links keep working after publishing?
13152 * Sitemap:: Generating a list of all pages
13153 * Generating an index:: An index that reaches across pages
13156 @node Project alist
13157 @subsection The variable @code{org-publish-project-alist}
13158 @cindex org-publish-project-alist
13159 @cindex projects, for publishing
13161 @vindex org-publish-project-alist
13162 Publishing is configured almost entirely through setting the value of one
13163 variable, called @code{org-publish-project-alist}. Each element of the list
13164 configures one project, and may be in one of the two following forms:
13167 ("project-name" :property value :property value ...)
13168 @r{i.e., a well-formed property list with alternating keys and values}
13170 ("project-name" :components ("project-name" "project-name" ...))
13174 In both cases, projects are configured by specifying property values. A
13175 project defines the set of files that will be published, as well as the
13176 publishing configuration to use when publishing those files. When a project
13177 takes the second form listed above, the individual members of the
13178 @code{:components} property are taken to be sub-projects, which group
13179 together files requiring different publishing options. When you publish such
13180 a ``meta-project'', all the components will also be published, in the
13183 @node Sources and destinations
13184 @subsection Sources and destinations for files
13185 @cindex directories, for publishing
13187 Most properties are optional, but some should always be set. In
13188 particular, Org needs to know where to look for source files,
13189 and where to put published files.
13191 @multitable @columnfractions 0.3 0.7
13192 @item @code{:base-directory}
13193 @tab Directory containing publishing source files
13194 @item @code{:publishing-directory}
13195 @tab Directory where output files will be published. You can directly
13196 publish to a web server using a file name syntax appropriate for
13197 the Emacs @file{tramp} package. Or you can publish to a local directory and
13198 use external tools to upload your website (@pxref{Uploading files}).
13199 @item @code{:preparation-function}
13200 @tab Function or list of functions to be called before starting the
13201 publishing process, for example, to run @code{make} for updating files to be
13202 published. The project property list is scoped into this call as the
13203 variable @code{project-plist}.
13204 @item @code{:completion-function}
13205 @tab Function or list of functions called after finishing the publishing
13206 process, for example, to change permissions of the resulting files. The
13207 project property list is scoped into this call as the variable
13208 @code{project-plist}.
13212 @node Selecting files
13213 @subsection Selecting files
13214 @cindex files, selecting for publishing
13216 By default, all files with extension @file{.org} in the base directory
13217 are considered part of the project. This can be modified by setting the
13219 @multitable @columnfractions 0.25 0.75
13220 @item @code{:base-extension}
13221 @tab Extension (without the dot!) of source files. This actually is a
13222 regular expression. Set this to the symbol @code{any} if you want to get all
13223 files in @code{:base-directory}, even without extension.
13225 @item @code{:exclude}
13226 @tab Regular expression to match file names that should not be
13227 published, even though they have been selected on the basis of their
13230 @item @code{:include}
13231 @tab List of files to be included regardless of @code{:base-extension}
13232 and @code{:exclude}.
13234 @item @code{:recursive}
13235 @tab non-@code{nil} means, check base-directory recursively for files to publish.
13238 @node Publishing action
13239 @subsection Publishing action
13240 @cindex action, for publishing
13242 Publishing means that a file is copied to the destination directory and
13243 possibly transformed in the process. The default transformation is to export
13244 Org files as HTML files, and this is done by the function
13245 @code{org-html-publish-to-html}, which calls the HTML exporter (@pxref{HTML
13246 export}). But you also can publish your content as PDF files using
13247 @code{org-latex-publish-to-pdf} or as @code{ascii}, @code{Texinfo}, etc.,
13248 using the corresponding functions.
13250 If you want to publish the Org file as an @code{.org} file but with the
13251 @i{archived}, @i{commented} and @i{tag-excluded} trees removed, use the
13252 function @code{org-org-publish-to-org}. This will produce @file{file.org}
13253 and put it in the publishing directory. If you want a htmlized version of
13254 this file, set the parameter @code{:htmlized-source} to @code{t}, it will
13255 produce @file{file.org.html} in the publishing directory@footnote{If the
13256 publishing directory is the same than the source directory, @file{file.org}
13257 will be exported as @file{file.org.org}, so probably don't want to do this.}.
13259 Other files like images only need to be copied to the publishing destination.
13260 For this you can use @code{org-publish-attachment}. For non-org files, you
13261 always need to specify the publishing function:
13263 @multitable @columnfractions 0.3 0.7
13264 @item @code{:publishing-function}
13265 @tab Function executing the publication of a file. This may also be a
13266 list of functions, which will all be called in turn.
13267 @item @code{:htmlized-source}
13268 @tab non-@code{nil} means, publish htmlized source.
13271 The function must accept three arguments: a property list containing at least
13272 a @code{:publishing-directory} property, the name of the file to be published
13273 and the path to the publishing directory of the output file. It should take
13274 the specified file, make the necessary transformation (if any) and place the
13275 result into the destination folder.
13277 @node Publishing options
13278 @subsection Options for the exporters
13279 @cindex options, for publishing
13281 The property list can be used to set many export options for the exporters.
13282 In most cases, these properties correspond to user variables in Org. The
13283 first table below lists these properties along with the variable they belong
13284 to. The second table list HTML specific properties. See the documentation
13285 string of these options for details.
13287 @vindex org-display-custom-times
13288 @vindex org-export-default-language
13289 @vindex org-export-exclude-tags
13290 @vindex org-export-headline-levels
13291 @vindex org-export-preserve-breaks
13292 @vindex org-export-publishing-directory
13293 @vindex org-export-select-tags
13294 @vindex org-export-with-archived-trees
13295 @vindex org-export-with-author
13296 @vindex org-export-with-creator
13297 @vindex org-export-with-drawers
13298 @vindex org-export-with-email
13299 @vindex org-export-with-emphasize
13300 @vindex org-export-with-fixed-width
13301 @vindex org-export-with-footnotes
13302 @vindex org-export-with-latex
13303 @vindex org-export-with-planning
13304 @vindex org-export-with-priority
13305 @vindex org-export-with-properties
13306 @vindex org-export-with-section-numbers
13307 @vindex org-export-with-special-strings
13308 @vindex org-export-with-sub-superscripts
13309 @vindex org-export-with-tables
13310 @vindex org-export-with-tags
13311 @vindex org-export-with-tasks
13312 @vindex org-export-with-timestamps
13313 @vindex org-export-with-toc
13314 @vindex org-export-with-todo-keywords
13315 @vindex user-mail-address
13316 @multitable @columnfractions 0.32 0.68
13317 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
13318 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
13319 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
13320 @item @code{:language} @tab @code{org-export-default-language}
13321 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
13322 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
13323 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
13324 @item @code{:select-tags} @tab @code{org-export-select-tags}
13325 @item @code{:with-author} @tab @code{org-export-with-author}
13326 @item @code{:with-creator} @tab @code{org-export-with-creator}
13327 @item @code{:with-drawers} @tab @code{org-export-with-drawers}
13328 @item @code{:with-email} @tab @code{org-export-with-email}
13329 @item @code{:with-emphasize} @tab @code{org-export-with-emphasize}
13330 @item @code{:with-fixed-width} @tab @code{org-export-with-fixed-width}
13331 @item @code{:with-footnotes} @tab @code{org-export-with-footnotes}
13332 @item @code{:with-latex} @tab @code{org-export-with-latex}
13333 @item @code{:with-planning} @tab @code{org-export-with-planning}
13334 @item @code{:with-priority} @tab @code{org-export-with-priority}
13335 @item @code{:with-properties} @tab @code{org-export-with-properties}
13336 @item @code{:with-special-strings} @tab @code{org-export-with-special-strings}
13337 @item @code{:with-sub-superscript} @tab @code{org-export-with-sub-superscripts}
13338 @item @code{:with-tables} @tab @code{org-export-with-tables}
13339 @item @code{:with-tags} @tab @code{org-export-with-tags}
13340 @item @code{:with-tasks} @tab @code{org-export-with-tasks}
13341 @item @code{:with-timestamps} @tab @code{org-export-with-timestamps}
13342 @item @code{:with-toc} @tab @code{org-export-with-toc}
13343 @item @code{:with-todo-keywords} @tab @code{org-export-with-todo-keywords}
13346 @vindex org-html-doctype
13347 @vindex org-html-container-element
13348 @vindex org-html-html5-fancy
13349 @vindex org-html-xml-declaration
13350 @vindex org-html-link-up
13351 @vindex org-html-link-home
13352 @vindex org-html-link-org-files-as-html
13353 @vindex org-html-link-use-abs-url
13354 @vindex org-html-head
13355 @vindex org-html-head-extra
13356 @vindex org-html-inline-images
13357 @vindex org-html-extension
13358 @vindex org-html-preamble
13359 @vindex org-html-postamble
13360 @vindex org-html-table-default-attributes
13361 @vindex org-html-table-row-tags
13362 @vindex org-html-head-include-default-style
13363 @vindex org-html-head-include-scripts
13364 @multitable @columnfractions 0.32 0.68
13365 @item @code{:html-doctype} @tab @code{org-html-doctype}
13366 @item @code{:html-container} @tab @code{org-html-container-element}
13367 @item @code{:html-html5-fancy} @tab @code{org-html-html5-fancy}
13368 @item @code{:html-xml-declaration} @tab @code{org-html-xml-declaration}
13369 @item @code{:html-link-up} @tab @code{org-html-link-up}
13370 @item @code{:html-link-home} @tab @code{org-html-link-home}
13371 @item @code{:html-link-org-as-html} @tab @code{org-html-link-org-files-as-html}
13372 @item @code{:html-link-use-abs-url} @tab @code{org-html-link-use-abs-url}
13373 @item @code{:html-head} @tab @code{org-html-head}
13374 @item @code{:html-head-extra} @tab @code{org-html-head-extra}
13375 @item @code{:html-inline-images} @tab @code{org-html-inline-images}
13376 @item @code{:html-extension} @tab @code{org-html-extension}
13377 @item @code{:html-preamble} @tab @code{org-html-preamble}
13378 @item @code{:html-postamble} @tab @code{org-html-postamble}
13379 @item @code{:html-table-attributes} @tab @code{org-html-table-default-attributes}
13380 @item @code{:html-table-row-tags} @tab @code{org-html-table-row-tags}
13381 @item @code{:html-head-include-default-style} @tab @code{org-html-head-include-default-style}
13382 @item @code{:html-head-include-scripts} @tab @code{org-html-head-include-scripts}
13385 Most of the @code{org-export-with-*} variables have the same effect in each
13388 @vindex org-publish-project-alist
13389 When a property is given a value in @code{org-publish-project-alist}, its
13390 setting overrides the value of the corresponding user variable (if any)
13391 during publishing. Options set within a file (@pxref{Export settings}),
13392 however, override everything.
13394 @node Publishing links
13395 @subsection Links between published files
13396 @cindex links, publishing
13398 To create a link from one Org file to another, you would use something like
13399 @samp{[[file:foo.org][The foo]]} or simply @samp{file:foo.org.}
13400 (@pxref{Hyperlinks}). When published, this link becomes a link to
13401 @file{foo.html}. You can thus interlink the pages of your "org web" project
13402 and the links will work as expected when you publish them to HTML@. If you
13403 also publish the Org source file and want to link to it, use an @code{http:}
13404 link instead of a @code{file:} link, because @code{file:} links are converted
13405 to link to the corresponding @file{html} file.
13407 You may also link to related files, such as images. Provided you are careful
13408 with relative file names, and provided you have also configured Org to upload
13409 the related files, these links will work too. See @ref{Complex example}, for
13410 an example of this usage.
13413 @subsection Generating a sitemap
13414 @cindex sitemap, of published pages
13416 The following properties may be used to control publishing of
13417 a map of files for a given project.
13419 @multitable @columnfractions 0.35 0.65
13420 @item @code{:auto-sitemap}
13421 @tab When non-@code{nil}, publish a sitemap during @code{org-publish-current-project}
13422 or @code{org-publish-all}.
13424 @item @code{:sitemap-filename}
13425 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
13426 becomes @file{sitemap.html}).
13428 @item @code{:sitemap-title}
13429 @tab Title of sitemap page. Defaults to name of file.
13431 @item @code{:sitemap-function}
13432 @tab Plug-in function to use for generation of the sitemap.
13433 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
13434 of links to all files in the project.
13436 @item @code{:sitemap-sort-folders}
13437 @tab Where folders should appear in the sitemap. Set this to @code{first}
13438 (default) or @code{last} to display folders first or last,
13439 respectively. Any other value will mix files and folders.
13441 @item @code{:sitemap-sort-files}
13442 @tab How the files are sorted in the site map. Set this to
13443 @code{alphabetically} (default), @code{chronologically} or
13444 @code{anti-chronologically}. @code{chronologically} sorts the files with
13445 older date first while @code{anti-chronologically} sorts the files with newer
13446 date first. @code{alphabetically} sorts the files alphabetically. The date of
13447 a file is retrieved with @code{org-publish-find-date}.
13449 @item @code{:sitemap-ignore-case}
13450 @tab Should sorting be case-sensitive? Default @code{nil}.
13452 @item @code{:sitemap-file-entry-format}
13453 @tab With this option one can tell how a sitemap's entry is formatted in the
13454 sitemap. This is a format string with some escape sequences: @code{%t} stands
13455 for the title of the file, @code{%a} stands for the author of the file and
13456 @code{%d} stands for the date of the file. The date is retrieved with the
13457 @code{org-publish-find-date} function and formatted with
13458 @code{org-publish-sitemap-date-format}. Default @code{%t}.
13460 @item @code{:sitemap-date-format}
13461 @tab Format string for the @code{format-time-string} function that tells how
13462 a sitemap entry's date is to be formatted. This property bypasses
13463 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
13465 @item @code{:sitemap-sans-extension}
13466 @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap.
13467 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
13468 Defaults to @code{nil}.
13472 @node Generating an index
13473 @subsection Generating an index
13474 @cindex index, in a publishing project
13476 Org mode can generate an index across the files of a publishing project.
13478 @multitable @columnfractions 0.25 0.75
13479 @item @code{:makeindex}
13480 @tab When non-@code{nil}, generate in index in the file @file{theindex.org} and
13481 publish it as @file{theindex.html}.
13484 The file will be created when first publishing a project with the
13485 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
13486 "theindex.inc"}. You can then build around this include statement by adding
13487 a title, style information, etc.
13489 @node Uploading files
13490 @section Uploading files
13494 For those people already utilizing third party sync tools such as
13495 @command{rsync} or @command{unison}, it might be preferable not to use the built in
13496 @i{remote} publishing facilities of Org mode which rely heavily on
13497 Tramp. Tramp, while very useful and powerful, tends not to be
13498 so efficient for multiple file transfer and has been known to cause problems
13501 Specialized synchronization utilities offer several advantages. In addition
13502 to timestamp comparison, they also do content and permissions/attribute
13503 checks. For this reason you might prefer to publish your web to a local
13504 directory (possibly even @i{in place} with your Org files) and then use
13505 @file{unison} or @file{rsync} to do the synchronization with the remote host.
13507 Since Unison (for example) can be configured as to which files to transfer to
13508 a certain remote destination, it can greatly simplify the project publishing
13509 definition. Simply keep all files in the correct location, process your Org
13510 files with @code{org-publish} and let the synchronization tool do the rest.
13511 You do not need, in this scenario, to include attachments such as @file{jpg},
13512 @file{css} or @file{gif} files in the project definition since the 3rd party
13515 Publishing to a local directory is also much faster than to a remote one, so
13516 that you can afford more easily to republish entire projects. If you set
13517 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
13518 benefit of re-including any changed external files such as source example
13519 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
13520 Org is not smart enough to detect if included files have been modified.
13522 @node Sample configuration
13523 @section Sample configuration
13525 Below we provide two example configurations. The first one is a simple
13526 project publishing only a set of Org files. The second example is
13527 more complex, with a multi-component project.
13530 * Simple example:: One-component publishing
13531 * Complex example:: A multi-component publishing example
13534 @node Simple example
13535 @subsection Example: simple publishing configuration
13537 This example publishes a set of Org files to the @file{public_html}
13538 directory on the local machine.
13541 (setq org-publish-project-alist
13543 :base-directory "~/org/"
13544 :publishing-directory "~/public_html"
13545 :section-numbers nil
13547 :html-head "<link rel=\"stylesheet\"
13548 href=\"../other/mystyle.css\"
13549 type=\"text/css\"/>")))
13552 @node Complex example
13553 @subsection Example: complex publishing configuration
13555 This more complicated example publishes an entire website, including
13556 Org files converted to HTML, image files, Emacs Lisp source code, and
13557 style sheets. The publishing directory is remote and private files are
13560 To ensure that links are preserved, care should be taken to replicate
13561 your directory structure on the web server, and to use relative file
13562 paths. For example, if your Org files are kept in @file{~/org} and your
13563 publishable images in @file{~/images}, you would link to an image with
13566 file:../images/myimage.png
13569 On the web server, the relative path to the image should be the
13570 same. You can accomplish this by setting up an "images" folder in the
13571 right place on the web server, and publishing images to it.
13574 (setq org-publish-project-alist
13576 :base-directory "~/org/"
13577 :base-extension "org"
13578 :publishing-directory "/ssh:user@@host:~/html/notebook/"
13579 :publishing-function org-html-publish-to-html
13580 :exclude "PrivatePage.org" ;; regexp
13582 :section-numbers nil
13584 :html-head "<link rel=\"stylesheet\"
13585 href=\"../other/mystyle.css\" type=\"text/css\"/>"
13589 :base-directory "~/images/"
13590 :base-extension "jpg\\|gif\\|png"
13591 :publishing-directory "/ssh:user@@host:~/html/images/"
13592 :publishing-function org-publish-attachment)
13595 :base-directory "~/other/"
13596 :base-extension "css\\|el"
13597 :publishing-directory "/ssh:user@@host:~/html/other/"
13598 :publishing-function org-publish-attachment)
13599 ("website" :components ("orgfiles" "images" "other"))))
13602 @node Triggering publication
13603 @section Triggering publication
13605 Once properly configured, Org can publish with the following commands:
13608 @orgcmd{C-c C-e P x,org-publish}
13609 Prompt for a specific project and publish all files that belong to it.
13610 @orgcmd{C-c C-e P p,org-publish-current-project}
13611 Publish the project containing the current file.
13612 @orgcmd{C-c C-e P f,org-publish-current-file}
13613 Publish only the current file.
13614 @orgcmd{C-c C-e P a,org-publish-all}
13615 Publish every project.
13618 @vindex org-publish-use-timestamps-flag
13619 Org uses timestamps to track when a file has changed. The above functions
13620 normally only publish changed files. You can override this and force
13621 publishing of all files by giving a prefix argument to any of the commands
13622 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
13623 This may be necessary in particular if files include other files via
13624 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
13627 @node Working with source code
13628 @chapter Working with source code
13629 @cindex Schulte, Eric
13630 @cindex Davison, Dan
13631 @cindex source code, working with
13633 Source code can be included in Org mode documents using a @samp{src} block,
13637 #+BEGIN_SRC emacs-lisp
13638 (defun org-xor (a b)
13644 Org mode provides a number of features for working with live source code,
13645 including editing of code blocks in their native major-mode, evaluation of
13646 code blocks, converting code blocks into source files (known as @dfn{tangling}
13647 in literate programming), and exporting code blocks and their
13648 results in several formats. This functionality was contributed by Eric
13649 Schulte and Dan Davison, and was originally named Org-babel.
13651 The following sections describe Org mode's code block handling facilities.
13654 * Structure of code blocks:: Code block syntax described
13655 * Editing source code:: Language major-mode editing
13656 * Exporting code blocks:: Export contents and/or results
13657 * Extracting source code:: Create pure source code files
13658 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
13659 * Library of Babel:: Use and contribute to a library of useful code blocks
13660 * Languages:: List of supported code block languages
13661 * Header arguments:: Configure code block functionality
13662 * Results of evaluation:: How evaluation results are handled
13663 * Noweb reference syntax:: Literate programming in Org mode
13664 * Key bindings and useful functions:: Work quickly with code blocks
13665 * Batch execution:: Call functions from the command line
13669 @node Structure of code blocks
13670 @section Structure of code blocks
13671 @cindex code block, structure
13672 @cindex source code, block structure
13674 @cindex #+BEGIN_SRC
13676 Live code blocks can be specified with a @samp{src} block or
13677 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
13678 @ref{Easy templates} system} The structure of a @samp{src} block is
13682 #+BEGIN_SRC <language> <switches> <header arguments>
13687 The @code{#+NAME:} line is optional, and can be used to name the code
13688 block. Live code blocks require that a language be specified on the
13689 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
13690 @cindex source code, inline
13692 Live code blocks can also be specified inline using
13695 src_<language>@{<body>@}
13701 src_<language>[<header arguments>]@{<body>@}
13705 @item <#+NAME: name>
13706 This line associates a name with the code block. This is similar to the
13707 @code{#+NAME: Name} lines that can be used to name tables in Org mode
13708 files. Referencing the name of a code block makes it possible to evaluate
13709 the block from other places in the file, from other files, or from Org mode
13710 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
13711 and the behavior of Org mode when two or more blocks share the same name is
13715 The language of the code in the block (see @ref{Languages}).
13716 @cindex source code, language
13718 Optional switches control code block export (see the discussion of switches in
13719 @ref{Literal examples})
13720 @cindex source code, switches
13721 @item <header arguments>
13722 Optional header arguments control many aspects of evaluation, export and
13723 tangling of code blocks (see @ref{Header arguments}).
13724 Header arguments can also be set on a per-buffer or per-subtree
13725 basis using properties.
13726 @item source code, header arguments
13728 Source code in the specified language.
13732 @node Editing source code
13733 @section Editing source code
13734 @cindex code block, editing
13735 @cindex source code, editing
13737 @vindex org-edit-src-auto-save-idle-delay
13738 @vindex org-edit-src-turn-on-auto-save
13740 Use @kbd{C-c '} to edit the current code block. This brings up a language
13741 major-mode edit buffer containing the body of the code block. Manually
13742 saving this buffer with @key{C-x C-s} will write the contents back to the Org
13743 buffer. You can also set @code{org-edit-src-auto-save-idle-delay} to save the
13744 base buffer after some idle delay, or @code{org-edit-src-turn-on-auto-save}
13745 to auto-save this buffer into a separate file using @code{auto-save-mode}.
13746 Use @kbd{C-c '} again to exit.
13748 The @code{org-src-mode} minor mode will be active in the edit buffer. The
13749 following variables can be used to configure the behavior of the edit
13750 buffer. See also the customization group @code{org-edit-structure} for
13751 further configuration options.
13754 @item org-src-lang-modes
13755 If an Emacs major-mode named @code{<lang>-mode} exists, where
13756 @code{<lang>} is the language named in the header line of the code block,
13757 then the edit buffer will be placed in that major-mode. This variable
13758 can be used to map arbitrary language names to existing major modes.
13759 @item org-src-window-setup
13760 Controls the way Emacs windows are rearranged when the edit buffer is created.
13761 @item org-src-preserve-indentation
13762 This variable is especially useful for tangling languages such as
13763 Python, in which whitespace indentation in the output is critical.
13764 @item org-src-ask-before-returning-to-edit-buffer
13765 By default, Org will ask before returning to an open edit buffer. Set this
13766 variable to @code{nil} to switch without asking.
13769 To turn on native code fontification in the @emph{Org} buffer, configure the
13770 variable @code{org-src-fontify-natively}.
13773 @node Exporting code blocks
13774 @section Exporting code blocks
13775 @cindex code block, exporting
13776 @cindex source code, exporting
13778 It is possible to export the @emph{code} of code blocks, the @emph{results}
13779 of code block evaluation, @emph{both} the code and the results of code block
13780 evaluation, or @emph{none}. For most languages, the default exports code.
13781 However, for some languages (e.g., @code{ditaa}) the default exports the
13782 results of code block evaluation. For information on exporting code block
13783 bodies, see @ref{Literal examples}.
13785 The @code{:exports} header argument can be used to specify export
13788 @subsubheading Header arguments:
13791 @cindex @code{:exports}, src header argument
13792 @item :exports code
13793 The default in most languages. The body of the code block is exported, as
13794 described in @ref{Literal examples}.
13795 @item :exports results
13796 The code block will be evaluated each time to buffer is exported, and the
13797 results will be placed in the Org mode buffer for export, either updating
13798 previous results of the code block located anywhere in the buffer or, if no
13799 previous results exist, placing the results immediately after the code block.
13800 The body of the code block will not be exported.
13801 @item :exports both
13802 Both the code block and its results will be exported.
13803 @item :exports none
13804 Neither the code block nor its results will be exported.
13807 It is possible to inhibit the evaluation of code blocks during export.
13808 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
13809 ensure that no code blocks are evaluated as part of the export process. This
13810 can be useful in situations where potentially untrusted Org mode files are
13811 exported in an automated fashion, for example when Org mode is used as the
13812 markup language for a wiki. It is also possible to set this variable to
13813 @code{‘inline-only}. In that case, only inline code blocks will be
13814 evaluated, in order to insert their results. Non-inline code blocks are
13815 assumed to have their results already inserted in the buffer by manual
13816 evaluation. This setting is useful to avoid expensive recalculations during
13817 export, not to provide security.
13820 @node Extracting source code
13821 @section Extracting source code
13823 @cindex source code, extracting
13824 @cindex code block, extracting source code
13826 Creating pure source code files by extracting code from source blocks is
13827 referred to as ``tangling''---a term adopted from the literate programming
13828 community. During ``tangling'' of code blocks their bodies are expanded
13829 using @code{org-babel-expand-src-block} which can expand both variable and
13830 ``noweb'' style references (see @ref{Noweb reference syntax}).
13832 @subsubheading Header arguments
13835 @cindex @code{:tangle}, src header argument
13837 The default. The code block is not included in the tangled output.
13839 Include the code block in the tangled output. The output file name is the
13840 name of the org file with the extension @samp{.org} replaced by the extension
13841 for the block language.
13842 @item :tangle filename
13843 Include the code block in the tangled output to file @samp{filename}.
13847 @subsubheading Functions
13850 @item org-babel-tangle
13851 Tangle the current file. Bound to @kbd{C-c C-v t}.
13853 With prefix argument only tangle the current code block.
13854 @item org-babel-tangle-file
13855 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
13858 @subsubheading Hooks
13861 @item org-babel-post-tangle-hook
13862 This hook is run from within code files tangled by @code{org-babel-tangle}.
13863 Example applications could include post-processing, compilation or evaluation
13864 of tangled code files.
13867 @subsubheading Jumping between code and Org
13869 When tangling code from an Org-mode buffer to a source code file, you'll
13870 frequently find yourself viewing the file of tangled source code (e.g., many
13871 debuggers point to lines of the source code file). It is useful to be able
13872 to navigate from the tangled source to the Org-mode buffer from which the
13875 The @code{org-babel-tangle-jump-to-org} function provides this jumping from
13876 code to Org-mode functionality. Two header arguments are required for
13877 jumping to work, first the @code{padline} (@ref{padline}) option must be set
13878 to true (the default setting), second the @code{comments} (@ref{comments})
13879 header argument must be set to @code{links}, which will insert comments into
13880 the source code buffer which point back to the original Org-mode file.
13882 @node Evaluating code blocks
13883 @section Evaluating code blocks
13884 @cindex code block, evaluating
13885 @cindex source code, evaluating
13888 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
13889 potential for that code to do harm. Org mode provides safeguards to ensure
13890 that code is only evaluated after explicit confirmation from the user. For
13891 information on these safeguards (and on how to disable them) see @ref{Code
13892 evaluation security}.} and the results of evaluation optionally placed in the
13893 Org mode buffer. The results of evaluation are placed following a line that
13894 begins by default with @code{#+RESULTS} and optionally a cache identifier
13895 and/or the name of the evaluated code block. The default value of
13896 @code{#+RESULTS} can be changed with the customizable variable
13897 @code{org-babel-results-keyword}.
13899 By default, the evaluation facility is only enabled for Lisp code blocks
13900 specified as @code{emacs-lisp}. However, source code blocks in many languages
13901 can be evaluated within Org mode (see @ref{Languages} for a list of supported
13902 languages and @ref{Structure of code blocks} for information on the syntax
13903 used to define a code block).
13906 There are a number of ways to evaluate code blocks. The simplest is to press
13907 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
13908 option @code{org-babel-no-eval-on-ctrl-c-ctrl-c} can be used to remove code
13909 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
13910 @code{org-babel-execute-src-block} function to evaluate the block and insert
13911 its results into the Org mode buffer.
13914 It is also possible to evaluate named code blocks from anywhere in an Org
13915 mode buffer or an Org mode table. Live code blocks located in the current
13916 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
13917 can be executed. Named code blocks can be executed with a separate
13918 @code{#+CALL:} line or inline within a block of text.
13920 The syntax of the @code{#+CALL:} line is
13923 #+CALL: <name>(<arguments>)
13924 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
13927 The syntax for inline evaluation of named code blocks is
13930 ... call_<name>(<arguments>) ...
13931 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
13936 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
13938 Arguments specified in this section will be passed to the code block. These
13939 arguments use standard function call syntax, rather than
13940 header argument syntax. For example, a @code{#+CALL:} line that passes the
13941 number four to a code block named @code{double}, which declares the header
13942 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
13943 @item <inside header arguments>
13944 Inside header arguments are passed through and applied to the named code
13945 block. These arguments use header argument syntax rather than standard
13946 function call syntax. Inside header arguments affect how the code block is
13947 evaluated. For example, @code{[:results output]} will collect the results of
13948 everything printed to @code{STDOUT} during execution of the code block.
13949 @item <end header arguments>
13950 End header arguments are applied to the calling instance and do not affect
13951 evaluation of the named code block. They affect how the results are
13952 incorporated into the Org mode buffer and how the call line is exported. For
13953 example, @code{:results html} will insert the results of the call line
13954 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
13956 For more examples of passing header arguments to @code{#+CALL:} lines see
13957 @ref{Header arguments in function calls}.
13960 @node Library of Babel
13961 @section Library of Babel
13962 @cindex babel, library of
13963 @cindex source code, library
13964 @cindex code block, library
13966 The ``Library of Babel'' consists of code blocks that can be called from any
13967 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
13968 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
13969 code blocks} for information on the syntax of remote code block evaluation).
13972 The central repository of code blocks in the ``Library of Babel'' is housed
13973 in an Org mode file located in the @samp{contrib} directory of Org mode.
13975 Users can add code blocks they believe to be generally useful to their
13976 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
13977 then loaded into the library with @code{org-babel-lob-ingest}.
13981 Code blocks located in any Org mode file can be loaded into the ``Library of
13982 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
13987 @cindex babel, languages
13988 @cindex source code, languages
13989 @cindex code block, languages
13991 Code blocks in the following languages are supported.
13993 @multitable @columnfractions 0.28 0.3 0.22 0.2
13994 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
13995 @item Asymptote @tab asymptote @tab Awk @tab awk
13996 @item Emacs Calc @tab calc @tab C @tab C
13997 @item C++ @tab C++ @tab Clojure @tab clojure
13998 @item CSS @tab css @tab ditaa @tab ditaa
13999 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
14000 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
14001 @item Java @tab java @tab @tab
14002 @item Javascript @tab js @tab LaTeX @tab latex
14003 @item Ledger @tab ledger @tab Lisp @tab lisp
14004 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
14005 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
14006 @item Octave @tab octave @tab Org mode @tab org
14007 @item Oz @tab oz @tab Perl @tab perl
14008 @item Plantuml @tab plantuml @tab Python @tab python
14009 @item R @tab R @tab Ruby @tab ruby
14010 @item Sass @tab sass @tab Scheme @tab scheme
14011 @item GNU Screen @tab screen @tab shell @tab sh
14012 @item SQL @tab sql @tab SQLite @tab sqlite
14015 Language-specific documentation is available for some languages. If
14016 available, it can be found at
14017 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
14019 The option @code{org-babel-load-languages} controls which languages are
14020 enabled for evaluation (by default only @code{emacs-lisp} is enabled). This
14021 variable can be set using the customization interface or by adding code like
14022 the following to your emacs configuration.
14025 The following disables @code{emacs-lisp} evaluation and enables evaluation of
14026 @code{R} code blocks.
14030 (org-babel-do-load-languages
14031 'org-babel-load-languages
14032 '((emacs-lisp . nil)
14036 It is also possible to enable support for a language by loading the related
14037 elisp file with @code{require}.
14040 The following adds support for evaluating @code{clojure} code blocks.
14044 (require 'ob-clojure)
14047 @node Header arguments
14048 @section Header arguments
14049 @cindex code block, header arguments
14050 @cindex source code, block header arguments
14052 Code block functionality can be configured with header arguments. This
14053 section provides an overview of the use of header arguments, and then
14054 describes each header argument in detail.
14057 * Using header arguments:: Different ways to set header arguments
14058 * Specific header arguments:: List of header arguments
14061 @node Using header arguments
14062 @subsection Using header arguments
14064 The values of header arguments can be set in several way. When the header
14065 arguments in each layer have been determined, they are combined in order from
14066 the first, least specific (having the lowest priority) up to the last, most
14067 specific (having the highest priority). A header argument with a higher
14068 priority replaces the same header argument specified at lower priority.
14070 * System-wide header arguments:: Set global default values
14071 * Language-specific header arguments:: Set default values by language
14072 * Header arguments in Org mode properties:: Set default values for a buffer or heading
14073 * Language-specific header arguments in Org mode properties:: Set language-specific default values for a buffer or heading
14074 * Code block specific header arguments:: The most common way to set values
14075 * Header arguments in function calls:: The most specific level
14079 @node System-wide header arguments
14080 @subsubheading System-wide header arguments
14081 @vindex org-babel-default-header-args
14082 System-wide values of header arguments can be specified by adapting the
14083 @code{org-babel-default-header-args} variable:
14085 @cindex @code{:session}, src header argument
14086 @cindex @code{:results}, src header argument
14087 @cindex @code{:exports}, src header argument
14088 @cindex @code{:cache}, src header argument
14089 @cindex @code{:noweb}, src header argument
14092 :results => "replace"
14098 For example, the following example could be used to set the default value of
14099 @code{:noweb} header arguments to @code{yes}. This would have the effect of
14100 expanding @code{:noweb} references by default when evaluating source code
14104 (setq org-babel-default-header-args
14105 (cons '(:noweb . "yes")
14106 (assq-delete-all :noweb org-babel-default-header-args)))
14109 @node Language-specific header arguments
14110 @subsubheading Language-specific header arguments
14111 Each language can define its own set of default header arguments in variable
14112 @code{org-babel-default-header-args:<lang>}, where @code{<lang>} is the name
14113 of the language. See the language-specific documentation available online at
14114 @uref{http://orgmode.org/worg/org-contrib/babel}.
14116 @node Header arguments in Org mode properties
14117 @subsubheading Header arguments in Org mode properties
14119 Buffer-wide header arguments may be specified as properties through the use
14120 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
14121 @ref{Property syntax}).
14123 For example the following would set @code{session} to @code{*R*} (only for R
14124 code blocks), and @code{results} to @code{silent} for every code block in the
14125 buffer, ensuring that all execution took place in the same session, and no
14126 results would be inserted into the buffer.
14129 #+PROPERTY: header-args:R :session *R*
14130 #+PROPERTY: header-args :results silent
14133 Header arguments read from Org mode properties can also be set on a
14134 per-subtree basis using property drawers (see @ref{Property syntax}).
14135 @vindex org-use-property-inheritance
14136 When properties are used to set default header arguments, they are always
14137 looked up with inheritance, regardless of the value of
14138 @code{org-use-property-inheritance}. Properties are evaluated as seen by the
14139 outermost call or source block.@footnote{The deprecated syntax for default
14140 header argument properties, using the name of the header argument as a
14141 property name directly, evaluates the property as seen by the corresponding
14142 source block definition. This behaviour has been kept for backwards
14145 In the following example the value of
14146 the @code{:cache} header argument will default to @code{yes} in all code
14147 blocks in the subtree rooted at the following heading:
14152 :header-args: :cache yes
14157 @vindex org-babel-default-header-args
14158 Properties defined in this way override the properties set in
14159 @code{org-babel-default-header-args} and are applied for all activated
14160 languages. It is convenient to use the @code{org-set-property} function
14161 bound to @kbd{C-c C-x p} to set properties in Org mode documents.
14163 @node Language-specific header arguments in Org mode properties
14164 @subsubheading Language-specific header arguments in Org mode properties
14166 Language-specific header arguments are also read from properties
14167 @code{header-args:<lang>} where @code{<lang>} is the name of the language
14168 targeted. As an example
14173 :header-args:clojure: :session *clojure-1*
14174 :header-args:R: :session *R*
14178 :header-args:clojure: :session *clojure-2*
14182 would independently set a default session header argument for R and clojure
14183 for calls and source blocks under subtree ``Heading'' and change to a
14184 different clojure setting for evaluations under subtree ``Subheading'', while
14185 the R session is inherited from ``Heading'' and therefore unchanged.
14187 @node Code block specific header arguments
14188 @subsubheading Code block specific header arguments
14190 The most common way to assign values to header arguments is at the
14191 code block level. This can be done by listing a sequence of header
14192 arguments and their values as part of the @code{#+BEGIN_SRC} line.
14193 Properties set in this way override both the values of
14194 @code{org-babel-default-header-args} and header arguments specified as
14195 properties. In the following example, the @code{:results} header argument
14196 is set to @code{silent}, meaning the results of execution will not be
14197 inserted in the buffer, and the @code{:exports} header argument is set to
14198 @code{code}, meaning only the body of the code block will be
14199 preserved on export to HTML or @LaTeX{}.
14203 #+BEGIN_SRC haskell :results silent :exports code :var n=0
14205 fac n = n * fac (n-1)
14208 Similarly, it is possible to set header arguments for inline code blocks
14211 src_haskell[:exports both]@{fac 5@}
14214 Code block header arguments can span multiple lines using @code{#+HEADER:} or
14215 @code{#+HEADERS:} lines preceding a code block or nested between the
14216 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
14220 Multi-line header arguments on an un-named code block:
14223 #+HEADERS: :var data1=1
14224 #+BEGIN_SRC emacs-lisp :var data2=2
14225 (message "data1:%S, data2:%S" data1 data2)
14232 Multi-line header arguments on a named code block:
14235 #+NAME: named-block
14236 #+HEADER: :var data=2
14237 #+BEGIN_SRC emacs-lisp
14238 (message "data:%S" data)
14241 #+RESULTS: named-block
14245 @node Header arguments in function calls
14246 @subsubheading Header arguments in function calls
14248 At the most specific level, header arguments for ``Library of Babel'' or
14249 @code{#+CALL:} lines can be set as shown in the two examples below. For more
14250 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
14253 The following will apply the @code{:exports results} header argument to the
14254 evaluation of the @code{#+CALL:} line.
14257 #+CALL: factorial(n=5) :exports results
14260 The following will apply the @code{:session special} header argument to the
14261 evaluation of the @code{factorial} code block.
14264 #+CALL: factorial[:session special](n=5)
14267 @node Specific header arguments
14268 @subsection Specific header arguments
14269 Header arguments consist of an initial colon followed by the name of the
14270 argument in lowercase letters. The following header arguments are defined:
14273 * var:: Pass arguments to code blocks
14274 * Results:: Specify the type of results and how they will
14275 be collected and handled
14276 * file:: Specify a path for file output
14277 * file-desc:: Specify a description for file results
14278 * dir:: Specify the default (possibly remote)
14279 directory for code block execution
14280 * exports:: Export code and/or results
14281 * tangle:: Toggle tangling and specify file name
14282 * mkdirp:: Toggle creation of parent directories of target
14283 files during tangling
14284 * comments:: Toggle insertion of comments in tangled
14286 * padline:: Control insertion of padding lines in tangled
14288 * no-expand:: Turn off variable assignment and noweb
14289 expansion during tangling
14290 * session:: Preserve the state of code evaluation
14291 * noweb:: Toggle expansion of noweb references
14292 * noweb-ref:: Specify block's noweb reference resolution target
14293 * noweb-sep:: String used to separate noweb references
14294 * cache:: Avoid re-evaluating unchanged code blocks
14295 * sep:: Delimiter for writing tabular results outside Org
14296 * hlines:: Handle horizontal lines in tables
14297 * colnames:: Handle column names in tables
14298 * rownames:: Handle row names in tables
14299 * shebang:: Make tangled files executable
14300 * tangle-mode:: Set permission of tangled files
14301 * eval:: Limit evaluation of specific code blocks
14302 * wrap:: Mark source block evaluation results
14303 * post:: Post processing of code block results
14304 * prologue:: Text to prepend to code block body
14305 * epilogue:: Text to append to code block body
14308 Additional header arguments are defined on a language-specific basis, see
14312 @subsubsection @code{:var}
14313 @cindex @code{:var}, src header argument
14314 The @code{:var} header argument is used to pass arguments to code blocks.
14315 The specifics of how arguments are included in a code block vary by language;
14316 these are addressed in the language-specific documentation. However, the
14317 syntax used to specify arguments is the same across all languages. In every
14318 case, variables require a default value when they are declared.
14320 The values passed to arguments can either be literal values, references, or
14321 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}).
14322 References include anything in the Org mode file that takes a @code{#+NAME:}
14323 or @code{#+RESULTS:} line: tables, lists, @code{#+BEGIN_EXAMPLE} blocks,
14324 other code blocks and the results of other code blocks.
14326 Note: When a reference is made to another code block, the referenced block
14327 will be evaluated unless it has current cached results (see @ref{cache}).
14329 Argument values can be indexed in a manner similar to arrays (see @ref{var,
14330 Indexable variable values}).
14332 The following syntax is used to pass arguments to code blocks using the
14333 @code{:var} header argument.
14339 The argument, @code{assign}, can either be a literal value, such as a string
14340 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
14341 literal example, another code block (with or without arguments), or the
14342 results of evaluating another code block.
14344 Here are examples of passing values by reference:
14349 an Org mode table named with either a @code{#+NAME:} line
14352 #+NAME: example-table
14358 #+NAME: table-length
14359 #+BEGIN_SRC emacs-lisp :var table=example-table
14363 #+RESULTS: table-length
14368 a simple list named with a @code{#+NAME:} line (note that nesting is not
14369 carried through to the source code block)
14372 #+NAME: example-list
14378 #+BEGIN_SRC emacs-lisp :var x=example-list
14386 @item code block without arguments
14387 a code block name (from the example above), as assigned by @code{#+NAME:},
14388 optionally followed by parentheses
14391 #+BEGIN_SRC emacs-lisp :var length=table-length()
14399 @item code block with arguments
14400 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
14401 optional arguments passed within the parentheses following the
14402 code block name using standard function call syntax
14406 #+BEGIN_SRC emacs-lisp :var input=8
14414 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
14422 @item literal example
14423 a literal example block named with a @code{#+NAME:} line
14426 #+NAME: literal-example
14432 #+NAME: read-literal-example
14433 #+BEGIN_SRC emacs-lisp :var x=literal-example
14434 (concatenate 'string x " for you.")
14437 #+RESULTS: read-literal-example
14438 : A literal example
14439 : on two lines for you.
14445 @subsubheading Indexable variable values
14446 It is possible to reference portions of variable values by ``indexing'' into
14447 the variables. Indexes are 0 based with negative values counting back from
14448 the end. If an index is separated by @code{,}s then each subsequent section
14449 will index into the next deepest nesting or dimension of the value. Note
14450 that this indexing occurs @emph{before} other table related header arguments
14451 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
14452 following example assigns the last cell of the first row the table
14453 @code{example-table} to the variable @code{data}:
14456 #+NAME: example-table
14462 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
14470 Ranges of variable values can be referenced using two integers separated by a
14471 @code{:}, in which case the entire inclusive range is referenced. For
14472 example the following assigns the middle three rows of @code{example-table}
14476 #+NAME: example-table
14483 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
14493 Additionally, an empty index, or the single character @code{*}, are both
14494 interpreted to mean the entire range and as such are equivalent to
14495 @code{0:-1}, as shown in the following example in which the entire first
14496 column is referenced.
14499 #+NAME: example-table
14505 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
14513 It is possible to index into the results of code blocks as well as tables.
14514 Any number of dimensions can be indexed. Dimensions are separated from one
14515 another by commas, as shown in the following example.
14519 #+BEGIN_SRC emacs-lisp
14520 '(((1 2 3) (4 5 6) (7 8 9))
14521 ((10 11 12) (13 14 15) (16 17 18))
14522 ((19 20 21) (22 23 24) (25 26 27)))
14525 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
14533 @subsubheading Emacs Lisp evaluation of variables
14535 Emacs lisp code can be used to initialize variable values. When a variable
14536 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
14537 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
14538 the variable value. The following example demonstrates use of this
14539 evaluation to reliably pass the file-name of the Org mode buffer to a code
14540 block---note that evaluation of header arguments is guaranteed to take place
14541 in the original Org mode file, while there is no such guarantee for
14542 evaluation of the code block body.
14545 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
14550 Note that values read from tables and lists will not be evaluated as
14551 Emacs Lisp, as shown in the following example.
14557 #+HEADERS: :var data=table[0,0]
14567 @subsubsection @code{:results}
14568 @cindex @code{:results}, src header argument
14570 There are four classes of @code{:results} header argument. Only one option
14571 per class may be supplied per code block.
14575 @b{collection} header arguments specify how the results should be collected
14576 from the code block
14578 @b{type} header arguments specify what type of result the code block will
14579 return---which has implications for how they will be processed before
14580 insertion into the Org mode buffer
14582 @b{format} header arguments specify what type of result the code block will
14583 return---which has implications for how they will be inserted into the
14586 @b{handling} header arguments specify how the results of evaluating the code
14587 block should be handled.
14590 @subsubheading Collection
14591 The following options are mutually exclusive, and specify how the results
14592 should be collected from the code block.
14596 This is the default. The result is the value of the last statement in the
14597 code block. This header argument places the evaluation in functional
14598 mode. Note that in some languages, e.g., Python, use of this result type
14599 requires that a @code{return} statement be included in the body of the source
14600 code block. E.g., @code{:results value}.
14601 @item @code{output}
14602 The result is the collection of everything printed to STDOUT during the
14603 execution of the code block. This header argument places the
14604 evaluation in scripting mode. E.g., @code{:results output}.
14607 @subsubheading Type
14609 The following options are mutually exclusive and specify what type of results
14610 the code block will return. By default, results are inserted as either a
14611 table or scalar depending on their value.
14614 @item @code{table}, @code{vector}
14615 The results should be interpreted as an Org mode table. If a single value is
14616 returned, it will be converted into a table with one row and one column.
14617 E.g., @code{:results value table}.
14619 The results should be interpreted as an Org mode list. If a single scalar
14620 value is returned it will be converted into a list with only one element.
14621 @item @code{scalar}, @code{verbatim}
14622 The results should be interpreted literally---they will not be
14623 converted into a table. The results will be inserted into the Org mode
14624 buffer as quoted text. E.g., @code{:results value verbatim}.
14626 The results will be interpreted as the path to a file, and will be inserted
14627 into the Org mode buffer as a file link. E.g., @code{:results value file}.
14630 @subsubheading Format
14632 The following options are mutually exclusive and specify what type of results
14633 the code block will return. By default, results are inserted according to the
14634 type as specified above.
14638 The results are interpreted as raw Org mode code and are inserted directly
14639 into the buffer. If the results look like a table they will be aligned as
14640 such by Org mode. E.g., @code{:results value raw}.
14642 The results are will be enclosed in a @code{BEGIN_SRC org} block.
14643 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
14644 in the block and/or if you export the file. E.g., @code{:results value org}.
14646 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
14647 block. E.g., @code{:results value html}.
14649 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
14650 E.g., @code{:results value latex}.
14652 Result are assumed to be parsable code and are enclosed in a code block.
14653 E.g., @code{:results value code}.
14655 The result is converted to pretty-printed code and is enclosed in a code
14656 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
14657 @code{:results value pp}.
14658 @item @code{drawer}
14659 The result is wrapped in a RESULTS drawer. This can be useful for
14660 inserting @code{raw} or @code{org} syntax results in such a way that their
14661 extent is known and they can be automatically removed or replaced.
14664 @subsubheading Handling
14665 The following results options indicate what happens with the
14666 results once they are collected.
14669 @item @code{silent}
14670 The results will be echoed in the minibuffer but will not be inserted into
14671 the Org mode buffer. E.g., @code{:results output silent}.
14672 @item @code{replace}
14673 The default value. Any existing results will be removed, and the new results
14674 will be inserted into the Org mode buffer in their place. E.g.,
14675 @code{:results output replace}.
14676 @item @code{append}
14677 If there are pre-existing results of the code block then the new results will
14678 be appended to the existing results. Otherwise the new results will be
14679 inserted as with @code{replace}.
14680 @item @code{prepend}
14681 If there are pre-existing results of the code block then the new results will
14682 be prepended to the existing results. Otherwise the new results will be
14683 inserted as with @code{replace}.
14687 @subsubsection @code{:file}
14688 @cindex @code{:file}, src header argument
14690 The header argument @code{:file} is used to specify an external file in which
14691 to save code block results. After code block evaluation an Org mode style
14692 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
14693 into the Org mode buffer. Some languages including R, gnuplot, dot, and
14694 ditaa provide special handling of the @code{:file} header argument
14695 automatically wrapping the code block body in the boilerplate code required
14696 to save output to the specified file. This is often useful for saving
14697 graphical output of a code block to the specified file.
14699 The argument to @code{:file} should be either a string specifying the path to
14700 a file, or a list of two strings in which case the first element of the list
14701 should be the path to a file and the second a description for the link.
14704 @subsubsection @code{:file-desc}
14706 The value of the @code{:file-desc} header argument is used to provide a
14707 description for file code block results which are inserted as Org mode links
14708 (see @ref{Link format}). If the @code{:file-desc} header argument is given
14709 with no value the link path will be placed in both the ``link'' and the
14710 ``description'' portion of the Org mode link.
14713 @subsubsection @code{:dir} and remote execution
14714 @cindex @code{:dir}, src header argument
14716 While the @code{:file} header argument can be used to specify the path to the
14717 output file, @code{:dir} specifies the default directory during code block
14718 execution. If it is absent, then the directory associated with the current
14719 buffer is used. In other words, supplying @code{:dir path} temporarily has
14720 the same effect as changing the current directory with @kbd{M-x cd path RET}, and
14721 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
14722 the value of the Emacs variable @code{default-directory}.
14724 When using @code{:dir}, you should supply a relative path for file output
14725 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
14726 case that path will be interpreted relative to the default directory.
14728 In other words, if you want your plot to go into a folder called @file{Work}
14729 in your home directory, you could use
14732 #+BEGIN_SRC R :file myplot.png :dir ~/Work
14733 matplot(matrix(rnorm(100), 10), type="l")
14737 @subsubheading Remote execution
14738 A directory on a remote machine can be specified using tramp file syntax, in
14739 which case the code will be evaluated on the remote machine. An example is
14742 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
14743 plot(1:10, main=system("hostname", intern=TRUE))
14747 Text results will be returned to the local Org mode buffer as usual, and file
14748 output will be created on the remote machine with relative paths interpreted
14749 relative to the remote directory. An Org mode link to the remote file will be
14752 So, in the above example a plot will be created on the remote machine,
14753 and a link of the following form will be inserted in the org buffer:
14756 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
14759 Most of this functionality follows immediately from the fact that @code{:dir}
14760 sets the value of the Emacs variable @code{default-directory}, thanks to
14761 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
14762 install tramp separately in order for these features to work correctly.
14764 @subsubheading Further points
14768 If @code{:dir} is used in conjunction with @code{:session}, although it will
14769 determine the starting directory for a new session as expected, no attempt is
14770 currently made to alter the directory associated with an existing session.
14772 @code{:dir} should typically not be used to create files during export with
14773 @code{:exports results} or @code{:exports both}. The reason is that, in order
14774 to retain portability of exported material between machines, during export
14775 links inserted into the buffer will @emph{not} be expanded against @code{default
14776 directory}. Therefore, if @code{default-directory} is altered using
14777 @code{:dir}, it is probable that the file will be created in a location to
14778 which the link does not point.
14782 @subsubsection @code{:exports}
14783 @cindex @code{:exports}, src header argument
14785 The @code{:exports} header argument specifies what should be included in HTML
14786 or @LaTeX{} exports of the Org mode file.
14790 The default. The body of code is included into the exported file. E.g.,
14791 @code{:exports code}.
14792 @item @code{results}
14793 The result of evaluating the code is included in the exported file. E.g.,
14794 @code{:exports results}.
14796 Both the code and results are included in the exported file. E.g.,
14797 @code{:exports both}.
14799 Nothing is included in the exported file. E.g., @code{:exports none}.
14803 @subsubsection @code{:tangle}
14804 @cindex @code{:tangle}, src header argument
14806 The @code{:tangle} header argument specifies whether or not the code
14807 block should be included in tangled extraction of source code files.
14810 @item @code{tangle}
14811 The code block is exported to a source code file named after the full path
14812 (including the directory) and file name (w/o extension) of the Org mode file.
14813 E.g., @code{:tangle yes}.
14815 The default. The code block is not exported to a source code file.
14816 E.g., @code{:tangle no}.
14818 Any other string passed to the @code{:tangle} header argument is interpreted
14819 as a path (directory and file name relative to the directory of the Org mode
14820 file) to which the block will be exported. E.g., @code{:tangle path}.
14824 @subsubsection @code{:mkdirp}
14825 @cindex @code{:mkdirp}, src header argument
14827 The @code{:mkdirp} header argument can be used to create parent directories
14828 of tangled files when missing. This can be set to @code{yes} to enable
14829 directory creation or to @code{no} to inhibit directory creation.
14832 @subsubsection @code{:comments}
14833 @cindex @code{:comments}, src header argument
14834 By default code blocks are tangled to source-code files without any insertion
14835 of comments beyond those which may already exist in the body of the code
14836 block. The @code{:comments} header argument can be set as follows to control
14837 the insertion of extra comments into the tangled code file.
14841 The default. No extra comments are inserted during tangling.
14843 The code block is wrapped in comments which contain pointers back to the
14844 original Org file from which the code was tangled.
14846 A synonym for ``link'' to maintain backwards compatibility.
14848 Include text from the Org mode file as a comment.
14849 The text is picked from the leading context of the tangled code and is
14850 limited by the nearest headline or source block as the case may be.
14852 Turns on both the ``link'' and ``org'' comment options.
14854 Turns on the ``link'' comment option, and additionally wraps expanded noweb
14855 references in the code block body in link comments.
14859 @subsubsection @code{:padline}
14860 @cindex @code{:padline}, src header argument
14861 Control in insertion of padding lines around code block bodies in tangled
14862 code files. The default value is @code{yes} which results in insertion of
14863 newlines before and after each tangled code block. The following arguments
14868 Insert newlines before and after each code block body in tangled code files.
14870 Do not insert any newline padding in tangled output.
14874 @subsubsection @code{:no-expand}
14875 @cindex @code{:no-expand}, src header argument
14877 By default, code blocks are expanded with @code{org-babel-expand-src-block}
14878 during tangling. This has the effect of assigning values to variables
14879 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
14880 references (see @ref{Noweb reference syntax}) with their targets. The
14881 @code{:no-expand} header argument can be used to turn off this behavior.
14884 @subsubsection @code{:session}
14885 @cindex @code{:session}, src header argument
14887 The @code{:session} header argument starts a session for an interpreted
14888 language where state is preserved.
14890 By default, a session is not started.
14892 A string passed to the @code{:session} header argument will give the session
14893 a name. This makes it possible to run concurrent sessions for each
14894 interpreted language.
14897 @subsubsection @code{:noweb}
14898 @cindex @code{:noweb}, src header argument
14900 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
14901 references (see @ref{Noweb reference syntax}) when the code block is
14902 evaluated, tangled, or exported. The @code{:noweb} header argument can have
14903 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
14904 @code{no-export} @code{strip-export}.
14908 The default. ``Noweb'' syntax references in the body of the code block will
14909 not be expanded before the code block is evaluated, tangled or exported.
14911 ``Noweb'' syntax references in the body of the code block will be
14912 expanded before the code block is evaluated, tangled or exported.
14913 @item @code{tangle}
14914 ``Noweb'' syntax references in the body of the code block will be expanded
14915 before the code block is tangled. However, ``noweb'' syntax references will
14916 not be expanded when the code block is evaluated or exported.
14917 @item @code{no-export}
14918 ``Noweb'' syntax references in the body of the code block will be expanded
14919 before the block is evaluated or tangled. However, ``noweb'' syntax
14920 references will not be expanded when the code block is exported.
14921 @item @code{strip-export}
14922 ``Noweb'' syntax references in the body of the code block will be expanded
14923 before the block is evaluated or tangled. However, ``noweb'' syntax
14924 references will be removed when the code block is exported.
14926 ``Noweb'' syntax references in the body of the code block will only be
14927 expanded before the block is evaluated.
14930 @subsubheading Noweb prefix lines
14931 Noweb insertions are now placed behind the line prefix of the
14932 @code{<<reference>>}.
14933 This behavior is illustrated in the following example. Because the
14934 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
14935 each line of the expanded noweb reference will be commented.
14947 -- multi-line body of example
14950 Note that noweb replacement text that does not contain any newlines will not
14951 be affected by this change, so it is still possible to use inline noweb
14955 @subsubsection @code{:noweb-ref}
14956 @cindex @code{:noweb-ref}, src header argument
14957 When expanding ``noweb'' style references the bodies of all code block with
14958 @emph{either} a block name matching the reference name @emph{or} a
14959 @code{:noweb-ref} header argument matching the reference name will be
14960 concatenated together to form the replacement text.
14962 By setting this header argument at the sub-tree or file level, simple code
14963 block concatenation may be achieved. For example, when tangling the
14964 following Org mode file, the bodies of code blocks will be concatenated into
14965 the resulting pure code file@footnote{(The example needs property inheritance
14966 to be turned on for the @code{noweb-ref} property, see @ref{Property
14970 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
14973 * the mount point of the fullest disk
14975 :noweb-ref: fullest-disk
14978 ** query all mounted disks
14983 ** strip the header row
14988 ** sort by the percent full
14990 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
14993 ** extract the mount point
14995 |awk '@{print $2@}'
14999 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
15000 used to separate accumulate noweb references like those above. By default a
15004 @subsubsection @code{:noweb-sep}
15005 @cindex @code{:noweb-sep}, src header argument
15007 The @code{:noweb-sep} header argument holds the string used to separate
15008 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
15012 @subsubsection @code{:cache}
15013 @cindex @code{:cache}, src header argument
15015 The @code{:cache} header argument controls the use of in-buffer caching of
15016 the results of evaluating code blocks. It can be used to avoid re-evaluating
15017 unchanged code blocks. Note that the @code{:cache} header argument will not
15018 attempt to cache results when the @code{:session} header argument is used,
15019 because the results of the code block execution may be stored in the session
15020 outside of the Org mode buffer. The @code{:cache} header argument can have
15021 one of two values: @code{yes} or @code{no}.
15025 The default. No caching takes place, and the code block will be evaluated
15026 every time it is called.
15028 Every time the code block is run a SHA1 hash of the code and arguments
15029 passed to the block will be generated. This hash is packed into the
15030 @code{#+RESULTS:} line and will be checked on subsequent
15031 executions of the code block. If the code block has not
15032 changed since the last time it was evaluated, it will not be re-evaluated.
15035 Code block caches notice if the value of a variable argument
15036 to the code block has changed. If this is the case, the cache is
15037 invalidated and the code block is re-run. In the following example,
15038 @code{caller} will not be re-run unless the results of @code{random} have
15039 changed since it was last run.
15043 #+BEGIN_SRC R :cache yes
15047 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
15051 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
15055 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
15060 @subsubsection @code{:sep}
15061 @cindex @code{:sep}, src header argument
15063 The @code{:sep} header argument can be used to control the delimiter used
15064 when writing tabular results out to files external to Org mode. This is used
15065 either when opening tabular results of a code block by calling the
15066 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
15067 or when writing code block results to an external file (see @ref{file})
15070 By default, when @code{:sep} is not specified output tables are tab
15074 @subsubsection @code{:hlines}
15075 @cindex @code{:hlines}, src header argument
15077 Tables are frequently represented with one or more horizontal lines, or
15078 hlines. The @code{:hlines} argument to a code block accepts the
15079 values @code{yes} or @code{no}, with a default value of @code{no}.
15083 Strips horizontal lines from the input table. In most languages this is the
15084 desired effect because an @code{hline} symbol is interpreted as an unbound
15085 variable and raises an error. Setting @code{:hlines no} or relying on the
15086 default value yields the following results.
15097 #+BEGIN_SRC python :var tab=many-cols
15101 #+RESULTS: echo-table
15108 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
15119 #+BEGIN_SRC python :var tab=many-cols :hlines yes
15123 #+RESULTS: echo-table
15133 @subsubsection @code{:colnames}
15134 @cindex @code{:colnames}, src header argument
15136 The @code{:colnames} header argument accepts the values @code{yes},
15137 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
15138 Note that the behavior of the @code{:colnames} header argument may differ
15143 If an input table looks like it has column names
15144 (because its second row is an hline), then the column
15145 names will be removed from the table before
15146 processing, then reapplied to the results.
15155 #+NAME: echo-table-again
15156 #+BEGIN_SRC python :var tab=less-cols
15157 return [[val + '*' for val in row] for row in tab]
15160 #+RESULTS: echo-table-again
15167 Please note that column names are not removed before the table is indexed
15168 using variable indexing @xref{var, Indexable variable values}.
15171 No column name pre-processing takes place
15174 Column names are removed and reapplied as with @code{nil} even if the table
15175 does not ``look like'' it has column names (i.e., the second row is not an
15180 @subsubsection @code{:rownames}
15181 @cindex @code{:rownames}, src header argument
15183 The @code{:rownames} header argument can take on the values @code{yes} or
15184 @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
15185 blocks ignore the @code{:rownames} header argument entirely given the ease
15186 with which tables with row names may be handled directly in Emacs Lisp.
15190 No row name pre-processing will take place.
15193 The first column of the table is removed from the table before processing,
15194 and is then reapplied to the results.
15197 #+NAME: with-rownames
15198 | one | 1 | 2 | 3 | 4 | 5 |
15199 | two | 6 | 7 | 8 | 9 | 10 |
15201 #+NAME: echo-table-once-again
15202 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
15203 return [[val + 10 for val in row] for row in tab]
15206 #+RESULTS: echo-table-once-again
15207 | one | 11 | 12 | 13 | 14 | 15 |
15208 | two | 16 | 17 | 18 | 19 | 20 |
15211 Please note that row names are not removed before the table is indexed using
15212 variable indexing @xref{var, Indexable variable values}.
15217 @subsubsection @code{:shebang}
15218 @cindex @code{:shebang}, src header argument
15220 Setting the @code{:shebang} header argument to a string value
15221 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
15222 first line of any tangled file holding the code block, and the file
15223 permissions of the tangled file are set to make it executable.
15227 @subsubsection @code{:tangle-mode}
15228 @cindex @code{:tangle-mode}, src header argument
15230 The @code{tangle-mode} header argument controls the permission set on tangled
15231 files. The value of this header argument will be passed to
15232 @code{set-file-modes}. For example, to set a tangled file as read only use
15233 @code{:tangle-mode (identity #o444)}, or to set a tangled file as executable
15234 use @code{:tangle-mode (identity #o755)}. Blocks with @code{shebang}
15235 (@ref{shebang}) header arguments will automatically be made executable unless
15236 the @code{tangle-mode} header argument is also used. The behavior is
15237 undefined if multiple code blocks with different values for the
15238 @code{tangle-mode} header argument are tangled to the same file.
15241 @subsubsection @code{:eval}
15242 @cindex @code{:eval}, src header argument
15243 The @code{:eval} header argument can be used to limit the evaluation of
15244 specific code blocks. The @code{:eval} header argument can be useful for
15245 protecting against the evaluation of dangerous code blocks or to ensure that
15246 evaluation will require a query regardless of the value of the
15247 @code{org-confirm-babel-evaluate} variable. The possible values of
15248 @code{:eval} and their effects are shown below.
15252 The code block will not be evaluated under any circumstances.
15254 Evaluation of the code block will require a query.
15255 @item never-export or no-export
15256 The code block will not be evaluated during export but may still be called
15259 Evaluation of the code block during export will require a query.
15262 If this header argument is not set then evaluation is determined by the value
15263 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
15267 @subsubsection @code{:wrap}
15268 @cindex @code{:wrap}, src header argument
15269 The @code{:wrap} header argument is used to mark the results of source block
15270 evaluation. The header argument can be passed a string that will be appended
15271 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
15272 results. If not string is specified then the results will be wrapped in a
15273 @code{#+BEGIN/END_RESULTS} block.
15276 @subsubsection @code{:post}
15277 @cindex @code{:post}, src header argument
15278 The @code{:post} header argument is used to post-process the results of a
15279 code block execution. When a post argument is given, the results of the code
15280 block will temporarily be bound to the @code{*this*} variable. This variable
15281 may then be included in header argument forms such as those used in @ref{var}
15282 header argument specifications allowing passing of results to other code
15283 blocks, or direct execution via Emacs Lisp.
15285 The following example illustrates the usage of the @code{:post} header
15290 #+begin_src sh :var data="" :var width="\\textwidth" :results output
15291 echo "#+ATTR_LATEX :width $width"
15295 #+header: :file /tmp/it.png
15296 #+begin_src dot :post attr_wrap(width="5cm", data=*this*) :results drawer
15306 #+ATTR_LATEX :width 5cm
15307 [[file:/tmp/it.png]]
15312 @subsubsection @code{:prologue}
15313 @cindex @code{:prologue}, src header argument
15314 The value of the @code{prologue} header argument will be prepended to the
15315 code block body before execution. For example, @code{:prologue "reset"} may
15316 be used to reset a gnuplot session before execution of a particular code
15317 block, or the following configuration may be used to do this for all gnuplot
15318 code blocks. Also see @ref{epilogue}.
15321 (add-to-list 'org-babel-default-header-args:gnuplot
15322 '((:prologue . "reset")))
15326 @subsubsection @code{:epilogue}
15327 @cindex @code{:epilogue}, src header argument
15328 The value of the @code{epilogue} header argument will be appended to the code
15329 block body before execution. Also see @ref{prologue}.
15331 @node Results of evaluation
15332 @section Results of evaluation
15333 @cindex code block, results of evaluation
15334 @cindex source code, results of evaluation
15336 The way in which results are handled depends on whether a session is invoked,
15337 as well as on whether @code{:results value} or @code{:results output} is
15338 used. The following table shows the table possibilities. For a full listing
15339 of the possible results header arguments see @ref{Results}.
15341 @multitable @columnfractions 0.26 0.33 0.41
15342 @item @tab @b{Non-session} @tab @b{Session}
15343 @item @code{:results value} @tab value of last expression @tab value of last expression
15344 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
15347 Note: With @code{:results value}, the result in both @code{:session} and
15348 non-session is returned to Org mode as a table (a one- or two-dimensional
15349 vector of strings or numbers) when appropriate.
15351 @subsection Non-session
15352 @subsubsection @code{:results value}
15353 @cindex @code{:results}, src header argument
15354 This is the default. Internally, the value is obtained by wrapping the code
15355 in a function definition in the external language, and evaluating that
15356 function. Therefore, code should be written as if it were the body of such a
15357 function. In particular, note that Python does not automatically return a
15358 value from a function unless a @code{return} statement is present, and so a
15359 @samp{return} statement will usually be required in Python.
15361 This is the only one of the four evaluation contexts in which the code is
15362 automatically wrapped in a function definition.
15364 @subsubsection @code{:results output}
15365 @cindex @code{:results}, src header argument
15366 The code is passed to the interpreter as an external process, and the
15367 contents of the standard output stream are returned as text. (In certain
15368 languages this also contains the error output stream; this is an area for
15371 @subsection Session
15372 @subsubsection @code{:results value}
15373 @cindex @code{:results}, src header argument
15374 The code is passed to an interpreter running as an interactive Emacs inferior
15375 process. Only languages which provide tools for interactive evaluation of
15376 code have session support, so some language (e.g., C and ditaa) do not
15377 support the @code{:session} header argument, and in other languages (e.g.,
15378 Python and Haskell) which have limitations on the code which may be entered
15379 into interactive sessions, those limitations apply to the code in code blocks
15380 using the @code{:session} header argument as well.
15382 Unless the @code{:results output} option is supplied (see below) the result
15383 returned is the result of the last evaluation performed by the
15384 interpreter. (This is obtained in a language-specific manner: the value of
15385 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
15388 @subsubsection @code{:results output}
15389 @cindex @code{:results}, src header argument
15390 The code is passed to the interpreter running as an interactive Emacs
15391 inferior process. The result returned is the concatenation of the sequence of
15392 (text) output from the interactive interpreter. Notice that this is not
15393 necessarily the same as what would be sent to @code{STDOUT} if the same code
15394 were passed to a non-interactive interpreter running as an external
15395 process. For example, compare the following two blocks:
15398 #+BEGIN_SRC python :results output
15409 In non-session mode, the `2' is not printed and does not appear.
15412 #+BEGIN_SRC python :results output :session
15424 But in @code{:session} mode, the interactive interpreter receives input `2'
15425 and prints out its value, `2'. (Indeed, the other print statements are
15428 @node Noweb reference syntax
15429 @section Noweb reference syntax
15430 @cindex code block, noweb reference
15431 @cindex syntax, noweb
15432 @cindex source code, noweb reference
15434 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
15435 Programming system allows named blocks of code to be referenced by using the
15436 familiar Noweb syntax:
15439 <<code-block-name>>
15442 When a code block is tangled or evaluated, whether or not ``noweb''
15443 references are expanded depends upon the value of the @code{:noweb} header
15444 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
15445 evaluation. If @code{:noweb no}, the default, then the reference is not
15446 expanded before evaluation. See the @ref{noweb-ref} header argument for
15447 a more flexible way to resolve noweb references.
15449 It is possible to include the @emph{results} of a code block rather than the
15450 body. This is done by appending parenthesis to the code block name which may
15451 optionally contain arguments to the code block as shown below.
15454 <<code-block-name(optional arguments)>>
15457 Note: the default value, @code{:noweb no}, was chosen to ensure that
15458 correct code is not broken in a language, such as Ruby, where
15459 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
15460 syntactically valid in languages that you use, then please consider setting
15463 Note: if noweb tangling is slow in large Org mode files consider setting the
15464 @code{org-babel-use-quick-and-dirty-noweb-expansion} variable to @code{t}.
15465 This will result in faster noweb reference resolution at the expense of not
15466 correctly resolving inherited values of the @code{:noweb-ref} header
15469 @node Key bindings and useful functions
15470 @section Key bindings and useful functions
15471 @cindex code block, key bindings
15473 Many common Org mode key sequences are re-bound depending on
15476 Within a code block, the following key bindings
15479 @multitable @columnfractions 0.25 0.75
15481 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
15483 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
15485 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
15487 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
15490 In an Org mode buffer, the following key bindings are active:
15492 @multitable @columnfractions 0.45 0.55
15494 @kindex C-c C-v C-p
15495 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
15497 @kindex C-c C-v C-n
15498 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
15500 @kindex C-c C-v C-e
15501 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
15503 @kindex C-c C-v C-o
15504 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
15506 @kindex C-c C-v C-v
15507 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
15509 @kindex C-c C-v C-u
15510 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
15512 @kindex C-c C-v C-g
15513 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
15515 @kindex C-c C-v C-r
15516 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
15518 @kindex C-c C-v C-b
15519 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
15521 @kindex C-c C-v C-s
15522 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
15524 @kindex C-c C-v C-d
15525 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
15527 @kindex C-c C-v C-t
15528 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
15530 @kindex C-c C-v C-f
15531 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
15533 @kindex C-c C-v C-c
15534 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
15536 @kindex C-c C-v C-j
15537 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
15539 @kindex C-c C-v C-l
15540 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
15542 @kindex C-c C-v C-i
15543 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
15545 @kindex C-c C-v C-I
15546 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
15548 @kindex C-c C-v C-z
15549 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session-with-code}
15551 @kindex C-c C-v C-a
15552 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
15554 @kindex C-c C-v C-h
15555 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
15557 @kindex C-c C-v C-x
15558 @item @kbd{C-c C-v x} @ @ @r{or} @ @ @kbd{C-c C-v C-x} @tab @code{org-babel-do-key-sequence-in-edit-buffer}
15561 @c When possible these keybindings were extended to work when the control key is
15562 @c kept pressed, resulting in the following additional keybindings.
15564 @c @multitable @columnfractions 0.25 0.75
15565 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
15566 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
15567 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
15568 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
15569 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
15570 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
15571 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
15572 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
15575 @node Batch execution
15576 @section Batch execution
15577 @cindex code block, batch execution
15578 @cindex source code, batch execution
15580 It is possible to call functions from the command line. This shell
15581 script calls @code{org-babel-tangle} on every one of its arguments.
15583 Be sure to adjust the paths to fit your system.
15587 # -*- mode: shell-script -*-
15589 # tangle files with org-mode
15594 # wrap each argument in the code required to call tangle on it
15596 FILES="$FILES \"$i\""
15601 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
15602 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
15603 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
15604 (mapc (lambda (file)
15605 (find-file (expand-file-name file \"$DIR\"))
15607 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
15610 @node Miscellaneous
15611 @chapter Miscellaneous
15614 * Completion:: M-TAB knows what you need
15615 * Easy templates:: Quick insertion of structural elements
15616 * Speed keys:: Electric commands at the beginning of a headline
15617 * Code evaluation security:: Org mode files evaluate inline code
15618 * Customization:: Adapting Org to your taste
15619 * In-buffer settings:: Overview of the #+KEYWORDS
15620 * The very busy C-c C-c key:: When in doubt, press C-c C-c
15621 * Clean view:: Getting rid of leading stars in the outline
15622 * TTY keys:: Using Org on a tty
15623 * Interaction:: Other Emacs packages
15624 * org-crypt:: Encrypting Org files
15629 @section Completion
15630 @cindex completion, of @TeX{} symbols
15631 @cindex completion, of TODO keywords
15632 @cindex completion, of dictionary words
15633 @cindex completion, of option keywords
15634 @cindex completion, of tags
15635 @cindex completion, of property keys
15636 @cindex completion, of link abbreviations
15637 @cindex @TeX{} symbol completion
15638 @cindex TODO keywords completion
15639 @cindex dictionary word completion
15640 @cindex option keyword completion
15641 @cindex tag completion
15642 @cindex link abbreviations, completion of
15644 Emacs would not be Emacs without completion, and Org mode uses it whenever it
15645 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
15646 some of the completion prompts, you can specify your preference by setting at
15647 most one of the variables @code{org-completion-use-iswitchb}
15648 @code{org-completion-use-ido}.
15650 Org supports in-buffer completion. This type of completion does
15651 not make use of the minibuffer. You simply type a few letters into
15652 the buffer and use the key to complete text right there.
15655 @kindex M-@key{TAB}
15657 Complete word at point
15660 At the beginning of a headline, complete TODO keywords.
15662 After @samp{\}, complete @TeX{} symbols supported by the exporter.
15664 After @samp{*}, complete headlines in the current buffer so that they
15665 can be used in search links like @samp{[[*find this headline]]}.
15667 After @samp{:} in a headline, complete tags. The list of tags is taken
15668 from the variable @code{org-tag-alist} (possibly set through the
15669 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
15670 dynamically from all tags used in the current buffer.
15672 After @samp{:} and not in a headline, complete property keys. The list
15673 of keys is constructed dynamically from all keys used in the current
15676 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
15678 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
15679 @samp{OPTIONS} which set file-specific options for Org mode. When the
15680 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
15681 will insert example settings for this keyword.
15683 In the line after @samp{#+STARTUP: }, complete startup keywords,
15684 i.e., valid keys for this line.
15686 Elsewhere, complete dictionary words using Ispell.
15690 @node Easy templates
15691 @section Easy templates
15692 @cindex template insertion
15693 @cindex insertion, of templates
15695 Org mode supports insertion of empty structural elements (like
15696 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
15697 strokes. This is achieved through a native template expansion mechanism.
15698 Note that Emacs has several other template mechanisms which could be used in
15699 a similar way, for example @file{yasnippet}.
15701 To insert a structural element, type a @samp{<}, followed by a template
15702 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
15703 keystrokes are typed on a line by itself.
15705 The following template selectors are currently supported.
15707 @multitable @columnfractions 0.1 0.9
15708 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
15709 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
15710 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
15711 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
15712 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
15713 @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
15714 @item @kbd{L} @tab @code{#+LaTeX:}
15715 @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
15716 @item @kbd{H} @tab @code{#+HTML:}
15717 @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
15718 @item @kbd{A} @tab @code{#+ASCII:}
15719 @item @kbd{i} @tab @code{#+INDEX:} line
15720 @item @kbd{I} @tab @code{#+INCLUDE:} line
15723 For example, on an empty line, typing "<e" and then pressing TAB, will expand
15724 into a complete EXAMPLE template.
15726 You can install additional templates by customizing the variable
15727 @code{org-structure-template-alist}. See the docstring of the variable for
15728 additional details.
15731 @section Speed keys
15733 @vindex org-use-speed-commands
15734 @vindex org-speed-commands-user
15736 Single keys can be made to execute commands when the cursor is at the
15737 beginning of a headline, i.e., before the first star. Configure the variable
15738 @code{org-use-speed-commands} to activate this feature. There is a
15739 pre-defined list of commands, and you can add more such commands using the
15740 variable @code{org-speed-commands-user}. Speed keys not only speed up
15741 navigation and other commands, but they also provide an alternative way to
15742 execute commands bound to keys that are not or not easily available on a TTY,
15743 or on a small mobile device with a limited keyboard.
15745 To see which commands are available, activate the feature and press @kbd{?}
15746 with the cursor at the beginning of a headline.
15748 @node Code evaluation security
15749 @section Code evaluation and security issues
15751 Org provides tools to work with code snippets, including evaluating them.
15753 Running code on your machine always comes with a security risk. Badly
15754 written or malicious code can be executed on purpose or by accident. Org has
15755 default settings which will only evaluate such code if you give explicit
15756 permission to do so, and as a casual user of these features you should leave
15757 these precautions intact.
15759 For people who regularly work with such code, the confirmation prompts can
15760 become annoying, and you might want to turn them off. This can be done, but
15761 you must be aware of the risks that are involved.
15763 Code evaluation can happen under the following circumstances:
15766 @item Source code blocks
15767 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
15768 C-c} in the block. The most important thing to realize here is that Org mode
15769 files which contain code snippets are, in a certain sense, like executable
15770 files. So you should accept them and load them into Emacs only from trusted
15771 sources---just like you would do with a program you install on your computer.
15773 Make sure you know what you are doing before customizing the variables
15774 which take off the default security brakes.
15776 @defopt org-confirm-babel-evaluate
15777 When t (the default), the user is asked before every code block evaluation.
15778 When @code{nil}, the user is not asked. When set to a function, it is called with
15779 two arguments (language and body of the code block) and should return t to
15780 ask and @code{nil} not to ask.
15783 For example, here is how to execute "ditaa" code (which is considered safe)
15787 (defun my-org-confirm-babel-evaluate (lang body)
15788 (not (string= lang "ditaa"))) ; don't ask for ditaa
15789 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
15792 @item Following @code{shell} and @code{elisp} links
15793 Org has two link types that can directly evaluate code (@pxref{External
15794 links}). These links can be problematic because the code to be evaluated is
15797 @defopt org-confirm-shell-link-function
15798 Function to queries user about shell link execution.
15800 @defopt org-confirm-elisp-link-function
15801 Functions to query user for Emacs Lisp link execution.
15804 @item Formulas in tables
15805 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
15806 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
15809 @node Customization
15810 @section Customization
15811 @cindex customization
15812 @cindex options, for customization
15813 @cindex variables, for customization
15815 There are more than 500 variables that can be used to customize
15816 Org. For the sake of compactness of the manual, I am not
15817 describing the variables here. A structured overview of customization
15818 variables is available with @kbd{M-x org-customize RET}. Or select
15819 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
15820 settings can also be activated on a per-file basis, by putting special
15821 lines into the buffer (@pxref{In-buffer settings}).
15823 @node In-buffer settings
15824 @section Summary of in-buffer settings
15825 @cindex in-buffer settings
15826 @cindex special keywords
15828 Org mode uses special lines in the buffer to define settings on a
15829 per-file basis. These lines start with a @samp{#+} followed by a
15830 keyword, a colon, and then individual words defining a setting. Several
15831 setting words can be in the same line, but you can also have multiple
15832 lines for the keyword. While these settings are described throughout
15833 the manual, here is a summary. After changing any of these lines in the
15834 buffer, press @kbd{C-c C-c} with the cursor still in the line to
15835 activate the changes immediately. Otherwise they become effective only
15836 when the file is visited again in a new Emacs session.
15838 @vindex org-archive-location
15840 @item #+ARCHIVE: %s_done::
15841 This line sets the archive location for the agenda file. It applies for
15842 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
15843 of the file. The first such line also applies to any entries before it.
15844 The corresponding variable is @code{org-archive-location}.
15846 This line sets the category for the agenda file. The category applies
15847 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
15848 end of the file. The first such line also applies to any entries before it.
15849 @item #+COLUMNS: %25ITEM .....
15850 @cindex property, COLUMNS
15851 Set the default format for columns view. This format applies when
15852 columns view is invoked in locations where no @code{COLUMNS} property
15854 @item #+CONSTANTS: name1=value1 ...
15855 @vindex org-table-formula-constants
15856 @vindex org-table-formula
15857 Set file-local values for constants to be used in table formulas. This
15858 line sets the local variable @code{org-table-formula-constants-local}.
15859 The global version of this variable is
15860 @code{org-table-formula-constants}.
15861 @item #+FILETAGS: :tag1:tag2:tag3:
15862 Set tags that can be inherited by any entry in the file, including the
15864 @item #+LINK: linkword replace
15865 @vindex org-link-abbrev-alist
15866 These lines (several are allowed) specify link abbreviations.
15867 @xref{Link abbreviations}. The corresponding variable is
15868 @code{org-link-abbrev-alist}.
15869 @item #+PRIORITIES: highest lowest default
15870 @vindex org-highest-priority
15871 @vindex org-lowest-priority
15872 @vindex org-default-priority
15873 This line sets the limits and the default for the priorities. All three
15874 must be either letters A--Z or numbers 0--9. The highest priority must
15875 have a lower ASCII number than the lowest priority.
15876 @item #+PROPERTY: Property_Name Value
15877 This line sets a default inheritance value for entries in the current
15878 buffer, most useful for specifying the allowed values of a property.
15879 @cindex #+SETUPFILE
15880 @item #+SETUPFILE: file
15881 This line defines a file that holds more in-buffer setup. Normally this is
15882 entirely ignored. Only when the buffer is parsed for option-setting lines
15883 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
15884 settings line, or when exporting), then the contents of this file are parsed
15885 as if they had been included in the buffer. In particular, the file can be
15886 any other Org mode file with internal setup. You can visit the file the
15887 cursor is in the line with @kbd{C-c '}.
15890 This line sets options to be used at startup of Org mode, when an
15891 Org file is being visited.
15893 The first set of options deals with the initial visibility of the outline
15894 tree. The corresponding variable for global default settings is
15895 @code{org-startup-folded}, with a default value @code{t}, which means
15897 @vindex org-startup-folded
15898 @cindex @code{overview}, STARTUP keyword
15899 @cindex @code{content}, STARTUP keyword
15900 @cindex @code{showall}, STARTUP keyword
15901 @cindex @code{showeverything}, STARTUP keyword
15903 overview @r{top-level headlines only}
15904 content @r{all headlines}
15905 showall @r{no folding of any entries}
15906 showeverything @r{show even drawer contents}
15909 @vindex org-startup-indented
15910 @cindex @code{indent}, STARTUP keyword
15911 @cindex @code{noindent}, STARTUP keyword
15912 Dynamic virtual indentation is controlled by the variable
15913 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
15915 indent @r{start with @code{org-indent-mode} turned on}
15916 noindent @r{start with @code{org-indent-mode} turned off}
15919 @vindex org-startup-align-all-tables
15920 Then there are options for aligning tables upon visiting a file. This
15921 is useful in files containing narrowed table columns. The corresponding
15922 variable is @code{org-startup-align-all-tables}, with a default value
15924 @cindex @code{align}, STARTUP keyword
15925 @cindex @code{noalign}, STARTUP keyword
15927 align @r{align all tables}
15928 noalign @r{don't align tables on startup}
15931 @vindex org-startup-with-inline-images
15932 When visiting a file, inline images can be automatically displayed. The
15933 corresponding variable is @code{org-startup-with-inline-images}, with a
15934 default value @code{nil} to avoid delays when visiting a file.
15935 @cindex @code{inlineimages}, STARTUP keyword
15936 @cindex @code{noinlineimages}, STARTUP keyword
15938 inlineimages @r{show inline images}
15939 noinlineimages @r{don't show inline images on startup}
15942 @vindex org-startup-with-latex-preview
15943 When visiting a file, @LaTeX{} fragments can be converted to images
15944 automatically. The variable @code{org-startup-with-latex-preview} which
15945 controls this behavior, is set to @code{nil} by default to avoid delays on
15947 @cindex @code{latexpreview}, STARTUP keyword
15948 @cindex @code{nolatexpreview}, STARTUP keyword
15950 latexpreview @r{preview @LaTeX{} fragments}
15951 nolatexpreview @r{don't preview @LaTeX{} fragments}
15954 @vindex org-log-done
15955 @vindex org-log-note-clock-out
15956 @vindex org-log-repeat
15957 Logging the closing and reopening of TODO items and clock intervals can be
15958 configured using these options (see variables @code{org-log-done},
15959 @code{org-log-note-clock-out} and @code{org-log-repeat})
15960 @cindex @code{logdone}, STARTUP keyword
15961 @cindex @code{lognotedone}, STARTUP keyword
15962 @cindex @code{nologdone}, STARTUP keyword
15963 @cindex @code{lognoteclock-out}, STARTUP keyword
15964 @cindex @code{nolognoteclock-out}, STARTUP keyword
15965 @cindex @code{logrepeat}, STARTUP keyword
15966 @cindex @code{lognoterepeat}, STARTUP keyword
15967 @cindex @code{nologrepeat}, STARTUP keyword
15968 @cindex @code{logreschedule}, STARTUP keyword
15969 @cindex @code{lognotereschedule}, STARTUP keyword
15970 @cindex @code{nologreschedule}, STARTUP keyword
15971 @cindex @code{logredeadline}, STARTUP keyword
15972 @cindex @code{lognoteredeadline}, STARTUP keyword
15973 @cindex @code{nologredeadline}, STARTUP keyword
15974 @cindex @code{logrefile}, STARTUP keyword
15975 @cindex @code{lognoterefile}, STARTUP keyword
15976 @cindex @code{nologrefile}, STARTUP keyword
15977 @cindex @code{logdrawer}, STARTUP keyword
15978 @cindex @code{nologdrawer}, STARTUP keyword
15979 @cindex @code{logstatesreversed}, STARTUP keyword
15980 @cindex @code{nologstatesreversed}, STARTUP keyword
15982 logdone @r{record a timestamp when an item is marked DONE}
15983 lognotedone @r{record timestamp and a note when DONE}
15984 nologdone @r{don't record when items are marked DONE}
15985 logrepeat @r{record a time when reinstating a repeating item}
15986 lognoterepeat @r{record a note when reinstating a repeating item}
15987 nologrepeat @r{do not record when reinstating repeating item}
15988 lognoteclock-out @r{record a note when clocking out}
15989 nolognoteclock-out @r{don't record a note when clocking out}
15990 logreschedule @r{record a timestamp when scheduling time changes}
15991 lognotereschedule @r{record a note when scheduling time changes}
15992 nologreschedule @r{do not record when a scheduling date changes}
15993 logredeadline @r{record a timestamp when deadline changes}
15994 lognoteredeadline @r{record a note when deadline changes}
15995 nologredeadline @r{do not record when a deadline date changes}
15996 logrefile @r{record a timestamp when refiling}
15997 lognoterefile @r{record a note when refiling}
15998 nologrefile @r{do not record when refiling}
15999 logdrawer @r{store log into drawer}
16000 nologdrawer @r{store log outside of drawer}
16001 logstatesreversed @r{reverse the order of states notes}
16002 nologstatesreversed @r{do not reverse the order of states notes}
16005 @vindex org-hide-leading-stars
16006 @vindex org-odd-levels-only
16007 Here are the options for hiding leading stars in outline headings, and for
16008 indenting outlines. The corresponding variables are
16009 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
16010 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
16011 @cindex @code{hidestars}, STARTUP keyword
16012 @cindex @code{showstars}, STARTUP keyword
16013 @cindex @code{odd}, STARTUP keyword
16014 @cindex @code{even}, STARTUP keyword
16016 hidestars @r{make all but one of the stars starting a headline invisible.}
16017 showstars @r{show all stars starting a headline}
16018 indent @r{virtual indentation according to outline level}
16019 noindent @r{no virtual indentation according to outline level}
16020 odd @r{allow only odd outline levels (1,3,...)}
16021 oddeven @r{allow all outline levels}
16024 @vindex org-put-time-stamp-overlays
16025 @vindex org-time-stamp-overlay-formats
16026 To turn on custom format overlays over timestamps (variables
16027 @code{org-put-time-stamp-overlays} and
16028 @code{org-time-stamp-overlay-formats}), use
16029 @cindex @code{customtime}, STARTUP keyword
16031 customtime @r{overlay custom time format}
16034 @vindex constants-unit-system
16035 The following options influence the table spreadsheet (variable
16036 @code{constants-unit-system}).
16037 @cindex @code{constcgs}, STARTUP keyword
16038 @cindex @code{constSI}, STARTUP keyword
16040 constcgs @r{@file{constants.el} should use the c-g-s unit system}
16041 constSI @r{@file{constants.el} should use the SI unit system}
16044 @vindex org-footnote-define-inline
16045 @vindex org-footnote-auto-label
16046 @vindex org-footnote-auto-adjust
16047 To influence footnote settings, use the following keywords. The
16048 corresponding variables are @code{org-footnote-define-inline},
16049 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
16050 @cindex @code{fninline}, STARTUP keyword
16051 @cindex @code{nofninline}, STARTUP keyword
16052 @cindex @code{fnlocal}, STARTUP keyword
16053 @cindex @code{fnprompt}, STARTUP keyword
16054 @cindex @code{fnauto}, STARTUP keyword
16055 @cindex @code{fnconfirm}, STARTUP keyword
16056 @cindex @code{fnplain}, STARTUP keyword
16057 @cindex @code{fnadjust}, STARTUP keyword
16058 @cindex @code{nofnadjust}, STARTUP keyword
16060 fninline @r{define footnotes inline}
16061 fnnoinline @r{define footnotes in separate section}
16062 fnlocal @r{define footnotes near first reference, but not inline}
16063 fnprompt @r{prompt for footnote labels}
16064 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
16065 fnconfirm @r{offer automatic label for editing or confirmation}
16066 fnplain @r{create @code{[1]}-like labels automatically}
16067 fnadjust @r{automatically renumber and sort footnotes}
16068 nofnadjust @r{do not renumber and sort automatically}
16071 @cindex org-hide-block-startup
16072 To hide blocks on startup, use these keywords. The corresponding variable is
16073 @code{org-hide-block-startup}.
16074 @cindex @code{hideblocks}, STARTUP keyword
16075 @cindex @code{nohideblocks}, STARTUP keyword
16077 hideblocks @r{Hide all begin/end blocks on startup}
16078 nohideblocks @r{Do not hide blocks on startup}
16081 @cindex org-pretty-entities
16082 The display of entities as UTF-8 characters is governed by the variable
16083 @code{org-pretty-entities} and the keywords
16084 @cindex @code{entitiespretty}, STARTUP keyword
16085 @cindex @code{entitiesplain}, STARTUP keyword
16087 entitiespretty @r{Show entities as UTF-8 characters where possible}
16088 entitiesplain @r{Leave entities plain}
16091 @item #+TAGS: TAG1(c1) TAG2(c2)
16092 @vindex org-tag-alist
16093 These lines (several such lines are allowed) specify the valid tags in
16094 this file, and (potentially) the corresponding @emph{fast tag selection}
16095 keys. The corresponding variable is @code{org-tag-alist}.
16098 This line contains the formulas for the table directly above the line.
16100 Table can have multiple lines containing @samp{#+TBLFM:}. Note
16101 that only the first line of @samp{#+TBLFM:} will be applied when
16102 you recalculate the table. For more details see @ref{Using
16103 multiple #+TBLFM lines} in @ref{Editing and debugging formulas}.
16105 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:,
16106 @itemx #+OPTIONS:, #+BIND:,
16107 @itemx #+DESCRIPTION:, #+KEYWORDS:,
16108 @itemx #+LaTeX_HEADER:, #+LaTeX_HEADER_EXTRA:,
16109 @itemx #+HTML_HEAD:, #+HTML_HEAD_EXTRA:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
16110 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
16111 These lines provide settings for exporting files. For more details see
16112 @ref{Export settings}.
16113 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
16114 @vindex org-todo-keywords
16115 These lines set the TODO keywords and their interpretation in the
16116 current file. The corresponding variable is @code{org-todo-keywords}.
16119 @node The very busy C-c C-c key
16120 @section The very busy C-c C-c key
16122 @cindex C-c C-c, overview
16124 The key @kbd{C-c C-c} has many purposes in Org, which are all
16125 mentioned scattered throughout this manual. One specific function of
16126 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
16127 other circumstances it means something like @emph{``Hey Org, look
16128 here and update according to what you see here''}. Here is a summary of
16129 what this means in different contexts.
16133 If there are highlights in the buffer from the creation of a sparse
16134 tree, or from clock display, remove these highlights.
16136 If the cursor is in one of the special @code{#+KEYWORD} lines, this
16137 triggers scanning the buffer for these lines and updating the
16140 If the cursor is inside a table, realign the table. This command
16141 works even if the automatic table editor has been turned off.
16143 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
16146 If the current buffer is a capture buffer, close the note and file it.
16147 With a prefix argument, file it, without further interaction, to the
16150 If the cursor is on a @code{<<<target>>>}, update radio targets and
16151 corresponding links in this buffer.
16153 If the cursor is in a property line or at the start or end of a property
16154 drawer, offer property commands.
16156 If the cursor is at a footnote reference, go to the corresponding
16157 definition, and @emph{vice versa}.
16159 If the cursor is on a statistics cookie, update it.
16161 If the cursor is in a plain list item with a checkbox, toggle the status
16164 If the cursor is on a numbered item in a plain list, renumber the
16167 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
16170 If the cursor is at a timestamp, fix the day name in the timestamp.
16174 @section A cleaner outline view
16175 @cindex hiding leading stars
16176 @cindex dynamic indentation
16177 @cindex odd-levels-only outlines
16178 @cindex clean outline view
16180 Some people find it noisy and distracting that the Org headlines start with a
16181 potentially large number of stars, and that text below the headlines is not
16182 indented. While this is no problem when writing a @emph{book-like} document
16183 where the outline headings are really section headings, in a more
16184 @emph{list-oriented} outline, indented structure is a lot cleaner:
16188 * Top level headline | * Top level headline
16189 ** Second level | * Second level
16190 *** 3rd level | * 3rd level
16191 some text | some text
16192 *** 3rd level | * 3rd level
16193 more text | more text
16194 * Another top level headline | * Another top level headline
16200 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
16201 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
16202 be achieved dynamically at display time using @code{org-indent-mode}. In
16203 this minor mode, all lines are prefixed for display with the necessary amount
16204 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
16205 property, such that @code{visual-line-mode} (or purely setting
16206 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
16207 }. Also headlines are prefixed with additional stars, so that the amount of
16208 indentation shifts by two@footnote{See the variable
16209 @code{org-indent-indentation-per-level}.} spaces per level. All headline
16210 stars but the last one are made invisible using the @code{org-hide}
16211 face@footnote{Turning on @code{org-indent-mode} sets
16212 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
16213 @code{nil}.}; see below under @samp{2.} for more information on how this
16214 works. You can turn on @code{org-indent-mode} for all files by customizing
16215 the variable @code{org-startup-indented}, or you can turn it on for
16216 individual files using
16222 If you want a similar effect in an earlier version of Emacs and/or Org, or if
16223 you want the indentation to be hard space characters so that the plain text
16224 file looks as similar as possible to the Emacs display, Org supports you in
16229 @emph{Indentation of text below headlines}@*
16230 You may indent text below each headline to make the left boundary line up
16231 with the headline, like
16235 more text, now indented
16238 @vindex org-adapt-indentation
16239 Org supports this with paragraph filling, line wrapping, and structure
16240 editing@footnote{See also the variable @code{org-adapt-indentation}.},
16241 preserving or adapting the indentation as appropriate.
16244 @vindex org-hide-leading-stars
16245 @emph{Hiding leading stars}@* You can modify the display in such a way that
16246 all leading stars become invisible. To do this in a global way, configure
16247 the variable @code{org-hide-leading-stars} or change this on a per-file basis
16251 #+STARTUP: hidestars
16252 #+STARTUP: showstars
16255 With hidden stars, the tree becomes:
16259 * Top level headline
16267 @vindex org-hide @r{(face)}
16268 The leading stars are not truly replaced by whitespace, they are only
16269 fontified with the face @code{org-hide} that uses the background color as
16270 font color. If you are not using either white or black background, you may
16271 have to customize this face to get the wanted effect. Another possibility is
16272 to set this font such that the extra stars are @i{almost} invisible, for
16273 example using the color @code{grey90} on a white background.
16276 @vindex org-odd-levels-only
16277 Things become cleaner still if you skip all the even levels and use only odd
16278 levels 1, 3, 5..., effectively adding two stars to go from one outline level
16279 to the next@footnote{When you need to specify a level for a property search
16280 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
16281 way we get the outline view shown at the beginning of this section. In order
16282 to make the structure editing and export commands handle this convention
16283 correctly, configure the variable @code{org-odd-levels-only}, or set this on
16284 a per-file basis with one of the following lines:
16291 You can convert an Org file from single-star-per-level to the
16292 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
16293 RET} in that file. The reverse operation is @kbd{M-x
16294 org-convert-to-oddeven-levels}.
16298 @section Using Org on a tty
16299 @cindex tty key bindings
16301 Because Org contains a large number of commands, by default many of
16302 Org's core commands are bound to keys that are generally not
16303 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
16304 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
16305 together with modifiers like @key{Meta} and/or @key{Shift}. To access
16306 these commands on a tty when special keys are unavailable, the following
16307 alternative bindings can be used. The tty bindings below will likely be
16308 more cumbersome; you may find for some of the bindings below that a
16309 customized workaround suits you better. For example, changing a timestamp
16310 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
16311 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
16313 @multitable @columnfractions 0.15 0.2 0.1 0.2
16314 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
16315 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
16316 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
16317 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
16318 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
16319 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
16320 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
16321 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
16322 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
16323 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
16324 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
16325 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
16326 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
16327 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
16328 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
16329 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
16330 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
16331 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
16332 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
16337 @section Interaction with other packages
16338 @cindex packages, interaction with other
16339 Org lives in the world of GNU Emacs and interacts in various ways
16340 with other code out there.
16343 * Cooperation:: Packages Org cooperates with
16344 * Conflicts:: Packages that lead to conflicts
16348 @subsection Packages that Org cooperates with
16351 @cindex @file{calc.el}
16352 @cindex Gillespie, Dave
16353 @item @file{calc.el} by Dave Gillespie
16354 Org uses the Calc package for implementing spreadsheet
16355 functionality in its tables (@pxref{The spreadsheet}). Org
16356 checks for the availability of Calc by looking for the function
16357 @code{calc-eval} which will have been autoloaded during setup if Calc has
16358 been installed properly. As of Emacs 22, Calc is part of the Emacs
16359 distribution. Another possibility for interaction between the two
16360 packages is using Calc for embedded calculations. @xref{Embedded Mode,
16361 , Embedded Mode, calc, GNU Emacs Calc Manual}.
16362 @item @file{constants.el} by Carsten Dominik
16363 @cindex @file{constants.el}
16364 @cindex Dominik, Carsten
16365 @vindex org-table-formula-constants
16366 In a table formula (@pxref{The spreadsheet}), it is possible to use
16367 names for natural constants or units. Instead of defining your own
16368 constants in the variable @code{org-table-formula-constants}, install
16369 the @file{constants} package which defines a large number of constants
16370 and units, and lets you use unit prefixes like @samp{M} for
16371 @samp{Mega}, etc. You will need version 2.0 of this package, available
16372 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
16373 the function @code{constants-get}, which has to be autoloaded in your
16374 setup. See the installation instructions in the file
16375 @file{constants.el}.
16376 @item @file{cdlatex.el} by Carsten Dominik
16377 @cindex @file{cdlatex.el}
16378 @cindex Dominik, Carsten
16379 Org mode can make use of the CD@LaTeX{} package to efficiently enter
16380 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
16381 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
16382 @cindex @file{imenu.el}
16383 Imenu allows menu access to an index of items in a file. Org mode
16384 supports Imenu---all you need to do to get the index is the following:
16386 (add-hook 'org-mode-hook
16387 (lambda () (imenu-add-to-menubar "Imenu")))
16389 @vindex org-imenu-depth
16390 By default the index is two levels deep---you can modify the depth using
16391 the option @code{org-imenu-depth}.
16392 @item @file{remember.el} by John Wiegley
16393 @cindex @file{remember.el}
16394 @cindex Wiegley, John
16395 Org used to use this package for capture, but no longer does.
16396 @item @file{speedbar.el} by Eric M. Ludlam
16397 @cindex @file{speedbar.el}
16398 @cindex Ludlam, Eric M.
16399 Speedbar is a package that creates a special frame displaying files and
16400 index items in files. Org mode supports Speedbar and allows you to
16401 drill into Org files directly from the Speedbar. It also allows you to
16402 restrict the scope of agenda commands to a file or a subtree by using
16403 the command @kbd{<} in the Speedbar frame.
16404 @cindex @file{table.el}
16405 @item @file{table.el} by Takaaki Ota
16407 @cindex table editor, @file{table.el}
16408 @cindex @file{table.el}
16409 @cindex Ota, Takaaki
16411 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
16412 and alignment can be created using the Emacs table package by Takaaki Ota
16413 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
16414 Org mode will recognize these tables and export them properly. Because of
16415 interference with other Org mode functionality, you unfortunately cannot edit
16416 these tables directly in the buffer. Instead, you need to use the command
16417 @kbd{C-c '} to edit them, similar to source code snippets.
16420 @orgcmd{C-c ',org-edit-special}
16421 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
16423 @orgcmd{C-c ~,org-table-create-with-table.el}
16424 Insert a @file{table.el} table. If there is already a table at point, this
16425 command converts it between the @file{table.el} format and the Org mode
16426 format. See the documentation string of the command
16427 @code{org-convert-table} for the restrictions under which this is
16430 @file{table.el} is part of Emacs since Emacs 22.
16431 @item @file{footnote.el} by Steven L. Baur
16432 @cindex @file{footnote.el}
16433 @cindex Baur, Steven L.
16434 Org mode recognizes numerical footnotes as provided by this package.
16435 However, Org mode also has its own footnote support (@pxref{Footnotes}),
16436 which makes using @file{footnote.el} unnecessary.
16440 @subsection Packages that lead to conflicts with Org mode
16444 @cindex @code{shift-selection-mode}
16445 @vindex org-support-shift-select
16446 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
16447 cursor motions combined with the shift key should start or enlarge regions.
16448 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
16449 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
16450 at such a location. By default, @kbd{S-@key{cursor}} commands outside
16451 special contexts don't do anything, but you can customize the variable
16452 @code{org-support-shift-select}. Org mode then tries to accommodate shift
16453 selection by (i) using it outside of the special contexts where special
16454 commands apply, and by (ii) extending an existing active region even if the
16455 cursor moves across a special context.
16457 @item @file{CUA.el} by Kim. F. Storm
16458 @cindex @file{CUA.el}
16459 @cindex Storm, Kim. F.
16460 @vindex org-replace-disputed-keys
16461 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
16462 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and
16463 extend the region. In fact, Emacs 23 has this built-in in the form of
16464 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
16465 23, you probably don't want to use another package for this purpose.
16466 However, if you prefer to leave these keys to a different package while
16467 working in Org mode, configure the variable @code{org-replace-disputed-keys}.
16468 When set, Org will move the following key bindings in Org files, and in the
16469 agenda buffer (but not during date selection).
16472 S-UP @result{} M-p S-DOWN @result{} M-n
16473 S-LEFT @result{} M-- S-RIGHT @result{} M-+
16474 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
16477 @vindex org-disputed-keys
16478 Yes, these are unfortunately more difficult to remember. If you want
16479 to have other replacement keys, look at the variable
16480 @code{org-disputed-keys}.
16482 @item @file{ecomplete.el} by Lars Magne Ingebrigtsen @email{larsi@@gnus.org}
16483 @cindex @file{ecomplete.el}
16485 Ecomplete provides ``electric'' address completion in address header
16486 lines in message buffers. Sadly Orgtbl mode cuts ecompletes power
16487 supply: No completion happens when Orgtbl mode is enabled in message
16488 buffers while entering text in address header lines. If one wants to
16489 use ecomplete one should @emph{not} follow the advice to automagically
16490 turn on Orgtbl mode in message buffers (see @ref{Orgtbl mode}), but
16491 instead---after filling in the message headers---turn on Orgtbl mode
16492 manually when needed in the messages body.
16494 @item @file{filladapt.el} by Kyle Jones
16495 @cindex @file{filladapt.el}
16497 Org mode tries to do the right thing when filling paragraphs, list items and
16498 other elements. Many users reported they had problems using both
16499 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
16503 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
16506 @item @file{yasnippet.el}
16507 @cindex @file{yasnippet.el}
16508 The way Org mode binds the @key{TAB} key (binding to @code{[tab]} instead of
16509 @code{"\t"}) overrules YASnippet's access to this key. The following code
16510 fixed this problem:
16513 (add-hook 'org-mode-hook
16515 (org-set-local 'yas/trigger-key [tab])
16516 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
16519 The latest version of yasnippet doesn't play well with Org mode. If the
16520 above code does not fix the conflict, start by defining the following
16524 (defun yas/org-very-safe-expand ()
16525 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
16528 Then, tell Org mode what to do with the new function:
16531 (add-hook 'org-mode-hook
16533 (make-variable-buffer-local 'yas/trigger-key)
16534 (setq yas/trigger-key [tab])
16535 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
16536 (define-key yas/keymap [tab] 'yas/next-field)))
16539 @item @file{windmove.el} by Hovav Shacham
16540 @cindex @file{windmove.el}
16541 This package also uses the @kbd{S-<cursor>} keys, so everything written
16542 in the paragraph above about CUA mode also applies here. If you want make
16543 the windmove function active in locations where Org mode does not have
16544 special functionality on @kbd{S-@key{cursor}}, add this to your
16548 ;; Make windmove work in org-mode:
16549 (add-hook 'org-shiftup-final-hook 'windmove-up)
16550 (add-hook 'org-shiftleft-final-hook 'windmove-left)
16551 (add-hook 'org-shiftdown-final-hook 'windmove-down)
16552 (add-hook 'org-shiftright-final-hook 'windmove-right)
16555 @item @file{viper.el} by Michael Kifer
16556 @cindex @file{viper.el}
16558 Viper uses @kbd{C-c /} and therefore makes this key not access the
16559 corresponding Org mode command @code{org-sparse-tree}. You need to find
16560 another key for this command, or override the key in
16561 @code{viper-vi-global-user-map} with
16564 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
16572 @section org-crypt.el
16573 @cindex @file{org-crypt.el}
16574 @cindex @code{org-decrypt-entry}
16576 Org-crypt will encrypt the text of an entry, but not the headline, or
16577 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
16580 Any text below a headline that has a @samp{:crypt:} tag will be automatically
16581 be encrypted when the file is saved. If you want to use a different tag just
16582 customize the @code{org-crypt-tag-matcher} setting.
16584 To use org-crypt it is suggested that you have the following in your
16588 (require 'org-crypt)
16589 (org-crypt-use-before-save-magic)
16590 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
16592 (setq org-crypt-key nil)
16593 ;; GPG key to use for encryption
16594 ;; Either the Key ID or set to nil to use symmetric encryption.
16596 (setq auto-save-default nil)
16597 ;; Auto-saving does not cooperate with org-crypt.el: so you need
16598 ;; to turn it off if you plan to use org-crypt.el quite often.
16599 ;; Otherwise, you'll get an (annoying) message each time you
16602 ;; To turn it off only locally, you can insert this:
16604 ;; # -*- buffer-auto-save-file-name: nil; -*-
16607 Excluding the crypt tag from inheritance prevents already encrypted text
16608 being encrypted again.
16614 This appendix covers some areas where users can extend the functionality of
16618 * Hooks:: How to reach into Org's internals
16619 * Add-on packages:: Available extensions
16620 * Adding hyperlink types:: New custom link types
16621 * Adding export back-ends:: How to write new export back-ends
16622 * Context-sensitive commands:: How to add functionality to such commands
16623 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
16624 * Dynamic blocks:: Automatically filled blocks
16625 * Special agenda views:: Customized views
16626 * Speeding up your agendas:: Tips on how to speed up your agendas
16627 * Extracting agenda information:: Post-processing of agenda information
16628 * Using the property API:: Writing programs that use entry properties
16629 * Using the mapping API:: Mapping over all or selected entries
16636 Org has a large number of hook variables that can be used to add
16637 functionality. This appendix about hacking is going to illustrate the
16638 use of some of them. A complete list of all hooks with documentation is
16639 maintained by the Worg project and can be found at
16640 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
16642 @node Add-on packages
16643 @section Add-on packages
16644 @cindex add-on packages
16646 A large number of add-on packages have been written by various authors.
16648 These packages are not part of Emacs, but they are distributed as contributed
16649 packages with the separate release available at @uref{http://orgmode.org}.
16650 See the @file{contrib/README} file in the source code directory for a list of
16651 contributed files. You may also find some more information on the Worg page:
16652 @uref{http://orgmode.org/worg/org-contrib/}.
16654 @node Adding hyperlink types
16655 @section Adding hyperlink types
16656 @cindex hyperlinks, adding new types
16658 Org has a large number of hyperlink types built-in
16659 (@pxref{Hyperlinks}). If you would like to add new link types, Org
16660 provides an interface for doing so. Let's look at an example file,
16661 @file{org-man.el}, that will add support for creating links like
16662 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
16666 ;;; org-man.el - Support for links to manpages in Org
16670 (org-add-link-type "man" 'org-man-open)
16671 (add-hook 'org-store-link-functions 'org-man-store-link)
16673 (defcustom org-man-command 'man
16674 "The Emacs command to be used to display a man page."
16676 :type '(choice (const man) (const woman)))
16678 (defun org-man-open (path)
16679 "Visit the manpage on PATH.
16680 PATH should be a topic that can be thrown at the man command."
16681 (funcall org-man-command path))
16683 (defun org-man-store-link ()
16684 "Store a link to a manpage."
16685 (when (memq major-mode '(Man-mode woman-mode))
16686 ;; This is a man page, we do make this link
16687 (let* ((page (org-man-get-page-name))
16688 (link (concat "man:" page))
16689 (description (format "Manpage for %s" page)))
16690 (org-store-link-props
16693 :description description))))
16695 (defun org-man-get-page-name ()
16696 "Extract the page name from the buffer name."
16697 ;; This works for both `Man-mode' and `woman-mode'.
16698 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
16699 (match-string 1 (buffer-name))
16700 (error "Cannot create link to this man page")))
16704 ;;; org-man.el ends here
16708 You would activate this new link type in @file{.emacs} with
16715 Let's go through the file and see what it does.
16718 It does @code{(require 'org)} to make sure that @file{org.el} has been
16721 The next line calls @code{org-add-link-type} to define a new link type
16722 with prefix @samp{man}. The call also contains the name of a function
16723 that will be called to follow such a link.
16725 @vindex org-store-link-functions
16726 The next line adds a function to @code{org-store-link-functions}, in
16727 order to allow the command @kbd{C-c l} to record a useful link in a
16728 buffer displaying a man page.
16731 The rest of the file defines the necessary variables and functions.
16732 First there is a customization variable that determines which Emacs
16733 command should be used to display man pages. There are two options,
16734 @code{man} and @code{woman}. Then the function to follow a link is
16735 defined. It gets the link path as an argument---in this case the link
16736 path is just a topic for the manual command. The function calls the
16737 value of @code{org-man-command} to display the man page.
16739 Finally the function @code{org-man-store-link} is defined. When you try
16740 to store a link with @kbd{C-c l}, this function will be called to
16741 try to make a link. The function must first decide if it is supposed to
16742 create the link for this buffer type; we do this by checking the value
16743 of the variable @code{major-mode}. If not, the function must exit and
16744 return the value @code{nil}. If yes, the link is created by getting the
16745 manual topic from the buffer name and prefixing it with the string
16746 @samp{man:}. Then it must call the command @code{org-store-link-props}
16747 and set the @code{:type} and @code{:link} properties. Optionally you
16748 can also set the @code{:description} property to provide a default for
16749 the link description when the link is later inserted into an Org
16750 buffer with @kbd{C-c C-l}.
16752 When it makes sense for your new link type, you may also define a function
16753 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
16754 support for inserting such a link with @kbd{C-c C-l}. Such a function should
16755 not accept any arguments, and return the full link with prefix.
16757 @node Adding export back-ends
16758 @section Adding export back-ends
16759 @cindex Export, writing back-ends
16761 Org 8.0 comes with a completely rewritten export engine which makes it easy
16762 to write new export back-ends, either from scratch, or by deriving them
16763 from existing ones.
16765 Your two entry points are respectively @code{org-export-define-backend} and
16766 @code{org-export-define-derived-backend}. To grok these functions, you
16767 should first have a look at @file{ox-latex.el} (for how to define a new
16768 back-end from scratch) and @file{ox-beamer.el} (for how to derive a new
16769 back-end from an existing one.
16771 When creating a new back-end from scratch, the basic idea is to set the name
16772 of the back-end (as a symbol) and an an alist of elements and export
16773 functions. On top of this, you will need to set additional keywords like
16774 @code{:menu-entry} (to display the back-end in the export dispatcher),
16775 @code{:export-block} (to specify what blocks should not be exported by this
16776 back-end), and @code{:options-alist} (to let the user set export options that
16777 are specific to this back-end.)
16779 Deriving a new back-end is similar, except that you need to set
16780 @code{:translate-alist} to an alist of export functions that should be used
16781 instead of the parent back-end functions.
16783 For a complete reference documentation, see
16784 @url{http://orgmode.org/worg/dev/org-export-reference.html, the Org Export
16785 Reference on Worg}.
16787 @node Context-sensitive commands
16788 @section Context-sensitive commands
16789 @cindex context-sensitive commands, hooks
16790 @cindex add-ons, context-sensitive commands
16791 @vindex org-ctrl-c-ctrl-c-hook
16793 Org has several commands that act differently depending on context. The most
16794 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
16795 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
16797 Add-ons can tap into this functionality by providing a function that detects
16798 special context for that add-on and executes functionality appropriate for
16799 the context. Here is an example from Dan Davison's @file{org-R.el} which
16800 allows you to evaluate commands based on the @file{R} programming language
16801 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
16802 described in @ref{Working with source code} and is now obsolete.}. For this
16803 package, special contexts are lines that start with @code{#+R:} or
16807 (defun org-R-apply-maybe ()
16808 "Detect if this is context for org-R and execute R commands."
16809 (if (save-excursion
16810 (beginning-of-line 1)
16811 (looking-at "#\\+RR?:"))
16812 (progn (call-interactively 'org-R-apply)
16813 t) ;; to signal that we took action
16814 nil)) ;; to signal that we did not
16816 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
16819 The function first checks if the cursor is in such a line. If that is the
16820 case, @code{org-R-apply} is called and the function returns @code{t} to
16821 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
16822 contexts. If the function finds it should do nothing locally, it returns
16823 @code{nil} so that other, similar functions can have a try.
16826 @node Tables in arbitrary syntax
16827 @section Tables and lists in arbitrary syntax
16828 @cindex tables, in other modes
16829 @cindex lists, in other modes
16830 @cindex Orgtbl mode
16832 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
16833 frequent feature request has been to make it work with native tables in
16834 specific languages, for example @LaTeX{}. However, this is extremely
16835 hard to do in a general way, would lead to a customization nightmare,
16836 and would take away much of the simplicity of the Orgtbl mode table
16839 This appendix describes a different approach. We keep the Orgtbl mode
16840 table in its native format (the @i{source table}), and use a custom
16841 function to @i{translate} the table to the correct syntax, and to
16842 @i{install} it in the right location (the @i{target table}). This puts
16843 the burden of writing conversion functions on the user, but it allows
16844 for a very flexible system.
16846 Bastien added the ability to do the same with lists, in Orgstruct mode. You
16847 can use Org's facilities to edit and structure lists by turning
16848 @code{orgstruct-mode} on, then locally exporting such lists in another format
16849 (HTML, @LaTeX{} or Texinfo.)
16853 * Radio tables:: Sending and receiving radio tables
16854 * A @LaTeX{} example:: Step by step, almost a tutorial
16855 * Translator functions:: Copy and modify
16856 * Radio lists:: Sending and receiving lists
16860 @subsection Radio tables
16861 @cindex radio tables
16863 To define the location of the target table, you first need to create two
16864 lines that are comments in the current mode, but contain magic words
16865 @code{BEGIN/END RECEIVE ORGTBL} for Orgtbl mode to find. Orgtbl mode will
16866 insert the translated table between these lines, replacing whatever was there
16867 before. For example in C mode where comments are between @code{/* ... */}:
16870 /* BEGIN RECEIVE ORGTBL table_name */
16871 /* END RECEIVE ORGTBL table_name */
16875 Just above the source table, we put a special line that tells
16876 Orgtbl mode how to translate this table and where to install it. For
16880 #+ORGTBL: SEND table_name translation_function arguments....
16884 @code{table_name} is the reference name for the table that is also used
16885 in the receiver lines. @code{translation_function} is the Lisp function
16886 that does the translation. Furthermore, the line can contain a list of
16887 arguments (alternating key and value) at the end. The arguments will be
16888 passed as a property list to the translation function for
16889 interpretation. A few standard parameters are already recognized and
16890 acted upon before the translation function is called:
16894 Skip the first N lines of the table. Hlines do count as separate lines for
16897 @item :skipcols (n1 n2 ...)
16898 List of columns that should be skipped. If the table has a column with
16899 calculation marks, that column is automatically discarded as well.
16900 Please note that the translator function sees the table @emph{after} the
16901 removal of these columns, the function never knows that there have been
16902 additional columns.
16905 When non-@code{nil}, do not escape special characters @code{&%#_^} when exporting
16906 the table. The default value is @code{nil}.
16910 The one problem remaining is how to keep the source table in the buffer
16911 without disturbing the normal workings of the file, for example during
16912 compilation of a C file or processing of a @LaTeX{} file. There are a
16913 number of different solutions:
16917 The table could be placed in a block comment if that is supported by the
16918 language. For example, in C mode you could wrap the table between
16919 @samp{/*} and @samp{*/} lines.
16921 Sometimes it is possible to put the table after some kind of @i{END}
16922 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
16925 You can just comment the table line-by-line whenever you want to process
16926 the file, and uncomment it whenever you need to edit the table. This
16927 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment RET}
16928 makes this comment-toggling very easy, in particular if you bind it to a
16932 @node A @LaTeX{} example
16933 @subsection A @LaTeX{} example of radio tables
16934 @cindex @LaTeX{}, and Orgtbl mode
16936 The best way to wrap the source table in @LaTeX{} is to use the
16937 @code{comment} environment provided by @file{comment.sty}. It has to be
16938 activated by placing @code{\usepackage@{comment@}} into the document
16939 header. Orgtbl mode can insert a radio table skeleton@footnote{By
16940 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
16941 variable @code{orgtbl-radio-table-templates} to install templates for other
16942 modes.} with the command @kbd{M-x orgtbl-insert-radio-table RET}. You will
16943 be prompted for a table name, let's say we use @samp{salesfigures}. You
16944 will then get the following template:
16946 @cindex #+ORGTBL, SEND
16948 % BEGIN RECEIVE ORGTBL salesfigures
16949 % END RECEIVE ORGTBL salesfigures
16951 #+ORGTBL: SEND salesfigures orgtbl-to-latex
16957 @vindex @LaTeX{}-verbatim-environments
16958 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
16959 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
16960 into the receiver location with name @code{salesfigures}. You may now
16961 fill in the table---feel free to use the spreadsheet features@footnote{If
16962 the @samp{#+TBLFM} line contains an odd number of dollar characters,
16963 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
16964 example you can fix this by adding an extra line inside the
16965 @code{comment} environment that is used to balance the dollar
16966 expressions. If you are using AUC@TeX{} with the font-latex library, a
16967 much better solution is to add the @code{comment} environment to the
16968 variable @code{LaTeX-verbatim-environments}.}:
16971 % BEGIN RECEIVE ORGTBL salesfigures
16972 % END RECEIVE ORGTBL salesfigures
16974 #+ORGTBL: SEND salesfigures orgtbl-to-latex
16975 | Month | Days | Nr sold | per day |
16976 |-------+------+---------+---------|
16977 | Jan | 23 | 55 | 2.4 |
16978 | Feb | 21 | 16 | 0.8 |
16979 | March | 22 | 278 | 12.6 |
16980 #+TBLFM: $4=$3/$2;%.1f
16981 % $ (optional extra dollar to keep font-lock happy, see footnote)
16986 When you are done, press @kbd{C-c C-c} in the table to get the converted
16987 table inserted between the two marker lines.
16989 Now let's assume you want to make the table header by hand, because you
16990 want to control how columns are aligned, etc. In this case we make sure
16991 that the table translator skips the first 2 lines of the source
16992 table, and tell the command to work as a @i{splice}, i.e., to not produce
16993 header and footer commands of the target table:
16996 \begin@{tabular@}@{lrrr@}
16997 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
16998 % BEGIN RECEIVE ORGTBL salesfigures
16999 % END RECEIVE ORGTBL salesfigures
17003 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
17004 | Month | Days | Nr sold | per day |
17005 |-------+------+---------+---------|
17006 | Jan | 23 | 55 | 2.4 |
17007 | Feb | 21 | 16 | 0.8 |
17008 | March | 22 | 278 | 12.6 |
17009 #+TBLFM: $4=$3/$2;%.1f
17013 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
17014 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
17015 and marks horizontal lines with @code{\hline}. Furthermore, it
17016 interprets the following parameters (see also @pxref{Translator functions}):
17019 @item :splice nil/t
17020 When set to t, return only table body lines, don't wrap them into a
17021 tabular environment. Default is @code{nil}.
17024 A format to be used to wrap each field, it should contain @code{%s} for the
17025 original field value. For example, to wrap each field value in dollars,
17026 you could use @code{:fmt "$%s$"}. This may also be a property list with
17027 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
17028 A function of one argument can be used in place of the strings; the
17029 function must return a formatted string.
17032 Use this format to print numbers with exponentials. The format should
17033 have @code{%s} twice for inserting mantissa and exponent, for example
17034 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
17035 may also be a property list with column numbers and formats, for example
17036 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
17037 @code{efmt} has been applied to a value, @code{fmt} will also be
17038 applied. Similar to @code{fmt}, functions of two arguments can be
17039 supplied instead of strings.
17042 @node Translator functions
17043 @subsection Translator functions
17044 @cindex HTML, and Orgtbl mode
17045 @cindex translator function
17047 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
17048 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
17049 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
17050 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
17051 code that produces tables during HTML export.}, these all use a generic
17052 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
17053 itself is a very short function that computes the column definitions for the
17054 @code{tabular} environment, defines a few field and line separators and then
17055 hands processing over to the generic translator. Here is the entire code:
17059 (defun orgtbl-to-latex (table params)
17060 "Convert the Orgtbl mode TABLE to LaTeX."
17061 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
17062 org-table-last-alignment ""))
17065 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
17066 :tend "\\end@{tabular@}"
17067 :lstart "" :lend " \\\\" :sep " & "
17068 :efmt "%s\\,(%s)" :hline "\\hline")))
17069 (orgtbl-to-generic table (org-combine-plists params2 params))))
17073 As you can see, the properties passed into the function (variable
17074 @var{PARAMS}) are combined with the ones newly defined in the function
17075 (variable @var{PARAMS2}). The ones passed into the function (i.e., the
17076 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
17077 would like to use the @LaTeX{} translator, but wanted the line endings to
17078 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
17079 overrule the default with
17082 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
17085 For a new language, you can either write your own converter function in
17086 analogy with the @LaTeX{} translator, or you can use the generic function
17087 directly. For example, if you have a language where a table is started
17088 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
17089 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
17090 separator is a TAB, you could call the generic translator like this (on
17094 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
17095 :lstart "!BL! " :lend " !EL!" :sep "\t"
17099 Please check the documentation string of the function
17100 @code{orgtbl-to-generic} for a full list of parameters understood by
17101 that function, and remember that you can pass each of them into
17102 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
17103 using the generic function.
17105 Of course you can also write a completely new function doing complicated
17106 things the generic translator cannot do. A translator function takes
17107 two arguments. The first argument is the table, a list of lines, each
17108 line either the symbol @code{hline} or a list of fields. The second
17109 argument is the property list containing all parameters specified in the
17110 @samp{#+ORGTBL: SEND} line. The function must return a single string
17111 containing the formatted table. If you write a generally useful
17112 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
17113 others can benefit from your work.
17116 @subsection Radio lists
17117 @cindex radio lists
17118 @cindex org-list-insert-radio-list
17120 Sending and receiving radio lists works exactly the same way as sending and
17121 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
17122 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
17123 @code{org-list-insert-radio-list}.
17125 Here are the differences with radio tables:
17129 Orgstruct mode must be active.
17131 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
17133 The available translation functions for radio lists don't take
17136 @kbd{C-c C-c} will work when pressed on the first item of the list.
17139 Here is a @LaTeX{} example. Let's say that you have this in your
17144 % BEGIN RECEIVE ORGLST to-buy
17145 % END RECEIVE ORGLST to-buy
17147 #+ORGLST: SEND to-buy org-list-to-latex
17156 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
17157 @LaTeX{} list between the two marker lines.
17159 @node Dynamic blocks
17160 @section Dynamic blocks
17161 @cindex dynamic blocks
17163 Org documents can contain @emph{dynamic blocks}. These are
17164 specially marked regions that are updated by some user-written function.
17165 A good example for such a block is the clock table inserted by the
17166 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
17168 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
17169 to the block and can also specify parameters for the function producing
17170 the content of the block.
17172 @cindex #+BEGIN:dynamic block
17174 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
17179 Dynamic blocks are updated with the following commands
17182 @orgcmd{C-c C-x C-u,org-dblock-update}
17183 Update dynamic block at point.
17184 @orgkey{C-u C-c C-x C-u}
17185 Update all dynamic blocks in the current file.
17188 Updating a dynamic block means to remove all the text between BEGIN and
17189 END, parse the BEGIN line for parameters and then call the specific
17190 writer function for this block to insert the new content. If you want
17191 to use the original content in the writer function, you can use the
17192 extra parameter @code{:content}.
17194 For a block with name @code{myblock}, the writer function is
17195 @code{org-dblock-write:myblock} with as only parameter a property list
17196 with the parameters given in the begin line. Here is a trivial example
17197 of a block that keeps track of when the block update function was last
17201 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
17207 The corresponding block writer function could look like this:
17210 (defun org-dblock-write:block-update-time (params)
17211 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
17212 (insert "Last block update at: "
17213 (format-time-string fmt (current-time)))))
17216 If you want to make sure that all dynamic blocks are always up-to-date,
17217 you could add the function @code{org-update-all-dblocks} to a hook, for
17218 example @code{before-save-hook}. @code{org-update-all-dblocks} is
17219 written in a way such that it does nothing in buffers that are not in
17222 You can narrow the current buffer to the current dynamic block (like any
17223 other block) with @code{org-narrow-to-block}.
17225 @node Special agenda views
17226 @section Special agenda views
17227 @cindex agenda views, user-defined
17229 @vindex org-agenda-skip-function
17230 @vindex org-agenda-skip-function-global
17231 Org provides a special hook that can be used to narrow down the selection
17232 made by these agenda views: @code{agenda}, @code{agenda*}@footnote{The
17233 @code{agenda*} view is the same as @code{agenda} except that it only
17234 considers @emph{appointments}, i.e., scheduled and deadline items that have a
17235 time specification @code{[h]h:mm} in their time-stamps.}, @code{todo},
17236 @code{alltodo}, @code{tags}, @code{tags-todo}, @code{tags-tree}. You may
17237 specify a function that is used at each match to verify if the match should
17238 indeed be part of the agenda view, and if not, how much should be skipped.
17239 You can specify a global condition that will be applied to all agenda views,
17240 this condition would be stored in the variable
17241 @code{org-agenda-skip-function-global}. More commonly, such a definition is
17242 applied only to specific custom searches, using
17243 @code{org-agenda-skip-function}.
17245 Let's say you want to produce a list of projects that contain a WAITING
17246 tag anywhere in the project tree. Let's further assume that you have
17247 marked all tree headings that define a project with the TODO keyword
17248 PROJECT@. In this case you would run a TODO search for the keyword
17249 PROJECT, but skip the match unless there is a WAITING tag anywhere in
17250 the subtree belonging to the project line.
17252 To achieve this, you must write a function that searches the subtree for
17253 the tag. If the tag is found, the function must return @code{nil} to
17254 indicate that this match should not be skipped. If there is no such
17255 tag, return the location of the end of the subtree, to indicate that
17256 search should continue from there.
17259 (defun my-skip-unless-waiting ()
17260 "Skip trees that are not waiting"
17261 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
17262 (if (re-search-forward ":waiting:" subtree-end t)
17263 nil ; tag found, do not skip
17264 subtree-end))) ; tag not found, continue after end of subtree
17267 Now you may use this function in an agenda custom command, for example
17271 (org-add-agenda-custom-command
17272 '("b" todo "PROJECT"
17273 ((org-agenda-skip-function 'my-skip-unless-waiting)
17274 (org-agenda-overriding-header "Projects waiting for something: "))))
17277 @vindex org-agenda-overriding-header
17278 Note that this also binds @code{org-agenda-overriding-header} to get a
17279 meaningful header in the agenda view.
17281 @vindex org-odd-levels-only
17282 @vindex org-agenda-skip-function
17283 A general way to create custom searches is to base them on a search for
17284 entries with a certain level limit. If you want to study all entries with
17285 your custom search function, simply do a search for
17286 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
17287 level number corresponds to order in the hierarchy, not to the number of
17288 stars.}, and then use @code{org-agenda-skip-function} to select the entries
17289 you really want to have.
17291 You may also put a Lisp form into @code{org-agenda-skip-function}. In
17292 particular, you may use the functions @code{org-agenda-skip-entry-if}
17293 and @code{org-agenda-skip-subtree-if} in this form, for example:
17296 @item (org-agenda-skip-entry-if 'scheduled)
17297 Skip current entry if it has been scheduled.
17298 @item (org-agenda-skip-entry-if 'notscheduled)
17299 Skip current entry if it has not been scheduled.
17300 @item (org-agenda-skip-entry-if 'deadline)
17301 Skip current entry if it has a deadline.
17302 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
17303 Skip current entry if it has a deadline, or if it is scheduled.
17304 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
17305 Skip current entry if the TODO keyword is TODO or WAITING.
17306 @item (org-agenda-skip-entry-if 'todo 'done)
17307 Skip current entry if the TODO keyword marks a DONE state.
17308 @item (org-agenda-skip-entry-if 'timestamp)
17309 Skip current entry if it has any timestamp, may also be deadline or scheduled.
17310 @anchor{x-agenda-skip-entry-regexp}
17311 @item (org-agenda-skip-entry-if 'regexp "regular expression")
17312 Skip current entry if the regular expression matches in the entry.
17313 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
17314 Skip current entry unless the regular expression matches.
17315 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
17316 Same as above, but check and skip the entire subtree.
17319 Therefore we could also have written the search for WAITING projects
17320 like this, even without defining a special function:
17323 (org-add-agenda-custom-command
17324 '("b" todo "PROJECT"
17325 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
17326 'regexp ":waiting:"))
17327 (org-agenda-overriding-header "Projects waiting for something: "))))
17330 @node Speeding up your agendas
17331 @section Speeding up your agendas
17332 @cindex agenda views, optimization
17334 When your Org files grow in both number and size, agenda commands may start
17335 to become slow. Below are some tips on how to speed up the agenda commands.
17339 Reduce the number of Org agenda files: this will reduce the slowdown caused
17340 by accessing a hard drive.
17342 Reduce the number of DONE and archived headlines: this way the agenda does
17343 not need to skip them.
17345 @vindex org-agenda-dim-blocked-tasks
17346 Inhibit the dimming of blocked tasks:
17348 (setq org-agenda-dim-blocked-tasks nil)
17351 @vindex org-startup-folded
17352 @vindex org-agenda-inhibit-startup
17353 Inhibit agenda files startup options:
17355 (setq org-agenda-inhibit-startup nil)
17358 @vindex org-agenda-show-inherited-tags
17359 @vindex org-agenda-use-tag-inheritance
17360 Disable tag inheritance in agenda:
17362 (setq org-agenda-use-tag-inheritance nil)
17366 You can set these options for specific agenda views only. See the docstrings
17367 of these variables for details on why they affect the agenda generation, and
17368 this @uref{http://orgmode.org/worg/agenda-optimization.html, dedicated Worg
17369 page} for further explanations.
17371 @node Extracting agenda information
17372 @section Extracting agenda information
17373 @cindex agenda, pipe
17374 @cindex Scripts, for agenda processing
17376 @vindex org-agenda-custom-commands
17377 Org provides commands to access agenda information for the command
17378 line in Emacs batch mode. This extracted information can be sent
17379 directly to a printer, or it can be read by a program that does further
17380 processing of the data. The first of these commands is the function
17381 @code{org-batch-agenda}, that produces an agenda view and sends it as
17382 ASCII text to STDOUT@. The command takes a single string as parameter.
17383 If the string has length 1, it is used as a key to one of the commands
17384 you have configured in @code{org-agenda-custom-commands}, basically any
17385 key you can use after @kbd{C-c a}. For example, to directly print the
17386 current TODO list, you could use
17389 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
17392 If the parameter is a string with 2 or more characters, it is used as a
17393 tags/TODO match string. For example, to print your local shopping list
17394 (all items with the tag @samp{shop}, but excluding the tag
17395 @samp{NewYork}), you could use
17398 emacs -batch -l ~/.emacs \
17399 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
17403 You may also modify parameters on the fly like this:
17406 emacs -batch -l ~/.emacs \
17407 -eval '(org-batch-agenda "a" \
17408 org-agenda-span (quote month) \
17409 org-agenda-include-diary nil \
17410 org-agenda-files (quote ("~/org/project.org")))' \
17415 which will produce a 30-day agenda, fully restricted to the Org file
17416 @file{~/org/projects.org}, not even including the diary.
17418 If you want to process the agenda data in more sophisticated ways, you
17419 can use the command @code{org-batch-agenda-csv} to get a comma-separated
17420 list of values for each agenda item. Each line in the output will
17421 contain a number of fields separated by commas. The fields in a line
17425 category @r{The category of the item}
17426 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
17427 type @r{The type of the agenda entry, can be}
17428 todo @r{selected in TODO match}
17429 tagsmatch @r{selected in tags match}
17430 diary @r{imported from diary}
17431 deadline @r{a deadline}
17432 scheduled @r{scheduled}
17433 timestamp @r{appointment, selected by timestamp}
17434 closed @r{entry was closed on date}
17435 upcoming-deadline @r{warning about nearing deadline}
17436 past-scheduled @r{forwarded scheduled item}
17437 block @r{entry has date block including date}
17438 todo @r{The TODO keyword, if any}
17439 tags @r{All tags including inherited ones, separated by colons}
17440 date @r{The relevant date, like 2007-2-14}
17441 time @r{The time, like 15:00-16:50}
17442 extra @r{String with extra planning info}
17443 priority-l @r{The priority letter if any was given}
17444 priority-n @r{The computed numerical priority}
17448 Time and date will only be given if a timestamp (or deadline/scheduled)
17449 led to the selection of the item.
17451 A CSV list like this is very easy to use in a post-processing script.
17452 For example, here is a Perl program that gets the TODO list from
17453 Emacs/Org and prints all the items, preceded by a checkbox:
17458 # define the Emacs command to run
17459 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
17461 # run it and capture the output
17462 $agenda = qx@{$cmd 2>/dev/null@};
17464 # loop over all lines
17465 foreach $line (split(/\n/,$agenda)) @{
17466 # get the individual values
17467 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
17468 $priority_l,$priority_n) = split(/,/,$line);
17469 # process and print
17470 print "[ ] $head\n";
17474 @node Using the property API
17475 @section Using the property API
17476 @cindex API, for properties
17477 @cindex properties, API
17479 Here is a description of the functions that can be used to work with
17482 @defun org-entry-properties &optional pom which
17483 Get all properties of the entry at point-or-marker POM.@*
17484 This includes the TODO keyword, the tags, time strings for deadline,
17485 scheduled, and clocking, and any additional properties defined in the
17486 entry. The return value is an alist. Keys may occur multiple times
17487 if the property key was used several times.@*
17488 POM may also be @code{nil}, in which case the current entry is used.
17489 If WHICH is @code{nil} or `all', get all properties. If WHICH is
17490 `special' or `standard', only get that subclass.
17492 @vindex org-use-property-inheritance
17493 @findex org-insert-property-drawer
17494 @defun org-entry-get pom property &optional inherit
17495 Get value of @code{PROPERTY} for entry at point-or-marker @code{POM}@. By default,
17496 this only looks at properties defined locally in the entry. If @code{INHERIT}
17497 is non-@code{nil} and the entry does not have the property, then also check
17498 higher levels of the hierarchy. If @code{INHERIT} is the symbol
17499 @code{selective}, use inheritance if and only if the setting of
17500 @code{org-use-property-inheritance} selects @code{PROPERTY} for inheritance.
17503 @defun org-entry-delete pom property
17504 Delete the property @code{PROPERTY} from entry at point-or-marker POM.
17507 @defun org-entry-put pom property value
17508 Set @code{PROPERTY} to @code{VALUE} for entry at point-or-marker POM.
17511 @defun org-buffer-property-keys &optional include-specials
17512 Get all property keys in the current buffer.
17515 @defun org-insert-property-drawer
17516 Insert a property drawer for the current entry. Also
17519 @defun org-entry-put-multivalued-property pom property &rest values
17520 Set @code{PROPERTY} at point-or-marker @code{POM} to @code{VALUES}@.
17521 @code{VALUES} should be a list of strings. They will be concatenated, with
17522 spaces as separators.
17525 @defun org-entry-get-multivalued-property pom property
17526 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17527 list of values and return the values as a list of strings.
17530 @defun org-entry-add-to-multivalued-property pom property value
17531 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17532 list of values and make sure that @code{VALUE} is in this list.
17535 @defun org-entry-remove-from-multivalued-property pom property value
17536 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17537 list of values and make sure that @code{VALUE} is @emph{not} in this list.
17540 @defun org-entry-member-in-multivalued-property pom property value
17541 Treat the value of the property @code{PROPERTY} as a whitespace-separated
17542 list of values and check if @code{VALUE} is in this list.
17545 @defopt org-property-allowed-value-functions
17546 Hook for functions supplying allowed values for a specific property.
17547 The functions must take a single argument, the name of the property, and
17548 return a flat list of allowed values. If @samp{:ETC} is one of
17549 the values, use the values as completion help, but allow also other values
17550 to be entered. The functions must return @code{nil} if they are not
17551 responsible for this property.
17554 @node Using the mapping API
17555 @section Using the mapping API
17556 @cindex API, for mapping
17557 @cindex mapping entries, API
17559 Org has sophisticated mapping capabilities to find all entries satisfying
17560 certain criteria. Internally, this functionality is used to produce agenda
17561 views, but there is also an API that can be used to execute arbitrary
17562 functions for each or selected entries. The main entry point for this API
17565 @defun org-map-entries func &optional match scope &rest skip
17566 Call @code{FUNC} at each headline selected by @code{MATCH} in @code{SCOPE}.
17568 @code{FUNC} is a function or a Lisp form. The function will be called
17569 without arguments, with the cursor positioned at the beginning of the
17570 headline. The return values of all calls to the function will be collected
17571 and returned as a list.
17573 The call to @code{FUNC} will be wrapped into a save-excursion form, so
17574 @code{FUNC} does not need to preserve point. After evaluation, the cursor
17575 will be moved to the end of the line (presumably of the headline of the
17576 processed entry) and search continues from there. Under some circumstances,
17577 this may not produce the wanted results. For example, if you have removed
17578 (e.g., archived) the current (sub)tree it could mean that the next entry will
17579 be skipped entirely. In such cases, you can specify the position from where
17580 search should continue by making @code{FUNC} set the variable
17581 @code{org-map-continue-from} to the desired buffer position.
17583 @code{MATCH} is a tags/property/todo match as it is used in the agenda match
17584 view. Only headlines that are matched by this query will be considered
17585 during the iteration. When @code{MATCH} is @code{nil} or @code{t}, all
17586 headlines will be visited by the iteration.
17588 @code{SCOPE} determines the scope of this command. It can be any of:
17591 nil @r{the current buffer, respecting the restriction if any}
17592 tree @r{the subtree started with the entry at point}
17593 region @r{The entries within the active region, if any}
17594 file @r{the current buffer, without restriction}
17596 @r{the current buffer, and any archives associated with it}
17597 agenda @r{all agenda files}
17598 agenda-with-archives
17599 @r{all agenda files with any archive files associated with them}
17601 @r{if this is a list, all files in the list will be scanned}
17604 The remaining args are treated as settings for the skipping facilities of
17605 the scanner. The following items can be given here:
17607 @vindex org-agenda-skip-function
17609 archive @r{skip trees with the archive tag}
17610 comment @r{skip trees with the COMMENT keyword}
17611 function or Lisp form
17612 @r{will be used as value for @code{org-agenda-skip-function},}
17613 @r{so whenever the function returns t, FUNC}
17614 @r{will not be called for that entry and search will}
17615 @r{continue from the point where the function leaves it}
17619 The function given to that mapping routine can really do anything you like.
17620 It can use the property API (@pxref{Using the property API}) to gather more
17621 information about the entry, or in order to change metadata in the entry.
17622 Here are a couple of functions that might be handy:
17624 @defun org-todo &optional arg
17625 Change the TODO state of the entry. See the docstring of the functions for
17626 the many possible values for the argument @code{ARG}.
17629 @defun org-priority &optional action
17630 Change the priority of the entry. See the docstring of this function for the
17631 possible values for @code{ACTION}.
17634 @defun org-toggle-tag tag &optional onoff
17635 Toggle the tag @code{TAG} in the current entry. Setting @code{ONOFF} to
17636 either @code{on} or @code{off} will not toggle tag, but ensure that it is
17641 Promote the current entry.
17645 Demote the current entry.
17648 Here is a simple example that will turn all entries in the current file with
17649 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
17650 Entries in comment trees and in archive trees will be ignored.
17654 '(org-todo "UPCOMING")
17655 "+TOMORROW" 'file 'archive 'comment)
17658 The following example counts the number of entries with TODO keyword
17659 @code{WAITING}, in all agenda files.
17662 (length (org-map-entries t "/+WAITING" 'agenda))
17666 @appendix MobileOrg
17670 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
17671 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
17672 capture support for an Org mode system rooted on a ``real'' computer. It
17673 also allows you to record changes to existing entries. The
17674 @uref{https://github.com/MobileOrg/, iOS implementation} for the
17675 @i{iPhone/iPod Touch/iPad} series of devices, was started by Richard Moreland
17676 and is now in the hands Sean Escriva. Android users should check out
17677 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
17678 by Matt Jones. The two implementations are not identical but offer similar
17681 This appendix describes the support Org has for creating agenda views in a
17682 format that can be displayed by @i{MobileOrg}, and for integrating notes
17683 captured and changes made by @i{MobileOrg} into the main system.
17685 For changing tags and TODO states in MobileOrg, you should have set up the
17686 customization variables @code{org-todo-keywords} and @code{org-tag-alist} to
17687 cover all important tags and TODO keywords, even if individual files use only
17688 part of these. MobileOrg will also offer you states and tags set up with
17689 in-buffer settings, but it will understand the logistics of TODO state
17690 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
17691 (@pxref{Setting tags}) only for those set in these variables.
17694 * Setting up the staging area:: Where to interact with the mobile device
17695 * Pushing to MobileOrg:: Uploading Org files and agendas
17696 * Pulling from MobileOrg:: Integrating captured and flagged items
17699 @node Setting up the staging area
17700 @section Setting up the staging area
17702 MobileOrg needs to interact with Emacs through a directory on a server. If
17703 you are using a public server, you should consider encrypting the files that
17704 are uploaded to the server. This can be done with Org mode 7.02 and with
17705 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
17706 installation on your system. To turn on encryption, set a password in
17707 @i{MobileOrg} and, on the Emacs side, configure the variable
17708 @code{org-mobile-use-encryption}@footnote{If you can safely store the
17709 password in your Emacs setup, you might also want to configure
17710 @code{org-mobile-encryption-password}. Please read the docstring of that
17711 variable. Note that encryption will apply only to the contents of the
17712 @file{.org} files. The file names themselves will remain visible.}.
17714 The easiest way to create that directory is to use a free
17715 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
17716 Dropbox, or if your version of MobileOrg does not support it, you can use a
17717 webdav server. For more information, check out the documentation of MobileOrg and also this
17718 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
17719 When MobileOrg first connects to your Dropbox, it will create a directory
17720 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
17724 (setq org-mobile-directory "~/Dropbox/MobileOrg")
17727 Org mode has commands to put files for @i{MobileOrg} into that directory,
17728 and to read captured notes from there.
17730 @node Pushing to MobileOrg
17731 @section Pushing to MobileOrg
17733 This operation copies all files currently listed in @code{org-mobile-files}
17734 to the directory @code{org-mobile-directory}. By default this list contains
17735 all agenda files (as listed in @code{org-agenda-files}), but additional files
17736 can be included by customizing @code{org-mobile-files}. File names will be
17737 staged with paths relative to @code{org-directory}, so all files should be
17738 inside this directory@footnote{Symbolic links in @code{org-directory} need to
17739 have the same name as their targets.}.
17741 The push operation also creates a special Org file @file{agendas.org} with
17742 all custom agenda view defined by the user@footnote{While creating the
17743 agendas, Org mode will force ID properties on all referenced entries, so that
17744 these entries can be uniquely identified if @i{MobileOrg} flags them for
17745 further action. If you do not want to get these properties in so many
17746 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
17747 to @code{nil}. Org mode will then rely on outline paths, in the hope that
17748 these will be unique enough.}.
17750 Finally, Org writes the file @file{index.org}, containing links to all other
17751 files. @i{MobileOrg} first reads this file from the server, and then
17752 downloads all agendas and Org files listed in it. To speed up the download,
17753 MobileOrg will only read files whose checksums@footnote{Checksums are stored
17754 automatically in the file @file{checksums.dat}} have changed.
17756 @node Pulling from MobileOrg
17757 @section Pulling from MobileOrg
17759 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
17760 files for viewing. It also appends captured entries and pointers to flagged
17761 and changed entries to the file @file{mobileorg.org} on the server. Org has
17762 a @emph{pull} operation that integrates this information into an inbox file
17763 and operates on the pointers to flagged entries. Here is how it works:
17767 Org moves all entries found in
17768 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
17769 operation.} and appends them to the file pointed to by the variable
17770 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
17771 will be a top-level entry in the inbox file.
17773 After moving the entries, Org will attempt to implement the changes made in
17774 @i{MobileOrg}. Some changes are applied directly and without user
17775 interaction. Examples are all changes to tags, TODO state, headline and body
17776 text that can be cleanly applied. Entries that have been flagged for further
17777 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
17778 again. When there is a problem finding an entry or applying the change, the
17779 pointer entry will remain in the inbox and will be marked with an error
17780 message. You need to later resolve these issues by hand.
17782 Org will then generate an agenda view with all flagged entries. The user
17783 should then go through these entries and do whatever actions are necessary.
17784 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
17785 will be displayed in the echo area when the cursor is on the corresponding
17791 Pressing @kbd{?} in that special agenda will display the full flagging note in
17792 another window and also push it onto the kill ring. So you could use @kbd{?
17793 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
17794 Pressing @kbd{?} twice in succession will offer to remove the
17795 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
17796 in a property). In this way you indicate that the intended processing for
17797 this flagged entry is finished.
17802 If you are not able to process all flagged entries directly, you can always
17803 return to this agenda view@footnote{Note, however, that there is a subtle
17804 difference. The view created automatically by @kbd{M-x org-mobile-pull RET}
17805 is guaranteed to search all files that have been addressed by the last pull.
17806 This might include a file that is not currently in your list of agenda files.
17807 If you later use @kbd{C-c a ?} to regenerate the view, only the current
17808 agenda files will be searched.} using @kbd{C-c a ?}.
17810 @node History and acknowledgments
17811 @appendix History and acknowledgments
17812 @cindex acknowledgments
17816 @section From Carsten
17818 Org was born in 2003, out of frustration over the user interface of the Emacs
17819 Outline mode. I was trying to organize my notes and projects, and using
17820 Emacs seemed to be the natural way to go. However, having to remember eleven
17821 different commands with two or three keys per command, only to hide and show
17822 parts of the outline tree, that seemed entirely unacceptable to me. Also,
17823 when using outlines to take notes, I constantly wanted to restructure the
17824 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
17825 cycling} and @emph{structure editing} were originally implemented in the
17826 package @file{outline-magic.el}, but quickly moved to the more general
17827 @file{org.el}. As this environment became comfortable for project planning,
17828 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
17829 @emph{table support}. These areas highlighted the two main goals that Org
17830 still has today: to be a new, outline-based, plain text mode with innovative
17831 and intuitive editing features, and to incorporate project planning
17832 functionality directly into a notes file.
17834 Since the first release, literally thousands of emails to me or to
17835 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
17836 reports, feedback, new ideas, and sometimes patches and add-on code.
17837 Many thanks to everyone who has helped to improve this package. I am
17838 trying to keep here a list of the people who had significant influence
17839 in shaping one or more aspects of Org. The list may not be
17840 complete, if I have forgotten someone, please accept my apologies and
17843 Before I get to this list, a few special mentions are in order:
17846 @item Bastien Guerry
17847 Bastien has written a large number of extensions to Org (most of them
17848 integrated into the core by now), including the @LaTeX{} exporter and the
17849 plain list parser. His support during the early days was central to the
17850 success of this project. Bastien also invented Worg, helped establishing the
17851 Web presence of Org, and sponsored hosting costs for the orgmode.org website.
17852 Bastien stepped in as maintainer of Org between 2011 and 2013, at a time when
17853 I desparately needed a break.
17854 @item Eric Schulte and Dan Davison
17855 Eric and Dan are jointly responsible for the Org-babel system, which turns
17856 Org into a multi-language environment for evaluating code and doing literate
17857 programming and reproducible research. This has become one of Org's killer
17858 features that define what Org is today.
17860 John has contributed a number of great ideas and patches directly to Org,
17861 including the attachment system (@file{org-attach.el}), integration with
17862 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
17863 items, habit tracking (@file{org-habits.el}), and encryption
17864 (@file{org-crypt.el}). Also, the capture system is really an extended copy
17865 of his great @file{remember.el}.
17866 @item Sebastian Rose
17867 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
17868 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
17869 higher level. He also wrote @file{org-info.js}, a Java script for displaying
17870 web pages derived from Org using an Info-like or a folding interface with
17871 single-key navigation.
17874 @noindent See below for the full list of contributions! Again, please
17875 let me know what I am missing here!
17877 @section From Bastien
17879 I (Bastien) have been maintaining Org between 2011 and 2013. This appendix
17880 would not be complete without adding a few more acknowledgements and thanks.
17882 I am first grateful to Carsten for his trust while handing me over the
17883 maintainership of Org. His unremitting support is what really helped me
17884 getting more confident over time, with both the community and the code.
17886 When I took over maintainership, I knew I would have to make Org more
17887 collaborative than ever, as I would have to rely on people that are more
17888 knowledgeable than I am on many parts of the code. Here is a list of the
17889 persons I could rely on, they should really be considered co-maintainers,
17890 either of the code or the community:
17894 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
17895 from worrying about possible bugs here and let me focus on other parts.
17897 @item Nicolas Goaziou
17898 Nicolas is maintaining the consistency of the deepest parts of Org. His work
17899 on @file{org-element.el} and @file{ox.el} has been outstanding, and it opened
17900 the doors for many new ideas and features. He rewrote many of the old
17901 exporters to use the new export engine, and helped with documenting this
17902 major change. More importantly (if that's possible), he has been more than
17903 reliable during all the work done for Org 8.0, and always very reactive on
17907 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
17908 into a flexible and conceptually clean process. He patiently coped with the
17909 many hiccups that such a change can create for users.
17912 The Org mode mailing list would not be such a nice place without Nick, who
17913 patiently helped users so many times. It is impossible to overestimate such
17914 a great help, and the list would not be so active without him.
17917 I received support from so many users that it is clearly impossible to be
17918 fair when shortlisting a few of them, but Org's history would not be
17919 complete if the ones above were not mentioned in this manual.
17921 @section List of contributions
17926 @i{Russel Adams} came up with the idea for drawers.
17928 @i{Suvayu Ali} has steadily helped on the mailing list, providing useful
17929 feedback on many features and several patches.
17931 @i{Luis Anaya} wrote @file{ox-man.el}.
17933 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
17935 @i{Michael Brand} helped by reporting many bugs and testing many features.
17936 He also implemented the distinction between empty fields and 0-value fields
17937 in Org's spreadsheets.
17939 @i{Christophe Bataillon} created the great unicorn logo that we use on the
17942 @i{Alex Bochannek} provided a patch for rounding timestamps.
17944 @i{Jan Böcker} wrote @file{org-docview.el}.
17946 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
17948 @i{Tom Breton} wrote @file{org-choose.el}.
17950 @i{Charles Cave}'s suggestion sparked the implementation of templates
17951 for Remember, which are now templates for capture.
17953 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
17956 @i{Gregory Chernov} patched support for Lisp forms into table
17957 calculations and improved XEmacs compatibility, in particular by porting
17958 @file{nouline.el} to XEmacs.
17960 @i{Sacha Chua} suggested copying some linking code from Planner, and helped
17961 make Org pupular through her blog.
17963 @i{Toby S. Cubitt} contributed to the code for clock formats.
17965 @i{Baoqiu Cui} contributed the first DocBook exporter. In Org 8.0, we go a
17966 different route: you can now export to Texinfo and export the @file{.texi}
17967 file to DocBook using @code{makeinfo}.
17969 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
17970 came up with the idea of properties, and that there should be an API for
17973 @i{Nick Dokos} tracked down several nasty bugs.
17975 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
17976 inspired some of the early development, including HTML export. He also
17977 asked for a way to narrow wide table columns.
17979 @i{Jason Dunsmore} has been maintaining the Org-Mode server at Rackspace for
17980 several years now. He also sponsored the hosting costs until Rackspace
17981 started to host us for free.
17983 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
17984 the Org-Babel documentation into the manual.
17986 @i{Christian Egli} converted the documentation into Texinfo format, inspired
17987 the agenda, patched CSS formatting into the HTML exporter, and wrote
17988 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
17989 @file{ox-taskjuggler.el} for Org 8.0.
17991 @i{David Emery} provided a patch for custom CSS support in exported
17994 @i{Sean Escriva} took over MobileOrg development on the iPhone platform.
17996 @i{Nic Ferrier} contributed mailcap and XOXO support.
17998 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
18000 @i{John Foerch} figured out how to make incremental search show context
18001 around a match in a hidden outline tree.
18003 @i{Raimar Finken} wrote @file{org-git-line.el}.
18005 @i{Mikael Fornius} works as a mailing list moderator.
18007 @i{Austin Frank} works as a mailing list moderator.
18009 @i{Eric Fraga} drove the development of BEAMER export with ideas and
18012 @i{Barry Gidden} did proofreading the manual in preparation for the book
18013 publication through Network Theory Ltd.
18015 @i{Niels Giesen} had the idea to automatically archive DONE trees.
18017 @i{Nicolas Goaziou} rewrote much of the plain list code. He also wrote
18018 @file{org-element.el} and @file{org-export.el}, which was a huge step forward
18019 in implementing a clean framework for Org exporters.
18021 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
18023 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
18026 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
18027 task state change logging, and the clocktable. His clear explanations have
18028 been critical when we started to adopt the Git version control system.
18030 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
18033 @i{Phil Jackson} wrote @file{org-irc.el}.
18035 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
18036 folded entries, and column view for properties.
18038 @i{Matt Jones} wrote @i{MobileOrg Android}.
18040 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
18042 @i{Jonathan Leech-Pepin} wrote @file{ox-texinfo.el}.
18044 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
18045 provided frequent feedback and some patches.
18047 @i{Matt Lundin} has proposed last-row references for table formulas and named
18048 invisible anchors. He has also worked a lot on the FAQ.
18050 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
18051 and is a prolific contributor on the mailing list with competent replies,
18052 small fixes and patches.
18054 @i{Jason F. McBrayer} suggested agenda export to CSV format.
18056 @i{Max Mikhanosha} came up with the idea of refiling and sticky agendas.
18058 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
18061 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
18064 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
18066 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
18067 and being able to quickly restrict the agenda to a subtree.
18069 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
18071 @i{Greg Newman} refreshed the unicorn logo into its current form.
18073 @i{Tim O'Callaghan} suggested in-file links, search options for general
18074 file links, and TAGS.
18076 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
18077 version of the reference card.
18079 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
18082 @i{Oliver Oppitz} suggested multi-state TODO items.
18084 @i{Scott Otterson} sparked the introduction of descriptive text for
18085 links, among other things.
18087 @i{Pete Phillips} helped during the development of the TAGS feature, and
18088 provided frequent feedback.
18090 @i{Francesco Pizzolante} provided patches that helped speeding up the agenda
18093 @i{Martin Pohlack} provided the code snippet to bundle character insertion
18094 into bundles of 20 for undo.
18096 @i{Rackspace.com} is hosting our website for free. Thank you Rackspace!
18098 @i{T.V. Raman} reported bugs and suggested improvements.
18100 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
18103 @i{Paul Rivier} provided the basic implementation of named footnotes. He
18104 also acted as mailing list moderator for some time.
18106 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
18108 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
18109 conflict with @file{allout.el}.
18111 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
18114 @i{Philip Rooke} created the Org reference card, provided lots
18115 of feedback, developed and applied standards to the Org documentation.
18117 @i{Christian Schlauer} proposed angular brackets around links, among
18120 @i{Christopher Schmidt} reworked @code{orgstruct-mode} so that users can
18121 enjoy folding in non-org buffers by using Org headlines in comments.
18123 @i{Paul Sexton} wrote @file{org-ctags.el}.
18125 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
18126 @file{organizer-mode.el}.
18128 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
18129 examples, and remote highlighting for referenced code lines.
18131 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
18132 now packaged into Org's @file{contrib} directory.
18134 @i{Daniel Sinder} came up with the idea of internal archiving by locking
18137 @i{Dale Smith} proposed link abbreviations.
18139 @i{James TD Smith} has contributed a large number of patches for useful
18140 tweaks and features.
18142 @i{Adam Spiers} asked for global linking commands, inspired the link
18143 extension system, added support for mairix, and proposed the mapping API.
18145 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
18146 @LaTeX{}, UTF-8, Latin-1 and ASCII.
18148 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
18149 with links transformation to Org syntax.
18151 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
18152 chapter about publishing.
18154 @i{Jambunathan K} contributed the ODT exporter and rewrote the HTML exporter.
18156 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
18157 enabled source code highlighting in Gnus.
18159 @i{Stefan Vollmar} organized a video-recorded talk at the
18160 Max-Planck-Institute for Neurology. He also inspired the creation of a
18161 concept index for HTML export.
18163 @i{J@"urgen Vollmer} contributed code generating the table of contents
18166 @i{Samuel Wales} has provided important feedback and bug reports.
18168 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
18171 @i{David Wainberg} suggested archiving, and improvements to the linking
18174 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
18177 @i{Roland Winkler} requested additional key bindings to make Org
18180 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
18181 and contributed various ideas and code snippets.
18185 @node GNU Free Documentation License
18186 @appendix GNU Free Documentation License
18187 @include doclicense.texi
18191 @unnumbered Concept index
18196 @unnumbered Key index
18200 @node Command and Function Index
18201 @unnumbered Command and function index
18205 @node Variable Index
18206 @unnumbered Variable index
18208 This is not a complete index of variables and faces, only the ones that are
18209 mentioned in the manual. For a more complete list, use @kbd{M-x
18210 org-customize @key{RET}} and then click yourself through the tree.
18216 @c Local variables:
18218 @c indent-tabs-mode: nil
18219 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
18220 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
18224 @c LocalWords: webdavhost pre