4 @setfilename ../../info/org
5 @settitle The Org Manual
8 @set DATE December 2010
10 @c Use proper quote and backtick for code sections in PDF output
11 @c Cf. Texinfo manual 14.2
12 @set txicodequoteundirected
13 @set txicodequotebacktick
15 @c Version and Contact Info
16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
17 @set AUTHOR Carsten Dominik
18 @set MAINTAINER Carsten Dominik
19 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
25 @c -----------------------------------------------------------------------------
27 @c Macro definitions for commands and keys
28 @c =======================================
30 @c The behavior of the key/command macros will depend on the flag cmdnames
31 @c When set, commands names are shown. When clear, they are not shown.
35 @c Below we define the following macros for Org key tables:
37 @c orgkey{key} A key item
38 @c orgcmd{key,cmd} Key with command name
39 @c xorgcmd{key,cmmand} Key with command name as @itemx
40 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
41 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
42 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
43 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
44 @c different functions, so format as @itemx
45 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
46 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
47 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
49 @c a key but no command
61 @c one key with a command
62 @c Inserts: @item KEY COMMAND
63 @macro orgcmd{key,command}
68 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
71 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
80 @c One key with one command, formatted using @itemx
81 @c Inserts: @itemx KEY COMMAND
82 @macro xorgcmd{key,command}
87 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
90 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
99 @c one key with a command, bit do not index the key
100 @c Inserts: @item KEY COMMAND
101 @macro orgcmdnki{key,command}
105 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
108 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
116 @c one key with a command, and special text to replace key in item
117 @c Inserts: @item TEXT COMMAND
118 @macro orgcmdtkc{text,key,command}
123 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
126 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
135 @c two keys with one command
136 @c Inserts: @item KEY1 or KEY2 COMMAND
137 @macro orgcmdkkc{key1,key2,command}
143 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
152 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
156 @c Two keys with one command name, but different functions, so format as
158 @c Inserts: @item KEY1
159 @c @itemx KEY2 COMMAND
160 @macro orgcmdkxkc{key1,key2,command}
167 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
171 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
182 @c Same as previous, but use "or short"
183 @c Inserts: @item KEY1 or short KEY2 COMMAND
184 @macro orgcmdkskc{key1,key2,command}
190 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
199 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
203 @c Same as previous, but use @itemx
204 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
205 @macro xorgcmdkskc{key1,key2,command}
211 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
220 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
224 @c two keys with two commands
225 @c Inserts: @item KEY1 COMMAND1
226 @c @itemx KEY2 COMMAND2
227 @macro orgcmdkkcc{key1,key2,command1,command2}
234 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
235 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
238 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
239 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
249 @c -----------------------------------------------------------------------------
252 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
255 @c Subheadings inside a table.
256 @macro tsubheading{text}
258 @subsubheading \text\
266 This manual is for Org version @value{VERSION}.
268 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010
269 Free Software Foundation, Inc.
272 Permission is granted to copy, distribute and/or modify this document
273 under the terms of the GNU Free Documentation License, Version 1.3 or
274 any later version published by the Free Software Foundation; with no
275 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
276 and with the Back-Cover Texts as in (a) below. A copy of the license
277 is included in the section entitled ``GNU Free Documentation License.''
279 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
280 modify this GNU manual. Buying copies from the FSF supports it in
281 developing GNU and promoting software freedom.''
283 This document is part of a collection distributed under the GNU Free
284 Documentation License. If you want to distribute this document
285 separately from the collection, you can do so by adding a copy of the
286 license to the document, as described in section 6 of the license.
292 * Org Mode: (org). Outline-based notes management and organizer
296 @title The Org Manual
298 @subtitle Release @value{VERSION}
299 @author by Carsten Dominik
300 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, and Thomas Dye
302 @c The following two commands start the copyright page.
304 @vskip 0pt plus 1filll
308 @c Output the table of contents at the beginning.
312 @node Top, Introduction, (dir), (dir)
319 * Introduction:: Getting started
320 * Document Structure:: A tree works like your brain
321 * Tables:: Pure magic for quick formatting
322 * Hyperlinks:: Notes in context
323 * TODO Items:: Every tree branch can be a TODO item
324 * Tags:: Tagging headlines and matching sets of tags
325 * Properties and Columns:: Storing information about an entry
326 * Dates and Times:: Making items useful for planning
327 * Capture - Refile - Archive:: The ins and outs for projects
328 * Agenda Views:: Collecting information into views
329 * Markup:: Prepare text for rich export
330 * Exporting:: Sharing and publishing of notes
331 * Publishing:: Create a web site of linked Org files
332 * Working With Source Code:: Export, evaluate, and tangle code blocks
333 * Miscellaneous:: All the rest which did not fit elsewhere
334 * Hacking:: How to hack your way around
335 * MobileOrg:: Viewing and capture on a mobile device
336 * History and Acknowledgments:: How Org came into being
337 * Main Index:: An index of Org's concepts and features
338 * Key Index:: Key bindings and where they are described
339 * Command and Function Index:: Command names and some internal functions
340 * Variable Index:: Variables mentioned in the manual
343 --- The Detailed Node Listing ---
347 * Summary:: Brief summary of what Org does
348 * Installation:: How to install a downloaded version of Org
349 * Activation:: How to activate Org for certain buffers
350 * Feedback:: Bug reports, ideas, patches etc.
351 * Conventions:: Type-setting conventions in the manual
355 * Outlines:: Org is based on Outline mode
356 * Headlines:: How to typeset Org tree headlines
357 * Visibility cycling:: Show and hide, much simplified
358 * Motion:: Jumping to other headlines
359 * Structure editing:: Changing sequence and level of headlines
360 * Sparse trees:: Matches embedded in context
361 * Plain lists:: Additional structure within an entry
362 * Drawers:: Tucking stuff away
363 * Blocks:: Folding blocks
364 * Footnotes:: How footnotes are defined in Org's syntax
365 * Orgstruct mode:: Structure editing outside Org
369 * Built-in table editor:: Simple tables
370 * Column width and alignment:: Overrule the automatic settings
371 * Column groups:: Grouping to trigger vertical lines
372 * Orgtbl mode:: The table editor as minor mode
373 * The spreadsheet:: The table editor has spreadsheet capabilities
374 * Org-Plot:: Plotting from org tables
378 * References:: How to refer to another field or range
379 * Formula syntax for Calc:: Using Calc to compute stuff
380 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
381 * Field formulas:: Formulas valid for a single field
382 * Column formulas:: Formulas valid for an entire column
383 * Editing and debugging formulas:: Fixing formulas
384 * Updating the table:: Recomputing all dependent fields
385 * Advanced features:: Field names, parameters and automatic recalc
389 * Link format:: How links in Org are formatted
390 * Internal links:: Links to other places in the current file
391 * External links:: URL-like links to the world
392 * Handling links:: Creating, inserting and following
393 * Using links outside Org:: Linking from my C source code?
394 * Link abbreviations:: Shortcuts for writing complex links
395 * Search options:: Linking to a specific location
396 * Custom searches:: When the default search is not enough
400 * Radio targets:: Make targets trigger links in plain text
404 * TODO basics:: Marking and displaying TODO entries
405 * TODO extensions:: Workflow and assignments
406 * Progress logging:: Dates and notes for progress
407 * Priorities:: Some things are more important than others
408 * Breaking down tasks:: Splitting a task into manageable pieces
409 * Checkboxes:: Tick-off lists
411 Extended use of TODO keywords
413 * Workflow states:: From TODO to DONE in steps
414 * TODO types:: I do this, Fred does the rest
415 * Multiple sets in one file:: Mixing it all, and still finding your way
416 * Fast access to TODO states:: Single letter selection of a state
417 * Per-file keywords:: Different files, different requirements
418 * Faces for TODO keywords:: Highlighting states
419 * TODO dependencies:: When one task needs to wait for others
423 * Closing items:: When was this entry marked DONE?
424 * Tracking TODO state changes:: When did the status change?
425 * Tracking your habits:: How consistent have you been?
429 * Tag inheritance:: Tags use the tree structure of the outline
430 * Setting tags:: How to assign tags to a headline
431 * Tag searches:: Searching for combinations of tags
433 Properties and columns
435 * Property syntax:: How properties are spelled out
436 * Special properties:: Access to other Org-mode features
437 * Property searches:: Matching property values
438 * Property inheritance:: Passing values down the tree
439 * Column view:: Tabular viewing and editing
440 * Property API:: Properties for Lisp programmers
444 * Defining columns:: The COLUMNS format property
445 * Using column view:: How to create and use column view
446 * Capturing column view:: A dynamic block for column view
450 * Scope of column definitions:: Where defined, where valid?
451 * Column attributes:: Appearance and content of a column
455 * Timestamps:: Assigning a time to a tree entry
456 * Creating timestamps:: Commands which insert timestamps
457 * Deadlines and scheduling:: Planning your work
458 * Clocking work time:: Tracking how long you spend on a task
459 * Effort estimates:: Planning work effort in advance
460 * Relative timer:: Notes with a running timer
461 * Countdown timer:: Starting a countdown timer for a task
465 * The date/time prompt:: How Org-mode helps you entering date and time
466 * Custom time format:: Making dates look different
468 Deadlines and scheduling
470 * Inserting deadline/schedule:: Planning items
471 * Repeated tasks:: Items that show up again and again
475 * Clocking commands:: Starting and stopping a clock
476 * The clock table:: Detailed reports
477 * Resolving idle time:: Resolving time when you've been idle
479 Capture - Refile - Archive
481 * Capture:: Capturing new stuff
482 * Attachments:: Add files to tasks
483 * RSS Feeds:: Getting input from RSS feeds
484 * Protocols:: External (e.g. Browser) access to Emacs and Org
485 * Refiling notes:: Moving a tree from one place to another
486 * Archiving:: What to do with finished projects
490 * Setting up capture:: Where notes will be stored
491 * Using capture:: Commands to invoke and terminate capture
492 * Capture templates:: Define the outline of different note types
496 * Template elements:: What is needed for a complete template entry
497 * Template expansion:: Filling in information about time and context
501 * Moving subtrees:: Moving a tree to an archive file
502 * Internal archiving:: Switch off a tree but keep it in the file
506 * Agenda files:: Files being searched for agenda information
507 * Agenda dispatcher:: Keyboard access to agenda views
508 * Built-in agenda views:: What is available out of the box?
509 * Presentation and sorting:: How agenda items are prepared for display
510 * Agenda commands:: Remote editing of Org trees
511 * Custom agenda views:: Defining special searches and views
512 * Exporting Agenda Views:: Writing a view to a file
513 * Agenda column view:: Using column view for collected entries
515 The built-in agenda views
517 * Weekly/daily agenda:: The calendar page with current tasks
518 * Global TODO list:: All unfinished action items
519 * Matching tags and properties:: Structured information with fine-tuned search
520 * Timeline:: Time-sorted view for single file
521 * Search view:: Find entries by searching for text
522 * Stuck projects:: Find projects you need to review
524 Presentation and sorting
526 * Categories:: Not all tasks are equal
527 * Time-of-day specifications:: How the agenda knows the time
528 * Sorting of agenda items:: The order of things
532 * Storing searches:: Type once, use often
533 * Block agenda:: All the stuff you need in a single buffer
534 * Setting Options:: Changing the rules
536 Markup for rich export
538 * Structural markup elements:: The basic structure as seen by the exporter
539 * Images and tables:: Tables and Images will be included
540 * Literal examples:: Source code examples with special formatting
541 * Include files:: Include additional files into a document
542 * Index entries:: Making an index
543 * Macro replacement:: Use macros to create complex output
544 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
546 Structural markup elements
548 * Document title:: Where the title is taken from
549 * Headings and sections:: The document structure as seen by the exporter
550 * Table of contents:: The if and where of the table of contents
551 * Initial text:: Text before the first heading?
553 * Paragraphs:: Paragraphs
554 * Footnote markup:: Footnotes
555 * Emphasis and monospace:: Bold, italic, etc.
556 * Horizontal rules:: Make a line
557 * Comment lines:: What will *not* be exported
561 * Special symbols:: Greek letters and other symbols
562 * Subscripts and superscripts:: Simple syntax for raising/lowering text
563 * LaTeX fragments:: Complex formulas made easy
564 * Previewing LaTeX fragments:: What will this snippet look like?
565 * CDLaTeX mode:: Speed up entering of formulas
569 * Selective export:: Using tags to select and exclude trees
570 * Export options:: Per-file export settings
571 * The export dispatcher:: How to access exporter commands
572 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
573 * HTML export:: Exporting to HTML
574 * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
575 * DocBook export:: Exporting to DocBook
576 * TaskJuggler export:: Exporting to TaskJuggler
577 * Freemind export:: Exporting to Freemind mind maps
578 * XOXO export:: Exporting to XOXO
579 * iCalendar export:: Exporting in iCalendar format
583 * HTML Export commands:: How to invoke HTML export
584 * Quoting HTML tags:: Using direct HTML in Org-mode
585 * Links in HTML export:: How links will be interpreted and formatted
586 * Tables in HTML export:: How to modify the formatting of tables
587 * Images in HTML export:: How to insert figures into HTML output
588 * Math formatting in HTML export:: Beautiful math also on the web
589 * Text areas in HTML export:: An alternative way to show an example
590 * CSS support:: Changing the appearance of the output
591 * JavaScript support:: Info and Folding in a web browser
593 @LaTeX{} and PDF export
595 * LaTeX/PDF export commands:: Which key invokes which commands
596 * Header and sectioning:: Setting up the export file structure
597 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code
598 * Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
599 * Images in LaTeX export:: How to insert figures into @LaTeX{} output
600 * Beamer class export:: Turning the file into a presentation
604 * DocBook export commands:: How to invoke DocBook export
605 * Quoting DocBook code:: Incorporating DocBook code in Org files
606 * Recursive sections:: Recursive sections in DocBook
607 * Tables in DocBook export:: Tables are exported as HTML tables
608 * Images in DocBook export:: How to insert figures into DocBook output
609 * Special characters:: How to handle special characters
613 * Configuration:: Defining projects
614 * Uploading files:: How to get files up on the server
615 * Sample configuration:: Example projects
616 * Triggering publication:: Publication commands
620 * Project alist:: The central configuration variable
621 * Sources and destinations:: From here to there
622 * Selecting files:: What files are part of the project?
623 * Publishing action:: Setting the function doing the publishing
624 * Publishing options:: Tweaking HTML export
625 * Publishing links:: Which links keep working after publishing?
626 * Sitemap:: Generating a list of all pages
627 * Generating an index:: An index that reaches across pages
631 * Simple example:: One-component publishing
632 * Complex example:: A multi-component publishing example
634 Working with source code
636 * Structure of code blocks:: Code block syntax described
637 * Editing source code:: Language major-mode editing
638 * Exporting code blocks:: Export contents and/or results
639 * Extracting source code:: Create pure source code files
640 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
641 * Library of Babel:: Use and contribute to a library of useful code blocks
642 * Languages:: List of supported code block languages
643 * Header arguments:: Configure code block functionality
644 * Results of evaluation:: How evaluation results are handled
645 * Noweb reference syntax:: Literate programming in Org-mode
646 * Key bindings and useful functions:: Work quickly with code blocks
647 * Batch execution:: Call functions from the command line
651 * Using header arguments:: Different ways to set header arguments
652 * Specific header arguments:: List of header arguments
654 Using header arguments
656 * System-wide header arguments:: Set global default values
657 * Language-specific header arguments:: Set default values by language
658 * Buffer-wide header arguments:: Set default values for a specific buffer
659 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
660 * Code block specific header arguments:: The most common way to set values
661 * Header arguments in function calls:: The most specific level
663 Specific header arguments
665 * var:: Pass arguments to code blocks
666 * results:: Specify the type of results and how they will
667 be collected and handled
668 * file:: Specify a path for file output
669 * dir:: Specify the default (possibly remote)
670 directory for code block execution
671 * exports:: Export code and/or results
672 * tangle:: Toggle tangling and specify file name
673 * comments:: Toggle insertion of comments in tangled
675 * no-expand:: Turn off variable assignment and noweb
676 expansion during tangling
677 * session:: Preserve the state of code evaluation
678 * noweb:: Toggle expansion of noweb references
679 * cache:: Avoid re-evaluating unchanged code blocks
680 * sep:: Specify delimiter for writing external tables
681 * hlines:: Handle horizontal lines in tables
682 * colnames:: Handle column names in tables
683 * rownames:: Handle row names in tables
684 * shebang:: Make tangled files executable
685 * eval:: Limit evaluation of specific code blocks
689 * Completion:: M-TAB knows what you need
690 * Easy Templates:: Quick insertion of structural elements
691 * Speed keys:: Electric commands at the beginning of a headline
692 * Code evaluation security:: Org mode files evaluate inline code
693 * Customization:: Adapting Org to your taste
694 * In-buffer settings:: Overview of the #+KEYWORDS
695 * The very busy C-c C-c key:: When in doubt, press C-c C-c
696 * Clean view:: Getting rid of leading stars in the outline
697 * TTY keys:: Using Org on a tty
698 * Interaction:: Other Emacs packages
700 Interaction with other packages
702 * Cooperation:: Packages Org cooperates with
703 * Conflicts:: Packages that lead to conflicts
707 * Hooks:: Who to reach into Org's internals
708 * Add-on packages:: Available extensions
709 * Adding hyperlink types:: New custom link types
710 * Context-sensitive commands:: How to add functionality to such commands
711 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
712 * Dynamic blocks:: Automatically filled blocks
713 * Special agenda views:: Customized views
714 * Extracting agenda information:: Postprocessing of agenda information
715 * Using the property API:: Writing programs that use entry properties
716 * Using the mapping API:: Mapping over all or selected entries
718 Tables and lists in arbitrary syntax
720 * Radio tables:: Sending and receiving radio tables
721 * A LaTeX example:: Step by step, almost a tutorial
722 * Translator functions:: Copy and modify
723 * Radio lists:: Doing the same for lists
727 * Setting up the staging area:: Where to interact with the mobile device
728 * Pushing to MobileOrg:: Uploading Org files and agendas
729 * Pulling from MobileOrg:: Integrating captured and flagged items
734 @node Introduction, Document Structure, Top, Top
735 @chapter Introduction
739 * Summary:: Brief summary of what Org does
740 * Installation:: How to install a downloaded version of Org
741 * Activation:: How to activate Org for certain buffers
742 * Feedback:: Bug reports, ideas, patches etc.
743 * Conventions:: Type-setting conventions in the manual
746 @node Summary, Installation, Introduction, Introduction
750 Org is a mode for keeping notes, maintaining TODO lists, and doing
751 project planning with a fast and effective plain-text system.
753 Org develops organizational tasks around NOTES files that contain
754 lists or information about projects as plain text. Org is
755 implemented on top of Outline mode, which makes it possible to keep the
756 content of large files well structured. Visibility cycling and
757 structure editing help to work with the tree. Tables are easily created
758 with a built-in table editor. Org supports TODO items, deadlines,
759 timestamps, and scheduling. It dynamically compiles entries into an
760 agenda that utilizes and smoothly integrates much of the Emacs calendar
761 and diary. Plain text URL-like links connect to websites, emails,
762 Usenet messages, BBDB entries, and any files related to the projects.
763 For printing and sharing of notes, an Org file can be exported as a
764 structured ASCII file, as HTML, or (TODO and agenda items only) as an
765 iCalendar file. It can also serve as a publishing tool for a set of
768 As a project planning environment, Org works by adding metadata to outline
769 nodes. Based on this data, specific entries can be extracted in queries and
770 create dynamic @i{agenda views}.
772 Org mode contains the Org Babel environment which allows you to work with
773 embedded source code blocks in a file, to facilitate code evaluation,
774 documentation, and tangling.
776 Org's automatic, context-sensitive table editor with spreadsheet
777 capabilities can be integrated into any major mode by activating the
778 minor Orgtbl mode. Using a translation step, it can be used to maintain
779 tables in arbitrary file types, for example in @LaTeX{}. The structure
780 editing and list creation capabilities can be used outside Org with
781 the minor Orgstruct mode.
783 Org keeps simple things simple. When first fired up, it should
784 feel like a straightforward, easy to use outliner. Complexity is not
785 imposed, but a large amount of functionality is available when you need
786 it. Org is a toolbox and can be used in different ways and for different
790 @r{@bullet{} an outline extension with visibility cycling and structure editing}
791 @r{@bullet{} an ASCII system and table editor for taking structured notes}
792 @r{@bullet{} a TODO list editor}
793 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
794 @pindex GTD, Getting Things Done
795 @r{@bullet{} an environment in which to implement David Allen's GTD system}
796 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
797 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
798 @r{@bullet{} an environment for literate programming}
803 There is a website for Org which provides links to the newest
804 version of Org, as well as additional information, frequently asked
805 questions (FAQ), links to tutorials, etc@. This page is located at
806 @uref{http://orgmode.org}.
808 @cindex print edition
809 The version 7.3 of this manual is available as a
810 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
816 @node Installation, Activation, Summary, Introduction
817 @section Installation
821 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
822 distribution or an XEmacs package, please skip this section and go directly
823 to @ref{Activation}.}
825 If you have downloaded Org from the Web, either as a distribution @file{.zip}
826 or @file{.tar} file, or as a Git archive, you must take the following steps
827 to install it: go into the unpacked Org distribution directory and edit the
828 top section of the file @file{Makefile}. You must set the name of the Emacs
829 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
830 directories where local Lisp and Info files are kept. If you don't have
831 access to the system-wide directories, you can simply run Org directly from
832 the distribution directory by adding the @file{lisp} subdirectory to the
833 Emacs load path. To do this, add the following line to @file{.emacs}:
836 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
840 If you plan to use code from the @file{contrib} subdirectory, do a similar
841 step for this directory:
844 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
847 @noindent Now byte-compile the Lisp files with the shell command:
853 @noindent If you are running Org from the distribution directory, this is
854 all. If you want to install Org into the system directories, use (as
861 Installing Info files is system dependent, because of differences in the
862 @file{install-info} program. In Debian it copies the info files into the
863 correct directory and modifies the info directory file. In many other
864 systems, the files need to be copied to the correct directory separately, and
865 @file{install-info} then only modifies the directory file. Check your system
866 documentation to find out which of the following commands you need:
870 make install-info-debian
873 Then add the following line to @file{.emacs}. It is needed so that
874 Emacs can autoload functions that are located in files not immediately loaded
875 when Org-mode starts.
877 (require 'org-install)
880 Do not forget to activate Org as described in the following section.
883 @node Activation, Feedback, Installation, Introduction
887 @cindex global key bindings
888 @cindex key bindings, global
890 To make sure files with extension @file{.org} use Org mode, add the following
891 line to your @file{.emacs} file.
893 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
895 @noindent Org mode buffers need font-lock to be turned on - this is the
896 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
897 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
899 The four Org commands @command{org-store-link}, @command{org-capture},
900 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
901 global keys (i.e. anywhere in Emacs, not just in Org buffers). Here are
902 suggested bindings for these keys, please modify the keys to your own
905 (global-set-key "\C-cl" 'org-store-link)
906 (global-set-key "\C-cc" 'org-capture)
907 (global-set-key "\C-ca" 'org-agenda)
908 (global-set-key "\C-cb" 'org-iswitchb)
911 @cindex Org-mode, turning on
912 With this setup, all files with extension @samp{.org} will be put
913 into Org-mode. As an alternative, make the first line of a file look
917 MY PROJECTS -*- mode: org; -*-
920 @vindex org-insert-mode-line-in-empty-file
921 @noindent which will select Org-mode for this buffer no matter what
922 the file's name is. See also the variable
923 @code{org-insert-mode-line-in-empty-file}.
925 Many commands in Org work on the region if the region is @i{active}. To make
926 use of this, you need to have @code{transient-mark-mode}
927 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
928 in Emacs 22 you need to do this yourself with
930 (transient-mark-mode 1)
932 @noindent If you do not like @code{transient-mark-mode}, you can create an
933 active region by using the mouse to select a region, or pressing
934 @kbd{C-@key{SPC}} twice before moving the cursor.
936 @node Feedback, Conventions, Activation, Introduction
943 If you find problems with Org, or if you have questions, remarks, or ideas
944 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
945 If you are not a member of the mailing list, your mail will be passed to the
946 list after a moderator has approved it@footnote{Please consider subscribing
947 to the mailing list, in order to minimize the work the mailing list
948 moderators have to do.}.
950 For bug reports, please first try to reproduce the bug with the latest
951 version of Org available---if you are running an outdated version, it is
952 quite possible that the bug has been fixed already. If the bug persists,
953 prepare a report and provide as much information as possible, including the
954 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
955 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
956 @file{.emacs}. The easiest way to do this is to use the command
958 @kbd{M-x org-submit-bug-report}
960 @noindent which will put all this information into an Emacs mail buffer so
961 that you only need to add your description. If you re not sending the Email
962 from within Emacs, please copy and paste the content into your Email program.
964 If an error occurs, a backtrace can be very useful (see below on how to
965 create one). Often a small example file helps, along with clear information
969 @item What exactly did you do?
970 @item What did you expect to happen?
971 @item What happened instead?
973 @noindent Thank you for helping to improve this program.
975 @subsubheading How to create a useful backtrace
977 @cindex backtrace of an error
978 If working with Org produces an error with a message you don't
979 understand, you may have hit a bug. The best way to report this is by
980 providing, in addition to what was mentioned above, a @emph{backtrace}.
981 This is information from the built-in debugger about where and how the
982 error occurred. Here is how to produce a useful backtrace:
986 Reload uncompiled versions of all Org-mode Lisp files. The backtrace
987 contains much more information if it is produced with uncompiled code.
990 C-u M-x org-reload RET
993 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
996 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
997 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
999 Do whatever you have to do to hit the error. Don't forget to
1000 document the steps you take.
1002 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1003 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1004 attach it to your bug report.
1007 @node Conventions, , Feedback, Introduction
1008 @section Typesetting conventions used in this manual
1010 Org uses three types of keywords: TODO keywords, tags, and property
1011 names. In this manual we use the following conventions:
1016 TODO keywords are written with all capitals, even if they are
1020 User-defined tags are written in lowercase; built-in tags with special
1021 meaning are written with all capitals.
1024 User-defined properties are capitalized; built-in properties with
1025 special meaning are written with all capitals.
1028 The manual lists both the keys and the corresponding commands for accessing
1029 functionality. Org mode often uses the same key for different functions,
1030 depending on context. The command that is bound to such keys has a generic
1031 name, like @code{org-metaright}. In the manual we will, wherever possible,
1032 give the function that is internally called by the generic command. For
1033 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1034 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1035 be listed to call org-table-move-column-right.
1037 If you prefer, you can compile the manual without the command names by
1038 unsetting the flag @code{cmdnames} in @file{org.texi}.
1040 @node Document Structure, Tables, Introduction, Top
1041 @chapter Document structure
1042 @cindex document structure
1043 @cindex structure of document
1045 Org is based on Outline mode and provides flexible commands to
1046 edit the structure of the document.
1049 * Outlines:: Org is based on Outline mode
1050 * Headlines:: How to typeset Org tree headlines
1051 * Visibility cycling:: Show and hide, much simplified
1052 * Motion:: Jumping to other headlines
1053 * Structure editing:: Changing sequence and level of headlines
1054 * Sparse trees:: Matches embedded in context
1055 * Plain lists:: Additional structure within an entry
1056 * Drawers:: Tucking stuff away
1057 * Blocks:: Folding blocks
1058 * Footnotes:: How footnotes are defined in Org's syntax
1059 * Orgstruct mode:: Structure editing outside Org
1062 @node Outlines, Headlines, Document Structure, Document Structure
1065 @cindex Outline mode
1067 Org is implemented on top of Outline mode. Outlines allow a
1068 document to be organized in a hierarchical structure, which (at least
1069 for me) is the best representation of notes and thoughts. An overview
1070 of this structure is achieved by folding (hiding) large parts of the
1071 document to show only the general document structure and the parts
1072 currently being worked on. Org greatly simplifies the use of
1073 outlines by compressing the entire show/hide functionality into a single
1074 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1076 @node Headlines, Visibility cycling, Outlines, Document Structure
1079 @cindex outline tree
1080 @vindex org-special-ctrl-a/e
1081 @vindex org-special-ctrl-k
1082 @vindex org-ctrl-k-protect-subtree
1084 Headlines define the structure of an outline tree. The headlines in Org
1085 start with one or more stars, on the left margin@footnote{See the variables
1086 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1087 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1088 @kbd{C-e}, and @kbd{C-k} in headlines.}. For example:
1091 * Top level headline
1098 * Another top level headline
1101 @noindent Some people find the many stars too noisy and would prefer an
1102 outline that has whitespace followed by a single star as headline
1103 starters. @ref{Clean view}, describes a setup to realize this.
1105 @vindex org-cycle-separator-lines
1106 An empty line after the end of a subtree is considered part of it and
1107 will be hidden when the subtree is folded. However, if you leave at
1108 least two empty lines, one empty line will remain visible after folding
1109 the subtree, in order to structure the collapsed view. See the
1110 variable @code{org-cycle-separator-lines} to modify this behavior.
1112 @node Visibility cycling, Motion, Headlines, Document Structure
1113 @section Visibility cycling
1114 @cindex cycling, visibility
1115 @cindex visibility cycling
1116 @cindex trees, visibility
1117 @cindex show hidden text
1120 Outlines make it possible to hide parts of the text in the buffer.
1121 Org uses just two commands, bound to @key{TAB} and
1122 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1124 @cindex subtree visibility states
1125 @cindex subtree cycling
1126 @cindex folded, subtree visibility state
1127 @cindex children, subtree visibility state
1128 @cindex subtree, subtree visibility state
1130 @orgcmd{@key{TAB},org-cycle}
1131 @emph{Subtree cycling}: Rotate current subtree among the states
1134 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1135 '-----------------------------------'
1138 @vindex org-cycle-emulate-tab
1139 @vindex org-cycle-global-at-bob
1140 The cursor must be on a headline for this to work@footnote{see, however,
1141 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1142 beginning of the buffer and the first line is not a headline, then
1143 @key{TAB} actually runs global cycling (see below)@footnote{see the
1144 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1145 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1147 @cindex global visibility states
1148 @cindex global cycling
1149 @cindex overview, global visibility state
1150 @cindex contents, global visibility state
1151 @cindex show all, global visibility state
1152 @orgcmd{S-@key{TAB},org-global-cycle}
1153 @itemx C-u @key{TAB}
1154 @emph{Global cycling}: Rotate the entire buffer among the states
1157 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1158 '--------------------------------------'
1161 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1162 CONTENTS view up to headlines of level N will be shown. Note that inside
1163 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1165 @cindex show all, command
1166 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1167 Show all, including drawers.
1168 @orgcmd{C-c C-r,org-reveal}
1169 Reveal context around point, showing the current entry, the following heading
1170 and the hierarchy above. Useful for working near a location that has been
1171 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1172 (@pxref{Agenda commands}). With a prefix argument show, on each
1173 level, all sibling headings. With double prefix arg, also show the entire
1174 subtree of the parent.
1175 @orgcmd{C-c C-k,show-branches}
1176 Expose all the headings of the subtree, CONTENT view for just one subtree.
1177 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1178 Show the current subtree in an indirect buffer@footnote{The indirect
1181 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1184 (see the Emacs manual for more information about indirect buffers)
1186 will contain the entire buffer, but will be narrowed to the current
1187 tree. Editing the indirect buffer will also change the original buffer,
1188 but without affecting visibility in that buffer.}. With a numeric
1189 prefix argument N, go up to level N and then take that tree. If N is
1190 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1191 the previously used indirect buffer.
1194 @vindex org-startup-folded
1195 @cindex @code{overview}, STARTUP keyword
1196 @cindex @code{content}, STARTUP keyword
1197 @cindex @code{showall}, STARTUP keyword
1198 @cindex @code{showeverything}, STARTUP keyword
1200 When Emacs first visits an Org file, the global state is set to
1201 OVERVIEW, i.e. only the top level headlines are visible. This can be
1202 configured through the variable @code{org-startup-folded}, or on a
1203 per-file basis by adding one of the following lines anywhere in the
1210 #+STARTUP: showeverything
1213 @cindex property, VISIBILITY
1215 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1216 and Columns}) will get their visibility adapted accordingly. Allowed values
1217 for this property are @code{folded}, @code{children}, @code{content}, and
1220 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1221 Switch back to the startup visibility of the buffer, i.e. whatever is
1222 requested by startup options and @samp{VISIBILITY} properties in individual
1226 @node Motion, Structure editing, Visibility cycling, Document Structure
1228 @cindex motion, between headlines
1229 @cindex jumping, to headlines
1230 @cindex headline navigation
1231 The following commands jump to other headlines in the buffer.
1234 @orgcmd{C-c C-n,outline-next-visible-heading}
1236 @orgcmd{C-c C-p,outline-previous-visible-heading}
1238 @orgcmd{C-c C-f,org-forward-same-level}
1239 Next heading same level.
1240 @orgcmd{C-c C-b,org-backward-same-level}
1241 Previous heading same level.
1242 @orgcmd{C-c C-u,outline-up-heading}
1243 Backward to higher level heading.
1244 @orgcmd{C-c C-j,org-goto}
1245 Jump to a different place without changing the current outline
1246 visibility. Shows the document structure in a temporary buffer, where
1247 you can use the following keys to find your destination:
1248 @vindex org-goto-auto-isearch
1250 @key{TAB} @r{Cycle visibility.}
1251 @key{down} / @key{up} @r{Next/previous visible headline.}
1252 @key{RET} @r{Select this location.}
1253 @kbd{/} @r{Do a Sparse-tree search}
1254 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1255 n / p @r{Next/previous visible headline.}
1256 f / b @r{Next/previous headline same level.}
1258 0-9 @r{Digit argument.}
1261 @vindex org-goto-interface
1263 See also the variable @code{org-goto-interface}.
1266 @node Structure editing, Sparse trees, Motion, Document Structure
1267 @section Structure editing
1268 @cindex structure editing
1269 @cindex headline, promotion and demotion
1270 @cindex promotion, of subtrees
1271 @cindex demotion, of subtrees
1272 @cindex subtree, cut and paste
1273 @cindex pasting, of subtrees
1274 @cindex cutting, of subtrees
1275 @cindex copying, of subtrees
1276 @cindex sorting, of subtrees
1277 @cindex subtrees, cut and paste
1280 @orgcmd{M-@key{RET},org-insert-heading}
1281 @vindex org-M-RET-may-split-line
1282 Insert new heading with same level as current. If the cursor is in a
1283 plain list item, a new item is created (@pxref{Plain lists}). To force
1284 creation of a new headline, use a prefix argument, or first press @key{RET}
1285 to get to the beginning of the next line. When this command is used in
1286 the middle of a line, the line is split and the rest of the line becomes
1287 the new headline@footnote{If you do not want the line to be split,
1288 customize the variable @code{org-M-RET-may-split-line}.}. If the
1289 command is used at the beginning of a headline, the new headline is
1290 created before the current line. If at the beginning of any other line,
1291 the content of that line is made the new heading. If the command is
1292 used at the end of a folded subtree (i.e. behind the ellipses at the end
1293 of a headline), then a headline like the current one will be inserted
1294 after the end of the subtree.
1295 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1296 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1297 current heading, the new heading is placed after the body instead of before
1298 it. This command works from anywhere in the entry.
1299 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1300 @vindex org-treat-insert-todo-heading-as-state-change
1301 Insert new TODO entry with same level as current heading. See also the
1302 variable @code{org-treat-insert-todo-heading-as-state-change}.
1303 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1304 Insert new TODO entry with same level as current heading. Like
1305 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1307 @orgcmd{@key{TAB},org-cycle}
1308 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1309 become a child of the previous one. The next @key{TAB} makes it a parent,
1310 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1311 to the initial level.
1312 @orgcmd{M-@key{left},org-do-promote}
1313 Promote current heading by one level.
1314 @orgcmd{M-@key{right},org-do-demote}
1315 Demote current heading by one level.
1316 @orgcmd{M-S-@key{left},org-promote-subtree}
1317 Promote the current subtree by one level.
1318 @orgcmd{M-S-@key{right},org-demote-subtree}
1319 Demote the current subtree by one level.
1320 @orgcmd{M-S-@key{up},org-move-subtree-up}
1321 Move subtree up (swap with previous subtree of same
1323 @orgcmd{M-S-@key{down},org-move-subtree-down}
1324 Move subtree down (swap with next subtree of same level).
1325 @orgcmd{C-c C-x C-w,org-cut-subtree}
1326 Kill subtree, i.e. remove it from buffer but save in kill ring.
1327 With a numeric prefix argument N, kill N sequential subtrees.
1328 @orgcmd{C-c C-x M-w,org-copy-subtree}
1329 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1330 sequential subtrees.
1331 @orgcmd{C-c C-x C-y,org-paste-subtree}
1332 Yank subtree from kill ring. This does modify the level of the subtree to
1333 make sure the tree fits in nicely at the yank position. The yank level can
1334 also be specified with a numeric prefix argument, or by yanking after a
1335 headline marker like @samp{****}.
1336 @orgcmd{C-y,org-yank}
1337 @vindex org-yank-adjusted-subtrees
1338 @vindex org-yank-folded-subtrees
1339 Depending on the variables @code{org-yank-adjusted-subtrees} and
1340 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1341 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1342 C-x C-y}. With the default settings, no level adjustment will take place,
1343 but the yanked tree will be folded unless doing so would swallow text
1344 previously visible. Any prefix argument to this command will force a normal
1345 @code{yank} to be executed, with the prefix passed along. A good way to
1346 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1347 yank, it will yank previous kill items plainly, without adjustment and
1349 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1350 Clone a subtree by making a number of sibling copies of it. You will be
1351 prompted for the number of copies to make, and you can also specify if any
1352 timestamps in the entry should be shifted. This can be useful, for example,
1353 to create a number of tasks related to a series of lectures to prepare. For
1354 more details, see the docstring of the command
1355 @code{org-clone-subtree-with-time-shift}.
1356 @orgcmd{C-c C-w,org-refile}
1357 Refile entry or region to a different location. @xref{Refiling notes}.
1358 @orgcmd{C-c ^,org-sort-entries-or-items}
1359 Sort same-level entries. When there is an active region, all entries in the
1360 region will be sorted. Otherwise the children of the current headline are
1361 sorted. The command prompts for the sorting method, which can be
1362 alphabetically, numerically, by time (first timestamp with active preferred,
1363 creation time, scheduled time, deadline time), by priority, by TODO keyword
1364 (in the sequence the keywords have been defined in the setup) or by the value
1365 of a property. Reverse sorting is possible as well. You can also supply
1366 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1367 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1368 entries will also be removed.
1369 @orgcmd{C-x n s,org-narrow-to-subtree}
1370 Narrow buffer to current subtree.
1371 @orgcmd{C-x n w,widen}
1372 Widen buffer to remove narrowing.
1373 @orgcmd{C-c *,org-toggle-heading}
1374 Turn a normal line or plain list item into a headline (so that it becomes a
1375 subheading at its location). Also turn a headline into a normal line by
1376 removing the stars. If there is an active region, turn all lines in the
1377 region into headlines. If the first line in the region was an item, turn
1378 only the item lines into headlines. Finally, if the first line is a
1379 headline, remove the stars from all headlines in the region.
1382 @cindex region, active
1383 @cindex active region
1384 @cindex transient mark mode
1385 When there is an active region (Transient Mark mode), promotion and
1386 demotion work on all headlines in the region. To select a region of
1387 headlines, it is best to place both point and mark at the beginning of a
1388 line, mark at the beginning of the first headline, and point at the line
1389 just after the last headline to change. Note that when the cursor is
1390 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1394 @node Sparse trees, Plain lists, Structure editing, Document Structure
1395 @section Sparse trees
1396 @cindex sparse trees
1397 @cindex trees, sparse
1398 @cindex folding, sparse trees
1399 @cindex occur, command
1401 @vindex org-show-hierarchy-above
1402 @vindex org-show-following-heading
1403 @vindex org-show-siblings
1404 @vindex org-show-entry-below
1405 An important feature of Org-mode is the ability to construct @emph{sparse
1406 trees} for selected information in an outline tree, so that the entire
1407 document is folded as much as possible, but the selected information is made
1408 visible along with the headline structure above it@footnote{See also the
1409 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1410 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1411 control on how much context is shown around each match.}. Just try it out
1412 and you will see immediately how it works.
1414 Org-mode contains several commands creating such trees, all these
1415 commands can be accessed through a dispatcher:
1418 @orgcmd{C-c /,org-sparse-tree}
1419 This prompts for an extra key to select a sparse-tree creating command.
1420 @orgcmd{C-c / r,org-occur}
1421 @vindex org-remove-highlights-with-change
1422 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1423 the match is in a headline, the headline is made visible. If the match is in
1424 the body of an entry, headline and body are made visible. In order to
1425 provide minimal context, also the full hierarchy of headlines above the match
1426 is shown, as well as the headline following the match. Each match is also
1427 highlighted; the highlights disappear when the buffer is changed by an
1428 editing command@footnote{This depends on the option
1429 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1430 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1431 so several calls to this command can be stacked.
1432 @orgcmdkkc{M-g n,M-g M-n,next-error}
1433 Jump to the next sparse tree match in this buffer.
1434 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1435 Jump to the previous sparse tree match in this buffer.
1440 @vindex org-agenda-custom-commands
1441 For frequently used sparse trees of specific search strings, you can
1442 use the variable @code{org-agenda-custom-commands} to define fast
1443 keyboard access to specific sparse trees. These commands will then be
1444 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1448 (setq org-agenda-custom-commands
1449 '(("f" occur-tree "FIXME")))
1452 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1453 a sparse tree matching the string @samp{FIXME}.
1455 The other sparse tree commands select headings based on TODO keywords,
1456 tags, or properties and will be discussed later in this manual.
1459 @cindex printing sparse trees
1460 @cindex visible text, printing
1461 To print a sparse tree, you can use the Emacs command
1462 @code{ps-print-buffer-with-faces} which does not print invisible parts
1463 of the document @footnote{This does not work under XEmacs, because
1464 XEmacs uses selective display for outlining, not text properties.}.
1465 Or you can use the command @kbd{C-c C-e v} to export only the visible
1466 part of the document and print the resulting file.
1468 @node Plain lists, Drawers, Sparse trees, Document Structure
1469 @section Plain lists
1471 @cindex lists, plain
1472 @cindex lists, ordered
1473 @cindex ordered lists
1475 Within an entry of the outline tree, hand-formatted lists can provide
1476 additional structure. They also provide a way to create lists of checkboxes
1477 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1478 (@pxref{Exporting}) can parse and format them.
1480 Org knows ordered lists, unordered lists, and description lists.
1483 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1484 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1485 they will be seen as top-level headlines. Also, when you are hiding leading
1486 stars to get a clean outline view, plain list items starting with a star are
1487 visually indistinguishable from true headlines. In short: even though
1488 @samp{*} is supported, it may be better to not use it for plain list items.}
1491 @vindex org-plain-list-ordered-item-terminator
1492 @emph{Ordered} list items start with a numeral followed by either a period or
1493 a right parenthesis@footnote{You can filter out any of them by configuring
1494 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1495 @samp{1)}. If you want a list to start with a different value (e.g. 20), start
1496 the text of the item with @code{[@@20]}@footnote{If there's a checkbox in the
1497 item, the cookie must be put @emph{before} the checkbox.}. Those constructs
1498 can be used in any item of the list in order to enforce a particular
1501 @emph{Description} list items are unordered list items, and contain the
1502 separator @samp{ :: } to separate the description @emph{term} from the
1506 Items belonging to the same list must have the same indentation on the first
1507 line. In particular, if an ordered list reaches number @samp{10.}, then the
1508 2--digit numbers must be written left-aligned with the other numbers in the
1511 @vindex org-list-ending-method
1512 @vindex org-list-end-regexp
1513 @vindex org-empty-line-terminates-plain-lists
1514 Two methods@footnote{To disable either of them, configure
1515 @code{org-list-ending-method}.} are provided to terminate lists. A list ends
1516 before the next line that is indented like the bullet/number or less, or it
1517 ends before two blank lines@footnote{See also
1518 @code{org-empty-line-terminates-plain-lists}.}. In both cases, all levels of
1519 the list are closed@footnote{So you cannot have a sublist, some text and then
1520 another sublist while still in the same top-level list item. This used to be
1521 possible, but it was only supported in the HTML exporter and difficult to
1522 manage with automatic indentation.}. For finer control, you can end lists
1523 with any pattern set in @code{org-list-end-regexp}. Here is an example:
1527 ** Lord of the Rings
1528 My favorite scenes are (in this order)
1529 1. The attack of the Rohirrim
1530 2. Eowyn's fight with the witch king
1531 + this was already my favorite scene in the book
1532 + I really like Miranda Otto.
1533 3. Peter Jackson being shot by Legolas
1534 He makes a really funny face when it happens.
1536 But in the end, no individual scenes matter but the film as a whole.
1537 Important actors in this film are:
1538 - @b{Elijah Wood} :: He plays Frodo
1539 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1540 him very well from his role as Mikey Walsh in @i{The Goonies}.
1544 Org supports these lists by tuning filling and wrapping commands to deal with
1545 them correctly@footnote{Org only changes the filling settings for Emacs. For
1546 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1547 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1548 properly (@pxref{Exporting}). Since indentation is what governs the
1549 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1550 blocks can be indented to signal that they should be considered as a list
1553 @vindex org-list-demote-modify-bullet
1554 If you find that using a different bullet for a sub-list (than that used for
1555 the current list-level) improves readability, customize the variable
1556 @code{org-list-demote-modify-bullet}.
1558 @vindex org-list-automatic-rules
1559 The following commands act on items when the cursor is in the first line of
1560 an item (the line with the bullet or number). Some of them imply the
1561 application of automatic rules to keep list structure intact. If some of
1562 these actions get in your way, configure @code{org-list-automatic-rules}
1563 to disable them individually.
1566 @orgcmd{@key{TAB},org-cycle}
1567 @vindex org-cycle-include-plain-lists
1568 Items can be folded just like headline levels. Normally this works only if
1569 the cursor is on a plain list item. For more details, see the variable
1570 @code{org-cycle-include-plain-lists}. If this variable is set to
1571 @code{integrate}, plain list items will be treated like low-level
1572 headlines. The level of an item is then given by the
1573 indentation of the bullet/number. Items are always subordinate to real
1574 headlines, however; the hierarchies remain completely separated.
1575 @orgcmd{M-@key{RET},org-insert-heading}
1576 @vindex org-M-RET-may-split-line
1577 @vindex org-list-automatic-rules
1578 Insert new item at current level. With a prefix argument, force a new
1579 heading (@pxref{Structure editing}). If this command is used in the middle
1580 of a line, the line is @emph{split} and the rest of the line becomes the new
1581 item@footnote{If you do not want the line to be split, customize the variable
1582 @code{org-M-RET-may-split-line}.}. If this command is executed @emph{before
1583 an item's body}, the new item is created @emph{before} the current item. If the
1584 command is executed in the white space before the text that is part of an
1585 item but does not contain the bullet, a bullet is added to the current line.
1587 As a new item cannot be inserted in a structural construct (like an example
1588 or source code block) within a list, Org will instead insert it right before
1589 the structure, or return an error.
1590 @kindex M-S-@key{RET}
1592 Insert a new item with a checkbox (@pxref{Checkboxes}).
1593 @orgcmd{@key{TAB},org-cycle}
1594 In a new item with no text yet, the first @key{TAB} demotes the item to
1595 become a child of the previous one. Subsequent @key{TAB}s move the item to
1596 meaningful levels in the list and eventually get it back to its initial
1598 @kindex S-@key{down}
1601 @cindex shift-selection-mode
1602 @vindex org-support-shift-select
1603 Jump to the previous/next item in the current list, but only if
1604 @code{org-support-shift-select} is off. If not, you can still use paragraph
1605 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1607 @kindex M-S-@key{up}
1608 @kindex M-S-@key{down}
1610 @itemx M-S-@key{down}
1611 Move the item including subitems up/down (swap with previous/next item
1612 of same indentation). If the list is ordered, renumbering is
1614 @kindex M-@key{left}
1615 @kindex M-@key{right}
1617 @itemx M-@key{right}
1618 Decrease/increase the indentation of an item, leaving children alone.
1619 @kindex M-S-@key{left}
1620 @kindex M-S-@key{right}
1621 @item M-S-@key{left}
1622 @itemx M-S-@key{right}
1623 Decrease/increase the indentation of the item, including subitems.
1624 Initially, the item tree is selected based on current indentation. When
1625 these commands are executed several times in direct succession, the initially
1626 selected region is used, even if the new indentation would imply a different
1627 hierarchy. To use the new hierarchy, break the command chain with a cursor
1630 As a special case, using this command on the very first item of a list will
1631 move the whole list. This behavior can be disabled by configuring
1632 @code{org-list-automatic-rules}. The global indentation of a list has no
1633 influence on the text @emph{after} the list.
1636 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1637 state of the checkbox. Also, makes sure that all the
1638 items on this list level use the same bullet and that the numbering of list
1639 items (if applicable) is correct.
1641 @vindex org-plain-list-ordered-item-terminator
1642 @vindex org-list-automatic-rules
1644 Cycle the entire list level through the different itemize/enumerate bullets
1645 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1646 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1647 and its position@footnote{See @code{bullet} rule in
1648 @code{org-list-automatic-rules} for more information.}. With a numeric
1649 prefix argument N, select the Nth bullet from this list. If there is an
1650 active region when calling this, all lines will be converted to list items.
1651 If the first line already was a list item, any item markers will be removed
1652 from the list. Finally, even without an active region, a normal line will be
1653 converted into a list item.
1656 Turn a plain list item into a headline (so that it becomes a subheading at
1657 its location). @xref{Structure editing}, for a detailed explanation.
1658 @kindex S-@key{left}
1659 @kindex S-@key{right}
1660 @item S-@key{left}/@key{right}
1661 @vindex org-support-shift-select
1662 This command also cycles bullet styles when the cursor in on the bullet or
1663 anywhere in an item line, details depending on
1664 @code{org-support-shift-select}.
1667 Sort the plain list. You will be prompted for the sorting method:
1668 numerically, alphabetically, by time, or by custom function.
1671 @node Drawers, Blocks, Plain lists, Document Structure
1675 @cindex visibility cycling, drawers
1678 Sometimes you want to keep information associated with an entry, but you
1679 normally don't want to see it. For this, Org-mode has @emph{drawers}.
1680 Drawers need to be configured with the variable
1681 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1682 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1686 ** This is a headline
1687 Still outside the drawer
1689 This is inside the drawer.
1694 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1695 show the entry, but keep the drawer collapsed to a single line. In order to
1696 look inside the drawer, you need to move the cursor to the drawer line and
1697 press @key{TAB} there. Org-mode uses the @code{PROPERTIES} drawer for
1698 storing properties (@pxref{Properties and Columns}), and you can also arrange
1699 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1700 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1701 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1706 Add a time-stamped note to the LOGBOOK drawer.
1709 @node Blocks, Footnotes, Drawers, Document Structure
1712 @vindex org-hide-block-startup
1713 @cindex blocks, folding
1714 Org-mode uses begin...end blocks for various purposes from including source
1715 code examples (@pxref{Literal examples}) to capturing time logging
1716 information (@pxref{Clocking work time}). These blocks can be folded and
1717 unfolded by pressing TAB in the begin line. You can also get all blocks
1718 folded at startup by configuring the variable @code{org-hide-block-startup}
1719 or on a per-file basis by using
1721 @cindex @code{hideblocks}, STARTUP keyword
1722 @cindex @code{nohideblocks}, STARTUP keyword
1724 #+STARTUP: hideblocks
1725 #+STARTUP: nohideblocks
1728 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1732 Org-mode supports the creation of footnotes. In contrast to the
1733 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
1734 larger document, not only for one-off documents like emails. The basic
1735 syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is
1736 defined in a paragraph that is started by a footnote marker in square
1737 brackets in column 0, no indentation allowed. If you need a paragraph break
1738 inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
1739 is simply the marker in square brackets, inside text. For example:
1742 The Org homepage[fn:1] now looks a lot better than it used to.
1744 [fn:1] The link is: http://orgmode.org
1747 Org-mode extends the number-based syntax to @emph{named} footnotes and
1748 optional inline definition. Using plain numbers as markers (as
1749 @file{footnote.el} does) is supported for backward compatibility, but not
1750 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1751 LaTeX}). Here are the valid references:
1755 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1756 recommended because something like @samp{[1]} could easily be part of a code
1759 A named footnote reference, where @code{name} is a unique label word, or, for
1760 simplicity of automatic creation, a number.
1761 @item [fn:: This is the inline definition of this footnote]
1762 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1764 @item [fn:name: a definition]
1765 An inline definition of a footnote, which also specifies a name for the note.
1766 Since Org allows multiple references to the same note, you can then use
1767 @code{[fn:name]} to create additional references.
1770 @vindex org-footnote-auto-label
1771 Footnote labels can be created automatically, or you can create names yourself.
1772 This is handled by the variable @code{org-footnote-auto-label} and its
1773 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1776 @noindent The following command handles footnotes:
1781 The footnote action command.
1783 When the cursor is on a footnote reference, jump to the definition. When it
1784 is at a definition, jump to the (first) reference.
1786 @vindex org-footnote-define-inline
1787 @vindex org-footnote-section
1788 @vindex org-footnote-auto-adjust
1789 Otherwise, create a new footnote. Depending on the variable
1790 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1791 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1792 definition will be placed right into the text as part of the reference, or
1793 separately into the location determined by the variable
1794 @code{org-footnote-section}.
1796 When this command is called with a prefix argument, a menu of additional
1799 s @r{Sort the footnote definitions by reference sequence. During editing,}
1800 @r{Org makes no effort to sort footnote definitions into a particular}
1801 @r{sequence. If you want them sorted, use this command, which will}
1802 @r{also move entries according to @code{org-footnote-section}. Automatic}
1803 @r{sorting after each insertion/deletion can be configured using the}
1804 @r{variable @code{org-footnote-auto-adjust}.}
1805 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1806 @r{after each insertion/deletion can be configured using the variable}
1807 @r{@code{org-footnote-auto-adjust}.}
1808 S @r{Short for first @code{r}, then @code{s} action.}
1809 n @r{Normalize the footnotes by collecting all definitions (including}
1810 @r{inline definitions) into a special section, and then numbering them}
1811 @r{in sequence. The references will then also be numbers. This is}
1812 @r{meant to be the final step before finishing a document (e.g. sending}
1813 @r{off an email). The exporters do this automatically, and so could}
1814 @r{something like @code{message-send-hook}.}
1815 d @r{Delete the footnote at point, and all definitions of and references}
1818 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1819 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1820 renumbering and sorting footnotes can be automatic after each insertion or
1825 If the cursor is on a footnote reference, jump to the definition. If it is a
1826 the definition, jump back to the reference. When called at a footnote
1827 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1831 @item C-c C-o @r{or} mouse-1/2
1832 Footnote labels are also links to the corresponding definition/reference, and
1833 you can use the usual commands to follow these links.
1836 @node Orgstruct mode, , Footnotes, Document Structure
1837 @section The Orgstruct minor mode
1838 @cindex Orgstruct mode
1839 @cindex minor mode for structure editing
1841 If you like the intuitive way the Org-mode structure editing and list
1842 formatting works, you might want to use these commands in other modes like
1843 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1844 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1845 turn it on by default, for example in Message mode, with one of:
1848 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1849 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1852 When this mode is active and the cursor is on a line that looks to Org like a
1853 headline or the first line of a list item, most structure editing commands
1854 will work, even if the same keys normally have different functionality in the
1855 major mode you are using. If the cursor is not in one of those special
1856 lines, Orgstruct mode lurks silently in the shadows. When you use
1857 @code{orgstruct++-mode}, Org will also export indentation and autofill
1858 settings into that mode, and detect item context after the first line of an
1861 @node Tables, Hyperlinks, Document Structure, Top
1864 @cindex editing tables
1866 Org comes with a fast and intuitive table editor. Spreadsheet-like
1867 calculations are supported using the Emacs @file{calc} package
1869 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1872 (see the Emacs Calculator manual for more information about the Emacs
1877 * Built-in table editor:: Simple tables
1878 * Column width and alignment:: Overrule the automatic settings
1879 * Column groups:: Grouping to trigger vertical lines
1880 * Orgtbl mode:: The table editor as minor mode
1881 * The spreadsheet:: The table editor has spreadsheet capabilities
1882 * Org-Plot:: Plotting from org tables
1885 @node Built-in table editor, Column width and alignment, Tables, Tables
1886 @section The built-in table editor
1887 @cindex table editor, built-in
1889 Org makes it easy to format tables in plain ASCII. Any line with
1890 @samp{|} as the first non-whitespace character is considered part of a
1891 table. @samp{|} is also the column separator. A table might look like
1895 | Name | Phone | Age |
1896 |-------+-------+-----|
1897 | Peter | 1234 | 17 |
1898 | Anna | 4321 | 25 |
1901 A table is re-aligned automatically each time you press @key{TAB} or
1902 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1903 the next field (@key{RET} to the next row) and creates new table rows
1904 at the end of the table or before horizontal lines. The indentation
1905 of the table is set by the first line. Any line starting with
1906 @samp{|-} is considered as a horizontal separator line and will be
1907 expanded on the next re-align to span the whole table width. So, to
1908 create the above table, you would only type
1915 @noindent and then press @key{TAB} to align the table and start filling in
1916 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1917 @kbd{C-c @key{RET}}.
1919 @vindex org-enable-table-editor
1920 @vindex org-table-auto-blank-field
1921 When typing text into a field, Org treats @key{DEL},
1922 @key{Backspace}, and all character keys in a special way, so that
1923 inserting and deleting avoids shifting other fields. Also, when
1924 typing @emph{immediately after the cursor was moved into a new field
1925 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1926 field is automatically made blank. If this behavior is too
1927 unpredictable for you, configure the variables
1928 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1931 @tsubheading{Creation and conversion}
1932 @orgcmd{C-c |,org-table-create-or-convert-from-region}
1933 Convert the active region to table. If every line contains at least one
1934 TAB character, the function assumes that the material is tab separated.
1935 If every line contains a comma, comma-separated values (CSV) are assumed.
1936 If not, lines are split at whitespace into fields. You can use a prefix
1937 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1938 C-u} forces TAB, and a numeric argument N indicates that at least N
1939 consecutive spaces, or alternatively a TAB will be the separator.
1941 If there is no active region, this command creates an empty Org
1942 table. But it's easier just to start typing, like
1943 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1945 @tsubheading{Re-aligning and field motion}
1946 @orgcmd{C-c C-c,org-table-align}
1947 Re-align the table without moving the cursor.
1949 @orgcmd{<TAB>,org-table-next-field}
1950 Re-align the table, move to the next field. Creates a new row if
1953 @orgcmd{S-@key{TAB},org-table-previous-field}
1954 Re-align, move to previous field.
1956 @orgcmd{@key{RET},org-table-next-row}
1957 Re-align the table and move down to next row. Creates a new row if
1958 necessary. At the beginning or end of a line, @key{RET} still does
1959 NEWLINE, so it can be used to split a table.
1961 @orgcmd{M-a,org-table-beginning-of-field}
1962 Move to beginning of the current table field, or on to the previous field.
1963 @orgcmd{M-e,org-table-end-of-field}
1964 Move to end of the current table field, or on to the next field.
1966 @tsubheading{Column and row editing}
1967 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
1968 Move the current column left/right.
1970 @orgcmd{M-S-@key{left},org-table-delete-column}
1971 Kill the current column.
1973 @orgcmd{M-S-@key{right},org-table-insert-column}
1974 Insert a new column to the left of the cursor position.
1976 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
1977 Move the current row up/down.
1979 @orgcmd{M-S-@key{up},org-table-kill-row}
1980 Kill the current row or horizontal line.
1982 @orgcmd{M-S-@key{down},org-table-insert-row}
1983 Insert a new row above the current row. With a prefix argument, the line is
1984 created below the current one.
1986 @orgcmd{C-c -,org-table-insert-hline}
1987 Insert a horizontal line below current row. With a prefix argument, the line
1988 is created above the current line.
1990 @orgcmd{C-c @key{RET},org-table-hline-and-move}
1991 Insert a horizontal line below current row, and move the cursor into the row
1994 @orgcmd{C-c ^,org-table-sort-lines}
1995 Sort the table lines in the region. The position of point indicates the
1996 column to be used for sorting, and the range of lines is the range
1997 between the nearest horizontal separator lines, or the entire table. If
1998 point is before the first column, you will be prompted for the sorting
1999 column. If there is an active region, the mark specifies the first line
2000 and the sorting column, while point should be in the last line to be
2001 included into the sorting. The command prompts for the sorting type
2002 (alphabetically, numerically, or by time). When called with a prefix
2003 argument, alphabetic sorting will be case-sensitive.
2005 @tsubheading{Regions}
2006 @orgcmd{C-c C-x M-w,org-table-copy-region}
2007 Copy a rectangular region from a table to a special clipboard. Point and
2008 mark determine edge fields of the rectangle. If there is no active region,
2009 copy just the current field. The process ignores horizontal separator lines.
2011 @orgcmd{C-c C-x C-w,org-table-cut-region}
2012 Copy a rectangular region from a table to a special clipboard, and
2013 blank all fields in the rectangle. So this is the ``cut'' operation.
2015 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2016 Paste a rectangular region into a table.
2017 The upper left corner ends up in the current field. All involved fields
2018 will be overwritten. If the rectangle does not fit into the present table,
2019 the table is enlarged as needed. The process ignores horizontal separator
2022 @orgcmd{M-@key{RET},org-table-wrap-region}
2023 Split the current field at the cursor position and move the rest to the line
2024 below. If there is an active region, and both point and mark are in the same
2025 column, the text in the column is wrapped to minimum width for the given
2026 number of lines. A numeric prefix argument may be used to change the number
2027 of desired lines. If there is no region, but you specify a prefix argument,
2028 the current field is made blank, and the content is appended to the field
2031 @tsubheading{Calculations}
2032 @cindex formula, in tables
2033 @cindex calculations, in tables
2034 @cindex region, active
2035 @cindex active region
2036 @cindex transient mark mode
2037 @orgcmd{C-c +,org-table-sum}
2038 Sum the numbers in the current column, or in the rectangle defined by
2039 the active region. The result is shown in the echo area and can
2040 be inserted with @kbd{C-y}.
2042 @orgcmd{S-@key{RET},org-table-copy-down}
2043 @vindex org-table-copy-increment
2044 When current field is empty, copy from first non-empty field above. When not
2045 empty, copy current field down to next row and move cursor along with it.
2046 Depending on the variable @code{org-table-copy-increment}, integer field
2047 values will be incremented during copy. Integers that are too large will not
2048 be incremented. Also, a @code{0} prefix argument temporarily disables the
2049 increment. This key is also used by shift-selection and related modes
2050 (@pxref{Conflicts}).
2052 @tsubheading{Miscellaneous}
2053 @orgcmd{C-c `,org-table-edit-field}
2054 Edit the current field in a separate window. This is useful for fields that
2055 are not fully visible (@pxref{Column width and alignment}). When called with
2056 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2059 @item M-x org-table-import
2060 Import a file as a table. The table should be TAB or whitespace
2061 separated. Use, for example, to import a spreadsheet table or data
2062 from a database, because these programs generally can write
2063 TAB-separated text files. This command works by inserting the file into
2064 the buffer and then converting the region to a table. Any prefix
2065 argument is passed on to the converter, which uses it to determine the
2067 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2068 Tables can also be imported by pasting tabular text into the Org
2069 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2070 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2072 @item M-x org-table-export
2073 @findex org-table-export
2074 @vindex org-table-export-default-format
2075 Export the table, by default as a TAB-separated file. Use for data
2076 exchange with, for example, spreadsheet or database programs. The format
2077 used to export the file can be configured in the variable
2078 @code{org-table-export-default-format}. You may also use properties
2079 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2080 name and the format for table export in a subtree. Org supports quite
2081 general formats for exported tables. The exporter format is the same as the
2082 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2083 detailed description.
2086 If you don't like the automatic table editor because it gets in your
2087 way on lines which you would like to start with @samp{|}, you can turn
2091 (setq org-enable-table-editor nil)
2094 @noindent Then the only table command that still works is
2095 @kbd{C-c C-c} to do a manual re-align.
2097 @node Column width and alignment, Column groups, Built-in table editor, Tables
2098 @section Column width and alignment
2099 @cindex narrow columns in tables
2100 @cindex alignment in tables
2102 The width of columns is automatically determined by the table editor. And
2103 also the alignment of a column is determined automatically from the fraction
2104 of number-like versus non-number fields in the column.
2106 Sometimes a single field or a few fields need to carry more text, leading to
2107 inconveniently wide columns. Or maybe you want to make a table with several
2108 columns having a fixed width, regardless of content. To set@footnote{This
2109 feature does not work on XEmacs.} the width of a column, one field anywhere
2110 in the column may contain just the string @samp{<N>} where @samp{N} is an
2111 integer specifying the width of the column in characters. The next re-align
2112 will then set the width of this column to this value.
2116 |---+------------------------------| |---+--------|
2118 | 1 | one | | 1 | one |
2119 | 2 | two | ----\ | 2 | two |
2120 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2121 | 4 | four | | 4 | four |
2122 |---+------------------------------| |---+--------|
2127 Fields that are wider become clipped and end in the string @samp{=>}.
2128 Note that the full text is still in the buffer but is hidden.
2129 To see the full text, hold the mouse over the field---a tool-tip window
2130 will show the full content. To edit such a field, use the command
2131 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2132 open a new window with the full field. Edit it and finish with @kbd{C-c
2135 @vindex org-startup-align-all-tables
2136 When visiting a file containing a table with narrowed columns, the
2137 necessary character hiding has not yet happened, and the table needs to
2138 be aligned before it looks nice. Setting the option
2139 @code{org-startup-align-all-tables} will realign all tables in a file
2140 upon visiting, but also slow down startup. You can also set this option
2141 on a per-file basis with:
2148 If you would like to overrule the automatic alignment of number-rich columns
2149 to the right and of string-rich column to the left, you can use @samp{<r>},
2150 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2151 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2152 also combine alignment and field width like this: @samp{<l10>}.
2154 Lines which only contain these formatting cookies will be removed
2155 automatically when exporting the document.
2157 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2158 @section Column groups
2159 @cindex grouping columns in tables
2161 When Org exports tables, it does so by default without vertical
2162 lines because that is visually more satisfying in general. Occasionally
2163 however, vertical lines can be useful to structure a table into groups
2164 of columns, much like horizontal lines can do for groups of rows. In
2165 order to specify column groups, you can use a special row where the
2166 first field contains only @samp{/}. The further fields can either
2167 contain @samp{<} to indicate that this column should start a group,
2168 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2169 a group of its own. Boundaries between column groups will upon export be
2170 marked with vertical lines. Here is an example:
2173 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2174 |---+-----+-----+-----+---------+------------|
2175 | / | < | | > | < | > |
2176 | 1 | 1 | 1 | 1 | 1 | 1 |
2177 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2178 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2179 |---+-----+-----+-----+---------+------------|
2180 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2183 It is also sufficient to just insert the column group starters after
2184 every vertical line you would like to have:
2187 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2188 |----+-----+-----+-----+---------+------------|
2192 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2193 @section The Orgtbl minor mode
2195 @cindex minor mode for tables
2197 If you like the intuitive way the Org table editor works, you
2198 might also want to use it in other modes like Text mode or Mail mode.
2199 The minor mode Orgtbl mode makes this possible. You can always toggle
2200 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2201 example in Message mode, use
2204 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2207 Furthermore, with some special setup, it is possible to maintain tables
2208 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2209 construct @LaTeX{} tables with the underlying ease and power of
2210 Orgtbl mode, including spreadsheet capabilities. For details, see
2211 @ref{Tables in arbitrary syntax}.
2213 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2214 @section The spreadsheet
2215 @cindex calculations, in tables
2216 @cindex spreadsheet capabilities
2217 @cindex @file{calc} package
2219 The table editor makes use of the Emacs @file{calc} package to implement
2220 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2221 derive fields from other fields. While fully featured, Org's implementation
2222 is not identical to other spreadsheets. For example, Org knows the concept
2223 of a @emph{column formula} that will be applied to all non-header fields in a
2224 column without having to copy the formula to each relevant field. There is
2225 also a formula debugger, and a formula editor with features for highlighting
2226 fields in the table corresponding to the references at the point in the
2227 formula, moving these references by arrow keys
2230 * References:: How to refer to another field or range
2231 * Formula syntax for Calc:: Using Calc to compute stuff
2232 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2233 * Field formulas:: Formulas valid for a single field
2234 * Column formulas:: Formulas valid for an entire column
2235 * Editing and debugging formulas:: Fixing formulas
2236 * Updating the table:: Recomputing all dependent fields
2237 * Advanced features:: Field names, parameters and automatic recalc
2240 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2241 @subsection References
2244 To compute fields in the table from other fields, formulas must
2245 reference other fields or ranges. In Org, fields can be referenced
2246 by name, by absolute coordinates, and by relative coordinates. To find
2247 out what the coordinates of a field are, press @kbd{C-c ?} in that
2248 field, or press @kbd{C-c @}} to toggle the display of a grid.
2250 @subsubheading Field references
2251 @cindex field references
2252 @cindex references, to fields
2254 Formulas can reference the value of another field in two ways. Like in
2255 any other spreadsheet, you may reference fields with a letter/number
2256 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2257 @c Such references are always fixed to that field, they don't change
2258 @c when you copy and paste a formula to a different field. So
2259 @c Org's @code{B3} behaves like @code{$B$3} in other spreadsheets.
2262 Org also uses another, more general operator that looks like this:
2264 @@@var{row}$@var{column}
2268 Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}},
2269 or relative to the current column like @samp{+1} or @samp{-2}.
2271 The row specification only counts data lines and ignores horizontal
2272 separator lines (hlines). You can use absolute row numbers
2273 @samp{1}...@samp{@var{N}}, and row numbers relative to the current row like
2274 @samp{+3} or @samp{-1}. Or specify the row relative to one of the
2275 hlines: @samp{I} refers to the first hline@footnote{Note that only
2276 hlines are counted that @emph{separate} table lines. If the table
2277 starts with a hline above the header, it does not count.}, @samp{II} to
2278 the second, etc@. @samp{-I} refers to the first such line above the
2279 current line, @samp{+I} to the first such line below the current line.
2280 You can also write @samp{III+2} which is the second data line after the
2281 third hline in the table.
2283 @samp{0} refers to the current row and column. Also, if you omit
2284 either the column or the row part of the reference, the current
2285 row/column is implied.
2287 Org's references with @emph{unsigned} numbers are fixed references
2288 in the sense that if you use the same reference in the formula for two
2289 different fields, the same field will be referenced each time.
2290 Org's references with @emph{signed} numbers are floating
2291 references because the same reference operator can reference different
2292 fields depending on the field being calculated by the formula.
2294 As a special case, references like @samp{$LR5} and @samp{$LR12} can be used
2295 to refer in a stable way to the 5th and 12th field in the last row of the
2298 Here are a few examples:
2301 @@2$3 @r{2nd row, 3rd column}
2302 C2 @r{same as previous}
2303 $5 @r{column 5 in the current row}
2304 E& @r{same as previous}
2305 @@2 @r{current column, row 2}
2306 @@-1$-3 @r{the field one row up, three columns to the left}
2307 @@-I$2 @r{field just under hline above current row, column 2}
2310 @subsubheading Range references
2311 @cindex range references
2312 @cindex references, to ranges
2314 You may reference a rectangular range of fields by specifying two field
2315 references connected by two dots @samp{..}. If both fields are in the
2316 current row, you may simply use @samp{$2..$7}, but if at least one field
2317 is in a different row, you need to use the general @code{@@row$column}
2318 format at least for the first field (i.e the reference must start with
2319 @samp{@@} in order to be interpreted correctly). Examples:
2322 $1..$3 @r{First three fields in the current row.}
2323 $P..$Q @r{Range, using column names (see under Advanced)}
2324 @@2$1..@@4$3 @r{6 fields between these two fields.}
2325 A2..C4 @r{Same as above.}
2326 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2329 @noindent Range references return a vector of values that can be fed
2330 into Calc vector functions. Empty fields in ranges are normally
2331 suppressed, so that the vector contains only the non-empty fields (but
2332 see the @samp{E} mode switch below). If there are no non-empty fields,
2333 @samp{[0]} is returned to avoid syntax errors in formulas.
2335 @subsubheading Field coordinates in formulas
2336 @cindex field coordinates
2337 @cindex coordinates, of field
2338 @cindex row, of field coordinates
2339 @cindex column, of field coordinates
2341 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2342 get the row or column number of the field where the formula result goes.
2343 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2344 and @code{org-table-current-column}. Examples:
2347 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2348 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2349 @r{column 3 of the current table}
2352 @noindent For the second example, table FOO must have at least as many rows
2353 as the current table. Inefficient@footnote{The computation time scales as
2354 O(N^2) because table FOO is parsed for each field to be copied.} for large
2357 @subsubheading Named references
2358 @cindex named references
2359 @cindex references, named
2360 @cindex name, of column or field
2361 @cindex constants, in calculations
2364 @vindex org-table-formula-constants
2365 @samp{$name} is interpreted as the name of a column, parameter or
2366 constant. Constants are defined globally through the variable
2367 @code{org-table-formula-constants}, and locally (for the file) through a
2371 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2375 @vindex constants-unit-system
2376 @pindex constants.el
2377 Also properties (@pxref{Properties and Columns}) can be used as
2378 constants in table formulas: for a property @samp{:Xyz:} use the name
2379 @samp{$PROP_Xyz}, and the property will be searched in the current
2380 outline entry and in the hierarchy above it. If you have the
2381 @file{constants.el} package, it will also be used to resolve constants,
2382 including natural constants like @samp{$h} for Planck's constant, and
2383 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2384 supply the values of constants in two different unit systems, @code{SI}
2385 and @code{cgs}. Which one is used depends on the value of the variable
2386 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2387 @code{constSI} and @code{constcgs} to set this value for the current
2388 buffer.}. Column names and parameters can be specified in special table
2389 lines. These are described below, see @ref{Advanced features}. All
2390 names must start with a letter, and further consist of letters and
2393 @subsubheading Remote references
2394 @cindex remote references
2395 @cindex references, remote
2396 @cindex references, to a different table
2397 @cindex name, of column or field
2398 @cindex constants, in calculations
2401 You may also reference constants, fields and ranges from a different table,
2402 either in the current file or even in a different file. The syntax is
2405 remote(NAME-OR-ID,REF)
2409 where NAME can be the name of a table in the current file as set by a
2410 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2411 entry, even in a different file, and the reference then refers to the first
2412 table in that entry. REF is an absolute field or range reference as
2413 described above for example @code{@@3$3} or @code{$somename}, valid in the
2416 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2417 @subsection Formula syntax for Calc
2418 @cindex formula syntax, Calc
2419 @cindex syntax, of formulas
2421 A formula can be any algebraic expression understood by the Emacs
2422 @file{Calc} package. @b{Note that @file{calc} has the
2423 non-standard convention that @samp{/} has lower precedence than
2424 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2425 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2426 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2427 Emacs Calc Manual}),
2428 @c FIXME: The link to the Calc manual in HTML does not work.
2429 variable substitution takes place according to the rules described above.
2430 @cindex vectors, in table calculations
2431 The range vectors can be directly fed into the Calc vector functions
2432 like @samp{vmean} and @samp{vsum}.
2434 @cindex format specifier
2435 @cindex mode, for @file{calc}
2436 @vindex org-calc-default-modes
2437 A formula can contain an optional mode string after a semicolon. This
2438 string consists of flags to influence Calc and other modes during
2439 execution. By default, Org uses the standard Calc modes (precision
2440 12, angular units degrees, fraction and symbolic modes off). The display
2441 format, however, has been changed to @code{(float 8)} to keep tables
2442 compact. The default settings can be configured using the variable
2443 @code{org-calc-default-modes}.
2446 p20 @r{set the internal Calc calculation precision to 20 digits}
2447 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2448 @r{format of the result of Calc passed back to Org.}
2449 @r{Calc formatting is unlimited in precision as}
2450 @r{long as the Calc calculation precision is greater.}
2451 D R @r{angle modes: degrees, radians}
2452 F S @r{fraction and symbolic modes}
2453 N @r{interpret all fields as numbers, use 0 for non-numbers}
2454 T @r{force text interpretation}
2455 E @r{keep empty fields in ranges}
2460 Unless you use large integer numbers or high-precision-calculation
2461 and -display for floating point numbers you may alternatively provide a
2462 @code{printf} format specifier to reformat the Calc result after it has been
2463 passed back to Org instead of letting Calc already do the
2464 formatting@footnote{The @code{printf} reformatting is limited in precision
2465 because the value passed to it is converted into an @code{integer} or
2466 @code{double}. The @code{integer} is limited in size by truncating the
2467 signed value to 32 bits. The @code{double} is limited in precision to 64
2468 bits overall which leaves approximately 16 significant decimal digits.}.
2472 $1+$2 @r{Sum of first and second field}
2473 $1+$2;%.2f @r{Same, format result to two decimals}
2474 exp($2)+exp($1) @r{Math functions can be used}
2475 $0;%.1f @r{Reformat current cell to 1 decimal}
2476 ($3-32)*5/9 @r{Degrees F -> C conversion}
2477 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2478 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2479 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2480 vmean($2..$7) @r{Compute column range mean, using vector function}
2481 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2482 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2485 Calc also contains a complete set of logical operations. For example
2488 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
2491 @node Formula syntax for Lisp, Field formulas, Formula syntax for Calc, The spreadsheet
2492 @subsection Emacs Lisp forms as formulas
2493 @cindex Lisp forms, as table formulas
2495 It is also possible to write a formula in Emacs Lisp; this can be useful for
2496 string manipulation and control structures, if Calc's functionality is not
2497 enough. If a formula starts with a single-quote followed by an opening
2498 parenthesis, then it is evaluated as a Lisp form. The evaluation should
2499 return either a string or a number. Just as with @file{calc} formulas, you
2500 can specify modes and a printf format after a semicolon. With Emacs Lisp
2501 forms, you need to be conscious about the way field references are
2502 interpolated into the form. By default, a reference will be interpolated as
2503 a Lisp string (in double-quotes) containing the field. If you provide the
2504 @samp{N} mode switch, all referenced elements will be numbers (non-number
2505 fields will be zero) and interpolated as Lisp numbers, without quotes. If
2506 you provide the @samp{L} flag, all fields will be interpolated literally,
2507 without quotes. I.e., if you want a reference to be interpreted as a string
2508 by the Lisp form, enclose the reference operator itself in double-quotes,
2509 like @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2510 +embed them in list or vector syntax. Here are a few examples---note how the
2511 @samp{N} mode is used when we do computations in Lisp:
2514 @r{Swap the first two characters of the content of column 1}
2515 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2516 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2518 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2519 '(apply '+ '($1..$4));N
2522 @node Field formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2523 @subsection Field formulas
2524 @cindex field formula
2525 @cindex formula, for individual table field
2527 To assign a formula to a particular field, type it directly into the
2528 field, preceded by @samp{:=}, for example @samp{:=$1+$2}. When you
2529 press @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in
2530 the field, the formula will be stored as the formula for this field,
2531 evaluated, and the current field replaced with the result.
2534 Formulas are stored in a special line starting with @samp{#+TBLFM:}
2535 directly below the table. If you type the equation in the 4th field of
2536 the 3rd data line in the table, the formula will look like
2537 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
2538 with the appropriate commands, @i{absolute references} (but not relative
2539 ones) in stored formulas are modified in order to still reference the
2540 same field. Of course this is not true if you edit the table structure
2541 with normal editing commands---then you must fix the equations yourself.
2542 The left-hand side of a formula may also be a named field (@pxref{Advanced
2543 features}), or a last-row reference like @samp{$LR3}.
2545 Instead of typing an equation into the field, you may also use the
2549 @orgcmd{C-u C-c =,org-table-eval-formula}
2550 Install a new formula for the current field. The command prompts for a
2551 formula with default taken from the @samp{#+TBLFM:} line, applies
2552 it to the current field, and stores it.
2555 @node Column formulas, Editing and debugging formulas, Field formulas, The spreadsheet
2556 @subsection Column formulas
2557 @cindex column formula
2558 @cindex formula, for table column
2560 Often in a table, the same formula should be used for all fields in a
2561 particular column. Instead of having to copy the formula to all fields
2562 in that column, Org allows you to assign a single formula to an entire
2563 column. If the table contains horizontal separator hlines, everything
2564 before the first such line is considered part of the table @emph{header}
2565 and will not be modified by column formulas.
2567 To assign a formula to a column, type it directly into any field in the
2568 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2569 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2570 the formula will be stored as the formula for the current column, evaluated
2571 and the current field replaced with the result. If the field contains only
2572 @samp{=}, the previously stored formula for this column is used. For each
2573 column, Org will only remember the most recently used formula. In the
2574 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand
2575 side of a column formula cannot currently be the name of column, it
2576 must be the numeric column reference.
2578 Instead of typing an equation into the field, you may also use the
2582 @orgcmd{C-c =,org-table-eval-formula}
2583 Install a new formula for the current column and replace current field with
2584 the result of the formula. The command prompts for a formula, with default
2585 taken from the @samp{#+TBLFM} line, applies it to the current field and
2586 stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command
2587 will apply it to that many consecutive fields in the current column.
2590 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2591 @subsection Editing and debugging formulas
2592 @cindex formula editing
2593 @cindex editing, of table formulas
2595 @vindex org-table-use-standard-references
2596 You can edit individual formulas in the minibuffer or directly in the
2597 field. Org can also prepare a special buffer with all active
2598 formulas of a table. When offering a formula for editing, Org
2599 converts references to the standard format (like @code{B3} or @code{D&})
2600 if possible. If you prefer to only work with the internal format (like
2601 @code{@@3$2} or @code{$4}), configure the variable
2602 @code{org-table-use-standard-references}.
2605 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2606 Edit the formula associated with the current column/field in the
2607 minibuffer. See @ref{Column formulas}, and @ref{Field formulas}.
2608 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2609 Re-insert the active formula (either a
2610 field formula, or a column formula) into the current field, so that you
2611 can edit it directly in the field. The advantage over editing in the
2612 minibuffer is that you can use the command @kbd{C-c ?}.
2613 @orgcmd{C-c ?,org-table-field-info}
2614 While editing a formula in a table field, highlight the field(s)
2615 referenced by the reference at the cursor position in the formula.
2617 @findex org-table-toggle-coordinate-overlays
2619 Toggle the display of row and column numbers for a table, using overlays
2620 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2621 time the table is aligned; you can force it with @kbd{C-c C-c}.
2623 @findex org-table-toggle-formula-debugger
2625 Toggle the formula debugger on and off
2626 (@command{org-table-toggle-formula-debugger}). See below.
2627 @orgcmd{C-c ',org-table-edit-formulas}
2628 Edit all formulas for the current table in a special buffer, where the
2629 formulas will be displayed one per line. If the current field has an
2630 active formula, the cursor in the formula editor will mark it.
2631 While inside the special buffer, Org will automatically highlight
2632 any field or range reference at the cursor position. You may edit,
2633 remove and add formulas, and use the following commands:
2635 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2636 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2637 prefix, also apply the new formulas to the entire table.
2638 @orgcmd{C-c C-q,org-table-fedit-abort}
2639 Exit the formula editor without installing changes.
2640 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2641 Toggle all references in the formula editor between standard (like
2642 @code{B3}) and internal (like @code{@@3$2}).
2643 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2644 Pretty-print or indent Lisp formula at point. When in a line containing
2645 a Lisp formula, format the formula according to Emacs Lisp rules.
2646 Another @key{TAB} collapses the formula back again. In the open
2647 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2648 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2649 Complete Lisp symbols, just like in Emacs Lisp mode.
2651 @kindex S-@key{down}
2652 @kindex S-@key{left}
2653 @kindex S-@key{right}
2654 @findex org-table-fedit-ref-up
2655 @findex org-table-fedit-ref-down
2656 @findex org-table-fedit-ref-left
2657 @findex org-table-fedit-ref-right
2658 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2659 Shift the reference at point. For example, if the reference is
2660 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2661 This also works for relative references and for hline references.
2662 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2663 Move the test line for column formulas in the Org buffer up and
2665 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2666 Scroll the window displaying the table.
2668 @findex org-table-toggle-coordinate-overlays
2670 Turn the coordinate grid in the table on and off.
2674 Making a table field blank does not remove the formula associated with
2675 the field, because that is stored in a different line (the @samp{#+TBLFM}
2676 line)---during the next recalculation the field will be filled again.
2677 To remove a formula from a field, you have to give an empty reply when
2678 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2681 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2682 equations with @kbd{C-c C-c} in that line or with the normal
2683 recalculation commands in the table.
2685 @subsubheading Debugging formulas
2686 @cindex formula debugging
2687 @cindex debugging, of table formulas
2688 When the evaluation of a formula leads to an error, the field content
2689 becomes the string @samp{#ERROR}. If you would like see what is going
2690 on during variable substitution and calculation in order to find a bug,
2691 turn on formula debugging in the @code{Tbl} menu and repeat the
2692 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2693 field. Detailed information will be displayed.
2695 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2696 @subsection Updating the table
2697 @cindex recomputing table fields
2698 @cindex updating, table
2700 Recalculation of a table is normally not automatic, but needs to be
2701 triggered by a command. See @ref{Advanced features}, for a way to make
2702 recalculation at least semi-automatic.
2704 In order to recalculate a line of a table or the entire table, use the
2708 @orgcmd{C-c *,org-table-recalculate}
2709 Recalculate the current row by first applying the stored column formulas
2710 from left to right, and all field formulas in the current row.
2716 Recompute the entire table, line by line. Any lines before the first
2717 hline are left alone, assuming that these are part of the table header.
2719 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2720 Iterate the table by recomputing it until no further changes occur.
2721 This may be necessary if some computed fields use the value of other
2722 fields that are computed @i{later} in the calculation sequence.
2723 @item M-x org-table-recalculate-buffer-tables
2724 @findex org-table-recalculate-buffer-tables
2725 Recompute all tables in the current buffer.
2726 @item M-x org-table-iterate-buffer-tables
2727 @findex org-table-iterate-buffer-tables
2728 Iterate all tables in the current buffer, in order to converge table-to-table
2732 @node Advanced features, , Updating the table, The spreadsheet
2733 @subsection Advanced features
2735 If you want the recalculation of fields to happen automatically, or if
2736 you want to be able to assign @i{names} to fields and columns, you need
2737 to reserve the first column of the table for special marking characters.
2739 @orgcmd{C-#,org-table-rotate-recalc-marks}
2740 Rotate the calculation mark in first column through the states @samp{ },
2741 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2742 change all marks in the region.
2745 Here is an example of a table that collects exam results of students and
2746 makes use of these features:
2750 |---+---------+--------+--------+--------+-------+------|
2751 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2752 |---+---------+--------+--------+--------+-------+------|
2753 | ! | | P1 | P2 | P3 | Tot | |
2754 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2755 | ^ | | m1 | m2 | m3 | mt | |
2756 |---+---------+--------+--------+--------+-------+------|
2757 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2758 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2759 |---+---------+--------+--------+--------+-------+------|
2760 | | Average | | | | 29.7 | |
2761 | ^ | | | | | at | |
2762 | $ | max=50 | | | | | |
2763 |---+---------+--------+--------+--------+-------+------|
2764 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2768 @noindent @b{Important}: please note that for these special tables,
2769 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2770 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2771 to the field itself. The column formulas are not applied in rows with
2774 @cindex marking characters, tables
2775 The marking characters have the following meaning:
2778 The fields in this line define names for the columns, so that you may
2779 refer to a column as @samp{$Tot} instead of @samp{$6}.
2781 This row defines names for the fields @emph{above} the row. With such
2782 a definition, any formula in the table may use @samp{$m1} to refer to
2783 the value @samp{10}. Also, if you assign a formula to a names field, it
2784 will be stored as @samp{$name=...}.
2786 Similar to @samp{^}, but defines names for the fields in the row
2789 Fields in this row can define @emph{parameters} for formulas. For
2790 example, if a field in a @samp{$} row contains @samp{max=50}, then
2791 formulas in this table can refer to the value 50 using @samp{$max}.
2792 Parameters work exactly like constants, only that they can be defined on
2795 Fields in this row are automatically recalculated when pressing
2796 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2797 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2798 lines will be left alone by this command.
2800 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2801 not for automatic recalculation. Use this when automatic
2802 recalculation slows down editing too much.
2804 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2805 All lines that should be recalculated should be marked with @samp{#}
2808 Do not export this line. Useful for lines that contain the narrowing
2809 @samp{<N>} markers or column group markers.
2812 Finally, just to whet your appetite for what can be done with the
2813 fantastic @file{calc.el} package, here is a table that computes the Taylor
2814 series of degree @code{n} at location @code{x} for a couple of
2819 |---+-------------+---+-----+--------------------------------------|
2820 | | Func | n | x | Result |
2821 |---+-------------+---+-----+--------------------------------------|
2822 | # | exp(x) | 1 | x | 1 + x |
2823 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2824 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2825 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2826 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2827 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2828 |---+-------------+---+-----+--------------------------------------|
2829 #+TBLFM: $5=taylor($2,$4,$3);n3
2833 @node Org-Plot, , The spreadsheet, Tables
2835 @cindex graph, in tables
2836 @cindex plot tables using Gnuplot
2839 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2840 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2841 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2842 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2843 on your system, then call @code{org-plot/gnuplot} on the following table.
2847 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2848 | Sede | Max cites | H-index |
2849 |-----------+-----------+---------|
2850 | Chile | 257.72 | 21.39 |
2851 | Leeds | 165.77 | 19.68 |
2852 | Sao Paolo | 71.00 | 11.50 |
2853 | Stockholm | 134.19 | 14.33 |
2854 | Morelia | 257.56 | 17.67 |
2858 Notice that Org Plot is smart enough to apply the table's headers as labels.
2859 Further control over the labels, type, content, and appearance of plots can
2860 be exercised through the @code{#+PLOT:} lines preceding a table. See below
2861 for a complete list of Org-plot options. For more information and examples
2862 see the Org-plot tutorial at
2863 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
2865 @subsubheading Plot Options
2869 Specify any @command{gnuplot} option to be set when graphing.
2872 Specify the title of the plot.
2875 Specify which column of the table to use as the @code{x} axis.
2878 Specify the columns to graph as a Lisp style list, surrounded by parentheses
2879 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2880 fourth columns (defaults to graphing all other columns aside from the @code{ind}
2884 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2887 Specify a @code{with} option to be inserted for every col being plotted
2888 (e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2889 Defaults to @code{lines}.
2892 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
2895 List of labels to be used for the @code{deps} (defaults to the column headers
2899 Specify an entire line to be inserted in the Gnuplot script.
2902 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2903 flat mapping rather than a @code{3d} slope.
2906 Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
2907 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
2910 If you want total control, you can specify a script file (place the file name
2911 between double-quotes) which will be used to plot. Before plotting, every
2912 instance of @code{$datafile} in the specified script will be replaced with
2913 the path to the generated data file. Note: even if you set this option, you
2914 may still want to specify the plot type, as that can impact the content of
2918 @node Hyperlinks, TODO Items, Tables, Top
2922 Like HTML, Org provides links inside a file, external links to
2923 other files, Usenet articles, emails, and much more.
2926 * Link format:: How links in Org are formatted
2927 * Internal links:: Links to other places in the current file
2928 * External links:: URL-like links to the world
2929 * Handling links:: Creating, inserting and following
2930 * Using links outside Org:: Linking from my C source code?
2931 * Link abbreviations:: Shortcuts for writing complex links
2932 * Search options:: Linking to a specific location
2933 * Custom searches:: When the default search is not enough
2936 @node Link format, Internal links, Hyperlinks, Hyperlinks
2937 @section Link format
2939 @cindex format, of links
2941 Org will recognize plain URL-like links and activate them as
2942 clickable links. The general link format, however, looks like this:
2945 [[link][description]] @r{or alternatively} [[link]]
2949 Once a link in the buffer is complete (all brackets present), Org
2950 will change the display so that @samp{description} is displayed instead
2951 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2952 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
2953 which by default is an underlined face. You can directly edit the
2954 visible part of a link. Note that this can be either the @samp{link}
2955 part (if there is no description) or the @samp{description} part. To
2956 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2959 If you place the cursor at the beginning or just behind the end of the
2960 displayed text and press @key{BACKSPACE}, you will remove the
2961 (invisible) bracket at that location. This makes the link incomplete
2962 and the internals are again displayed as plain text. Inserting the
2963 missing bracket hides the link internals again. To show the
2964 internal structure of all links, use the menu entry
2965 @code{Org->Hyperlinks->Literal links}.
2967 @node Internal links, External links, Link format, Hyperlinks
2968 @section Internal links
2969 @cindex internal links
2970 @cindex links, internal
2971 @cindex targets, for links
2973 @cindex property, CUSTOM_ID
2974 If the link does not look like a URL, it is considered to be internal in the
2975 current file. The most important case is a link like
2976 @samp{[[#my-custom-id]]} which will link to the entry with the
2977 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
2978 for HTML export (@pxref{HTML export}) where they produce pretty section
2979 links. You are responsible yourself to make sure these custom IDs are unique
2982 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
2983 lead to a text search in the current file.
2985 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
2986 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
2987 point to the corresponding headline. The preferred match for a text link is
2988 a @i{dedicated target}: the same string in double angular brackets. Targets
2989 may be located anywhere; sometimes it is convenient to put them into a
2990 comment line. For example
2996 @noindent In HTML export (@pxref{HTML export}), such targets will become
2997 named anchors for direct access through @samp{http} links@footnote{Note that
2998 text before the first headline is usually not exported, so the first such
2999 target should be after the first headline, or in the line directly before the
3002 If no dedicated target exists, Org will search for a headline that is exactly
3003 the link text but may also include a TODO keyword and tags@footnote{To insert
3004 a link targeting a headline, in-buffer completion can be used. Just type a
3005 star followed by a few optional letters into the buffer and press
3006 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3007 completions.}. In non-Org files, the search will look for the words in the
3008 link text. In the above example the search would be for @samp{my target}.
3010 Following a link pushes a mark onto Org's own mark ring. You can
3011 return to the previous position with @kbd{C-c &}. Using this command
3012 several times in direct succession goes back to positions recorded
3016 * Radio targets:: Make targets trigger links in plain text
3019 @node Radio targets, , Internal links, Internal links
3020 @subsection Radio targets
3021 @cindex radio targets
3022 @cindex targets, radio
3023 @cindex links, radio targets
3025 Org can automatically turn any occurrences of certain target names
3026 in normal text into a link. So without explicitly creating a link, the
3027 text connects to the target radioing its position. Radio targets are
3028 enclosed by triple angular brackets. For example, a target @samp{<<<My
3029 Target>>>} causes each occurrence of @samp{my target} in normal text to
3030 become activated as a link. The Org file is scanned automatically
3031 for radio targets only when the file is first loaded into Emacs. To
3032 update the target list during editing, press @kbd{C-c C-c} with the
3033 cursor on or at a target.
3035 @node External links, Handling links, Internal links, Hyperlinks
3036 @section External links
3037 @cindex links, external
3038 @cindex external links
3039 @cindex links, external
3047 @cindex WANDERLUST links
3049 @cindex USENET links
3054 Org supports links to files, websites, Usenet and email messages,
3055 BBDB database entries and links to both IRC conversations and their
3056 logs. External links are URL-like locators. They start with a short
3057 identifying string followed by a colon. There can be no space after
3058 the colon. The following list shows examples for each link type.
3061 http://www.astro.uva.nl/~dominik @r{on the web}
3062 doi:10.1000/182 @r{DOI for an electronic resource}
3063 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3064 /home/dominik/images/jupiter.jpg @r{same as above}
3065 file:papers/last.pdf @r{file, relative path}
3066 ./papers/last.pdf @r{same as above}
3067 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3068 /myself@@some.where:papers/last.pdf @r{same as above}
3069 file:sometextfile::NNN @r{file with line number to jump to}
3070 file:projects.org @r{another Org file}
3071 file:projects.org::some words @r{text search in Org file}
3072 file:projects.org::*task title @r{heading search in Org file}
3073 docview:papers/last.pdf::NNN @r{open file in doc-view mode at page NNN}
3074 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3075 news:comp.emacs @r{Usenet link}
3076 mailto:adent@@galaxy.net @r{Mail link}
3077 vm:folder @r{VM folder link}
3078 vm:folder#id @r{VM message link}
3079 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3080 wl:folder @r{WANDERLUST folder link}
3081 wl:folder#id @r{WANDERLUST message link}
3082 mhe:folder @r{MH-E folder link}
3083 mhe:folder#id @r{MH-E message link}
3084 rmail:folder @r{RMAIL folder link}
3085 rmail:folder#id @r{RMAIL message link}
3086 gnus:group @r{Gnus group link}
3087 gnus:group#id @r{Gnus article link}
3088 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3089 irc:/irc.com/#emacs/bob @r{IRC link}
3090 info:org:External%20links @r{Info node link (with encoded space)}
3091 shell:ls *.org @r{A shell command}
3092 elisp:org-agenda @r{Interactive Elisp command}
3093 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3096 A link should be enclosed in double brackets and may contain a
3097 descriptive text to be displayed instead of the URL (@pxref{Link
3098 format}), for example:
3101 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3105 If the description is a file name or URL that points to an image, HTML
3106 export (@pxref{HTML export}) will inline the image as a clickable
3107 button. If there is no description at all and the link points to an
3109 that image will be inlined into the exported HTML file.
3111 @cindex square brackets, around links
3112 @cindex plain text external links
3113 Org also finds external links in the normal text and activates them
3114 as links. If spaces must be part of the link (for example in
3115 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3116 about the end of the link, enclose them in square brackets.
3118 @node Handling links, Using links outside Org, External links, Hyperlinks
3119 @section Handling links
3120 @cindex links, handling
3122 Org provides methods to create a link in the correct syntax, to
3123 insert it into an Org file, and to follow the link.
3126 @orgcmd{C-c l,org-store-link}
3127 @cindex storing links
3128 Store a link to the current location. This is a @emph{global} command (you
3129 must create the key binding yourself) which can be used in any buffer to
3130 create a link. The link will be stored for later insertion into an Org
3131 buffer (see below). What kind of link will be created depends on the current
3134 @b{Org-mode buffers}@*
3135 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3136 to the target. Otherwise it points to the current headline, which will also
3139 @vindex org-link-to-org-use-id
3140 @cindex property, CUSTOM_ID
3141 @cindex property, ID
3142 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3143 will be stored. In addition or alternatively (depending on the value of
3144 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3145 created and/or used to construct a link. So using this command in Org
3146 buffers will potentially create two links: a human-readable from the custom
3147 ID, and one that is globally unique and works even if the entry is moved from
3148 file to file. Later, when inserting the link, you need to decide which one
3151 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3152 Pretty much all Emacs mail clients are supported. The link will point to the
3153 current article, or, in some GNUS buffers, to the group. The description is
3154 constructed from the author and the subject.
3156 @b{Web browsers: W3 and W3M}@*
3157 Here the link will be the current URL, with the page title as description.
3159 @b{Contacts: BBDB}@*
3160 Links created in a BBDB buffer will point to the current entry.
3163 @vindex org-irc-link-to-logs
3164 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3165 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3166 the current conversation is created. Otherwise an @samp{irc:/} style link to
3167 the user/channel/server under the point will be stored.
3170 For any other files, the link will point to the file, with a search string
3171 (@pxref{Search options}) pointing to the contents of the current line. If
3172 there is an active region, the selected words will form the basis of the
3173 search string. If the automatically created link is not working correctly or
3174 accurately enough, you can write custom functions to select the search string
3175 and to do the search for particular file types---see @ref{Custom searches}.
3176 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3179 When the cursor is in an agenda view, the created link points to the
3180 entry referenced by the current line.
3183 @orgcmd{C-c C-l,org-insert-link}
3184 @cindex link completion
3185 @cindex completion, of links
3186 @cindex inserting links
3187 @vindex org-keep-stored-link-after-insertion
3188 Insert a link@footnote{ Note that you don't have to use this command to
3189 insert a link. Links in Org are plain text, and you can type or paste them
3190 straight into the buffer. By using this command, the links are automatically
3191 enclosed in double brackets, and you will be asked for the optional
3192 descriptive text.}. This prompts for a link to be inserted into the buffer.
3193 You can just type a link, using text for an internal link, or one of the link
3194 type prefixes mentioned in the examples above. The link will be inserted
3195 into the buffer@footnote{After insertion of a stored link, the link will be
3196 removed from the list of stored links. To keep it in the list later use, use
3197 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3198 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3199 If some text was selected when this command is called, the selected text
3200 becomes the default description.
3202 @b{Inserting stored links}@*
3203 All links stored during the
3204 current session are part of the history for this prompt, so you can access
3205 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3207 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3208 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3209 defined through link abbreviations (@pxref{Link abbreviations}). If you
3210 press @key{RET} after inserting only the @var{prefix}, Org will offer
3211 specific completion support for some link types@footnote{This works by
3212 calling a special function @code{org-PREFIX-complete-link}.} For
3213 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3214 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3215 @key{RET}} you can complete contact names.
3217 @cindex file name completion
3218 @cindex completion, of file names
3219 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3220 a file will be inserted and you may use file name completion to select
3221 the name of the file. The path to the file is inserted relative to the
3222 directory of the current Org file, if the linked file is in the current
3223 directory or in a sub-directory of it, or if the path is written relative
3224 to the current directory using @samp{../}. Otherwise an absolute path
3225 is used, if possible with @samp{~/} for your home directory. You can
3226 force an absolute path with two @kbd{C-u} prefixes.
3228 @item C-c C-l @ @r{(with cursor on existing link)}
3229 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3230 link and description parts of the link.
3232 @cindex following links
3233 @orgcmd{C-c C-o,org-open-at-point}
3234 @vindex org-file-apps
3235 Open link at point. This will launch a web browser for URLs (using
3236 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3237 the corresponding links, and execute the command in a shell link. When the
3238 cursor is on an internal link, this command runs the corresponding search.
3239 When the cursor is on a TAG list in a headline, it creates the corresponding
3240 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3241 date. Furthermore, it will visit text and remote files in @samp{file:} links
3242 with Emacs and select a suitable application for local non-text files.
3243 Classification of files is based on file extension only. See option
3244 @code{org-file-apps}. If you want to override the default application and
3245 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3246 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3247 If the cursor is on a headline, but not on a link, offer all links in the
3248 headline and entry text.
3250 @vindex org-return-follows-link
3251 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3258 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3259 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3263 @vindex org-display-internal-link-with-indirect-buffer
3264 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3265 internal links to be displayed in another window@footnote{See the
3266 variable @code{org-display-internal-link-with-indirect-buffer}}.
3268 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3269 @cindex inlining images
3270 @cindex images, inlining
3271 @vindex org-startup-with-inline-images
3272 @cindex @code{inlineimages}, STARTUP keyword
3273 @cindex @code{noinlineimages}, STARTUP keyword
3274 Toggle the inline display of linked images. Normally this will only inline
3275 images that have no description part in the link, i.e. images that will also
3276 be inlined during export. When called with a prefix argument, also display
3277 images that do have a link description. You can ask for inline images to be
3278 displayed at startup by configuring the variable
3279 @code{org-startup-with-inline-images}@footnote{with corresponding
3280 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3281 @orgcmd{C-c %,org-mark-ring-push}
3283 Push the current position onto the mark ring, to be able to return
3284 easily. Commands following an internal link do this automatically.
3286 @orgcmd{C-c &,org-mark-ring-goto}
3287 @cindex links, returning to
3288 Jump back to a recorded position. A position is recorded by the
3289 commands following internal links, and by @kbd{C-c %}. Using this
3290 command several times in direct succession moves through a ring of
3291 previously recorded positions.
3293 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3294 @cindex links, finding next/previous
3295 Move forward/backward to the next link in the buffer. At the limit of
3296 the buffer, the search fails once, and then wraps around. The key
3297 bindings for this are really too long; you might want to bind this also
3298 to @kbd{C-n} and @kbd{C-p}
3300 (add-hook 'org-load-hook
3302 (define-key org-mode-map "\C-n" 'org-next-link)
3303 (define-key org-mode-map "\C-p" 'org-previous-link)))
3307 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3308 @section Using links outside Org
3310 You can insert and follow links that have Org syntax not only in
3311 Org, but in any Emacs buffer. For this, you should create two
3312 global commands, like this (please select suitable global keys
3316 (global-set-key "\C-c L" 'org-insert-link-global)
3317 (global-set-key "\C-c o" 'org-open-at-point-global)
3320 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3321 @section Link abbreviations
3322 @cindex link abbreviations
3323 @cindex abbreviation, links
3325 Long URLs can be cumbersome to type, and often many similar links are
3326 needed in a document. For this you can use link abbreviations. An
3327 abbreviated link looks like this
3330 [[linkword:tag][description]]
3334 @vindex org-link-abbrev-alist
3335 where the tag is optional.
3336 The @i{linkword} must be a word, starting with a letter, followed by
3337 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3338 according to the information in the variable @code{org-link-abbrev-alist}
3339 that relates the linkwords to replacement text. Here is an example:
3343 (setq org-link-abbrev-alist
3344 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3345 ("google" . "http://www.google.com/search?q=")
3346 ("gmap" . "http://maps.google.com/maps?q=%s")
3347 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3348 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3352 If the replacement text contains the string @samp{%s}, it will be
3353 replaced with the tag. Otherwise the tag will be appended to the string
3354 in order to create the link. You may also specify a function that will
3355 be called with the tag as the only argument to create the link.
3357 With the above setting, you could link to a specific bug with
3358 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3359 @code{[[google:OrgMode]]}, show the map location of the Free Software
3360 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3361 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3362 what the Org author is doing besides Emacs hacking with
3363 @code{[[ads:Dominik,C]]}.
3365 If you need special abbreviations just for a single Org buffer, you
3366 can define them in the file with
3370 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3371 #+LINK: google http://www.google.com/search?q=%s
3375 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3376 complete link abbreviations. You may also define a function
3377 @code{org-PREFIX-complete-link} that implements special (e.g. completion)
3378 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3379 not accept any arguments, and return the full link with prefix.
3381 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3382 @section Search options in file links
3383 @cindex search option in file links
3384 @cindex file links, searching
3386 File links can contain additional information to make Emacs jump to a
3387 particular location in the file when following a link. This can be a
3388 line number or a search option after a double@footnote{For backward
3389 compatibility, line numbers can also follow a single colon.} colon. For
3390 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3391 links}) to a file, it encodes the words in the current line as a search
3392 string that can be used to find this line back later when following the
3393 link with @kbd{C-c C-o}.
3395 Here is the syntax of the different ways to attach a search to a file
3396 link, together with an explanation:
3399 [[file:~/code/main.c::255]]
3400 [[file:~/xx.org::My Target]]
3401 [[file:~/xx.org::*My Target]]
3402 [[file:~/xx.org::#my-custom-id]]
3403 [[file:~/xx.org::/regexp/]]
3410 Search for a link target @samp{<<My Target>>}, or do a text search for
3411 @samp{my target}, similar to the search in internal links, see
3412 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3413 link will become an HTML reference to the corresponding named anchor in
3416 In an Org file, restrict search to headlines.
3418 Link to a heading with a @code{CUSTOM_ID} property
3420 Do a regular expression search for @code{regexp}. This uses the Emacs
3421 command @code{occur} to list all matches in a separate window. If the
3422 target file is in Org-mode, @code{org-occur} is used to create a
3423 sparse tree with the matches.
3424 @c If the target file is a directory,
3425 @c @code{grep} will be used to search all files in the directory.
3428 As a degenerate case, a file link with an empty file name can be used
3429 to search the current file. For example, @code{[[file:::find me]]} does
3430 a search for @samp{find me} in the current file, just as
3431 @samp{[[find me]]} would.
3433 @node Custom searches, , Search options, Hyperlinks
3434 @section Custom Searches
3435 @cindex custom search strings
3436 @cindex search strings, custom
3438 The default mechanism for creating search strings and for doing the
3439 actual search related to a file link may not work correctly in all
3440 cases. For example, Bib@TeX{} database files have many entries like
3441 @samp{year="1993"} which would not result in good search strings,
3442 because the only unique identification for a Bib@TeX{} entry is the
3445 @vindex org-create-file-search-functions
3446 @vindex org-execute-file-search-functions
3447 If you come across such a problem, you can write custom functions to set
3448 the right search string for a particular file type, and to do the search
3449 for the string in the file. Using @code{add-hook}, these functions need
3450 to be added to the hook variables
3451 @code{org-create-file-search-functions} and
3452 @code{org-execute-file-search-functions}. See the docstring for these
3453 variables for more information. Org actually uses this mechanism
3454 for Bib@TeX{} database files, and you can use the corresponding code as
3455 an implementation example. See the file @file{org-bibtex.el}.
3457 @node TODO Items, Tags, Hyperlinks, Top
3461 Org-mode does not maintain TODO lists as separate documents@footnote{Of
3462 course, you can make a document that contains only long lists of TODO items,
3463 but this is not required.}. Instead, TODO items are an integral part of the
3464 notes file, because TODO items usually come up while taking notes! With Org
3465 mode, simply mark any entry in a tree as being a TODO item. In this way,
3466 information is not duplicated, and the entire context from which the TODO
3467 item emerged is always present.
3469 Of course, this technique for managing TODO items scatters them
3470 throughout your notes file. Org-mode compensates for this by providing
3471 methods to give you an overview of all the things that you have to do.
3474 * TODO basics:: Marking and displaying TODO entries
3475 * TODO extensions:: Workflow and assignments
3476 * Progress logging:: Dates and notes for progress
3477 * Priorities:: Some things are more important than others
3478 * Breaking down tasks:: Splitting a task into manageable pieces
3479 * Checkboxes:: Tick-off lists
3482 @node TODO basics, TODO extensions, TODO Items, TODO Items
3483 @section Basic TODO functionality
3485 Any headline becomes a TODO item when it starts with the word
3486 @samp{TODO}, for example:
3489 *** TODO Write letter to Sam Fortune
3493 The most important commands to work with TODO entries are:
3496 @orgcmd{C-c C-t,org-todo}
3497 @cindex cycling, of TODO states
3498 Rotate the TODO state of the current item among
3501 ,-> (unmarked) -> TODO -> DONE --.
3502 '--------------------------------'
3505 The same rotation can also be done ``remotely'' from the timeline and
3506 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3508 @orgkey{C-u C-c C-t}
3509 Select a specific keyword using completion or (if it has been set up)
3510 the fast selection interface. For the latter, you need to assign keys
3511 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3514 @kindex S-@key{right}
3515 @kindex S-@key{left}
3516 @item S-@key{right} @ @r{/} @ S-@key{left}
3517 @vindex org-treat-S-cursor-todo-selection-as-state-change
3518 Select the following/preceding TODO state, similar to cycling. Useful
3519 mostly if more than two TODO states are possible (@pxref{TODO
3520 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3521 with @code{shift-selection-mode}. See also the variable
3522 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3523 @orgcmd{C-c / t,org-show-todo-key}
3524 @cindex sparse tree, for TODO
3525 @vindex org-todo-keywords
3526 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3527 entire buffer, but shows all TODO items (with not-DONE state) and the
3528 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3529 / T}), search for a specific TODO. You will be prompted for the keyword, and
3530 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3531 entries that match any one of these keywords. With numeric prefix argument
3532 N, show the tree for the Nth keyword in the variable
3533 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3534 both un-done and done.
3535 @orgcmd{C-c a t,org-todo-list}
3536 Show the global TODO list. Collects the TODO items (with not-DONE states)
3537 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3538 buffer will be in @code{agenda-mode}, which provides commands to examine and
3539 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3540 @xref{Global TODO list}, for more information.
3541 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3542 Insert a new TODO entry below the current one.
3546 @vindex org-todo-state-tags-triggers
3547 Changing a TODO state can also trigger tag changes. See the docstring of the
3548 option @code{org-todo-state-tags-triggers} for details.
3550 @node TODO extensions, Progress logging, TODO basics, TODO Items
3551 @section Extended use of TODO keywords
3552 @cindex extended TODO keywords
3554 @vindex org-todo-keywords
3555 By default, marked TODO entries have one of only two states: TODO and
3556 DONE. Org-mode allows you to classify TODO items in more complex ways
3557 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3558 special setup, the TODO keyword system can work differently in different
3561 Note that @i{tags} are another way to classify headlines in general and
3562 TODO items in particular (@pxref{Tags}).
3565 * Workflow states:: From TODO to DONE in steps
3566 * TODO types:: I do this, Fred does the rest
3567 * Multiple sets in one file:: Mixing it all, and still finding your way
3568 * Fast access to TODO states:: Single letter selection of a state
3569 * Per-file keywords:: Different files, different requirements
3570 * Faces for TODO keywords:: Highlighting states
3571 * TODO dependencies:: When one task needs to wait for others
3574 @node Workflow states, TODO types, TODO extensions, TODO extensions
3575 @subsection TODO keywords as workflow states
3576 @cindex TODO workflow
3577 @cindex workflow states as TODO keywords
3579 You can use TODO keywords to indicate different @emph{sequential} states
3580 in the process of working on an item, for example@footnote{Changing
3581 this variable only becomes effective after restarting Org-mode in a
3585 (setq org-todo-keywords
3586 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3589 The vertical bar separates the TODO keywords (states that @emph{need
3590 action}) from the DONE states (which need @emph{no further action}). If
3591 you don't provide the separator bar, the last state is used as the DONE
3593 @cindex completion, of TODO keywords
3594 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3595 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3596 also use a numeric prefix argument to quickly select a specific state. For
3597 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3598 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3599 define many keywords, you can use in-buffer completion
3600 (@pxref{Completion}) or even a special one-key selection scheme
3601 (@pxref{Fast access to TODO states}) to insert these words into the
3602 buffer. Changing a TODO state can be logged with a timestamp, see
3603 @ref{Tracking TODO state changes}, for more information.
3605 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3606 @subsection TODO keywords as types
3608 @cindex names as TODO keywords
3609 @cindex types as TODO keywords
3611 The second possibility is to use TODO keywords to indicate different
3612 @emph{types} of action items. For example, you might want to indicate
3613 that items are for ``work'' or ``home''. Or, when you work with several
3614 people on a single project, you might want to assign action items
3615 directly to persons, by using their names as TODO keywords. This would
3616 be set up like this:
3619 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3622 In this case, different keywords do not indicate a sequence, but rather
3623 different types. So the normal work flow would be to assign a task to a
3624 person, and later to mark it DONE. Org-mode supports this style by adapting
3625 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3626 @kbd{t} command in the timeline and agenda buffers.}. When used several
3627 times in succession, it will still cycle through all names, in order to first
3628 select the right type for a task. But when you return to the item after some
3629 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3630 to DONE. Use prefix arguments or completion to quickly select a specific
3631 name. You can also review the items of a specific TODO type in a sparse tree
3632 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3633 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3634 from all agenda files into a single buffer, you would use the numeric prefix
3635 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3637 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3638 @subsection Multiple keyword sets in one file
3639 @cindex TODO keyword sets
3641 Sometimes you may want to use different sets of TODO keywords in
3642 parallel. For example, you may want to have the basic
3643 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3644 separate state indicating that an item has been canceled (so it is not
3645 DONE, but also does not require action). Your setup would then look
3649 (setq org-todo-keywords
3650 '((sequence "TODO" "|" "DONE")
3651 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3652 (sequence "|" "CANCELED")))
3655 The keywords should all be different, this helps Org-mode to keep track
3656 of which subsequence should be used for a given entry. In this setup,
3657 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3658 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3659 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3660 select the correct sequence. Besides the obvious ways like typing a
3661 keyword or using completion, you may also apply the following commands:
3664 @kindex C-S-@key{right}
3665 @kindex C-S-@key{left}
3666 @kindex C-u C-u C-c C-t
3667 @item C-u C-u C-c C-t
3668 @itemx C-S-@key{right}
3669 @itemx C-S-@key{left}
3670 These keys jump from one TODO subset to the next. In the above example,
3671 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3672 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3673 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3674 @code{shift-selection-mode} (@pxref{Conflicts}).
3675 @kindex S-@key{right}
3676 @kindex S-@key{left}
3679 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3680 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3681 from @code{DONE} to @code{REPORT} in the example above. See also
3682 @ref{Conflicts}, for a discussion of the interaction with
3683 @code{shift-selection-mode}.
3686 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3687 @subsection Fast access to TODO states
3689 If you would like to quickly change an entry to an arbitrary TODO state
3690 instead of cycling through the states, you can set up keys for
3691 single-letter access to the states. This is done by adding the section
3692 key after each keyword, in parentheses. For example:
3695 (setq org-todo-keywords
3696 '((sequence "TODO(t)" "|" "DONE(d)")
3697 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3698 (sequence "|" "CANCELED(c)")))
3701 @vindex org-fast-tag-selection-include-todo
3702 If you then press @code{C-c C-t} followed by the selection key, the entry
3703 will be switched to this state. @key{SPC} can be used to remove any TODO
3704 keyword from an entry.@footnote{Check also the variable
3705 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3706 state through the tags interface (@pxref{Setting tags}), in case you like to
3707 mingle the two concepts. Note that this means you need to come up with
3708 unique keys across both sets of keywords.}
3710 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3711 @subsection Setting up keywords for individual files
3712 @cindex keyword options
3713 @cindex per-file keywords
3718 It can be very useful to use different aspects of the TODO mechanism in
3719 different files. For file-local settings, you need to add special lines
3720 to the file which set the keywords and interpretation for that file
3721 only. For example, to set one of the two examples discussed above, you
3722 need one of the following lines, starting in column zero anywhere in the
3726 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3728 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3729 interpretation, but it means the same as @code{#+TODO}), or
3731 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3734 A setup for using several sets in parallel would be:
3738 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3742 @cindex completion, of option keywords
3744 @noindent To make sure you are using the correct keyword, type
3745 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3747 @cindex DONE, final TODO keyword
3748 Remember that the keywords after the vertical bar (or the last keyword
3749 if no bar is there) must always mean that the item is DONE (although you
3750 may use a different word). After changing one of these lines, use
3751 @kbd{C-c C-c} with the cursor still in the line to make the changes
3752 known to Org-mode@footnote{Org-mode parses these lines only when
3753 Org-mode is activated after visiting a file. @kbd{C-c C-c} with the
3754 cursor in a line starting with @samp{#+} is simply restarting Org-mode
3755 for the current buffer.}.
3757 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3758 @subsection Faces for TODO keywords
3759 @cindex faces, for TODO keywords
3761 @vindex org-todo @r{(face)}
3762 @vindex org-done @r{(face)}
3763 @vindex org-todo-keyword-faces
3764 Org-mode highlights TODO keywords with special faces: @code{org-todo}
3765 for keywords indicating that an item still has to be acted upon, and
3766 @code{org-done} for keywords indicating that an item is finished. If
3767 you are using more than 2 different states, you might want to use
3768 special faces for some of them. This can be done using the variable
3769 @code{org-todo-keyword-faces}. For example:
3773 (setq org-todo-keyword-faces
3774 '(("TODO" . org-warning) ("STARTED" . "yellow")
3775 ("CANCELED" . (:foreground "blue" :weight bold))))
3779 While using a list with face properties as shown for CANCELED @emph{should}
3780 work, this does not aways seem to be the case. If necessary, define a
3781 special face and use that. A string is interpreted as a color. The variable
3782 @code{org-faces-easy-properties} determines if that color is interpreted as a
3783 foreground or a background color.
3785 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3786 @subsection TODO dependencies
3787 @cindex TODO dependencies
3788 @cindex dependencies, of TODO states
3790 @vindex org-enforce-todo-dependencies
3791 @cindex property, ORDERED
3792 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3793 dependencies. Usually, a parent TODO task should not be marked DONE until
3794 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3795 there is a logical sequence to a number of (sub)tasks, so that one task
3796 cannot be acted upon before all siblings above it are done. If you customize
3797 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3798 from changing state to DONE while they have children that are not DONE.
3799 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3800 will be blocked until all earlier siblings are marked DONE. Here is an
3804 * TODO Blocked until (two) is done
3813 ** TODO b, needs to wait for (a)
3814 ** TODO c, needs to wait for (a) and (b)
3818 @orgcmd{C-c C-x o,org-toggle-ordered-property}
3819 @vindex org-track-ordered-property-with-tag
3820 @cindex property, ORDERED
3821 Toggle the @code{ORDERED} property of the current entry. A property is used
3822 for this behavior because this should be local to the current entry, not
3823 inherited like a tag. However, if you would like to @i{track} the value of
3824 this property with a tag for better visibility, customize the variable
3825 @code{org-track-ordered-property-with-tag}.
3826 @orgkey{C-u C-u C-u C-c C-t}
3827 Change TODO state, circumventing any state blocking.
3830 @vindex org-agenda-dim-blocked-tasks
3831 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3832 that cannot be closed because of such dependencies will be shown in a dimmed
3833 font or even made invisible in agenda views (@pxref{Agenda Views}).
3835 @cindex checkboxes and TODO dependencies
3836 @vindex org-enforce-todo-dependencies
3837 You can also block changes of TODO states by looking at checkboxes
3838 (@pxref{Checkboxes}). If you set the variable
3839 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3840 checkboxes will be blocked from switching to DONE.
3842 If you need more complex dependency structures, for example dependencies
3843 between entries in different trees or files, check out the contributed
3844 module @file{org-depend.el}.
3847 @node Progress logging, Priorities, TODO extensions, TODO Items
3848 @section Progress logging
3849 @cindex progress logging
3850 @cindex logging, of progress
3852 Org-mode can automatically record a timestamp and possibly a note when
3853 you mark a TODO item as DONE, or even each time you change the state of
3854 a TODO item. This system is highly configurable, settings can be on a
3855 per-keyword basis and can be localized to a file or even a subtree. For
3856 information on how to clock working time for a task, see @ref{Clocking
3860 * Closing items:: When was this entry marked DONE?
3861 * Tracking TODO state changes:: When did the status change?
3862 * Tracking your habits:: How consistent have you been?
3865 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3866 @subsection Closing items
3868 The most basic logging is to keep track of @emph{when} a certain TODO
3869 item was finished. This is achieved with@footnote{The corresponding
3870 in-buffer setting is: @code{#+STARTUP: logdone}}
3873 (setq org-log-done 'time)
3877 Then each time you turn an entry from a TODO (not-done) state into any
3878 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3879 just after the headline. If you turn the entry back into a TODO item
3880 through further state cycling, that line will be removed again. If you
3881 want to record a note along with the timestamp, use@footnote{The
3882 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3885 (setq org-log-done 'note)
3889 You will then be prompted for a note, and that note will be stored below
3890 the entry with a @samp{Closing Note} heading.
3892 In the timeline (@pxref{Timeline}) and in the agenda
3893 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3894 display the TODO items with a @samp{CLOSED} timestamp on each day,
3895 giving you an overview of what has been done.
3897 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
3898 @subsection Tracking TODO state changes
3899 @cindex drawer, for state change recording
3901 @vindex org-log-states-order-reversed
3902 @vindex org-log-into-drawer
3903 @cindex property, LOG_INTO_DRAWER
3904 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3905 might want to keep track of when a state change occurred and maybe take a
3906 note about this change. You can either record just a timestamp, or a
3907 time-stamped note for a change. These records will be inserted after the
3908 headline as an itemized list, newest first@footnote{See the variable
3909 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
3910 want to get the notes out of the way into a drawer (@pxref{Drawers}).
3911 Customize the variable @code{org-log-into-drawer} to get this
3912 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
3913 also overrule the setting of this variable for a subtree by setting a
3914 @code{LOG_INTO_DRAWER} property.
3916 Since it is normally too much to record a note for every state, Org-mode
3917 expects configuration on a per-keyword basis for this. This is achieved by
3918 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
3919 in parentheses after each keyword. For example, with the setting
3922 (setq org-todo-keywords
3923 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3927 @vindex org-log-done
3928 you not only define global TODO keywords and fast access keys, but also
3929 request that a time is recorded when the entry is set to
3930 DONE@footnote{It is possible that Org-mode will record two timestamps
3931 when you are using both @code{org-log-done} and state change logging.
3932 However, it will never prompt for two notes---if you have configured
3933 both, the state change recording note will take precedence and cancel
3934 the @samp{Closing Note}.}, and that a note is recorded when switching to
3935 WAIT or CANCELED. The setting for WAIT is even more special: the
3936 @samp{!} after the slash means that in addition to the note taken when
3937 entering the state, a timestamp should be recorded when @i{leaving} the
3938 WAIT state, if and only if the @i{target} state does not configure
3939 logging for entering it. So it has no effect when switching from WAIT
3940 to DONE, because DONE is configured to record a timestamp only. But
3941 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3942 setting now triggers a timestamp even though TODO has no logging
3945 You can use the exact same syntax for setting logging preferences local
3948 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3951 @cindex property, LOGGING
3952 In order to define logging settings that are local to a subtree or a
3953 single item, define a LOGGING property in this entry. Any non-empty
3954 LOGGING property resets all logging settings to nil. You may then turn
3955 on logging for this specific tree using STARTUP keywords like
3956 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3957 settings like @code{TODO(!)}. For example
3960 * TODO Log each state with only a time
3962 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3964 * TODO Only log when switching to WAIT, and when repeating
3966 :LOGGING: WAIT(@@) logrepeat
3968 * TODO No logging at all
3974 @node Tracking your habits, , Tracking TODO state changes, Progress logging
3975 @subsection Tracking your habits
3978 Org has the ability to track the consistency of a special category of TODOs,
3979 called ``habits''. A habit has the following properties:
3983 You have enabled the @code{habits} module by customizing the variable
3986 The habit is a TODO, with a TODO keyword representing an open state.
3988 The property @code{STYLE} is set to the value @code{habit}.
3990 The TODO has a scheduled date, usually with a @code{.+} style repeat
3991 interval. A @code{++} style may be appropriate for habits with time
3992 constraints, e.g., must be done on weekends, or a @code{+} style for an
3993 unusual habit that can have a backlog, e.g., weekly reports.
3995 The TODO may also have minimum and maximum ranges specified by using the
3996 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
3997 three days, but at most every two days.
3999 You must also have state logging for the @code{DONE} state enabled, in order
4000 for historical data to be represented in the consistency graph. If it's not
4001 enabled it's not an error, but the consistency graphs will be largely
4005 To give you an idea of what the above rules look like in action, here's an
4006 actual habit with some history:
4010 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4011 - State "DONE" from "TODO" [2009-10-15 Thu]
4012 - State "DONE" from "TODO" [2009-10-12 Mon]
4013 - State "DONE" from "TODO" [2009-10-10 Sat]
4014 - State "DONE" from "TODO" [2009-10-04 Sun]
4015 - State "DONE" from "TODO" [2009-10-02 Fri]
4016 - State "DONE" from "TODO" [2009-09-29 Tue]
4017 - State "DONE" from "TODO" [2009-09-25 Fri]
4018 - State "DONE" from "TODO" [2009-09-19 Sat]
4019 - State "DONE" from "TODO" [2009-09-16 Wed]
4020 - State "DONE" from "TODO" [2009-09-12 Sat]
4023 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4027 What this habit says is: I want to shave at most every 2 days (given by the
4028 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4029 today is the 15th, then the habit first appears in the agenda on Oct 17,
4030 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4031 after four days have elapsed.
4033 What's really useful about habits is that they are displayed along with a
4034 consistency graph, to show how consistent you've been at getting that task
4035 done in the past. This graph shows every day that the task was done over the
4036 past three weeks, with colors for each day. The colors used are:
4040 If the task wasn't to be done yet on that day.
4042 If the task could have been done on that day.
4044 If the task was going to be overdue the next day.
4046 If the task was overdue on that day.
4049 In addition to coloring each day, the day is also marked with an asterisk if
4050 the task was actually done that day, and an exclamation mark to show where
4051 the current day falls in the graph.
4053 There are several configuration variables that can be used to change the way
4054 habits are displayed in the agenda.
4057 @item org-habit-graph-column
4058 The buffer column at which the consistency graph should be drawn. This will
4059 overwrite any text in that column, so it's a good idea to keep your habits'
4060 titles brief and to the point.
4061 @item org-habit-preceding-days
4062 The amount of history, in days before today, to appear in consistency graphs.
4063 @item org-habit-following-days
4064 The number of days after today that will appear in consistency graphs.
4065 @item org-habit-show-habits-only-for-today
4066 If non-nil, only show habits in today's agenda view. This is set to true by
4070 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4071 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4072 bring them back. They are also subject to tag filtering, if you have habits
4073 which should only be done in certain contexts, for example.
4075 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4079 If you use Org-mode extensively, you may end up with enough TODO items that
4080 it starts to make sense to prioritize them. Prioritizing can be done by
4081 placing a @emph{priority cookie} into the headline of a TODO item, like this
4084 *** TODO [#A] Write letter to Sam Fortune
4088 @vindex org-priority-faces
4089 By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
4090 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4091 treated just like priority @samp{B}. Priorities make a difference only for
4092 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4093 have no inherent meaning to Org-mode. The cookies can be highlighted with
4094 special faces by customizing the variable @code{org-priority-faces}.
4096 Priorities can be attached to any outline node; they do not need to be TODO
4102 @findex org-priority
4103 Set the priority of the current headline (@command{org-priority}). The
4104 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4105 When you press @key{SPC} instead, the priority cookie is removed from the
4106 headline. The priorities can also be changed ``remotely'' from the timeline
4107 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4109 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4110 @vindex org-priority-start-cycle-with-default
4111 Increase/decrease priority of current headline@footnote{See also the option
4112 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4113 also used to modify timestamps (@pxref{Creating timestamps}). See also
4114 @ref{Conflicts}, for a discussion of the interaction with
4115 @code{shift-selection-mode}.
4118 @vindex org-highest-priority
4119 @vindex org-lowest-priority
4120 @vindex org-default-priority
4121 You can change the range of allowed priorities by setting the variables
4122 @code{org-highest-priority}, @code{org-lowest-priority}, and
4123 @code{org-default-priority}. For an individual buffer, you may set
4124 these values (highest, lowest, default) like this (please make sure that
4125 the highest priority is earlier in the alphabet than the lowest
4128 @cindex #+PRIORITIES
4133 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4134 @section Breaking tasks down into subtasks
4135 @cindex tasks, breaking down
4136 @cindex statistics, for TODO items
4138 @vindex org-agenda-todo-list-sublevels
4139 It is often advisable to break down large tasks into smaller, manageable
4140 subtasks. You can do this by creating an outline tree below a TODO item,
4141 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4142 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4143 the overview over the fraction of subtasks that are already completed, insert
4144 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4145 be updated each time the TODO status of a child changes, or when pressing
4146 @kbd{C-c C-c} on the cookie. For example:
4149 * Organize Party [33%]
4150 ** TODO Call people [1/2]
4154 ** DONE Talk to neighbor
4157 @cindex property, COOKIE_DATA
4158 If a heading has both checkboxes and TODO children below it, the meaning of
4159 the statistics cookie become ambiguous. Set the property
4160 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4163 @vindex org-hierarchical-todo-statistics
4164 If you would like to have the statistics cookie count any TODO entries in the
4165 subtree (not just direct children), configure the variable
4166 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4167 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4171 * Parent capturing statistics [2/20]
4173 :COOKIE_DATA: todo recursive
4177 If you would like a TODO entry to automatically change to DONE
4178 when all children are done, you can use the following setup:
4181 (defun org-summary-todo (n-done n-not-done)
4182 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4183 (let (org-log-done org-log-states) ; turn off logging
4184 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4186 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4190 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4191 large number of subtasks (@pxref{Checkboxes}).
4194 @node Checkboxes, , Breaking down tasks, TODO Items
4198 @vindex org-list-automatic-rules
4199 Every item in a plain list@footnote{With the exception of description
4200 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4201 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4202 it with the string @samp{[ ]}. This feature is similar to TODO items
4203 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4204 into the global TODO list, so they are often great to split a task into a
4205 number of simple steps. Or you can use them in a shopping list. To toggle a
4206 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4207 @file{org-mouse.el}).
4209 Here is an example of a checkbox list.
4212 * TODO Organize party [2/4]
4213 - [-] call people [1/3]
4218 - [ ] think about what music to play
4219 - [X] talk to the neighbors
4222 Checkboxes work hierarchically, so if a checkbox item has children that
4223 are checkboxes, toggling one of the children checkboxes will make the
4224 parent checkbox reflect if none, some, or all of the children are
4227 @cindex statistics, for checkboxes
4228 @cindex checkbox statistics
4229 @cindex property, COOKIE_DATA
4230 @vindex org-hierarchical-checkbox-statistics
4231 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4232 indicating how many checkboxes present in this entry have been checked off,
4233 and the total number of checkboxes present. This can give you an idea on how
4234 many checkboxes remain, even without opening a folded entry. The cookies can
4235 be placed into a headline or into (the first line of) a plain list item.
4236 Each cookie covers checkboxes of direct children structurally below the
4237 headline/item on which the cookie appears@footnote{Set the variable
4238 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4239 represent the all checkboxes below the cookie, not just the direct
4240 children.}. You have to insert the cookie yourself by typing either
4241 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4242 result, as in the examples above. With @samp{[%]} you get information about
4243 the percentage of checkboxes checked (in the above example, this would be
4244 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4245 count either checkboxes below the heading or TODO states of children, and it
4246 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4247 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4249 @cindex blocking, of checkboxes
4250 @cindex checkbox blocking
4251 @cindex property, ORDERED
4252 If the current outline node has an @code{ORDERED} property, checkboxes must
4253 be checked off in sequence, and an error will be thrown if you try to check
4254 off a box while there are unchecked boxes above it.
4256 @noindent The following commands work with checkboxes:
4259 @orgcmd{C-c C-c,org-toggle-checkbox}
4260 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4261 double prefix argument, set it to @samp{[-]}, which is considered to be an
4263 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4264 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4265 double prefix argument, set it to @samp{[-]}, which is considered to be an
4269 If there is an active region, toggle the first checkbox in the region
4270 and set all remaining boxes to the same status as the first. With a prefix
4271 arg, add or remove the checkbox for all items in the region.
4273 If the cursor is in a headline, toggle checkboxes in the region between
4274 this headline and the next (so @emph{not} the entire subtree).
4276 If there is no active region, just toggle the checkbox at point.
4278 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4279 Insert a new item with a checkbox.
4280 This works only if the cursor is already in a plain list item
4281 (@pxref{Plain lists}).
4282 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4283 @vindex org-track-ordered-property-with-tag
4284 @cindex property, ORDERED
4285 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4286 be checked off in sequence. A property is used for this behavior because
4287 this should be local to the current entry, not inherited like a tag.
4288 However, if you would like to @i{track} the value of this property with a tag
4289 for better visibility, customize the variable
4290 @code{org-track-ordered-property-with-tag}.
4291 @orgcmd{C-c #,org-update-statistics-cookies}
4292 Update the statistics cookie in the current outline entry. When called with
4293 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4294 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4295 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4296 changing TODO states. If you delete boxes/entries or add/change them by
4297 hand, use this command to get things back into sync. Or simply toggle any
4298 entry twice (checkboxes with @kbd{C-c C-c}).
4301 @node Tags, Properties and Columns, TODO Items, Top
4304 @cindex headline tagging
4305 @cindex matching, tags
4306 @cindex sparse tree, tag based
4308 An excellent way to implement labels and contexts for cross-correlating
4309 information is to assign @i{tags} to headlines. Org-mode has extensive
4312 @vindex org-tag-faces
4313 Every headline can contain a list of tags; they occur at the end of the
4314 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4315 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4316 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4317 Tags will by default be in bold face with the same color as the headline.
4318 You may specify special faces for specific tags using the variable
4319 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4320 (@pxref{Faces for TODO keywords}).
4323 * Tag inheritance:: Tags use the tree structure of the outline
4324 * Setting tags:: How to assign tags to a headline
4325 * Tag searches:: Searching for combinations of tags
4328 @node Tag inheritance, Setting tags, Tags, Tags
4329 @section Tag inheritance
4330 @cindex tag inheritance
4331 @cindex inheritance, of tags
4332 @cindex sublevels, inclusion into tags match
4334 @i{Tags} make use of the hierarchical structure of outline trees. If a
4335 heading has a certain tag, all subheadings will inherit the tag as
4336 well. For example, in the list
4339 * Meeting with the French group :work:
4340 ** Summary by Frank :boss:notes:
4341 *** TODO Prepare slides for him :action:
4345 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4346 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4347 explicitly marked with those tags. You can also set tags that all entries in
4348 a file should inherit just as if these tags were defined in a hypothetical
4349 level zero that surrounds the entire file. Use a line like this@footnote{As
4350 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4351 changes in the line.}:
4355 #+FILETAGS: :Peter:Boss:Secret:
4359 @vindex org-use-tag-inheritance
4360 @vindex org-tags-exclude-from-inheritance
4361 To limit tag inheritance to specific tags, or to turn it off entirely, use
4362 the variables @code{org-use-tag-inheritance} and
4363 @code{org-tags-exclude-from-inheritance}.
4365 @vindex org-tags-match-list-sublevels
4366 When a headline matches during a tags search while tag inheritance is turned
4367 on, all the sublevels in the same tree will (for a simple match form) match
4368 as well@footnote{This is only true if the search does not involve more
4369 complex tests including properties (@pxref{Property searches}).}. The list
4370 of matches may then become very long. If you only want to see the first tags
4371 match in a subtree, configure the variable
4372 @code{org-tags-match-list-sublevels} (not recommended).
4374 @node Setting tags, Tag searches, Tag inheritance, Tags
4375 @section Setting tags
4376 @cindex setting tags
4377 @cindex tags, setting
4380 Tags can simply be typed into the buffer at the end of a headline.
4381 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4382 also a special command for inserting tags:
4385 @orgcmd{C-c C-q,org-set-tags-command}
4386 @cindex completion, of tags
4387 @vindex org-tags-column
4388 Enter new tags for the current headline. Org-mode will either offer
4389 completion or a special single-key interface for setting tags, see
4390 below. After pressing @key{RET}, the tags will be inserted and aligned
4391 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4392 tags in the current buffer will be aligned to that column, just to make
4393 things look nice. TAGS are automatically realigned after promotion,
4394 demotion, and TODO state changes (@pxref{TODO basics}).
4395 @orgcmd{C-c C-c,org-set-tags-command}
4396 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4399 @vindex org-tag-alist
4400 Org will support tag insertion based on a @emph{list of tags}. By
4401 default this list is constructed dynamically, containing all tags
4402 currently used in the buffer. You may also globally specify a hard list
4403 of tags with the variable @code{org-tag-alist}. Finally you can set
4404 the default tags for a given file with lines like
4408 #+TAGS: @@work @@home @@tennisclub
4409 #+TAGS: laptop car pc sailboat
4412 If you have globally defined your preferred set of tags using the
4413 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4414 in a specific file, add an empty TAGS option line to that file:
4420 @vindex org-tag-persistent-alist
4421 If you have a preferred set of tags that you would like to use in every file,
4422 in addition to those defined on a per-file basis by TAGS option lines, then
4423 you may specify a list of tags with the variable
4424 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4425 by adding a STARTUP option line to that file:
4431 By default Org-mode uses the standard minibuffer completion facilities for
4432 entering tags. However, it also implements another, quicker, tag selection
4433 method called @emph{fast tag selection}. This allows you to select and
4434 deselect tags with just a single key press. For this to work well you should
4435 assign unique letters to most of your commonly used tags. You can do this
4436 globally by configuring the variable @code{org-tag-alist} in your
4437 @file{.emacs} file. For example, you may find the need to tag many items in
4438 different files with @samp{:@@home:}. In this case you can set something
4442 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4445 @noindent If the tag is only relevant to the file you are working on, then you
4446 can instead set the TAGS option line as:
4449 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4452 @noindent The tags interface will show the available tags in a splash
4453 window. If you want to start a new line after a specific tag, insert
4454 @samp{\n} into the tag list
4457 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4460 @noindent or write them in two lines:
4463 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4464 #+TAGS: laptop(l) pc(p)
4468 You can also group together tags that are mutually exclusive by using
4472 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4475 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4476 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4478 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4479 these lines to activate any changes.
4482 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4483 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4484 of the braces. Similarly, you can use @code{:newline} to indicate a line
4485 break. The previous example would be set globally by the following
4489 (setq org-tag-alist '((:startgroup . nil)
4490 ("@@work" . ?w) ("@@home" . ?h)
4491 ("@@tennisclub" . ?t)
4493 ("laptop" . ?l) ("pc" . ?p)))
4496 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4497 automatically present you with a special interface, listing inherited tags,
4498 the tags of the current headline, and a list of all valid tags with
4499 corresponding keys@footnote{Keys will automatically be assigned to tags which
4500 have no configured keys.}. In this interface, you can use the following
4505 Pressing keys assigned to tags will add or remove them from the list of
4506 tags in the current line. Selecting a tag in a group of mutually
4507 exclusive tags will turn off any other tags from that group.
4510 Enter a tag in the minibuffer, even if the tag is not in the predefined
4511 list. You will be able to complete on all tags present in the buffer.
4512 You can also add several tags: just separate them with a comma.
4516 Clear all tags for this line.
4519 Accept the modified set.
4521 Abort without installing changes.
4523 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4525 Turn off groups of mutually exclusive tags. Use this to (as an
4526 exception) assign several tags from such a group.
4528 Toggle auto-exit after the next change (see below).
4529 If you are using expert mode, the first @kbd{C-c} will display the
4534 This method lets you assign tags to a headline with very few keys. With
4535 the above setup, you could clear the current tags and set @samp{@@home},
4536 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4537 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4538 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4539 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4540 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4541 @key{RET} @key{RET}}.
4543 @vindex org-fast-tag-selection-single-key
4544 If you find that most of the time you need only a single key press to
4545 modify your list of tags, set the variable
4546 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4547 press @key{RET} to exit fast tag selection---it will immediately exit
4548 after the first change. If you then occasionally need more keys, press
4549 @kbd{C-c} to turn off auto-exit for the current tag selection process
4550 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4551 C-c}). If you set the variable to the value @code{expert}, the special
4552 window is not even shown for single-key tag selection, it comes up only
4553 when you press an extra @kbd{C-c}.
4555 @node Tag searches, , Setting tags, Tags
4556 @section Tag searches
4557 @cindex tag searches
4558 @cindex searching for tags
4560 Once a system of tags has been set up, it can be used to collect related
4561 information into special lists.
4564 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4565 Create a sparse tree with all headlines matching a tags search. With a
4566 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4567 @orgcmd{C-c a m,org-tags-view}
4568 Create a global list of tag matches from all agenda files.
4569 @xref{Matching tags and properties}.
4570 @orgcmd{C-c a M,org-tags-view}
4571 @vindex org-tags-match-list-sublevels
4572 Create a global list of tag matches from all agenda files, but check
4573 only TODO items and force checking subitems (see variable
4574 @code{org-tags-match-list-sublevels}).
4577 These commands all prompt for a match string which allows basic Boolean logic
4578 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4579 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4580 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4581 string is rich and allows also matching against TODO keywords, entry levels
4582 and properties. For a complete description with many examples, see
4583 @ref{Matching tags and properties}.
4586 @node Properties and Columns, Dates and Times, Tags, Top
4587 @chapter Properties and columns
4590 Properties are a set of key-value pairs associated with an entry. There
4591 are two main applications for properties in Org-mode. First, properties
4592 are like tags, but with a value. Second, you can use properties to
4593 implement (very basic) database capabilities in an Org buffer. For
4594 an example of the first application, imagine maintaining a file where
4595 you document bugs and plan releases for a piece of software. Instead of
4596 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4597 property, say @code{:Release:}, that in different subtrees has different
4598 values, such as @code{1.0} or @code{2.0}. For an example of the second
4599 application of properties, imagine keeping track of your music CDs,
4600 where properties could be things such as the album, artist, date of
4601 release, number of tracks, and so on.
4603 Properties can be conveniently edited and viewed in column view
4604 (@pxref{Column view}).
4607 * Property syntax:: How properties are spelled out
4608 * Special properties:: Access to other Org-mode features
4609 * Property searches:: Matching property values
4610 * Property inheritance:: Passing values down the tree
4611 * Column view:: Tabular viewing and editing
4612 * Property API:: Properties for Lisp programmers
4615 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4616 @section Property syntax
4617 @cindex property syntax
4618 @cindex drawer, for properties
4620 Properties are key-value pairs. They need to be inserted into a special
4621 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4622 is specified on a single line, with the key (surrounded by colons)
4623 first, and the value after it. Here is an example:
4628 *** Goldberg Variations
4630 :Title: Goldberg Variations
4631 :Composer: J.S. Bach
4633 :Publisher: Deutsche Grammophon
4638 You may define the allowed values for a particular property @samp{:Xyz:}
4639 by setting a property @samp{:Xyz_ALL:}. This special property is
4640 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4641 the entire tree. When allowed values are defined, setting the
4642 corresponding property becomes easier and is less prone to typing
4643 errors. For the example with the CD collection, we can predefine
4644 publishers and the number of disks in a box like this:
4649 :NDisks_ALL: 1 2 3 4
4650 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4654 If you want to set properties that can be inherited by any entry in a
4655 file, use a line like
4656 @cindex property, _ALL
4659 #+PROPERTY: NDisks_ALL 1 2 3 4
4662 @vindex org-global-properties
4663 Property values set with the global variable
4664 @code{org-global-properties} can be inherited by all entries in all
4668 The following commands help to work with properties:
4671 @orgcmd{M-@key{TAB},org-complete}
4672 After an initial colon in a line, complete property keys. All keys used
4673 in the current file will be offered as possible completions.
4674 @orgcmd{C-c C-x p,org-set-property}
4675 Set a property. This prompts for a property name and a value. If
4676 necessary, the property drawer is created as well.
4677 @item M-x org-insert-property-drawer
4678 @findex org-insert-property-drawer
4679 Insert a property drawer into the current entry. The drawer will be
4680 inserted early in the entry, but after the lines with planning
4681 information like deadlines.
4682 @orgcmd{C-c C-c,org-property-action}
4683 With the cursor in a property drawer, this executes property commands.
4684 @orgcmd{C-c C-c s,org-set-property}
4685 Set a property in the current entry. Both the property and the value
4686 can be inserted using completion.
4687 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4688 Switch property at point to the next/previous allowed value.
4689 @orgcmd{C-c C-c d,org-delete-property}
4690 Remove a property from the current entry.
4691 @orgcmd{C-c C-c D,org-delete-property-globally}
4692 Globally remove a property, from all entries in the current file.
4693 @orgcmd{C-c C-c c,org-compute-property-at-point}
4694 Compute the property at point, using the operator and scope from the
4695 nearest column format definition.
4698 @node Special properties, Property searches, Property syntax, Properties and Columns
4699 @section Special properties
4700 @cindex properties, special
4702 Special properties provide an alternative access method to Org-mode
4703 features, like the TODO state or the priority of an entry, discussed in the
4704 previous chapters. This interface exists so that you can include
4705 these states in a column view (@pxref{Column view}), or to use them in
4706 queries. The following property names are special and should not be
4707 used as keys in the properties drawer:
4709 @cindex property, special, TODO
4710 @cindex property, special, TAGS
4711 @cindex property, special, ALLTAGS
4712 @cindex property, special, CATEGORY
4713 @cindex property, special, PRIORITY
4714 @cindex property, special, DEADLINE
4715 @cindex property, special, SCHEDULED
4716 @cindex property, special, CLOSED
4717 @cindex property, special, TIMESTAMP
4718 @cindex property, special, TIMESTAMP_IA
4719 @cindex property, special, CLOCKSUM
4720 @cindex property, special, BLOCKED
4721 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4722 @cindex property, special, ITEM
4723 @cindex property, special, FILE
4725 TODO @r{The TODO keyword of the entry.}
4726 TAGS @r{The tags defined directly in the headline.}
4727 ALLTAGS @r{All tags, including inherited ones.}
4728 CATEGORY @r{The category of an entry.}
4729 PRIORITY @r{The priority of the entry, a string with a single letter.}
4730 DEADLINE @r{The deadline time string, without the angular brackets.}
4731 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4732 CLOSED @r{When was this entry closed?}
4733 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4734 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4735 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4736 @r{must be run first to compute the values.}
4737 BLOCKED @r{"t" if task is currently blocked by children or siblings}
4738 ITEM @r{The content of the entry.}
4739 FILE @r{The filename the entry is located in.}
4742 @node Property searches, Property inheritance, Special properties, Properties and Columns
4743 @section Property searches
4744 @cindex properties, searching
4745 @cindex searching, of properties
4747 To create sparse trees and special lists with selection based on properties,
4748 the same commands are used as for tag searches (@pxref{Tag searches}).
4750 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4751 Create a sparse tree with all matching entries. With a
4752 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4753 @orgcmd{C-c a m,org-tags-view}
4754 Create a global list of tag/property matches from all agenda files.
4755 @xref{Matching tags and properties}.
4756 @orgcmd{C-c a M,org-tags-view}
4757 @vindex org-tags-match-list-sublevels
4758 Create a global list of tag matches from all agenda files, but check
4759 only TODO items and force checking of subitems (see variable
4760 @code{org-tags-match-list-sublevels}).
4763 The syntax for the search string is described in @ref{Matching tags and
4766 There is also a special command for creating sparse trees based on a
4771 Create a sparse tree based on the value of a property. This first
4772 prompts for the name of a property, and then for a value. A sparse tree
4773 is created with all entries that define this property with the given
4774 value. If you enclose the value in curly braces, it is interpreted as
4775 a regular expression and matched against the property values.
4778 @node Property inheritance, Column view, Property searches, Properties and Columns
4779 @section Property Inheritance
4780 @cindex properties, inheritance
4781 @cindex inheritance, of properties
4783 @vindex org-use-property-inheritance
4784 The outline structure of Org-mode documents lends itself to an
4785 inheritance model of properties: if the parent in a tree has a certain
4786 property, the children can inherit this property. Org-mode does not
4787 turn this on by default, because it can slow down property searches
4788 significantly and is often not needed. However, if you find inheritance
4789 useful, you can turn it on by setting the variable
4790 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4791 all properties inherited from the parent, to a list of properties
4792 that should be inherited, or to a regular expression that matches
4793 inherited properties. If a property has the value @samp{nil}, this is
4794 interpreted as an explicit undefine of the property, so that inheritance
4795 search will stop at this value and return @code{nil}.
4797 Org-mode has a few properties for which inheritance is hard-coded, at
4798 least for the special applications for which they are used:
4800 @cindex property, COLUMNS
4803 The @code{:COLUMNS:} property defines the format of column view
4804 (@pxref{Column view}). It is inherited in the sense that the level
4805 where a @code{:COLUMNS:} property is defined is used as the starting
4806 point for a column view table, independently of the location in the
4807 subtree from where columns view is turned on.
4809 @cindex property, CATEGORY
4810 For agenda view, a category set through a @code{:CATEGORY:} property
4811 applies to the entire subtree.
4813 @cindex property, ARCHIVE
4814 For archiving, the @code{:ARCHIVE:} property may define the archive
4815 location for the entire subtree (@pxref{Moving subtrees}).
4817 @cindex property, LOGGING
4818 The LOGGING property may define logging settings for an entry or a
4819 subtree (@pxref{Tracking TODO state changes}).
4822 @node Column view, Property API, Property inheritance, Properties and Columns
4823 @section Column view
4825 A great way to view and edit properties in an outline tree is
4826 @emph{column view}. In column view, each outline node is turned into a
4827 table row. Columns in this table provide access to properties of the
4828 entries. Org-mode implements columns by overlaying a tabular structure
4829 over the headline of each item. While the headlines have been turned
4830 into a table row, you can still change the visibility of the outline
4831 tree. For example, you get a compact table by switching to CONTENTS
4832 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4833 is active), but you can still open, read, and edit the entry below each
4834 headline. Or, you can switch to column view after executing a sparse
4835 tree command and in this way get a table only for the selected items.
4836 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4837 queries have collected selected items, possibly from a number of files.
4840 * Defining columns:: The COLUMNS format property
4841 * Using column view:: How to create and use column view
4842 * Capturing column view:: A dynamic block for column view
4845 @node Defining columns, Using column view, Column view, Column view
4846 @subsection Defining columns
4847 @cindex column view, for properties
4848 @cindex properties, column view
4850 Setting up a column view first requires defining the columns. This is
4851 done by defining a column format line.
4854 * Scope of column definitions:: Where defined, where valid?
4855 * Column attributes:: Appearance and content of a column
4858 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4859 @subsubsection Scope of column definitions
4861 To define a column format for an entire file, use a line like
4865 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4868 To specify a format that only applies to a specific tree, add a
4869 @code{:COLUMNS:} property to the top node of that tree, for example:
4872 ** Top node for columns view
4874 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4878 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4879 for the entry itself, and for the entire subtree below it. Since the
4880 column definition is part of the hierarchical structure of the document,
4881 you can define columns on level 1 that are general enough for all
4882 sublevels, and more specific columns further down, when you edit a
4883 deeper part of the tree.
4885 @node Column attributes, , Scope of column definitions, Defining columns
4886 @subsubsection Column attributes
4887 A column definition sets the attributes of a column. The general
4888 definition looks like this:
4891 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
4895 Except for the percent sign and the property name, all items are
4896 optional. The individual parts have the following meaning:
4899 @var{width} @r{An integer specifying the width of the column in characters.}
4900 @r{If omitted, the width will be determined automatically.}
4901 @var{property} @r{The property that should be edited in this column.}
4902 @r{Special properties representing meta data are allowed here}
4903 @r{as well (@pxref{Special properties})}
4904 @var{title} @r{The header text for the column. If omitted, the property}
4906 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
4907 @r{parent nodes are computed from the children.}
4908 @r{Supported summary types are:}
4909 @{+@} @r{Sum numbers in this column.}
4910 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4911 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4912 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
4913 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
4914 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
4915 @{X%@} @r{Checkbox status, @samp{[n%]}.}
4916 @{min@} @r{Smallest number in column.}
4917 @{max@} @r{Largest number.}
4918 @{mean@} @r{Arithmetic mean of numbers.}
4919 @{:min@} @r{Smallest time value in column.}
4920 @{:max@} @r{Largest time value.}
4921 @{:mean@} @r{Arithmetic mean of time values.}
4922 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
4923 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
4924 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
4925 @{est+@} @r{Add low-high estimates.}
4929 Be aware that you can only have one summary type for any property you
4930 include. Subsequent columns referencing the same property will all display the
4931 same summary information.
4933 The @code{est+} summary type requires further explanation. It is used for
4934 combining estimates, expressed as low-high ranges. For example, instead
4935 of estimating a particular task will take 5 days, you might estimate it as
4936 5-6 days if you're fairly confident you know how much work is required, or
4937 1-10 days if you don't really know what needs to be done. Both ranges
4938 average at 5.5 days, but the first represents a more predictable delivery.
4940 When combining a set of such estimates, simply adding the lows and highs
4941 produces an unrealistically wide result. Instead, @code{est+} adds the
4942 statistical mean and variance of the sub-tasks, generating a final estimate
4943 from the sum. For example, suppose you had ten tasks, each of which was
4944 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
4945 of 5 to 20 days, representing what to expect if everything goes either
4946 extremely well or extremely poorly. In contrast, @code{est+} estimates the
4947 full job more realistically, at 10-15 days.
4949 Here is an example for a complete columns definition, along with allowed
4953 :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.}
4954 %10Time_Estimate@{:@} %CLOCKSUM
4955 :Owner_ALL: Tammy Mark Karl Lisa Don
4956 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4957 :Approved_ALL: "[ ]" "[X]"
4961 The first column, @samp{%25ITEM}, means the first 25 characters of the
4962 item itself, i.e. of the headline. You probably always should start the
4963 column definition with the @samp{ITEM} specifier. The other specifiers
4964 create columns @samp{Owner} with a list of names as allowed values, for
4965 @samp{Status} with four different possible values, and for a checkbox
4966 field @samp{Approved}. When no width is given after the @samp{%}
4967 character, the column will be exactly as wide as it needs to be in order
4968 to fully display all values. The @samp{Approved} column does have a
4969 modified title (@samp{Approved?}, with a question mark). Summaries will
4970 be created for the @samp{Time_Estimate} column by adding time duration
4971 expressions like HH:MM, and for the @samp{Approved} column, by providing
4972 an @samp{[X]} status if all children have been checked. The
4973 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4976 @node Using column view, Capturing column view, Defining columns, Column view
4977 @subsection Using column view
4980 @tsubheading{Turning column view on and off}
4981 @orgcmd{C-c C-x C-c,org-columns}
4982 @vindex org-columns-default-format
4983 Turn on column view. If the cursor is before the first headline in the file,
4984 column view is turned on for the entire file, using the @code{#+COLUMNS}
4985 definition. If the cursor is somewhere inside the outline, this command
4986 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
4987 defines a format. When one is found, the column view table is established
4988 for the tree starting at the entry that contains the @code{:COLUMNS:}
4989 property. If no such property is found, the format is taken from the
4990 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
4991 and column view is established for the current entry and its subtree.
4992 @orgcmd{r,org-columns-redo}
4993 Recreate the column view, to include recent changes made in the buffer.
4994 @orgcmd{g,org-columns-redo}
4996 @orgcmd{q,org-columns-quit}
4998 @tsubheading{Editing values}
4999 @item @key{left} @key{right} @key{up} @key{down}
5000 Move through the column view from field to field.
5001 @kindex S-@key{left}
5002 @kindex S-@key{right}
5003 @item S-@key{left}/@key{right}
5004 Switch to the next/previous allowed value of the field. For this, you
5005 have to have specified allowed values for a property.
5007 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5008 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5009 Same as @kbd{S-@key{left}/@key{right}}
5010 @orgcmd{e,org-columns-edit-value}
5011 Edit the property at point. For the special properties, this will
5012 invoke the same interface that you normally use to change that
5013 property. For example, when editing a TAGS property, the tag completion
5014 or fast selection interface will pop up.
5015 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5016 When there is a checkbox at point, toggle it.
5017 @orgcmd{v,org-columns-show-value}
5018 View the full value of this property. This is useful if the width of
5019 the column is smaller than that of the value.
5020 @orgcmd{a,org-columns-edit-allowed}
5021 Edit the list of allowed values for this property. If the list is found
5022 in the hierarchy, the modified values is stored there. If no list is
5023 found, the new value is stored in the first entry that is part of the
5024 current column view.
5025 @tsubheading{Modifying the table structure}
5026 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5027 Make the column narrower/wider by one character.
5028 @orgcmd{S-M-@key{right},org-columns-new}
5029 Insert a new column, to the left of the current column.
5030 @orgcmd{S-M-@key{left},org-columns-delete}
5031 Delete the current column.
5034 @node Capturing column view, , Using column view, Column view
5035 @subsection Capturing column view
5037 Since column view is just an overlay over a buffer, it cannot be
5038 exported or printed directly. If you want to capture a column view, use
5039 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5040 of this block looks like this:
5042 @cindex #+BEGIN, columnview
5045 #+BEGIN: columnview :hlines 1 :id "label"
5050 @noindent This dynamic block has the following parameters:
5054 This is the most important parameter. Column view is a feature that is
5055 often localized to a certain (sub)tree, and the capture block might be
5056 at a different location in the file. To identify the tree whose view to
5057 capture, you can use 4 values:
5058 @cindex property, ID
5060 local @r{use the tree in which the capture block is located}
5061 global @r{make a global view, including all headings in the file}
5062 "file:@var{path-to-file}"
5063 @r{run column view at the top of this file}
5064 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5065 @r{property with the value @i{label}. You can use}
5066 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5067 @r{the current entry and copy it to the kill-ring.}
5070 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5071 an hline before each headline with level @code{<= @var{N}}.
5073 When set to @code{t}, force column groups to get vertical lines.
5075 When set to a number, don't capture entries below this level.
5076 @item :skip-empty-rows
5077 When set to @code{t}, skip rows where the only non-empty specifier of the
5078 column view is @code{ITEM}.
5083 The following commands insert or update the dynamic block:
5086 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5087 Insert a dynamic block capturing a column view. You will be prompted
5088 for the scope or ID of the view.
5089 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5090 Update dynamic block at point. The cursor needs to be in the
5091 @code{#+BEGIN} line of the dynamic block.
5092 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5093 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5094 you have several clock table blocks, column-capturing blocks or other dynamic
5098 You can add formulas to the column view table and you may add plotting
5099 instructions in front of the table---these will survive an update of the
5100 block. If there is a @code{#+TBLFM:} after the table, the table will
5101 actually be recalculated automatically after an update.
5103 An alternative way to capture and process property values into a table is
5104 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5105 package@footnote{Contributed packages are not part of Emacs, but are
5106 distributed with the main distribution of Org (visit
5107 @uref{http://orgmode.org}).}. It provides a general API to collect
5108 properties from entries in a certain scope, and arbitrary Lisp expressions to
5109 process these values before inserting them into a table or a dynamic block.
5111 @node Property API, , Column view, Properties and Columns
5112 @section The Property API
5113 @cindex properties, API
5114 @cindex API, for properties
5116 There is a full API for accessing and changing properties. This API can
5117 be used by Emacs Lisp programs to work with properties and to implement
5118 features based on them. For more information see @ref{Using the
5121 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5122 @chapter Dates and times
5128 To assist project planning, TODO items can be labeled with a date and/or
5129 a time. The specially formatted string carrying the date and time
5130 information is called a @emph{timestamp} in Org-mode. This may be a
5131 little confusing because timestamp is often used as indicating when
5132 something was created or last changed. However, in Org-mode this term
5133 is used in a much wider sense.
5136 * Timestamps:: Assigning a time to a tree entry
5137 * Creating timestamps:: Commands which insert timestamps
5138 * Deadlines and scheduling:: Planning your work
5139 * Clocking work time:: Tracking how long you spend on a task
5140 * Effort estimates:: Planning work effort in advance
5141 * Relative timer:: Notes with a running timer
5142 * Countdown timer:: Starting a countdown timer for a task
5146 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5147 @section Timestamps, deadlines, and scheduling
5149 @cindex ranges, time
5154 A timestamp is a specification of a date (possibly with a time or a range of
5155 times) in a special format, either @samp{<2003-09-16 Tue>} or
5156 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
5157 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601 date/time
5158 format. To use an alternative format, see @ref{Custom time format}.}. A
5159 timestamp can appear anywhere in the headline or body of an Org tree entry.
5160 Its presence causes entries to be shown on specific dates in the agenda
5161 (@pxref{Weekly/daily agenda}). We distinguish:
5164 @item Plain timestamp; Event; Appointment
5166 A simple timestamp just assigns a date/time to an item. This is just
5167 like writing down an appointment or event in a paper agenda. In the
5168 timeline and agenda displays, the headline of an entry associated with a
5169 plain timestamp will be shown exactly on that date.
5172 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5173 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5176 @item Timestamp with repeater interval
5177 @cindex timestamp, with repeater interval
5178 A timestamp may contain a @emph{repeater interval}, indicating that it
5179 applies not only on the given date, but again and again after a certain
5180 interval of N days (d), weeks (w), months (m), or years (y). The
5181 following will show up in the agenda every Wednesday:
5184 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5187 @item Diary-style sexp entries
5188 For more complex date specifications, Org-mode supports using the
5189 special sexp diary entries implemented in the Emacs calendar/diary
5190 package. For example
5193 * The nerd meeting on every 2nd Thursday of the month
5194 <%%(diary-float t 4 2)>
5197 @item Time/Date range
5200 Two timestamps connected by @samp{--} denote a range. The headline
5201 will be shown on the first and last day of the range, and on any dates
5202 that are displayed and fall in the range. Here is an example:
5205 ** Meeting in Amsterdam
5206 <2004-08-23 Mon>--<2004-08-26 Thu>
5209 @item Inactive timestamp
5210 @cindex timestamp, inactive
5211 @cindex inactive timestamp
5212 Just like a plain timestamp, but with square brackets instead of
5213 angular ones. These timestamps are inactive in the sense that they do
5214 @emph{not} trigger an entry to show up in the agenda.
5217 * Gillian comes late for the fifth time [2006-11-01 Wed]
5222 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5223 @section Creating timestamps
5224 @cindex creating timestamps
5225 @cindex timestamps, creating
5227 For Org-mode to recognize timestamps, they need to be in the specific
5228 format. All commands listed below produce timestamps in the correct
5232 @orgcmd{C-c .,org-time-stamp}
5233 Prompt for a date and insert a corresponding timestamp. When the cursor is
5234 at an existing timestamp in the buffer, the command is used to modify this
5235 timestamp instead of inserting a new one. When this command is used twice in
5236 succession, a time range is inserted.
5238 @orgcmd{C-c !,org-time-stamp-inactive}
5239 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5246 @vindex org-time-stamp-rounding-minutes
5247 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5248 contains date and time. The default time can be rounded to multiples of 5
5249 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5251 @orgcmd{C-c <,org-date-from-calendar}
5252 Insert a timestamp corresponding to the cursor date in the Calendar.
5254 @orgcmd{C-c >,org-goto-calendar}
5255 Access the Emacs calendar for the current date. If there is a
5256 timestamp in the current line, go to the corresponding date
5259 @orgcmd{C-c C-o,org-open-at-point}
5260 Access the agenda for the date given by the timestamp or -range at
5261 point (@pxref{Weekly/daily agenda}).
5263 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5264 Change date at cursor by one day. These key bindings conflict with
5265 shift-selection and related modes (@pxref{Conflicts}).
5267 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5268 Change the item under the cursor in a timestamp. The cursor can be on a
5269 year, month, day, hour or minute. When the timestamp contains a time range
5270 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5271 shifting the time block with constant length. To change the length, modify
5272 the second time. Note that if the cursor is in a headline and not at a
5273 timestamp, these same keys modify the priority of an item.
5274 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5275 related modes (@pxref{Conflicts}).
5277 @orgcmd{C-c C-y,org-evaluate-time-range}
5278 @cindex evaluate time range
5279 Evaluate a time range by computing the difference between start and end.
5280 With a prefix argument, insert result after the time range (in a table: into
5281 the following column).
5286 * The date/time prompt:: How Org-mode helps you entering date and time
5287 * Custom time format:: Making dates look different
5290 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5291 @subsection The date/time prompt
5292 @cindex date, reading in minibuffer
5293 @cindex time, reading in minibuffer
5295 @vindex org-read-date-prefer-future
5296 When Org-mode prompts for a date/time, the default is shown in default
5297 date/time format, and the prompt therefore seems to ask for a specific
5298 format. But it will in fact accept any string containing some date and/or
5299 time information, and it is really smart about interpreting your input. You
5300 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5301 copied from an email message. Org-mode will find whatever information is in
5302 there and derive anything you have not specified from the @emph{default date
5303 and time}. The default is usually the current date and time, but when
5304 modifying an existing timestamp, or when entering the second stamp of a
5305 range, it is taken from the stamp in the buffer. When filling in
5306 information, Org-mode assumes that most of the time you will want to enter a
5307 date in the future: if you omit the month/year and the given day/month is
5308 @i{before} today, it will assume that you mean a future date@footnote{See the
5309 variable @code{org-read-date-prefer-future}. You may set that variable to
5310 the symbol @code{time} to even make a time before now shift the date to
5311 tomorrow.}. If the date has been automatically shifted into the future, the
5312 time prompt will show this with @samp{(=>F).}
5314 For example, let's assume that today is @b{June 13, 2006}. Here is how
5315 various inputs will be interpreted, the items filled in by Org-mode are
5319 3-2-5 --> 2003-02-05
5320 2/5/3 --> 2003-02-05
5321 14 --> @b{2006}-@b{06}-14
5322 12 --> @b{2006}-@b{07}-12
5323 2/5 --> @b{2007}-02-05
5324 Fri --> nearest Friday (default date or later)
5325 sep 15 --> @b{2006}-09-15
5326 feb 15 --> @b{2007}-02-15
5327 sep 12 9 --> 2009-09-12
5328 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
5329 22 sept 0:34 --> @b{2006}-09-22 0:34
5330 w4 --> ISO week for of the current year @b{2006}
5331 2012 w4 fri --> Friday of ISO week 4 in 2012
5332 2012-w04-5 --> Same as above
5335 Furthermore you can specify a relative date by giving, as the
5336 @emph{first} thing in the input: a plus/minus sign, a number and a
5337 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5338 single plus or minus, the date is always relative to today. With a
5339 double plus or minus, it is relative to the default date. If instead of
5340 a single letter, you use the abbreviation of day name, the date will be
5341 the Nth such day. E.g.
5346 +4d --> four days from today
5347 +4 --> same as above
5348 +2w --> two weeks from today
5349 ++5 --> five days from default date
5350 +2tue --> second Tuesday from now.
5353 @vindex parse-time-months
5354 @vindex parse-time-weekdays
5355 The function understands English month and weekday abbreviations. If
5356 you want to use unabbreviated names and/or other languages, configure
5357 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5359 You can specify a time range by giving start and end times or by giving a
5360 start time and a duration (in HH:MM format). Use `-' or `-@{@}-' as the separator
5361 in the former case and use '+' as the separator in the latter case. E.g.
5364 11am-1:15pm --> 11:00-13:15
5365 11am--1:15pm --> same as above
5366 11am+2:15 --> same as above
5369 @cindex calendar, for selecting date
5370 @vindex org-popup-calendar-for-date-prompt
5371 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5372 you don't need/want the calendar, configure the variable
5373 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5374 prompt, either by clicking on a date in the calendar, or by pressing
5375 @key{RET}, the date selected in the calendar will be combined with the
5376 information entered at the prompt. You can control the calendar fully
5377 from the minibuffer:
5384 @kindex S-@key{right}
5385 @kindex S-@key{left}
5386 @kindex S-@key{down}
5388 @kindex M-S-@key{right}
5389 @kindex M-S-@key{left}
5392 @key{RET} @r{Choose date at cursor in calendar.}
5393 mouse-1 @r{Select date by clicking on it.}
5394 S-@key{right}/@key{left} @r{One day forward/backward.}
5395 S-@key{down}/@key{up} @r{One week forward/backward.}
5396 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5397 > / < @r{Scroll calendar forward/backward by one month.}
5398 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5401 @vindex org-read-date-display-live
5402 The actions of the date/time prompt may seem complex, but I assure you they
5403 will grow on you, and you will start getting annoyed by pretty much any other
5404 way of entering a date/time out there. To help you understand what is going
5405 on, the current interpretation of your input will be displayed live in the
5406 minibuffer@footnote{If you find this distracting, turn the display of with
5407 @code{org-read-date-display-live}.}.
5409 @node Custom time format, , The date/time prompt, Creating timestamps
5410 @subsection Custom time format
5411 @cindex custom date/time format
5412 @cindex time format, custom
5413 @cindex date format, custom
5415 @vindex org-display-custom-times
5416 @vindex org-time-stamp-custom-formats
5417 Org-mode uses the standard ISO notation for dates and times as it is
5418 defined in ISO 8601. If you cannot get used to this and require another
5419 representation of date and time to keep you happy, you can get it by
5420 customizing the variables @code{org-display-custom-times} and
5421 @code{org-time-stamp-custom-formats}.
5424 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5425 Toggle the display of custom formats for dates and times.
5429 Org-mode needs the default format for scanning, so the custom date/time
5430 format does not @emph{replace} the default format---instead it is put
5431 @emph{over} the default format using text properties. This has the
5432 following consequences:
5435 You cannot place the cursor onto a timestamp anymore, only before or
5438 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5439 each component of a timestamp. If the cursor is at the beginning of
5440 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5441 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5442 time will be changed by one minute.
5444 If the timestamp contains a range of clock times or a repeater, these
5445 will not be overlaid, but remain in the buffer as they were.
5447 When you delete a timestamp character-by-character, it will only
5448 disappear from the buffer after @emph{all} (invisible) characters
5449 belonging to the ISO timestamp have been removed.
5451 If the custom timestamp format is longer than the default and you are
5452 using dates in tables, table alignment will be messed up. If the custom
5453 format is shorter, things do work as expected.
5457 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5458 @section Deadlines and scheduling
5460 A timestamp may be preceded by special keywords to facilitate planning:
5464 @cindex DEADLINE keyword
5466 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5467 to be finished on that date.
5469 @vindex org-deadline-warning-days
5470 On the deadline date, the task will be listed in the agenda. In
5471 addition, the agenda for @emph{today} will carry a warning about the
5472 approaching or missed deadline, starting
5473 @code{org-deadline-warning-days} before the due date, and continuing
5474 until the entry is marked DONE. An example:
5477 *** TODO write article about the Earth for the Guide
5478 The editor in charge is [[bbdb:Ford Prefect]]
5479 DEADLINE: <2004-02-29 Sun>
5482 You can specify a different lead time for warnings for a specific
5483 deadlines using the following syntax. Here is an example with a warning
5484 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5487 @cindex SCHEDULED keyword
5489 Meaning: you are planning to start working on that task on the given
5492 @vindex org-agenda-skip-scheduled-if-done
5493 The headline will be listed under the given date@footnote{It will still
5494 be listed on that date after it has been marked DONE. If you don't like
5495 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5496 addition, a reminder that the scheduled date has passed will be present
5497 in the compilation for @emph{today}, until the entry is marked DONE, i.e.
5498 the task will automatically be forwarded until completed.
5501 *** TODO Call Trillian for a date on New Years Eve.
5502 SCHEDULED: <2004-12-25 Sat>
5506 @b{Important:} Scheduling an item in Org-mode should @i{not} be
5507 understood in the same way that we understand @i{scheduling a meeting}.
5508 Setting a date for a meeting is just a simple appointment, you should
5509 mark this entry with a simple plain timestamp, to get this item shown
5510 on the date where it applies. This is a frequent misunderstanding by
5511 Org users. In Org-mode, @i{scheduling} means setting a date when you
5512 want to start working on an action item.
5515 You may use timestamps with repeaters in scheduling and deadline
5516 entries. Org-mode will issue early and late warnings based on the
5517 assumption that the timestamp represents the @i{nearest instance} of
5518 the repeater. However, the use of diary sexp entries like
5520 @code{<%%(diary-float t 42)>}
5522 in scheduling and deadline timestamps is limited. Org-mode does not
5523 know enough about the internals of each sexp function to issue early and
5524 late warnings. However, it will show the item on each day where the
5528 * Inserting deadline/schedule:: Planning items
5529 * Repeated tasks:: Items that show up again and again
5532 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5533 @subsection Inserting deadlines or schedules
5535 The following commands allow you to quickly insert a deadline or to schedule
5540 @orgcmd{C-c C-d,org-deadline}
5541 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5542 in the line directly following the headline. When called with a prefix arg,
5543 an existing deadline will be removed from the entry. Depending on the
5544 variable @code{org-log-redeadline}@footnote{with corresponding
5545 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5546 and @code{nologredeadline}}, a note will be taken when changing an existing
5548 @c FIXME Any CLOSED timestamp will be removed.????????
5550 @orgcmd{C-c C-s,org-schedule}
5551 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5552 happen in the line directly following the headline. Any CLOSED timestamp
5553 will be removed. When called with a prefix argument, remove the scheduling
5554 date from the entry. Depending on the variable
5555 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5556 keywords @code{logredeadline}, @code{lognoteredeadline}, and
5557 @code{nologredeadline}}, a note will be taken when changing an existing
5560 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5563 Mark the current entry for agenda action. After you have marked the entry
5564 like this, you can open the agenda or the calendar to find an appropriate
5565 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5566 schedule the marked item.
5568 @orgcmd{C-c / d,org-check-deadlines}
5569 @cindex sparse tree, for deadlines
5570 @vindex org-deadline-warning-days
5571 Create a sparse tree with all deadlines that are either past-due, or
5572 which will become due within @code{org-deadline-warning-days}.
5573 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5574 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5575 all deadlines due tomorrow.
5577 @orgcmd{C-c / b,org-check-before-date}
5578 Sparse tree for deadlines and scheduled items before a given date.
5580 @orgcmd{C-c / a,org-check-after-date}
5581 Sparse tree for deadlines and scheduled items after a given date.
5584 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5585 @subsection Repeated tasks
5586 @cindex tasks, repeated
5587 @cindex repeated tasks
5589 Some tasks need to be repeated again and again. Org-mode helps to
5590 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5591 or plain timestamp. In the following example
5593 ** TODO Pay the rent
5594 DEADLINE: <2005-10-01 Sat +1m>
5597 the @code{+1m} is a repeater; the intended interpretation is that the task
5598 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5599 from that time. If you need both a repeater and a special warning period in
5600 a deadline entry, the repeater should come first and the warning period last:
5601 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5603 @vindex org-todo-repeat-to-state
5604 Deadlines and scheduled items produce entries in the agenda when they are
5605 over-due, so it is important to be able to mark such an entry as completed
5606 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5607 keyword DONE, it will no longer produce entries in the agenda. The problem
5608 with this is, however, that then also the @emph{next} instance of the
5609 repeated entry will not be active. Org-mode deals with this in the following
5610 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5611 shift the base date of the repeating timestamp by the repeater interval, and
5612 immediately set the entry state back to TODO@footnote{In fact, the target
5613 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5614 the variable @code{org-todo-repeat-to-state}. If neither of these is
5615 specified, the target state defaults to the first state of the TODO state
5616 sequence.}. In the example above, setting the state to DONE would actually
5617 switch the date like this:
5620 ** TODO Pay the rent
5621 DEADLINE: <2005-11-01 Tue +1m>
5624 @vindex org-log-repeat
5625 A timestamp@footnote{You can change this using the option
5626 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5627 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5628 will also be prompted for a note.} will be added under the deadline, to keep
5629 a record that you actually acted on the previous instance of this deadline.
5631 As a consequence of shifting the base date, this entry will no longer be
5632 visible in the agenda when checking past dates, but all future instances
5635 With the @samp{+1m} cookie, the date shift will always be exactly one
5636 month. So if you have not paid the rent for three months, marking this
5637 entry DONE will still keep it as an overdue deadline. Depending on the
5638 task, this may not be the best way to handle it. For example, if you
5639 forgot to call your father for 3 weeks, it does not make sense to call
5640 him 3 times in a single day to make up for it. Finally, there are tasks
5641 like changing batteries which should always repeat a certain time
5642 @i{after} the last time you did it. For these tasks, Org-mode has
5643 special repeaters @samp{++} and @samp{.+}. For example:
5647 DEADLINE: <2008-02-10 Sun ++1w>
5648 Marking this DONE will shift the date by at least one week,
5649 but also by as many weeks as it takes to get this date into
5650 the future. However, it stays on a Sunday, even if you called
5651 and marked it done on Saturday.
5652 ** TODO Check the batteries in the smoke detectors
5653 DEADLINE: <2005-11-01 Tue .+1m>
5654 Marking this DONE will shift the date to one month after
5658 You may have both scheduling and deadline information for a specific
5659 task---just make sure that the repeater intervals on both are the same.
5661 An alternative to using a repeater is to create a number of copies of a task
5662 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5663 created for this purpose, it is described in @ref{Structure editing}.
5666 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5667 @section Clocking work time
5668 @cindex clocking time
5669 @cindex time clocking
5671 Org-mode allows you to clock the time you spend on specific tasks in a
5672 project. When you start working on an item, you can start the clock.
5673 When you stop working on that task, or when you mark the task done, the
5674 clock is stopped and the corresponding time interval is recorded. It
5675 also computes the total time spent on each subtree of a project. And it
5676 remembers a history or tasks recently clocked, to that you can jump quickly
5677 between a number of tasks absorbing your time.
5679 To save the clock history across Emacs sessions, use
5681 (setq org-clock-persist 'history)
5682 (org-clock-persistence-insinuate)
5684 When you clock into a new task after resuming Emacs, the incomplete
5685 clock@footnote{To resume the clock under the assumption that you have worked
5686 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5687 will be found (@pxref{Resolving idle time}) and you will be prompted about
5691 * Clocking commands:: Starting and stopping a clock
5692 * The clock table:: Detailed reports
5693 * Resolving idle time:: Resolving time when you've been idle
5696 @node Clocking commands, The clock table, Clocking work time, Clocking work time
5697 @subsection Clocking commands
5700 @orgcmd{C-c C-x C-i,org-clock-in}
5701 @vindex org-clock-into-drawer
5702 Start the clock on the current item (clock-in). This inserts the CLOCK
5703 keyword together with a timestamp. If this is not the first clocking of
5704 this item, the multiple CLOCK lines will be wrapped into a
5705 @code{:LOGBOOK:} drawer (see also the variable
5706 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5707 select the task from a list of recently clocked tasks. With two @kbd{C-u
5708 C-u} prefixes, clock into the task at point and mark it as the default task.
5709 The default task will always be available when selecting a clocking task,
5710 with letter @kbd{d}.@*
5711 @cindex property: CLOCK_MODELINE_TOTAL
5712 @cindex property: LAST_REPEAT
5713 @vindex org-clock-modeline-total
5714 While the clock is running, the current clocking time is shown in the mode
5715 line, along with the title of the task. The clock time shown will be all
5716 time ever clocked for this task and its children. If the task has an effort
5717 estimate (@pxref{Effort estimates}), the mode line displays the current
5718 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5719 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5720 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5721 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5722 will be shown. More control over what time is shown can be exercised with
5723 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5724 @code{current} to show only the current clocking instance, @code{today} to
5725 show all time clocked on this tasks today (see also the variable
5726 @code{org-extend-today-until}), @code{all} to include all time, or
5727 @code{auto} which is the default@footnote{See also the variable
5728 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5729 mode line entry will pop up a menu with clocking options.
5731 @orgcmd{C-c C-x C-o,org-clock-out}
5732 @vindex org-log-note-clock-out
5733 Stop the clock (clock-out). This inserts another timestamp at the same
5734 location where the clock was last started. It also directly computes
5735 the resulting time in inserts it after the time range as @samp{=>
5736 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5737 possibility to record an additional note together with the clock-out
5738 timestamp@footnote{The corresponding in-buffer setting is:
5739 @code{#+STARTUP: lognoteclock-out}}.
5740 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5741 Update the effort estimate for the current clock task.
5744 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
5745 Recompute the time interval after changing one of the timestamps. This
5746 is only necessary if you edit the timestamps directly. If you change
5747 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5748 @orgcmd{C-c C-t,org-todo}
5749 Changing the TODO state of an item to DONE automatically stops the clock
5750 if it is running in this same item.
5751 @orgcmd{C-c C-x C-x,org-clock-cancel}
5752 Cancel the current clock. This is useful if a clock was started by
5753 mistake, or if you ended up working on something else.
5754 @orgcmd{C-c C-x C-j,org-clock-goto}
5755 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
5756 prefix arg, select the target task from a list of recently clocked tasks.
5757 @orgcmd{C-c C-x C-d,org-clock-display}
5758 @vindex org-remove-highlights-with-change
5759 Display time summaries for each subtree in the current buffer. This
5760 puts overlays at the end of each headline, showing the total time
5761 recorded under that heading, including the time of any subheadings. You
5762 can use visibility cycling to study the tree, but the overlays disappear
5763 when you change the buffer (see variable
5764 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5767 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5768 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5769 worked on or closed during a day.
5771 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
5772 @subsection The clock table
5773 @cindex clocktable, dynamic block
5774 @cindex report, of clocked time
5776 Org mode can produce quite complex reports based on the time clocking
5777 information. Such a report is called a @emph{clock table}, because it is
5778 formatted as one or several Org tables.
5781 @orgcmd{C-c C-x C-r,org-clock-report}
5782 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5783 report as an Org-mode table into the current file. When the cursor is
5784 at an existing clock table, just update it. When called with a prefix
5785 argument, jump to the first clock report in the current document and
5787 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5788 Update dynamic block at point. The cursor needs to be in the
5789 @code{#+BEGIN} line of the dynamic block.
5790 @orgkey{C-u C-c C-x C-u}
5791 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5792 you have several clock table blocks in a buffer.
5793 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
5794 Shift the current @code{:block} interval and update the table. The cursor
5795 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5796 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5800 Here is an example of the frame for a clock table as it is inserted into the
5801 buffer with the @kbd{C-c C-x C-r} command:
5803 @cindex #+BEGIN, clocktable
5805 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5809 @vindex org-clocktable-defaults
5810 The @samp{BEGIN} line and specify a number of options to define the scope,
5811 structure, and formatting of the report. Defaults for all these options can
5812 be configured in the variable @code{org-clocktable-defaults}.
5814 @noindent First there are options that determine which clock entries are to
5817 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5818 @r{Clocks at deeper levels will be summed into the upper level.}
5819 :scope @r{The scope to consider. This can be any of the following:}
5820 nil @r{the current buffer or narrowed region}
5821 file @r{the full current buffer}
5822 subtree @r{the subtree where the clocktable is located}
5823 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
5824 tree @r{the surrounding level 1 tree}
5825 agenda @r{all agenda files}
5826 ("file"..) @r{scan these files}
5827 file-with-archives @r{current file and its archives}
5828 agenda-with-archives @r{all agenda files, including archives}
5829 :block @r{The time block to consider. This block is specified either}
5830 @r{absolute, or relative to the current time and may be any of}
5832 2007-12-31 @r{New year eve 2007}
5833 2007-12 @r{December 2007}
5834 2007-W50 @r{ISO-week 50 in 2007}
5835 2007-Q2 @r{2nd quarter in 2007}
5836 2007 @r{the year 2007}
5837 today, yesterday, today-@var{N} @r{a relative day}
5838 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
5839 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
5840 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
5841 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5842 :tstart @r{A time string specifying when to start considering times.}
5843 :tend @r{A time string specifying when to stop considering times.}
5844 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5845 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5846 :stepskip0 @r{Do not show steps that have zero time.}
5847 :fileskip0 @r{Do not show table sections from files which did not contribute.}
5848 :tags @r{A tags match to select entries that should contribute}.
5851 Then there are options which determine the formatting of the table. There
5852 options are interpreted by the function @code{org-clocktable-write-default},
5853 but you can specify your own function using the @code{:formatter} parameter.
5855 :emphasize @r{When @code{t}, emphasize level one and level two items.}
5856 :link @r{Link the item headlines in the table to their origins.}
5857 :narrow @r{An integer to limit the width of the headline column in}
5858 @r{the org table. If you write it like @samp{50!}, then the}
5859 @r{headline will also be shortened in export.}
5860 :indent @r{Indent each headline field according to its level.}
5861 :tcolumns @r{Number of columns to be used for times. If this is smaller}
5862 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
5863 :level @r{Should a level number column be included?}
5864 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
5865 @r{All are overwritten except if there is an explicit @code{:narrow}}
5866 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
5867 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
5868 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5869 @r{As a special case, @samp{:formula %} adds a column with % time.}
5870 @r{If you do not specify a formula here, any existing formula}
5871 @r{below the clock table will survive updates and be evaluated.}
5872 :formatter @r{A function to format clock data and insert it into the buffer.}
5874 To get a clock summary of the current level 1 tree, for the current
5875 day, you could write
5877 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5881 and to use a specific time range you could write@footnote{Note that all
5882 parameters must be specified in a single line---the line is broken here
5883 only to fit it into the manual.}
5885 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5886 :tend "<2006-08-10 Thu 12:00>"
5889 A summary of the current subtree with % times would be
5891 #+BEGIN: clocktable :scope subtree :link t :formula %
5894 A horizontally compact representation of everything clocked during last week
5897 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
5901 @node Resolving idle time, , The clock table, Clocking work time
5902 @subsection Resolving idle time
5903 @cindex resolve idle time
5905 @cindex idle, resolve, dangling
5906 If you clock in on a work item, and then walk away from your
5907 computer---perhaps to take a phone call---you often need to ``resolve'' the
5908 time you were away by either subtracting it from the current clock, or
5909 applying it to another one.
5911 @vindex org-clock-idle-time
5912 By customizing the variable @code{org-clock-idle-time} to some integer, such
5913 as 10 or 15, Emacs can alert you when you get back to your computer after
5914 being idle for that many minutes@footnote{On computers using Mac OS X,
5915 idleness is based on actual user idleness, not just Emacs' idle time. For
5916 X11, you can install a utility program @file{x11idle.c}, available in the
5917 UTILITIES directory of the Org git distribution, to get the same general
5918 treatment of idleness. On other systems, idle time refers to Emacs idle time
5919 only.}, and ask what you want to do with the idle time. There will be a
5920 question waiting for you when you get back, indicating how much idle time has
5921 passed (constantly updated with the current amount), as well as a set of
5922 choices to correct the discrepancy:
5926 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
5927 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
5928 effectively changing nothing, or enter a number to keep that many minutes.
5930 If you use the shift key and press @kbd{K}, it will keep however many minutes
5931 you request and then immediately clock out of that task. If you keep all of
5932 the minutes, this is the same as just clocking out of the current task.
5934 To keep none of the minutes, use @kbd{s} to subtract all the away time from
5935 the clock, and then check back in from the moment you returned.
5937 To keep none of the minutes and just clock out at the start of the away time,
5938 use the shift key and press @kbd{S}. Remember that using shift will always
5939 leave you clocked out, no matter which option you choose.
5941 To cancel the clock altogether, use @kbd{C}. Note that if instead of
5942 canceling you subtract the away time, and the resulting clock amount is less
5943 than a minute, the clock will still be canceled rather than clutter up the
5944 log with an empty entry.
5947 What if you subtracted those away minutes from the current clock, and now
5948 want to apply them to a new clock? Simply clock in to any task immediately
5949 after the subtraction. Org will notice that you have subtracted time ``on
5950 the books'', so to speak, and will ask if you want to apply those minutes to
5951 the next task you clock in on.
5953 There is one other instance when this clock resolution magic occurs. Say you
5954 were clocked in and hacking away, and suddenly your cat chased a mouse who
5955 scared a hamster that crashed into your UPS's power button! You suddenly
5956 lose all your buffers, but thanks to auto-save you still have your recent Org
5957 mode changes, including your last clock in.
5959 If you restart Emacs and clock into any task, Org will notice that you have a
5960 dangling clock which was never clocked out from your last session. Using
5961 that clock's starting time as the beginning of the unaccounted-for period,
5962 Org will ask how you want to resolve that time. The logic and behavior is
5963 identical to dealing with away time due to idleness; it's just happening due
5964 to a recovery event rather than a set amount of idle time.
5966 You can also check all the files visited by your Org agenda for dangling
5967 clocks at any time using @kbd{M-x org-resolve-clocks}.
5969 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
5970 @section Effort estimates
5971 @cindex effort estimates
5973 @cindex property, Effort
5974 @vindex org-effort-property
5975 If you want to plan your work in a very detailed way, or if you need to
5976 produce offers with quotations of the estimated work effort, you may want to
5977 assign effort estimates to entries. If you are also clocking your work, you
5978 may later want to compare the planned effort with the actual working time, a
5979 great way to improve planning estimates. Effort estimates are stored in a
5980 special property @samp{Effort}@footnote{You may change the property being
5981 used with the variable @code{org-effort-property}.}. You can set the effort
5982 for an entry with the following commands:
5985 @orgcmd{C-c C-x e,org-set-effort}
5986 Set the effort estimate for the current entry. With a numeric prefix
5987 argument, set it to the Nth allowed value (see below). This command is also
5988 accessible from the agenda with the @kbd{e} key.
5989 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5990 Modify the effort estimate of the item currently being clocked.
5993 Clearly the best way to work with effort estimates is through column view
5994 (@pxref{Column view}). You should start by setting up discrete values for
5995 effort estimates, and a @code{COLUMNS} format that displays these values
5996 together with clock sums (if you want to clock your time). For a specific
6000 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
6001 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6005 @vindex org-global-properties
6006 @vindex org-columns-default-format
6007 or, even better, you can set up these values globally by customizing the
6008 variables @code{org-global-properties} and @code{org-columns-default-format}.
6009 In particular if you want to use this setup also in the agenda, a global
6010 setup may be advised.
6012 The way to assign estimates to individual items is then to switch to column
6013 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6014 value. The values you enter will immediately be summed up in the hierarchy.
6015 In the column next to it, any clocked time will be displayed.
6017 @vindex org-agenda-columns-add-appointments-to-effort-sum
6018 If you switch to column view in the daily/weekly agenda, the effort column
6019 will summarize the estimated work effort for each day@footnote{Please note
6020 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6021 column view}).}, and you can use this to find space in your schedule. To get
6022 an overview of the entire part of the day that is committed, you can set the
6023 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6024 appointments on a day that take place over a specified time interval will
6025 then also be added to the load estimate of the day.
6027 Effort estimates can be used in secondary agenda filtering that is triggered
6028 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6029 these estimates defined consistently, two or three key presses will narrow
6030 down the list to stuff that fits into an available time slot.
6032 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6033 @section Taking notes with a relative timer
6034 @cindex relative timer
6036 When taking notes during, for example, a meeting or a video viewing, it can
6037 be useful to have access to times relative to a starting time. Org provides
6038 such a relative timer and make it easy to create timed notes.
6041 @orgcmd{C-c C-x .,org-timer}
6042 Insert a relative time into the buffer. The first time you use this, the
6043 timer will be started. When called with a prefix argument, the timer is
6045 @orgcmd{C-c C-x -,org-timer-item}
6046 Insert a description list item with the current relative time. With a prefix
6047 argument, first reset the timer to 0.
6048 @orgcmd{M-@key{RET},org-insert-heading}
6049 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6051 @c for key sequences with a comma, command name macros fail :(
6054 Pause the timer, or continue it if it is already paused
6055 (@command{org-timer-pause-or-continue}).
6056 @c removed the sentence because it is redundant to the following item
6057 @kindex C-u C-c C-x ,
6059 Stop the timer. After this, you can only start a new timer, not continue the
6060 old one. This command also removes the timer from the mode line.
6061 @orgcmd{C-c C-x 0,org-timer-start}
6062 Reset the timer without inserting anything into the buffer. By default, the
6063 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6064 specific starting offset. The user is prompted for the offset, with a
6065 default taken from a timer string at point, if any, So this can be used to
6066 restart taking notes after a break in the process. When called with a double
6067 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6068 by a certain amount. This can be used to fix timer strings if the timer was
6069 not started at exactly the right moment.
6072 @node Countdown timer, , Relative timer, Dates and Times
6073 @section Countdown timer
6074 @cindex Countdown timer
6078 Calling @code{org-timer-set-timer} from an Org-mode buffer runs a countdown
6079 timer. Use @key{;} from agenda buffers, @key{C-c C-x ;} everwhere else.
6081 @code{org-timer-set-timer} prompts the user for a duration and displays a
6082 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6083 default countdown value. Giving a prefix numeric argument overrides this
6086 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6087 @chapter Capture - Refile - Archive
6090 An important part of any organization system is the ability to quickly
6091 capture new ideas and tasks, and to associate reference material with them.
6092 Org does this using a process called @i{capture}. It also can store files
6093 related to a task (@i{attachments}) in a special directory. Once in the
6094 system, tasks and projects need to be moved around. Moving completed project
6095 trees to an archive file keeps the system compact and fast.
6098 * Capture:: Capturing new stuff
6099 * Attachments:: Add files to tasks
6100 * RSS Feeds:: Getting input from RSS feeds
6101 * Protocols:: External (e.g. Browser) access to Emacs and Org
6102 * Refiling notes:: Moving a tree from one place to another
6103 * Archiving:: What to do with finished projects
6106 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6110 Org's method for capturing new items is heavily inspired by John Wiegley
6111 excellent remember package. Up to version 6.36 Org used a special setup
6112 for @file{remember.el}. @file{org-remember.el} is still part of Org-mode for
6113 backward compatibility with existing setups. You can find the documentation
6114 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6116 The new capturing setup described here is preferred and should be used by new
6117 users. To convert your @code{org-remember-templates}, run the command
6119 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6121 @noindent and then customize the new variable with @kbd{M-x
6122 customize-variable org-capture-templates}, check the result, and save the
6123 customization. You can then use both remember and capture until
6124 you are familiar with the new mechanism.
6126 Capture lets you quickly store notes with little interruption of your work
6127 flow. The basic process of capturing is very similar to remember, but Org
6128 does enhance it with templates and more.
6131 * Setting up capture:: Where notes will be stored
6132 * Using capture:: Commands to invoke and terminate capture
6133 * Capture templates:: Define the outline of different note types
6136 @node Setting up capture, Using capture, Capture, Capture
6137 @subsection Setting up capture
6139 The following customization sets a default target file for notes, and defines
6140 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6141 suggestion.} for capturing new material.
6143 @vindex org-default-notes-file
6145 (setq org-default-notes-file (concat org-directory "/notes.org"))
6146 (define-key global-map "\C-cc" 'org-capture)
6149 @node Using capture, Capture templates, Setting up capture, Capture
6150 @subsection Using capture
6153 @orgcmd{C-c c,org-capture}
6154 Call the command @code{org-capture}. Note that this keybinding is global and
6155 not active by default - you need to install it. If you have templates
6156 defined @pxref{Capture templates}, it will offer these templates for
6157 selection or use a new Org outline node as the default template. It will
6158 insert the template into the target file and switch to an indirect buffer
6159 narrowed to this new node. You may then insert the information you want.
6161 @orgcmd{C-c C-c,org-capture-finalize}
6162 Once you have finished entering information into the capture buffer, @kbd{C-c
6163 C-c} will return you to the window configuration before the capture process,
6164 so that you can resume your work without further distraction. When called
6165 with a prefix arg, finalize and then jump to the captured item.
6167 @orgcmd{C-c C-w,org-capture-refile}
6168 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6169 a different place. Please realize that this is a normal refiling command
6170 that will be executed---so the cursor position at the moment you run this
6171 command is important. If you have inserted a tree with a parent and
6172 children, first move the cursor back to the parent. Any prefix argument
6173 given to this command will be passed on to the @code{org-refile} command.
6175 @orgcmd{C-c C-k,org-capture-kill}
6176 Abort the capture process and return to the previous state.
6180 You can also call @code{org-capture} in a special way from the agenda, using
6181 the @kbd{k c} key combination. With this access, any timestamps inserted by
6182 the selected capture template will default to the cursor date in the agenda,
6183 rather than to the current date.
6185 To find the locations of the last stored capture, use @code{org-capture} with
6190 Visit the target location of a cpature template. You get to select the
6191 template in the usual way.
6192 @orgkey{C-u C-u C-c c}
6193 Visit the last stored capture item in its buffer.
6196 @node Capture templates, , Using capture, Capture
6197 @subsection Capture templates
6198 @cindex templates, for Capture
6200 You can use templates for different types of capture items, and
6201 for different target locations. The easiest way to create such templates is
6202 through the customize interface.
6206 Customize the variable @code{org-capture-templates}.
6209 Before we give the formal description of template definitions, let's look at
6210 an example. Say you would like to use one template to create general TODO
6211 entries, and you want to put these entries under the heading @samp{Tasks} in
6212 your file @file{~/org/gtd.org}. Also, a date tree in the file
6213 @file{journal.org} should capture journal entries. A possible configuration
6217 (setq org-capture-templates
6218 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6219 "* TODO %?\n %i\n %a")
6220 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6221 "* %?\nEntered on %U\n %i\n %a")))
6224 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6228 [[file:@var{link to where you initiated capture}]]
6232 During expansion of the template, @code{%a} has been replaced by a link to
6233 the location from where you called the capture command. This can be
6234 extremely useful for deriving tasks from emails, for example. You fill in
6235 the task definition, press @code{C-c C-c} and Org returns you to the same
6236 place where you started the capture process.
6238 To define special keys to capture to a particular template without going
6239 through the interactive template selection, you can create your key binding
6243 (define-key global-map "\C-c c"
6244 (lambda () (interactive) (org-capture "t")))
6248 * Template elements:: What is needed for a complete template entry
6249 * Template expansion:: Filling in information about time and context
6252 @node Template elements, Template expansion, Capture templates, Capture templates
6253 @subsubsection Template elements
6255 Now lets look at the elements of a template definition. Each entry in
6256 @code{org-capture-templates} is a list with the following items:
6260 The keys that will select the template, as a string, characters
6261 only, for example @code{"a"} for a template to be selected with a
6262 single key, or @code{"bt"} for selection with two keys. When using
6263 several keys, keys using the same prefix key must be sequential
6264 in the list and preceded by a 2-element entry explaining the
6265 prefix key, for example
6267 ("b" "Templates for marking stuff to buy")
6269 @noindent If you do not define a template for the @kbd{C} key, this key will
6270 be used to open the customize buffer for this complex variable.
6273 A short string describing the template, which will be shown during
6277 The type of entry, a symbol. Valid values are:
6280 An Org-mode node, with a headline. Will be filed as the child of the
6281 target entry or as a top-level entry. The target file should be an Org-mode
6284 A plain list item, placed in the first plain list at the target
6285 location. Again the target file should be an Org file.
6287 A checkbox item. This only differs from the plain list item by the
6290 a new line in the first table at the target location. Where exactly the
6291 line will be inserted depends on the properties @code{:prepend} and
6292 @code{:table-line-pos} (see below).
6294 Text to be inserted as it is.
6298 @vindex org-default-notes-file
6299 Specification of where the captured item should be placed. In Org-mode
6300 files, targets usually define a node. Entries will become children of this
6301 node. Other types will be added to the table or list in the body of this
6302 node. Most target specifications contain a file name. If that file name is
6303 the empty string, it defaults to @code{org-default-notes-file}.
6307 @item (file "path/to/file")
6308 Text will be placed at the beginning or end of that file.
6310 @item (id "id of existing org entry")
6311 Filing as child of this entry, or in the body of the entry.
6313 @item (file+headline "path/to/file" "node headline")
6314 Fast configuration if the target heading is unique in the file.
6316 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6317 For non-unique headings, the full path is safer.
6319 @item (file+regexp "path/to/file" "regexp to find location")
6320 Use a regular expression to position the cursor.
6322 @item (file+datetree "path/to/file")
6323 Will create a heading in a date tree for today's date.
6325 @item (file+datetree+prompt "path/to/file")
6326 Will create a heading in a date tree, but will prompt for the date.
6328 @item (file+function "path/to/file" function-finding-location)
6329 A function to find the right location in the file.
6332 File to the entry that is currently being clocked.
6334 @item (function function-finding-location)
6335 Most general way, write your own function to find both
6340 The template for creating the capture item. If you leave this empty, an
6341 appropriate default template will be used. Otherwise this is a string with
6342 escape codes, which will be replaced depending on time and context of the
6343 capture call. The string with escapes may be loaded from a template file,
6344 using the special syntax @code{(file "path/to/template")}. See below for
6348 The rest of the entry is a property list of additional options.
6349 Recognized properties are:
6352 Normally new captured information will be appended at
6353 the target location (last child, last table line, last list item...).
6354 Setting this property will change that.
6356 @item :immediate-finish
6357 When set, do not offer to edit the information, just
6358 file it away immediately. This makes sense if the template only needs
6359 information that can be added automatically.
6362 Set this to the number of lines to insert
6363 before and after the new item. Default 0, only common other value is 1.
6366 Start the clock in this item.
6369 If starting the capture interrupted a clock, restart that clock when finished
6373 Do not narrow the target buffer, simply show the full buffer. Default is to
6374 narrow it so that you only see the new material.
6377 If the target file was not yet visited when capture was invoked, kill the
6378 buffer again after capture is completed.
6382 @node Template expansion, , Template elements, Capture templates
6383 @subsubsection Template expansion
6385 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6386 these sequences literally, escape the @kbd{%} with a backslash.} allow
6387 dynamic insertion of content:
6389 @comment SJE: should these sentences terminate in period?
6391 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6392 @r{You may specify a default value and a completion table with}
6393 @r{%^@{prompt|default|completion2|completion3...@}}
6394 @r{The arrow keys access a prompt-specific history.}
6395 %a @r{annotation, normally the link created with @code{org-store-link}}
6396 %A @r{like @code{%a}, but prompt for the description part}
6397 %i @r{initial content, the region when capture is called while the}
6398 @r{region is active.}
6399 @r{The entire text will be indented like @code{%i} itself.}
6400 %t @r{timestamp, date only}
6401 %T @r{timestamp with date and time}
6402 %u, %U @r{like the above, but inactive timestamps}
6403 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
6404 @r{You may define a prompt like @code{%^@{Birthday@}t}}
6405 %n @r{user name (taken from @code{user-full-name})}
6406 %c @r{Current kill ring head.}
6407 %x @r{Content of the X clipboard.}
6408 %^C @r{Interactive selection of which kill or clip to use.}
6409 %^L @r{Like @code{%^C}, but insert as link.}
6410 %k @r{title of the currently clocked task}
6411 %K @r{link to the currently clocked task}
6412 %^g @r{prompt for tags, with completion on tags in target file.}
6413 %^G @r{prompt for tags, with completion all tags in all agenda files.}
6414 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
6415 %:keyword @r{specific information for certain link types, see below}
6416 %[@var{file}] @r{insert the contents of the file given by @var{file}}
6417 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
6421 For specific link types, the following keywords will be
6422 defined@footnote{If you define your own link types (@pxref{Adding
6423 hyperlink types}), any property you store with
6424 @code{org-store-link-props} can be accessed in capture templates in a
6427 @vindex org-from-is-user-regexp
6429 Link type | Available keywords
6430 -------------------+----------------------------------------------
6431 bbdb | %:name %:company
6432 irc | %:server %:port %:nick
6433 vm, wl, mh, mew, rmail | %:type %:subject %:message-id
6434 | %:from %:fromname %:fromaddress
6435 | %:to %:toname %:toaddress
6436 | %:date @r{(message date header field)}
6437 | %:date-timestamp @r{(date as active timestamp)}
6438 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6439 | %: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}.}}
6440 gnus | %:group, @r{for messages also all email fields}
6442 info | %:file %:node
6447 To place the cursor after template expansion use:
6450 %? @r{After completing the template, position cursor here.}
6454 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6455 @section Attachments
6458 @vindex org-attach-directory
6459 It is often useful to associate reference material with an outline node/task.
6460 Small chunks of plain text can simply be stored in the subtree of a project.
6461 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6462 files that live elsewhere on your computer or in the cloud, like emails or
6463 source code files belonging to a project. Another method is @i{attachments},
6464 which are files located in a directory belonging to an outline node. Org
6465 uses directories named by the unique ID of each entry. These directories are
6466 located in the @file{data} directory which lives in the same directory where
6467 your Org file lives@footnote{If you move entries or Org files from one
6468 directory to another, you may want to configure @code{org-attach-directory}
6469 to contain an absolute path.}. If you initialize this directory with
6470 @code{git init}, Org will automatically commit changes when it sees them.
6471 The attachment system has been contributed to Org by John Wiegley.
6473 In cases where it seems better to do so, you can also attach a directory of your
6474 choice to an entry. You can also make children inherit the attachment
6475 directory from a parent, so that an entire subtree uses the same attached
6478 @noindent The following commands deal with attachments:
6482 @orgcmd{C-c C-a,org-attach}
6483 The dispatcher for commands related to the attachment system. After these
6484 keys, a list of commands is displayed and you must press an additional key
6485 to select a command:
6488 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6489 @vindex org-attach-method
6490 Select a file and move it into the task's attachment directory. The file
6491 will be copied, moved, or linked, depending on @code{org-attach-method}.
6492 Note that hard links are not supported on all systems.
6498 Attach a file using the copy/move/link method.
6499 Note that hard links are not supported on all systems.
6501 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6502 Create a new attachment as an Emacs buffer.
6504 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6505 Synchronize the current task with its attachment directory, in case you added
6506 attachments yourself.
6508 @orgcmdtkc{p,C-c C-a o,org-attach-open}
6509 @vindex org-file-apps
6510 Open current task's attachment. If there is more than one, prompt for a
6511 file name first. Opening will follow the rules set by @code{org-file-apps}.
6512 For more details, see the information on following hyperlinks
6513 (@pxref{Handling links}).
6515 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6516 Also open the attachment, but force opening the file in Emacs.
6518 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6519 Open the current task's attachment directory.
6521 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6522 Also open the directory, but force using @command{dired} in Emacs.
6524 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6525 Select and delete a single attachment.
6527 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6528 Delete all of a task's attachments. A safer way is to open the directory in
6529 @command{dired} and delete from there.
6531 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6532 @cindex property, ATTACH_DIR
6533 Set a specific directory as the entry's attachment directory. This works by
6534 putting the directory path into the @code{ATTACH_DIR} property.
6536 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6537 @cindex property, ATTACH_DIR_INHERIT
6538 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6539 same directory for attachments as the parent does.
6543 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6548 Org can add and change entries based on information found in RSS feeds and
6549 Atom feeds. You could use this to make a task out of each new podcast in a
6550 podcast feed. Or you could use a phone-based note-creating service on the
6551 web to import tasks into Org. To access feeds, configure the variable
6552 @code{org-feed-alist}. The docstring of this variable has detailed
6553 information. Here is just an example:
6556 (setq org-feed-alist
6558 "http://rss.slashdot.org/Slashdot/slashdot"
6559 "~/txt/org/feeds.org" "Slashdot Entries")))
6563 will configure that new items from the feed provided by
6564 @code{rss.slashdot.org} will result in new entries in the file
6565 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6566 the following command is used:
6569 @orgcmd{C-c C-x g,org-feed-update-all}
6571 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6573 @orgcmd{C-c C-x G,org-feed-goto-inbox}
6574 Prompt for a feed name and go to the inbox configured for this feed.
6577 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6578 it will store information about the status of items in the feed, to avoid
6579 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6580 list of drawers in that file:
6583 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6586 For more information, including how to read atom feeds, see
6587 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6589 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6590 @section Protocols for external access
6591 @cindex protocols, for external access
6594 You can set up Org for handling protocol calls from outside applications that
6595 are passed to Emacs through the @file{emacsserver}. For example, you can
6596 configure bookmarks in your web browser to send a link to the current page to
6597 Org and create a note from it using capture (@pxref{Capture}). Or you
6598 could create a bookmark that will tell Emacs to open the local source file of
6599 a remote website you are looking at with the browser. See
6600 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6601 documentation and setup instructions.
6603 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6604 @section Refiling notes
6605 @cindex refiling notes
6607 When reviewing the captured data, you may want to refile some of the entries
6608 into a different list, for example into a project. Cutting, finding the
6609 right location, and then pasting the note is cumbersome. To simplify this
6610 process, you can use the following special command:
6613 @orgcmd{C-c C-w,org-refile}
6614 @vindex org-reverse-note-order
6615 @vindex org-refile-targets
6616 @vindex org-refile-use-outline-path
6617 @vindex org-outline-path-complete-in-steps
6618 @vindex org-refile-allow-creating-parent-nodes
6619 @vindex org-log-refile
6620 @vindex org-refile-use-cache
6621 Refile the entry or region at point. This command offers possible locations
6622 for refiling the entry and lets you select one with completion. The item (or
6623 all items in the region) is filed below the target heading as a subitem.
6624 Depending on @code{org-reverse-note-order}, it will be either the first or
6626 By default, all level 1 headlines in the current buffer are considered to be
6627 targets, but you can have more complex definitions across a number of files.
6628 See the variable @code{org-refile-targets} for details. If you would like to
6629 select a location via a file-path-like completion along the outline path, see
6630 the variables @code{org-refile-use-outline-path} and
6631 @code{org-outline-path-complete-in-steps}. If you would like to be able to
6632 create new nodes as new parents for refiling on the fly, check the
6633 variable @code{org-refile-allow-creating-parent-nodes}.
6634 When the variable @code{org-log-refile}@footnote{with corresponding
6635 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6636 and @code{nologrefile}} is set, a time stamp or a note will be
6637 recorded when an entry has been refiled.
6638 @orgkey{C-u C-c C-w}
6639 Use the refile interface to jump to a heading.
6640 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
6641 Jump to the location where @code{org-refile} last moved a tree to.
6643 Refile as the child of the item currently being clocked.
6644 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6646 @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}
6648 Clear the target cache. Caching of refile targets can be turned on by
6649 setting @code{org-refile-use-cache}. To make the command see new possible
6650 targets, you have to clear the cache with this command.
6653 @node Archiving, , Refiling notes, Capture - Refile - Archive
6657 When a project represented by a (sub)tree is finished, you may want
6658 to move the tree out of the way and to stop it from contributing to the
6659 agenda. Archiving is important to keep your working files compact and global
6660 searches like the construction of agenda views fast.
6663 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
6664 @vindex org-archive-default-command
6665 Archive the current entry using the command specified in the variable
6666 @code{org-archive-default-command}.
6670 * Moving subtrees:: Moving a tree to an archive file
6671 * Internal archiving:: Switch off a tree but keep it in the file
6674 @node Moving subtrees, Internal archiving, Archiving, Archiving
6675 @subsection Moving a tree to the archive file
6676 @cindex external archiving
6678 The most common archiving action is to move a project tree to another file,
6682 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
6683 @vindex org-archive-location
6684 Archive the subtree starting at the cursor position to the location
6685 given by @code{org-archive-location}.
6686 @orgkey{C-u C-c C-x C-s}
6687 Check if any direct children of the current headline could be moved to
6688 the archive. To do this, each subtree is checked for open TODO entries.
6689 If none are found, the command offers to move it to the archive
6690 location. If the cursor is @emph{not} on a headline when this command
6691 is invoked, the level 1 trees will be checked.
6694 @cindex archive locations
6695 The default archive location is a file in the same directory as the
6696 current file, with the name derived by appending @file{_archive} to the
6697 current file name. For information and examples on how to change this,
6698 see the documentation string of the variable
6699 @code{org-archive-location}. There is also an in-buffer option for
6700 setting this variable, for example@footnote{For backward compatibility,
6701 the following also works: If there are several such lines in a file,
6702 each specifies the archive location for the text below it. The first
6703 such line also applies to any text before its definition. However,
6704 using this method is @emph{strongly} deprecated as it is incompatible
6705 with the outline structure of the document. The correct method for
6706 setting multiple archive locations in a buffer is using properties.}:
6710 #+ARCHIVE: %s_done::
6713 @cindex property, ARCHIVE
6715 If you would like to have a special ARCHIVE location for a single entry
6716 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6717 location as the value (@pxref{Properties and Columns}).
6719 @vindex org-archive-save-context-info
6720 When a subtree is moved, it receives a number of special properties that
6721 record context information like the file from where the entry came, its
6722 outline path the archiving time etc. Configure the variable
6723 @code{org-archive-save-context-info} to adjust the amount of information
6727 @node Internal archiving, , Moving subtrees, Archiving
6728 @subsection Internal archiving
6730 If you want to just switch off (for agenda views) certain subtrees without
6731 moving them to a different file, you can use the @code{ARCHIVE tag}.
6733 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6734 its location in the outline tree, but behaves in the following way:
6737 @vindex org-cycle-open-archived-trees
6738 It does not open when you attempt to do so with a visibility cycling
6739 command (@pxref{Visibility cycling}). You can force cycling archived
6740 subtrees with @kbd{C-@key{TAB}}, or by setting the option
6741 @code{org-cycle-open-archived-trees}. Also normal outline commands like
6742 @code{show-all} will open archived subtrees.
6744 @vindex org-sparse-tree-open-archived-trees
6745 During sparse tree construction (@pxref{Sparse trees}), matches in
6746 archived subtrees are not exposed, unless you configure the option
6747 @code{org-sparse-tree-open-archived-trees}.
6749 @vindex org-agenda-skip-archived-trees
6750 During agenda view construction (@pxref{Agenda Views}), the content of
6751 archived trees is ignored unless you configure the option
6752 @code{org-agenda-skip-archived-trees}, in which case these trees will always
6753 be included. In the agenda you can press @kbd{v a} to get archives
6754 temporarily included.
6756 @vindex org-export-with-archived-trees
6757 Archived trees are not exported (@pxref{Exporting}), only the headline
6758 is. Configure the details using the variable
6759 @code{org-export-with-archived-trees}.
6761 @vindex org-columns-skip-archived-trees
6762 Archived trees are excluded from column view unless the variable
6763 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
6766 The following commands help manage the ARCHIVE tag:
6769 @orgcmd{C-c C-x a,org-toggle-archive-tag}
6770 Toggle the ARCHIVE tag for the current headline. When the tag is set,
6771 the headline changes to a shadowed face, and the subtree below it is
6773 @orgkey{C-u C-c C-x a}
6774 Check if any direct children of the current headline should be archived.
6775 To do this, each subtree is checked for open TODO entries. If none are
6776 found, the command offers to set the ARCHIVE tag for the child. If the
6777 cursor is @emph{not} on a headline when this command is invoked, the
6778 level 1 trees will be checked.
6779 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
6780 Cycle a tree even if it is tagged with ARCHIVE.
6781 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
6782 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
6783 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
6784 entry becomes a child of that sibling and in this way retains a lot of its
6785 original context, including inherited tags and approximate position in the
6790 @node Agenda Views, Markup, Capture - Refile - Archive, Top
6791 @chapter Agenda views
6792 @cindex agenda views
6794 Due to the way Org works, TODO items, time-stamped items, and
6795 tagged headlines can be scattered throughout a file or even a number of
6796 files. To get an overview of open action items, or of events that are
6797 important for a particular date, this information must be collected,
6798 sorted and displayed in an organized way.
6800 Org can select items based on various criteria and display them
6801 in a separate buffer. Seven different view types are provided:
6805 an @emph{agenda} that is like a calendar and shows information
6808 a @emph{TODO list} that covers all unfinished
6811 a @emph{match view}, showings headlines based on the tags, properties, and
6812 TODO state associated with them,
6814 a @emph{timeline view} that shows all events in a single Org file,
6815 in time-sorted view,
6817 a @emph{text search view} that shows all entries from multiple files
6818 that contain specified keywords,
6820 a @emph{stuck projects view} showing projects that currently don't move
6823 @emph{custom views} that are special searches and combinations of different
6828 The extracted information is displayed in a special @emph{agenda
6829 buffer}. This buffer is read-only, but provides commands to visit the
6830 corresponding locations in the original Org files, and even to
6831 edit these files remotely.
6833 @vindex org-agenda-window-setup
6834 @vindex org-agenda-restore-windows-after-quit
6835 Two variables control how the agenda buffer is displayed and whether the
6836 window configuration is restored when the agenda exits:
6837 @code{org-agenda-window-setup} and
6838 @code{org-agenda-restore-windows-after-quit}.
6841 * Agenda files:: Files being searched for agenda information
6842 * Agenda dispatcher:: Keyboard access to agenda views
6843 * Built-in agenda views:: What is available out of the box?
6844 * Presentation and sorting:: How agenda items are prepared for display
6845 * Agenda commands:: Remote editing of Org trees
6846 * Custom agenda views:: Defining special searches and views
6847 * Exporting Agenda Views:: Writing a view to a file
6848 * Agenda column view:: Using column view for collected entries
6851 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
6852 @section Agenda files
6853 @cindex agenda files
6854 @cindex files for agenda
6856 @vindex org-agenda-files
6857 The information to be shown is normally collected from all @emph{agenda
6858 files}, the files listed in the variable
6859 @code{org-agenda-files}@footnote{If the value of that variable is not a
6860 list, but a single file name, then the list of agenda files will be
6861 maintained in that external file.}. If a directory is part of this list,
6862 all files with the extension @file{.org} in this directory will be part
6865 Thus, even if you only work with a single Org file, that file should
6866 be put into the list@footnote{When using the dispatcher, pressing
6867 @kbd{<} before selecting a command will actually limit the command to
6868 the current file, and ignore @code{org-agenda-files} until the next
6869 dispatcher command.}. You can customize @code{org-agenda-files}, but
6870 the easiest way to maintain it is through the following commands
6872 @cindex files, adding to agenda list
6874 @orgcmd{C-c [,org-agenda-to-front}
6875 Add current file to the list of agenda files. The file is added to
6876 the front of the list. If it was already in the list, it is moved to
6877 the front. With a prefix argument, file is added/moved to the end.
6878 @orgcmd{C-c ],org-remove-file}
6879 Remove current file from the list of agenda files.
6881 @orgcmd{C-',org-cycle-agenda-files}
6883 Cycle through agenda file list, visiting one file after the other.
6884 @kindex M-x org-iswitchb
6885 @item M-x org-iswitchb
6886 Command to use an @code{iswitchb}-like interface to switch to and between Org
6891 The Org menu contains the current list of files and can be used
6892 to visit any of them.
6894 If you would like to focus the agenda temporarily on a file not in
6895 this list, or on just one file in the list, or even on only a subtree in a
6896 file, then this can be done in different ways. For a single agenda command,
6897 you may press @kbd{<} once or several times in the dispatcher
6898 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
6899 extended period, use the following commands:
6902 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
6903 Permanently restrict the agenda to the current subtree. When with a
6904 prefix argument, or with the cursor before the first headline in a file,
6905 the agenda scope is set to the entire file. This restriction remains in
6906 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
6907 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
6908 agenda view, the new restriction takes effect immediately.
6909 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
6910 Remove the permanent restriction created by @kbd{C-c C-x <}.
6914 When working with @file{speedbar.el}, you can use the following commands in
6917 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
6918 Permanently restrict the agenda to the item---either an Org file or a subtree
6919 in such a file---at the cursor in the Speedbar frame.
6920 If there is a window displaying an agenda view, the new restriction takes
6922 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
6923 Lift the restriction.
6926 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
6927 @section The agenda dispatcher
6928 @cindex agenda dispatcher
6929 @cindex dispatching agenda commands
6930 The views are created through a dispatcher, which should be bound to a
6931 global key---for example @kbd{C-c a} (@pxref{Installation}). In the
6932 following we will assume that @kbd{C-c a} is indeed how the dispatcher
6933 is accessed and list keyboard access to commands accordingly. After
6934 pressing @kbd{C-c a}, an additional letter is required to execute a
6935 command. The dispatcher offers the following default commands:
6938 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
6940 Create a list of all TODO items (@pxref{Global TODO list}).
6942 Create a list of headlines matching a TAGS expression (@pxref{Matching
6943 tags and properties}).
6945 Create the timeline view for the current buffer (@pxref{Timeline}).
6947 Create a list of entries selected by a boolean expression of keywords
6948 and/or regular expressions that must or must not occur in the entry.
6950 @vindex org-agenda-text-search-extra-files
6951 Search for a regular expression in all agenda files and additionally in
6952 the files listed in @code{org-agenda-text-search-extra-files}. This
6953 uses the Emacs command @code{multi-occur}. A prefix argument can be
6954 used to specify the number of context lines for each match, default is
6957 Create a list of stuck projects (@pxref{Stuck projects}).
6959 Restrict an agenda command to the current buffer@footnote{For backward
6960 compatibility, you can also press @kbd{1} to restrict to the current
6961 buffer.}. After pressing @kbd{<}, you still need to press the character
6962 selecting the command.
6964 If there is an active region, restrict the following agenda command to
6965 the region. Otherwise, restrict it to the current subtree@footnote{For
6966 backward compatibility, you can also press @kbd{0} to restrict to the
6967 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
6968 character selecting the command.
6971 You can also define custom commands that will be accessible through the
6972 dispatcher, just like the default commands. This includes the
6973 possibility to create extended agenda buffers that contain several
6974 blocks together, for example the weekly agenda, the global TODO list and
6975 a number of special tags matches. @xref{Custom agenda views}.
6977 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
6978 @section The built-in agenda views
6980 In this section we describe the built-in views.
6983 * Weekly/daily agenda:: The calendar page with current tasks
6984 * Global TODO list:: All unfinished action items
6985 * Matching tags and properties:: Structured information with fine-tuned search
6986 * Timeline:: Time-sorted view for single file
6987 * Search view:: Find entries by searching for text
6988 * Stuck projects:: Find projects you need to review
6991 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
6992 @subsection The weekly/daily agenda
6994 @cindex weekly agenda
6995 @cindex daily agenda
6997 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
6998 paper agenda, showing all the tasks for the current week or day.
7001 @cindex org-agenda, command
7002 @orgcmd{C-c a a,org-agenda-list}
7003 Compile an agenda for the current week from a list of Org files. The agenda
7004 shows the entries for each day. With a numeric prefix@footnote{For backward
7005 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7006 listed before the agenda. This feature is deprecated, use the dedicated TODO
7007 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7008 C-c a a}) you may set the number of days to be displayed.
7011 @vindex org-agenda-span
7012 @vindex org-agenda-ndays
7013 The default number of days displayed in the agenda is set by the variable
7014 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7015 variable can be set to any number of days you want to see by default in the
7016 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7019 Remote editing from the agenda buffer means, for example, that you can
7020 change the dates of deadlines and appointments from the agenda buffer.
7021 The commands available in the Agenda buffer are listed in @ref{Agenda
7024 @subsubheading Calendar/Diary integration
7025 @cindex calendar integration
7026 @cindex diary integration
7028 Emacs contains the calendar and diary by Edward M. Reingold. The
7029 calendar displays a three-month calendar with holidays from different
7030 countries and cultures. The diary allows you to keep track of
7031 anniversaries, lunar phases, sunrise/set, recurrent appointments
7032 (weekly, monthly) and more. In this way, it is quite complementary to
7033 Org. It can be very useful to combine output from Org with
7036 In order to include entries from the Emacs diary into Org-mode's
7037 agenda, you only need to customize the variable
7040 (setq org-agenda-include-diary t)
7043 @noindent After that, everything will happen automatically. All diary
7044 entries including holidays, anniversaries, etc., will be included in the
7045 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
7046 @key{RET} can be used from the agenda buffer to jump to the diary
7047 file in order to edit existing diary entries. The @kbd{i} command to
7048 insert new entries for the current date works in the agenda buffer, as
7049 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7050 Sunrise/Sunset times, show lunar phases and to convert to other
7051 calendars, respectively. @kbd{c} can be used to switch back and forth
7052 between calendar and agenda.
7054 If you are using the diary only for sexp entries and holidays, it is
7055 faster to not use the above setting, but instead to copy or even move
7056 the entries into an Org file. Org-mode evaluates diary-style sexp
7057 entries, and does it faster because there is no overhead for first
7058 creating the diary display. Note that the sexp entries must start at
7059 the left margin, no whitespace is allowed before them. For example,
7060 the following segment of an Org file will be processed and entries
7061 will be made in the agenda:
7064 * Birthdays and similar stuff
7066 %%(org-calendar-holiday) ; special function for holiday names
7068 %%(diary-anniversary 5 14 1956)@footnote{Note that the order of the arguments (month, day, year) depends on the setting of @code{calendar-date-style}.} Arthur Dent is %d years old
7069 %%(diary-anniversary 10 2 1869) Mahatma Gandhi would be %d years old
7072 @subsubheading Anniversaries from BBDB
7073 @cindex BBDB, anniversaries
7074 @cindex anniversaries, from BBDB
7076 If you are using the Big Brothers Database to store your contacts, you will
7077 very likely prefer to store anniversaries in BBDB rather than in a
7078 separate Org or diary file. Org supports this and will show BBDB
7079 anniversaries as part of the agenda. All you need to do is to add the
7080 following to one your your agenda files:
7087 %%(org-bbdb-anniversaries)
7090 You can then go ahead and define anniversaries for a BBDB record. Basically,
7091 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7092 record and then add the date in the format @code{YYYY-MM-DD}, followed by a
7093 space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
7094 a format string). If you omit the class, it will default to @samp{birthday}.
7095 Here are a few examples, the header for the file @file{org-bbdb.el} contains
7096 more detailed information.
7101 2008-04-14 %s released version 6.01 of org-mode, %d years ago
7104 After a change to BBDB, or for the first agenda display during an Emacs
7105 session, the agenda display will suffer a short delay as Org updates its
7106 hash with anniversaries. However, from then on things will be very fast---much
7107 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7108 in an Org or Diary file.
7110 @subsubheading Appointment reminders
7111 @cindex @file{appt.el}
7112 @cindex appointment reminders
7114 Org can interact with Emacs appointments notification facility. To add all
7115 the appointments of your agenda files, use the command
7116 @code{org-agenda-to-appt}. This command also lets you filter through the
7117 list of your appointments and add only those belonging to a specific category
7118 or matching a regular expression. See the docstring for details.
7120 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7121 @subsection The global TODO list
7122 @cindex global TODO list
7123 @cindex TODO list, global
7125 The global TODO list contains all unfinished TODO items formatted and
7126 collected into a single place.
7129 @orgcmd{C-c a t,org-todo-list}
7130 Show the global TODO list. This collects the TODO items from all agenda
7131 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7132 items with a state the is not a DONE state. The buffer is in
7133 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7134 entries directly from that buffer (@pxref{Agenda commands}).
7135 @orgcmd{C-c a T,org-todo-list}
7136 @cindex TODO keyword matching
7137 @vindex org-todo-keywords
7138 Like the above, but allows selection of a specific TODO keyword. You can
7139 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7140 prompted for a keyword, and you may also specify several keywords by
7141 separating them with @samp{|} as the boolean OR operator. With a numeric
7142 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7144 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7145 a prefix argument to this command to change the selected TODO keyword,
7146 for example @kbd{3 r}. If you often need a search for a specific
7147 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7148 Matching specific TODO keywords can also be done as part of a tags
7149 search (@pxref{Tag searches}).
7152 Remote editing of TODO items means that you can change the state of a
7153 TODO entry with a single key press. The commands available in the
7154 TODO list are described in @ref{Agenda commands}.
7156 @cindex sublevels, inclusion into TODO list
7157 Normally the global TODO list simply shows all headlines with TODO
7158 keywords. This list can become very long. There are two ways to keep
7162 @vindex org-agenda-todo-ignore-scheduled
7163 @vindex org-agenda-todo-ignore-deadlines
7164 @vindex org-agenda-todo-ignore-timestamp
7165 @vindex org-agenda-todo-ignore-with-date
7166 Some people view a TODO item that has been @emph{scheduled} for execution or
7167 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7168 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7169 @code{org-agenda-todo-ignore-deadlines},
7170 @code{org-agenda-todo-ignore-timestamp} and/or
7171 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7174 @vindex org-agenda-todo-list-sublevels
7175 TODO items may have sublevels to break up the task into subtasks. In
7176 such cases it may be enough to list only the highest level TODO headline
7177 and omit the sublevels from the global list. Configure the variable
7178 @code{org-agenda-todo-list-sublevels} to get this behavior.
7181 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7182 @subsection Matching tags and properties
7183 @cindex matching, of tags
7184 @cindex matching, of properties
7188 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7189 or have properties (@pxref{Properties and Columns}), you can select headlines
7190 based on this metadata and collect them into an agenda buffer. The match
7191 syntax described here also applies when creating sparse trees with @kbd{C-c /
7195 @orgcmd{C-c a m,org-tags-view}
7196 Produce a list of all headlines that match a given set of tags. The
7197 command prompts for a selection criterion, which is a boolean logic
7198 expression with tags, like @samp{+work+urgent-withboss} or
7199 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7200 define a custom command for it (@pxref{Agenda dispatcher}).
7201 @orgcmd{C-c a M,org-tags-view}
7202 @vindex org-tags-match-list-sublevels
7203 @vindex org-agenda-tags-todo-honor-ignore-options
7204 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7205 not-DONE state and force checking subitems (see variable
7206 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7207 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7208 specific TODO keywords together with a tags match is also possible, see
7212 The commands available in the tags list are described in @ref{Agenda
7215 @subsubheading Match syntax
7217 @cindex Boolean logic, for tag/property searches
7218 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7219 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7220 not implemented. Each element in the search is either a tag, a regular
7221 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7222 VALUE} with a comparison operator, accessing a property value. Each element
7223 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7224 sugar for positive selection. The AND operator @samp{&} is optional when
7225 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7229 Select headlines tagged @samp{:work:}, but discard those also tagged
7232 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7233 @item work|laptop+night
7234 Like before, but require the @samp{:laptop:} lines to be tagged also
7238 @cindex regular expressions, with tags search
7239 Instead of a tag, you may also specify a regular expression enclosed in curly
7240 braces. For example,
7241 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7242 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7244 @cindex TODO keyword matching, with tags search
7245 @cindex level, require for tags/property match
7246 @cindex category, require for tags/property match
7247 @vindex org-odd-levels-only
7248 You may also test for properties (@pxref{Properties and Columns}) at the same
7249 time as matching tags. The properties may be real properties, or special
7250 properties that represent other metadata (@pxref{Special properties}). For
7251 example, the ``property'' @code{TODO} represents the TODO keyword of the
7252 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7253 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7254 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7255 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7256 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7258 Here are more examples:
7260 @item work+TODO="WAITING"
7261 Select @samp{:work:}-tagged TODO lines with the specific TODO
7262 keyword @samp{WAITING}.
7263 @item work+TODO="WAITING"|home+TODO="WAITING"
7264 Waiting tasks both at work and at home.
7267 When matching properties, a number of different operators can be used to test
7268 the value of a property. Here is a complex example:
7271 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7272 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7276 The type of comparison will depend on how the comparison value is written:
7279 If the comparison value is a plain number, a numerical comparison is done,
7280 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7281 @samp{>=}, and @samp{<>}.
7283 If the comparison value is enclosed in double-quotes,
7284 a string comparison is done, and the same operators are allowed.
7286 If the comparison value is enclosed in double-quotes @emph{and} angular
7287 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7288 assumed to be date/time specifications in the standard Org way, and the
7289 comparison will be done accordingly. Special values that will be recognized
7290 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7291 @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
7292 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7293 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7294 respectively, can be used.
7296 If the comparison value is enclosed
7297 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7298 regexp matches the property value, and @samp{<>} meaning that it does not
7302 So the search string in the example finds entries tagged @samp{:work:} but
7303 not @samp{:boss:}, which also have a priority value @samp{A}, a
7304 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7305 property that is numerically smaller than 2, a @samp{:With:} property that is
7306 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7307 on or after October 11, 2008.
7309 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7310 other properties will slow down the search. However, once you have paid the
7311 price by accessing one property, testing additional properties is cheap
7314 You can configure Org-mode to use property inheritance during a search, but
7315 beware that this can slow down searches considerably. See @ref{Property
7316 inheritance}, for details.
7318 For backward compatibility, and also for typing speed, there is also a
7319 different way to test TODO states in a search. For this, terminate the
7320 tags/property part of the search string (which may include several terms
7321 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7322 expression just for TODO keywords. The syntax is then similar to that for
7323 tags, but should be applied with care: for example, a positive selection on
7324 several TODO keywords cannot meaningfully be combined with boolean AND.
7325 However, @emph{negative selection} combined with AND can be meaningful. To
7326 make sure that only lines are checked that actually have any TODO keyword
7327 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7328 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7329 not match TODO keywords in a DONE state. Examples:
7333 Same as @samp{work+TODO="WAITING"}
7334 @item work/!-WAITING-NEXT
7335 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7337 @item work/!+WAITING|+NEXT
7338 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7342 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7343 @subsection Timeline for a single file
7344 @cindex timeline, single file
7345 @cindex time-sorted view
7347 The timeline summarizes all time-stamped items from a single Org-mode
7348 file in a @emph{time-sorted view}. The main purpose of this command is
7349 to give an overview over events in a project.
7352 @orgcmd{C-c a L,org-timeline}
7353 Show a time-sorted view of the Org file, with all time-stamped items.
7354 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7355 (scheduled or not) are also listed under the current date.
7359 The commands available in the timeline buffer are listed in
7360 @ref{Agenda commands}.
7362 @node Search view, Stuck projects, Timeline, Built-in agenda views
7363 @subsection Search view
7366 @cindex searching, for text
7368 This agenda view is a general text search facility for Org-mode entries.
7369 It is particularly useful to find notes.
7372 @orgcmd{C-c a s,org-search-view}
7373 This is a special search that lets you select entries by matching a substring
7374 or specific words using a boolean logic.
7376 For example, the search string @samp{computer equipment} will find entries
7377 that contain @samp{computer equipment} as a substring. If the two words are
7378 separated by more space or a line break, the search will still match.
7379 Search view can also search for specific keywords in the entry, using Boolean
7380 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7381 will search for note entries that contain the keywords @code{computer}
7382 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7383 not matched by the regular expression @code{8\.11[bg]}, meaning to
7384 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7385 word search, other @samp{+} characters are optional. For more details, see
7386 the docstring of the command @code{org-search-view}.
7388 @vindex org-agenda-text-search-extra-files
7389 Note that in addition to the agenda files, this command will also search
7390 the files listed in @code{org-agenda-text-search-extra-files}.
7392 @node Stuck projects, , Search view, Built-in agenda views
7393 @subsection Stuck projects
7395 If you are following a system like David Allen's GTD to organize your
7396 work, one of the ``duties'' you have is a regular review to make sure
7397 that all projects move along. A @emph{stuck} project is a project that
7398 has no defined next actions, so it will never show up in the TODO lists
7399 Org-mode produces. During the review, you need to identify such
7400 projects and define next actions for them.
7403 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7404 List projects that are stuck.
7407 @vindex org-stuck-projects
7408 Customize the variable @code{org-stuck-projects} to define what a stuck
7409 project is and how to find it.
7412 You almost certainly will have to configure this view before it will
7413 work for you. The built-in default assumes that all your projects are
7414 level-2 headlines, and that a project is not stuck if it has at least
7415 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7417 Let's assume that you, in your own way of using Org-mode, identify
7418 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7419 indicate a project that should not be considered yet. Let's further
7420 assume that the TODO keyword DONE marks finished projects, and that NEXT
7421 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7422 is a next action even without the NEXT tag. Finally, if the project
7423 contains the special word IGNORE anywhere, it should not be listed
7424 either. In this case you would start by identifying eligible projects
7425 with a tags/todo match@footnote{@xref{Tag searches}.}
7426 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7427 IGNORE in the subtree to identify projects that are not stuck. The
7428 correct customization for this is
7431 (setq org-stuck-projects
7432 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7436 Note that if a project is identified as non-stuck, the subtree of this entry
7437 will still be searched for stuck projects.
7439 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7440 @section Presentation and sorting
7441 @cindex presentation, of agenda items
7443 @vindex org-agenda-prefix-format
7444 Before displaying items in an agenda view, Org-mode visually prepares
7445 the items and sorts them. Each item occupies a single line. The line
7446 starts with a @emph{prefix} that contains the @emph{category}
7447 (@pxref{Categories}) of the item and other important information. You can
7448 customize the prefix using the option @code{org-agenda-prefix-format}.
7449 The prefix is followed by a cleaned-up version of the outline headline
7450 associated with the item.
7453 * Categories:: Not all tasks are equal
7454 * Time-of-day specifications:: How the agenda knows the time
7455 * Sorting of agenda items:: The order of things
7458 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7459 @subsection Categories
7463 The category is a broad label assigned to each agenda item. By default,
7464 the category is simply derived from the file name, but you can also
7465 specify it with a special line in the buffer, like this@footnote{For
7466 backward compatibility, the following also works: if there are several
7467 such lines in a file, each specifies the category for the text below it.
7468 The first category also applies to any text before the first CATEGORY
7469 line. However, using this method is @emph{strongly} deprecated as it is
7470 incompatible with the outline structure of the document. The correct
7471 method for setting multiple categories in a buffer is using a
7479 @cindex property, CATEGORY
7480 If you would like to have a special CATEGORY for a single entry or a
7481 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7482 special category you want to apply as the value.
7485 The display in the agenda buffer looks best if the category is not
7486 longer than 10 characters.
7489 You can set up icons for category by customizing the
7490 @code{org-agenda-category-icon-alist} variable.
7492 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7493 @subsection Time-of-day specifications
7494 @cindex time-of-day specification
7496 Org-mode checks each agenda item for a time-of-day specification. The
7497 time can be part of the timestamp that triggered inclusion into the
7498 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7499 ranges can be specified with two timestamps, like
7501 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7503 In the headline of the entry itself, a time(range) may also appear as
7504 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7505 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7506 specifications in diary entries are recognized as well.
7508 For agenda display, Org-mode extracts the time and displays it in a
7509 standard 24 hour format as part of the prefix. The example times in
7510 the previous paragraphs would end up in the agenda like this:
7513 8:30-13:00 Arthur Dent lies in front of the bulldozer
7514 12:45...... Ford Prefect arrives and takes Arthur to the pub
7515 19:00...... The Vogon reads his poem
7516 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7520 If the agenda is in single-day mode, or for the display of today, the
7521 timed entries are embedded in a time grid, like
7524 8:00...... ------------------
7525 8:30-13:00 Arthur Dent lies in front of the bulldozer
7526 10:00...... ------------------
7527 12:00...... ------------------
7528 12:45...... Ford Prefect arrives and takes Arthur to the pub
7529 14:00...... ------------------
7530 16:00...... ------------------
7531 18:00...... ------------------
7532 19:00...... The Vogon reads his poem
7533 20:00...... ------------------
7534 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7537 @vindex org-agenda-use-time-grid
7538 @vindex org-agenda-time-grid
7539 The time grid can be turned on and off with the variable
7540 @code{org-agenda-use-time-grid}, and can be configured with
7541 @code{org-agenda-time-grid}.
7543 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7544 @subsection Sorting of agenda items
7545 @cindex sorting, of agenda items
7546 @cindex priorities, of agenda items
7547 Before being inserted into a view, the items are sorted. How this is
7548 done depends on the type of view.
7551 @vindex org-agenda-files
7552 For the daily/weekly agenda, the items for each day are sorted. The
7553 default order is to first collect all items containing an explicit
7554 time-of-day specification. These entries will be shown at the beginning
7555 of the list, as a @emph{schedule} for the day. After that, items remain
7556 grouped in categories, in the sequence given by @code{org-agenda-files}.
7557 Within each category, items are sorted by priority (@pxref{Priorities}),
7558 which is composed of the base priority (2000 for priority @samp{A}, 1000
7559 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7560 overdue scheduled or deadline items.
7562 For the TODO list, items remain in the order of categories, but within
7563 each category, sorting takes place according to priority
7564 (@pxref{Priorities}). The priority used for sorting derives from the
7565 priority cookie, with additions depending on how close an item is to its due
7568 For tags matches, items are not sorted at all, but just appear in the
7569 sequence in which they are found in the agenda files.
7572 @vindex org-agenda-sorting-strategy
7573 Sorting can be customized using the variable
7574 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7575 the estimated effort of an entry (@pxref{Effort estimates}).
7577 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7578 @section Commands in the agenda buffer
7579 @cindex commands, in agenda buffer
7581 Entries in the agenda buffer are linked back to the Org file or diary
7582 file where they originate. You are not allowed to edit the agenda
7583 buffer itself, but commands are provided to show and jump to the
7584 original entry location, and to edit the Org files ``remotely'' from
7585 the agenda buffer. In this way, all information is stored only once,
7586 removing the risk that your agenda and note files may diverge.
7588 Some commands can be executed with mouse clicks on agenda lines. For
7589 the other commands, the cursor needs to be in the desired line.
7592 @tsubheading{Motion}
7593 @cindex motion commands in agenda
7594 @orgcmd{n,org-agenda-next-line}
7595 Next line (same as @key{up} and @kbd{C-p}).
7596 @orgcmd{p,org-agenda-previous-line}
7597 Previous line (same as @key{down} and @kbd{C-n}).
7598 @tsubheading{View/Go to Org file}
7599 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
7600 Display the original location of the item in another window.
7601 With prefix arg, make sure that the entire entry is made visible in the
7602 outline, not only the heading.
7604 @orgcmd{L,org-agenda-recenter}
7605 Display original location and recenter that window.
7607 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
7608 Go to the original location of the item in another window.
7610 @orgcmd{@key{RET},org-agenda-switch-to}
7611 Go to the original location of the item and delete other windows.
7613 @orgcmd{F,org-agenda-follow-mode}
7614 @vindex org-agenda-start-with-follow-mode
7615 Toggle Follow mode. In Follow mode, as you move the cursor through
7616 the agenda buffer, the other window always shows the corresponding
7617 location in the Org file. The initial setting for this mode in new
7618 agenda buffers can be set with the variable
7619 @code{org-agenda-start-with-follow-mode}.
7621 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
7622 Display the entire subtree of the current item in an indirect buffer. With a
7623 numeric prefix argument N, go up to level N and then take that tree. If N is
7624 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
7625 previously used indirect buffer.
7627 @orgcmd{C-c C-o,org-agenda-open-link}
7628 Follow a link in the entry. This will offer a selection of any links in the
7629 text belonging to the referenced Org node. If there is only one link, it
7630 will be followed without a selection prompt.
7632 @tsubheading{Change display}
7633 @cindex display changing, in agenda
7636 Delete other windows.
7644 @c @item v d @ @r{or short} @ d
7645 @c @itemx v w @ @r{or short} @ w
7648 @orgcmdkskc{v d,d,org-aganda-day-view}
7649 @xorgcmdkskc{v w,w,org-aganda-day-view}
7650 @xorgcmd{v m,org-agenda-month-view}
7651 @xorgcmd{v y,org-agenda-month-year}
7652 Switch to day/week/month/year view. When switching to day or week view,
7653 this setting becomes the default for subsequent agenda commands. Since
7654 month and year views are slow to create, they do not become the default.
7655 A numeric prefix argument may be used to jump directly to a specific day
7656 of the year, ISO week, month, or year, respectively. For example,
7657 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
7658 setting day, week, or month view, a year may be encoded in the prefix
7659 argument as well. For example, @kbd{200712 w} will jump to week 12 in
7660 2007. If such a year specification has only one or two digits, it will
7661 be mapped to the interval 1938-2037.
7663 @orgcmd{f,org-agenda-later}
7664 Go forward in time to display the following @code{org-agenda-current-span} days.
7665 For example, if the display covers a week, switch to the following week.
7666 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
7668 @orgcmd{b,org-agenda-earlier}
7669 Go backward in time to display earlier dates.
7671 @orgcmd{.,org-agenda-goto-today}
7674 @orgcmd{j,org-agenda-goto-date}
7675 Prompt for a date and go there.
7677 @orgcmd{J,org-agenda-clock-goto}
7678 Go to the currently clocked-in task @i{in the agenda buffer}.
7680 @orgcmd{D,org-agenda-toggle-diary}
7681 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7683 @orgcmdkskc{v l,l,org-agenda-log-mode}
7685 @vindex org-log-done
7686 @vindex org-agenda-log-mode-items
7687 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7688 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7689 entries that have been clocked on that day. You can configure the entry
7690 types that should be included in log mode using the variable
7691 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7692 all possible logbook entries, including state changes. When called with two
7693 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7694 @kbd{v L} is equivalent to @kbd{C-u v l}.
7696 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
7697 Include inactive timestamps into the current view. Only for weekly/daily
7698 agenda and timeline views.
7700 @orgcmd{v a,org-agenda-archives-mode}
7701 @xorgcmd{v A,org-agenda-archives-mode 'files}
7702 Toggle Archives mode. In Archives mode, trees that are marked
7703 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7704 capital @kbd{A}, even all archive files are included. To exit archives mode,
7705 press @kbd{v a} again.
7707 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
7708 @vindex org-agenda-start-with-clockreport-mode
7709 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7710 always show a table with the clocked times for the timespan and file scope
7711 covered by the current agenda view. The initial setting for this mode in new
7712 agenda buffers can be set with the variable
7713 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
7714 when toggling this mode (i.e. @kbd{C-u R}), the clock table will not show
7715 contributions from entries that are hidden by agenda filtering@footnote{Only
7716 tags filtering will be respected here, effort filtering is ignored.}.
7718 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
7719 @vindex org-agenda-start-with-entry-text-mode
7720 @vindex org-agenda-entry-text-maxlines
7721 Toggle entry text mode. In entry text mode, a number of lines from the Org
7722 outline node referenced by an agenda line will be displayed below the line.
7723 The maximum number of lines is given by the variable
7724 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
7725 prefix argument will temporarily modify that number to the prefix value.
7727 @orgcmd{G,org-agenda-toggle-time-grid}
7728 @vindex org-agenda-use-time-grid
7729 @vindex org-agenda-time-grid
7730 Toggle the time grid on and off. See also the variables
7731 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
7733 @orgcmd{r,org-agenda-rodo}
7734 Recreate the agenda buffer, for example to reflect the changes after
7735 modification of the timestamps of items with @kbd{S-@key{left}} and
7736 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
7737 argument is interpreted to create a selective list for a specific TODO
7739 @orgcmd{g,org-agenda-rodo}
7742 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
7743 Save all Org buffers in the current Emacs session, and also the locations of
7746 @orgcmd{C-c C-x C-c,org-agenda-columns}
7747 @vindex org-columns-default-format
7748 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
7749 view format is taken from the entry at point, or (if there is no entry at
7750 point), from the first entry in the agenda view. So whatever the format for
7751 that entry would be in the original buffer (taken from a property, from a
7752 @code{#+COLUMNS} line, or from the default variable
7753 @code{org-columns-default-format}), will be used in the agenda.
7755 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7756 Remove the restriction lock on the agenda, if it is currently restricted to a
7757 file or subtree (@pxref{Agenda files}).
7759 @tsubheading{Secondary filtering and query editing}
7760 @cindex filtering, by tag and effort, in agenda
7761 @cindex tag filtering, in agenda
7762 @cindex effort filtering, in agenda
7763 @cindex query editing, in agenda
7765 @orgcmd{/,org-agenda-filter-by-tag}
7766 @vindex org-agenda-filter-preset
7767 Filter the current agenda view with respect to a tag and/or effort estimates.
7768 The difference between this and a custom agenda command is that filtering is
7769 very fast, so that you can switch quickly between different filters without
7770 having to recreate the agenda.@footnote{Custom commands can preset a filter by
7771 binding the variable @code{org-agenda-filter-preset} as an option. This
7772 filter will then be applied to the view and persist as a basic filter through
7773 refreshes and more secondary filtering. The filter is a global property of
7774 the entire agenda view---in a block agenda, you should only set this in the
7775 global options section, not in the section of an individual block.}
7777 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
7778 all. Pressing @key{TAB} at that prompt will offer use completion to select a
7779 tag (including any tags that do not have a selection character). The command
7780 then hides all entries that do not contain or inherit this tag. When called
7781 with prefix arg, remove the entries that @emph{do} have the tag. A second
7782 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
7783 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
7784 will be narrowed by requiring or forbidding the selected additional tag.
7785 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
7786 immediately use the @kbd{\} command.
7788 @vindex org-sort-agenda-noeffort-is-high
7789 In order to filter for effort estimates, you should set up allowed
7790 efforts globally, for example
7792 (setq org-global-properties
7793 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
7795 You can then filter for an effort by first typing an operator, one of
7796 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
7797 estimate in your array of allowed values, where @kbd{0} means the 10th value.
7798 The filter will then restrict to entries with effort smaller-or-equal, equal,
7799 or larger-or-equal than the selected value. If the digits 0-9 are not used
7800 as fast access keys to tags, you can also simply press the index digit
7801 directly without an operator. In this case, @kbd{<} will be assumed. For
7802 application of the operator, entries without a defined effort will be treated
7803 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
7804 for tasks without effort definition, press @kbd{?} as the operator.
7806 Org also supports automatic, context-aware tag filtering. If the variable
7807 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
7808 that function can decide which tags should be excluded from the agenda
7809 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
7810 as a sub-option key and runs the auto exclusion logic. For example, let's
7811 say you use a @code{Net} tag to identify tasks which need network access, an
7812 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
7813 calls. You could auto-exclude these tags based on the availability of the
7814 Internet, and outside of business hours, with something like this:
7818 (defun org-my-auto-exclude-function (tag)
7820 ((string= tag "Net")
7821 (/= 0 (call-process "/sbin/ping" nil nil nil
7822 "-c1" "-q" "-t1" "mail.gnu.org")))
7823 ((or (string= tag "Errand") (string= tag "Call"))
7824 (let ((hour (nth 2 (decode-time))))
7825 (or (< hour 8) (> hour 21)))))
7828 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
7832 @orgcmd{\,org-agenda-filter-by-tag-refine}
7833 Narrow the current agenda filter by an additional condition. When called with
7834 prefix arg, remove the entries that @emph{do} have the tag, or that do match
7835 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
7836 @kbd{-} as the first key after the @kbd{/} command.
7845 @item @r{in} search view
7846 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
7847 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
7848 add a positive search term prefixed by @samp{+}, indicating that this search
7849 term @i{must} occur/match in the entry. The closing bracket/brace will add a
7850 negative search term which @i{must not} occur/match in the entry for it to be
7854 @tsubheading{Remote editing}
7855 @cindex remote editing, from agenda
7860 @cindex undoing remote-editing events
7861 @cindex remote editing, undo
7862 @orgcmd{C-_,org-agenda-undo}
7863 Undo a change due to a remote editing command. The change is undone
7864 both in the agenda buffer and in the remote buffer.
7866 @orgcmd{t,org-agenda-todo}
7867 Change the TODO state of the item, both in the agenda and in the
7870 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
7871 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
7872 Switch to the next/previous set of TODO keywords.
7874 @orgcmd{C-k,org-agenda-kill}
7875 @vindex org-agenda-confirm-kill
7876 Delete the current agenda item along with the entire subtree belonging
7877 to it in the original Org file. If the text to be deleted remotely
7878 is longer than one line, the kill needs to be confirmed by the user. See
7879 variable @code{org-agenda-confirm-kill}.
7881 @orgcmd{C-c C-w,org-agenda-refile}
7882 Refile the entry at point.
7884 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
7885 @vindex org-archive-default-command
7886 Archive the subtree corresponding to the entry at point using the default
7887 archiving command set in @code{org-archive-default-command}. When using the
7888 @code{a} key, confirmation will be required.
7890 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
7891 Toggle the ARCHIVE tag for the current headline.
7893 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
7894 Move the subtree corresponding to the current entry to its @emph{archive
7897 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
7898 Archive the subtree corresponding to the current headline. This means the
7899 entry will be moved to the configured archive location, most likely a
7902 @orgcmd{T,org-agenda-show-tags}
7903 @vindex org-agenda-show-inherited-tags
7904 Show all tags associated with the current item. This is useful if you have
7905 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
7906 tags of a headline occasionally.
7908 @orgcmd{:,org-agenda-set-tags}
7909 Set tags for the current headline. If there is an active region in the
7910 agenda, change a tag for all headings in the region.
7914 Set the priority for the current item (@command{org-agenda-priority}).
7915 Org-mode prompts for the priority character. If you reply with @key{SPC}, the
7916 priority cookie is removed from the entry.
7918 @orgcmd{P,org-agenda-show-priority}
7919 Display weighted priority of current item.
7921 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
7922 Increase the priority of the current item. The priority is changed in
7923 the original buffer, but the agenda is not resorted. Use the @kbd{r}
7926 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
7927 Decrease the priority of the current item.
7929 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
7930 @vindex org-log-into-drawer
7931 Add a note to the entry. This note will be recorded, and then filed to the
7932 same location where state change notes are put. Depending on
7933 @code{org-log-into-drawer}, this may be inside a drawer.
7935 @orgcmd{C-c C-a,org-attach}
7936 Dispatcher for all command related to attachments.
7938 @orgcmd{C-c C-s,org-agenda-schedule}
7939 Schedule this item. With prefix arg remove the scheduling timestamp
7941 @orgcmd{C-c C-d,org-agenda-deadline}
7942 Set a deadline for this item. With prefix arg remove the deadline.
7944 @orgcmd{k,org-agenda-action}
7945 Agenda actions, to set dates for selected items to the cursor date.
7946 This command also works in the calendar! The command prompts for an
7949 m @r{Mark the entry at point for action. You can also make entries}
7950 @r{in Org files with @kbd{C-c C-x C-k}.}
7951 d @r{Set the deadline of the marked entry to the date at point.}
7952 s @r{Schedule the marked entry at the date at point.}
7953 r @r{Call @code{org-capture} with the cursor date as default date.}
7956 Press @kbd{r} afterward to refresh the agenda and see the effect of the
7959 @orgcmd{S-@key{right},org-agenda-do-date-later}
7960 Change the timestamp associated with the current line by one day into the
7961 future. With a numeric prefix argument, change it by that many days. For
7962 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
7963 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
7964 command, it will continue to change hours even without the prefix arg. With
7965 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
7966 is changed in the original Org file, but the change is not directly reflected
7967 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
7969 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
7970 Change the timestamp associated with the current line by one day
7973 @orgcmd{>,org-agenda-date-prompt}
7974 Change the timestamp associated with the current line. The key @kbd{>} has
7975 been chosen, because it is the same as @kbd{S-.} on my keyboard.
7977 @orgcmd{I,org-agenda-clock-in}
7978 Start the clock on the current item. If a clock is running already, it
7981 @orgcmd{O,org-agenda-clock-out}
7982 Stop the previously started clock.
7984 @orgcmd{X,org-agenda-clock-cancel}
7985 Cancel the currently running clock.
7987 @orgcmd{J,org-agenda-clock-goto}
7988 Jump to the running clock in another window.
7990 @tsubheading{Bulk remote editing selected entries}
7991 @cindex remote editing, bulk, from agenda
7993 @orgcmd{m,org-agenda-bulk-mark}
7994 Mark the entry at point for bulk action. With prefix arg, mark that many
7997 @orgcmd{u,org-agenda-bulk-unmark}
7998 Unmark entry for bulk action.
8000 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8001 Unmark all marked entries for bulk action.
8003 @orgcmd{B,org-agenda-bulk-action}
8004 Bulk action: act on all marked entries in the agenda. This will prompt for
8005 another key to select the action to be applied. The prefix arg to @kbd{B}
8006 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8007 these special timestamps.
8009 r @r{Prompt for a single refile target and move all entries. The entries}
8010 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8011 $ @r{Archive all selected entries.}
8012 A @r{Archive entries by moving them to their respective archive siblings.}
8013 t @r{Change TODO state. This prompts for a single TODO keyword and}
8014 @r{changes the state of all selected entries, bypassing blocking and}
8015 @r{suppressing logging notes (but not time stamps).}
8016 + @r{Add a tag to all selected entries.}
8017 - @r{Remove a tag from all selected entries.}
8018 s @r{Schedule all items to a new date. To shift existing schedule dates}
8019 @r{by a fixed number of days, use something starting with double plus}
8020 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8021 S @r{Reschedule randomly by N days. N will be prompted for. With prefix}
8022 @r{arg (@kbd{C-u B S}), scatter only accross weekdays.}
8023 d @r{Set deadline to a specific date.}
8027 @tsubheading{Calendar commands}
8028 @cindex calendar commands, from agenda
8030 @orgcmd{c,org-agenda-goto-calendar}
8031 Open the Emacs calendar and move to the date at the agenda cursor.
8033 @orgcmd{c,org-calendar-goto-agenda}
8034 When in the calendar, compute and show the Org-mode agenda for the
8037 @cindex diary entries, creating from agenda
8038 @orgcmd{i,org-agenda-diary-entry}
8039 @vindex org-agenda-diary-file
8040 Insert a new entry into the diary, using the date at the cursor and (for
8041 block entries) the date at the mark. This will add to the Emacs diary
8042 file@footnote{This file is parsed for the agenda when
8043 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8044 command in the calendar. The diary file will pop up in another window, where
8045 you can add the entry.
8047 If you configure @code{org-agenda-diary-file} to point to an Org-mode file,
8048 Org will create entries (in org-mode syntax) in that file instead. Most
8049 entries will be stored in a date-based outline tree that will later make it
8050 easy to archive appointments from previous months/years. The tree will be
8051 built under an entry with a @code{DATE_TREE} property, or else with years as
8052 top-level entries. Emacs will prompt you for the entry text---if you specify
8053 it, the entry will be created in @code{org-agenda-diary-file} without further
8054 interaction. If you directly press @key{RET} at the prompt without typing
8055 text, the target file will be shown in another window for you to finish the
8056 entry there. See also the @kbd{k r} command.
8058 @orgcmd{M,org-agenda-phases-of-moon}
8059 Show the phases of the moon for the three months around current date.
8061 @orgcmd{S,org-agenda-sunrise-sunset}
8062 Show sunrise and sunset times. The geographical location must be set
8063 with calendar variables, see the documentation for the Emacs calendar.
8065 @orgcmd{C,org-agenda-convert-date}
8066 Convert the date at cursor into many other cultural and historic
8069 @orgcmd{H,org-agenda-holidays}
8070 Show holidays for three months around the cursor date.
8072 @item M-x org-export-icalendar-combine-agenda-files
8073 Export a single iCalendar file containing entries from all agenda files.
8074 This is a globally available command, and also available in the agenda menu.
8076 @tsubheading{Exporting to a file}
8077 @orgcmd{C-x C-w,org-write-agenda}
8078 @cindex exporting agenda views
8079 @cindex agenda views, exporting
8080 @vindex org-agenda-exporter-settings
8081 Write the agenda view to a file. Depending on the extension of the selected
8082 file name, the view will be exported as HTML (extension @file{.html} or
8083 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8084 and plain text (any other extension). When called with a @kbd{C-u} prefix
8085 argument, immediately open the newly created file. Use the variable
8086 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8087 for @file{htmlize} to be used during export.
8089 @tsubheading{Quit and Exit}
8090 @orgcmd{q,org-agenda-quit}
8091 Quit agenda, remove the agenda buffer.
8093 @cindex agenda files, removing buffers
8094 @orgcmd{x,org-agenda-exit}
8095 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8096 for the compilation of the agenda. Buffers created by the user to
8097 visit Org files will not be removed.
8101 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8102 @section Custom agenda views
8103 @cindex custom agenda views
8104 @cindex agenda views, custom
8106 Custom agenda commands serve two purposes: to store and quickly access
8107 frequently used TODO and tags searches, and to create special composite
8108 agenda buffers. Custom agenda commands will be accessible through the
8109 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8112 * Storing searches:: Type once, use often
8113 * Block agenda:: All the stuff you need in a single buffer
8114 * Setting Options:: Changing the rules
8117 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8118 @subsection Storing searches
8120 The first application of custom searches is the definition of keyboard
8121 shortcuts for frequently used searches, either creating an agenda
8122 buffer, or a sparse tree (the latter covering of course only the current
8125 @vindex org-agenda-custom-commands
8126 Custom commands are configured in the variable
8127 @code{org-agenda-custom-commands}. You can customize this variable, for
8128 example by pressing @kbd{C-c a C}. You can also directly set it with
8129 Emacs Lisp in @file{.emacs}. The following example contains all valid
8134 (setq org-agenda-custom-commands
8135 '(("w" todo "WAITING")
8136 ("W" todo-tree "WAITING")
8137 ("u" tags "+boss-urgent")
8138 ("v" tags-todo "+boss-urgent")
8139 ("U" tags-tree "+boss-urgent")
8140 ("f" occur-tree "\\<FIXME\\>")
8141 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8142 ("hl" tags "+home+Lisa")
8143 ("hp" tags "+home+Peter")
8144 ("hk" tags "+home+Kim")))
8149 The initial string in each entry defines the keys you have to press
8150 after the dispatcher command @kbd{C-c a} in order to access the command.
8151 Usually this will be just a single character, but if you have many
8152 similar commands, you can also define two-letter combinations where the
8153 first character is the same in several combinations and serves as a
8154 prefix key@footnote{You can provide a description for a prefix key by
8155 inserting a cons cell with the prefix and the description.}. The second
8156 parameter is the search type, followed by the string or regular
8157 expression to be used for the matching. The example above will
8162 as a global search for TODO entries with @samp{WAITING} as the TODO
8165 as the same search, but only in the current buffer and displaying the
8166 results as a sparse tree
8168 as a global tags search for headlines marked @samp{:boss:} but not
8171 as the same search as @kbd{C-c a u}, but limiting the search to
8172 headlines that are also TODO items
8174 as the same search as @kbd{C-c a u}, but only in the current buffer and
8175 displaying the result as a sparse tree
8177 to create a sparse tree (again: current buffer only) with all entries
8178 containing the word @samp{FIXME}
8180 as a prefix command for a HOME tags search where you have to press an
8181 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8182 Peter, or Kim) as additional tag to match.
8185 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8186 @subsection Block agenda
8187 @cindex block agenda
8188 @cindex agenda, with block views
8190 Another possibility is the construction of agenda views that comprise
8191 the results of @emph{several} commands, each of which creates a block in
8192 the agenda buffer. The available commands include @code{agenda} for the
8193 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8194 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8195 matching commands discussed above: @code{todo}, @code{tags}, and
8196 @code{tags-todo}. Here are two examples:
8200 (setq org-agenda-custom-commands
8201 '(("h" "Agenda and Home-related tasks"
8205 ("o" "Agenda and Office-related tasks"
8213 This will define @kbd{C-c a h} to create a multi-block view for stuff
8214 you need to attend to at home. The resulting agenda buffer will contain
8215 your agenda for the current week, all TODO items that carry the tag
8216 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8217 command @kbd{C-c a o} provides a similar view for office tasks.
8219 @node Setting Options, , Block agenda, Custom agenda views
8220 @subsection Setting options for custom commands
8221 @cindex options, for custom agenda views
8223 @vindex org-agenda-custom-commands
8224 Org-mode contains a number of variables regulating agenda construction
8225 and display. The global variables define the behavior for all agenda
8226 commands, including the custom commands. However, if you want to change
8227 some settings just for a single custom view, you can do so. Setting
8228 options requires inserting a list of variable names and values at the
8229 right spot in @code{org-agenda-custom-commands}. For example:
8233 (setq org-agenda-custom-commands
8234 '(("w" todo "WAITING"
8235 ((org-agenda-sorting-strategy '(priority-down))
8236 (org-agenda-prefix-format " Mixed: ")))
8237 ("U" tags-tree "+boss-urgent"
8238 ((org-show-following-heading nil)
8239 (org-show-hierarchy-above nil)))
8241 ((org-agenda-files '("~org/notes.org"))
8242 (org-agenda-text-search-extra-files nil)))))
8247 Now the @kbd{C-c a w} command will sort the collected entries only by
8248 priority, and the prefix format is modified to just say @samp{ Mixed: }
8249 instead of giving the category of the entry. The sparse tags tree of
8250 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8251 headline hierarchy above the match, nor the headline following the match
8252 will be shown. The command @kbd{C-c a N} will do a text search limited
8253 to only a single file.
8255 @vindex org-agenda-custom-commands
8256 For command sets creating a block agenda,
8257 @code{org-agenda-custom-commands} has two separate spots for setting
8258 options. You can add options that should be valid for just a single
8259 command in the set, and options that should be valid for all commands in
8260 the set. The former are just added to the command entry; the latter
8261 must come after the list of command entries. Going back to the block
8262 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8263 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8264 the results for GARDEN tags query in the opposite order,
8265 @code{priority-up}. This would look like this:
8269 (setq org-agenda-custom-commands
8270 '(("h" "Agenda and Home-related tasks"
8274 ((org-agenda-sorting-strategy '(priority-up)))))
8275 ((org-agenda-sorting-strategy '(priority-down))))
8276 ("o" "Agenda and Office-related tasks"
8283 As you see, the values and parentheses setting is a little complex.
8284 When in doubt, use the customize interface to set this variable---it
8285 fully supports its structure. Just one caveat: when setting options in
8286 this interface, the @emph{values} are just Lisp expressions. So if the
8287 value is a string, you need to add the double-quotes around the value
8291 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8292 @section Exporting Agenda Views
8293 @cindex agenda views, exporting
8295 If you are away from your computer, it can be very useful to have a printed
8296 version of some agenda views to carry around. Org-mode can export custom
8297 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8298 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8299 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8300 a PDF file with also create the postscript file.}, and iCalendar files. If
8301 you want to do this only occasionally, use the command
8304 @orgcmd{C-x C-w,org-write-agenda}
8305 @cindex exporting agenda views
8306 @cindex agenda views, exporting
8307 @vindex org-agenda-exporter-settings
8308 Write the agenda view to a file. Depending on the extension of the selected
8309 file name, the view will be exported as HTML (extension @file{.html} or
8310 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8311 @file{.ics}), or plain text (any other extension). Use the variable
8312 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8313 for @file{htmlize} to be used during export, for example
8315 @vindex org-agenda-add-entry-text-maxlines
8316 @vindex htmlize-output-type
8317 @vindex ps-number-of-columns
8318 @vindex ps-landscape-mode
8320 (setq org-agenda-exporter-settings
8321 '((ps-number-of-columns 2)
8322 (ps-landscape-mode t)
8323 (org-agenda-add-entry-text-maxlines 5)
8324 (htmlize-output-type 'css)))
8328 If you need to export certain agenda views frequently, you can associate
8329 any custom agenda command with a list of output file names
8330 @footnote{If you want to store standard views like the weekly agenda
8331 or the global TODO list as well, you need to define custom commands for
8332 them in order to be able to specify file names.}. Here is an example
8333 that first defines custom commands for the agenda and the global
8334 TODO list, together with a number of files to which to export them.
8335 Then we define two block agenda commands and specify file names for them
8336 as well. File names can be relative to the current working directory,
8341 (setq org-agenda-custom-commands
8342 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8343 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8344 ("h" "Agenda and Home-related tasks"
8349 ("~/views/home.html"))
8350 ("o" "Agenda and Office-related tasks"
8355 ("~/views/office.ps" "~/calendars/office.ics"))))
8359 The extension of the file name determines the type of export. If it is
8360 @file{.html}, Org-mode will use the @file{htmlize.el} package to convert
8361 the buffer to HTML and save it to this file name. If the extension is
8362 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8363 Postscript output. If the extension is @file{.ics}, iCalendar export is
8364 run export over all files that were used to construct the agenda, and
8365 limit the export to entries listed in the agenda. Any other
8366 extension produces a plain ASCII file.
8368 The export files are @emph{not} created when you use one of those
8369 commands interactively because this might use too much overhead.
8370 Instead, there is a special command to produce @emph{all} specified
8374 @orgcmd{C-c a e,org-store-agenda-views}
8375 Export all agenda views that have export file names associated with
8379 You can use the options section of the custom agenda commands to also
8380 set options for the export commands. For example:
8383 (setq org-agenda-custom-commands
8385 ((ps-number-of-columns 2)
8386 (ps-landscape-mode t)
8387 (org-agenda-prefix-format " [ ] ")
8388 (org-agenda-with-colors nil)
8389 (org-agenda-remove-tags t))
8394 This command sets two options for the Postscript exporter, to make it
8395 print in two columns in landscape format---the resulting page can be cut
8396 in two and then used in a paper agenda. The remaining settings modify
8397 the agenda prefix to omit category and scheduling information, and
8398 instead include a checkbox to check off items. We also remove the tags
8399 to make the lines compact, and we don't want to use colors for the
8400 black-and-white printer. Settings specified in
8401 @code{org-agenda-exporter-settings} will also apply, but the settings
8402 in @code{org-agenda-custom-commands} take precedence.
8405 From the command line you may also use
8407 emacs -f org-batch-store-agenda-views -kill
8410 or, if you need to modify some parameters@footnote{Quoting depends on the
8411 system you use, please check the FAQ for examples.}
8413 emacs -eval '(org-batch-store-agenda-views \
8414 org-agenda-span month \
8415 org-agenda-start-day "2007-11-01" \
8416 org-agenda-include-diary nil \
8417 org-agenda-files (quote ("~/org/project.org")))' \
8421 which will create the agenda views restricted to the file
8422 @file{~/org/project.org}, without diary entries and with a 30-day
8425 You can also extract agenda information in a way that allows further
8426 processing by other programs. See @ref{Extracting agenda information}, for
8430 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8431 @section Using column view in the agenda
8432 @cindex column view, in agenda
8433 @cindex agenda, column view
8435 Column view (@pxref{Column view}) is normally used to view and edit
8436 properties embedded in the hierarchical structure of an Org file. It can be
8437 quite useful to use column view also from the agenda, where entries are
8438 collected by certain criteria.
8441 @orgcmd{C-c C-x C-c,org-agenda-columns}
8442 Turn on column view in the agenda.
8445 To understand how to use this properly, it is important to realize that the
8446 entries in the agenda are no longer in their proper outline environment.
8447 This causes the following issues:
8451 @vindex org-columns-default-format
8452 @vindex org-overriding-columns-format
8453 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8454 entries in the agenda are collected from different files, and different files
8455 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8456 Org first checks if the variable @code{org-overriding-columns-format} is
8457 currently set, and if so, takes the format from there. Otherwise it takes
8458 the format associated with the first item in the agenda, or, if that item
8459 does not have a specific format (defined in a property, or in its file), it
8460 uses @code{org-columns-default-format}.
8462 @cindex property, special, CLOCKSUM
8463 If any of the columns has a summary type defined (@pxref{Column attributes}),
8464 turning on column view in the agenda will visit all relevant agenda files and
8465 make sure that the computations of this property are up to date. This is
8466 also true for the special @code{CLOCKSUM} property. Org will then sum the
8467 values displayed in the agenda. In the daily/weekly agenda, the sums will
8468 cover a single day; in all other views they cover the entire block. It is
8469 vital to realize that the agenda may show the same entry @emph{twice} (for
8470 example as scheduled and as a deadline), and it may show two entries from the
8471 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8472 cases, the summation in the agenda will lead to incorrect results because
8473 some values will count double.
8475 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8476 the entire clocked time for this item. So even in the daily/weekly agenda,
8477 the clocksum listed in column view may originate from times outside the
8478 current view. This has the advantage that you can compare these values with
8479 a column listing the planned total effort for a task---one of the major
8480 applications for column view in the agenda. If you want information about
8481 clocked time in the displayed period use clock table mode (press @kbd{R} in
8486 @node Markup, Exporting, Agenda Views, Top
8487 @chapter Markup for rich export
8489 When exporting Org-mode documents, the exporter tries to reflect the
8490 structure of the document as accurately as possible in the backend. Since
8491 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
8492 Org-mode has rules on how to prepare text for rich export. This section
8493 summarizes the markup rules used in an Org-mode buffer.
8496 * Structural markup elements:: The basic structure as seen by the exporter
8497 * Images and tables:: Tables and Images will be included
8498 * Literal examples:: Source code examples with special formatting
8499 * Include files:: Include additional files into a document
8500 * Index entries:: Making an index
8501 * Macro replacement:: Use macros to create complex output
8502 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
8505 @node Structural markup elements, Images and tables, Markup, Markup
8506 @section Structural markup elements
8509 * Document title:: Where the title is taken from
8510 * Headings and sections:: The document structure as seen by the exporter
8511 * Table of contents:: The if and where of the table of contents
8512 * Initial text:: Text before the first heading?
8514 * Paragraphs:: Paragraphs
8515 * Footnote markup:: Footnotes
8516 * Emphasis and monospace:: Bold, italic, etc.
8517 * Horizontal rules:: Make a line
8518 * Comment lines:: What will *not* be exported
8521 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8522 @subheading Document title
8523 @cindex document title, markup rules
8526 The title of the exported document is taken from the special line
8530 #+TITLE: This is the title of the document
8534 If this line does not exist, the title is derived from the first non-empty,
8535 non-comment line in the buffer. If no such line exists, or if you have
8536 turned off exporting of the text before the first headline (see below), the
8537 title will be the file name without extension.
8539 @cindex property, EXPORT_TITLE
8540 If you are exporting only a subtree by marking is as the region, the heading
8541 of the subtree will become the title of the document. If the subtree has a
8542 property @code{EXPORT_TITLE}, that will take precedence.
8544 @node Headings and sections, Table of contents, Document title, Structural markup elements
8545 @subheading Headings and sections
8546 @cindex headings and sections, markup rules
8548 @vindex org-export-headline-levels
8549 The outline structure of the document as described in @ref{Document
8550 Structure}, forms the basis for defining sections of the exported document.
8551 However, since the outline structure is also used for (for example) lists of
8552 tasks, only the first three outline levels will be used as headings. Deeper
8553 levels will become itemized lists. You can change the location of this
8554 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8555 per-file basis with a line
8562 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8563 @subheading Table of contents
8564 @cindex table of contents, markup rules
8566 @vindex org-export-with-toc
8567 The table of contents is normally inserted directly before the first headline
8568 of the file. If you would like to get it to a different location, insert the
8569 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8570 location. The depth of the table of contents is by default the same as the
8571 number of headline levels, but you can choose a smaller number, or turn off
8572 the table of contents entirely, by configuring the variable
8573 @code{org-export-with-toc}, or on a per-file basis with a line like
8576 #+OPTIONS: toc:2 (only to two levels in TOC)
8577 #+OPTIONS: toc:nil (no TOC at all)
8580 @node Initial text, Lists, Table of contents, Structural markup elements
8581 @subheading Text before the first headline
8582 @cindex text before first headline, markup rules
8585 Org-mode normally exports the text before the first headline, and even uses
8586 the first line as the document title. The text will be fully marked up. If
8587 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
8588 constructs described below in the sections for the individual exporters.
8590 @vindex org-export-skip-text-before-1st-heading
8591 Some people like to use the space before the first headline for setup and
8592 internal links and therefore would like to control the exported text before
8593 the first headline in a different way. You can do so by setting the variable
8594 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8595 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8598 If you still want to have some text before the first headline, use the
8599 @code{#+TEXT} construct:
8603 #+TEXT: This text will go before the *first* headline.
8604 #+TEXT: [TABLE-OF-CONTENTS]
8605 #+TEXT: This goes between the table of contents and the first headline
8608 @node Lists, Paragraphs, Initial text, Structural markup elements
8610 @cindex lists, markup rules
8612 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8613 syntax for such lists. Most backends support unordered, ordered, and
8616 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8617 @subheading Paragraphs, line breaks, and quoting
8618 @cindex paragraphs, markup rules
8620 Paragraphs are separated by at least one empty line. If you need to enforce
8621 a line break within a paragraph, use @samp{\\} at the end of a line.
8623 To keep the line breaks in a region, but otherwise use normal formatting, you
8624 can use this construct, which can also be used to format poetry.
8626 @cindex #+BEGIN_VERSE
8629 Great clouds overhead
8630 Tiny black birds rise and fall
8637 When quoting a passage from another document, it is customary to format this
8638 as a paragraph that is indented on both the left and the right margin. You
8639 can include quotations in Org-mode documents like this:
8641 @cindex #+BEGIN_QUOTE
8644 Everything should be made as simple as possible,
8645 but not any simpler -- Albert Einstein
8649 If you would like to center some text, do it like this:
8650 @cindex #+BEGIN_CENTER
8653 Everything should be made as simple as possible, \\
8659 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8660 @subheading Footnote markup
8661 @cindex footnotes, markup rules
8662 @cindex @file{footnote.el}
8664 Footnotes defined in the way described in @ref{Footnotes}, will be exported by
8665 all backends. Org allows multiple references to the same note, and
8666 different backends support this to varying degrees.
8668 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8669 @subheading Emphasis and monospace
8671 @cindex underlined text, markup rules
8672 @cindex bold text, markup rules
8673 @cindex italic text, markup rules
8674 @cindex verbatim text, markup rules
8675 @cindex code text, markup rules
8676 @cindex strike-through text, markup rules
8677 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8678 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8679 in the code and verbatim string is not processed for Org-mode specific
8680 syntax; it is exported verbatim.
8682 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8683 @subheading Horizontal rules
8684 @cindex horizontal rules, markup rules
8685 A line consisting of only dashes, and at least 5 of them, will be
8686 exported as a horizontal line (@samp{<hr/>} in HTML).
8688 @node Comment lines, , Horizontal rules, Structural markup elements
8689 @subheading Comment lines
8690 @cindex comment lines
8691 @cindex exporting, not
8692 @cindex #+BEGIN_COMMENT
8694 Lines starting with @samp{#} in column zero are treated as comments and will
8695 never be exported. If you want an indented line to be treated as a comment,
8696 start it with @samp{#+ }. Also entire subtrees starting with the word
8697 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8698 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8703 Toggle the COMMENT keyword at the beginning of an entry.
8707 @node Images and tables, Literal examples, Structural markup elements, Markup
8708 @section Images and Tables
8710 @cindex tables, markup rules
8713 Both the native Org-mode tables (@pxref{Tables}) and tables formatted with
8714 the @file{table.el} package will be exported properly. For Org-mode tables,
8715 the lines before the first horizontal separator line will become table header
8716 lines. You can use the following lines somewhere before the table to assign
8717 a caption and a label for cross references, and in the text you can refer to
8718 the object with @code{\ref@{tab:basic-data@}}:
8721 #+CAPTION: This is the caption for the next table (or link)
8722 #+LABEL: tbl:basic-data
8727 @cindex inlined images, markup rules
8728 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
8729 images into the exported document. Org does this, if a link to an image
8730 files does not have a description part, for example @code{[[./img/a.jpg]]}.
8731 If you wish to define a caption for the image and maybe a label for internal
8732 cross references, make sure that the link is on a line by itself and precede
8733 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
8736 #+CAPTION: This is the caption for the next figure link (or table)
8737 #+LABEL: fig:SED-HR4049
8741 You may also define additional attributes for the figure. As this is
8742 backend-specific, see the sections about the individual backends for more
8745 @xref{Handling links,the discussion of image links}.
8747 @node Literal examples, Include files, Images and tables, Markup
8748 @section Literal examples
8749 @cindex literal examples, markup rules
8750 @cindex code line references, markup rules
8752 You can include literal examples that should not be subjected to
8753 markup. Such examples will be typeset in monospace, so this is well suited
8754 for source code and similar examples.
8755 @cindex #+BEGIN_EXAMPLE
8759 Some example from a text file.
8763 Note that such blocks may be @i{indented} in order to align nicely with
8764 indented text and in particular with plain list structure (@pxref{Plain
8765 lists}). For simplicity when using small examples, you can also start the
8766 example lines with a colon followed by a space. There may also be additional
8767 whitespace before the colon:
8771 : Some example from a text file.
8774 @cindex formatting source code, markup rules
8775 If the example is source code from a programming language, or any other text
8776 that can be marked up by font-lock in Emacs, you can ask for the example to
8777 look like the fontified Emacs buffer@footnote{This works automatically for
8778 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
8779 which is distributed with Org). Fontified code chunks in LaTeX can be
8780 achieved using either the listings or the
8781 @url{http://code.google.com/p/minted, minted,} package. To use listings, turn
8782 on the variable @code{org-export-latex-listings} and ensure that the listings
8783 package is included by the LaTeX header (e.g. by configuring
8784 @code{org-export-latex-packages-alist}). See the listings documentation for
8785 configuration options, including obtaining colored output. For minted it is
8786 necessary to install the program @url{http://pygments.org, pygments}, in
8787 addition to setting @code{org-export-latex-minted}, ensuring that the minted
8788 package is included by the LaTeX header, and ensuring that the
8789 @code{-shell-escape} option is passed to @file{pdflatex} (see
8790 @code{org-latex-to-pdf-process}). See the documentation of the variables
8791 @code{org-export-latex-listings} and @code{org-export-latex-minted} for
8792 further details.}. This is done with the @samp{src} block, where you also
8793 need to specify the name of the major mode that should be used to fontify the
8798 #+BEGIN_SRC emacs-lisp
8799 (defun org-xor (a b)
8805 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
8806 switch to the end of the @code{BEGIN} line, to get the lines of the example
8807 numbered. If you use a @code{+n} switch, the numbering from the previous
8808 numbered snippet will be continued in the current one. In literal examples,
8809 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
8810 targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference name
8811 enclosed in single parenthesis). In HTML, hovering the mouse over such a
8812 link will remote-highlight the corresponding code line, which is kind of
8815 You can also add a @code{-r} switch which @i{removes} the labels from the
8816 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
8817 labels in the source code while using line numbers for the links, which might
8818 be useful to explain those in an org-mode example code.}. With the @code{-n}
8819 switch, links to these references will be labeled by the line numbers from
8820 the code listing, otherwise links will use the labels with no parentheses.
8824 #+BEGIN_SRC emacs-lisp -n -r
8825 (save-excursion (ref:sc)
8826 (goto-char (point-min)) (ref:jump)
8828 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
8832 @vindex org-coderef-label-format
8833 If the syntax for the label format conflicts with the language syntax, use a
8834 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
8835 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8837 HTML export also allows examples to be published as text areas, @xref{Text
8838 areas in HTML export}.
8843 Edit the source code example at point in its native mode. This works by
8844 switching to a temporary buffer with the source code. You need to exit by
8845 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
8846 or @samp{#} will get a comma prepended, to keep them from being interpreted
8847 by Org as outline nodes or special comments. These commas will be stripped
8848 for editing with @kbd{C-c '}, and also for export.}. The edited version will
8849 then replace the old version in the Org buffer. Fixed-width regions
8850 (where each line starts with a colon followed by a space) will be edited
8851 using @code{artist-mode}@footnote{You may select a different-mode with the
8852 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
8853 drawings easily. Using this command in an empty line will create a new
8857 Calling @code{org-store-link} while editing a source code example in a
8858 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
8859 that it is unique in the current buffer, and insert it with the proper
8860 formatting like @samp{(ref:label)} at the end of the current line. Then the
8861 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8865 @node Include files, Index entries, Literal examples, Markup
8866 @section Include files
8867 @cindex include files, markup rules
8869 During export, you can include the content of another file. For example, to
8870 include your @file{.emacs} file, you could use:
8874 #+INCLUDE: "~/.emacs" src emacs-lisp
8877 The optional second and third parameter are the markup (e.g. @samp{quote},
8878 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8879 language for formatting the contents. The markup is optional; if it is not
8880 given, the text will be assumed to be in Org-mode format and will be
8881 processed normally. The include line will also allow additional keyword
8882 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8883 first line and for each following line, @code{:minlevel} in order to get
8884 org-mode content demoted to a specified level, as well as any options
8885 accepted by the selected markup. For example, to include a file as an item,
8889 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8895 Visit the include file at point.
8898 @node Index entries, Macro replacement, Include files, Markup
8899 @section Index entries
8900 @cindex index entries, for publishing
8902 You can specify entries that will be used for generating an index during
8903 publishing. This is done by lines starting with @code{#+INDEX}. An entry
8904 the contains an exclamation mark will create a sub item. See @ref{Generating
8905 an index} for more information.
8910 #+INDEX: Application!CV
8916 @node Macro replacement, Embedded LaTeX, Index entries, Markup
8917 @section Macro replacement
8918 @cindex macro replacement, during export
8921 You can define text snippets with
8924 #+MACRO: name replacement text $1, $2 are arguments
8927 @noindent which can be referenced anywhere in the document (even in
8928 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
8929 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
8930 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
8931 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
8932 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
8933 and to the modification time of the file being exported, respectively.
8934 @var{FORMAT} should be a format string understood by
8935 @code{format-time-string}.
8937 Macro expansion takes place during export, and some people use it to
8938 construct complex HTML code.
8941 @node Embedded LaTeX, , Macro replacement, Markup
8942 @section Embedded @LaTeX{}
8943 @cindex @TeX{} interpretation
8944 @cindex @LaTeX{} interpretation
8946 Plain ASCII is normally sufficient for almost all note taking. Exceptions
8947 include scientific notes, which often require mathematical symbols and the
8948 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
8949 Donald E. Knuth's @TeX{} system. Many of the features described here as
8950 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
8951 distinction.} is widely used to typeset scientific documents. Org-mode
8952 supports embedding @LaTeX{} code into its files, because many academics are
8953 used to writing and reading @LaTeX{} source code, and because it can be
8954 readily processed to produce pretty output for a number of export backends.
8957 * Special symbols:: Greek letters and other symbols
8958 * Subscripts and superscripts:: Simple syntax for raising/lowering text
8959 * LaTeX fragments:: Complex formulas made easy
8960 * Previewing LaTeX fragments:: What will this snippet look like?
8961 * CDLaTeX mode:: Speed up entering of formulas
8964 @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
8965 @subsection Special symbols
8966 @cindex math symbols
8967 @cindex special symbols
8968 @cindex @TeX{} macros
8969 @cindex @LaTeX{} fragments, markup rules
8970 @cindex HTML entities
8971 @cindex @LaTeX{} entities
8973 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
8974 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
8975 for these macros is available, just type @samp{\} and maybe a few letters,
8976 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
8977 code, Org-mode allows these macros to be present without surrounding math
8978 delimiters, for example:
8981 Angles are written as Greek letters \alpha, \beta and \gamma.
8984 @vindex org-entities
8985 During export, these symbols will be transformed into the native format of
8986 the exporter backend. Strings like @code{\alpha} will be exported as
8987 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
8988 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
8989 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
8990 like this: @samp{\Aacute@{@}stor}.
8992 A large number of entities is provided, with names taken from both HTML and
8993 @LaTeX{}; see the variable @code{org-entities} for the complete list.
8994 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
8995 @samp{...} are all converted into special commands creating hyphens of
8996 different lengths or a compact set of dots.
8998 If you would like to see entities displayed as UTF8 characters, use the
8999 following command@footnote{You can turn this on by default by setting the
9000 variable @code{org-pretty-entities}, or on a per-file base with the
9001 @code{#+STARTUP} option @code{entitiespretty}.}:
9006 Toggle display of entities as UTF-8 characters. This does not change the
9007 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9008 for display purposes only.
9011 @node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
9012 @subsection Subscripts and superscripts
9016 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9017 and subscripts. Again, these can be used without embedding them in
9018 math-mode delimiters. To increase the readability of ASCII text, it is
9019 not necessary (but OK) to surround multi-character sub- and superscripts
9020 with curly braces. For example
9023 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9024 the sun is R_@{sun@} = 6.96 x 10^8 m.
9027 @vindex org-export-with-sub-superscripts
9028 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9029 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9030 where the underscore is often used in a different context, Org's convention
9031 to always interpret these as subscripts can get in your way. Configure the
9032 variable @code{org-export-with-sub-superscripts} to globally change this
9033 convention, or use, on a per-file basis:
9039 @noindent With this setting, @samp{a_b} will not be interpreted as a
9040 subscript, but @samp{a_@{b@}} will.
9045 In addition to showing entities as UTF-8 characters, this command will also
9046 format sub- and superscripts in a WYSIWYM way.
9049 @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
9050 @subsection @LaTeX{} fragments
9051 @cindex @LaTeX{} fragments
9053 @vindex org-format-latex-header
9054 Going beyond symbols and sub- and superscripts, a full formula language is
9055 needed. Org-mode can contain @LaTeX{} math fragments, and it supports ways
9056 to process these for several export backends. When exporting to @LaTeX{},
9057 the code is obviously left as it is. When exporting to HTML, Org invokes the
9058 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9059 HTML export}) to process and display the math@footnote{If you plan to use
9060 this regularly or on pages with significant page views, you should install
9061 @file{MathJax} on your own
9062 server in order to limit the load of our server.}. Finally, it can also
9063 process the mathematical expressions into images@footnote{For this to work
9064 you need to be on a system with a working @LaTeX{} installation. You also
9065 need the @file{dvipng} program, available at
9066 @url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will
9067 be used when processing a fragment can be configured with the variable
9068 @code{org-format-latex-header}.} that can be displayed in a browser or in
9071 @LaTeX{} fragments don't need any special marking at all. The following
9072 snippets will be identified as @LaTeX{} source code:
9075 Environments of any kind@footnote{When @file{MathJax} is used, only the
9076 environment recognized by @file{MathJax} will be processed. When
9077 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9078 handled.}. The only requirement is that the @code{\begin} statement appears
9079 on a new line, preceded by only whitespace.
9081 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9082 currency specifications, single @samp{$} characters are only recognized as
9083 math delimiters if the enclosed text contains at most two line breaks, is
9084 directly attached to the @samp{$} characters with no whitespace in between,
9085 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9086 For the other delimiters, there is no such restriction, so when in doubt, use
9087 @samp{\(...\)} as inline math delimiters.
9090 @noindent For example:
9093 \begin@{equation@} % arbitrary environments,
9094 x=\sqrt@{b@} % even tables, figures
9095 \end@{equation@} % etc
9097 If $a^2=b$ and \( b=2 \), then the solution must be
9098 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9102 @vindex org-format-latex-options
9103 If you need any of the delimiter ASCII sequences for other purposes, you
9104 can configure the option @code{org-format-latex-options} to deselect the
9105 ones you do not wish to have interpreted by the @LaTeX{} converter.
9107 @vindex org-export-with-LaTeX-fragments
9108 LaTeX processing can be configured with the variable
9109 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9110 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9111 LaTeX backends. You can also set this variable on a per-file basis using one
9115 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9116 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9117 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9118 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9121 @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
9122 @subsection Previewing LaTeX fragments
9123 @cindex LaTeX fragments, preview
9125 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9126 produce preview images of the typeset expressions:
9131 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9132 over the source code. If there is no fragment at point, process all
9133 fragments in the current entry (between two headlines). When called
9134 with a prefix argument, process the entire subtree. When called with
9135 two prefix arguments, or when the cursor is before the first headline,
9136 process the entire buffer.
9139 Remove the overlay preview images.
9142 @vindex org-format-latex-options
9143 You can customize the variable @code{org-format-latex-options} to influence
9144 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9145 export, @code{:html-scale}) property can be used to adjust the size of the
9148 @node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX
9149 @subsection Using CDLa@TeX{} to enter math
9152 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
9153 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9154 environments and math templates. Inside Org-mode, you can make use of
9155 some of the features of CDLa@TeX{} mode. You need to install
9156 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9157 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9158 Don't use CDLa@TeX{} mode itself under Org-mode, but use the light
9159 version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it
9160 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9164 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9167 When this mode is enabled, the following features are present (for more
9168 details see the documentation of CDLa@TeX{} mode):
9172 Environment templates can be inserted with @kbd{C-c @{}.
9175 The @key{TAB} key will do template expansion if the cursor is inside a
9176 @LaTeX{} fragment@footnote{Org-mode has a method to test if the cursor is
9177 inside such a fragment, see the documentation of the function
9178 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9179 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9180 correctly inside the first brace. Another @key{TAB} will get you into
9181 the second brace. Even outside fragments, @key{TAB} will expand
9182 environment abbreviations at the beginning of a line. For example, if
9183 you write @samp{equ} at the beginning of a line and press @key{TAB},
9184 this abbreviation will be expanded to an @code{equation} environment.
9185 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9189 @vindex cdlatex-simplify-sub-super-scripts
9190 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9191 characters together with a pair of braces. If you use @key{TAB} to move
9192 out of the braces, and if the braces surround only a single character or
9193 macro, they are removed again (depending on the variable
9194 @code{cdlatex-simplify-sub-super-scripts}).
9197 Pressing the backquote @kbd{`} followed by a character inserts math
9198 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9199 after the backquote, a help window will pop up.
9202 Pressing the single-quote @kbd{'} followed by another character modifies
9203 the symbol before point with an accent or a font. If you wait more than
9204 1.5 seconds after the single-quote, a help window will pop up. Character
9205 modification will work only inside @LaTeX{} fragments; outside the quote
9209 @node Exporting, Publishing, Markup, Top
9213 Org-mode documents can be exported into a variety of other formats. For
9214 printing and sharing of notes, ASCII export produces a readable and simple
9215 version of an Org file. HTML export allows you to publish a notes file on
9216 the web, while the XOXO format provides a solid base for exchange with a
9217 broad range of other applications. @LaTeX{} export lets you use Org-mode and
9218 its structured editing functions to easily create @LaTeX{} files. DocBook
9219 export makes it possible to convert Org files to many other formats using
9220 DocBook tools. For project management you can create gantt and resource
9221 charts by using TaskJuggler export. To incorporate entries with associated
9222 times like deadlines or appointments into a desktop calendar program like
9223 iCal, Org-mode can also produce extracts in the iCalendar format. Currently
9224 Org-mode only supports export, not import of these different formats.
9226 Org supports export of selected regions when @code{transient-mark-mode} is
9227 enabled (default in Emacs 23).
9230 * Selective export:: Using tags to select and exclude trees
9231 * Export options:: Per-file export settings
9232 * The export dispatcher:: How to access exporter commands
9233 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9234 * HTML export:: Exporting to HTML
9235 * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9236 * DocBook export:: Exporting to DocBook
9237 * TaskJuggler export:: Exporting to TaskJuggler
9238 * Freemind export:: Exporting to Freemind mind maps
9239 * XOXO export:: Exporting to XOXO
9240 * iCalendar export:: Exporting in iCalendar format
9243 @node Selective export, Export options, Exporting, Exporting
9244 @section Selective export
9245 @cindex export, selective by tags
9247 @vindex org-export-select-tags
9248 @vindex org-export-exclude-tags
9249 You may use tags to select the parts of a document that should be exported,
9250 or to exclude parts from export. This behavior is governed by two variables:
9251 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
9253 Org first checks if any of the @emph{select} tags is present in the buffer.
9254 If yes, all trees that do not carry one of these tags will be excluded. If a
9255 selected tree is a subtree, the heading hierarchy above it will also be
9256 selected for export, but not the text below those headings.
9259 If none of the select tags is found, the whole buffer will be selected for
9263 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9264 be removed from the export buffer.
9266 @node Export options, The export dispatcher, Selective export, Exporting
9267 @section Export options
9268 @cindex options, for export
9270 @cindex completion, of option keywords
9271 The exporter recognizes special lines in the buffer which provide
9272 additional information. These lines may be put anywhere in the file.
9273 The whole set of lines can be inserted into the buffer with @kbd{C-c
9274 C-e t}. For individual lines, a good way to make sure the keyword is
9275 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9276 (@pxref{Completion}). For a summary of other in-buffer settings not
9277 specifically related to export, see @ref{In-buffer settings}.
9278 In particular, note that you can place commonly-used (export) options in
9279 a separate file which can be included using @code{#+SETUPFILE}.
9282 @orgcmd{C-c C-e t,org-insert-export-options-template}
9283 Insert template with export options, see example below.
9290 @cindex #+DESCRIPTION
9298 @cindex #+EXPORT_SELECT_TAGS
9299 @cindex #+EXPORT_EXCLUDE_TAGS
9301 @cindex #+LATEX_HEADER
9302 @vindex user-full-name
9303 @vindex user-mail-address
9304 @vindex org-export-default-language
9306 #+TITLE: the title to be shown (default is the buffer name)
9307 #+AUTHOR: the author (default taken from @code{user-full-name})
9308 #+DATE: a date, fixed, or a format string for @code{format-time-string}
9309 #+EMAIL: his/her email address (default from @code{user-mail-address})
9310 #+DESCRIPTION: the page description, e.g. for the XHTML meta tag
9311 #+KEYWORDS: the page keywords, e.g. for the XHTML meta tag
9312 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
9313 #+TEXT: Some descriptive text to be inserted at the beginning.
9314 #+TEXT: Several lines may be given.
9315 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9316 #+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
9317 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9318 #+LINK_UP: the ``up'' link of an exported page
9319 #+LINK_HOME: the ``home'' link of an exported page
9320 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
9321 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9322 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9323 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9327 The OPTIONS line is a compact@footnote{If you want to configure many options
9328 this way, you can use several OPTIONS lines.} form to specify export
9329 settings. Here you can:
9330 @cindex headline levels
9331 @cindex section-numbers
9332 @cindex table of contents
9333 @cindex line-break preservation
9334 @cindex quoted HTML tags
9335 @cindex fixed-width sections
9337 @cindex @TeX{}-like syntax for sub- and superscripts
9339 @cindex special strings
9340 @cindex emphasized text
9341 @cindex @TeX{} macros
9342 @cindex @LaTeX{} fragments
9343 @cindex author info, in export
9344 @cindex time info, in export
9346 H: @r{set the number of headline levels for export}
9347 num: @r{turn on/off section-numbers}
9348 toc: @r{turn on/off table of contents, or set level limit (integer)}
9349 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9350 @@: @r{turn on/off quoted HTML tags}
9351 :: @r{turn on/off fixed-width sections}
9352 |: @r{turn on/off tables}
9353 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9354 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9355 @r{the simple @code{a_b} will be left as it is.}
9356 -: @r{turn on/off conversion of special strings.}
9357 f: @r{turn on/off footnotes like this[1].}
9358 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9359 pri: @r{turn on/off priority cookies}
9360 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9361 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9362 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9363 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9364 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
9365 skip: @r{turn on/off skipping the text before the first heading}
9366 author: @r{turn on/off inclusion of author name/email into exported file}
9367 email: @r{turn on/off inclusion of author email into exported file}
9368 creator: @r{turn on/off inclusion of creator info into exported file}
9369 timestamp: @r{turn on/off inclusion creation time into exported file}
9370 d: @r{turn on/off inclusion of drawers}
9373 These options take effect in both the HTML and @LaTeX{} export, except for
9374 @code{TeX} and @code{LaTeX}, which are respectively @code{t} and @code{nil}
9375 for the @LaTeX{} export. The default values for these and many other options
9376 are given by a set of variables. For a list of such variables, the
9377 corresponding OPTIONS keys and also the publishing keys (@pxref{Project
9378 alist}), see the constant @code{org-export-plist-vars}.
9380 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9381 calling an export command, the subtree can overrule some of the file's export
9382 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9383 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9384 @code{EXPORT_OPTIONS}.
9386 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9387 @section The export dispatcher
9388 @cindex dispatcher, for export commands
9390 All export commands can be reached using the export dispatcher, which is a
9391 prefix key that prompts for an additional key specifying the command.
9392 Normally the entire file is exported, but if there is an active region that
9393 contains one outline tree, the first heading is used as document title and
9394 the subtrees are exported.
9397 @orgcmd{C-c C-e,org-export}
9398 @vindex org-export-run-in-background
9399 Dispatcher for export and publishing commands. Displays a help-window
9400 listing the additional key(s) needed to launch an export or publishing
9401 command. The prefix arg is passed through to the exporter. A double prefix
9402 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9403 separate Emacs process@footnote{To make this behavior the default, customize
9404 the variable @code{org-export-run-in-background}.}.
9405 @orgcmd{C-c C-e v,org-export-visible}
9406 Like @kbd{C-c C-e}, but only export the text that is currently visible
9407 (i.e. not hidden by outline visibility).
9408 @orgcmd{C-u C-u C-c C-e,org-export}
9409 @vindex org-export-run-in-background
9410 Call the exporter, but reverse the setting of
9411 @code{org-export-run-in-background}, i.e. request background processing if
9412 not set, or force processing in the current Emacs process if set.
9415 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9416 @section ASCII/Latin-1/UTF-8 export
9417 @cindex ASCII export
9418 @cindex Latin-1 export
9419 @cindex UTF-8 export
9421 ASCII export produces a simple and very readable version of an Org-mode
9422 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9423 with special characters and symbols available in these encodings.
9425 @cindex region, active
9426 @cindex active region
9427 @cindex transient-mark-mode
9429 @orgcmd{C-c C-e a,org-export-as-ascii}
9430 @cindex property, EXPORT_FILE_NAME
9431 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9432 will be @file{myfile.txt}. The file will be overwritten without
9433 warning. If there is an active region@footnote{This requires
9434 @code{transient-mark-mode} be turned on.}, only the region will be
9435 exported. If the selected region is a single tree@footnote{To select the
9436 current subtree, use @kbd{C-c @@}.}, the tree head will
9437 become the document title. If the tree head entry has or inherits an
9438 @code{EXPORT_FILE_NAME} property, that name will be used for the
9440 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9441 Export to a temporary buffer. Do not create a file.
9442 @orgcmd{C-c C-e n,org-export-as-latin1}
9443 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
9444 Like the above commands, but use Latin-1 encoding.
9445 @orgcmd{C-c C-e u,org-export-as-utf8}
9446 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
9447 Like the above commands, but use UTF-8 encoding.
9448 @item C-c C-e v a/n/u
9449 Export only the visible part of the document.
9452 @cindex headline levels, for exporting
9453 In the exported version, the first 3 outline levels will become
9454 headlines, defining a general document structure. Additional levels
9455 will be exported as itemized lists. If you want that transition to occur
9456 at a different level, specify it with a prefix argument. For example,
9463 creates only top level headlines and does the rest as items. When
9464 headlines are converted to items, the indentation of the text following
9465 the headline is changed to fit nicely under the item. This is done with
9466 the assumption that the first body line indicates the base indentation of
9467 the body text. Any indentation larger than this is adjusted to preserve
9468 the layout relative to the first line. Should there be lines with less
9469 indentation than the first, these are left alone.
9471 @vindex org-export-ascii-links-to-notes
9472 Links will be exported in a footnote-like style, with the descriptive part in
9473 the text and the link in a note before the next heading. See the variable
9474 @code{org-export-ascii-links-to-notes} for details and other options.
9476 @node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9477 @section HTML export
9480 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9481 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9482 language, but with additional support for tables.
9485 * HTML Export commands:: How to invoke HTML export
9486 * Quoting HTML tags:: Using direct HTML in Org-mode
9487 * Links in HTML export:: How links will be interpreted and formatted
9488 * Tables in HTML export:: How to modify the formatting of tables
9489 * Images in HTML export:: How to insert figures into HTML output
9490 * Math formatting in HTML export:: Beautiful math also on the web
9491 * Text areas in HTML export:: An alternative way to show an example
9492 * CSS support:: Changing the appearance of the output
9493 * JavaScript support:: Info and Folding in a web browser
9496 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
9497 @subsection HTML export commands
9499 @cindex region, active
9500 @cindex active region
9501 @cindex transient-mark-mode
9503 @orgcmd{C-c C-e h,org-export-as-html}
9504 @cindex property, EXPORT_FILE_NAME
9505 Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
9506 the ASCII file will be @file{myfile.html}. The file will be overwritten
9507 without warning. If there is an active region@footnote{This requires
9508 @code{transient-mark-mode} be turned on.}, only the region will be
9509 exported. If the selected region is a single tree@footnote{To select the
9510 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9511 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9512 property, that name will be used for the export.
9513 @orgcmd{C-c C-e b,org-export-as-html-and-open}
9514 Export as HTML file and immediately open it with a browser.
9515 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
9516 Export to a temporary buffer. Do not create a file.
9517 @orgcmd{C-c C-e R,org-export-region-as-html}
9518 Export the active region to a temporary buffer. With a prefix argument, do
9519 not produce the file header and footer, but just the plain HTML section for
9520 the region. This is good for cut-and-paste operations.
9521 @item C-c C-e v h/b/H/R
9522 Export only the visible part of the document.
9523 @item M-x org-export-region-as-html
9524 Convert the region to HTML under the assumption that it was Org-mode
9525 syntax before. This is a global command that can be invoked in any
9527 @item M-x org-replace-region-by-HTML
9528 Replace the active region (assumed to be in Org-mode syntax) by HTML
9532 @cindex headline levels, for exporting
9533 In the exported version, the first 3 outline levels will become headlines,
9534 defining a general document structure. Additional levels will be exported as
9535 itemized lists. If you want that transition to occur at a different level,
9536 specify it with a numeric prefix argument. For example,
9543 creates two levels of headings and does the rest as items.
9545 @node Quoting HTML tags, Links in HTML export, HTML Export commands, HTML export
9546 @subsection Quoting HTML tags
9548 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
9549 @samp{>} in HTML export. If you want to include simple HTML tags
9550 which should be interpreted as such, mark them with @samp{@@} as in
9551 @samp{@@<b>bold text@@</b>}. Note that this really works only for
9552 simple tags. For more extensive HTML that should be copied verbatim to
9553 the exported file use either
9556 @cindex #+BEGIN_HTML
9558 #+HTML: Literal HTML code for export
9562 @cindex #+BEGIN_HTML
9566 All lines between these markers are exported literally
9571 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9572 @subsection Links in HTML export
9574 @cindex links, in HTML export
9575 @cindex internal links, in HTML export
9576 @cindex external links, in HTML export
9577 Internal links (@pxref{Internal links}) will continue to work in HTML. This
9578 includes automatic links created by radio targets (@pxref{Radio
9579 targets}). Links to external files will still work if the target file is on
9580 the same @i{relative} path as the published Org file. Links to other
9581 @file{.org} files will be translated into HTML links under the assumption
9582 that an HTML version also exists of the linked file, at the same relative
9583 path. @samp{id:} links can then be used to jump to specific entries across
9584 files. For information related to linking files while publishing them to a
9585 publishing directory see @ref{Publishing links}.
9587 If you want to specify attributes for links, you can do so using a special
9588 @code{#+ATTR_HTML} line to define attributes that will be added to the
9589 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
9590 and @code{style} attributes for a link:
9594 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
9595 [[http://orgmode.org]]
9598 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9600 @cindex tables, in HTML
9601 @vindex org-export-html-table-tag
9603 Org-mode tables are exported to HTML using the table tag defined in
9604 @code{org-export-html-table-tag}. The default setting makes tables without
9605 cell borders and frame. If you would like to change this for individual
9606 tables, place something like the following before the table:
9611 #+CAPTION: This is a table with lines around and between cells
9612 #+ATTR_HTML: border="2" rules="all" frame="all"
9615 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
9616 @subsection Images in HTML export
9618 @cindex images, inline in HTML
9619 @cindex inlining images in HTML
9620 @vindex org-export-html-inline-images
9621 HTML export can inline images given as links in the Org file, and
9622 it can make an image the clickable part of a link. By
9623 default@footnote{But see the variable
9624 @code{org-export-html-inline-images}.}, images are inlined if a link does
9625 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
9626 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
9627 @samp{the image} that points to the image. If the description part
9628 itself is a @code{file:} link or a @code{http:} URL pointing to an
9629 image, this image will be inlined and activated so that clicking on the
9630 image will activate the link. For example, to include a thumbnail that
9631 will link to a high resolution version of the image, you could use:
9634 [[file:highres.jpg][file:thumb.jpg]]
9637 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
9638 In the example below we specify the @code{alt} and @code{title} attributes to
9639 support text viewers and accessibility, and align it to the right.
9644 #+CAPTION: A black cat stalking a spider
9645 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
9650 and you could use @code{http} addresses just as well.
9652 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
9653 @subsection Math formatting in HTML export
9657 @LaTeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two
9658 different ways on HTML pages. The default is to use the
9659 @uref{http://www.mathjax.org, MathJax system} which should work out of the
9660 box with Org mode installation because @code{http://orgmode.org} serves
9661 @file{MathJax} for Org-mode users for small applications and for testing
9662 purposes. @b{If you plan to use this regularly or on pages with significant
9663 page views, you should install@footnote{Installation instructions can be
9664 found on the MathJax website, see
9665 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
9666 your own server in order to limit the load of our server.} To configure
9667 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
9668 insert something like the following into the buffer:
9671 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
9674 @noindent See the docstring of the variable
9675 @code{org-export-html-mathjax-options} for the meaning of the parameters in
9678 If you prefer, you can also request that @LaTeX{} fragments are processed
9679 into small images that will be inserted into the browser page. Before the
9680 availability of MathJax, this was the default method for Org files. This
9681 method requires that the @file{dvipng} program is available on your system.
9682 You can still get this processing with
9685 #+OPTIONS: LaTeX:dvipng
9688 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
9689 @subsection Text areas in HTML export
9691 @cindex text areas, in HTML
9692 An alternative way to publish literal code examples in HTML is to use text
9693 areas, where the example can even be edited before pasting it into an
9694 application. It is triggered by a @code{-t} switch at an @code{example} or
9695 @code{src} block. Using this switch disables any options for syntax and
9696 label highlighting, and line numbering, which may be present. You may also
9697 use @code{-h} and @code{-w} switches to specify the height and width of the
9698 text area, which default to the number of lines in the example, and 80,
9699 respectively. For example
9702 #+BEGIN_EXAMPLE -t -w 40
9703 (defun org-xor (a b)
9710 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
9711 @subsection CSS support
9712 @cindex CSS, for HTML export
9713 @cindex HTML export, CSS
9715 @vindex org-export-html-todo-kwd-class-prefix
9716 @vindex org-export-html-tag-class-prefix
9717 You can also give style information for the exported file. The HTML exporter
9718 assigns the following special CSS classes@footnote{If the classes on TODO
9719 keywords and tags lead to conflicts, use the variables
9720 @code{org-export-html-todo-kwd-class-prefix} and
9721 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
9722 parts of the document---your style specifications may change these, in
9723 addition to any of the standard classes like for headlines, tables, etc.
9725 p.author @r{author information, including email}
9726 p.date @r{publishing date}
9727 p.creator @r{creator info, about org-mode version}
9728 .title @r{document title}
9729 .todo @r{TODO keywords, all not-done states}
9730 .done @r{the DONE keywords, all stated the count as done}
9731 .WAITING @r{each TODO keyword also uses a class named after itself}
9732 .timestamp @r{timestamp}
9733 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
9734 .timestamp-wrapper @r{span around keyword plus timestamp}
9735 .tag @r{tag in a headline}
9736 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
9737 .target @r{target for links}
9738 .linenr @r{the line number in a code example}
9739 .code-highlighted @r{for highlighting referenced code lines}
9740 div.outline-N @r{div for outline level N (headline plus text))}
9741 div.outline-text-N @r{extra div for text at outline level N}
9742 .section-number-N @r{section number in headlines, different for each level}
9743 div.figure @r{how to format an inlined image}
9744 pre.src @r{formatted source code}
9745 pre.example @r{normal example}
9746 p.verse @r{verse paragraph}
9747 div.footnotes @r{footnote section headline}
9748 p.footnote @r{footnote definition paragraph, containing a footnote}
9749 .footref @r{a footnote reference number (always a <sup>)}
9750 .footnum @r{footnote number in footnote definition (always <sup>)}
9753 @vindex org-export-html-style-default
9754 @vindex org-export-html-style-include-default
9755 @vindex org-export-html-style
9756 @vindex org-export-html-extra
9757 @vindex org-export-html-style-default
9758 Each exported file contains a compact default style that defines these
9759 classes in a basic way@footnote{This style is defined in the constant
9760 @code{org-export-html-style-default}, which you should not modify. To turn
9761 inclusion of these defaults off, customize
9762 @code{org-export-html-style-include-default}}. You may overwrite these
9763 settings, or add to them by using the variables @code{org-export-html-style}
9764 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
9765 fine-grained settings, like file-local settings). To set the latter variable
9766 individually for each file, you can use
9770 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
9774 For longer style definitions, you can use several such lines. You could also
9775 directly write a @code{<style>} @code{</style>} section in this way, without
9776 referring to an external file.
9778 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
9779 property to assign a class to the tree. In order to specify CSS styles for a
9780 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
9783 @c FIXME: More about header and footer styles
9784 @c FIXME: Talk about links and targets.
9786 @node JavaScript support, , CSS support, HTML export
9787 @subsection JavaScript supported display of web pages
9789 @cindex Rose, Sebastian
9790 Sebastian Rose has written a JavaScript program especially designed to
9791 enhance the web viewing experience of HTML files created with Org. This
9792 program allows you to view large files in two different ways. The first one
9793 is an @emph{Info}-like mode where each section is displayed separately and
9794 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
9795 as well, press @kbd{?} for an overview of the available keys). The second
9796 view type is a @emph{folding} view much like Org provides inside Emacs. The
9797 script is available at @url{http://orgmode.org/org-info.js} and you can find
9798 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
9799 We host the script at our site, but if you use it a lot, you might
9800 not want to be dependent on @url{orgmode.org} and prefer to install a local
9801 copy on your own web server.
9803 To use the script, you need to make sure that the @file{org-jsinfo.el} module
9804 gets loaded. It should be loaded by default, but you can try @kbd{M-x
9805 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
9806 this is indeed the case. All it then takes to make use of the program is
9807 adding a single line to the Org file:
9809 @cindex #+INFOJS_OPT
9811 #+INFOJS_OPT: view:info toc:nil
9815 If this line is found, the HTML header will automatically contain the code
9816 needed to invoke the script. Using the line above, you can set the following
9820 path: @r{The path to the script. The default is to grab the script from}
9821 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
9822 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
9823 view: @r{Initial view when website is first shown. Possible values are:}
9824 info @r{Info-like interface with one section per page.}
9825 overview @r{Folding interface, initially showing only top-level.}
9826 content @r{Folding interface, starting with all headlines visible.}
9827 showall @r{Folding interface, all headlines and text visible.}
9828 sdepth: @r{Maximum headline level that will still become an independent}
9829 @r{section for info and folding modes. The default is taken from}
9830 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
9831 @r{If this is smaller than in @code{org-export-headline-levels}, each}
9832 @r{info/folding section can still contain child headlines.}
9833 toc: @r{Should the table of contents @emph{initially} be visible?}
9834 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
9835 tdepth: @r{The depth of the table of contents. The defaults are taken from}
9836 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
9837 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
9838 @r{If yes, the toc will never be displayed as a section.}
9839 ltoc: @r{Should there be short contents (children) in each section?}
9840 @r{Make this @code{above} if the section should be above initial text.}
9841 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
9842 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
9843 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
9844 @r{default), only one such button will be present.}
9847 @vindex org-infojs-options
9848 @vindex org-export-html-use-infojs
9849 You can choose default values for these options by customizing the variable
9850 @code{org-infojs-options}. If you always want to apply the script to your
9851 pages, configure the variable @code{org-export-html-use-infojs}.
9853 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
9854 @section @LaTeX{} and PDF export
9855 @cindex @LaTeX{} export
9857 @cindex Guerry, Bastien
9859 Org-mode contains a @LaTeX{} exporter written by Bastien Guerry. With
9860 further processing@footnote{The default LaTeX output is designed for
9861 processing with pdftex or latex. It includes packages that are not
9862 compatible with xetex and possibly luatex. See the variables
9863 @code{org-export-latex-default-packages-alist} and
9864 @code{org-export-latex-packages-alist}.}, this backend is also used to
9865 produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
9866 implement links and cross references, the PDF output file will be fully
9870 * LaTeX/PDF export commands:: Which key invokes which commands
9871 * Header and sectioning:: Setting up the export file structure
9872 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code
9873 * Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
9874 * Images in LaTeX export:: How to insert figures into @LaTeX{} output
9875 * Beamer class export:: Turning the file into a presentation
9878 @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
9879 @subsection @LaTeX{} export commands
9881 @cindex region, active
9882 @cindex active region
9883 @cindex transient-mark-mode
9885 @orgcmd{C-c C-e l,org-export-as-latex}
9886 @cindex property EXPORT_FILE_NAME
9887 Export as @LaTeX{} file @file{myfile.tex}. For an Org file
9888 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
9889 be overwritten without warning. If there is an active region@footnote{This
9890 requires @code{transient-mark-mode} be turned on.}, only the region will be
9891 exported. If the selected region is a single tree@footnote{To select the
9892 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9893 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
9894 property, that name will be used for the export.
9895 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
9896 Export to a temporary buffer. Do not create a file.
9898 Export only the visible part of the document.
9899 @item M-x org-export-region-as-latex
9900 Convert the region to @LaTeX{} under the assumption that it was Org-mode
9901 syntax before. This is a global command that can be invoked in any
9903 @item M-x org-replace-region-by-latex
9904 Replace the active region (assumed to be in Org-mode syntax) by @LaTeX{}
9906 @orgcmd{C-c C-e p,org-export-as-pdf}
9907 Export as @LaTeX{} and then process to PDF.
9908 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
9909 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
9912 @cindex headline levels, for exporting
9913 @vindex org-latex-low-levels
9914 In the exported version, the first 3 outline levels will become
9915 headlines, defining a general document structure. Additional levels
9916 will be exported as description lists. The exporter can ignore them or
9917 convert them to a custom string depending on
9918 @code{org-latex-low-levels}.
9920 If you want that transition to occur at a different level, specify it
9921 with a numeric prefix argument. For example,
9928 creates two levels of headings and does the rest as items.
9930 @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
9931 @subsection Header and sectioning structure
9932 @cindex @LaTeX{} class
9933 @cindex @LaTeX{} sectioning structure
9934 @cindex @LaTeX{} header
9935 @cindex header, for LaTeX files
9936 @cindex sectioning structure, for LaTeX export
9938 By default, the @LaTeX{} output uses the class @code{article}.
9940 @vindex org-export-latex-default-class
9941 @vindex org-export-latex-classes
9942 @vindex org-export-latex-default-packages-alist
9943 @vindex org-export-latex-packages-alist
9944 @cindex #+LATEX_HEADER
9945 @cindex #+LATEX_CLASS
9946 @cindex #+LATEX_CLASS_OPTIONS
9947 @cindex property, LATEX_CLASS
9948 @cindex property, LATEX_CLASS_OPTIONS
9949 You can change this globally by setting a different value for
9950 @code{org-export-latex-default-class} or locally by adding an option like
9951 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
9952 property that applies when exporting a region containing only this (sub)tree.
9953 The class must be listed in @code{org-export-latex-classes}. This variable
9954 defines a header template for each class@footnote{Into which the values of
9955 @code{org-export-latex-default-packages-alist} and
9956 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
9957 define the sectioning structure for each class. You can also define your own
9958 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
9959 property can specify the options for the @code{\documentclass} macro. You
9960 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
9961 header. See the docstring of @code{org-export-latex-classes} for more
9964 @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export
9965 @subsection Quoting @LaTeX{} code
9967 Embedded @LaTeX{} as described in @ref{Embedded LaTeX}, will be correctly
9968 inserted into the @LaTeX{} file. This includes simple macros like
9969 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
9970 you can add special code that should only be present in @LaTeX{} export with
9971 the following constructs:
9974 @cindex #+BEGIN_LaTeX
9976 #+LaTeX: Literal LaTeX code for export
9980 @cindex #+BEGIN_LaTeX
9984 All lines between these markers are exported literally
9989 @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
9990 @subsection Tables in @LaTeX{} export
9991 @cindex tables, in @LaTeX{} export
9993 For @LaTeX{} export of a table, you can specify a label and a caption
9994 (@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to
9995 request a @code{longtable} environment for the table, so that it may span
9996 several pages, or to change the default table environment from @code{table}
9997 to @code{table*} or to change the default inner tabular environment to
9998 @code{tabularx} or @code{tabulary}. Finally, you can set the alignment
9999 string, and (with @code{tabularx} or @code{tabulary}) the width:
10003 @cindex #+ATTR_LaTeX
10005 #+CAPTION: A long table
10007 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10012 or to specify a multicolumn table with @code{tabulary}
10016 @cindex #+ATTR_LaTeX
10018 #+CAPTION: A wide table with tabulary
10020 #+ATTR_LaTeX: table* tabulary width=\textwidth
10025 @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
10026 @subsection Images in @LaTeX{} export
10027 @cindex images, inline in @LaTeX{}
10028 @cindex inlining images in @LaTeX{}
10030 Images that are linked to without a description part in the link, like
10031 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10032 output file resulting from @LaTeX{} processing. Org will use an
10033 @code{\includegraphics} macro to insert the image. If you have specified a
10034 caption and/or a label as described in @ref{Images and tables}, the figure
10035 will be wrapped into a @code{figure} environment and thus become a floating
10036 element. You can use an @code{#+ATTR_LaTeX:} line to specify the various
10037 options that can be used in the optional argument of the
10038 @code{\includegraphics} macro. To modify the placement option of the
10039 @code{figure} environment, add something like @samp{placement=[h!]} to the
10042 If you would like to let text flow around the image, add the word @samp{wrap}
10043 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10044 half of the page. To fine-tune, the @code{placement} field will be the set
10045 of additional arguments needed by the @code{wrapfigure} environment. Note
10046 that if you change the size of the image, you need to use compatible settings
10047 for @code{\includegraphics} and @code{wrapfigure}.
10051 @cindex #+ATTR_LaTeX
10053 #+CAPTION: The black-body emission of the disk around HR 4049
10054 #+LABEL: fig:SED-HR4049
10055 #+ATTR_LaTeX: width=5cm,angle=90
10056 [[./img/sed-hr4049.pdf]]
10058 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10062 If you need references to a label created in this way, write
10063 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10065 @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export
10066 @subsection Beamer class export
10068 The LaTeX class @file{beamer} allows production of high quality presentations
10069 using LaTeX and pdf processing. Org-mode has special support for turning an
10070 Org-mode file or tree into a @file{beamer} presentation.
10072 When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS:
10073 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10074 @code{beamer}, a special export mode will turn the file or tree into a beamer
10075 presentation. Any tree with not-too-deep level nesting should in principle be
10076 exportable as a beamer presentation. By default, the top-level entries (or
10077 the first level below the selected subtree heading) will be turned into
10078 frames, and the outline structure below this level will become itemize lists.
10079 You can also configure the variable @code{org-beamer-frame-level} to a
10080 different level---then the hierarchy above frames will produce the sectioning
10081 structure of the presentation.
10083 A template for useful in-buffer settings or properties can be inserted into
10084 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10085 things, this will install a column view format which is very handy for
10086 editing special properties used by beamer.
10088 You can influence the structure of the presentation using the following
10093 The environment that should be used to format this entry. Valid environments
10094 are defined in the constant @code{org-beamer-environments-default}, and you
10095 can define more in @code{org-beamer-environments-extra}. If this property is
10096 set, the entry will also get a @code{:B_environment:} tag to make this
10097 visible. This tag has no semantic meaning, it is only a visual aid.
10098 @item BEAMER_envargs
10099 The beamer-special arguments that should be used for the environment, like
10100 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10101 property is also set, something like @code{C[t]} can be added here as well to
10102 set an options argument for the implied @code{columns} environment.
10103 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10106 The width of a column that should start with this entry. If this property is
10107 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10108 Also this tag is only a visual aid. When this is a plain number, it will be
10109 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10110 that you have specified the units, like @samp{3cm}. The first such property
10111 in a frame will start a @code{columns} environment to surround the columns.
10112 This environment is closed when an entry has a @code{BEAMER_col} property
10113 with value 0 or 1, or automatically at the end of the frame.
10115 Additional commands that should be inserted after the environment has been
10116 opened. For example, when creating a frame, this can be used to specify
10120 Frames will automatically receive a @code{fragile} option if they contain
10121 source code that uses the verbatim environment. Special @file{beamer}
10122 specific code can be inserted using @code{#+BEAMER:} and
10123 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
10124 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10125 in the presentation as well.
10127 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10128 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10129 into @code{\note@{...@}}. The former will include the heading as part of the
10130 note text, the latter will ignore the heading of that node. To simplify note
10131 generation, it is actually enough to mark the note with a @emph{tag} (either
10132 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10133 @code{BEAMER_env} property.
10135 You can turn on a special minor mode @code{org-beamer-mode} for editing
10143 @orgcmd{C-c C-b,org-beamer-select-environment}
10144 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10145 environment or the @code{BEAMER_col} property.
10148 Column view provides a great way to set the environment of a node and other
10149 important parameters. Make sure you are using a COLUMN format that is geared
10150 toward this special purpose. The command @kbd{M-x
10151 org-insert-beamer-options-template} defines such a format.
10153 Here is a simple example Org document that is intended for beamer export.
10156 #+LaTeX_CLASS: beamer
10157 #+TITLE: Example Presentation
10158 #+AUTHOR: Carsten Dominik
10159 #+LaTeX_CLASS_OPTIONS: [presentation]
10160 #+BEAMER_FRAME_LEVEL: 2
10161 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10162 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10164 * This is the first structural section
10166 ** Frame 1 \\ with a subtitle
10167 *** Thanks to Eric Fraga :BMCOL:B_block:
10170 :BEAMER_envargs: C[t]
10173 for the first viable beamer setup in Org
10174 *** Thanks to everyone else :BMCOL:B_block:
10178 :BEAMER_envargs: <2->
10180 for contributing to the discussion
10181 **** This will be formatted as a beamer note :B_note:
10182 ** Frame 2 \\ where we will not use columns
10183 *** Request :B_block:
10184 Please test this stuff!
10190 For more information, see the documentation on Worg.
10192 @node DocBook export, TaskJuggler export, LaTeX and PDF export, Exporting
10193 @section DocBook export
10194 @cindex DocBook export
10196 @cindex Cui, Baoqiu
10198 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10199 exported to DocBook format, it can be further processed to produce other
10200 formats, including PDF, HTML, man pages, etc., using many available DocBook
10201 tools and stylesheets.
10203 Currently DocBook exporter only supports DocBook V5.0.
10206 * DocBook export commands:: How to invoke DocBook export
10207 * Quoting DocBook code:: Incorporating DocBook code in Org files
10208 * Recursive sections:: Recursive sections in DocBook
10209 * Tables in DocBook export:: Tables are exported as HTML tables
10210 * Images in DocBook export:: How to insert figures into DocBook output
10211 * Special characters:: How to handle special characters
10214 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10215 @subsection DocBook export commands
10217 @cindex region, active
10218 @cindex active region
10219 @cindex transient-mark-mode
10221 @orgcmd{C-c C-e D,org-export-as-docbook}
10222 @cindex property EXPORT_FILE_NAME
10223 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10224 file will be @file{myfile.xml}. The file will be overwritten without
10225 warning. If there is an active region@footnote{This requires
10226 @code{transient-mark-mode} to be turned on}, only the region will be
10227 exported. If the selected region is a single tree@footnote{To select the
10228 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10229 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10230 property, that name will be used for the export.
10231 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10232 Export as DocBook file, process to PDF, then open the resulting PDF file.
10234 @vindex org-export-docbook-xslt-proc-command
10235 @vindex org-export-docbook-xsl-fo-proc-command
10236 Note that, in order to produce PDF output based on exported DocBook file, you
10237 need to have XSLT processor and XSL-FO processor software installed on your
10238 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10239 @code{org-export-docbook-xsl-fo-proc-command}.
10241 @vindex org-export-docbook-xslt-stylesheet
10242 The stylesheet argument @code{%s} in variable
10243 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10244 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10245 the user. You can also overrule this global setting on a per-file basis by
10246 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10248 @orgkey{C-c C-e v D}
10249 Export only the visible part of the document.
10252 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10253 @subsection Quoting DocBook code
10255 You can quote DocBook code in Org files and copy it verbatim into exported
10256 DocBook file with the following constructs:
10259 @cindex #+BEGIN_DOCBOOK
10261 #+DOCBOOK: Literal DocBook code for export
10265 @cindex #+BEGIN_DOCBOOK
10269 All lines between these markers are exported by DocBook exporter
10274 For example, you can use the following lines to include a DocBook warning
10275 admonition. As to what this warning says, you should pay attention to the
10276 document context when quoting DocBook code in Org files. You may make
10277 exported DocBook XML files invalid by not quoting DocBook code correctly.
10282 <para>You should know what you are doing when quoting DocBook XML code
10283 in your Org file. Invalid DocBook XML may be generated by
10284 DocBook exporter if you are not careful!</para>
10289 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10290 @subsection Recursive sections
10291 @cindex DocBook recursive sections
10293 DocBook exporter exports Org files as articles using the @code{article}
10294 element in DocBook. Recursive sections, i.e. @code{section} elements, are
10295 used in exported articles. Top level headlines in Org files are exported as
10296 top level sections, and lower level headlines are exported as nested
10297 sections. The entire structure of Org files will be exported completely, no
10298 matter how many nested levels of headlines there are.
10300 Using recursive sections makes it easy to port and reuse exported DocBook
10301 code in other DocBook document types like @code{book} or @code{set}.
10303 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10304 @subsection Tables in DocBook export
10305 @cindex tables, in DocBook export
10307 Tables in Org files are exported as HTML tables, which have been supported since
10310 If a table does not have a caption, an informal table is generated using the
10311 @code{informaltable} element; otherwise, a formal table will be generated
10312 using the @code{table} element.
10314 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10315 @subsection Images in DocBook export
10316 @cindex images, inline in DocBook
10317 @cindex inlining images in DocBook
10319 Images that are linked to without a description part in the link, like
10320 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10321 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10322 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10323 specified a caption for an image as described in @ref{Images and tables}, a
10324 @code{caption} element will be added in @code{mediaobject}. If a label is
10325 also specified, it will be exported as an @code{xml:id} attribute of the
10326 @code{mediaobject} element.
10328 @vindex org-export-docbook-default-image-attributes
10329 Image attributes supported by the @code{imagedata} element, like @code{align}
10330 or @code{width}, can be specified in two ways: you can either customize
10331 variable @code{org-export-docbook-default-image-attributes} or use the
10332 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10333 @code{org-export-docbook-default-image-attributes} are applied to all inline
10334 images in the Org file to be exported (unless they are overridden by image
10335 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10337 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10338 attributes or override default image attributes for individual images. If
10339 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10340 variable @code{org-export-docbook-default-image-attributes}, the former
10341 takes precedence. Here is an example about how image attributes can be
10346 @cindex #+ATTR_DOCBOOK
10348 #+CAPTION: The logo of Org-mode
10349 #+LABEL: unicorn-svg
10350 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10351 [[./img/org-mode-unicorn.svg]]
10354 @vindex org-export-docbook-inline-image-extensions
10355 By default, DocBook exporter recognizes the following image file types:
10356 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10357 customize variable @code{org-export-docbook-inline-image-extensions} to add
10358 more types to this list as long as DocBook supports them.
10360 @node Special characters, , Images in DocBook export, DocBook export
10361 @subsection Special characters in DocBook export
10362 @cindex Special characters in DocBook export
10364 @vindex org-export-docbook-doctype
10365 @vindex org-entities
10366 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10367 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10368 characters are rewritten to XML entities, like @code{α},
10369 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10370 @code{org-entities}. As long as the generated DocBook file includes the
10371 corresponding entities, these special characters are recognized.
10373 You can customize variable @code{org-export-docbook-doctype} to include the
10374 entities you need. For example, you can set variable
10375 @code{org-export-docbook-doctype} to the following value to recognize all
10376 special characters included in XHTML entities:
10379 "<!DOCTYPE article [
10380 <!ENTITY % xhtml1-symbol PUBLIC
10381 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10382 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10389 @node TaskJuggler export, Freemind export, DocBook export, Exporting
10390 @section TaskJuggler export
10391 @cindex TaskJuggler export
10392 @cindex Project management
10394 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
10395 It provides an optimizing scheduler that computes your project time lines and
10396 resource assignments based on the project outline and the constraints that
10399 The TaskJuggler exporter is a bit different from other exporters, such as the
10400 HTML and LaTeX exporters for example, in that it does not export all the
10401 nodes of a document or strictly follow the order of the nodes in the
10404 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
10405 a optionally tree that defines the resources for this project. It then
10406 creates a TaskJuggler file based on these trees and the attributes defined in
10409 @subsection TaskJuggler export commands
10412 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
10413 Export as TaskJuggler file.
10415 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
10416 Export as TaskJuggler file and then open the file with TaskJugglerUI.
10421 @vindex org-export-taskjuggler-project-tag
10422 Create your tasks as you usually do with Org-mode. Assign efforts to each
10423 task using properties (it's easiest to do this in the column view). You
10424 should end up with something similar to the example by Peter Jones in
10425 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
10426 Now mark the top node of your tasks with a tag named
10427 @code{:taskjuggler_project:} (or whatever you customized
10428 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
10429 the project plan with @kbd{C-c C-e J} which will export the project plan and
10430 open a gantt chart in TaskJugglerUI.
10432 @subsection Resources
10434 @vindex org-export-taskjuggler-resource-tag
10435 Next you can define resources and assign those to work on specific tasks. You
10436 can group your resources hierarchically. Tag the top node of the resources
10437 with @code{:taskjuggler_resource:} (or whatever you customized
10438 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
10439 identifier (named @samp{resource_id}) to the resources (using the standard
10440 Org properties commands, @pxref{Property syntax}) or you can let the exporter
10441 generate identifiers automatically (the exporter picks the first word of the
10442 headline as the identifier as long as it is unique---see the documentation of
10443 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
10444 allocate resources to tasks. This is again done with the @samp{allocate}
10445 property on the tasks. Do this in column view or when on the task type
10446 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
10448 Once the allocations are done you can again export to TaskJuggler and check
10449 in the Resource Allocation Graph which person is working on what task at what
10452 @subsection Export of properties
10454 The exporter also takes TODO state information into consideration, i.e. if a
10455 task is marked as done it will have the corresponding attribute in
10456 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
10457 resource or resource node which is known to TaskJuggler, such as
10458 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
10459 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
10460 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
10461 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
10462 @samp{scheduling}, etc for tasks.
10464 @subsection Dependencies
10466 The exporter will handle dependencies that are defined in the tasks either
10467 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
10468 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
10469 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
10470 attribute can be either @samp{previous-sibling} or a reference to an
10471 identifier (named @samp{task_id}) which is defined for another task in the
10472 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
10473 dependencies separated by either space or comma. You can also specify
10474 optional attributes on the dependency by simply appending it. The following
10475 examples should illustrate this:
10480 :task_id: preparation
10483 * Training material
10485 :task_id: training_material
10488 ** Markup Guidelines
10492 ** Workflow Guidelines
10499 :BLOCKER: training_material @{ gapduration 1d @} preparation
10503 @subsection Reports
10505 @vindex org-export-taskjuggler-default-reports
10506 TaskJuggler can produce many kinds of reports (e.g. gantt chart, resource
10507 allocation, etc). The user defines what kind of reports should be generated
10508 for a project in the TaskJuggler file. The exporter will automatically insert
10509 some default reports in the file. These defaults are defined in
10510 @code{org-export-taskjuggler-default-reports}. They can be modified using
10511 customize along with a number of other options. For a more complete list, see
10512 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
10514 For more information and examples see the Org-taskjuggler tutorial at
10515 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
10517 @node Freemind export, XOXO export, TaskJuggler export, Exporting
10518 @section Freemind export
10519 @cindex Freemind export
10522 The Freemind exporter was written by Lennart Borgman.
10525 @orgcmd{C-c C-e m,org-export-as-freemind}
10526 Export as Freemind mind map @file{myfile.mm}.
10529 @node XOXO export, iCalendar export, Freemind export, Exporting
10530 @section XOXO export
10531 @cindex XOXO export
10533 Org-mode contains an exporter that produces XOXO-style output.
10534 Currently, this exporter only handles the general outline structure and
10535 does not interpret any additional Org-mode features.
10538 @orgcmd{C-c C-e x,org-export-as-xoxo}
10539 Export as XOXO file @file{myfile.html}.
10540 @orgkey{C-c C-e v x}
10541 Export only the visible part of the document.
10544 @node iCalendar export, , XOXO export, Exporting
10545 @section iCalendar export
10546 @cindex iCalendar export
10548 @vindex org-icalendar-include-todo
10549 @vindex org-icalendar-use-deadline
10550 @vindex org-icalendar-use-scheduled
10551 @vindex org-icalendar-categories
10552 @vindex org-icalendar-alarm-time
10553 Some people use Org-mode for keeping track of projects, but still prefer a
10554 standard calendar application for anniversaries and appointments. In this
10555 case it can be useful to show deadlines and other time-stamped items in Org
10556 files in the calendar application. Org-mode can export calendar information
10557 in the standard iCalendar format. If you also want to have TODO entries
10558 included in the export, configure the variable
10559 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
10560 and TODO items as VTODO. It will also create events from deadlines that are
10561 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
10562 to set the start and due dates for the TODO entry@footnote{See the variables
10563 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
10564 As categories, it will use the tags locally defined in the heading, and the
10565 file/tree category@footnote{To add inherited tags or the TODO state,
10566 configure the variable @code{org-icalendar-categories}.}. See the variable
10567 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
10570 @vindex org-icalendar-store-UID
10571 @cindex property, ID
10572 The iCalendar standard requires each entry to have a globally unique
10573 identifier (UID). Org creates these identifiers during export. If you set
10574 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
10575 @code{:ID:} property of the entry and re-used next time you report this
10576 entry. Since a single entry can give rise to multiple iCalendar entries (as
10577 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
10578 prefixes to the UID, depending on what triggered the inclusion of the entry.
10579 In this way the UID remains unique, but a synchronization program can still
10580 figure out from which entry all the different instances originate.
10583 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
10584 Create iCalendar entries for the current file and store them in the same
10585 directory, using a file extension @file{.ics}.
10586 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
10587 @vindex org-agenda-files
10588 Like @kbd{C-c C-e i}, but do this for all files in
10589 @code{org-agenda-files}. For each of these files, a separate iCalendar
10590 file will be written.
10591 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
10592 @vindex org-combined-agenda-icalendar-file
10593 Create a single large iCalendar file from all files in
10594 @code{org-agenda-files} and write it to the file given by
10595 @code{org-combined-agenda-icalendar-file}.
10598 @vindex org-use-property-inheritance
10599 @vindex org-icalendar-include-body
10600 @cindex property, SUMMARY
10601 @cindex property, DESCRIPTION
10602 @cindex property, LOCATION
10603 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
10604 property can be inherited from higher in the hierarchy if you configure
10605 @code{org-use-property-inheritance} accordingly.} properties if the selected
10606 entries have them. If not, the summary will be derived from the headline,
10607 and the description from the body (limited to
10608 @code{org-icalendar-include-body} characters).
10610 How this calendar is best read and updated, depends on the application
10611 you are using. The FAQ covers this issue.
10613 @node Publishing, Working With Source Code, Exporting, Top
10614 @chapter Publishing
10617 Org includes a publishing management system that allows you to configure
10618 automatic HTML conversion of @emph{projects} composed of interlinked org
10619 files. You can also configure Org to automatically upload your exported HTML
10620 pages and related attachments, such as images and source code files, to a web
10623 You can also use Org to convert files into PDF, or even combine HTML and PDF
10624 conversion so that files are available in both formats on the server.
10626 Publishing has been contributed to Org by David O'Toole.
10629 * Configuration:: Defining projects
10630 * Uploading files:: How to get files up on the server
10631 * Sample configuration:: Example projects
10632 * Triggering publication:: Publication commands
10635 @node Configuration, Uploading files, Publishing, Publishing
10636 @section Configuration
10638 Publishing needs significant configuration to specify files, destination
10639 and many other properties of a project.
10642 * Project alist:: The central configuration variable
10643 * Sources and destinations:: From here to there
10644 * Selecting files:: What files are part of the project?
10645 * Publishing action:: Setting the function doing the publishing
10646 * Publishing options:: Tweaking HTML export
10647 * Publishing links:: Which links keep working after publishing?
10648 * Sitemap:: Generating a list of all pages
10649 * Generating an index:: An index that reaches across pages
10652 @node Project alist, Sources and destinations, Configuration, Configuration
10653 @subsection The variable @code{org-publish-project-alist}
10654 @cindex org-publish-project-alist
10655 @cindex projects, for publishing
10657 @vindex org-publish-project-alist
10658 Publishing is configured almost entirely through setting the value of one
10659 variable, called @code{org-publish-project-alist}. Each element of the list
10660 configures one project, and may be in one of the two following forms:
10663 ("project-name" :property value :property value ...)
10664 @r{i.e. a well-formed property list with alternating keys and values}
10666 ("project-name" :components ("project-name" "project-name" ...))
10670 In both cases, projects are configured by specifying property values. A
10671 project defines the set of files that will be published, as well as the
10672 publishing configuration to use when publishing those files. When a project
10673 takes the second form listed above, the individual members of the
10674 @code{:components} property are taken to be sub-projects, which group
10675 together files requiring different publishing options. When you publish such
10676 a ``meta-project'', all the components will also be published, in the
10679 @node Sources and destinations, Selecting files, Project alist, Configuration
10680 @subsection Sources and destinations for files
10681 @cindex directories, for publishing
10683 Most properties are optional, but some should always be set. In
10684 particular, Org needs to know where to look for source files,
10685 and where to put published files.
10687 @multitable @columnfractions 0.3 0.7
10688 @item @code{:base-directory}
10689 @tab Directory containing publishing source files
10690 @item @code{:publishing-directory}
10691 @tab Directory where output files will be published. You can directly
10692 publish to a webserver using a file name syntax appropriate for
10693 the Emacs @file{tramp} package. Or you can publish to a local directory and
10694 use external tools to upload your website (@pxref{Uploading files}).
10695 @item @code{:preparation-function}
10696 @tab Function or list of functions to be called before starting the
10697 publishing process, for example, to run @code{make} for updating files to be
10698 published. The project property list is scoped into this call as the
10699 variable @code{project-plist}.
10700 @item @code{:completion-function}
10701 @tab Function or list of functions called after finishing the publishing
10702 process, for example, to change permissions of the resulting files. The
10703 project property list is scoped into this call as the variable
10704 @code{project-plist}.
10708 @node Selecting files, Publishing action, Sources and destinations, Configuration
10709 @subsection Selecting files
10710 @cindex files, selecting for publishing
10712 By default, all files with extension @file{.org} in the base directory
10713 are considered part of the project. This can be modified by setting the
10715 @multitable @columnfractions 0.25 0.75
10716 @item @code{:base-extension}
10717 @tab Extension (without the dot!) of source files. This actually is a
10718 regular expression. Set this to the symbol @code{any} if you want to get all
10719 files in @code{:base-directory}, even without extension.
10721 @item @code{:exclude}
10722 @tab Regular expression to match file names that should not be
10723 published, even though they have been selected on the basis of their
10726 @item @code{:include}
10727 @tab List of files to be included regardless of @code{:base-extension}
10728 and @code{:exclude}.
10730 @item @code{:recursive}
10731 @tab Non-nil means, check base-directory recursively for files to publish.
10734 @node Publishing action, Publishing options, Selecting files, Configuration
10735 @subsection Publishing action
10736 @cindex action, for publishing
10738 Publishing means that a file is copied to the destination directory and
10739 possibly transformed in the process. The default transformation is to export
10740 Org files as HTML files, and this is done by the function
10741 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
10742 export}). But you also can publish your content as PDF files using
10743 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
10744 @code{utf8} encoded files using the corresponding functions. If you want to
10745 publish the Org file itself, but with @i{archived}, @i{commented}, and
10746 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
10747 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
10748 produce @file{file.org} and @file{file.org.html} in the publishing
10749 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
10750 source and publishing directories are equal. Note that with this kind of
10751 setup, you need to add @code{:exclude "-source\\.org"} to the project
10752 definition in @code{org-publish-project-alist} to prevent the published
10753 source files from being considered as new org files the next time the project
10754 is published.}. Other files like images only need to be copied to the
10755 publishing destination; for this you may use @code{org-publish-attachment}.
10756 For non-Org files, you always need to specify the publishing function:
10758 @multitable @columnfractions 0.3 0.7
10759 @item @code{:publishing-function}
10760 @tab Function executing the publication of a file. This may also be a
10761 list of functions, which will all be called in turn.
10762 @item @code{:plain-source}
10763 @tab Non-nil means, publish plain source.
10764 @item @code{:htmlized-source}
10765 @tab Non-nil means, publish htmlized source.
10768 The function must accept three arguments: a property list containing at least
10769 a @code{:publishing-directory} property, the name of the file to be
10770 published, and the path to the publishing directory of the output file. It
10771 should take the specified file, make the necessary transformation (if any)
10772 and place the result into the destination folder.
10774 @node Publishing options, Publishing links, Publishing action, Configuration
10775 @subsection Options for the HTML/@LaTeX{} exporters
10776 @cindex options, for publishing
10778 The property list can be used to set many export options for the HTML
10779 and @LaTeX{} exporters. In most cases, these properties correspond to user
10780 variables in Org. The table below lists these properties along
10781 with the variable they belong to. See the documentation string for the
10782 respective variable for details.
10784 @vindex org-export-html-link-up
10785 @vindex org-export-html-link-home
10786 @vindex org-export-default-language
10787 @vindex org-display-custom-times
10788 @vindex org-export-headline-levels
10789 @vindex org-export-with-section-numbers
10790 @vindex org-export-section-number-format
10791 @vindex org-export-with-toc
10792 @vindex org-export-preserve-breaks
10793 @vindex org-export-with-archived-trees
10794 @vindex org-export-with-emphasize
10795 @vindex org-export-with-sub-superscripts
10796 @vindex org-export-with-special-strings
10797 @vindex org-export-with-footnotes
10798 @vindex org-export-with-drawers
10799 @vindex org-export-with-tags
10800 @vindex org-export-with-todo-keywords
10801 @vindex org-export-with-priority
10802 @vindex org-export-with-TeX-macros
10803 @vindex org-export-with-LaTeX-fragments
10804 @vindex org-export-skip-text-before-1st-heading
10805 @vindex org-export-with-fixed-width
10806 @vindex org-export-with-timestamps
10807 @vindex org-export-author-info
10808 @vindex org-export-email
10809 @vindex org-export-creator-info
10810 @vindex org-export-with-tables
10811 @vindex org-export-highlight-first-table-line
10812 @vindex org-export-html-style-include-default
10813 @vindex org-export-html-style-include-scripts
10814 @vindex org-export-html-style
10815 @vindex org-export-html-style-extra
10816 @vindex org-export-html-link-org-files-as-html
10817 @vindex org-export-html-inline-images
10818 @vindex org-export-html-extension
10819 @vindex org-export-html-table-tag
10820 @vindex org-export-html-expand
10821 @vindex org-export-html-with-timestamp
10822 @vindex org-export-publishing-directory
10823 @vindex org-export-html-preamble
10824 @vindex org-export-html-postamble
10825 @vindex org-export-html-auto-preamble
10826 @vindex org-export-html-auto-postamble
10827 @vindex user-full-name
10828 @vindex user-mail-address
10829 @vindex org-export-select-tags
10830 @vindex org-export-exclude-tags
10832 @multitable @columnfractions 0.32 0.68
10833 @item @code{:link-up} @tab @code{org-export-html-link-up}
10834 @item @code{:link-home} @tab @code{org-export-html-link-home}
10835 @item @code{:language} @tab @code{org-export-default-language}
10836 @item @code{:customtime} @tab @code{org-display-custom-times}
10837 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
10838 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
10839 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
10840 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
10841 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
10842 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
10843 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
10844 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
10845 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
10846 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
10847 @item @code{:drawers} @tab @code{org-export-with-drawers}
10848 @item @code{:tags} @tab @code{org-export-with-tags}
10849 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
10850 @item @code{:priority} @tab @code{org-export-with-priority}
10851 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
10852 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
10853 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
10854 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
10855 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
10856 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
10857 @item @code{:author-info} @tab @code{org-export-author-info}
10858 @item @code{:email-info} @tab @code{org-export-email-info}
10859 @item @code{:creator-info} @tab @code{org-export-creator-info}
10860 @item @code{:tables} @tab @code{org-export-with-tables}
10861 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
10862 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
10863 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
10864 @item @code{:style} @tab @code{org-export-html-style}
10865 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
10866 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
10867 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
10868 @item @code{:html-extension} @tab @code{org-export-html-extension}
10869 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
10870 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
10871 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
10872 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
10873 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
10874 @item @code{:preamble} @tab @code{org-export-html-preamble}
10875 @item @code{:postamble} @tab @code{org-export-html-postamble}
10876 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
10877 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
10878 @item @code{:author} @tab @code{user-full-name}
10879 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
10880 @item @code{:select-tags} @tab @code{org-export-select-tags}
10881 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
10882 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
10885 Most of the @code{org-export-with-*} variables have the same effect in
10886 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
10887 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
10890 @vindex org-publish-project-alist
10891 When a property is given a value in @code{org-publish-project-alist},
10892 its setting overrides the value of the corresponding user variable (if
10893 any) during publishing. Options set within a file (@pxref{Export
10894 options}), however, override everything.
10896 @node Publishing links, Sitemap, Publishing options, Configuration
10897 @subsection Links between published files
10898 @cindex links, publishing
10900 To create a link from one Org file to another, you would use
10901 something like @samp{[[file:foo.org][The foo]]} or simply
10902 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
10903 becomes a link to @file{foo.html}. In this way, you can interlink the
10904 pages of your "org web" project and the links will work as expected when
10905 you publish them to HTML. If you also publish the Org source file and want
10906 to link to that, use an @code{http:} link instead of a @code{file:} link,
10907 because @code{file:} links are converted to link to the corresponding
10910 You may also link to related files, such as images. Provided you are careful
10911 with relative file names, and provided you have also configured Org to upload
10912 the related files, these links will work too. See @ref{Complex example}, for
10913 an example of this usage.
10915 Sometimes an Org file to be published may contain links that are
10916 only valid in your production environment, but not in the publishing
10917 location. In this case, use the property
10919 @multitable @columnfractions 0.4 0.6
10920 @item @code{:link-validation-function}
10921 @tab Function to validate links
10925 to define a function for checking link validity. This function must
10926 accept two arguments, the file name and a directory relative to which
10927 the file name is interpreted in the production environment. If this
10928 function returns @code{nil}, then the HTML generator will only insert a
10929 description into the HTML file, but no link. One option for this
10930 function is @code{org-publish-validate-link} which checks if the given
10931 file is part of any project in @code{org-publish-project-alist}.
10933 @node Sitemap, Generating an index, Publishing links, Configuration
10934 @subsection Generating a sitemap
10935 @cindex sitemap, of published pages
10937 The following properties may be used to control publishing of
10938 a map of files for a given project.
10940 @multitable @columnfractions 0.35 0.65
10941 @item @code{:auto-sitemap}
10942 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
10943 or @code{org-publish-all}.
10945 @item @code{:sitemap-filename}
10946 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
10947 becomes @file{sitemap.html}).
10949 @item @code{:sitemap-title}
10950 @tab Title of sitemap page. Defaults to name of file.
10952 @item @code{:sitemap-function}
10953 @tab Plug-in function to use for generation of the sitemap.
10954 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
10955 of links to all files in the project.
10957 @item @code{:sitemap-sort-folders}
10958 @tab Where folders should appear in the sitemap. Set this to @code{first}
10959 (default) or @code{last} to display folders first or last,
10960 respectively. Any other value will mix files and folders.
10962 @item @code{:sitemap-alphabetically}
10963 @tab The site map is normally sorted alphabetically. Set this explicitly to
10964 @code{nil} to turn off sorting.
10966 @item @code{:sitemap-ignore-case}
10967 @tab Should sorting be case-sensitive? Default @code{nil}.
10971 @node Generating an index, , Sitemap, Configuration
10972 @subsection Generating an index
10973 @cindex index, in a publishing project
10975 Org-mode can generate an index across the files of a publishing project.
10977 @multitable @columnfractions 0.25 0.75
10978 @item @code{:makeindex}
10979 @tab When non-nil, generate in index in the file @file{theindex.org} and
10980 publish it as @file{theindex.html}.
10983 The file will be create when first publishing a project with the
10984 @code{:makeindex} set. The file only contains a statement @code{#+include:
10985 "theindex.inc"}. You can then built around this include statement by adding
10986 a title, style information etc.
10988 @node Uploading files, Sample configuration, Configuration, Publishing
10989 @section Uploading files
10993 For those people already utilizing third party sync tools such as
10994 @command{rsync} or @command{unison}, it might be preferable not to use the built in
10995 @i{remote} publishing facilities of Org-mode which rely heavily on
10996 Tramp. Tramp, while very useful and powerful, tends not to be
10997 so efficient for multiple file transfer and has been known to cause problems
11000 Specialized synchronization utilities offer several advantages. In addition
11001 to timestamp comparison, they also do content and permissions/attribute
11002 checks. For this reason you might prefer to publish your web to a local
11003 directory (possibly even @i{in place} with your Org files) and then use
11004 @file{unison} or @file{rsync} to do the synchronization with the remote host.
11006 Since Unison (for example) can be configured as to which files to transfer to
11007 a certain remote destination, it can greatly simplify the project publishing
11008 definition. Simply keep all files in the correct location, process your Org
11009 files with @code{org-publish} and let the synchronization tool do the rest.
11010 You do not need, in this scenario, to include attachments such as @file{jpg},
11011 @file{css} or @file{gif} files in the project definition since the 3rd party
11014 Publishing to a local directory is also much faster than to a remote one, so
11015 that you can afford more easily to republish entire projects. If you set
11016 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
11017 benefit of re-including any changed external files such as source example
11018 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
11019 Org is not smart enough to detect if included files have been modified.
11021 @node Sample configuration, Triggering publication, Uploading files, Publishing
11022 @section Sample configuration
11024 Below we provide two example configurations. The first one is a simple
11025 project publishing only a set of Org files. The second example is
11026 more complex, with a multi-component project.
11029 * Simple example:: One-component publishing
11030 * Complex example:: A multi-component publishing example
11033 @node Simple example, Complex example, Sample configuration, Sample configuration
11034 @subsection Example: simple publishing configuration
11036 This example publishes a set of Org files to the @file{public_html}
11037 directory on the local machine.
11040 (setq org-publish-project-alist
11042 :base-directory "~/org/"
11043 :publishing-directory "~/public_html"
11044 :section-numbers nil
11045 :table-of-contents nil
11046 :style "<link rel=\"stylesheet\"
11047 href=\"../other/mystyle.css\"
11048 type=\"text/css\"/>")))
11051 @node Complex example, , Simple example, Sample configuration
11052 @subsection Example: complex publishing configuration
11054 This more complicated example publishes an entire website, including
11055 Org files converted to HTML, image files, Emacs Lisp source code, and
11056 style sheets. The publishing directory is remote and private files are
11059 To ensure that links are preserved, care should be taken to replicate
11060 your directory structure on the web server, and to use relative file
11061 paths. For example, if your Org files are kept in @file{~/org} and your
11062 publishable images in @file{~/images}, you would link to an image with
11065 file:../images/myimage.png
11068 On the web server, the relative path to the image should be the
11069 same. You can accomplish this by setting up an "images" folder in the
11070 right place on the web server, and publishing images to it.
11073 (setq org-publish-project-alist
11075 :base-directory "~/org/"
11076 :base-extension "org"
11077 :publishing-directory "/ssh:user@@host:~/html/notebook/"
11078 :publishing-function org-publish-org-to-html
11079 :exclude "PrivatePage.org" ;; regexp
11081 :section-numbers nil
11082 :table-of-contents nil
11083 :style "<link rel=\"stylesheet\"
11084 href=\"../other/mystyle.css\" type=\"text/css\"/>"
11086 :auto-postamble nil)
11089 :base-directory "~/images/"
11090 :base-extension "jpg\\|gif\\|png"
11091 :publishing-directory "/ssh:user@@host:~/html/images/"
11092 :publishing-function org-publish-attachment)
11095 :base-directory "~/other/"
11096 :base-extension "css\\|el"
11097 :publishing-directory "/ssh:user@@host:~/html/other/"
11098 :publishing-function org-publish-attachment)
11099 ("website" :components ("orgfiles" "images" "other"))))
11102 @node Triggering publication, , Sample configuration, Publishing
11103 @section Triggering publication
11105 Once properly configured, Org can publish with the following commands:
11108 @orgcmd{C-c C-e X,org-publish}
11109 Prompt for a specific project and publish all files that belong to it.
11110 @orgcmd{C-c C-e P,org-publish-current-project}
11111 Publish the project containing the current file.
11112 @orgcmd{C-c C-e F,org-publish-current-file}
11113 Publish only the current file.
11114 @orgcmd{C-c C-e E,org-publish-all}
11115 Publish every project.
11118 @vindex org-publish-use-timestamps-flag
11119 Org uses timestamps to track when a file has changed. The above functions
11120 normally only publish changed files. You can override this and force
11121 publishing of all files by giving a prefix argument to any of the commands
11122 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
11123 This may be necessary in particular if files include other files via
11124 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
11126 @comment node-name, next, previous, up
11127 @comment Working With Source Code, Miscellaneous, Publishing, Top
11129 @node Working With Source Code, Miscellaneous, Publishing, Top
11130 @chapter Working with source code
11131 @cindex Schulte, Eric
11132 @cindex Davison, Dan
11133 @cindex source code, working with
11135 Source code can be included in Org-mode documents using a @samp{src} block,
11139 #+BEGIN_SRC emacs-lisp
11140 (defun org-xor (a b)
11146 Org-mode provides a number of features for working with live source code,
11147 including editing of code blocks in their native major-mode, evaluation of
11148 code blocks, tangling of code blocks, and exporting code blocks and their
11149 results in several formats. This functionality was contributed by Eric
11150 Schulte and Dan Davison, and was originally named Org-babel.
11152 The following sections describe Org-mode's code block handling facilities.
11155 * Structure of code blocks:: Code block syntax described
11156 * Editing source code:: Language major-mode editing
11157 * Exporting code blocks:: Export contents and/or results
11158 * Extracting source code:: Create pure source code files
11159 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
11160 * Library of Babel:: Use and contribute to a library of useful code blocks
11161 * Languages:: List of supported code block languages
11162 * Header arguments:: Configure code block functionality
11163 * Results of evaluation:: How evaluation results are handled
11164 * Noweb reference syntax:: Literate programming in Org-mode
11165 * Key bindings and useful functions:: Work quickly with code blocks
11166 * Batch execution:: Call functions from the command line
11169 @comment node-name, next, previous, up
11170 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11172 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11173 @section Structure of code blocks
11174 @cindex code block, structure
11175 @cindex source code, block structure
11177 The structure of code blocks is as follows:
11181 #+begin_src <language> <switches> <header arguments>
11186 Switches and header arguments are optional. Code can also be embedded in text
11190 src_<language>@{<body>@}
11196 src_<language>[<header arguments>]@{<body>@}
11201 This name is associated with the code block. This is similar to the
11202 @samp{#+tblname} lines that can be used to name tables in Org-mode files.
11203 Referencing the name of a code block makes it possible to evaluate the
11204 block from other places in the file, other files, or from Org-mode table
11205 formulas (see @ref{The spreadsheet}).
11207 The language of the code in the block.
11209 Optional switches controlling exportation of the code block (see switches discussion in
11210 @ref{Literal examples})
11211 @item <header arguments>
11212 Optional header arguments control many aspects of evaluation, export and
11213 tangling of code blocks. See the @ref{Header arguments}
11214 section. Header arguments can also be set on a per-buffer or per-subtree
11215 basis using properties.
11220 @comment node-name, next, previous, up
11221 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11223 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11224 @section Editing source code
11225 @cindex code block, editing
11226 @cindex source code, editing
11229 Use @kbd{C-c '} to edit the current code block. This brings up
11230 a language major-mode edit buffer containing the body of the code
11231 block. Saving this buffer will write the new contents back to the Org
11232 buffer. Use @kbd{C-c '} again to exit.
11234 The @code{org-src-mode} minor mode will be active in the edit buffer. The
11235 following variables can be used to configure the behavior of the edit
11236 buffer. See also the customization group @code{org-edit-structure} for
11237 further configuration options.
11240 @item org-src-lang-modes
11241 If an Emacs major-mode named @code{<lang>-mode} exists, where
11242 @code{<lang>} is the language named in the header line of the code block,
11243 then the edit buffer will be placed in that major-mode. This variable
11244 can be used to map arbitrary language names to existing major modes.
11245 @item org-src-window-setup
11246 Controls the way Emacs windows are rearranged when the edit buffer is created.
11247 @item org-src-preserve-indentation
11248 This variable is especially useful for tangling languages such as
11249 Python, in which whitespace indentation in the output is critical.
11250 @item org-src-ask-before-returning-to-edit-buffer
11251 By default, Org will ask before returning to an open edit buffer. Set
11252 this variable to nil to switch without asking.
11255 To turn on native code fontification in the @emph{Org} buffer, configure the
11256 variable @code{org-src-fontify-natively}.
11258 @comment node-name, next, previous, up
11259 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11261 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11262 @section Exporting code blocks
11263 @cindex code block, exporting
11264 @cindex source code, exporting
11266 It is possible to export the @emph{contents} of code blocks, the
11267 @emph{results} of code block evaluation, @emph{neither}, or @emph{both}. For
11268 most languages, the default exports the contents of code blocks. However, for
11269 some languages (e.g. @code{ditaa}) the default exports the results of code
11270 block evaluation. For information on exporting code block bodies, see
11271 @ref{Literal examples}.
11273 The @code{:exports} header argument can be used to specify export
11276 @subsubheading Header arguments:
11278 @item :exports code
11279 The default in most languages. The body of the code block is exported, as
11280 described in @ref{Literal examples}.
11281 @item :exports results
11282 The code block will be evaluated and the results will be placed in the
11283 Org-mode buffer for export, either updating previous results of the code
11284 block located anywhere in the buffer or, if no previous results exist,
11285 placing the results immediately after the code block. The body of the code
11286 block will not be exported.
11287 @item :exports both
11288 Both the code block and its results will be exported.
11289 @item :exports none
11290 Neither the code block nor its results will be exported.
11293 It is possible to inhibit the evaluation of code blocks during export.
11294 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
11295 ensure that no code blocks are evaluated as part of the export process. This
11296 can be useful in situations where potentially untrusted Org-mode files are
11297 exported in an automated fashion, for example when Org-mode is used as the
11298 markup language for a wiki.
11300 @comment node-name, next, previous, up
11301 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11302 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11303 @section Extracting source code
11304 @cindex source code, extracting
11305 @cindex code block, extracting source code
11307 Creating pure source code files by extracting code from source blocks is
11308 referred to as ``tangling''---a term adopted from the literate programming
11309 community. During ``tangling'' of code blocks their bodies are expanded
11310 using @code{org-babel-expand-src-block} which can expand both variable and
11311 ``noweb'' style references (see @ref{Noweb reference syntax}).
11313 @subsubheading Header arguments
11316 The default. The code block is not included in the tangled output.
11318 Include the code block in the tangled output. The output file name is the
11319 name of the org file with the extension @samp{.org} replaced by the extension
11320 for the block language.
11321 @item :tangle filename
11322 Include the code block in the tangled output to file @samp{filename}.
11326 @subsubheading Functions
11328 @item org-babel-tangle
11329 Tangle the current file. Bound to @kbd{C-c C-v t}.
11330 @item org-babel-tangle-file
11331 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
11334 @subsubheading Hooks
11336 @item org-babel-post-tangle-hook
11337 This hook is run from within code files tangled by @code{org-babel-tangle}.
11338 Example applications could include post-processing, compilation or evaluation
11339 of tangled code files.
11342 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
11343 @section Evaluating code blocks
11344 @cindex code block, evaluating
11345 @cindex source code, evaluating
11347 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
11348 potential for that code to do harm. Org-mode provides a number of safeguards
11349 to ensure that it only evaluates code with explicit confirmation from the
11350 user. For information on these safeguards (and on how to disable them) see
11351 @ref{Code evaluation security}.} and the results placed in the Org-mode
11352 buffer. By default, evaluation is only turned on for @code{emacs-lisp} code
11353 blocks, however support exists for evaluating blocks in many languages. See
11354 @ref{Languages} for a list of supported languages. See @ref{Structure of
11355 code blocks} for information on the syntax used to define a code block.
11358 There are a number of ways to evaluate code blocks. The simplest is to press
11359 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
11360 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
11361 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
11362 @code{org-babel-execute-src-block} function to evaluate the block and insert
11363 its results into the Org-mode buffer.
11365 It is also possible to evaluate named code blocks from anywhere in an
11366 Org-mode buffer or an Org-mode table. @code{#+call} (or synonymously
11367 @code{#+function} or @code{#+lob}) lines can be used to remotely execute code
11368 blocks located in the current Org-mode buffer or in the ``Library of Babel''
11369 (see @ref{Library of Babel}). These lines use the following syntax.
11372 #+call: <name>(<arguments>) <header arguments>
11373 #+function: <name>(<arguments>) <header arguments>
11374 #+lob: <name>(<arguments>) <header arguments>
11379 The name of the code block to be evaluated.
11381 Arguments specified in this section will be passed to the code block.
11382 @item <header arguments>
11383 Header arguments can be placed after the function invocation. See
11384 @ref{Header arguments} for more information on header arguments.
11388 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
11389 @section Library of Babel
11390 @cindex babel, library of
11391 @cindex source code, library
11392 @cindex code block, library
11394 The ``Library of Babel'' is a library of code blocks
11395 that can be called from any Org-mode file. The library is housed in an
11396 Org-mode file located in the @samp{contrib} directory of Org-mode.
11397 Org-mode users can deposit functions they believe to be generally
11398 useful in the library.
11400 Code blocks defined in the ``Library of Babel'' can be called remotely as if
11401 they were in the current Org-mode buffer (see @ref{Evaluating code blocks}
11402 for information on the syntax of remote code block evaluation).
11405 Code blocks located in any Org-mode file can be loaded into the ``Library of
11406 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
11409 @node Languages, Header arguments, Library of Babel, Working With Source Code
11411 @cindex babel, languages
11412 @cindex source code, languages
11413 @cindex code block, languages
11415 Code blocks in the following languages are supported.
11417 @multitable @columnfractions 0.28 0.3 0.22 0.2
11418 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
11419 @item Asymptote @tab asymptote @tab C @tab C
11420 @item C++ @tab C++ @tab Clojure @tab clojure
11421 @item CSS @tab css @tab ditaa @tab ditaa
11422 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
11423 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
11424 @item LaTeX @tab latex @tab MATLAB @tab matlab
11425 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
11426 @item Octave @tab octave @tab Oz @tab oz
11427 @item Perl @tab perl @tab Python @tab python
11428 @item R @tab R @tab Ruby @tab ruby
11429 @item Sass @tab sass @tab GNU Screen @tab screen
11430 @item shell @tab sh @tab SQL @tab sql
11431 @item SQLite @tab sqlite
11434 Language-specific documentation is available for some languages. If
11435 available, it can be found at
11436 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
11438 The @code{org-babel-load-languages} controls which languages are enabled for
11439 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
11440 be set using the customization interface or by adding code like the following
11441 to your emacs configuration.
11444 The following disables @code{emacs-lisp} evaluation and enables evaluation of
11445 @code{R} code blocks.
11449 (org-babel-do-load-languages
11450 'org-babel-load-languages
11451 '((emacs-lisp . nil)
11455 It is also possible to enable support for a language by loading the related
11456 elisp file with @code{require}.
11459 The following adds support for evaluating @code{clojure} code blocks.
11463 (require 'ob-clojure)
11466 @node Header arguments, Results of evaluation, Languages, Working With Source Code
11467 @section Header arguments
11468 @cindex code block, header arguments
11469 @cindex source code, block header arguments
11471 Code block functionality can be configured with header arguments. This
11472 section provides an overview of the use of header arguments, and then
11473 describes each header argument in detail.
11476 * Using header arguments:: Different ways to set header arguments
11477 * Specific header arguments:: List of header arguments
11480 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
11481 @subsection Using header arguments
11483 The values of header arguments can be set in six different ways, each more
11484 specific (and having higher priority) than the last.
11486 * System-wide header arguments:: Set global default values
11487 * Language-specific header arguments:: Set default values by language
11488 * Buffer-wide header arguments:: Set default values for a specific buffer
11489 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
11490 * Code block specific header arguments:: The most common way to set values
11491 * Header arguments in function calls:: The most specific level
11495 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
11496 @subsubheading System-wide header arguments
11497 @vindex org-babel-default-header-args
11498 System-wide values of header arguments can be specified by customizing the
11499 @code{org-babel-default-header-args} variable:
11503 :results => "replace"
11510 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
11512 @c ((:session . "none")
11513 @c (:results . "replace")
11514 @c (:exports . "code")
11516 @c (:noweb . "no"))
11520 @c Default arguments to use when evaluating a code block.
11523 For example, the following example could be used to set the default value of
11524 @code{:noweb} header arguments to @code{yes}. This would have the effect of
11525 expanding @code{:noweb} references by default when evaluating source code
11529 (setq org-babel-default-header-args
11530 (cons '(:noweb . "yes")
11531 (assq-delete-all :noweb org-babel-default-header-args)))
11534 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
11535 @subsubheading Language-specific header arguments
11536 Each language can define its own set of default header arguments. See the
11537 language-specific documentation available online at
11538 @uref{http://orgmode.org/worg/org-contrib/babel}.
11540 @node Buffer-wide header arguments, Header arguments in Org-mode properties, Language-specific header arguments, Using header arguments
11541 @subsubheading Buffer-wide header arguments
11542 Buffer-wide header arguments may be specified through the use of a special
11543 line placed anywhere in an Org-mode file. The line consists of the
11544 @code{#+BABEL:} keyword followed by a series of header arguments which may be
11545 specified using the standard header argument syntax.
11547 For example the following would set @code{session} to @code{*R*}, and
11548 @code{results} to @code{silent} for every code block in the buffer, ensuring
11549 that all execution took place in the same session, and no results would be
11550 inserted into the buffer.
11553 #+BABEL: :session *R* :results silent
11556 @node Header arguments in Org-mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
11557 @subsubheading Header arguments in Org-mode properties
11559 Header arguments are also read from Org-mode properties (see @ref{Property
11560 syntax}), which can be set on a buffer-wide or per-heading basis. An example
11561 of setting a header argument for all code blocks in a buffer is
11564 #+property: tangle yes
11567 When properties are used to set default header arguments, they are looked up
11568 with inheritance, so the value of the @code{:cache} header argument will default
11569 to @code{yes} in all code blocks in the subtree rooted at the following
11580 @vindex org-babel-default-header-args
11581 Properties defined in this way override the properties set in
11582 @code{org-babel-default-header-args}. It is convenient to use the
11583 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
11584 in Org-mode documents.
11586 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org-mode properties, Using header arguments
11587 @subsubheading Code block specific header arguments
11589 The most common way to assign values to header arguments is at the
11590 code block level. This can be done by listing a sequence of header
11591 arguments and their values as part of the @code{#+begin_src} line.
11592 Properties set in this way override both the values of
11593 @code{org-babel-default-header-args} and header arguments specified as
11594 properties. In the following example, the @code{:results} header argument
11595 is set to @code{silent}, meaning the results of execution will not be
11596 inserted in the buffer, and the @code{:exports} header argument is set to
11597 @code{code}, meaning only the body of the code block will be
11598 preserved on export to HTML or LaTeX.
11601 #+source: factorial
11602 #+begin_src haskell :results silent :exports code :var n=0
11604 fac n = n * fac (n-1)
11607 Similarly, it is possible to set header arguments for inline code blocks:
11610 src_haskell[:exports both]@{fac 5@}
11613 Code block header arguments can span multiple lines using =#+header:= or
11614 =#+headers:= lines preceding a code block or nested in between the name and
11615 body of a named code block.
11617 Multi-line header arguments on an un-named code block:
11619 #+headers: :var data1=1
11620 #+begin_src emacs-lisp :var data2=2
11621 (message "data1:%S, data2:%S" data1 data2)
11628 Multi-line header arguments on a named code block:
11630 #+source: named-block
11631 #+header: :var data=2
11632 #+begin_src emacs-lisp
11633 (message "data:%S" data)
11636 #+results: named-block
11640 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
11641 @comment node-name, next, previous, up
11642 @subsubheading Header arguments in function calls
11644 At the most specific level, header arguments for ``Library of Babel'' or
11645 function call lines can be set as shown below:
11648 #+call: factorial(n=5) :exports results
11651 @node Specific header arguments, , Using header arguments, Header arguments
11652 @subsection Specific header arguments
11653 The following header arguments are defined:
11656 * var:: Pass arguments to code blocks
11657 * results:: Specify the type of results and how they will
11658 be collected and handled
11659 * file:: Specify a path for file output
11660 * dir:: Specify the default (possibly remote)
11661 directory for code block execution
11662 * exports:: Export code and/or results
11663 * tangle:: Toggle tangling and specify file name
11664 * comments:: Toggle insertion of comments in tangled
11666 * no-expand:: Turn off variable assignment and noweb
11667 expansion during tangling
11668 * session:: Preserve the state of code evaluation
11669 * noweb:: Toggle expansion of noweb references
11670 * cache:: Avoid re-evaluating unchanged code blocks
11671 * sep:: Delimiter for writing tabular results outside Org
11672 * hlines:: Handle horizontal lines in tables
11673 * colnames:: Handle column names in tables
11674 * rownames:: Handle row names in tables
11675 * shebang:: Make tangled files executable
11676 * eval:: Limit evaluation of specific code blocks
11679 @node var, results, Specific header arguments, Specific header arguments
11680 @subsubsection @code{:var}
11681 The @code{:var} header argument is used to pass arguments to code blocks.
11682 The specifics of how arguments are included in a code block vary by language;
11683 these are addressed in the language-specific documentation. However, the
11684 syntax used to specify arguments is the same across all languages. The
11685 values passed to arguments can be literal values, values from org-mode tables
11686 and literal example blocks, or the results of other code blocks.
11688 These values can be indexed in a manner similar to arrays---see the
11689 ``indexable variable values'' heading below.
11691 The following syntax is used to pass arguments to code blocks using the
11692 @code{:var} header argument.
11698 where @code{assign} can take one of the following forms
11701 @item literal value
11702 either a string @code{"string"} or a number @code{9}.
11707 #+tblname: example-table
11713 #+source: table-length
11714 #+begin_src emacs-lisp :var table=example-table
11718 #+results: table-length
11722 a code block name, as assigned by @code{#+srcname:}, followed by
11726 #+begin_src emacs-lisp :var length=table-length()
11734 In addition, an argument can be passed to the code block referenced
11735 by @code{:var}. The argument is passed within the parentheses following the
11740 #+begin_src emacs-lisp :var input=8
11748 #+begin_src emacs-lisp :var input=double(input=1)
11757 @subsubheading Alternate argument syntax
11758 It is also possible to specify arguments in a potentially more natural way
11759 using the @code{#+source:} line of a code block. As in the following
11760 example arguments can be packed inside of parenthesis, separated by commas,
11761 following the source name.
11764 #+source: double(input=0, x=2)
11765 #+begin_src emacs-lisp
11770 @subsubheading Indexable variable values
11771 It is possible to reference portions of variable values by ``indexing'' into
11772 the variables. Indexes are 0 based with negative values counting back from
11773 the end. If an index is separated by @code{,}s then each subsequent section
11774 will index into the next deepest nesting or dimension of the value. The
11775 following example assigns the last cell of the first row the table
11776 @code{example-table} to the variable @code{data}:
11779 #+results: example-table
11785 #+begin_src emacs-lisp :var data=example-table[0,-1]
11793 Ranges of variable values can be referenced using two integers separated by a
11794 @code{:}, in which case the entire inclusive range is referenced. For
11795 example the following assigns the middle three rows of @code{example-table}
11799 #+results: example-table
11806 #+begin_src emacs-lisp :var data=example-table[1:3]
11816 Additionally, an empty index, or the single character @code{*}, are both
11817 interpreted to mean the entire range and as such are equivalent to
11818 @code{0:-1}, as shown in the following example in which the entire first
11819 column is referenced.
11822 #+results: example-table
11828 #+begin_src emacs-lisp :var data=example-table[,0]
11836 It is possible to index into the results of code blocks as well as tables.
11837 Any number of dimensions can be indexed. Dimensions are separated from one
11838 another by commas, as shown in the following example.
11842 #+begin_src emacs-lisp
11843 '(((1 2 3) (4 5 6) (7 8 9))
11844 ((10 11 12) (13 14 15) (16 17 18))
11845 ((19 20 21) (22 23 24) (25 26 27)))
11848 #+begin_src emacs-lisp :var data=3D[1,,1]
11856 @node results, file, var, Specific header arguments
11857 @subsubsection @code{:results}
11859 There are three classes of @code{:results} header argument. Only one option
11860 per class may be supplied per code block.
11864 @b{collection} header arguments specify how the results should be collected
11865 from the code block
11867 @b{type} header arguments specify what type of result the code block will
11868 return---which has implications for how they will be inserted into the
11871 @b{handling} header arguments specify how the results of evaluating the code
11872 block should be handled.
11875 @subsubheading Collection
11876 The following options are mutually exclusive, and specify how the results
11877 should be collected from the code block.
11881 This is the default. The result is the value of the last statement in the
11882 code block. This header argument places the evaluation in functional
11883 mode. Note that in some languages, e.g., Python, use of this result type
11884 requires that a @code{return} statement be included in the body of the source
11885 code block. E.g., @code{:results value}.
11886 @item @code{output}
11887 The result is the collection of everything printed to STDOUT during the
11888 execution of the code block. This header argument places the
11889 evaluation in scripting mode. E.g., @code{:results output}.
11892 @subsubheading Type
11894 The following options are mutually exclusive and specify what type of results
11895 the code block will return. By default, results are inserted as either a
11896 table or scalar depending on their value.
11899 @item @code{table}, @code{vector}
11900 The results should be interpreted as an Org-mode table. If a single value is
11901 returned, it will be converted into a table with one row and one column.
11902 E.g., @code{:results value table}.
11904 The results should be interpreted as an Org-mode list. If a single scalar
11905 value is returned it will be converted into a list with only one element.
11906 @item @code{scalar}, @code{verbatim}
11907 The results should be interpreted literally---they will not be
11908 converted into a table. The results will be inserted into the Org-mode
11909 buffer as quoted text. E.g., @code{:results value verbatim}.
11911 The results will be interpreted as the path to a file, and will be inserted
11912 into the Org-mode buffer as a file link. E.g., @code{:results value file}.
11913 @item @code{raw}, @code{org}
11914 The results are interpreted as raw Org-mode code and are inserted directly
11915 into the buffer. If the results look like a table they will be aligned as
11916 such by Org-mode. E.g., @code{:results value raw}.
11918 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
11919 block. E.g., @code{:results value html}.
11921 Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block.
11922 E.g., @code{:results value latex}.
11924 Result are assumed to be parseable code and are enclosed in a code block.
11925 E.g., @code{:results value code}.
11927 The result is converted to pretty-printed code and is enclosed in a code
11928 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
11929 @code{:results value pp}.
11932 @subsubheading Handling
11933 The following results options indicate what happens with the
11934 results once they are collected.
11937 @item @code{silent}
11938 The results will be echoed in the minibuffer but will not be inserted into
11939 the Org-mode buffer. E.g., @code{:results output silent}.
11940 @item @code{replace}
11941 The default value. Any existing results will be removed, and the new results
11942 will be inserted into the Org-mode buffer in their place. E.g.,
11943 @code{:results output replace}.
11944 @item @code{append}
11945 If there are pre-existing results of the code block then the new results will
11946 be appended to the existing results. Otherwise the new results will be
11947 inserted as with @code{replace}.
11948 @item @code{prepend}
11949 If there are pre-existing results of the code block then the new results will
11950 be prepended to the existing results. Otherwise the new results will be
11951 inserted as with @code{replace}.
11954 @node file, dir, results, Specific header arguments
11955 @subsubsection @code{:file}
11957 The header argument @code{:file} is used to specify an external file in which
11958 to save code block results. After code block evaluation an Org-mode style
11959 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
11960 into the Org-mode buffer. Some languages including R, gnuplot, dot, and
11961 ditaa provide special handling of the @code{:file} header argument
11962 automatically wrapping the code block body in the boilerplate code required
11963 to save output to the specified file. This is often useful for saving
11964 graphical output of a code block to the specified file.
11966 The argument to @code{:file} should be either a string specifying the path to
11967 a file, or a list of two strings in which case the first element of the list
11968 should be the path to a file and the second a description for the link.
11970 @node dir, exports, file, Specific header arguments
11971 @subsubsection @code{:dir} and remote execution
11973 While the @code{:file} header argument can be used to specify the path to the
11974 output file, @code{:dir} specifies the default directory during code block
11975 execution. If it is absent, then the directory associated with the current
11976 buffer is used. In other words, supplying @code{:dir path} temporarily has
11977 the same effect as changing the current directory with @kbd{M-x cd path}, and
11978 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
11979 the value of the Emacs variable @code{default-directory}.
11981 When using @code{:dir}, you should supply a relative path for file output
11982 (e.g. @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
11983 case that path will be interpreted relative to the default directory.
11985 In other words, if you want your plot to go into a folder called @file{Work}
11986 in your home directory, you could use
11989 #+begin_src R :file myplot.png :dir ~/Work
11990 matplot(matrix(rnorm(100), 10), type="l")
11994 @subsubheading Remote execution
11995 A directory on a remote machine can be specified using tramp file syntax, in
11996 which case the code will be evaluated on the remote machine. An example is
11999 #+begin_src R :file plot.png :dir /dand@@yakuba.princeton.edu:
12000 plot(1:10, main=system("hostname", intern=TRUE))
12004 Text results will be returned to the local Org-mode buffer as usual, and file
12005 output will be created on the remote machine with relative paths interpreted
12006 relative to the remote directory. An Org-mode link to the remote file will be
12009 So, in the above example a plot will be created on the remote machine,
12010 and a link of the following form will be inserted in the org buffer:
12013 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
12016 Most of this functionality follows immediately from the fact that @code{:dir}
12017 sets the value of the Emacs variable @code{default-directory}, thanks to
12018 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
12019 install tramp separately in order for these features to work correctly.
12021 @subsubheading Further points
12025 If @code{:dir} is used in conjunction with @code{:session}, although it will
12026 determine the starting directory for a new session as expected, no attempt is
12027 currently made to alter the directory associated with an existing session.
12029 @code{:dir} should typically not be used to create files during export with
12030 @code{:exports results} or @code{:exports both}. The reason is that, in order
12031 to retain portability of exported material between machines, during export
12032 links inserted into the buffer will *not* be expanded against @code{default
12033 directory}. Therefore, if @code{default-directory} is altered using
12034 @code{:dir}, it is probable that the file will be created in a location to
12035 which the link does not point.
12038 @node exports, tangle, dir, Specific header arguments
12039 @subsubsection @code{:exports}
12041 The @code{:exports} header argument specifies what should be included in HTML
12042 or LaTeX exports of the Org-mode file.
12046 The default. The body of code is included into the exported file. E.g.,
12047 @code{:exports code}.
12048 @item @code{results}
12049 The result of evaluating the code is included in the exported file. E.g.,
12050 @code{:exports results}.
12052 Both the code and results are included in the exported file. E.g.,
12053 @code{:exports both}.
12055 Nothing is included in the exported file. E.g., @code{:exports none}.
12058 @node tangle, comments, exports, Specific header arguments
12059 @subsubsection @code{:tangle}
12061 The @code{:tangle} header argument specifies whether or not the code
12062 block should be included in tangled extraction of source code files.
12065 @item @code{tangle}
12066 The code block is exported to a source code file named after the
12067 basename (name w/o extension) of the Org-mode file. E.g., @code{:tangle
12070 The default. The code block is not exported to a source code file.
12071 E.g., @code{:tangle no}.
12073 Any other string passed to the @code{:tangle} header argument is interpreted
12074 as a file basename to which the block will be exported. E.g., @code{:tangle
12078 @node comments, no-expand, tangle, Specific header arguments
12079 @subsubsection @code{:comments}
12080 By default code blocks are tangled to source-code files without any insertion
12081 of comments beyond those which may already exist in the body of the code
12082 block. The @code{:comments} header argument can be set as follows to control
12083 the insertion of extra comments into the tangled code file.
12087 The default. No extra comments are inserted during tangling.
12089 The code block is wrapped in comments which contain pointers back to the
12090 original Org file from which the code was tangled.
12092 A synonym for ``link'' to maintain backwards compatibility.
12094 Include text from the org-mode file as a comment.
12096 The text is picked from the leading context of the tangled code and is
12097 limited by the nearest headline or source block as the case may be.
12099 Turns on both the ``link'' and ``org'' comment options.
12102 @node no-expand, session, comments, Specific header arguments
12103 @subsubsection @code{:no-expand}
12105 By default, code blocks are expanded with @code{org-babel-expand-src-block}
12106 during tangling. This has the effect of assigning values to variables
12107 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
12108 references (see @ref{Noweb reference syntax}) with their targets. The
12109 @code{:no-expand} header argument can be used to turn off this behavior.
12111 @node session, noweb, no-expand, Specific header arguments
12112 @subsubsection @code{:session}
12114 The @code{:session} header argument starts a session for an interpreted
12115 language where state is preserved.
12117 By default, a session is not started.
12119 A string passed to the @code{:session} header argument will give the session
12120 a name. This makes it possible to run concurrent sessions for each
12121 interpreted language.
12123 @node noweb, cache, session, Specific header arguments
12124 @subsubsection @code{:noweb}
12126 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
12127 @ref{Noweb reference syntax}) references in a code block. This header
12128 argument can have one of three values: @code{yes} @code{no} or @code{tangle}.
12132 All ``noweb'' syntax references in the body of the code block will be
12133 expanded before the block is evaluated, tangled or exported.
12135 The default. No ``noweb'' syntax specific action is taken on evaluating
12136 code blocks, However, noweb references will still be expanded during
12138 @item @code{tangle}
12139 All ``noweb'' syntax references in the body of the code block will be
12140 expanded before the block is tangled, however ``noweb'' references will not
12141 be expanded when the block is evaluated or exported.
12144 @subsubheading Noweb prefix lines
12145 Noweb insertions are now placed behind the line prefix of the
12146 @code{<<reference>>}.
12147 This behavior is illustrated in the following example. Because the
12148 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
12149 each line of the expanded noweb reference will be commented.
12162 -- multi-line body of example
12165 Note that noweb replacement text that does not contain any newlines will not
12166 be affected by this change, so it is still possible to use inline noweb
12169 @node cache, sep, noweb, Specific header arguments
12170 @subsubsection @code{:cache}
12172 The @code{:cache} header argument controls the use of in-buffer caching of
12173 the results of evaluating code blocks. It can be used to avoid re-evaluating
12174 unchanged code blocks. This header argument can have one of two
12175 values: @code{yes} or @code{no}.
12179 The default. No caching takes place, and the code block will be evaluated
12180 every time it is called.
12182 Every time the code block is run a SHA1 hash of the code and arguments
12183 passed to the block will be generated. This hash is packed into the
12184 @code{#+results:} line and will be checked on subsequent
12185 executions of the code block. If the code block has not
12186 changed since the last time it was evaluated, it will not be re-evaluated.
12189 Code block caches notice if the value of a variable argument
12190 to the code block has changed. If this is the case, the cache is
12191 invalidated and the code block is re-run. In the following example,
12192 @code{caller} will not be re-run unless the results of @code{random} have
12193 changed since it was last run.
12197 #+begin_src R :cache yes
12201 #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
12205 #+begin_src emacs-lisp :var x=random :cache yes
12209 #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
12213 @node sep, hlines, cache, Specific header arguments
12214 @subsubsection @code{:sep}
12216 The @code{:sep} header argument can be used to control the delimiter used
12217 when writing tabular results out to files external to Org-mode. This is used
12218 either when opening tabular results of a code block by calling the
12219 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
12220 or when writing code block results to an external file (see @ref{file})
12223 By default, when @code{:sep} is not specified output tables are tab
12226 @node hlines, colnames, sep, Specific header arguments
12227 @subsubsection @code{:hlines}
12229 Tables are frequently represented with one or more horizontal lines, or
12230 hlines. The @code{:hlines} argument to a code block accepts the
12231 values @code{yes} or @code{no}, with a default value of @code{no}.
12235 Strips horizontal lines from the input table. In most languages this is the
12236 desired effect because an @code{hline} symbol is interpreted as an unbound
12237 variable and raises an error. Setting @code{:hlines no} or relying on the
12238 default value yields the following results.
12241 #+tblname: many-cols
12248 #+source: echo-table
12249 #+begin_src python :var tab=many-cols
12253 #+results: echo-table
12260 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
12263 #+tblname: many-cols
12270 #+source: echo-table
12271 #+begin_src python :var tab=many-cols :hlines yes
12275 #+results: echo-table
12284 @node colnames, rownames, hlines, Specific header arguments
12285 @subsubsection @code{:colnames}
12287 The @code{:colnames} header argument accepts the values @code{yes},
12288 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
12292 If an input table looks like it has column names
12293 (because its second row is an hline), then the column
12294 names will be removed from the table before
12295 processing, then reapplied to the results.
12298 #+tblname: less-cols
12304 #+srcname: echo-table-again
12305 #+begin_src python :var tab=less-cols
12306 return [[val + '*' for val in row] for row in tab]
12309 #+results: echo-table-again
12317 No column name pre-processing takes place
12320 Column names are removed and reapplied as with @code{nil} even if the table
12321 does not ``look like'' it has column names (i.e. the second row is not an
12325 @node rownames, shebang, colnames, Specific header arguments
12326 @subsubsection @code{:rownames}
12328 The @code{:rownames} header argument can take on the values @code{yes}
12329 or @code{no}, with a default value of @code{no}.
12333 No row name pre-processing will take place.
12336 The first column of the table is removed from the table before processing,
12337 and is then reapplied to the results.
12340 #+tblname: with-rownames
12341 | one | 1 | 2 | 3 | 4 | 5 |
12342 | two | 6 | 7 | 8 | 9 | 10 |
12344 #+srcname: echo-table-once-again
12345 #+begin_src python :var tab=with-rownames :rownames yes
12346 return [[val + 10 for val in row] for row in tab]
12349 #+results: echo-table-once-again
12350 | one | 11 | 12 | 13 | 14 | 15 |
12351 | two | 16 | 17 | 18 | 19 | 20 |
12355 @node shebang, eval, rownames, Specific header arguments
12356 @subsubsection @code{:shebang}
12358 Setting the @code{:shebang} header argument to a string value
12359 (e.g. @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
12360 first line of any tangled file holding the code block, and the file
12361 permissions of the tangled file are set to make it executable.
12363 @node eval, , shebang, Specific header arguments
12364 @subsubsection @code{:eval}
12365 The @code{:eval} header argument can be used to limit the evaluation of
12366 specific code blocks. @code{:eval} accepts two arguments ``never'' and
12367 ``query''. @code{:eval never} will ensure that a code block is never
12368 evaluated, this can be useful for protecting against the evaluation of
12369 dangerous code blocks. @code{:eval query} will require a query for every
12370 execution of a code block regardless of the value of the
12371 @code{org-confirm-babel-evaluate} variable.
12373 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
12374 @section Results of evaluation
12375 @cindex code block, results of evaluation
12376 @cindex source code, results of evaluation
12378 The way in which results are handled depends on whether a session is invoked,
12379 as well as on whether @code{:results value} or @code{:results output} is
12380 used. The following table shows the possibilities:
12382 @multitable @columnfractions 0.26 0.33 0.41
12383 @item @tab @b{Non-session} @tab @b{Session}
12384 @item @code{:results value} @tab value of last expression @tab value of last expression
12385 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
12388 Note: With @code{:results value}, the result in both @code{:session} and
12389 non-session is returned to Org-mode as a table (a one- or two-dimensional
12390 vector of strings or numbers) when appropriate.
12392 @subsection Non-session
12393 @subsubsection @code{:results value}
12394 This is the default. Internally, the value is obtained by wrapping the code
12395 in a function definition in the external language, and evaluating that
12396 function. Therefore, code should be written as if it were the body of such a
12397 function. In particular, note that Python does not automatically return a
12398 value from a function unless a @code{return} statement is present, and so a
12399 @samp{return} statement will usually be required in Python.
12401 This is the only one of the four evaluation contexts in which the code is
12402 automatically wrapped in a function definition.
12404 @subsubsection @code{:results output}
12405 The code is passed to the interpreter as an external process, and the
12406 contents of the standard output stream are returned as text. (In certain
12407 languages this also contains the error output stream; this is an area for
12410 @subsection Session
12411 @subsubsection @code{:results value}
12412 The code is passed to the interpreter running as an interactive Emacs
12413 inferior process. The result returned is the result of the last evaluation
12414 performed by the interpreter. (This is obtained in a language-specific
12415 manner: the value of the variable @code{_} in Python and Ruby, and the value
12416 of @code{.Last.value} in R).
12418 @subsubsection @code{:results output}
12419 The code is passed to the interpreter running as an interactive Emacs
12420 inferior process. The result returned is the concatenation of the sequence of
12421 (text) output from the interactive interpreter. Notice that this is not
12422 necessarily the same as what would be sent to @code{STDOUT} if the same code
12423 were passed to a non-interactive interpreter running as an external
12424 process. For example, compare the following two blocks:
12427 #+begin_src python :results output
12438 In non-session mode, the `2' is not printed and does not appear.
12440 #+begin_src python :results output :session
12452 But in @code{:session} mode, the interactive interpreter receives input `2'
12453 and prints out its value, `2'. (Indeed, the other print statements are
12456 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
12457 @section Noweb reference syntax
12458 @cindex code block, noweb reference
12459 @cindex syntax, noweb
12460 @cindex source code, noweb reference
12462 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
12463 Programming system allows named blocks of code to be referenced by using the
12464 familiar Noweb syntax:
12467 <<code-block-name>>
12470 When a code block is tangled or evaluated, whether or not ``noweb''
12471 references are expanded depends upon the value of the @code{:noweb} header
12472 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
12473 evaluation. If @code{:noweb no}, the default, then the reference is not
12474 expanded before evaluation.
12476 Note: the default value, @code{:noweb no}, was chosen to ensure that
12477 correct code is not broken in a language, such as Ruby, where
12478 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
12479 syntactically valid in languages that you use, then please consider setting
12482 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
12483 @section Key bindings and useful functions
12484 @cindex code block, key bindings
12486 Many common Org-mode key sequences are re-bound depending on
12489 Within a code block, the following key bindings
12492 @multitable @columnfractions 0.25 0.75
12494 @item @kbd{C-c C-c} @tab org-babel-execute-src-block
12496 @item @kbd{C-c C-o} @tab org-babel-open-src-block-result
12498 @item @kbd{C-@key{up}} @tab org-babel-load-in-session
12500 @item @kbd{M-@key{down}} @tab org-babel-pop-to-session
12503 In an Org-mode buffer, the following key bindings are active:
12505 @multitable @columnfractions 0.45 0.55
12507 @kindex C-c C-v C-a
12508 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab org-babel-sha1-hash
12510 @kindex C-c C-v C-b
12511 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
12513 @kindex C-c C-v C-f
12514 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab org-babel-tangle-file
12516 @item @kbd{C-c C-v g} @tab org-babel-goto-named-source-block
12518 @item @kbd{C-c C-v h} @tab org-babel-describe-bindings
12520 @kindex C-c C-v C-l
12521 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
12523 @kindex C-c C-v C-p
12524 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
12526 @kindex C-c C-v C-s
12527 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
12529 @kindex C-c C-v C-t
12530 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab org-babel-tangle
12532 @kindex C-c C-v C-z
12533 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
12536 @c When possible these keybindings were extended to work when the control key is
12537 @c kept pressed, resulting in the following additional keybindings.
12539 @c @multitable @columnfractions 0.25 0.75
12540 @c @item @kbd{C-c C-v C-a} @tab org-babel-sha1-hash
12541 @c @item @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
12542 @c @item @kbd{C-c C-v C-f} @tab org-babel-tangle-file
12543 @c @item @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
12544 @c @item @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
12545 @c @item @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
12546 @c @item @kbd{C-c C-v C-t} @tab org-babel-tangle
12547 @c @item @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
12550 @node Batch execution, , Key bindings and useful functions, Working With Source Code
12551 @section Batch execution
12552 @cindex code block, batch execution
12553 @cindex source code, batch execution
12555 It is possible to call functions from the command line. This shell
12556 script calls @code{org-babel-tangle} on every one of its arguments.
12558 Be sure to adjust the paths to fit your system.
12562 # -*- mode: shell-script -*-
12564 # tangle files with org-mode
12568 ORGINSTALL="~/src/org/lisp/org-install.el"
12570 # wrap each argument in the code required to call tangle on it
12572 FILES="$FILES \"$i\""
12575 emacs -Q --batch -l $ORGINSTALL \
12577 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
12578 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
12579 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
12580 (mapc (lambda (file)
12581 (find-file (expand-file-name file \"$DIR\"))
12583 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
12586 @node Miscellaneous, Hacking, Working With Source Code, Top
12587 @chapter Miscellaneous
12590 * Completion:: M-TAB knows what you need
12591 * Easy Templates:: Quick insertion of structural elements
12592 * Speed keys:: Electric commands at the beginning of a headline
12593 * Code evaluation security:: Org mode files evaluate inline code
12594 * Customization:: Adapting Org to your taste
12595 * In-buffer settings:: Overview of the #+KEYWORDS
12596 * The very busy C-c C-c key:: When in doubt, press C-c C-c
12597 * Clean view:: Getting rid of leading stars in the outline
12598 * TTY keys:: Using Org on a tty
12599 * Interaction:: Other Emacs packages
12603 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
12604 @section Completion
12605 @cindex completion, of @TeX{} symbols
12606 @cindex completion, of TODO keywords
12607 @cindex completion, of dictionary words
12608 @cindex completion, of option keywords
12609 @cindex completion, of tags
12610 @cindex completion, of property keys
12611 @cindex completion, of link abbreviations
12612 @cindex @TeX{} symbol completion
12613 @cindex TODO keywords completion
12614 @cindex dictionary word completion
12615 @cindex option keyword completion
12616 @cindex tag completion
12617 @cindex link abbreviations, completion of
12619 Emacs would not be Emacs without completion, and Org-mode uses it whenever it
12620 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
12621 some of the completion prompts, you can specify your preference by setting at
12622 most one of the variables @code{org-completion-use-iswitchb}
12623 @code{org-completion-use-ido}.
12625 Org supports in-buffer completion. This type of completion does
12626 not make use of the minibuffer. You simply type a few letters into
12627 the buffer and use the key to complete text right there.
12630 @kindex M-@key{TAB}
12632 Complete word at point
12635 At the beginning of a headline, complete TODO keywords.
12637 After @samp{\}, complete @TeX{} symbols supported by the exporter.
12639 After @samp{*}, complete headlines in the current buffer so that they
12640 can be used in search links like @samp{[[*find this headline]]}.
12642 After @samp{:} in a headline, complete tags. The list of tags is taken
12643 from the variable @code{org-tag-alist} (possibly set through the
12644 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
12645 dynamically from all tags used in the current buffer.
12647 After @samp{:} and not in a headline, complete property keys. The list
12648 of keys is constructed dynamically from all keys used in the current
12651 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
12653 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
12654 @samp{OPTIONS} which set file-specific options for Org-mode. When the
12655 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
12656 will insert example settings for this keyword.
12658 In the line after @samp{#+STARTUP: }, complete startup keywords,
12659 i.e. valid keys for this line.
12661 Elsewhere, complete dictionary words using Ispell.
12665 @node Easy Templates, Speed keys, Completion, Miscellaneous
12666 @section Easy Templates
12667 @cindex template insertion
12668 @cindex insertion, of templates
12670 Org-mode supports insertion of empty structural elements (like
12671 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
12672 strokes. This is achieved through a native template expansion mechanism.
12673 Note that Emacs has several other template mechanisms which could be used in
12674 a similar way, for example @file{yasnippet}.
12676 To insert a structural element, type a @samp{<}, followed by a template
12677 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
12678 keystrokes are typed on a line by itself.
12680 The following template selectors are currently supported.
12682 @multitable @columnfractions 0.1 0.9
12683 @item @kbd{s} @tab @code{#+begin_src ... #+end_src}
12684 @item @kbd{e} @tab @code{#+begin_example ... #+end_example}
12685 @item @kbd{q} @tab @code{#+begin_quote ... #+end_quote}
12686 @item @kbd{v} @tab @code{#+begin_verse ... #+end_verse}
12687 @item @kbd{c} @tab @code{#+begin_center ... #+end_center}
12688 @item @kbd{l} @tab @code{#+begin_latex ... #+end_latex}
12689 @item @kbd{L} @tab @code{#+latex:}
12690 @item @kbd{h} @tab @code{#+begin_html ... #+end_html}
12691 @item @kbd{H} @tab @code{#+html:}
12692 @item @kbd{a} @tab @code{#+begin_ascii ... #+end_ascii}
12693 @item @kbd{A} @tab @code{#+ascii:}
12694 @item @kbd{i} @tab @code{#+include:} line
12697 For example, on an empty line, typing "<e" and then pressing TAB, will expand
12698 into a complete EXAMPLE template.
12700 You can install additional templates by customizing the variable
12701 @code{org-structure-template-alist}. See the docstring of the variable for
12702 additional details.
12704 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
12705 @section Speed keys
12707 @vindex org-use-speed-commands
12708 @vindex org-speed-commands-user
12710 Single keys can be made to execute commands when the cursor is at the
12711 beginning of a headline, i.e. before the first star. Configure the variable
12712 @code{org-use-speed-commands} to activate this feature. There is a
12713 pre-defined list of commands, and you can add more such commands using the
12714 variable @code{org-speed-commands-user}. Speed keys do not only speed up
12715 navigation and other commands, but they also provide an alternative way to
12716 execute commands bound to keys that are not or not easily available on a TTY,
12717 or on a small mobile device with a limited keyboard.
12719 To see which commands are available, activate the feature and press @kbd{?}
12720 with the cursor at the beginning of a headline.
12722 @node Code evaluation security, Customization, Speed keys, Miscellaneous
12723 @section Code evaluation and security issues
12725 Org provides tools to work with the code snippets, including evaluating them.
12727 Running code on your machine always comes with a security risk. Badly
12728 written or malicious code can be executed on purpose or by accident. Org has
12729 default settings which will only evaluate such code if you give explicit
12730 permission to do so, and as a casual user of these features you should leave
12731 these precautions intact.
12733 For people who regularly work with such code, the confirmation prompts can
12734 become annoying, and you might want to turn them off. This can be done, but
12735 you must be aware of the risks that are involved.
12737 Code evaluation can happen under the following circumstances:
12740 @item Source code blocks
12741 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
12742 C-c} in the block. The most important thing to realize here is that Org mode
12743 files which contain code snippets are, in a certain sense, like executable
12744 files. So you should accept them and load them into Emacs only from trusted
12745 sources---just like you would do with a program you install on your computer.
12747 Make sure you know what you are doing before customizing the variables
12748 which take off the default security brakes.
12750 @defopt org-confirm-babel-evaluate
12751 When t (the default), the user is asked before every code block evaluation.
12752 When nil, the user is not asked. When set to a function, it is called with
12753 two arguments (language and body of the code block) and should return t to
12754 ask and nil not to ask.
12757 For example, here is how to execute "ditaa" code (which is considered safe)
12760 (defun my-org-confirm-babel-evaluate (lang body)
12761 (not (string= lang "ditaa"))) ; don't ask for ditaa
12762 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
12765 @item Following @code{shell} and @code{elisp} links
12766 Org has two link types that can directly evaluate code (@pxref{External
12767 links}). These links can be problematic because the code to be evaluated is
12770 @defopt org-confirm-shell-link-function
12771 Function to queries user about shell link execution.
12773 @defopt org-confirm-elisp-link-function
12774 Functions to query user for Emacs Lisp link execution.
12777 @item Formulas in tables
12778 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
12779 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
12782 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
12783 @section Customization
12784 @cindex customization
12785 @cindex options, for customization
12786 @cindex variables, for customization
12788 There are more than 180 variables that can be used to customize
12789 Org. For the sake of compactness of the manual, I am not
12790 describing the variables here. A structured overview of customization
12791 variables is available with @kbd{M-x org-customize}. Or select
12792 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
12793 settings can also be activated on a per-file basis, by putting special
12794 lines into the buffer (@pxref{In-buffer settings}).
12796 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
12797 @section Summary of in-buffer settings
12798 @cindex in-buffer settings
12799 @cindex special keywords
12801 Org-mode uses special lines in the buffer to define settings on a
12802 per-file basis. These lines start with a @samp{#+} followed by a
12803 keyword, a colon, and then individual words defining a setting. Several
12804 setting words can be in the same line, but you can also have multiple
12805 lines for the keyword. While these settings are described throughout
12806 the manual, here is a summary. After changing any of those lines in the
12807 buffer, press @kbd{C-c C-c} with the cursor still in the line to
12808 activate the changes immediately. Otherwise they become effective only
12809 when the file is visited again in a new Emacs session.
12811 @vindex org-archive-location
12813 @item #+ARCHIVE: %s_done::
12814 This line sets the archive location for the agenda file. It applies for
12815 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
12816 of the file. The first such line also applies to any entries before it.
12817 The corresponding variable is @code{org-archive-location}.
12819 This line sets the category for the agenda file. The category applies
12820 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
12821 end of the file. The first such line also applies to any entries before it.
12822 @item #+COLUMNS: %25ITEM .....
12823 @cindex property, COLUMNS
12824 Set the default format for columns view. This format applies when
12825 columns view is invoked in locations where no @code{COLUMNS} property
12827 @item #+CONSTANTS: name1=value1 ...
12828 @vindex org-table-formula-constants
12829 @vindex org-table-formula
12830 Set file-local values for constants to be used in table formulas. This
12831 line sets the local variable @code{org-table-formula-constants-local}.
12832 The global version of this variable is
12833 @code{org-table-formula-constants}.
12834 @item #+FILETAGS: :tag1:tag2:tag3:
12835 Set tags that can be inherited by any entry in the file, including the
12837 @item #+DRAWERS: NAME1 .....
12838 @vindex org-drawers
12839 Set the file-local set of drawers. The corresponding global variable is
12840 @code{org-drawers}.
12841 @item #+LINK: linkword replace
12842 @vindex org-link-abbrev-alist
12843 These lines (several are allowed) specify link abbreviations.
12844 @xref{Link abbreviations}. The corresponding variable is
12845 @code{org-link-abbrev-alist}.
12846 @item #+PRIORITIES: highest lowest default
12847 @vindex org-highest-priority
12848 @vindex org-lowest-priority
12849 @vindex org-default-priority
12850 This line sets the limits and the default for the priorities. All three
12851 must be either letters A-Z or numbers 0-9. The highest priority must
12852 have a lower ASCII number than the lowest priority.
12853 @item #+PROPERTY: Property_Name Value
12854 This line sets a default inheritance value for entries in the current
12855 buffer, most useful for specifying the allowed values of a property.
12856 @cindex #+SETUPFILE
12857 @item #+SETUPFILE: file
12858 This line defines a file that holds more in-buffer setup. Normally this is
12859 entirely ignored. Only when the buffer is parsed for option-setting lines
12860 (i.e. when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a
12861 settings line, or when exporting), then the contents of this file are parsed
12862 as if they had been included in the buffer. In particular, the file can be
12863 any other Org-mode file with internal setup. You can visit the file the
12864 cursor is in the line with @kbd{C-c '}.
12867 This line sets options to be used at startup of Org-mode, when an
12868 Org file is being visited.
12870 The first set of options deals with the initial visibility of the outline
12871 tree. The corresponding variable for global default settings is
12872 @code{org-startup-folded}, with a default value @code{t}, which means
12874 @vindex org-startup-folded
12875 @cindex @code{overview}, STARTUP keyword
12876 @cindex @code{content}, STARTUP keyword
12877 @cindex @code{showall}, STARTUP keyword
12878 @cindex @code{showeverything}, STARTUP keyword
12880 overview @r{top-level headlines only}
12881 content @r{all headlines}
12882 showall @r{no folding of any entries}
12883 showeverything @r{show even drawer contents}
12886 @vindex org-startup-indented
12887 @cindex @code{indent}, STARTUP keyword
12888 @cindex @code{noindent}, STARTUP keyword
12889 Dynamic virtual indentation is controlled by the variable
12890 @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
12892 indent @r{start with @code{org-indent-mode} turned on}
12893 noindent @r{start with @code{org-indent-mode} turned off}
12896 @vindex org-startup-align-all-tables
12897 Then there are options for aligning tables upon visiting a file. This
12898 is useful in files containing narrowed table columns. The corresponding
12899 variable is @code{org-startup-align-all-tables}, with a default value
12901 @cindex @code{align}, STARTUP keyword
12902 @cindex @code{noalign}, STARTUP keyword
12904 align @r{align all tables}
12905 noalign @r{don't align tables on startup}
12908 @vindex org-startup-with-inline-images
12909 When visiting a file, inline images can be automatically displayed. The
12910 corresponding variable is @code{org-startup-with-inline-images}, with a
12911 default value @code{nil} to avoid delays when visiting a file.
12912 @cindex @code{inlineimages}, STARTUP keyword
12913 @cindex @code{noinlineimages}, STARTUP keyword
12915 inlineimages @r{show inline images}
12916 noinlineimages @r{don't show inline images on startup}
12919 @vindex org-log-done
12920 @vindex org-log-note-clock-out
12921 @vindex org-log-repeat
12922 Logging the closing and reopening of TODO items and clock intervals can be
12923 configured using these options (see variables @code{org-log-done},
12924 @code{org-log-note-clock-out} and @code{org-log-repeat})
12925 @cindex @code{logdone}, STARTUP keyword
12926 @cindex @code{lognotedone}, STARTUP keyword
12927 @cindex @code{nologdone}, STARTUP keyword
12928 @cindex @code{lognoteclock-out}, STARTUP keyword
12929 @cindex @code{nolognoteclock-out}, STARTUP keyword
12930 @cindex @code{logrepeat}, STARTUP keyword
12931 @cindex @code{lognoterepeat}, STARTUP keyword
12932 @cindex @code{nologrepeat}, STARTUP keyword
12933 @cindex @code{logreschedule}, STARTUP keyword
12934 @cindex @code{lognotereschedule}, STARTUP keyword
12935 @cindex @code{nologreschedule}, STARTUP keyword
12936 @cindex @code{logredeadline}, STARTUP keyword
12937 @cindex @code{lognoteredeadline}, STARTUP keyword
12938 @cindex @code{nologredeadline}, STARTUP keyword
12939 @cindex @code{logrefile}, STARTUP keyword
12940 @cindex @code{lognoterefile}, STARTUP keyword
12941 @cindex @code{nologrefile}, STARTUP keyword
12943 logdone @r{record a timestamp when an item is marked DONE}
12944 lognotedone @r{record timestamp and a note when DONE}
12945 nologdone @r{don't record when items are marked DONE}
12946 logrepeat @r{record a time when reinstating a repeating item}
12947 lognoterepeat @r{record a note when reinstating a repeating item}
12948 nologrepeat @r{do not record when reinstating repeating item}
12949 lognoteclock-out @r{record a note when clocking out}
12950 nolognoteclock-out @r{don't record a note when clocking out}
12951 logreschedule @r{record a timestamp when scheduling time changes}
12952 lognotereschedule @r{record a note when scheduling time changes}
12953 nologreschedule @r{do not record when a scheduling date changes}
12954 logredeadline @r{record a timestamp when deadline changes}
12955 lognoteredeadline @r{record a note when deadline changes}
12956 nologredeadline @r{do not record when a deadline date changes}
12957 logrefile @r{record a timestamp when refiling}
12958 lognoterefile @r{record a note when refiling}
12959 nologrefile @r{do not record when refiling}
12961 @vindex org-hide-leading-stars
12962 @vindex org-odd-levels-only
12963 Here are the options for hiding leading stars in outline headings, and for
12964 indenting outlines. The corresponding variables are
12965 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
12966 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
12967 @cindex @code{hidestars}, STARTUP keyword
12968 @cindex @code{showstars}, STARTUP keyword
12969 @cindex @code{odd}, STARTUP keyword
12970 @cindex @code{even}, STARTUP keyword
12972 hidestars @r{make all but one of the stars starting a headline invisible.}
12973 showstars @r{show all stars starting a headline}
12974 indent @r{virtual indentation according to outline level}
12975 noindent @r{no virtual indentation according to outline level}
12976 odd @r{allow only odd outline levels (1,3,...)}
12977 oddeven @r{allow all outline levels}
12979 @vindex org-put-time-stamp-overlays
12980 @vindex org-time-stamp-overlay-formats
12981 To turn on custom format overlays over timestamps (variables
12982 @code{org-put-time-stamp-overlays} and
12983 @code{org-time-stamp-overlay-formats}), use
12984 @cindex @code{customtime}, STARTUP keyword
12986 customtime @r{overlay custom time format}
12988 @vindex constants-unit-system
12989 The following options influence the table spreadsheet (variable
12990 @code{constants-unit-system}).
12991 @cindex @code{constcgs}, STARTUP keyword
12992 @cindex @code{constSI}, STARTUP keyword
12994 constcgs @r{@file{constants.el} should use the c-g-s unit system}
12995 constSI @r{@file{constants.el} should use the SI unit system}
12997 @vindex org-footnote-define-inline
12998 @vindex org-footnote-auto-label
12999 @vindex org-footnote-auto-adjust
13000 To influence footnote settings, use the following keywords. The
13001 corresponding variables are @code{org-footnote-define-inline},
13002 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
13003 @cindex @code{fninline}, STARTUP keyword
13004 @cindex @code{nofninline}, STARTUP keyword
13005 @cindex @code{fnlocal}, STARTUP keyword
13006 @cindex @code{fnprompt}, STARTUP keyword
13007 @cindex @code{fnauto}, STARTUP keyword
13008 @cindex @code{fnconfirm}, STARTUP keyword
13009 @cindex @code{fnplain}, STARTUP keyword
13010 @cindex @code{fnadjust}, STARTUP keyword
13011 @cindex @code{nofnadjust}, STARTUP keyword
13013 fninline @r{define footnotes inline}
13014 fnnoinline @r{define footnotes in separate section}
13015 fnlocal @r{define footnotes near first reference, but not inline}
13016 fnprompt @r{prompt for footnote labels}
13017 fnauto @r{create [fn:1]-like labels automatically (default)}
13018 fnconfirm @r{offer automatic label for editing or confirmation}
13019 fnplain @r{create [1]-like labels automatically}
13020 fnadjust @r{automatically renumber and sort footnotes}
13021 nofnadjust @r{do not renumber and sort automatically}
13023 @cindex org-hide-block-startup
13024 To hide blocks on startup, use these keywords. The corresponding variable is
13025 @code{org-hide-block-startup}.
13026 @cindex @code{hideblocks}, STARTUP keyword
13027 @cindex @code{nohideblocks}, STARTUP keyword
13029 hideblocks @r{Hide all begin/end blocks on startup}
13030 nohideblocks @r{Do not hide blocks on startup}
13032 @cindex org-pretty-entities
13033 The display of entities as UTF-8 characters is governed by the variable
13034 @code{org-pretty-entities} and the keywords
13035 @cindex @code{entitiespretty}, STARTUP keyword
13036 @cindex @code{entitiesplain}, STARTUP keyword
13038 entitiespretty @r{Show entities as UTF-8 characters where possible}
13039 entitiesplain @r{Leave entities plain}
13041 @item #+TAGS: TAG1(c1) TAG2(c2)
13042 @vindex org-tag-alist
13043 These lines (several such lines are allowed) specify the valid tags in
13044 this file, and (potentially) the corresponding @emph{fast tag selection}
13045 keys. The corresponding variable is @code{org-tag-alist}.
13047 This line contains the formulas for the table directly above the line.
13048 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
13049 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
13050 @itemx #+DESCRIPTION:, #+KEYWORDS:,
13051 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
13052 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
13053 These lines provide settings for exporting files. For more details see
13054 @ref{Export options}.
13055 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
13056 @vindex org-todo-keywords
13057 These lines set the TODO keywords and their interpretation in the
13058 current file. The corresponding variable is @code{org-todo-keywords}.
13061 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
13062 @section The very busy C-c C-c key
13064 @cindex C-c C-c, overview
13066 The key @kbd{C-c C-c} has many purposes in Org, which are all
13067 mentioned scattered throughout this manual. One specific function of
13068 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
13069 other circumstances it means something like @emph{``Hey Org, look
13070 here and update according to what you see here''}. Here is a summary of
13071 what this means in different contexts.
13075 If there are highlights in the buffer from the creation of a sparse
13076 tree, or from clock display, remove these highlights.
13078 If the cursor is in one of the special @code{#+KEYWORD} lines, this
13079 triggers scanning the buffer for these lines and updating the
13082 If the cursor is inside a table, realign the table. This command
13083 works even if the automatic table editor has been turned off.
13085 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
13088 If the current buffer is a capture buffer, close the note and file it.
13089 With a prefix argument, file it, without further interaction, to the
13092 If the cursor is on a @code{<<<target>>>}, update radio targets and
13093 corresponding links in this buffer.
13095 If the cursor is in a property line or at the start or end of a property
13096 drawer, offer property commands.
13098 If the cursor is at a footnote reference, go to the corresponding
13099 definition, and vice versa.
13101 If the cursor is on a statistics cookie, update it.
13103 If the cursor is in a plain list item with a checkbox, toggle the status
13106 If the cursor is on a numbered item in a plain list, renumber the
13109 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
13113 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
13114 @section A cleaner outline view
13115 @cindex hiding leading stars
13116 @cindex dynamic indentation
13117 @cindex odd-levels-only outlines
13118 @cindex clean outline view
13120 Some people find it noisy and distracting that the Org headlines start with a
13121 potentially large number of stars, and that text below the headlines is not
13122 indented. While this is no problem when writing a @emph{book-like} document
13123 where the outline headings are really section headings, in a more
13124 @emph{list-oriented} outline, indented structure is a lot cleaner:
13128 * Top level headline | * Top level headline
13129 ** Second level | * Second level
13130 *** 3rd level | * 3rd level
13131 some text | some text
13132 *** 3rd level | * 3rd level
13133 more text | more text
13134 * Another top level headline | * Another top level headline
13140 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
13141 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
13142 be achieved dynamically at display time using @code{org-indent-mode}. In
13143 this minor mode, all lines are prefixed for display with the necessary amount
13144 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
13145 property, such that @code{visual-line-mode} (or purely setting
13146 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
13147 }. Also headlines are prefixed with additional stars, so that the amount of
13148 indentation shifts by two@footnote{See the variable
13149 @code{org-indent-indentation-per-level}.} spaces per level. All headline
13150 stars but the last one are made invisible using the @code{org-hide}
13151 face@footnote{Turning on @code{org-indent-mode} sets
13152 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
13153 @code{nil}.} - see below under @samp{2.} for more information on how this
13154 works. You can turn on @code{org-indent-mode} for all files by customizing
13155 the variable @code{org-startup-indented}, or you can turn it on for
13156 individual files using
13162 If you want a similar effect in an earlier version of Emacs and/or Org, or if
13163 you want the indentation to be hard space characters so that the plain text
13164 file looks as similar as possible to the Emacs display, Org supports you in
13169 @emph{Indentation of text below headlines}@*
13170 You may indent text below each headline to make the left boundary line up
13171 with the headline, like
13175 more text, now indented
13178 @vindex org-adapt-indentation
13179 Org supports this with paragraph filling, line wrapping, and structure
13180 editing@footnote{See also the variable @code{org-adapt-indentation}.},
13181 preserving or adapting the indentation as appropriate.
13184 @vindex org-hide-leading-stars
13185 @emph{Hiding leading stars}@* You can modify the display in such a way that
13186 all leading stars become invisible. To do this in a global way, configure
13187 the variable @code{org-hide-leading-stars} or change this on a per-file basis
13191 #+STARTUP: hidestars
13192 #+STARTUP: showstars
13195 With hidden stars, the tree becomes:
13199 * Top level headline
13207 @vindex org-hide @r{(face)}
13208 The leading stars are not truly replaced by whitespace, they are only
13209 fontified with the face @code{org-hide} that uses the background color as
13210 font color. If you are not using either white or black background, you may
13211 have to customize this face to get the wanted effect. Another possibility is
13212 to set this font such that the extra stars are @i{almost} invisible, for
13213 example using the color @code{grey90} on a white background.
13216 @vindex org-odd-levels-only
13217 Things become cleaner still if you skip all the even levels and use only odd
13218 levels 1, 3, 5..., effectively adding two stars to go from one outline level
13219 to the next@footnote{When you need to specify a level for a property search
13220 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
13221 way we get the outline view shown at the beginning of this section. In order
13222 to make the structure editing and export commands handle this convention
13223 correctly, configure the variable @code{org-odd-levels-only}, or set this on
13224 a per-file basis with one of the following lines:
13231 You can convert an Org file from single-star-per-level to the
13232 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
13233 RET} in that file. The reverse operation is @kbd{M-x
13234 org-convert-to-oddeven-levels}.
13237 @node TTY keys, Interaction, Clean view, Miscellaneous
13238 @section Using Org on a tty
13239 @cindex tty key bindings
13241 Because Org contains a large number of commands, by default many of
13242 Org's core commands are bound to keys that are generally not
13243 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
13244 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
13245 together with modifiers like @key{Meta} and/or @key{Shift}. To access
13246 these commands on a tty when special keys are unavailable, the following
13247 alternative bindings can be used. The tty bindings below will likely be
13248 more cumbersome; you may find for some of the bindings below that a
13249 customized workaround suits you better. For example, changing a timestamp
13250 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
13251 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
13253 @multitable @columnfractions 0.15 0.2 0.1 0.2
13254 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
13255 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
13256 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
13257 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
13258 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
13259 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
13260 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
13261 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
13262 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
13263 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
13264 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
13265 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
13266 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
13267 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
13268 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
13269 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
13270 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
13271 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
13272 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
13276 @node Interaction, , TTY keys, Miscellaneous
13277 @section Interaction with other packages
13278 @cindex packages, interaction with other
13279 Org lives in the world of GNU Emacs and interacts in various ways
13280 with other code out there.
13283 * Cooperation:: Packages Org cooperates with
13284 * Conflicts:: Packages that lead to conflicts
13287 @node Cooperation, Conflicts, Interaction, Interaction
13288 @subsection Packages that Org cooperates with
13291 @cindex @file{calc.el}
13292 @cindex Gillespie, Dave
13293 @item @file{calc.el} by Dave Gillespie
13294 Org uses the Calc package for implementing spreadsheet
13295 functionality in its tables (@pxref{The spreadsheet}). Org
13296 checks for the availability of Calc by looking for the function
13297 @code{calc-eval} which will have been autoloaded during setup if Calc has
13298 been installed properly. As of Emacs 22, Calc is part of the Emacs
13299 distribution. Another possibility for interaction between the two
13300 packages is using Calc for embedded calculations. @xref{Embedded Mode,
13301 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
13302 @item @file{constants.el} by Carsten Dominik
13303 @cindex @file{constants.el}
13304 @cindex Dominik, Carsten
13305 @vindex org-table-formula-constants
13306 In a table formula (@pxref{The spreadsheet}), it is possible to use
13307 names for natural constants or units. Instead of defining your own
13308 constants in the variable @code{org-table-formula-constants}, install
13309 the @file{constants} package which defines a large number of constants
13310 and units, and lets you use unit prefixes like @samp{M} for
13311 @samp{Mega}, etc@. You will need version 2.0 of this package, available
13312 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
13313 the function @code{constants-get}, which has to be autoloaded in your
13314 setup. See the installation instructions in the file
13315 @file{constants.el}.
13316 @item @file{cdlatex.el} by Carsten Dominik
13317 @cindex @file{cdlatex.el}
13318 @cindex Dominik, Carsten
13319 Org-mode can make use of the CDLa@TeX{} package to efficiently enter
13320 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
13321 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
13322 @cindex @file{imenu.el}
13323 Imenu allows menu access to an index of items in a file. Org-mode
13324 supports Imenu---all you need to do to get the index is the following:
13326 (add-hook 'org-mode-hook
13327 (lambda () (imenu-add-to-menubar "Imenu")))
13329 @vindex org-imenu-depth
13330 By default the index is two levels deep---you can modify the depth using
13331 the option @code{org-imenu-depth}.
13332 @item @file{remember.el} by John Wiegley
13333 @cindex @file{remember.el}
13334 @cindex Wiegley, John
13335 Org used to use this package for capture, but no longer does.
13336 @item @file{speedbar.el} by Eric M. Ludlam
13337 @cindex @file{speedbar.el}
13338 @cindex Ludlam, Eric M.
13339 Speedbar is a package that creates a special frame displaying files and
13340 index items in files. Org-mode supports Speedbar and allows you to
13341 drill into Org files directly from the Speedbar. It also allows you to
13342 restrict the scope of agenda commands to a file or a subtree by using
13343 the command @kbd{<} in the Speedbar frame.
13344 @cindex @file{table.el}
13345 @item @file{table.el} by Takaaki Ota
13347 @cindex table editor, @file{table.el}
13348 @cindex @file{table.el}
13349 @cindex Ota, Takaaki
13351 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
13352 and alignment can be created using the Emacs table package by Takaaki Ota
13353 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
13354 Org-mode will recognize these tables and export them properly. Because of
13355 interference with other Org-mode functionality, you unfortunately cannot edit
13356 these tables directly in the buffer. Instead, you need to use the command
13357 @kbd{C-c '} to edit them, similar to source code snippets.
13360 @orgcmd{C-c ',org-edit-special}
13361 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
13363 @orgcmd{C-c ~,org-table-create-with-table.el}
13364 Insert a @file{table.el} table. If there is already a table at point, this
13365 command converts it between the @file{table.el} format and the Org-mode
13366 format. See the documentation string of the command
13367 @code{org-convert-table} for the restrictions under which this is
13370 @file{table.el} is part of Emacs since Emacs 22.
13371 @item @file{footnote.el} by Steven L. Baur
13372 @cindex @file{footnote.el}
13373 @cindex Baur, Steven L.
13374 Org-mode recognizes numerical footnotes as provided by this package.
13375 However, Org-mode also has its own footnote support (@pxref{Footnotes}),
13376 which makes using @file{footnote.el} unnecessary.
13379 @node Conflicts, , Cooperation, Interaction
13380 @subsection Packages that lead to conflicts with Org-mode
13384 @cindex @code{shift-selection-mode}
13385 @vindex org-support-shift-select
13386 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
13387 cursor motions combined with the shift key should start or enlarge regions.
13388 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
13389 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
13390 at such a location. By default, @kbd{S-@key{cursor}} commands outside
13391 special contexts don't do anything, but you can customize the variable
13392 @code{org-support-shift-select}. Org-mode then tries to accommodate shift
13393 selection by (i) using it outside of the special contexts where special
13394 commands apply, and by (ii) extending an existing active region even if the
13395 cursor moves across a special context.
13397 @item @file{CUA.el} by Kim. F. Storm
13398 @cindex @file{CUA.el}
13399 @cindex Storm, Kim. F.
13400 @vindex org-replace-disputed-keys
13401 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
13402 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
13403 region. In fact, Emacs 23 has this built-in in the form of
13404 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
13405 23, you probably don't want to use another package for this purpose. However,
13406 if you prefer to leave these keys to a different package while working in
13407 Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
13408 Org will move the following key bindings in Org files, and in the agenda
13409 buffer (but not during date selection).
13412 S-UP -> M-p S-DOWN -> M-n
13413 S-LEFT -> M-- S-RIGHT -> M-+
13414 C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
13417 @vindex org-disputed-keys
13418 Yes, these are unfortunately more difficult to remember. If you want
13419 to have other replacement keys, look at the variable
13420 @code{org-disputed-keys}.
13422 @item @file{yasnippet.el}
13423 @cindex @file{yasnippet.el}
13424 The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
13425 @code{"\t"}) overrules YASnippet's access to this key. The following code
13426 fixed this problem:
13429 (add-hook 'org-mode-hook
13431 (org-set-local 'yas/trigger-key [tab])
13432 (define-key yas/keymap [tab] 'yas/next-field-group)))
13435 @item @file{windmove.el} by Hovav Shacham
13436 @cindex @file{windmove.el}
13437 This package also uses the @kbd{S-<cursor>} keys, so everything written
13438 in the paragraph above about CUA mode also applies here. If you want make
13439 the windmove function active in locations where Org-mode does not have
13440 special functionality on @kbd{S-@key{cursor}}, add this to your
13444 ;; Make windmove work in org-mode:
13445 (add-hook 'org-shiftup-final-hook 'windmove-up)
13446 (add-hook 'org-shiftleft-final-hook 'windmove-left)
13447 (add-hook 'org-shiftdown-final-hook 'windmove-down)
13448 (add-hook 'org-shiftright-final-hook 'windmove-right)
13451 @item @file{viper.el} by Michael Kifer
13452 @cindex @file{viper.el}
13454 Viper uses @kbd{C-c /} and therefore makes this key not access the
13455 corresponding Org-mode command @code{org-sparse-tree}. You need to find
13456 another key for this command, or override the key in
13457 @code{viper-vi-global-user-map} with
13460 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
13466 @node Hacking, MobileOrg, Miscellaneous, Top
13470 This appendix covers some aspects where users can extend the functionality of
13474 * Hooks:: Who to reach into Org's internals
13475 * Add-on packages:: Available extensions
13476 * Adding hyperlink types:: New custom link types
13477 * Context-sensitive commands:: How to add functionality to such commands
13478 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
13479 * Dynamic blocks:: Automatically filled blocks
13480 * Special agenda views:: Customized views
13481 * Extracting agenda information:: Postprocessing of agenda information
13482 * Using the property API:: Writing programs that use entry properties
13483 * Using the mapping API:: Mapping over all or selected entries
13486 @node Hooks, Add-on packages, Hacking, Hacking
13490 Org has a large number of hook variables that can be used to add
13491 functionality. This appendix about hacking is going to illustrate the
13492 use of some of them. A complete list of all hooks with documentation is
13493 maintained by the Worg project and can be found at
13494 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
13496 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
13497 @section Add-on packages
13498 @cindex add-on packages
13500 A large number of add-on packages have been written by various authors.
13501 These packages are not part of Emacs, but they are distributed as contributed
13502 packages with the separate release available at the Org-mode home page at
13503 @uref{http://orgmode.org}. The list of contributed packages, along with
13504 documentation about each package, is maintained by the Worg project at
13505 @uref{http://orgmode.org/worg/org-contrib/}.
13509 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
13510 @section Adding hyperlink types
13511 @cindex hyperlinks, adding new types
13513 Org has a large number of hyperlink types built-in
13514 (@pxref{Hyperlinks}). If you would like to add new link types, Org
13515 provides an interface for doing so. Let's look at an example file,
13516 @file{org-man.el}, that will add support for creating links like
13517 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
13521 ;;; org-man.el - Support for links to manpages in Org
13525 (org-add-link-type "man" 'org-man-open)
13526 (add-hook 'org-store-link-functions 'org-man-store-link)
13528 (defcustom org-man-command 'man
13529 "The Emacs command to be used to display a man page."
13531 :type '(choice (const man) (const woman)))
13533 (defun org-man-open (path)
13534 "Visit the manpage on PATH.
13535 PATH should be a topic that can be thrown at the man command."
13536 (funcall org-man-command path))
13538 (defun org-man-store-link ()
13539 "Store a link to a manpage."
13540 (when (memq major-mode '(Man-mode woman-mode))
13541 ;; This is a man page, we do make this link
13542 (let* ((page (org-man-get-page-name))
13543 (link (concat "man:" page))
13544 (description (format "Manpage for %s" page)))
13545 (org-store-link-props
13548 :description description))))
13550 (defun org-man-get-page-name ()
13551 "Extract the page name from the buffer name."
13552 ;; This works for both `Man-mode' and `woman-mode'.
13553 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
13554 (match-string 1 (buffer-name))
13555 (error "Cannot create link to this man page")))
13559 ;;; org-man.el ends here
13563 You would activate this new link type in @file{.emacs} with
13570 Let's go through the file and see what it does.
13573 It does @code{(require 'org)} to make sure that @file{org.el} has been
13576 The next line calls @code{org-add-link-type} to define a new link type
13577 with prefix @samp{man}. The call also contains the name of a function
13578 that will be called to follow such a link.
13580 @vindex org-store-link-functions
13581 The next line adds a function to @code{org-store-link-functions}, in
13582 order to allow the command @kbd{C-c l} to record a useful link in a
13583 buffer displaying a man page.
13586 The rest of the file defines the necessary variables and functions.
13587 First there is a customization variable that determines which Emacs
13588 command should be used to display man pages. There are two options,
13589 @code{man} and @code{woman}. Then the function to follow a link is
13590 defined. It gets the link path as an argument---in this case the link
13591 path is just a topic for the manual command. The function calls the
13592 value of @code{org-man-command} to display the man page.
13594 Finally the function @code{org-man-store-link} is defined. When you try
13595 to store a link with @kbd{C-c l}, this function will be called to
13596 try to make a link. The function must first decide if it is supposed to
13597 create the link for this buffer type; we do this by checking the value
13598 of the variable @code{major-mode}. If not, the function must exit and
13599 return the value @code{nil}. If yes, the link is created by getting the
13600 manual topic from the buffer name and prefixing it with the string
13601 @samp{man:}. Then it must call the command @code{org-store-link-props}
13602 and set the @code{:type} and @code{:link} properties. Optionally you
13603 can also set the @code{:description} property to provide a default for
13604 the link description when the link is later inserted into an Org
13605 buffer with @kbd{C-c C-l}.
13607 When it makes sense for your new link type, you may also define a function
13608 @code{org-PREFIX-complete-link} that implements special (e.g. completion)
13609 support for inserting such a link with @kbd{C-c C-l}. Such a function should
13610 not accept any arguments, and return the full link with prefix.
13612 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
13613 @section Context-sensitive commands
13614 @cindex context-sensitive commands, hooks
13615 @cindex add-ons, context-sensitive commands
13616 @vindex org-ctrl-c-ctrl-c-hook
13618 Org has several commands that act differently depending on context. The most
13619 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
13620 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
13622 Add-ons can tap into this functionality by providing a function that detects
13623 special context for that add-on and executes functionality appropriate for
13624 the context. Here is an example from Dan Davison's @file{org-R.el} which
13625 allows you to evaluate commands based on the @file{R} programming language
13626 @footnote{@file{org-R.el} has been replaced by the org-mode functionality
13627 described in @ref{Working With Source Code} and is now obsolete.}. For this
13628 package, special contexts are lines that start with @code{#+R:} or
13632 (defun org-R-apply-maybe ()
13633 "Detect if this is context for org-R and execute R commands."
13634 (if (save-excursion
13635 (beginning-of-line 1)
13636 (looking-at "#\\+RR?:"))
13637 (progn (call-interactively 'org-R-apply)
13638 t) ;; to signal that we took action
13639 nil)) ;; to signal that we did not
13641 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
13644 The function first checks if the cursor is in such a line. If that is the
13645 case, @code{org-R-apply} is called and the function returns @code{t} to
13646 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
13647 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
13650 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
13651 @section Tables and lists in arbitrary syntax
13652 @cindex tables, in other modes
13653 @cindex lists, in other modes
13654 @cindex Orgtbl mode
13656 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
13657 frequent feature request has been to make it work with native tables in
13658 specific languages, for example @LaTeX{}. However, this is extremely
13659 hard to do in a general way, would lead to a customization nightmare,
13660 and would take away much of the simplicity of the Orgtbl-mode table
13663 This appendix describes a different approach. We keep the Orgtbl mode
13664 table in its native format (the @i{source table}), and use a custom
13665 function to @i{translate} the table to the correct syntax, and to
13666 @i{install} it in the right location (the @i{target table}). This puts
13667 the burden of writing conversion functions on the user, but it allows
13668 for a very flexible system.
13670 Bastien added the ability to do the same with lists, in Orgstruct mode. You
13671 can use Org's facilities to edit and structure lists by turning
13672 @code{orgstruct-mode} on, then locally exporting such lists in another format
13673 (HTML, @LaTeX{} or Texinfo.)
13677 * Radio tables:: Sending and receiving radio tables
13678 * A LaTeX example:: Step by step, almost a tutorial
13679 * Translator functions:: Copy and modify
13680 * Radio lists:: Doing the same for lists
13683 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
13684 @subsection Radio tables
13685 @cindex radio tables
13687 To define the location of the target table, you first need to create two
13688 lines that are comments in the current mode, but contain magic words for
13689 Orgtbl mode to find. Orgtbl mode will insert the translated table
13690 between these lines, replacing whatever was there before. For example:
13693 /* BEGIN RECEIVE ORGTBL table_name */
13694 /* END RECEIVE ORGTBL table_name */
13698 Just above the source table, we put a special line that tells
13699 Orgtbl mode how to translate this table and where to install it. For
13703 #+ORGTBL: SEND table_name translation_function arguments....
13707 @code{table_name} is the reference name for the table that is also used
13708 in the receiver lines. @code{translation_function} is the Lisp function
13709 that does the translation. Furthermore, the line can contain a list of
13710 arguments (alternating key and value) at the end. The arguments will be
13711 passed as a property list to the translation function for
13712 interpretation. A few standard parameters are already recognized and
13713 acted upon before the translation function is called:
13717 Skip the first N lines of the table. Hlines do count as separate lines for
13720 @item :skipcols (n1 n2 ...)
13721 List of columns that should be skipped. If the table has a column with
13722 calculation marks, that column is automatically discarded as well.
13723 Please note that the translator function sees the table @emph{after} the
13724 removal of these columns, the function never knows that there have been
13725 additional columns.
13729 The one problem remaining is how to keep the source table in the buffer
13730 without disturbing the normal workings of the file, for example during
13731 compilation of a C file or processing of a @LaTeX{} file. There are a
13732 number of different solutions:
13736 The table could be placed in a block comment if that is supported by the
13737 language. For example, in C mode you could wrap the table between
13738 @samp{/*} and @samp{*/} lines.
13740 Sometimes it is possible to put the table after some kind of @i{END}
13741 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
13744 You can just comment the table line-by-line whenever you want to process
13745 the file, and uncomment it whenever you need to edit the table. This
13746 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
13747 makes this comment-toggling very easy, in particular if you bind it to a
13751 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
13752 @subsection A @LaTeX{} example of radio tables
13753 @cindex @LaTeX{}, and Orgtbl mode
13755 The best way to wrap the source table in @LaTeX{} is to use the
13756 @code{comment} environment provided by @file{comment.sty}. It has to be
13757 activated by placing @code{\usepackage@{comment@}} into the document
13758 header. Orgtbl mode can insert a radio table skeleton@footnote{By
13759 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
13760 variable @code{orgtbl-radio-tables} to install templates for other
13761 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
13762 be prompted for a table name, let's say we use @samp{salesfigures}. You
13763 will then get the following template:
13765 @cindex #+ORGTBL, SEND
13767 % BEGIN RECEIVE ORGTBL salesfigures
13768 % END RECEIVE ORGTBL salesfigures
13770 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13776 @vindex @LaTeX{}-verbatim-environments
13777 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
13778 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
13779 into the receiver location with name @code{salesfigures}. You may now
13780 fill in the table---feel free to use the spreadsheet features@footnote{If
13781 the @samp{#+TBLFM} line contains an odd number of dollar characters,
13782 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
13783 example you can fix this by adding an extra line inside the
13784 @code{comment} environment that is used to balance the dollar
13785 expressions. If you are using AUC@TeX{} with the font-latex library, a
13786 much better solution is to add the @code{comment} environment to the
13787 variable @code{LaTeX-verbatim-environments}.}:
13790 % BEGIN RECEIVE ORGTBL salesfigures
13791 % END RECEIVE ORGTBL salesfigures
13793 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13794 | Month | Days | Nr sold | per day |
13795 |-------+------+---------+---------|
13796 | Jan | 23 | 55 | 2.4 |
13797 | Feb | 21 | 16 | 0.8 |
13798 | March | 22 | 278 | 12.6 |
13799 #+TBLFM: $4=$3/$2;%.1f
13800 % $ (optional extra dollar to keep font-lock happy, see footnote)
13805 When you are done, press @kbd{C-c C-c} in the table to get the converted
13806 table inserted between the two marker lines.
13808 Now let's assume you want to make the table header by hand, because you
13809 want to control how columns are aligned, etc@. In this case we make sure
13810 that the table translator skips the first 2 lines of the source
13811 table, and tell the command to work as a @i{splice}, i.e. to not produce
13812 header and footer commands of the target table:
13815 \begin@{tabular@}@{lrrr@}
13816 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
13817 % BEGIN RECEIVE ORGTBL salesfigures
13818 % END RECEIVE ORGTBL salesfigures
13822 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
13823 | Month | Days | Nr sold | per day |
13824 |-------+------+---------+---------|
13825 | Jan | 23 | 55 | 2.4 |
13826 | Feb | 21 | 16 | 0.8 |
13827 | March | 22 | 278 | 12.6 |
13828 #+TBLFM: $4=$3/$2;%.1f
13832 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
13833 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
13834 and marks horizontal lines with @code{\hline}. Furthermore, it
13835 interprets the following parameters (see also @pxref{Translator functions}):
13838 @item :splice nil/t
13839 When set to t, return only table body lines, don't wrap them into a
13840 tabular environment. Default is nil.
13843 A format to be used to wrap each field, it should contain @code{%s} for the
13844 original field value. For example, to wrap each field value in dollars,
13845 you could use @code{:fmt "$%s$"}. This may also be a property list with
13846 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
13847 A function of one argument can be used in place of the strings; the
13848 function must return a formatted string.
13851 Use this format to print numbers with exponentials. The format should
13852 have @code{%s} twice for inserting mantissa and exponent, for example
13853 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
13854 may also be a property list with column numbers and formats, for example
13855 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
13856 @code{efmt} has been applied to a value, @code{fmt} will also be
13857 applied. Similar to @code{fmt}, functions of two arguments can be
13858 supplied instead of strings.
13861 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
13862 @subsection Translator functions
13863 @cindex HTML, and Orgtbl mode
13864 @cindex translator function
13866 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
13867 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
13868 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
13869 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
13870 code that produces tables during HTML export.}, these all use a generic
13871 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
13872 itself is a very short function that computes the column definitions for the
13873 @code{tabular} environment, defines a few field and line separators and then
13874 hands processing over to the generic translator. Here is the entire code:
13878 (defun orgtbl-to-latex (table params)
13879 "Convert the Orgtbl mode TABLE to LaTeX."
13880 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
13881 org-table-last-alignment ""))
13884 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
13885 :tend "\\end@{tabular@}"
13886 :lstart "" :lend " \\\\" :sep " & "
13887 :efmt "%s\\,(%s)" :hline "\\hline")))
13888 (orgtbl-to-generic table (org-combine-plists params2 params))))
13892 As you can see, the properties passed into the function (variable
13893 @var{PARAMS}) are combined with the ones newly defined in the function
13894 (variable @var{PARAMS2}). The ones passed into the function (i.e. the
13895 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
13896 would like to use the @LaTeX{} translator, but wanted the line endings to
13897 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
13898 overrule the default with
13901 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
13904 For a new language, you can either write your own converter function in
13905 analogy with the @LaTeX{} translator, or you can use the generic function
13906 directly. For example, if you have a language where a table is started
13907 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
13908 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
13909 separator is a TAB, you could call the generic translator like this (on
13913 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
13914 :lstart "!BL! " :lend " !EL!" :sep "\t"
13918 Please check the documentation string of the function
13919 @code{orgtbl-to-generic} for a full list of parameters understood by
13920 that function, and remember that you can pass each of them into
13921 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
13922 using the generic function.
13924 Of course you can also write a completely new function doing complicated
13925 things the generic translator cannot do. A translator function takes
13926 two arguments. The first argument is the table, a list of lines, each
13927 line either the symbol @code{hline} or a list of fields. The second
13928 argument is the property list containing all parameters specified in the
13929 @samp{#+ORGTBL: SEND} line. The function must return a single string
13930 containing the formatted table. If you write a generally useful
13931 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
13932 others can benefit from your work.
13934 @node Radio lists, , Translator functions, Tables in arbitrary syntax
13935 @subsection Radio lists
13936 @cindex radio lists
13937 @cindex org-list-insert-radio-list
13939 Sending and receiving radio lists works exactly the same way as sending and
13940 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
13941 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
13942 @code{org-list-insert-radio-list}.
13944 Here are the differences with radio tables:
13948 Orgstruct mode must be active.
13950 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
13952 The available translation functions for radio lists don't take
13955 @kbd{C-c C-c} will work when pressed on the first item of the list.
13958 Here is a @LaTeX{} example. Let's say that you have this in your
13963 % BEGIN RECEIVE ORGLST to-buy
13964 % END RECEIVE ORGLST to-buy
13966 #+ORGLST: SEND to-buy org-list-to-latex
13975 Pressing `C-c C-c' on @code{a new house} and will insert the converted
13976 @LaTeX{} list between the two marker lines.
13978 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
13979 @section Dynamic blocks
13980 @cindex dynamic blocks
13982 Org documents can contain @emph{dynamic blocks}. These are
13983 specially marked regions that are updated by some user-written function.
13984 A good example for such a block is the clock table inserted by the
13985 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
13987 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
13988 to the block and can also specify parameters for the function producing
13989 the content of the block.
13991 @cindex #+BEGIN:dynamic block
13993 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
13998 Dynamic blocks are updated with the following commands
14001 @orgcmd{C-c C-x C-u,org-dblock-update}
14002 Update dynamic block at point.
14003 @orgkey{C-u C-c C-x C-u}
14004 Update all dynamic blocks in the current file.
14007 Updating a dynamic block means to remove all the text between BEGIN and
14008 END, parse the BEGIN line for parameters and then call the specific
14009 writer function for this block to insert the new content. If you want
14010 to use the original content in the writer function, you can use the
14011 extra parameter @code{:content}.
14013 For a block with name @code{myblock}, the writer function is
14014 @code{org-dblock-write:myblock} with as only parameter a property list
14015 with the parameters given in the begin line. Here is a trivial example
14016 of a block that keeps track of when the block update function was last
14020 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
14026 The corresponding block writer function could look like this:
14029 (defun org-dblock-write:block-update-time (params)
14030 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
14031 (insert "Last block update at: "
14032 (format-time-string fmt (current-time)))))
14035 If you want to make sure that all dynamic blocks are always up-to-date,
14036 you could add the function @code{org-update-all-dblocks} to a hook, for
14037 example @code{before-save-hook}. @code{org-update-all-dblocks} is
14038 written in a way such that it does nothing in buffers that are not in
14041 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
14042 @section Special agenda views
14043 @cindex agenda views, user-defined
14045 Org provides a special hook that can be used to narrow down the selection
14046 made by these agenda views: @code{todo}, @code{alltodo}, @code{tags}, @code{tags-todo},
14047 @code{tags-tree}. You may specify a function that is used at each match to verify
14048 if the match should indeed be part of the agenda view, and if not, how
14049 much should be skipped.
14051 Let's say you want to produce a list of projects that contain a WAITING
14052 tag anywhere in the project tree. Let's further assume that you have
14053 marked all tree headings that define a project with the TODO keyword
14054 PROJECT. In this case you would run a TODO search for the keyword
14055 PROJECT, but skip the match unless there is a WAITING tag anywhere in
14056 the subtree belonging to the project line.
14058 To achieve this, you must write a function that searches the subtree for
14059 the tag. If the tag is found, the function must return @code{nil} to
14060 indicate that this match should not be skipped. If there is no such
14061 tag, return the location of the end of the subtree, to indicate that
14062 search should continue from there.
14065 (defun my-skip-unless-waiting ()
14066 "Skip trees that are not waiting"
14067 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
14068 (if (re-search-forward ":waiting:" subtree-end t)
14069 nil ; tag found, do not skip
14070 subtree-end))) ; tag not found, continue after end of subtree
14073 Now you may use this function in an agenda custom command, for example
14077 (org-add-agenda-custom-command
14078 '("b" todo "PROJECT"
14079 ((org-agenda-skip-function 'my-skip-unless-waiting)
14080 (org-agenda-overriding-header "Projects waiting for something: "))))
14083 @vindex org-agenda-overriding-header
14084 Note that this also binds @code{org-agenda-overriding-header} to get a
14085 meaningful header in the agenda view.
14087 @vindex org-odd-levels-only
14088 @vindex org-agenda-skip-function
14089 A general way to create custom searches is to base them on a search for
14090 entries with a certain level limit. If you want to study all entries with
14091 your custom search function, simply do a search for
14092 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
14093 level number corresponds to order in the hierarchy, not to the number of
14094 stars.}, and then use @code{org-agenda-skip-function} to select the entries
14095 you really want to have.
14097 You may also put a Lisp form into @code{org-agenda-skip-function}. In
14098 particular, you may use the functions @code{org-agenda-skip-entry-if}
14099 and @code{org-agenda-skip-subtree-if} in this form, for example:
14102 @item '(org-agenda-skip-entry-if 'scheduled)
14103 Skip current entry if it has been scheduled.
14104 @item '(org-agenda-skip-entry-if 'notscheduled)
14105 Skip current entry if it has not been scheduled.
14106 @item '(org-agenda-skip-entry-if 'deadline)
14107 Skip current entry if it has a deadline.
14108 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
14109 Skip current entry if it has a deadline, or if it is scheduled.
14110 @item '(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
14111 Skip current entry if the TODO keyword is TODO or WAITING.
14112 @item '(org-agenda-skip-entry-if 'todo 'done)
14113 Skip current entry if the TODO keyword marks a DONE state.
14114 @item '(org-agenda-skip-entry-if 'timestamp)
14115 Skip current entry if it has any timestamp, may also be deadline or scheduled.
14116 @item '(org-agenda-skip-entry 'regexp "regular expression")
14117 Skip current entry if the regular expression matches in the entry.
14118 @item '(org-agenda-skip-entry 'notregexp "regular expression")
14119 Skip current entry unless the regular expression matches.
14120 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
14121 Same as above, but check and skip the entire subtree.
14124 Therefore we could also have written the search for WAITING projects
14125 like this, even without defining a special function:
14128 (org-add-agenda-custom-command
14129 '("b" todo "PROJECT"
14130 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
14131 'regexp ":waiting:"))
14132 (org-agenda-overriding-header "Projects waiting for something: "))))
14135 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
14136 @section Extracting agenda information
14137 @cindex agenda, pipe
14138 @cindex Scripts, for agenda processing
14140 @vindex org-agenda-custom-commands
14141 Org provides commands to access agenda information for the command
14142 line in Emacs batch mode. This extracted information can be sent
14143 directly to a printer, or it can be read by a program that does further
14144 processing of the data. The first of these commands is the function
14145 @code{org-batch-agenda}, that produces an agenda view and sends it as
14146 ASCII text to STDOUT. The command takes a single string as parameter.
14147 If the string has length 1, it is used as a key to one of the commands
14148 you have configured in @code{org-agenda-custom-commands}, basically any
14149 key you can use after @kbd{C-c a}. For example, to directly print the
14150 current TODO list, you could use
14153 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
14156 If the parameter is a string with 2 or more characters, it is used as a
14157 tags/TODO match string. For example, to print your local shopping list
14158 (all items with the tag @samp{shop}, but excluding the tag
14159 @samp{NewYork}), you could use
14162 emacs -batch -l ~/.emacs \
14163 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
14167 You may also modify parameters on the fly like this:
14170 emacs -batch -l ~/.emacs \
14171 -eval '(org-batch-agenda "a" \
14172 org-agenda-span month \
14173 org-agenda-include-diary nil \
14174 org-agenda-files (quote ("~/org/project.org")))' \
14179 which will produce a 30-day agenda, fully restricted to the Org file
14180 @file{~/org/projects.org}, not even including the diary.
14182 If you want to process the agenda data in more sophisticated ways, you
14183 can use the command @code{org-batch-agenda-csv} to get a comma-separated
14184 list of values for each agenda item. Each line in the output will
14185 contain a number of fields separated by commas. The fields in a line
14189 category @r{The category of the item}
14190 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
14191 type @r{The type of the agenda entry, can be}
14192 todo @r{selected in TODO match}
14193 tagsmatch @r{selected in tags match}
14194 diary @r{imported from diary}
14195 deadline @r{a deadline}
14196 scheduled @r{scheduled}
14197 timestamp @r{appointment, selected by timestamp}
14198 closed @r{entry was closed on date}
14199 upcoming-deadline @r{warning about nearing deadline}
14200 past-scheduled @r{forwarded scheduled item}
14201 block @r{entry has date block including date}
14202 todo @r{The TODO keyword, if any}
14203 tags @r{All tags including inherited ones, separated by colons}
14204 date @r{The relevant date, like 2007-2-14}
14205 time @r{The time, like 15:00-16:50}
14206 extra @r{String with extra planning info}
14207 priority-l @r{The priority letter if any was given}
14208 priority-n @r{The computed numerical priority}
14212 Time and date will only be given if a timestamp (or deadline/scheduled)
14213 led to the selection of the item.
14215 A CSV list like this is very easy to use in a post-processing script.
14216 For example, here is a Perl program that gets the TODO list from
14217 Emacs/Org and prints all the items, preceded by a checkbox:
14222 # define the Emacs command to run
14223 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
14225 # run it and capture the output
14226 $agenda = qx@{$cmd 2>/dev/null@};
14228 # loop over all lines
14229 foreach $line (split(/\n/,$agenda)) @{
14230 # get the individual values
14231 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
14232 $priority_l,$priority_n) = split(/,/,$line);
14233 # process and print
14234 print "[ ] $head\n";
14238 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
14239 @section Using the property API
14240 @cindex API, for properties
14241 @cindex properties, API
14243 Here is a description of the functions that can be used to work with
14246 @defun org-entry-properties &optional pom which
14247 Get all properties of the entry at point-or-marker POM.@*
14248 This includes the TODO keyword, the tags, time strings for deadline,
14249 scheduled, and clocking, and any additional properties defined in the
14250 entry. The return value is an alist. Keys may occur multiple times
14251 if the property key was used several times.@*
14252 POM may also be nil, in which case the current entry is used.
14253 If WHICH is nil or `all', get all properties. If WHICH is
14254 `special' or `standard', only get that subclass.
14256 @vindex org-use-property-inheritance
14257 @defun org-entry-get pom property &optional inherit
14258 Get value of PROPERTY for entry at point-or-marker POM. By default,
14259 this only looks at properties defined locally in the entry. If INHERIT
14260 is non-nil and the entry does not have the property, then also check
14261 higher levels of the hierarchy. If INHERIT is the symbol
14262 @code{selective}, use inheritance if and only if the setting of
14263 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
14266 @defun org-entry-delete pom property
14267 Delete the property PROPERTY from entry at point-or-marker POM.
14270 @defun org-entry-put pom property value
14271 Set PROPERTY to VALUE for entry at point-or-marker POM.
14274 @defun org-buffer-property-keys &optional include-specials
14275 Get all property keys in the current buffer.
14278 @defun org-insert-property-drawer
14279 Insert a property drawer at point.
14282 @defun org-entry-put-multivalued-property pom property &rest values
14283 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
14284 strings. They will be concatenated, with spaces as separators.
14287 @defun org-entry-get-multivalued-property pom property
14288 Treat the value of the property PROPERTY as a whitespace-separated list of
14289 values and return the values as a list of strings.
14292 @defun org-entry-add-to-multivalued-property pom property value
14293 Treat the value of the property PROPERTY as a whitespace-separated list of
14294 values and make sure that VALUE is in this list.
14297 @defun org-entry-remove-from-multivalued-property pom property value
14298 Treat the value of the property PROPERTY as a whitespace-separated list of
14299 values and make sure that VALUE is @emph{not} in this list.
14302 @defun org-entry-member-in-multivalued-property pom property value
14303 Treat the value of the property PROPERTY as a whitespace-separated list of
14304 values and check if VALUE is in this list.
14307 @defopt org-property-allowed-value-functions
14308 Hook for functions supplying allowed values for a specific property.
14309 The functions must take a single argument, the name of the property, and
14310 return a flat list of allowed values. If @samp{:ETC} is one of
14311 the values, use the values as completion help, but allow also other values
14312 to be entered. The functions must return @code{nil} if they are not
14313 responsible for this property.
14316 @node Using the mapping API, , Using the property API, Hacking
14317 @section Using the mapping API
14318 @cindex API, for mapping
14319 @cindex mapping entries, API
14321 Org has sophisticated mapping capabilities to find all entries satisfying
14322 certain criteria. Internally, this functionality is used to produce agenda
14323 views, but there is also an API that can be used to execute arbitrary
14324 functions for each or selected entries. The main entry point for this API
14327 @defun org-map-entries func &optional match scope &rest skip
14328 Call FUNC at each headline selected by MATCH in SCOPE.
14330 FUNC is a function or a Lisp form. The function will be called without
14331 arguments, with the cursor positioned at the beginning of the headline.
14332 The return values of all calls to the function will be collected and
14333 returned as a list.
14335 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14336 does not need to preserve point. After evaluation, the cursor will be
14337 moved to the end of the line (presumably of the headline of the
14338 processed entry) and search continues from there. Under some
14339 circumstances, this may not produce the wanted results. For example,
14340 if you have removed (e.g. archived) the current (sub)tree it could
14341 mean that the next entry will be skipped entirely. In such cases, you
14342 can specify the position from where search should continue by making
14343 FUNC set the variable `org-map-continue-from' to the desired buffer
14346 MATCH is a tags/property/todo match as it is used in the agenda match view.
14347 Only headlines that are matched by this query will be considered during
14348 the iteration. When MATCH is nil or t, all headlines will be
14349 visited by the iteration.
14351 SCOPE determines the scope of this command. It can be any of:
14354 nil @r{the current buffer, respecting the restriction if any}
14355 tree @r{the subtree started with the entry at point}
14356 file @r{the current buffer, without restriction}
14358 @r{the current buffer, and any archives associated with it}
14359 agenda @r{all agenda files}
14360 agenda-with-archives
14361 @r{all agenda files with any archive files associated with them}
14363 @r{if this is a list, all files in the list will be scanned}
14366 The remaining args are treated as settings for the skipping facilities of
14367 the scanner. The following items can be given here:
14369 @vindex org-agenda-skip-function
14371 archive @r{skip trees with the archive tag}
14372 comment @r{skip trees with the COMMENT keyword}
14373 function or Lisp form
14374 @r{will be used as value for @code{org-agenda-skip-function},}
14375 @r{so whenever the function returns t, FUNC}
14376 @r{will not be called for that entry and search will}
14377 @r{continue from the point where the function leaves it}
14381 The function given to that mapping routine can really do anything you like.
14382 It can use the property API (@pxref{Using the property API}) to gather more
14383 information about the entry, or in order to change metadata in the entry.
14384 Here are a couple of functions that might be handy:
14386 @defun org-todo &optional arg
14387 Change the TODO state of the entry. See the docstring of the functions for
14388 the many possible values for the argument ARG.
14391 @defun org-priority &optional action
14392 Change the priority of the entry. See the docstring of this function for the
14393 possible values for ACTION.
14396 @defun org-toggle-tag tag &optional onoff
14397 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
14398 or @code{off} will not toggle tag, but ensure that it is either on or off.
14402 Promote the current entry.
14406 Demote the current entry.
14409 Here is a simple example that will turn all entries in the current file with
14410 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
14411 Entries in comment trees and in archive trees will be ignored.
14415 '(org-todo "UPCOMING")
14416 "+TOMORROW" 'file 'archive 'comment)
14419 The following example counts the number of entries with TODO keyword
14420 @code{WAITING}, in all agenda files.
14423 (length (org-map-entries t "/+WAITING" 'agenda))
14426 @node MobileOrg, History and Acknowledgments, Hacking, Top
14427 @appendix MobileOrg
14431 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
14432 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
14433 @i{MobileOrg} offers offline viewing and capture support for an Org-mode
14434 system rooted on a ``real'' computer. It does also allow you to record
14435 changes to existing entries. Android users should check out
14436 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
14439 This appendix describes the support Org has for creating agenda views in a
14440 format that can be displayed by @i{MobileOrg}, and for integrating notes
14441 captured and changes made by @i{MobileOrg} into the main system.
14443 For changing tags and TODO states in MobileOrg, you should have set up the
14444 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
14445 cover all important tags and TODO keywords, even if individual files use only
14446 part of these. MobileOrg will also offer you states and tags set up with
14447 in-buffer settings, but it will understand the logistics of TODO state
14448 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
14449 (@pxref{Setting tags}) only for those set in these variables.
14452 * Setting up the staging area:: Where to interact with the mobile device
14453 * Pushing to MobileOrg:: Uploading Org files and agendas
14454 * Pulling from MobileOrg:: Integrating captured and flagged items
14457 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
14458 @section Setting up the staging area
14460 MobileOrg needs to interact with Emacs through a directory on a server. If you
14461 are using a public server, you should consider to encrypt the files that are
14462 uploaded to the server. This can be done with Org-mode 7.02 and with
14463 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
14464 installation on your system. To turn on encryption, set a password in
14465 @i{MobileOrg} and, on the Emacs side, configure the variable
14466 @code{org-mobile-use-encryption}@footnote{If you can safely store the
14467 password in your Emacs setup, you might also want to configure
14468 @code{org-mobile-encryption-password}. Please read the docstring of that
14469 variable. Note that encryption will apply only to the contents of the
14470 @file{.org} files. The file names themselves will remain visible.}.
14472 The easiest way to create that directory is to use a free
14473 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
14474 Dropbox, or if your version of MobileOrg does not support it, you can use a
14475 webdav server. For more information, check out the documentation of MobileOrg and also this
14476 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
14477 When MobileOrg first connects to your Dropbox, it will create a directory
14478 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
14482 (setq org-mobile-directory "~/Dropbox/MobileOrg")
14485 Org-mode has commands to put files for @i{MobileOrg} into that directory,
14486 and to read captured notes from there.
14488 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
14489 @section Pushing to MobileOrg
14491 This operation copies all files currently listed in @code{org-mobile-files}
14492 to the directory @code{org-mobile-directory}. By default this list contains
14493 all agenda files (as listed in @code{org-agenda-files}), but additional files
14494 can be included by customizing @code{org-mobiles-files}. File names will be
14495 staged with paths relative to @code{org-directory}, so all files should be
14496 inside this directory. The push operation also creates a special Org file
14497 @file{agendas.org} with all custom agenda view defined by the
14498 user@footnote{While creating the agendas, Org-mode will force ID properties
14499 on all referenced entries, so that these entries can be uniquely identified
14500 if @i{MobileOrg} flags them for further action. If you do not want to get
14501 these properties in so many entries, you can set the variable
14502 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
14503 rely on outline paths, in the hope that these will be unique enough.}.
14504 Finally, Org writes the file @file{index.org}, containing links to all other
14505 files. @i{MobileOrg} first reads this file from the server, and then
14506 downloads all agendas and Org files listed in it. To speed up the download,
14507 MobileOrg will only read files whose checksums@footnote{stored automatically
14508 in the file @file{checksums.dat}} have changed.
14510 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
14511 @section Pulling from MobileOrg
14513 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
14514 files for viewing. It also appends captured entries and pointers to flagged
14515 and changed entries to the file @file{mobileorg.org} on the server. Org has
14516 a @emph{pull} operation that integrates this information into an inbox file
14517 and operates on the pointers to flagged entries. Here is how it works:
14521 Org moves all entries found in
14522 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
14523 operation.} and appends them to the file pointed to by the variable
14524 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
14525 will be a top-level entry in the inbox file.
14527 After moving the entries, Org will attempt to implement the changes made in
14528 @i{MobileOrg}. Some changes are applied directly and without user
14529 interaction. Examples are all changes to tags, TODO state, headline and body
14530 text that can be cleanly applied. Entries that have been flagged for further
14531 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
14532 again. When there is a problem finding an entry or applying the change, the
14533 pointer entry will remain in the inbox and will be marked with an error
14534 message. You need to later resolve these issues by hand.
14536 Org will then generate an agenda view with all flagged entries. The user
14537 should then go through these entries and do whatever actions are necessary.
14538 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
14539 will be displayed in the echo area when the cursor is on the corresponding
14544 Pressing @kbd{?} in that special agenda will display the full flagging note in
14545 another window and also push it onto the kill ring. So you could use @kbd{?
14546 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
14547 Pressing @kbd{?} twice in succession will offer to remove the
14548 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
14549 in a property). In this way you indicate that the intended processing for
14550 this flagged entry is finished.
14555 If you are not able to process all flagged entries directly, you can always
14556 return to this agenda view@footnote{Note, however, that there is a subtle
14557 difference. The view created automatically by @kbd{M-x org-mobile-pull
14558 @key{RET}} is guaranteed to search all files that have been addressed by the
14559 last pull. This might include a file that is not currently in your list of
14560 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
14561 the current agenda files will be searched.} using @kbd{C-c a ?}.
14563 @node History and Acknowledgments, Main Index, MobileOrg, Top
14564 @appendix History and acknowledgments
14565 @cindex acknowledgments
14569 Org was born in 2003, out of frustration over the user interface of the Emacs
14570 Outline mode. I was trying to organize my notes and projects, and using
14571 Emacs seemed to be the natural way to go. However, having to remember eleven
14572 different commands with two or three keys per command, only to hide and show
14573 parts of the outline tree, that seemed entirely unacceptable to me. Also,
14574 when using outlines to take notes, I constantly wanted to restructure the
14575 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
14576 cycling} and @emph{structure editing} were originally implemented in the
14577 package @file{outline-magic.el}, but quickly moved to the more general
14578 @file{org.el}. As this environment became comfortable for project planning,
14579 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
14580 @emph{table support}. These areas highlighted the two main goals that Org
14581 still has today: to be a new, outline-based, plain text mode with innovative
14582 and intuitive editing features, and to incorporate project planning
14583 functionality directly into a notes file.
14585 Since the first release, literally thousands of emails to me or to
14586 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
14587 reports, feedback, new ideas, and sometimes patches and add-on code.
14588 Many thanks to everyone who has helped to improve this package. I am
14589 trying to keep here a list of the people who had significant influence
14590 in shaping one or more aspects of Org. The list may not be
14591 complete, if I have forgotten someone, please accept my apologies and
14594 Before I get to this list, a few special mentions are in order:
14597 @item Bastien Guerry
14598 Bastien has written a large number of extensions to Org (most of them
14599 integrated into the core by now), including the LaTeX exporter and the plain
14600 list parser. His support during the early days, when he basically acted as
14601 co-maintainer, was central to the success of this project. Bastien also
14602 invented Worg, helped establishing the Web presence of Org, and sponsors
14603 hosting costs for the orgmode.org website.
14604 @item Eric Schulte and Dan Davison
14605 Eric and Dan are jointly responsible for the Org-babel system, which turns
14606 Org into a multi-language environment for evaluating code and doing literate
14607 programming and reproducible research.
14609 John has contributed a number of great ideas and patches directly to Org,
14610 including the attachment system (@file{org-attach.el}), integration with
14611 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
14612 items, habit tracking (@file{org-habits.el}), and encryption
14613 (@file{org-crypt.el}). Also, the capture system is really an extended copy
14614 of his great @file{remember.el}.
14615 @item Sebastian Rose
14616 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
14617 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
14618 higher level. He also wrote @file{org-info.js}, a Java script for displaying
14619 webpages derived from Org using an Info-like or a folding interface with
14620 single-key navigation.
14623 @noindent OK, now to the full list of contributions! Again, please let me
14624 know what I am missing here!
14629 @i{Russel Adams} came up with the idea for drawers.
14631 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
14633 @i{Christophe Bataillon} created the great unicorn logo that we use on the
14636 @i{Alex Bochannek} provided a patch for rounding timestamps.
14638 @i{Jan Böcker} wrote @file{org-docview.el}.
14640 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
14642 @i{Tom Breton} wrote @file{org-choose.el}.
14644 @i{Charles Cave}'s suggestion sparked the implementation of templates
14645 for Remember, which are now templates for capture.
14647 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
14650 @i{Gregory Chernov} patched support for Lisp forms into table
14651 calculations and improved XEmacs compatibility, in particular by porting
14652 @file{nouline.el} to XEmacs.
14654 @i{Sacha Chua} suggested copying some linking code from Planner.
14656 @i{Baoqiu Cui} contributed the DocBook exporter.
14658 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
14659 came up with the idea of properties, and that there should be an API for
14662 @i{Nick Dokos} tracked down several nasty bugs.
14664 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
14665 inspired some of the early development, including HTML export. He also
14666 asked for a way to narrow wide table columns.
14668 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
14669 the Org-Babel documentation into the manual.
14671 @i{Christian Egli} converted the documentation into Texinfo format, inspired
14672 the agenda, patched CSS formatting into the HTML exporter, and wrote
14673 @file{org-taskjuggler.el}.
14675 @i{David Emery} provided a patch for custom CSS support in exported
14678 @i{Nic Ferrier} contributed mailcap and XOXO support.
14680 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
14682 @i{John Foerch} figured out how to make incremental search show context
14683 around a match in a hidden outline tree.
14685 @i{Raimar Finken} wrote @file{org-git-line.el}.
14687 @i{Mikael Fornius} works as a mailing list moderator.
14689 @i{Austin Frank} works as a mailing list moderator.
14691 @i{Eric Fraga} drove the development of BEAMER export with ideas and
14694 @i{Barry Gidden} did proofreading the manual in preparation for the book
14695 publication through Network Theory Ltd.
14697 @i{Niels Giesen} had the idea to automatically archive DONE trees.
14699 @i{Nicolas Goaziou} rewrote much of the plain list code.
14701 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
14703 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
14706 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
14707 task state change logging, and the clocktable. His clear explanations have
14708 been critical when we started to adopt the Git version control system.
14710 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
14713 @i{Phil Jackson} wrote @file{org-irc.el}.
14715 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
14716 folded entries, and column view for properties.
14718 @i{Matt Jones} wrote @i{MobileOrg Android}.
14720 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
14722 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
14723 provided frequent feedback and some patches.
14725 @i{Matt Lundin} has proposed last-row references for table formulas and named
14726 invisible anchors. He has also worked a lot on the FAQ.
14728 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
14729 and is a prolific contributor on the mailing list with competent replies,
14730 small fixes and patches.
14732 @i{Jason F. McBrayer} suggested agenda export to CSV format.
14734 @i{Max Mikhanosha} came up with the idea of refiling.
14736 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
14739 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
14742 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
14744 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
14745 and being able to quickly restrict the agenda to a subtree.
14747 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
14749 @i{Greg Newman} refreshed the unicorn logo into its current form.
14751 @i{Tim O'Callaghan} suggested in-file links, search options for general
14752 file links, and TAGS.
14754 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
14755 version of the reference card.
14757 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
14760 @i{Oliver Oppitz} suggested multi-state TODO items.
14762 @i{Scott Otterson} sparked the introduction of descriptive text for
14763 links, among other things.
14765 @i{Pete Phillips} helped during the development of the TAGS feature, and
14766 provided frequent feedback.
14768 @i{Martin Pohlack} provided the code snippet to bundle character insertion
14769 into bundles of 20 for undo.
14771 @i{T.V. Raman} reported bugs and suggested improvements.
14773 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
14776 @i{Paul Rivier} provided the basic implementation of named footnotes. He
14777 also acted as mailing list moderator for some time.
14779 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
14781 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
14782 conflict with @file{allout.el}.
14784 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
14787 @i{Philip Rooke} created the Org reference card, provided lots
14788 of feedback, developed and applied standards to the Org documentation.
14790 @i{Christian Schlauer} proposed angular brackets around links, among
14793 @i{Paul Sexton} wrote @file{org-ctags.el}.
14795 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
14796 @file{organizer-mode.el}.
14798 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
14799 examples, and remote highlighting for referenced code lines.
14801 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
14802 now packaged into Org's @file{contrib} directory.
14804 @i{Daniel Sinder} came up with the idea of internal archiving by locking
14807 @i{Dale Smith} proposed link abbreviations.
14809 @i{James TD Smith} has contributed a large number of patches for useful
14810 tweaks and features.
14812 @i{Adam Spiers} asked for global linking commands, inspired the link
14813 extension system, added support for mairix, and proposed the mapping API.
14815 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
14816 LaTeX, UTF-8, Latin-1 and ASCII.
14818 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
14819 with links transformation to Org syntax.
14821 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
14822 chapter about publishing.
14824 @i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and
14825 enabled source code highlighling in Gnus.
14827 @i{Stefan Vollmar} organized a video-recorded talk at the
14828 Max-Planck-Institute for Neurology. He also inspired the creation of a
14829 concept index for HTML export.
14831 @i{J@"urgen Vollmer} contributed code generating the table of contents
14834 @i{Samuel Wales} has provided important feedback and bug reports.
14836 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
14839 @i{David Wainberg} suggested archiving, and improvements to the linking
14842 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
14845 @i{Roland Winkler} requested additional key bindings to make Org
14848 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
14849 and contributed various ideas and code snippets.
14853 @node Main Index, Key Index, History and Acknowledgments, Top
14854 @unnumbered Concept index
14858 @node Key Index, Command and Function Index, Main Index, Top
14859 @unnumbered Key index
14863 @node Command and Function Index, Variable Index, Key Index, Top
14864 @unnumbered Command and function index
14868 @node Variable Index, , Command and Function Index, Top
14869 @unnumbered Variable index
14871 This is not a complete index of variables and faces, only the ones that are
14872 mentioned in the manual. For a more complete list, use @kbd{M-x
14873 org-customize @key{RET}} and then click yourself through the tree.
14880 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
14883 @c Local variables:
14885 @c indent-tabs-mode: nil
14886 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
14887 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
14891 @c LocalWords: webdavhost pre