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 For customizing Org to add new link types @ref{Adding hyperlink types}.
3098 A link should be enclosed in double brackets and may contain a
3099 descriptive text to be displayed instead of the URL (@pxref{Link
3100 format}), for example:
3103 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3107 If the description is a file name or URL that points to an image, HTML
3108 export (@pxref{HTML export}) will inline the image as a clickable
3109 button. If there is no description at all and the link points to an
3111 that image will be inlined into the exported HTML file.
3113 @cindex square brackets, around links
3114 @cindex plain text external links
3115 Org also finds external links in the normal text and activates them
3116 as links. If spaces must be part of the link (for example in
3117 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3118 about the end of the link, enclose them in square brackets.
3120 @node Handling links, Using links outside Org, External links, Hyperlinks
3121 @section Handling links
3122 @cindex links, handling
3124 Org provides methods to create a link in the correct syntax, to
3125 insert it into an Org file, and to follow the link.
3128 @orgcmd{C-c l,org-store-link}
3129 @cindex storing links
3130 Store a link to the current location. This is a @emph{global} command (you
3131 must create the key binding yourself) which can be used in any buffer to
3132 create a link. The link will be stored for later insertion into an Org
3133 buffer (see below). What kind of link will be created depends on the current
3136 @b{Org-mode buffers}@*
3137 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3138 to the target. Otherwise it points to the current headline, which will also
3141 @vindex org-link-to-org-use-id
3142 @cindex property, CUSTOM_ID
3143 @cindex property, ID
3144 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3145 will be stored. In addition or alternatively (depending on the value of
3146 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3147 created and/or used to construct a link. So using this command in Org
3148 buffers will potentially create two links: a human-readable from the custom
3149 ID, and one that is globally unique and works even if the entry is moved from
3150 file to file. Later, when inserting the link, you need to decide which one
3153 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3154 Pretty much all Emacs mail clients are supported. The link will point to the
3155 current article, or, in some GNUS buffers, to the group. The description is
3156 constructed from the author and the subject.
3158 @b{Web browsers: W3 and W3M}@*
3159 Here the link will be the current URL, with the page title as description.
3161 @b{Contacts: BBDB}@*
3162 Links created in a BBDB buffer will point to the current entry.
3165 @vindex org-irc-link-to-logs
3166 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3167 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3168 the current conversation is created. Otherwise an @samp{irc:/} style link to
3169 the user/channel/server under the point will be stored.
3172 For any other files, the link will point to the file, with a search string
3173 (@pxref{Search options}) pointing to the contents of the current line. If
3174 there is an active region, the selected words will form the basis of the
3175 search string. If the automatically created link is not working correctly or
3176 accurately enough, you can write custom functions to select the search string
3177 and to do the search for particular file types---see @ref{Custom searches}.
3178 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3181 When the cursor is in an agenda view, the created link points to the
3182 entry referenced by the current line.
3185 @orgcmd{C-c C-l,org-insert-link}
3186 @cindex link completion
3187 @cindex completion, of links
3188 @cindex inserting links
3189 @vindex org-keep-stored-link-after-insertion
3190 Insert a link@footnote{ Note that you don't have to use this command to
3191 insert a link. Links in Org are plain text, and you can type or paste them
3192 straight into the buffer. By using this command, the links are automatically
3193 enclosed in double brackets, and you will be asked for the optional
3194 descriptive text.}. This prompts for a link to be inserted into the buffer.
3195 You can just type a link, using text for an internal link, or one of the link
3196 type prefixes mentioned in the examples above. The link will be inserted
3197 into the buffer@footnote{After insertion of a stored link, the link will be
3198 removed from the list of stored links. To keep it in the list later use, use
3199 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3200 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3201 If some text was selected when this command is called, the selected text
3202 becomes the default description.
3204 @b{Inserting stored links}@*
3205 All links stored during the
3206 current session are part of the history for this prompt, so you can access
3207 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3209 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3210 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3211 defined through link abbreviations (@pxref{Link abbreviations}). If you
3212 press @key{RET} after inserting only the @var{prefix}, Org will offer
3213 specific completion support for some link types@footnote{This works by
3214 calling a special function @code{org-PREFIX-complete-link}.} For
3215 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3216 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3217 @key{RET}} you can complete contact names.
3219 @cindex file name completion
3220 @cindex completion, of file names
3221 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3222 a file will be inserted and you may use file name completion to select
3223 the name of the file. The path to the file is inserted relative to the
3224 directory of the current Org file, if the linked file is in the current
3225 directory or in a sub-directory of it, or if the path is written relative
3226 to the current directory using @samp{../}. Otherwise an absolute path
3227 is used, if possible with @samp{~/} for your home directory. You can
3228 force an absolute path with two @kbd{C-u} prefixes.
3230 @item C-c C-l @ @r{(with cursor on existing link)}
3231 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3232 link and description parts of the link.
3234 @cindex following links
3235 @orgcmd{C-c C-o,org-open-at-point}
3236 @vindex org-file-apps
3237 Open link at point. This will launch a web browser for URLs (using
3238 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3239 the corresponding links, and execute the command in a shell link. When the
3240 cursor is on an internal link, this command runs the corresponding search.
3241 When the cursor is on a TAG list in a headline, it creates the corresponding
3242 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3243 date. Furthermore, it will visit text and remote files in @samp{file:} links
3244 with Emacs and select a suitable application for local non-text files.
3245 Classification of files is based on file extension only. See option
3246 @code{org-file-apps}. If you want to override the default application and
3247 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3248 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3249 If the cursor is on a headline, but not on a link, offer all links in the
3250 headline and entry text.
3252 @vindex org-return-follows-link
3253 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3260 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3261 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3265 @vindex org-display-internal-link-with-indirect-buffer
3266 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3267 internal links to be displayed in another window@footnote{See the
3268 variable @code{org-display-internal-link-with-indirect-buffer}}.
3270 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3271 @cindex inlining images
3272 @cindex images, inlining
3273 @vindex org-startup-with-inline-images
3274 @cindex @code{inlineimages}, STARTUP keyword
3275 @cindex @code{noinlineimages}, STARTUP keyword
3276 Toggle the inline display of linked images. Normally this will only inline
3277 images that have no description part in the link, i.e. images that will also
3278 be inlined during export. When called with a prefix argument, also display
3279 images that do have a link description. You can ask for inline images to be
3280 displayed at startup by configuring the variable
3281 @code{org-startup-with-inline-images}@footnote{with corresponding
3282 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3283 @orgcmd{C-c %,org-mark-ring-push}
3285 Push the current position onto the mark ring, to be able to return
3286 easily. Commands following an internal link do this automatically.
3288 @orgcmd{C-c &,org-mark-ring-goto}
3289 @cindex links, returning to
3290 Jump back to a recorded position. A position is recorded by the
3291 commands following internal links, and by @kbd{C-c %}. Using this
3292 command several times in direct succession moves through a ring of
3293 previously recorded positions.
3295 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3296 @cindex links, finding next/previous
3297 Move forward/backward to the next link in the buffer. At the limit of
3298 the buffer, the search fails once, and then wraps around. The key
3299 bindings for this are really too long; you might want to bind this also
3300 to @kbd{C-n} and @kbd{C-p}
3302 (add-hook 'org-load-hook
3304 (define-key org-mode-map "\C-n" 'org-next-link)
3305 (define-key org-mode-map "\C-p" 'org-previous-link)))
3309 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3310 @section Using links outside Org
3312 You can insert and follow links that have Org syntax not only in
3313 Org, but in any Emacs buffer. For this, you should create two
3314 global commands, like this (please select suitable global keys
3318 (global-set-key "\C-c L" 'org-insert-link-global)
3319 (global-set-key "\C-c o" 'org-open-at-point-global)
3322 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3323 @section Link abbreviations
3324 @cindex link abbreviations
3325 @cindex abbreviation, links
3327 Long URLs can be cumbersome to type, and often many similar links are
3328 needed in a document. For this you can use link abbreviations. An
3329 abbreviated link looks like this
3332 [[linkword:tag][description]]
3336 @vindex org-link-abbrev-alist
3337 where the tag is optional.
3338 The @i{linkword} must be a word, starting with a letter, followed by
3339 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3340 according to the information in the variable @code{org-link-abbrev-alist}
3341 that relates the linkwords to replacement text. Here is an example:
3345 (setq org-link-abbrev-alist
3346 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3347 ("google" . "http://www.google.com/search?q=")
3348 ("gmap" . "http://maps.google.com/maps?q=%s")
3349 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3350 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3354 If the replacement text contains the string @samp{%s}, it will be
3355 replaced with the tag. Otherwise the tag will be appended to the string
3356 in order to create the link. You may also specify a function that will
3357 be called with the tag as the only argument to create the link.
3359 With the above setting, you could link to a specific bug with
3360 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3361 @code{[[google:OrgMode]]}, show the map location of the Free Software
3362 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3363 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3364 what the Org author is doing besides Emacs hacking with
3365 @code{[[ads:Dominik,C]]}.
3367 If you need special abbreviations just for a single Org buffer, you
3368 can define them in the file with
3372 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3373 #+LINK: google http://www.google.com/search?q=%s
3377 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3378 complete link abbreviations. You may also define a function
3379 @code{org-PREFIX-complete-link} that implements special (e.g. completion)
3380 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3381 not accept any arguments, and return the full link with prefix.
3383 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3384 @section Search options in file links
3385 @cindex search option in file links
3386 @cindex file links, searching
3388 File links can contain additional information to make Emacs jump to a
3389 particular location in the file when following a link. This can be a
3390 line number or a search option after a double@footnote{For backward
3391 compatibility, line numbers can also follow a single colon.} colon. For
3392 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3393 links}) to a file, it encodes the words in the current line as a search
3394 string that can be used to find this line back later when following the
3395 link with @kbd{C-c C-o}.
3397 Here is the syntax of the different ways to attach a search to a file
3398 link, together with an explanation:
3401 [[file:~/code/main.c::255]]
3402 [[file:~/xx.org::My Target]]
3403 [[file:~/xx.org::*My Target]]
3404 [[file:~/xx.org::#my-custom-id]]
3405 [[file:~/xx.org::/regexp/]]
3412 Search for a link target @samp{<<My Target>>}, or do a text search for
3413 @samp{my target}, similar to the search in internal links, see
3414 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3415 link will become an HTML reference to the corresponding named anchor in
3418 In an Org file, restrict search to headlines.
3420 Link to a heading with a @code{CUSTOM_ID} property
3422 Do a regular expression search for @code{regexp}. This uses the Emacs
3423 command @code{occur} to list all matches in a separate window. If the
3424 target file is in Org-mode, @code{org-occur} is used to create a
3425 sparse tree with the matches.
3426 @c If the target file is a directory,
3427 @c @code{grep} will be used to search all files in the directory.
3430 As a degenerate case, a file link with an empty file name can be used
3431 to search the current file. For example, @code{[[file:::find me]]} does
3432 a search for @samp{find me} in the current file, just as
3433 @samp{[[find me]]} would.
3435 @node Custom searches, , Search options, Hyperlinks
3436 @section Custom Searches
3437 @cindex custom search strings
3438 @cindex search strings, custom
3440 The default mechanism for creating search strings and for doing the
3441 actual search related to a file link may not work correctly in all
3442 cases. For example, Bib@TeX{} database files have many entries like
3443 @samp{year="1993"} which would not result in good search strings,
3444 because the only unique identification for a Bib@TeX{} entry is the
3447 @vindex org-create-file-search-functions
3448 @vindex org-execute-file-search-functions
3449 If you come across such a problem, you can write custom functions to set
3450 the right search string for a particular file type, and to do the search
3451 for the string in the file. Using @code{add-hook}, these functions need
3452 to be added to the hook variables
3453 @code{org-create-file-search-functions} and
3454 @code{org-execute-file-search-functions}. See the docstring for these
3455 variables for more information. Org actually uses this mechanism
3456 for Bib@TeX{} database files, and you can use the corresponding code as
3457 an implementation example. See the file @file{org-bibtex.el}.
3459 @node TODO Items, Tags, Hyperlinks, Top
3463 Org-mode does not maintain TODO lists as separate documents@footnote{Of
3464 course, you can make a document that contains only long lists of TODO items,
3465 but this is not required.}. Instead, TODO items are an integral part of the
3466 notes file, because TODO items usually come up while taking notes! With Org
3467 mode, simply mark any entry in a tree as being a TODO item. In this way,
3468 information is not duplicated, and the entire context from which the TODO
3469 item emerged is always present.
3471 Of course, this technique for managing TODO items scatters them
3472 throughout your notes file. Org-mode compensates for this by providing
3473 methods to give you an overview of all the things that you have to do.
3476 * TODO basics:: Marking and displaying TODO entries
3477 * TODO extensions:: Workflow and assignments
3478 * Progress logging:: Dates and notes for progress
3479 * Priorities:: Some things are more important than others
3480 * Breaking down tasks:: Splitting a task into manageable pieces
3481 * Checkboxes:: Tick-off lists
3484 @node TODO basics, TODO extensions, TODO Items, TODO Items
3485 @section Basic TODO functionality
3487 Any headline becomes a TODO item when it starts with the word
3488 @samp{TODO}, for example:
3491 *** TODO Write letter to Sam Fortune
3495 The most important commands to work with TODO entries are:
3498 @orgcmd{C-c C-t,org-todo}
3499 @cindex cycling, of TODO states
3500 Rotate the TODO state of the current item among
3503 ,-> (unmarked) -> TODO -> DONE --.
3504 '--------------------------------'
3507 The same rotation can also be done ``remotely'' from the timeline and
3508 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3510 @orgkey{C-u C-c C-t}
3511 Select a specific keyword using completion or (if it has been set up)
3512 the fast selection interface. For the latter, you need to assign keys
3513 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3516 @kindex S-@key{right}
3517 @kindex S-@key{left}
3518 @item S-@key{right} @ @r{/} @ S-@key{left}
3519 @vindex org-treat-S-cursor-todo-selection-as-state-change
3520 Select the following/preceding TODO state, similar to cycling. Useful
3521 mostly if more than two TODO states are possible (@pxref{TODO
3522 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3523 with @code{shift-selection-mode}. See also the variable
3524 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3525 @orgcmd{C-c / t,org-show-todo-key}
3526 @cindex sparse tree, for TODO
3527 @vindex org-todo-keywords
3528 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3529 entire buffer, but shows all TODO items (with not-DONE state) and the
3530 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3531 / T}), search for a specific TODO. You will be prompted for the keyword, and
3532 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3533 entries that match any one of these keywords. With numeric prefix argument
3534 N, show the tree for the Nth keyword in the variable
3535 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3536 both un-done and done.
3537 @orgcmd{C-c a t,org-todo-list}
3538 Show the global TODO list. Collects the TODO items (with not-DONE states)
3539 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3540 buffer will be in @code{agenda-mode}, which provides commands to examine and
3541 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3542 @xref{Global TODO list}, for more information.
3543 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3544 Insert a new TODO entry below the current one.
3548 @vindex org-todo-state-tags-triggers
3549 Changing a TODO state can also trigger tag changes. See the docstring of the
3550 option @code{org-todo-state-tags-triggers} for details.
3552 @node TODO extensions, Progress logging, TODO basics, TODO Items
3553 @section Extended use of TODO keywords
3554 @cindex extended TODO keywords
3556 @vindex org-todo-keywords
3557 By default, marked TODO entries have one of only two states: TODO and
3558 DONE. Org-mode allows you to classify TODO items in more complex ways
3559 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3560 special setup, the TODO keyword system can work differently in different
3563 Note that @i{tags} are another way to classify headlines in general and
3564 TODO items in particular (@pxref{Tags}).
3567 * Workflow states:: From TODO to DONE in steps
3568 * TODO types:: I do this, Fred does the rest
3569 * Multiple sets in one file:: Mixing it all, and still finding your way
3570 * Fast access to TODO states:: Single letter selection of a state
3571 * Per-file keywords:: Different files, different requirements
3572 * Faces for TODO keywords:: Highlighting states
3573 * TODO dependencies:: When one task needs to wait for others
3576 @node Workflow states, TODO types, TODO extensions, TODO extensions
3577 @subsection TODO keywords as workflow states
3578 @cindex TODO workflow
3579 @cindex workflow states as TODO keywords
3581 You can use TODO keywords to indicate different @emph{sequential} states
3582 in the process of working on an item, for example@footnote{Changing
3583 this variable only becomes effective after restarting Org-mode in a
3587 (setq org-todo-keywords
3588 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3591 The vertical bar separates the TODO keywords (states that @emph{need
3592 action}) from the DONE states (which need @emph{no further action}). If
3593 you don't provide the separator bar, the last state is used as the DONE
3595 @cindex completion, of TODO keywords
3596 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3597 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3598 also use a numeric prefix argument to quickly select a specific state. For
3599 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3600 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3601 define many keywords, you can use in-buffer completion
3602 (@pxref{Completion}) or even a special one-key selection scheme
3603 (@pxref{Fast access to TODO states}) to insert these words into the
3604 buffer. Changing a TODO state can be logged with a timestamp, see
3605 @ref{Tracking TODO state changes}, for more information.
3607 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3608 @subsection TODO keywords as types
3610 @cindex names as TODO keywords
3611 @cindex types as TODO keywords
3613 The second possibility is to use TODO keywords to indicate different
3614 @emph{types} of action items. For example, you might want to indicate
3615 that items are for ``work'' or ``home''. Or, when you work with several
3616 people on a single project, you might want to assign action items
3617 directly to persons, by using their names as TODO keywords. This would
3618 be set up like this:
3621 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3624 In this case, different keywords do not indicate a sequence, but rather
3625 different types. So the normal work flow would be to assign a task to a
3626 person, and later to mark it DONE. Org-mode supports this style by adapting
3627 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3628 @kbd{t} command in the timeline and agenda buffers.}. When used several
3629 times in succession, it will still cycle through all names, in order to first
3630 select the right type for a task. But when you return to the item after some
3631 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3632 to DONE. Use prefix arguments or completion to quickly select a specific
3633 name. You can also review the items of a specific TODO type in a sparse tree
3634 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3635 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3636 from all agenda files into a single buffer, you would use the numeric prefix
3637 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3639 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3640 @subsection Multiple keyword sets in one file
3641 @cindex TODO keyword sets
3643 Sometimes you may want to use different sets of TODO keywords in
3644 parallel. For example, you may want to have the basic
3645 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3646 separate state indicating that an item has been canceled (so it is not
3647 DONE, but also does not require action). Your setup would then look
3651 (setq org-todo-keywords
3652 '((sequence "TODO" "|" "DONE")
3653 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3654 (sequence "|" "CANCELED")))
3657 The keywords should all be different, this helps Org-mode to keep track
3658 of which subsequence should be used for a given entry. In this setup,
3659 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3660 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3661 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3662 select the correct sequence. Besides the obvious ways like typing a
3663 keyword or using completion, you may also apply the following commands:
3666 @kindex C-S-@key{right}
3667 @kindex C-S-@key{left}
3668 @kindex C-u C-u C-c C-t
3669 @item C-u C-u C-c C-t
3670 @itemx C-S-@key{right}
3671 @itemx C-S-@key{left}
3672 These keys jump from one TODO subset to the next. In the above example,
3673 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3674 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3675 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3676 @code{shift-selection-mode} (@pxref{Conflicts}).
3677 @kindex S-@key{right}
3678 @kindex S-@key{left}
3681 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3682 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3683 from @code{DONE} to @code{REPORT} in the example above. See also
3684 @ref{Conflicts}, for a discussion of the interaction with
3685 @code{shift-selection-mode}.
3688 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3689 @subsection Fast access to TODO states
3691 If you would like to quickly change an entry to an arbitrary TODO state
3692 instead of cycling through the states, you can set up keys for
3693 single-letter access to the states. This is done by adding the section
3694 key after each keyword, in parentheses. For example:
3697 (setq org-todo-keywords
3698 '((sequence "TODO(t)" "|" "DONE(d)")
3699 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3700 (sequence "|" "CANCELED(c)")))
3703 @vindex org-fast-tag-selection-include-todo
3704 If you then press @code{C-c C-t} followed by the selection key, the entry
3705 will be switched to this state. @key{SPC} can be used to remove any TODO
3706 keyword from an entry.@footnote{Check also the variable
3707 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3708 state through the tags interface (@pxref{Setting tags}), in case you like to
3709 mingle the two concepts. Note that this means you need to come up with
3710 unique keys across both sets of keywords.}
3712 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3713 @subsection Setting up keywords for individual files
3714 @cindex keyword options
3715 @cindex per-file keywords
3720 It can be very useful to use different aspects of the TODO mechanism in
3721 different files. For file-local settings, you need to add special lines
3722 to the file which set the keywords and interpretation for that file
3723 only. For example, to set one of the two examples discussed above, you
3724 need one of the following lines, starting in column zero anywhere in the
3728 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3730 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3731 interpretation, but it means the same as @code{#+TODO}), or
3733 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3736 A setup for using several sets in parallel would be:
3740 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3744 @cindex completion, of option keywords
3746 @noindent To make sure you are using the correct keyword, type
3747 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3749 @cindex DONE, final TODO keyword
3750 Remember that the keywords after the vertical bar (or the last keyword
3751 if no bar is there) must always mean that the item is DONE (although you
3752 may use a different word). After changing one of these lines, use
3753 @kbd{C-c C-c} with the cursor still in the line to make the changes
3754 known to Org-mode@footnote{Org-mode parses these lines only when
3755 Org-mode is activated after visiting a file. @kbd{C-c C-c} with the
3756 cursor in a line starting with @samp{#+} is simply restarting Org-mode
3757 for the current buffer.}.
3759 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3760 @subsection Faces for TODO keywords
3761 @cindex faces, for TODO keywords
3763 @vindex org-todo @r{(face)}
3764 @vindex org-done @r{(face)}
3765 @vindex org-todo-keyword-faces
3766 Org-mode highlights TODO keywords with special faces: @code{org-todo}
3767 for keywords indicating that an item still has to be acted upon, and
3768 @code{org-done} for keywords indicating that an item is finished. If
3769 you are using more than 2 different states, you might want to use
3770 special faces for some of them. This can be done using the variable
3771 @code{org-todo-keyword-faces}. For example:
3775 (setq org-todo-keyword-faces
3776 '(("TODO" . org-warning) ("STARTED" . "yellow")
3777 ("CANCELED" . (:foreground "blue" :weight bold))))
3781 While using a list with face properties as shown for CANCELED @emph{should}
3782 work, this does not aways seem to be the case. If necessary, define a
3783 special face and use that. A string is interpreted as a color. The variable
3784 @code{org-faces-easy-properties} determines if that color is interpreted as a
3785 foreground or a background color.
3787 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3788 @subsection TODO dependencies
3789 @cindex TODO dependencies
3790 @cindex dependencies, of TODO states
3792 @vindex org-enforce-todo-dependencies
3793 @cindex property, ORDERED
3794 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3795 dependencies. Usually, a parent TODO task should not be marked DONE until
3796 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3797 there is a logical sequence to a number of (sub)tasks, so that one task
3798 cannot be acted upon before all siblings above it are done. If you customize
3799 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3800 from changing state to DONE while they have children that are not DONE.
3801 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3802 will be blocked until all earlier siblings are marked DONE. Here is an
3806 * TODO Blocked until (two) is done
3815 ** TODO b, needs to wait for (a)
3816 ** TODO c, needs to wait for (a) and (b)
3820 @orgcmd{C-c C-x o,org-toggle-ordered-property}
3821 @vindex org-track-ordered-property-with-tag
3822 @cindex property, ORDERED
3823 Toggle the @code{ORDERED} property of the current entry. A property is used
3824 for this behavior because this should be local to the current entry, not
3825 inherited like a tag. However, if you would like to @i{track} the value of
3826 this property with a tag for better visibility, customize the variable
3827 @code{org-track-ordered-property-with-tag}.
3828 @orgkey{C-u C-u C-u C-c C-t}
3829 Change TODO state, circumventing any state blocking.
3832 @vindex org-agenda-dim-blocked-tasks
3833 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3834 that cannot be closed because of such dependencies will be shown in a dimmed
3835 font or even made invisible in agenda views (@pxref{Agenda Views}).
3837 @cindex checkboxes and TODO dependencies
3838 @vindex org-enforce-todo-dependencies
3839 You can also block changes of TODO states by looking at checkboxes
3840 (@pxref{Checkboxes}). If you set the variable
3841 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3842 checkboxes will be blocked from switching to DONE.
3844 If you need more complex dependency structures, for example dependencies
3845 between entries in different trees or files, check out the contributed
3846 module @file{org-depend.el}.
3849 @node Progress logging, Priorities, TODO extensions, TODO Items
3850 @section Progress logging
3851 @cindex progress logging
3852 @cindex logging, of progress
3854 Org-mode can automatically record a timestamp and possibly a note when
3855 you mark a TODO item as DONE, or even each time you change the state of
3856 a TODO item. This system is highly configurable, settings can be on a
3857 per-keyword basis and can be localized to a file or even a subtree. For
3858 information on how to clock working time for a task, see @ref{Clocking
3862 * Closing items:: When was this entry marked DONE?
3863 * Tracking TODO state changes:: When did the status change?
3864 * Tracking your habits:: How consistent have you been?
3867 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3868 @subsection Closing items
3870 The most basic logging is to keep track of @emph{when} a certain TODO
3871 item was finished. This is achieved with@footnote{The corresponding
3872 in-buffer setting is: @code{#+STARTUP: logdone}}
3875 (setq org-log-done 'time)
3879 Then each time you turn an entry from a TODO (not-done) state into any
3880 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3881 just after the headline. If you turn the entry back into a TODO item
3882 through further state cycling, that line will be removed again. If you
3883 want to record a note along with the timestamp, use@footnote{The
3884 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3887 (setq org-log-done 'note)
3891 You will then be prompted for a note, and that note will be stored below
3892 the entry with a @samp{Closing Note} heading.
3894 In the timeline (@pxref{Timeline}) and in the agenda
3895 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3896 display the TODO items with a @samp{CLOSED} timestamp on each day,
3897 giving you an overview of what has been done.
3899 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
3900 @subsection Tracking TODO state changes
3901 @cindex drawer, for state change recording
3903 @vindex org-log-states-order-reversed
3904 @vindex org-log-into-drawer
3905 @cindex property, LOG_INTO_DRAWER
3906 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3907 might want to keep track of when a state change occurred and maybe take a
3908 note about this change. You can either record just a timestamp, or a
3909 time-stamped note for a change. These records will be inserted after the
3910 headline as an itemized list, newest first@footnote{See the variable
3911 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
3912 want to get the notes out of the way into a drawer (@pxref{Drawers}).
3913 Customize the variable @code{org-log-into-drawer} to get this
3914 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
3915 also overrule the setting of this variable for a subtree by setting a
3916 @code{LOG_INTO_DRAWER} property.
3918 Since it is normally too much to record a note for every state, Org-mode
3919 expects configuration on a per-keyword basis for this. This is achieved by
3920 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
3921 in parentheses after each keyword. For example, with the setting
3924 (setq org-todo-keywords
3925 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3929 @vindex org-log-done
3930 you not only define global TODO keywords and fast access keys, but also
3931 request that a time is recorded when the entry is set to
3932 DONE@footnote{It is possible that Org-mode will record two timestamps
3933 when you are using both @code{org-log-done} and state change logging.
3934 However, it will never prompt for two notes---if you have configured
3935 both, the state change recording note will take precedence and cancel
3936 the @samp{Closing Note}.}, and that a note is recorded when switching to
3937 WAIT or CANCELED. The setting for WAIT is even more special: the
3938 @samp{!} after the slash means that in addition to the note taken when
3939 entering the state, a timestamp should be recorded when @i{leaving} the
3940 WAIT state, if and only if the @i{target} state does not configure
3941 logging for entering it. So it has no effect when switching from WAIT
3942 to DONE, because DONE is configured to record a timestamp only. But
3943 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3944 setting now triggers a timestamp even though TODO has no logging
3947 You can use the exact same syntax for setting logging preferences local
3950 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3953 @cindex property, LOGGING
3954 In order to define logging settings that are local to a subtree or a
3955 single item, define a LOGGING property in this entry. Any non-empty
3956 LOGGING property resets all logging settings to nil. You may then turn
3957 on logging for this specific tree using STARTUP keywords like
3958 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3959 settings like @code{TODO(!)}. For example
3962 * TODO Log each state with only a time
3964 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
3966 * TODO Only log when switching to WAIT, and when repeating
3968 :LOGGING: WAIT(@@) logrepeat
3970 * TODO No logging at all
3976 @node Tracking your habits, , Tracking TODO state changes, Progress logging
3977 @subsection Tracking your habits
3980 Org has the ability to track the consistency of a special category of TODOs,
3981 called ``habits''. A habit has the following properties:
3985 You have enabled the @code{habits} module by customizing the variable
3988 The habit is a TODO, with a TODO keyword representing an open state.
3990 The property @code{STYLE} is set to the value @code{habit}.
3992 The TODO has a scheduled date, usually with a @code{.+} style repeat
3993 interval. A @code{++} style may be appropriate for habits with time
3994 constraints, e.g., must be done on weekends, or a @code{+} style for an
3995 unusual habit that can have a backlog, e.g., weekly reports.
3997 The TODO may also have minimum and maximum ranges specified by using the
3998 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
3999 three days, but at most every two days.
4001 You must also have state logging for the @code{DONE} state enabled, in order
4002 for historical data to be represented in the consistency graph. If it's not
4003 enabled it's not an error, but the consistency graphs will be largely
4007 To give you an idea of what the above rules look like in action, here's an
4008 actual habit with some history:
4012 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4013 - State "DONE" from "TODO" [2009-10-15 Thu]
4014 - State "DONE" from "TODO" [2009-10-12 Mon]
4015 - State "DONE" from "TODO" [2009-10-10 Sat]
4016 - State "DONE" from "TODO" [2009-10-04 Sun]
4017 - State "DONE" from "TODO" [2009-10-02 Fri]
4018 - State "DONE" from "TODO" [2009-09-29 Tue]
4019 - State "DONE" from "TODO" [2009-09-25 Fri]
4020 - State "DONE" from "TODO" [2009-09-19 Sat]
4021 - State "DONE" from "TODO" [2009-09-16 Wed]
4022 - State "DONE" from "TODO" [2009-09-12 Sat]
4025 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4029 What this habit says is: I want to shave at most every 2 days (given by the
4030 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4031 today is the 15th, then the habit first appears in the agenda on Oct 17,
4032 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4033 after four days have elapsed.
4035 What's really useful about habits is that they are displayed along with a
4036 consistency graph, to show how consistent you've been at getting that task
4037 done in the past. This graph shows every day that the task was done over the
4038 past three weeks, with colors for each day. The colors used are:
4042 If the task wasn't to be done yet on that day.
4044 If the task could have been done on that day.
4046 If the task was going to be overdue the next day.
4048 If the task was overdue on that day.
4051 In addition to coloring each day, the day is also marked with an asterisk if
4052 the task was actually done that day, and an exclamation mark to show where
4053 the current day falls in the graph.
4055 There are several configuration variables that can be used to change the way
4056 habits are displayed in the agenda.
4059 @item org-habit-graph-column
4060 The buffer column at which the consistency graph should be drawn. This will
4061 overwrite any text in that column, so it's a good idea to keep your habits'
4062 titles brief and to the point.
4063 @item org-habit-preceding-days
4064 The amount of history, in days before today, to appear in consistency graphs.
4065 @item org-habit-following-days
4066 The number of days after today that will appear in consistency graphs.
4067 @item org-habit-show-habits-only-for-today
4068 If non-nil, only show habits in today's agenda view. This is set to true by
4072 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4073 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4074 bring them back. They are also subject to tag filtering, if you have habits
4075 which should only be done in certain contexts, for example.
4077 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4081 If you use Org-mode extensively, you may end up with enough TODO items that
4082 it starts to make sense to prioritize them. Prioritizing can be done by
4083 placing a @emph{priority cookie} into the headline of a TODO item, like this
4086 *** TODO [#A] Write letter to Sam Fortune
4090 @vindex org-priority-faces
4091 By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
4092 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4093 treated just like priority @samp{B}. Priorities make a difference only for
4094 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4095 have no inherent meaning to Org-mode. The cookies can be highlighted with
4096 special faces by customizing the variable @code{org-priority-faces}.
4098 Priorities can be attached to any outline node; they do not need to be TODO
4104 @findex org-priority
4105 Set the priority of the current headline (@command{org-priority}). The
4106 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4107 When you press @key{SPC} instead, the priority cookie is removed from the
4108 headline. The priorities can also be changed ``remotely'' from the timeline
4109 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4111 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4112 @vindex org-priority-start-cycle-with-default
4113 Increase/decrease priority of current headline@footnote{See also the option
4114 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4115 also used to modify timestamps (@pxref{Creating timestamps}). See also
4116 @ref{Conflicts}, for a discussion of the interaction with
4117 @code{shift-selection-mode}.
4120 @vindex org-highest-priority
4121 @vindex org-lowest-priority
4122 @vindex org-default-priority
4123 You can change the range of allowed priorities by setting the variables
4124 @code{org-highest-priority}, @code{org-lowest-priority}, and
4125 @code{org-default-priority}. For an individual buffer, you may set
4126 these values (highest, lowest, default) like this (please make sure that
4127 the highest priority is earlier in the alphabet than the lowest
4130 @cindex #+PRIORITIES
4135 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4136 @section Breaking tasks down into subtasks
4137 @cindex tasks, breaking down
4138 @cindex statistics, for TODO items
4140 @vindex org-agenda-todo-list-sublevels
4141 It is often advisable to break down large tasks into smaller, manageable
4142 subtasks. You can do this by creating an outline tree below a TODO item,
4143 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4144 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4145 the overview over the fraction of subtasks that are already completed, insert
4146 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4147 be updated each time the TODO status of a child changes, or when pressing
4148 @kbd{C-c C-c} on the cookie. For example:
4151 * Organize Party [33%]
4152 ** TODO Call people [1/2]
4156 ** DONE Talk to neighbor
4159 @cindex property, COOKIE_DATA
4160 If a heading has both checkboxes and TODO children below it, the meaning of
4161 the statistics cookie become ambiguous. Set the property
4162 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4165 @vindex org-hierarchical-todo-statistics
4166 If you would like to have the statistics cookie count any TODO entries in the
4167 subtree (not just direct children), configure the variable
4168 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4169 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4173 * Parent capturing statistics [2/20]
4175 :COOKIE_DATA: todo recursive
4179 If you would like a TODO entry to automatically change to DONE
4180 when all children are done, you can use the following setup:
4183 (defun org-summary-todo (n-done n-not-done)
4184 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4185 (let (org-log-done org-log-states) ; turn off logging
4186 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4188 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4192 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4193 large number of subtasks (@pxref{Checkboxes}).
4196 @node Checkboxes, , Breaking down tasks, TODO Items
4200 @vindex org-list-automatic-rules
4201 Every item in a plain list@footnote{With the exception of description
4202 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4203 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4204 it with the string @samp{[ ]}. This feature is similar to TODO items
4205 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4206 into the global TODO list, so they are often great to split a task into a
4207 number of simple steps. Or you can use them in a shopping list. To toggle a
4208 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4209 @file{org-mouse.el}).
4211 Here is an example of a checkbox list.
4214 * TODO Organize party [2/4]
4215 - [-] call people [1/3]
4220 - [ ] think about what music to play
4221 - [X] talk to the neighbors
4224 Checkboxes work hierarchically, so if a checkbox item has children that
4225 are checkboxes, toggling one of the children checkboxes will make the
4226 parent checkbox reflect if none, some, or all of the children are
4229 @cindex statistics, for checkboxes
4230 @cindex checkbox statistics
4231 @cindex property, COOKIE_DATA
4232 @vindex org-hierarchical-checkbox-statistics
4233 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4234 indicating how many checkboxes present in this entry have been checked off,
4235 and the total number of checkboxes present. This can give you an idea on how
4236 many checkboxes remain, even without opening a folded entry. The cookies can
4237 be placed into a headline or into (the first line of) a plain list item.
4238 Each cookie covers checkboxes of direct children structurally below the
4239 headline/item on which the cookie appears@footnote{Set the variable
4240 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4241 represent the all checkboxes below the cookie, not just the direct
4242 children.}. You have to insert the cookie yourself by typing either
4243 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4244 result, as in the examples above. With @samp{[%]} you get information about
4245 the percentage of checkboxes checked (in the above example, this would be
4246 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4247 count either checkboxes below the heading or TODO states of children, and it
4248 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4249 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4251 @cindex blocking, of checkboxes
4252 @cindex checkbox blocking
4253 @cindex property, ORDERED
4254 If the current outline node has an @code{ORDERED} property, checkboxes must
4255 be checked off in sequence, and an error will be thrown if you try to check
4256 off a box while there are unchecked boxes above it.
4258 @noindent The following commands work with checkboxes:
4261 @orgcmd{C-c C-c,org-toggle-checkbox}
4262 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4263 double prefix argument, set it to @samp{[-]}, which is considered to be an
4265 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4266 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4267 double prefix argument, set it to @samp{[-]}, which is considered to be an
4271 If there is an active region, toggle the first checkbox in the region
4272 and set all remaining boxes to the same status as the first. With a prefix
4273 arg, add or remove the checkbox for all items in the region.
4275 If the cursor is in a headline, toggle checkboxes in the region between
4276 this headline and the next (so @emph{not} the entire subtree).
4278 If there is no active region, just toggle the checkbox at point.
4280 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4281 Insert a new item with a checkbox.
4282 This works only if the cursor is already in a plain list item
4283 (@pxref{Plain lists}).
4284 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4285 @vindex org-track-ordered-property-with-tag
4286 @cindex property, ORDERED
4287 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4288 be checked off in sequence. A property is used for this behavior because
4289 this should be local to the current entry, not inherited like a tag.
4290 However, if you would like to @i{track} the value of this property with a tag
4291 for better visibility, customize the variable
4292 @code{org-track-ordered-property-with-tag}.
4293 @orgcmd{C-c #,org-update-statistics-cookies}
4294 Update the statistics cookie in the current outline entry. When called with
4295 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4296 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4297 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4298 changing TODO states. If you delete boxes/entries or add/change them by
4299 hand, use this command to get things back into sync. Or simply toggle any
4300 entry twice (checkboxes with @kbd{C-c C-c}).
4303 @node Tags, Properties and Columns, TODO Items, Top
4306 @cindex headline tagging
4307 @cindex matching, tags
4308 @cindex sparse tree, tag based
4310 An excellent way to implement labels and contexts for cross-correlating
4311 information is to assign @i{tags} to headlines. Org-mode has extensive
4314 @vindex org-tag-faces
4315 Every headline can contain a list of tags; they occur at the end of the
4316 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4317 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4318 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4319 Tags will by default be in bold face with the same color as the headline.
4320 You may specify special faces for specific tags using the variable
4321 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4322 (@pxref{Faces for TODO keywords}).
4325 * Tag inheritance:: Tags use the tree structure of the outline
4326 * Setting tags:: How to assign tags to a headline
4327 * Tag searches:: Searching for combinations of tags
4330 @node Tag inheritance, Setting tags, Tags, Tags
4331 @section Tag inheritance
4332 @cindex tag inheritance
4333 @cindex inheritance, of tags
4334 @cindex sublevels, inclusion into tags match
4336 @i{Tags} make use of the hierarchical structure of outline trees. If a
4337 heading has a certain tag, all subheadings will inherit the tag as
4338 well. For example, in the list
4341 * Meeting with the French group :work:
4342 ** Summary by Frank :boss:notes:
4343 *** TODO Prepare slides for him :action:
4347 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4348 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4349 explicitly marked with those tags. You can also set tags that all entries in
4350 a file should inherit just as if these tags were defined in a hypothetical
4351 level zero that surrounds the entire file. Use a line like this@footnote{As
4352 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4353 changes in the line.}:
4357 #+FILETAGS: :Peter:Boss:Secret:
4361 @vindex org-use-tag-inheritance
4362 @vindex org-tags-exclude-from-inheritance
4363 To limit tag inheritance to specific tags, or to turn it off entirely, use
4364 the variables @code{org-use-tag-inheritance} and
4365 @code{org-tags-exclude-from-inheritance}.
4367 @vindex org-tags-match-list-sublevels
4368 When a headline matches during a tags search while tag inheritance is turned
4369 on, all the sublevels in the same tree will (for a simple match form) match
4370 as well@footnote{This is only true if the search does not involve more
4371 complex tests including properties (@pxref{Property searches}).}. The list
4372 of matches may then become very long. If you only want to see the first tags
4373 match in a subtree, configure the variable
4374 @code{org-tags-match-list-sublevels} (not recommended).
4376 @node Setting tags, Tag searches, Tag inheritance, Tags
4377 @section Setting tags
4378 @cindex setting tags
4379 @cindex tags, setting
4382 Tags can simply be typed into the buffer at the end of a headline.
4383 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4384 also a special command for inserting tags:
4387 @orgcmd{C-c C-q,org-set-tags-command}
4388 @cindex completion, of tags
4389 @vindex org-tags-column
4390 Enter new tags for the current headline. Org-mode will either offer
4391 completion or a special single-key interface for setting tags, see
4392 below. After pressing @key{RET}, the tags will be inserted and aligned
4393 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4394 tags in the current buffer will be aligned to that column, just to make
4395 things look nice. TAGS are automatically realigned after promotion,
4396 demotion, and TODO state changes (@pxref{TODO basics}).
4397 @orgcmd{C-c C-c,org-set-tags-command}
4398 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4401 @vindex org-tag-alist
4402 Org will support tag insertion based on a @emph{list of tags}. By
4403 default this list is constructed dynamically, containing all tags
4404 currently used in the buffer. You may also globally specify a hard list
4405 of tags with the variable @code{org-tag-alist}. Finally you can set
4406 the default tags for a given file with lines like
4410 #+TAGS: @@work @@home @@tennisclub
4411 #+TAGS: laptop car pc sailboat
4414 If you have globally defined your preferred set of tags using the
4415 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4416 in a specific file, add an empty TAGS option line to that file:
4422 @vindex org-tag-persistent-alist
4423 If you have a preferred set of tags that you would like to use in every file,
4424 in addition to those defined on a per-file basis by TAGS option lines, then
4425 you may specify a list of tags with the variable
4426 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4427 by adding a STARTUP option line to that file:
4433 By default Org-mode uses the standard minibuffer completion facilities for
4434 entering tags. However, it also implements another, quicker, tag selection
4435 method called @emph{fast tag selection}. This allows you to select and
4436 deselect tags with just a single key press. For this to work well you should
4437 assign unique letters to most of your commonly used tags. You can do this
4438 globally by configuring the variable @code{org-tag-alist} in your
4439 @file{.emacs} file. For example, you may find the need to tag many items in
4440 different files with @samp{:@@home:}. In this case you can set something
4444 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4447 @noindent If the tag is only relevant to the file you are working on, then you
4448 can instead set the TAGS option line as:
4451 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4454 @noindent The tags interface will show the available tags in a splash
4455 window. If you want to start a new line after a specific tag, insert
4456 @samp{\n} into the tag list
4459 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4462 @noindent or write them in two lines:
4465 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4466 #+TAGS: laptop(l) pc(p)
4470 You can also group together tags that are mutually exclusive by using
4474 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4477 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4478 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4480 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4481 these lines to activate any changes.
4484 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4485 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4486 of the braces. Similarly, you can use @code{:newline} to indicate a line
4487 break. The previous example would be set globally by the following
4491 (setq org-tag-alist '((:startgroup . nil)
4492 ("@@work" . ?w) ("@@home" . ?h)
4493 ("@@tennisclub" . ?t)
4495 ("laptop" . ?l) ("pc" . ?p)))
4498 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4499 automatically present you with a special interface, listing inherited tags,
4500 the tags of the current headline, and a list of all valid tags with
4501 corresponding keys@footnote{Keys will automatically be assigned to tags which
4502 have no configured keys.}. In this interface, you can use the following
4507 Pressing keys assigned to tags will add or remove them from the list of
4508 tags in the current line. Selecting a tag in a group of mutually
4509 exclusive tags will turn off any other tags from that group.
4512 Enter a tag in the minibuffer, even if the tag is not in the predefined
4513 list. You will be able to complete on all tags present in the buffer.
4514 You can also add several tags: just separate them with a comma.
4518 Clear all tags for this line.
4521 Accept the modified set.
4523 Abort without installing changes.
4525 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4527 Turn off groups of mutually exclusive tags. Use this to (as an
4528 exception) assign several tags from such a group.
4530 Toggle auto-exit after the next change (see below).
4531 If you are using expert mode, the first @kbd{C-c} will display the
4536 This method lets you assign tags to a headline with very few keys. With
4537 the above setup, you could clear the current tags and set @samp{@@home},
4538 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4539 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4540 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4541 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4542 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4543 @key{RET} @key{RET}}.
4545 @vindex org-fast-tag-selection-single-key
4546 If you find that most of the time you need only a single key press to
4547 modify your list of tags, set the variable
4548 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4549 press @key{RET} to exit fast tag selection---it will immediately exit
4550 after the first change. If you then occasionally need more keys, press
4551 @kbd{C-c} to turn off auto-exit for the current tag selection process
4552 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4553 C-c}). If you set the variable to the value @code{expert}, the special
4554 window is not even shown for single-key tag selection, it comes up only
4555 when you press an extra @kbd{C-c}.
4557 @node Tag searches, , Setting tags, Tags
4558 @section Tag searches
4559 @cindex tag searches
4560 @cindex searching for tags
4562 Once a system of tags has been set up, it can be used to collect related
4563 information into special lists.
4566 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4567 Create a sparse tree with all headlines matching a tags search. With a
4568 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4569 @orgcmd{C-c a m,org-tags-view}
4570 Create a global list of tag matches from all agenda files.
4571 @xref{Matching tags and properties}.
4572 @orgcmd{C-c a M,org-tags-view}
4573 @vindex org-tags-match-list-sublevels
4574 Create a global list of tag matches from all agenda files, but check
4575 only TODO items and force checking subitems (see variable
4576 @code{org-tags-match-list-sublevels}).
4579 These commands all prompt for a match string which allows basic Boolean logic
4580 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4581 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4582 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4583 string is rich and allows also matching against TODO keywords, entry levels
4584 and properties. For a complete description with many examples, see
4585 @ref{Matching tags and properties}.
4588 @node Properties and Columns, Dates and Times, Tags, Top
4589 @chapter Properties and columns
4592 Properties are a set of key-value pairs associated with an entry. There
4593 are two main applications for properties in Org-mode. First, properties
4594 are like tags, but with a value. Second, you can use properties to
4595 implement (very basic) database capabilities in an Org buffer. For
4596 an example of the first application, imagine maintaining a file where
4597 you document bugs and plan releases for a piece of software. Instead of
4598 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4599 property, say @code{:Release:}, that in different subtrees has different
4600 values, such as @code{1.0} or @code{2.0}. For an example of the second
4601 application of properties, imagine keeping track of your music CDs,
4602 where properties could be things such as the album, artist, date of
4603 release, number of tracks, and so on.
4605 Properties can be conveniently edited and viewed in column view
4606 (@pxref{Column view}).
4609 * Property syntax:: How properties are spelled out
4610 * Special properties:: Access to other Org-mode features
4611 * Property searches:: Matching property values
4612 * Property inheritance:: Passing values down the tree
4613 * Column view:: Tabular viewing and editing
4614 * Property API:: Properties for Lisp programmers
4617 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4618 @section Property syntax
4619 @cindex property syntax
4620 @cindex drawer, for properties
4622 Properties are key-value pairs. They need to be inserted into a special
4623 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4624 is specified on a single line, with the key (surrounded by colons)
4625 first, and the value after it. Here is an example:
4630 *** Goldberg Variations
4632 :Title: Goldberg Variations
4633 :Composer: J.S. Bach
4635 :Publisher: Deutsche Grammophon
4640 You may define the allowed values for a particular property @samp{:Xyz:}
4641 by setting a property @samp{:Xyz_ALL:}. This special property is
4642 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4643 the entire tree. When allowed values are defined, setting the
4644 corresponding property becomes easier and is less prone to typing
4645 errors. For the example with the CD collection, we can predefine
4646 publishers and the number of disks in a box like this:
4651 :NDisks_ALL: 1 2 3 4
4652 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4656 If you want to set properties that can be inherited by any entry in a
4657 file, use a line like
4658 @cindex property, _ALL
4661 #+PROPERTY: NDisks_ALL 1 2 3 4
4664 @vindex org-global-properties
4665 Property values set with the global variable
4666 @code{org-global-properties} can be inherited by all entries in all
4670 The following commands help to work with properties:
4673 @orgcmd{M-@key{TAB},org-complete}
4674 After an initial colon in a line, complete property keys. All keys used
4675 in the current file will be offered as possible completions.
4676 @orgcmd{C-c C-x p,org-set-property}
4677 Set a property. This prompts for a property name and a value. If
4678 necessary, the property drawer is created as well.
4679 @item M-x org-insert-property-drawer
4680 @findex org-insert-property-drawer
4681 Insert a property drawer into the current entry. The drawer will be
4682 inserted early in the entry, but after the lines with planning
4683 information like deadlines.
4684 @orgcmd{C-c C-c,org-property-action}
4685 With the cursor in a property drawer, this executes property commands.
4686 @orgcmd{C-c C-c s,org-set-property}
4687 Set a property in the current entry. Both the property and the value
4688 can be inserted using completion.
4689 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4690 Switch property at point to the next/previous allowed value.
4691 @orgcmd{C-c C-c d,org-delete-property}
4692 Remove a property from the current entry.
4693 @orgcmd{C-c C-c D,org-delete-property-globally}
4694 Globally remove a property, from all entries in the current file.
4695 @orgcmd{C-c C-c c,org-compute-property-at-point}
4696 Compute the property at point, using the operator and scope from the
4697 nearest column format definition.
4700 @node Special properties, Property searches, Property syntax, Properties and Columns
4701 @section Special properties
4702 @cindex properties, special
4704 Special properties provide an alternative access method to Org-mode
4705 features, like the TODO state or the priority of an entry, discussed in the
4706 previous chapters. This interface exists so that you can include
4707 these states in a column view (@pxref{Column view}), or to use them in
4708 queries. The following property names are special and should not be
4709 used as keys in the properties drawer:
4711 @cindex property, special, TODO
4712 @cindex property, special, TAGS
4713 @cindex property, special, ALLTAGS
4714 @cindex property, special, CATEGORY
4715 @cindex property, special, PRIORITY
4716 @cindex property, special, DEADLINE
4717 @cindex property, special, SCHEDULED
4718 @cindex property, special, CLOSED
4719 @cindex property, special, TIMESTAMP
4720 @cindex property, special, TIMESTAMP_IA
4721 @cindex property, special, CLOCKSUM
4722 @cindex property, special, BLOCKED
4723 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4724 @cindex property, special, ITEM
4725 @cindex property, special, FILE
4727 TODO @r{The TODO keyword of the entry.}
4728 TAGS @r{The tags defined directly in the headline.}
4729 ALLTAGS @r{All tags, including inherited ones.}
4730 CATEGORY @r{The category of an entry.}
4731 PRIORITY @r{The priority of the entry, a string with a single letter.}
4732 DEADLINE @r{The deadline time string, without the angular brackets.}
4733 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4734 CLOSED @r{When was this entry closed?}
4735 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4736 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4737 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4738 @r{must be run first to compute the values.}
4739 BLOCKED @r{"t" if task is currently blocked by children or siblings}
4740 ITEM @r{The content of the entry.}
4741 FILE @r{The filename the entry is located in.}
4744 @node Property searches, Property inheritance, Special properties, Properties and Columns
4745 @section Property searches
4746 @cindex properties, searching
4747 @cindex searching, of properties
4749 To create sparse trees and special lists with selection based on properties,
4750 the same commands are used as for tag searches (@pxref{Tag searches}).
4752 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4753 Create a sparse tree with all matching entries. With a
4754 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4755 @orgcmd{C-c a m,org-tags-view}
4756 Create a global list of tag/property matches from all agenda files.
4757 @xref{Matching tags and properties}.
4758 @orgcmd{C-c a M,org-tags-view}
4759 @vindex org-tags-match-list-sublevels
4760 Create a global list of tag matches from all agenda files, but check
4761 only TODO items and force checking of subitems (see variable
4762 @code{org-tags-match-list-sublevels}).
4765 The syntax for the search string is described in @ref{Matching tags and
4768 There is also a special command for creating sparse trees based on a
4773 Create a sparse tree based on the value of a property. This first
4774 prompts for the name of a property, and then for a value. A sparse tree
4775 is created with all entries that define this property with the given
4776 value. If you enclose the value in curly braces, it is interpreted as
4777 a regular expression and matched against the property values.
4780 @node Property inheritance, Column view, Property searches, Properties and Columns
4781 @section Property Inheritance
4782 @cindex properties, inheritance
4783 @cindex inheritance, of properties
4785 @vindex org-use-property-inheritance
4786 The outline structure of Org-mode documents lends itself to an
4787 inheritance model of properties: if the parent in a tree has a certain
4788 property, the children can inherit this property. Org-mode does not
4789 turn this on by default, because it can slow down property searches
4790 significantly and is often not needed. However, if you find inheritance
4791 useful, you can turn it on by setting the variable
4792 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4793 all properties inherited from the parent, to a list of properties
4794 that should be inherited, or to a regular expression that matches
4795 inherited properties. If a property has the value @samp{nil}, this is
4796 interpreted as an explicit undefine of the property, so that inheritance
4797 search will stop at this value and return @code{nil}.
4799 Org-mode has a few properties for which inheritance is hard-coded, at
4800 least for the special applications for which they are used:
4802 @cindex property, COLUMNS
4805 The @code{:COLUMNS:} property defines the format of column view
4806 (@pxref{Column view}). It is inherited in the sense that the level
4807 where a @code{:COLUMNS:} property is defined is used as the starting
4808 point for a column view table, independently of the location in the
4809 subtree from where columns view is turned on.
4811 @cindex property, CATEGORY
4812 For agenda view, a category set through a @code{:CATEGORY:} property
4813 applies to the entire subtree.
4815 @cindex property, ARCHIVE
4816 For archiving, the @code{:ARCHIVE:} property may define the archive
4817 location for the entire subtree (@pxref{Moving subtrees}).
4819 @cindex property, LOGGING
4820 The LOGGING property may define logging settings for an entry or a
4821 subtree (@pxref{Tracking TODO state changes}).
4824 @node Column view, Property API, Property inheritance, Properties and Columns
4825 @section Column view
4827 A great way to view and edit properties in an outline tree is
4828 @emph{column view}. In column view, each outline node is turned into a
4829 table row. Columns in this table provide access to properties of the
4830 entries. Org-mode implements columns by overlaying a tabular structure
4831 over the headline of each item. While the headlines have been turned
4832 into a table row, you can still change the visibility of the outline
4833 tree. For example, you get a compact table by switching to CONTENTS
4834 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4835 is active), but you can still open, read, and edit the entry below each
4836 headline. Or, you can switch to column view after executing a sparse
4837 tree command and in this way get a table only for the selected items.
4838 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4839 queries have collected selected items, possibly from a number of files.
4842 * Defining columns:: The COLUMNS format property
4843 * Using column view:: How to create and use column view
4844 * Capturing column view:: A dynamic block for column view
4847 @node Defining columns, Using column view, Column view, Column view
4848 @subsection Defining columns
4849 @cindex column view, for properties
4850 @cindex properties, column view
4852 Setting up a column view first requires defining the columns. This is
4853 done by defining a column format line.
4856 * Scope of column definitions:: Where defined, where valid?
4857 * Column attributes:: Appearance and content of a column
4860 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4861 @subsubsection Scope of column definitions
4863 To define a column format for an entire file, use a line like
4867 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4870 To specify a format that only applies to a specific tree, add a
4871 @code{:COLUMNS:} property to the top node of that tree, for example:
4874 ** Top node for columns view
4876 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4880 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4881 for the entry itself, and for the entire subtree below it. Since the
4882 column definition is part of the hierarchical structure of the document,
4883 you can define columns on level 1 that are general enough for all
4884 sublevels, and more specific columns further down, when you edit a
4885 deeper part of the tree.
4887 @node Column attributes, , Scope of column definitions, Defining columns
4888 @subsubsection Column attributes
4889 A column definition sets the attributes of a column. The general
4890 definition looks like this:
4893 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
4897 Except for the percent sign and the property name, all items are
4898 optional. The individual parts have the following meaning:
4901 @var{width} @r{An integer specifying the width of the column in characters.}
4902 @r{If omitted, the width will be determined automatically.}
4903 @var{property} @r{The property that should be edited in this column.}
4904 @r{Special properties representing meta data are allowed here}
4905 @r{as well (@pxref{Special properties})}
4906 @var{title} @r{The header text for the column. If omitted, the property}
4908 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
4909 @r{parent nodes are computed from the children.}
4910 @r{Supported summary types are:}
4911 @{+@} @r{Sum numbers in this column.}
4912 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4913 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4914 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
4915 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
4916 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
4917 @{X%@} @r{Checkbox status, @samp{[n%]}.}
4918 @{min@} @r{Smallest number in column.}
4919 @{max@} @r{Largest number.}
4920 @{mean@} @r{Arithmetic mean of numbers.}
4921 @{:min@} @r{Smallest time value in column.}
4922 @{:max@} @r{Largest time value.}
4923 @{:mean@} @r{Arithmetic mean of time values.}
4924 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
4925 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
4926 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
4927 @{est+@} @r{Add low-high estimates.}
4931 Be aware that you can only have one summary type for any property you
4932 include. Subsequent columns referencing the same property will all display the
4933 same summary information.
4935 The @code{est+} summary type requires further explanation. It is used for
4936 combining estimates, expressed as low-high ranges. For example, instead
4937 of estimating a particular task will take 5 days, you might estimate it as
4938 5-6 days if you're fairly confident you know how much work is required, or
4939 1-10 days if you don't really know what needs to be done. Both ranges
4940 average at 5.5 days, but the first represents a more predictable delivery.
4942 When combining a set of such estimates, simply adding the lows and highs
4943 produces an unrealistically wide result. Instead, @code{est+} adds the
4944 statistical mean and variance of the sub-tasks, generating a final estimate
4945 from the sum. For example, suppose you had ten tasks, each of which was
4946 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
4947 of 5 to 20 days, representing what to expect if everything goes either
4948 extremely well or extremely poorly. In contrast, @code{est+} estimates the
4949 full job more realistically, at 10-15 days.
4951 Here is an example for a complete columns definition, along with allowed
4955 :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.}
4956 %10Time_Estimate@{:@} %CLOCKSUM
4957 :Owner_ALL: Tammy Mark Karl Lisa Don
4958 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4959 :Approved_ALL: "[ ]" "[X]"
4963 The first column, @samp{%25ITEM}, means the first 25 characters of the
4964 item itself, i.e. of the headline. You probably always should start the
4965 column definition with the @samp{ITEM} specifier. The other specifiers
4966 create columns @samp{Owner} with a list of names as allowed values, for
4967 @samp{Status} with four different possible values, and for a checkbox
4968 field @samp{Approved}. When no width is given after the @samp{%}
4969 character, the column will be exactly as wide as it needs to be in order
4970 to fully display all values. The @samp{Approved} column does have a
4971 modified title (@samp{Approved?}, with a question mark). Summaries will
4972 be created for the @samp{Time_Estimate} column by adding time duration
4973 expressions like HH:MM, and for the @samp{Approved} column, by providing
4974 an @samp{[X]} status if all children have been checked. The
4975 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
4978 @node Using column view, Capturing column view, Defining columns, Column view
4979 @subsection Using column view
4982 @tsubheading{Turning column view on and off}
4983 @orgcmd{C-c C-x C-c,org-columns}
4984 @vindex org-columns-default-format
4985 Turn on column view. If the cursor is before the first headline in the file,
4986 column view is turned on for the entire file, using the @code{#+COLUMNS}
4987 definition. If the cursor is somewhere inside the outline, this command
4988 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
4989 defines a format. When one is found, the column view table is established
4990 for the tree starting at the entry that contains the @code{:COLUMNS:}
4991 property. If no such property is found, the format is taken from the
4992 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
4993 and column view is established for the current entry and its subtree.
4994 @orgcmd{r,org-columns-redo}
4995 Recreate the column view, to include recent changes made in the buffer.
4996 @orgcmd{g,org-columns-redo}
4998 @orgcmd{q,org-columns-quit}
5000 @tsubheading{Editing values}
5001 @item @key{left} @key{right} @key{up} @key{down}
5002 Move through the column view from field to field.
5003 @kindex S-@key{left}
5004 @kindex S-@key{right}
5005 @item S-@key{left}/@key{right}
5006 Switch to the next/previous allowed value of the field. For this, you
5007 have to have specified allowed values for a property.
5009 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5010 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5011 Same as @kbd{S-@key{left}/@key{right}}
5012 @orgcmd{e,org-columns-edit-value}
5013 Edit the property at point. For the special properties, this will
5014 invoke the same interface that you normally use to change that
5015 property. For example, when editing a TAGS property, the tag completion
5016 or fast selection interface will pop up.
5017 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5018 When there is a checkbox at point, toggle it.
5019 @orgcmd{v,org-columns-show-value}
5020 View the full value of this property. This is useful if the width of
5021 the column is smaller than that of the value.
5022 @orgcmd{a,org-columns-edit-allowed}
5023 Edit the list of allowed values for this property. If the list is found
5024 in the hierarchy, the modified values is stored there. If no list is
5025 found, the new value is stored in the first entry that is part of the
5026 current column view.
5027 @tsubheading{Modifying the table structure}
5028 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5029 Make the column narrower/wider by one character.
5030 @orgcmd{S-M-@key{right},org-columns-new}
5031 Insert a new column, to the left of the current column.
5032 @orgcmd{S-M-@key{left},org-columns-delete}
5033 Delete the current column.
5036 @node Capturing column view, , Using column view, Column view
5037 @subsection Capturing column view
5039 Since column view is just an overlay over a buffer, it cannot be
5040 exported or printed directly. If you want to capture a column view, use
5041 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5042 of this block looks like this:
5044 @cindex #+BEGIN, columnview
5047 #+BEGIN: columnview :hlines 1 :id "label"
5052 @noindent This dynamic block has the following parameters:
5056 This is the most important parameter. Column view is a feature that is
5057 often localized to a certain (sub)tree, and the capture block might be
5058 at a different location in the file. To identify the tree whose view to
5059 capture, you can use 4 values:
5060 @cindex property, ID
5062 local @r{use the tree in which the capture block is located}
5063 global @r{make a global view, including all headings in the file}
5064 "file:@var{path-to-file}"
5065 @r{run column view at the top of this file}
5066 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5067 @r{property with the value @i{label}. You can use}
5068 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5069 @r{the current entry and copy it to the kill-ring.}
5072 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5073 an hline before each headline with level @code{<= @var{N}}.
5075 When set to @code{t}, force column groups to get vertical lines.
5077 When set to a number, don't capture entries below this level.
5078 @item :skip-empty-rows
5079 When set to @code{t}, skip rows where the only non-empty specifier of the
5080 column view is @code{ITEM}.
5085 The following commands insert or update the dynamic block:
5088 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5089 Insert a dynamic block capturing a column view. You will be prompted
5090 for the scope or ID of the view.
5091 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5092 Update dynamic block at point. The cursor needs to be in the
5093 @code{#+BEGIN} line of the dynamic block.
5094 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5095 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5096 you have several clock table blocks, column-capturing blocks or other dynamic
5100 You can add formulas to the column view table and you may add plotting
5101 instructions in front of the table---these will survive an update of the
5102 block. If there is a @code{#+TBLFM:} after the table, the table will
5103 actually be recalculated automatically after an update.
5105 An alternative way to capture and process property values into a table is
5106 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5107 package@footnote{Contributed packages are not part of Emacs, but are
5108 distributed with the main distribution of Org (visit
5109 @uref{http://orgmode.org}).}. It provides a general API to collect
5110 properties from entries in a certain scope, and arbitrary Lisp expressions to
5111 process these values before inserting them into a table or a dynamic block.
5113 @node Property API, , Column view, Properties and Columns
5114 @section The Property API
5115 @cindex properties, API
5116 @cindex API, for properties
5118 There is a full API for accessing and changing properties. This API can
5119 be used by Emacs Lisp programs to work with properties and to implement
5120 features based on them. For more information see @ref{Using the
5123 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5124 @chapter Dates and times
5130 To assist project planning, TODO items can be labeled with a date and/or
5131 a time. The specially formatted string carrying the date and time
5132 information is called a @emph{timestamp} in Org-mode. This may be a
5133 little confusing because timestamp is often used as indicating when
5134 something was created or last changed. However, in Org-mode this term
5135 is used in a much wider sense.
5138 * Timestamps:: Assigning a time to a tree entry
5139 * Creating timestamps:: Commands which insert timestamps
5140 * Deadlines and scheduling:: Planning your work
5141 * Clocking work time:: Tracking how long you spend on a task
5142 * Effort estimates:: Planning work effort in advance
5143 * Relative timer:: Notes with a running timer
5144 * Countdown timer:: Starting a countdown timer for a task
5148 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5149 @section Timestamps, deadlines, and scheduling
5151 @cindex ranges, time
5156 A timestamp is a specification of a date (possibly with a time or a range of
5157 times) in a special format, either @samp{<2003-09-16 Tue>} or
5158 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
5159 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601 date/time
5160 format. To use an alternative format, see @ref{Custom time format}.}. A
5161 timestamp can appear anywhere in the headline or body of an Org tree entry.
5162 Its presence causes entries to be shown on specific dates in the agenda
5163 (@pxref{Weekly/daily agenda}). We distinguish:
5166 @item Plain timestamp; Event; Appointment
5168 A simple timestamp just assigns a date/time to an item. This is just
5169 like writing down an appointment or event in a paper agenda. In the
5170 timeline and agenda displays, the headline of an entry associated with a
5171 plain timestamp will be shown exactly on that date.
5174 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5175 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5178 @item Timestamp with repeater interval
5179 @cindex timestamp, with repeater interval
5180 A timestamp may contain a @emph{repeater interval}, indicating that it
5181 applies not only on the given date, but again and again after a certain
5182 interval of N days (d), weeks (w), months (m), or years (y). The
5183 following will show up in the agenda every Wednesday:
5186 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5189 @item Diary-style sexp entries
5190 For more complex date specifications, Org-mode supports using the
5191 special sexp diary entries implemented in the Emacs calendar/diary
5192 package. For example
5195 * The nerd meeting on every 2nd Thursday of the month
5196 <%%(diary-float t 4 2)>
5199 @item Time/Date range
5202 Two timestamps connected by @samp{--} denote a range. The headline
5203 will be shown on the first and last day of the range, and on any dates
5204 that are displayed and fall in the range. Here is an example:
5207 ** Meeting in Amsterdam
5208 <2004-08-23 Mon>--<2004-08-26 Thu>
5211 @item Inactive timestamp
5212 @cindex timestamp, inactive
5213 @cindex inactive timestamp
5214 Just like a plain timestamp, but with square brackets instead of
5215 angular ones. These timestamps are inactive in the sense that they do
5216 @emph{not} trigger an entry to show up in the agenda.
5219 * Gillian comes late for the fifth time [2006-11-01 Wed]
5224 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5225 @section Creating timestamps
5226 @cindex creating timestamps
5227 @cindex timestamps, creating
5229 For Org-mode to recognize timestamps, they need to be in the specific
5230 format. All commands listed below produce timestamps in the correct
5234 @orgcmd{C-c .,org-time-stamp}
5235 Prompt for a date and insert a corresponding timestamp. When the cursor is
5236 at an existing timestamp in the buffer, the command is used to modify this
5237 timestamp instead of inserting a new one. When this command is used twice in
5238 succession, a time range is inserted.
5240 @orgcmd{C-c !,org-time-stamp-inactive}
5241 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5248 @vindex org-time-stamp-rounding-minutes
5249 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5250 contains date and time. The default time can be rounded to multiples of 5
5251 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5253 @orgcmd{C-c <,org-date-from-calendar}
5254 Insert a timestamp corresponding to the cursor date in the Calendar.
5256 @orgcmd{C-c >,org-goto-calendar}
5257 Access the Emacs calendar for the current date. If there is a
5258 timestamp in the current line, go to the corresponding date
5261 @orgcmd{C-c C-o,org-open-at-point}
5262 Access the agenda for the date given by the timestamp or -range at
5263 point (@pxref{Weekly/daily agenda}).
5265 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5266 Change date at cursor by one day. These key bindings conflict with
5267 shift-selection and related modes (@pxref{Conflicts}).
5269 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5270 Change the item under the cursor in a timestamp. The cursor can be on a
5271 year, month, day, hour or minute. When the timestamp contains a time range
5272 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5273 shifting the time block with constant length. To change the length, modify
5274 the second time. Note that if the cursor is in a headline and not at a
5275 timestamp, these same keys modify the priority of an item.
5276 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5277 related modes (@pxref{Conflicts}).
5279 @orgcmd{C-c C-y,org-evaluate-time-range}
5280 @cindex evaluate time range
5281 Evaluate a time range by computing the difference between start and end.
5282 With a prefix argument, insert result after the time range (in a table: into
5283 the following column).
5288 * The date/time prompt:: How Org-mode helps you entering date and time
5289 * Custom time format:: Making dates look different
5292 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5293 @subsection The date/time prompt
5294 @cindex date, reading in minibuffer
5295 @cindex time, reading in minibuffer
5297 @vindex org-read-date-prefer-future
5298 When Org-mode prompts for a date/time, the default is shown in default
5299 date/time format, and the prompt therefore seems to ask for a specific
5300 format. But it will in fact accept any string containing some date and/or
5301 time information, and it is really smart about interpreting your input. You
5302 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5303 copied from an email message. Org-mode will find whatever information is in
5304 there and derive anything you have not specified from the @emph{default date
5305 and time}. The default is usually the current date and time, but when
5306 modifying an existing timestamp, or when entering the second stamp of a
5307 range, it is taken from the stamp in the buffer. When filling in
5308 information, Org-mode assumes that most of the time you will want to enter a
5309 date in the future: if you omit the month/year and the given day/month is
5310 @i{before} today, it will assume that you mean a future date@footnote{See the
5311 variable @code{org-read-date-prefer-future}. You may set that variable to
5312 the symbol @code{time} to even make a time before now shift the date to
5313 tomorrow.}. If the date has been automatically shifted into the future, the
5314 time prompt will show this with @samp{(=>F).}
5316 For example, let's assume that today is @b{June 13, 2006}. Here is how
5317 various inputs will be interpreted, the items filled in by Org-mode are
5321 3-2-5 --> 2003-02-05
5322 2/5/3 --> 2003-02-05
5323 14 --> @b{2006}-@b{06}-14
5324 12 --> @b{2006}-@b{07}-12
5325 2/5 --> @b{2007}-02-05
5326 Fri --> nearest Friday (default date or later)
5327 sep 15 --> @b{2006}-09-15
5328 feb 15 --> @b{2007}-02-15
5329 sep 12 9 --> 2009-09-12
5330 12:45 --> @b{2006}-@b{06}-@b{13} 12:45
5331 22 sept 0:34 --> @b{2006}-09-22 0:34
5332 w4 --> ISO week for of the current year @b{2006}
5333 2012 w4 fri --> Friday of ISO week 4 in 2012
5334 2012-w04-5 --> Same as above
5337 Furthermore you can specify a relative date by giving, as the
5338 @emph{first} thing in the input: a plus/minus sign, a number and a
5339 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5340 single plus or minus, the date is always relative to today. With a
5341 double plus or minus, it is relative to the default date. If instead of
5342 a single letter, you use the abbreviation of day name, the date will be
5343 the Nth such day. E.g.
5348 +4d --> four days from today
5349 +4 --> same as above
5350 +2w --> two weeks from today
5351 ++5 --> five days from default date
5352 +2tue --> second Tuesday from now.
5355 @vindex parse-time-months
5356 @vindex parse-time-weekdays
5357 The function understands English month and weekday abbreviations. If
5358 you want to use unabbreviated names and/or other languages, configure
5359 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5361 You can specify a time range by giving start and end times or by giving a
5362 start time and a duration (in HH:MM format). Use `-' or `-@{@}-' as the separator
5363 in the former case and use '+' as the separator in the latter case. E.g.
5366 11am-1:15pm --> 11:00-13:15
5367 11am--1:15pm --> same as above
5368 11am+2:15 --> same as above
5371 @cindex calendar, for selecting date
5372 @vindex org-popup-calendar-for-date-prompt
5373 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5374 you don't need/want the calendar, configure the variable
5375 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5376 prompt, either by clicking on a date in the calendar, or by pressing
5377 @key{RET}, the date selected in the calendar will be combined with the
5378 information entered at the prompt. You can control the calendar fully
5379 from the minibuffer:
5386 @kindex S-@key{right}
5387 @kindex S-@key{left}
5388 @kindex S-@key{down}
5390 @kindex M-S-@key{right}
5391 @kindex M-S-@key{left}
5394 @key{RET} @r{Choose date at cursor in calendar.}
5395 mouse-1 @r{Select date by clicking on it.}
5396 S-@key{right}/@key{left} @r{One day forward/backward.}
5397 S-@key{down}/@key{up} @r{One week forward/backward.}
5398 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5399 > / < @r{Scroll calendar forward/backward by one month.}
5400 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5403 @vindex org-read-date-display-live
5404 The actions of the date/time prompt may seem complex, but I assure you they
5405 will grow on you, and you will start getting annoyed by pretty much any other
5406 way of entering a date/time out there. To help you understand what is going
5407 on, the current interpretation of your input will be displayed live in the
5408 minibuffer@footnote{If you find this distracting, turn the display of with
5409 @code{org-read-date-display-live}.}.
5411 @node Custom time format, , The date/time prompt, Creating timestamps
5412 @subsection Custom time format
5413 @cindex custom date/time format
5414 @cindex time format, custom
5415 @cindex date format, custom
5417 @vindex org-display-custom-times
5418 @vindex org-time-stamp-custom-formats
5419 Org-mode uses the standard ISO notation for dates and times as it is
5420 defined in ISO 8601. If you cannot get used to this and require another
5421 representation of date and time to keep you happy, you can get it by
5422 customizing the variables @code{org-display-custom-times} and
5423 @code{org-time-stamp-custom-formats}.
5426 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5427 Toggle the display of custom formats for dates and times.
5431 Org-mode needs the default format for scanning, so the custom date/time
5432 format does not @emph{replace} the default format---instead it is put
5433 @emph{over} the default format using text properties. This has the
5434 following consequences:
5437 You cannot place the cursor onto a timestamp anymore, only before or
5440 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5441 each component of a timestamp. If the cursor is at the beginning of
5442 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5443 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5444 time will be changed by one minute.
5446 If the timestamp contains a range of clock times or a repeater, these
5447 will not be overlaid, but remain in the buffer as they were.
5449 When you delete a timestamp character-by-character, it will only
5450 disappear from the buffer after @emph{all} (invisible) characters
5451 belonging to the ISO timestamp have been removed.
5453 If the custom timestamp format is longer than the default and you are
5454 using dates in tables, table alignment will be messed up. If the custom
5455 format is shorter, things do work as expected.
5459 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5460 @section Deadlines and scheduling
5462 A timestamp may be preceded by special keywords to facilitate planning:
5466 @cindex DEADLINE keyword
5468 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5469 to be finished on that date.
5471 @vindex org-deadline-warning-days
5472 On the deadline date, the task will be listed in the agenda. In
5473 addition, the agenda for @emph{today} will carry a warning about the
5474 approaching or missed deadline, starting
5475 @code{org-deadline-warning-days} before the due date, and continuing
5476 until the entry is marked DONE. An example:
5479 *** TODO write article about the Earth for the Guide
5480 The editor in charge is [[bbdb:Ford Prefect]]
5481 DEADLINE: <2004-02-29 Sun>
5484 You can specify a different lead time for warnings for a specific
5485 deadlines using the following syntax. Here is an example with a warning
5486 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5489 @cindex SCHEDULED keyword
5491 Meaning: you are planning to start working on that task on the given
5494 @vindex org-agenda-skip-scheduled-if-done
5495 The headline will be listed under the given date@footnote{It will still
5496 be listed on that date after it has been marked DONE. If you don't like
5497 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5498 addition, a reminder that the scheduled date has passed will be present
5499 in the compilation for @emph{today}, until the entry is marked DONE, i.e.
5500 the task will automatically be forwarded until completed.
5503 *** TODO Call Trillian for a date on New Years Eve.
5504 SCHEDULED: <2004-12-25 Sat>
5508 @b{Important:} Scheduling an item in Org-mode should @i{not} be
5509 understood in the same way that we understand @i{scheduling a meeting}.
5510 Setting a date for a meeting is just a simple appointment, you should
5511 mark this entry with a simple plain timestamp, to get this item shown
5512 on the date where it applies. This is a frequent misunderstanding by
5513 Org users. In Org-mode, @i{scheduling} means setting a date when you
5514 want to start working on an action item.
5517 You may use timestamps with repeaters in scheduling and deadline
5518 entries. Org-mode will issue early and late warnings based on the
5519 assumption that the timestamp represents the @i{nearest instance} of
5520 the repeater. However, the use of diary sexp entries like
5522 @code{<%%(diary-float t 42)>}
5524 in scheduling and deadline timestamps is limited. Org-mode does not
5525 know enough about the internals of each sexp function to issue early and
5526 late warnings. However, it will show the item on each day where the
5530 * Inserting deadline/schedule:: Planning items
5531 * Repeated tasks:: Items that show up again and again
5534 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5535 @subsection Inserting deadlines or schedules
5537 The following commands allow you to quickly insert a deadline or to schedule
5542 @orgcmd{C-c C-d,org-deadline}
5543 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5544 in the line directly following the headline. When called with a prefix arg,
5545 an existing deadline will be removed from the entry. Depending on the
5546 variable @code{org-log-redeadline}@footnote{with corresponding
5547 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5548 and @code{nologredeadline}}, a note will be taken when changing an existing
5550 @c FIXME Any CLOSED timestamp will be removed.????????
5552 @orgcmd{C-c C-s,org-schedule}
5553 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5554 happen in the line directly following the headline. Any CLOSED timestamp
5555 will be removed. When called with a prefix argument, remove the scheduling
5556 date from the entry. Depending on the variable
5557 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5558 keywords @code{logredeadline}, @code{lognoteredeadline}, and
5559 @code{nologredeadline}}, a note will be taken when changing an existing
5562 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5565 Mark the current entry for agenda action. After you have marked the entry
5566 like this, you can open the agenda or the calendar to find an appropriate
5567 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5568 schedule the marked item.
5570 @orgcmd{C-c / d,org-check-deadlines}
5571 @cindex sparse tree, for deadlines
5572 @vindex org-deadline-warning-days
5573 Create a sparse tree with all deadlines that are either past-due, or
5574 which will become due within @code{org-deadline-warning-days}.
5575 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5576 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5577 all deadlines due tomorrow.
5579 @orgcmd{C-c / b,org-check-before-date}
5580 Sparse tree for deadlines and scheduled items before a given date.
5582 @orgcmd{C-c / a,org-check-after-date}
5583 Sparse tree for deadlines and scheduled items after a given date.
5586 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5587 @subsection Repeated tasks
5588 @cindex tasks, repeated
5589 @cindex repeated tasks
5591 Some tasks need to be repeated again and again. Org-mode helps to
5592 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5593 or plain timestamp. In the following example
5595 ** TODO Pay the rent
5596 DEADLINE: <2005-10-01 Sat +1m>
5599 the @code{+1m} is a repeater; the intended interpretation is that the task
5600 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5601 from that time. If you need both a repeater and a special warning period in
5602 a deadline entry, the repeater should come first and the warning period last:
5603 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5605 @vindex org-todo-repeat-to-state
5606 Deadlines and scheduled items produce entries in the agenda when they are
5607 over-due, so it is important to be able to mark such an entry as completed
5608 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5609 keyword DONE, it will no longer produce entries in the agenda. The problem
5610 with this is, however, that then also the @emph{next} instance of the
5611 repeated entry will not be active. Org-mode deals with this in the following
5612 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5613 shift the base date of the repeating timestamp by the repeater interval, and
5614 immediately set the entry state back to TODO@footnote{In fact, the target
5615 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5616 the variable @code{org-todo-repeat-to-state}. If neither of these is
5617 specified, the target state defaults to the first state of the TODO state
5618 sequence.}. In the example above, setting the state to DONE would actually
5619 switch the date like this:
5622 ** TODO Pay the rent
5623 DEADLINE: <2005-11-01 Tue +1m>
5626 @vindex org-log-repeat
5627 A timestamp@footnote{You can change this using the option
5628 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5629 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5630 will also be prompted for a note.} will be added under the deadline, to keep
5631 a record that you actually acted on the previous instance of this deadline.
5633 As a consequence of shifting the base date, this entry will no longer be
5634 visible in the agenda when checking past dates, but all future instances
5637 With the @samp{+1m} cookie, the date shift will always be exactly one
5638 month. So if you have not paid the rent for three months, marking this
5639 entry DONE will still keep it as an overdue deadline. Depending on the
5640 task, this may not be the best way to handle it. For example, if you
5641 forgot to call your father for 3 weeks, it does not make sense to call
5642 him 3 times in a single day to make up for it. Finally, there are tasks
5643 like changing batteries which should always repeat a certain time
5644 @i{after} the last time you did it. For these tasks, Org-mode has
5645 special repeaters @samp{++} and @samp{.+}. For example:
5649 DEADLINE: <2008-02-10 Sun ++1w>
5650 Marking this DONE will shift the date by at least one week,
5651 but also by as many weeks as it takes to get this date into
5652 the future. However, it stays on a Sunday, even if you called
5653 and marked it done on Saturday.
5654 ** TODO Check the batteries in the smoke detectors
5655 DEADLINE: <2005-11-01 Tue .+1m>
5656 Marking this DONE will shift the date to one month after
5660 You may have both scheduling and deadline information for a specific
5661 task---just make sure that the repeater intervals on both are the same.
5663 An alternative to using a repeater is to create a number of copies of a task
5664 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5665 created for this purpose, it is described in @ref{Structure editing}.
5668 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5669 @section Clocking work time
5670 @cindex clocking time
5671 @cindex time clocking
5673 Org-mode allows you to clock the time you spend on specific tasks in a
5674 project. When you start working on an item, you can start the clock.
5675 When you stop working on that task, or when you mark the task done, the
5676 clock is stopped and the corresponding time interval is recorded. It
5677 also computes the total time spent on each subtree of a project. And it
5678 remembers a history or tasks recently clocked, to that you can jump quickly
5679 between a number of tasks absorbing your time.
5681 To save the clock history across Emacs sessions, use
5683 (setq org-clock-persist 'history)
5684 (org-clock-persistence-insinuate)
5686 When you clock into a new task after resuming Emacs, the incomplete
5687 clock@footnote{To resume the clock under the assumption that you have worked
5688 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5689 will be found (@pxref{Resolving idle time}) and you will be prompted about
5693 * Clocking commands:: Starting and stopping a clock
5694 * The clock table:: Detailed reports
5695 * Resolving idle time:: Resolving time when you've been idle
5698 @node Clocking commands, The clock table, Clocking work time, Clocking work time
5699 @subsection Clocking commands
5702 @orgcmd{C-c C-x C-i,org-clock-in}
5703 @vindex org-clock-into-drawer
5704 Start the clock on the current item (clock-in). This inserts the CLOCK
5705 keyword together with a timestamp. If this is not the first clocking of
5706 this item, the multiple CLOCK lines will be wrapped into a
5707 @code{:LOGBOOK:} drawer (see also the variable
5708 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5709 select the task from a list of recently clocked tasks. With two @kbd{C-u
5710 C-u} prefixes, clock into the task at point and mark it as the default task.
5711 The default task will always be available when selecting a clocking task,
5712 with letter @kbd{d}.@*
5713 @cindex property: CLOCK_MODELINE_TOTAL
5714 @cindex property: LAST_REPEAT
5715 @vindex org-clock-modeline-total
5716 While the clock is running, the current clocking time is shown in the mode
5717 line, along with the title of the task. The clock time shown will be all
5718 time ever clocked for this task and its children. If the task has an effort
5719 estimate (@pxref{Effort estimates}), the mode line displays the current
5720 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5721 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5722 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5723 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5724 will be shown. More control over what time is shown can be exercised with
5725 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5726 @code{current} to show only the current clocking instance, @code{today} to
5727 show all time clocked on this tasks today (see also the variable
5728 @code{org-extend-today-until}), @code{all} to include all time, or
5729 @code{auto} which is the default@footnote{See also the variable
5730 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5731 mode line entry will pop up a menu with clocking options.
5733 @orgcmd{C-c C-x C-o,org-clock-out}
5734 @vindex org-log-note-clock-out
5735 Stop the clock (clock-out). This inserts another timestamp at the same
5736 location where the clock was last started. It also directly computes
5737 the resulting time in inserts it after the time range as @samp{=>
5738 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5739 possibility to record an additional note together with the clock-out
5740 timestamp@footnote{The corresponding in-buffer setting is:
5741 @code{#+STARTUP: lognoteclock-out}}.
5742 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5743 Update the effort estimate for the current clock task.
5746 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
5747 Recompute the time interval after changing one of the timestamps. This
5748 is only necessary if you edit the timestamps directly. If you change
5749 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5750 @orgcmd{C-c C-t,org-todo}
5751 Changing the TODO state of an item to DONE automatically stops the clock
5752 if it is running in this same item.
5753 @orgcmd{C-c C-x C-x,org-clock-cancel}
5754 Cancel the current clock. This is useful if a clock was started by
5755 mistake, or if you ended up working on something else.
5756 @orgcmd{C-c C-x C-j,org-clock-goto}
5757 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
5758 prefix arg, select the target task from a list of recently clocked tasks.
5759 @orgcmd{C-c C-x C-d,org-clock-display}
5760 @vindex org-remove-highlights-with-change
5761 Display time summaries for each subtree in the current buffer. This
5762 puts overlays at the end of each headline, showing the total time
5763 recorded under that heading, including the time of any subheadings. You
5764 can use visibility cycling to study the tree, but the overlays disappear
5765 when you change the buffer (see variable
5766 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5769 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5770 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5771 worked on or closed during a day.
5773 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
5774 @subsection The clock table
5775 @cindex clocktable, dynamic block
5776 @cindex report, of clocked time
5778 Org mode can produce quite complex reports based on the time clocking
5779 information. Such a report is called a @emph{clock table}, because it is
5780 formatted as one or several Org tables.
5783 @orgcmd{C-c C-x C-r,org-clock-report}
5784 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5785 report as an Org-mode table into the current file. When the cursor is
5786 at an existing clock table, just update it. When called with a prefix
5787 argument, jump to the first clock report in the current document and
5789 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5790 Update dynamic block at point. The cursor needs to be in the
5791 @code{#+BEGIN} line of the dynamic block.
5792 @orgkey{C-u C-c C-x C-u}
5793 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5794 you have several clock table blocks in a buffer.
5795 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
5796 Shift the current @code{:block} interval and update the table. The cursor
5797 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5798 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5802 Here is an example of the frame for a clock table as it is inserted into the
5803 buffer with the @kbd{C-c C-x C-r} command:
5805 @cindex #+BEGIN, clocktable
5807 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5811 @vindex org-clocktable-defaults
5812 The @samp{BEGIN} line and specify a number of options to define the scope,
5813 structure, and formatting of the report. Defaults for all these options can
5814 be configured in the variable @code{org-clocktable-defaults}.
5816 @noindent First there are options that determine which clock entries are to
5819 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5820 @r{Clocks at deeper levels will be summed into the upper level.}
5821 :scope @r{The scope to consider. This can be any of the following:}
5822 nil @r{the current buffer or narrowed region}
5823 file @r{the full current buffer}
5824 subtree @r{the subtree where the clocktable is located}
5825 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
5826 tree @r{the surrounding level 1 tree}
5827 agenda @r{all agenda files}
5828 ("file"..) @r{scan these files}
5829 file-with-archives @r{current file and its archives}
5830 agenda-with-archives @r{all agenda files, including archives}
5831 :block @r{The time block to consider. This block is specified either}
5832 @r{absolute, or relative to the current time and may be any of}
5834 2007-12-31 @r{New year eve 2007}
5835 2007-12 @r{December 2007}
5836 2007-W50 @r{ISO-week 50 in 2007}
5837 2007-Q2 @r{2nd quarter in 2007}
5838 2007 @r{the year 2007}
5839 today, yesterday, today-@var{N} @r{a relative day}
5840 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
5841 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
5842 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
5843 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5844 :tstart @r{A time string specifying when to start considering times.}
5845 :tend @r{A time string specifying when to stop considering times.}
5846 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5847 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5848 :stepskip0 @r{Do not show steps that have zero time.}
5849 :fileskip0 @r{Do not show table sections from files which did not contribute.}
5850 :tags @r{A tags match to select entries that should contribute}.
5853 Then there are options which determine the formatting of the table. There
5854 options are interpreted by the function @code{org-clocktable-write-default},
5855 but you can specify your own function using the @code{:formatter} parameter.
5857 :emphasize @r{When @code{t}, emphasize level one and level two items.}
5858 :link @r{Link the item headlines in the table to their origins.}
5859 :narrow @r{An integer to limit the width of the headline column in}
5860 @r{the org table. If you write it like @samp{50!}, then the}
5861 @r{headline will also be shortened in export.}
5862 :indent @r{Indent each headline field according to its level.}
5863 :tcolumns @r{Number of columns to be used for times. If this is smaller}
5864 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
5865 :level @r{Should a level number column be included?}
5866 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
5867 @r{All are overwritten except if there is an explicit @code{:narrow}}
5868 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
5869 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
5870 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5871 @r{As a special case, @samp{:formula %} adds a column with % time.}
5872 @r{If you do not specify a formula here, any existing formula}
5873 @r{below the clock table will survive updates and be evaluated.}
5874 :formatter @r{A function to format clock data and insert it into the buffer.}
5876 To get a clock summary of the current level 1 tree, for the current
5877 day, you could write
5879 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5883 and to use a specific time range you could write@footnote{Note that all
5884 parameters must be specified in a single line---the line is broken here
5885 only to fit it into the manual.}
5887 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5888 :tend "<2006-08-10 Thu 12:00>"
5891 A summary of the current subtree with % times would be
5893 #+BEGIN: clocktable :scope subtree :link t :formula %
5896 A horizontally compact representation of everything clocked during last week
5899 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
5903 @node Resolving idle time, , The clock table, Clocking work time
5904 @subsection Resolving idle time
5905 @cindex resolve idle time
5907 @cindex idle, resolve, dangling
5908 If you clock in on a work item, and then walk away from your
5909 computer---perhaps to take a phone call---you often need to ``resolve'' the
5910 time you were away by either subtracting it from the current clock, or
5911 applying it to another one.
5913 @vindex org-clock-idle-time
5914 By customizing the variable @code{org-clock-idle-time} to some integer, such
5915 as 10 or 15, Emacs can alert you when you get back to your computer after
5916 being idle for that many minutes@footnote{On computers using Mac OS X,
5917 idleness is based on actual user idleness, not just Emacs' idle time. For
5918 X11, you can install a utility program @file{x11idle.c}, available in the
5919 UTILITIES directory of the Org git distribution, to get the same general
5920 treatment of idleness. On other systems, idle time refers to Emacs idle time
5921 only.}, and ask what you want to do with the idle time. There will be a
5922 question waiting for you when you get back, indicating how much idle time has
5923 passed (constantly updated with the current amount), as well as a set of
5924 choices to correct the discrepancy:
5928 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
5929 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
5930 effectively changing nothing, or enter a number to keep that many minutes.
5932 If you use the shift key and press @kbd{K}, it will keep however many minutes
5933 you request and then immediately clock out of that task. If you keep all of
5934 the minutes, this is the same as just clocking out of the current task.
5936 To keep none of the minutes, use @kbd{s} to subtract all the away time from
5937 the clock, and then check back in from the moment you returned.
5939 To keep none of the minutes and just clock out at the start of the away time,
5940 use the shift key and press @kbd{S}. Remember that using shift will always
5941 leave you clocked out, no matter which option you choose.
5943 To cancel the clock altogether, use @kbd{C}. Note that if instead of
5944 canceling you subtract the away time, and the resulting clock amount is less
5945 than a minute, the clock will still be canceled rather than clutter up the
5946 log with an empty entry.
5949 What if you subtracted those away minutes from the current clock, and now
5950 want to apply them to a new clock? Simply clock in to any task immediately
5951 after the subtraction. Org will notice that you have subtracted time ``on
5952 the books'', so to speak, and will ask if you want to apply those minutes to
5953 the next task you clock in on.
5955 There is one other instance when this clock resolution magic occurs. Say you
5956 were clocked in and hacking away, and suddenly your cat chased a mouse who
5957 scared a hamster that crashed into your UPS's power button! You suddenly
5958 lose all your buffers, but thanks to auto-save you still have your recent Org
5959 mode changes, including your last clock in.
5961 If you restart Emacs and clock into any task, Org will notice that you have a
5962 dangling clock which was never clocked out from your last session. Using
5963 that clock's starting time as the beginning of the unaccounted-for period,
5964 Org will ask how you want to resolve that time. The logic and behavior is
5965 identical to dealing with away time due to idleness; it's just happening due
5966 to a recovery event rather than a set amount of idle time.
5968 You can also check all the files visited by your Org agenda for dangling
5969 clocks at any time using @kbd{M-x org-resolve-clocks}.
5971 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
5972 @section Effort estimates
5973 @cindex effort estimates
5975 @cindex property, Effort
5976 @vindex org-effort-property
5977 If you want to plan your work in a very detailed way, or if you need to
5978 produce offers with quotations of the estimated work effort, you may want to
5979 assign effort estimates to entries. If you are also clocking your work, you
5980 may later want to compare the planned effort with the actual working time, a
5981 great way to improve planning estimates. Effort estimates are stored in a
5982 special property @samp{Effort}@footnote{You may change the property being
5983 used with the variable @code{org-effort-property}.}. You can set the effort
5984 for an entry with the following commands:
5987 @orgcmd{C-c C-x e,org-set-effort}
5988 Set the effort estimate for the current entry. With a numeric prefix
5989 argument, set it to the Nth allowed value (see below). This command is also
5990 accessible from the agenda with the @kbd{e} key.
5991 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5992 Modify the effort estimate of the item currently being clocked.
5995 Clearly the best way to work with effort estimates is through column view
5996 (@pxref{Column view}). You should start by setting up discrete values for
5997 effort estimates, and a @code{COLUMNS} format that displays these values
5998 together with clock sums (if you want to clock your time). For a specific
6002 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
6003 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6007 @vindex org-global-properties
6008 @vindex org-columns-default-format
6009 or, even better, you can set up these values globally by customizing the
6010 variables @code{org-global-properties} and @code{org-columns-default-format}.
6011 In particular if you want to use this setup also in the agenda, a global
6012 setup may be advised.
6014 The way to assign estimates to individual items is then to switch to column
6015 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6016 value. The values you enter will immediately be summed up in the hierarchy.
6017 In the column next to it, any clocked time will be displayed.
6019 @vindex org-agenda-columns-add-appointments-to-effort-sum
6020 If you switch to column view in the daily/weekly agenda, the effort column
6021 will summarize the estimated work effort for each day@footnote{Please note
6022 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6023 column view}).}, and you can use this to find space in your schedule. To get
6024 an overview of the entire part of the day that is committed, you can set the
6025 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6026 appointments on a day that take place over a specified time interval will
6027 then also be added to the load estimate of the day.
6029 Effort estimates can be used in secondary agenda filtering that is triggered
6030 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6031 these estimates defined consistently, two or three key presses will narrow
6032 down the list to stuff that fits into an available time slot.
6034 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6035 @section Taking notes with a relative timer
6036 @cindex relative timer
6038 When taking notes during, for example, a meeting or a video viewing, it can
6039 be useful to have access to times relative to a starting time. Org provides
6040 such a relative timer and make it easy to create timed notes.
6043 @orgcmd{C-c C-x .,org-timer}
6044 Insert a relative time into the buffer. The first time you use this, the
6045 timer will be started. When called with a prefix argument, the timer is
6047 @orgcmd{C-c C-x -,org-timer-item}
6048 Insert a description list item with the current relative time. With a prefix
6049 argument, first reset the timer to 0.
6050 @orgcmd{M-@key{RET},org-insert-heading}
6051 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6053 @c for key sequences with a comma, command name macros fail :(
6056 Pause the timer, or continue it if it is already paused
6057 (@command{org-timer-pause-or-continue}).
6058 @c removed the sentence because it is redundant to the following item
6059 @kindex C-u C-c C-x ,
6061 Stop the timer. After this, you can only start a new timer, not continue the
6062 old one. This command also removes the timer from the mode line.
6063 @orgcmd{C-c C-x 0,org-timer-start}
6064 Reset the timer without inserting anything into the buffer. By default, the
6065 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6066 specific starting offset. The user is prompted for the offset, with a
6067 default taken from a timer string at point, if any, So this can be used to
6068 restart taking notes after a break in the process. When called with a double
6069 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6070 by a certain amount. This can be used to fix timer strings if the timer was
6071 not started at exactly the right moment.
6074 @node Countdown timer, , Relative timer, Dates and Times
6075 @section Countdown timer
6076 @cindex Countdown timer
6080 Calling @code{org-timer-set-timer} from an Org-mode buffer runs a countdown
6081 timer. Use @key{;} from agenda buffers, @key{C-c C-x ;} everwhere else.
6083 @code{org-timer-set-timer} prompts the user for a duration and displays a
6084 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6085 default countdown value. Giving a prefix numeric argument overrides this
6088 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6089 @chapter Capture - Refile - Archive
6092 An important part of any organization system is the ability to quickly
6093 capture new ideas and tasks, and to associate reference material with them.
6094 Org does this using a process called @i{capture}. It also can store files
6095 related to a task (@i{attachments}) in a special directory. Once in the
6096 system, tasks and projects need to be moved around. Moving completed project
6097 trees to an archive file keeps the system compact and fast.
6100 * Capture:: Capturing new stuff
6101 * Attachments:: Add files to tasks
6102 * RSS Feeds:: Getting input from RSS feeds
6103 * Protocols:: External (e.g. Browser) access to Emacs and Org
6104 * Refiling notes:: Moving a tree from one place to another
6105 * Archiving:: What to do with finished projects
6108 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6112 Org's method for capturing new items is heavily inspired by John Wiegley
6113 excellent remember package. Up to version 6.36 Org used a special setup
6114 for @file{remember.el}. @file{org-remember.el} is still part of Org-mode for
6115 backward compatibility with existing setups. You can find the documentation
6116 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6118 The new capturing setup described here is preferred and should be used by new
6119 users. To convert your @code{org-remember-templates}, run the command
6121 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6123 @noindent and then customize the new variable with @kbd{M-x
6124 customize-variable org-capture-templates}, check the result, and save the
6125 customization. You can then use both remember and capture until
6126 you are familiar with the new mechanism.
6128 Capture lets you quickly store notes with little interruption of your work
6129 flow. The basic process of capturing is very similar to remember, but Org
6130 does enhance it with templates and more.
6133 * Setting up capture:: Where notes will be stored
6134 * Using capture:: Commands to invoke and terminate capture
6135 * Capture templates:: Define the outline of different note types
6138 @node Setting up capture, Using capture, Capture, Capture
6139 @subsection Setting up capture
6141 The following customization sets a default target file for notes, and defines
6142 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6143 suggestion.} for capturing new material.
6145 @vindex org-default-notes-file
6147 (setq org-default-notes-file (concat org-directory "/notes.org"))
6148 (define-key global-map "\C-cc" 'org-capture)
6151 @node Using capture, Capture templates, Setting up capture, Capture
6152 @subsection Using capture
6155 @orgcmd{C-c c,org-capture}
6156 Call the command @code{org-capture}. Note that this keybinding is global and
6157 not active by default - you need to install it. If you have templates
6158 defined @pxref{Capture templates}, it will offer these templates for
6159 selection or use a new Org outline node as the default template. It will
6160 insert the template into the target file and switch to an indirect buffer
6161 narrowed to this new node. You may then insert the information you want.
6163 @orgcmd{C-c C-c,org-capture-finalize}
6164 Once you have finished entering information into the capture buffer, @kbd{C-c
6165 C-c} will return you to the window configuration before the capture process,
6166 so that you can resume your work without further distraction. When called
6167 with a prefix arg, finalize and then jump to the captured item.
6169 @orgcmd{C-c C-w,org-capture-refile}
6170 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6171 a different place. Please realize that this is a normal refiling command
6172 that will be executed---so the cursor position at the moment you run this
6173 command is important. If you have inserted a tree with a parent and
6174 children, first move the cursor back to the parent. Any prefix argument
6175 given to this command will be passed on to the @code{org-refile} command.
6177 @orgcmd{C-c C-k,org-capture-kill}
6178 Abort the capture process and return to the previous state.
6182 You can also call @code{org-capture} in a special way from the agenda, using
6183 the @kbd{k c} key combination. With this access, any timestamps inserted by
6184 the selected capture template will default to the cursor date in the agenda,
6185 rather than to the current date.
6187 To find the locations of the last stored capture, use @code{org-capture} with
6192 Visit the target location of a cpature template. You get to select the
6193 template in the usual way.
6194 @orgkey{C-u C-u C-c c}
6195 Visit the last stored capture item in its buffer.
6198 @node Capture templates, , Using capture, Capture
6199 @subsection Capture templates
6200 @cindex templates, for Capture
6202 You can use templates for different types of capture items, and
6203 for different target locations. The easiest way to create such templates is
6204 through the customize interface.
6208 Customize the variable @code{org-capture-templates}.
6211 Before we give the formal description of template definitions, let's look at
6212 an example. Say you would like to use one template to create general TODO
6213 entries, and you want to put these entries under the heading @samp{Tasks} in
6214 your file @file{~/org/gtd.org}. Also, a date tree in the file
6215 @file{journal.org} should capture journal entries. A possible configuration
6219 (setq org-capture-templates
6220 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6221 "* TODO %?\n %i\n %a")
6222 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6223 "* %?\nEntered on %U\n %i\n %a")))
6226 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6230 [[file:@var{link to where you initiated capture}]]
6234 During expansion of the template, @code{%a} has been replaced by a link to
6235 the location from where you called the capture command. This can be
6236 extremely useful for deriving tasks from emails, for example. You fill in
6237 the task definition, press @code{C-c C-c} and Org returns you to the same
6238 place where you started the capture process.
6240 To define special keys to capture to a particular template without going
6241 through the interactive template selection, you can create your key binding
6245 (define-key global-map "\C-c c"
6246 (lambda () (interactive) (org-capture "t")))
6250 * Template elements:: What is needed for a complete template entry
6251 * Template expansion:: Filling in information about time and context
6254 @node Template elements, Template expansion, Capture templates, Capture templates
6255 @subsubsection Template elements
6257 Now lets look at the elements of a template definition. Each entry in
6258 @code{org-capture-templates} is a list with the following items:
6262 The keys that will select the template, as a string, characters
6263 only, for example @code{"a"} for a template to be selected with a
6264 single key, or @code{"bt"} for selection with two keys. When using
6265 several keys, keys using the same prefix key must be sequential
6266 in the list and preceded by a 2-element entry explaining the
6267 prefix key, for example
6269 ("b" "Templates for marking stuff to buy")
6271 @noindent If you do not define a template for the @kbd{C} key, this key will
6272 be used to open the customize buffer for this complex variable.
6275 A short string describing the template, which will be shown during
6279 The type of entry, a symbol. Valid values are:
6282 An Org-mode node, with a headline. Will be filed as the child of the
6283 target entry or as a top-level entry. The target file should be an Org-mode
6286 A plain list item, placed in the first plain list at the target
6287 location. Again the target file should be an Org file.
6289 A checkbox item. This only differs from the plain list item by the
6292 a new line in the first table at the target location. Where exactly the
6293 line will be inserted depends on the properties @code{:prepend} and
6294 @code{:table-line-pos} (see below).
6296 Text to be inserted as it is.
6300 @vindex org-default-notes-file
6301 Specification of where the captured item should be placed. In Org-mode
6302 files, targets usually define a node. Entries will become children of this
6303 node. Other types will be added to the table or list in the body of this
6304 node. Most target specifications contain a file name. If that file name is
6305 the empty string, it defaults to @code{org-default-notes-file}.
6309 @item (file "path/to/file")
6310 Text will be placed at the beginning or end of that file.
6312 @item (id "id of existing org entry")
6313 Filing as child of this entry, or in the body of the entry.
6315 @item (file+headline "path/to/file" "node headline")
6316 Fast configuration if the target heading is unique in the file.
6318 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6319 For non-unique headings, the full path is safer.
6321 @item (file+regexp "path/to/file" "regexp to find location")
6322 Use a regular expression to position the cursor.
6324 @item (file+datetree "path/to/file")
6325 Will create a heading in a date tree for today's date.
6327 @item (file+datetree+prompt "path/to/file")
6328 Will create a heading in a date tree, but will prompt for the date.
6330 @item (file+function "path/to/file" function-finding-location)
6331 A function to find the right location in the file.
6334 File to the entry that is currently being clocked.
6336 @item (function function-finding-location)
6337 Most general way, write your own function to find both
6342 The template for creating the capture item. If you leave this empty, an
6343 appropriate default template will be used. Otherwise this is a string with
6344 escape codes, which will be replaced depending on time and context of the
6345 capture call. The string with escapes may be loaded from a template file,
6346 using the special syntax @code{(file "path/to/template")}. See below for
6350 The rest of the entry is a property list of additional options.
6351 Recognized properties are:
6354 Normally new captured information will be appended at
6355 the target location (last child, last table line, last list item...).
6356 Setting this property will change that.
6358 @item :immediate-finish
6359 When set, do not offer to edit the information, just
6360 file it away immediately. This makes sense if the template only needs
6361 information that can be added automatically.
6364 Set this to the number of lines to insert
6365 before and after the new item. Default 0, only common other value is 1.
6368 Start the clock in this item.
6371 If starting the capture interrupted a clock, restart that clock when finished
6375 Do not narrow the target buffer, simply show the full buffer. Default is to
6376 narrow it so that you only see the new material.
6379 If the target file was not yet visited when capture was invoked, kill the
6380 buffer again after capture is completed.
6384 @node Template expansion, , Template elements, Capture templates
6385 @subsubsection Template expansion
6387 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6388 these sequences literally, escape the @kbd{%} with a backslash.} allow
6389 dynamic insertion of content:
6391 @comment SJE: should these sentences terminate in period?
6393 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6394 @r{You may specify a default value and a completion table with}
6395 @r{%^@{prompt|default|completion2|completion3...@}}
6396 @r{The arrow keys access a prompt-specific history.}
6397 %a @r{annotation, normally the link created with @code{org-store-link}}
6398 %A @r{like @code{%a}, but prompt for the description part}
6399 %i @r{initial content, the region when capture is called while the}
6400 @r{region is active.}
6401 @r{The entire text will be indented like @code{%i} itself.}
6402 %t @r{timestamp, date only}
6403 %T @r{timestamp with date and time}
6404 %u, %U @r{like the above, but inactive timestamps}
6405 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
6406 @r{You may define a prompt like @code{%^@{Birthday@}t}}
6407 %n @r{user name (taken from @code{user-full-name})}
6408 %c @r{Current kill ring head.}
6409 %x @r{Content of the X clipboard.}
6410 %^C @r{Interactive selection of which kill or clip to use.}
6411 %^L @r{Like @code{%^C}, but insert as link.}
6412 %k @r{title of the currently clocked task}
6413 %K @r{link to the currently clocked task}
6414 %f @r{file visited by current buffer when org-capture was called}
6415 %F @r{like @code{%f}, but include full path}
6416 %^g @r{prompt for tags, with completion on tags in target file.}
6417 %^G @r{prompt for tags, with completion all tags in all agenda files.}
6418 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
6419 %:keyword @r{specific information for certain link types, see below}
6420 %[@var{file}] @r{insert the contents of the file given by @var{file}}
6421 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
6425 For specific link types, the following keywords will be
6426 defined@footnote{If you define your own link types (@pxref{Adding
6427 hyperlink types}), any property you store with
6428 @code{org-store-link-props} can be accessed in capture templates in a
6431 @vindex org-from-is-user-regexp
6433 Link type | Available keywords
6434 -------------------+----------------------------------------------
6435 bbdb | %:name %:company
6436 irc | %:server %:port %:nick
6437 vm, wl, mh, mew, rmail | %:type %:subject %:message-id
6438 | %:from %:fromname %:fromaddress
6439 | %:to %:toname %:toaddress
6440 | %:date @r{(message date header field)}
6441 | %:date-timestamp @r{(date as active timestamp)}
6442 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6443 | %: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}.}}
6444 gnus | %:group, @r{for messages also all email fields}
6446 info | %:file %:node
6451 To place the cursor after template expansion use:
6454 %? @r{After completing the template, position cursor here.}
6458 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6459 @section Attachments
6462 @vindex org-attach-directory
6463 It is often useful to associate reference material with an outline node/task.
6464 Small chunks of plain text can simply be stored in the subtree of a project.
6465 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6466 files that live elsewhere on your computer or in the cloud, like emails or
6467 source code files belonging to a project. Another method is @i{attachments},
6468 which are files located in a directory belonging to an outline node. Org
6469 uses directories named by the unique ID of each entry. These directories are
6470 located in the @file{data} directory which lives in the same directory where
6471 your Org file lives@footnote{If you move entries or Org files from one
6472 directory to another, you may want to configure @code{org-attach-directory}
6473 to contain an absolute path.}. If you initialize this directory with
6474 @code{git init}, Org will automatically commit changes when it sees them.
6475 The attachment system has been contributed to Org by John Wiegley.
6477 In cases where it seems better to do so, you can also attach a directory of your
6478 choice to an entry. You can also make children inherit the attachment
6479 directory from a parent, so that an entire subtree uses the same attached
6482 @noindent The following commands deal with attachments:
6486 @orgcmd{C-c C-a,org-attach}
6487 The dispatcher for commands related to the attachment system. After these
6488 keys, a list of commands is displayed and you must press an additional key
6489 to select a command:
6492 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6493 @vindex org-attach-method
6494 Select a file and move it into the task's attachment directory. The file
6495 will be copied, moved, or linked, depending on @code{org-attach-method}.
6496 Note that hard links are not supported on all systems.
6502 Attach a file using the copy/move/link method.
6503 Note that hard links are not supported on all systems.
6505 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6506 Create a new attachment as an Emacs buffer.
6508 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6509 Synchronize the current task with its attachment directory, in case you added
6510 attachments yourself.
6512 @orgcmdtkc{p,C-c C-a o,org-attach-open}
6513 @vindex org-file-apps
6514 Open current task's attachment. If there is more than one, prompt for a
6515 file name first. Opening will follow the rules set by @code{org-file-apps}.
6516 For more details, see the information on following hyperlinks
6517 (@pxref{Handling links}).
6519 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6520 Also open the attachment, but force opening the file in Emacs.
6522 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6523 Open the current task's attachment directory.
6525 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6526 Also open the directory, but force using @command{dired} in Emacs.
6528 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6529 Select and delete a single attachment.
6531 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6532 Delete all of a task's attachments. A safer way is to open the directory in
6533 @command{dired} and delete from there.
6535 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6536 @cindex property, ATTACH_DIR
6537 Set a specific directory as the entry's attachment directory. This works by
6538 putting the directory path into the @code{ATTACH_DIR} property.
6540 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6541 @cindex property, ATTACH_DIR_INHERIT
6542 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6543 same directory for attachments as the parent does.
6547 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6552 Org can add and change entries based on information found in RSS feeds and
6553 Atom feeds. You could use this to make a task out of each new podcast in a
6554 podcast feed. Or you could use a phone-based note-creating service on the
6555 web to import tasks into Org. To access feeds, configure the variable
6556 @code{org-feed-alist}. The docstring of this variable has detailed
6557 information. Here is just an example:
6560 (setq org-feed-alist
6562 "http://rss.slashdot.org/Slashdot/slashdot"
6563 "~/txt/org/feeds.org" "Slashdot Entries")))
6567 will configure that new items from the feed provided by
6568 @code{rss.slashdot.org} will result in new entries in the file
6569 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6570 the following command is used:
6573 @orgcmd{C-c C-x g,org-feed-update-all}
6575 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6577 @orgcmd{C-c C-x G,org-feed-goto-inbox}
6578 Prompt for a feed name and go to the inbox configured for this feed.
6581 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6582 it will store information about the status of items in the feed, to avoid
6583 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6584 list of drawers in that file:
6587 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6590 For more information, including how to read atom feeds, see
6591 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6593 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6594 @section Protocols for external access
6595 @cindex protocols, for external access
6598 You can set up Org for handling protocol calls from outside applications that
6599 are passed to Emacs through the @file{emacsserver}. For example, you can
6600 configure bookmarks in your web browser to send a link to the current page to
6601 Org and create a note from it using capture (@pxref{Capture}). Or you
6602 could create a bookmark that will tell Emacs to open the local source file of
6603 a remote website you are looking at with the browser. See
6604 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6605 documentation and setup instructions.
6607 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6608 @section Refiling notes
6609 @cindex refiling notes
6611 When reviewing the captured data, you may want to refile some of the entries
6612 into a different list, for example into a project. Cutting, finding the
6613 right location, and then pasting the note is cumbersome. To simplify this
6614 process, you can use the following special command:
6617 @orgcmd{C-c C-w,org-refile}
6618 @vindex org-reverse-note-order
6619 @vindex org-refile-targets
6620 @vindex org-refile-use-outline-path
6621 @vindex org-outline-path-complete-in-steps
6622 @vindex org-refile-allow-creating-parent-nodes
6623 @vindex org-log-refile
6624 @vindex org-refile-use-cache
6625 Refile the entry or region at point. This command offers possible locations
6626 for refiling the entry and lets you select one with completion. The item (or
6627 all items in the region) is filed below the target heading as a subitem.
6628 Depending on @code{org-reverse-note-order}, it will be either the first or
6630 By default, all level 1 headlines in the current buffer are considered to be
6631 targets, but you can have more complex definitions across a number of files.
6632 See the variable @code{org-refile-targets} for details. If you would like to
6633 select a location via a file-path-like completion along the outline path, see
6634 the variables @code{org-refile-use-outline-path} and
6635 @code{org-outline-path-complete-in-steps}. If you would like to be able to
6636 create new nodes as new parents for refiling on the fly, check the
6637 variable @code{org-refile-allow-creating-parent-nodes}.
6638 When the variable @code{org-log-refile}@footnote{with corresponding
6639 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6640 and @code{nologrefile}} is set, a time stamp or a note will be
6641 recorded when an entry has been refiled.
6642 @orgkey{C-u C-c C-w}
6643 Use the refile interface to jump to a heading.
6644 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
6645 Jump to the location where @code{org-refile} last moved a tree to.
6647 Refile as the child of the item currently being clocked.
6648 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6650 @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}
6652 Clear the target cache. Caching of refile targets can be turned on by
6653 setting @code{org-refile-use-cache}. To make the command see new possible
6654 targets, you have to clear the cache with this command.
6657 @node Archiving, , Refiling notes, Capture - Refile - Archive
6661 When a project represented by a (sub)tree is finished, you may want
6662 to move the tree out of the way and to stop it from contributing to the
6663 agenda. Archiving is important to keep your working files compact and global
6664 searches like the construction of agenda views fast.
6667 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
6668 @vindex org-archive-default-command
6669 Archive the current entry using the command specified in the variable
6670 @code{org-archive-default-command}.
6674 * Moving subtrees:: Moving a tree to an archive file
6675 * Internal archiving:: Switch off a tree but keep it in the file
6678 @node Moving subtrees, Internal archiving, Archiving, Archiving
6679 @subsection Moving a tree to the archive file
6680 @cindex external archiving
6682 The most common archiving action is to move a project tree to another file,
6686 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
6687 @vindex org-archive-location
6688 Archive the subtree starting at the cursor position to the location
6689 given by @code{org-archive-location}.
6690 @orgkey{C-u C-c C-x C-s}
6691 Check if any direct children of the current headline could be moved to
6692 the archive. To do this, each subtree is checked for open TODO entries.
6693 If none are found, the command offers to move it to the archive
6694 location. If the cursor is @emph{not} on a headline when this command
6695 is invoked, the level 1 trees will be checked.
6698 @cindex archive locations
6699 The default archive location is a file in the same directory as the
6700 current file, with the name derived by appending @file{_archive} to the
6701 current file name. For information and examples on how to change this,
6702 see the documentation string of the variable
6703 @code{org-archive-location}. There is also an in-buffer option for
6704 setting this variable, for example@footnote{For backward compatibility,
6705 the following also works: If there are several such lines in a file,
6706 each specifies the archive location for the text below it. The first
6707 such line also applies to any text before its definition. However,
6708 using this method is @emph{strongly} deprecated as it is incompatible
6709 with the outline structure of the document. The correct method for
6710 setting multiple archive locations in a buffer is using properties.}:
6714 #+ARCHIVE: %s_done::
6717 @cindex property, ARCHIVE
6719 If you would like to have a special ARCHIVE location for a single entry
6720 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6721 location as the value (@pxref{Properties and Columns}).
6723 @vindex org-archive-save-context-info
6724 When a subtree is moved, it receives a number of special properties that
6725 record context information like the file from where the entry came, its
6726 outline path the archiving time etc. Configure the variable
6727 @code{org-archive-save-context-info} to adjust the amount of information
6731 @node Internal archiving, , Moving subtrees, Archiving
6732 @subsection Internal archiving
6734 If you want to just switch off (for agenda views) certain subtrees without
6735 moving them to a different file, you can use the @code{ARCHIVE tag}.
6737 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6738 its location in the outline tree, but behaves in the following way:
6741 @vindex org-cycle-open-archived-trees
6742 It does not open when you attempt to do so with a visibility cycling
6743 command (@pxref{Visibility cycling}). You can force cycling archived
6744 subtrees with @kbd{C-@key{TAB}}, or by setting the option
6745 @code{org-cycle-open-archived-trees}. Also normal outline commands like
6746 @code{show-all} will open archived subtrees.
6748 @vindex org-sparse-tree-open-archived-trees
6749 During sparse tree construction (@pxref{Sparse trees}), matches in
6750 archived subtrees are not exposed, unless you configure the option
6751 @code{org-sparse-tree-open-archived-trees}.
6753 @vindex org-agenda-skip-archived-trees
6754 During agenda view construction (@pxref{Agenda Views}), the content of
6755 archived trees is ignored unless you configure the option
6756 @code{org-agenda-skip-archived-trees}, in which case these trees will always
6757 be included. In the agenda you can press @kbd{v a} to get archives
6758 temporarily included.
6760 @vindex org-export-with-archived-trees
6761 Archived trees are not exported (@pxref{Exporting}), only the headline
6762 is. Configure the details using the variable
6763 @code{org-export-with-archived-trees}.
6765 @vindex org-columns-skip-archived-trees
6766 Archived trees are excluded from column view unless the variable
6767 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
6770 The following commands help manage the ARCHIVE tag:
6773 @orgcmd{C-c C-x a,org-toggle-archive-tag}
6774 Toggle the ARCHIVE tag for the current headline. When the tag is set,
6775 the headline changes to a shadowed face, and the subtree below it is
6777 @orgkey{C-u C-c C-x a}
6778 Check if any direct children of the current headline should be archived.
6779 To do this, each subtree is checked for open TODO entries. If none are
6780 found, the command offers to set the ARCHIVE tag for the child. If the
6781 cursor is @emph{not} on a headline when this command is invoked, the
6782 level 1 trees will be checked.
6783 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
6784 Cycle a tree even if it is tagged with ARCHIVE.
6785 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
6786 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
6787 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
6788 entry becomes a child of that sibling and in this way retains a lot of its
6789 original context, including inherited tags and approximate position in the
6794 @node Agenda Views, Markup, Capture - Refile - Archive, Top
6795 @chapter Agenda views
6796 @cindex agenda views
6798 Due to the way Org works, TODO items, time-stamped items, and
6799 tagged headlines can be scattered throughout a file or even a number of
6800 files. To get an overview of open action items, or of events that are
6801 important for a particular date, this information must be collected,
6802 sorted and displayed in an organized way.
6804 Org can select items based on various criteria and display them
6805 in a separate buffer. Seven different view types are provided:
6809 an @emph{agenda} that is like a calendar and shows information
6812 a @emph{TODO list} that covers all unfinished
6815 a @emph{match view}, showings headlines based on the tags, properties, and
6816 TODO state associated with them,
6818 a @emph{timeline view} that shows all events in a single Org file,
6819 in time-sorted view,
6821 a @emph{text search view} that shows all entries from multiple files
6822 that contain specified keywords,
6824 a @emph{stuck projects view} showing projects that currently don't move
6827 @emph{custom views} that are special searches and combinations of different
6832 The extracted information is displayed in a special @emph{agenda
6833 buffer}. This buffer is read-only, but provides commands to visit the
6834 corresponding locations in the original Org files, and even to
6835 edit these files remotely.
6837 @vindex org-agenda-window-setup
6838 @vindex org-agenda-restore-windows-after-quit
6839 Two variables control how the agenda buffer is displayed and whether the
6840 window configuration is restored when the agenda exits:
6841 @code{org-agenda-window-setup} and
6842 @code{org-agenda-restore-windows-after-quit}.
6845 * Agenda files:: Files being searched for agenda information
6846 * Agenda dispatcher:: Keyboard access to agenda views
6847 * Built-in agenda views:: What is available out of the box?
6848 * Presentation and sorting:: How agenda items are prepared for display
6849 * Agenda commands:: Remote editing of Org trees
6850 * Custom agenda views:: Defining special searches and views
6851 * Exporting Agenda Views:: Writing a view to a file
6852 * Agenda column view:: Using column view for collected entries
6855 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
6856 @section Agenda files
6857 @cindex agenda files
6858 @cindex files for agenda
6860 @vindex org-agenda-files
6861 The information to be shown is normally collected from all @emph{agenda
6862 files}, the files listed in the variable
6863 @code{org-agenda-files}@footnote{If the value of that variable is not a
6864 list, but a single file name, then the list of agenda files will be
6865 maintained in that external file.}. If a directory is part of this list,
6866 all files with the extension @file{.org} in this directory will be part
6869 Thus, even if you only work with a single Org file, that file should
6870 be put into the list@footnote{When using the dispatcher, pressing
6871 @kbd{<} before selecting a command will actually limit the command to
6872 the current file, and ignore @code{org-agenda-files} until the next
6873 dispatcher command.}. You can customize @code{org-agenda-files}, but
6874 the easiest way to maintain it is through the following commands
6876 @cindex files, adding to agenda list
6878 @orgcmd{C-c [,org-agenda-to-front}
6879 Add current file to the list of agenda files. The file is added to
6880 the front of the list. If it was already in the list, it is moved to
6881 the front. With a prefix argument, file is added/moved to the end.
6882 @orgcmd{C-c ],org-remove-file}
6883 Remove current file from the list of agenda files.
6885 @orgcmd{C-',org-cycle-agenda-files}
6887 Cycle through agenda file list, visiting one file after the other.
6888 @kindex M-x org-iswitchb
6889 @item M-x org-iswitchb
6890 Command to use an @code{iswitchb}-like interface to switch to and between Org
6895 The Org menu contains the current list of files and can be used
6896 to visit any of them.
6898 If you would like to focus the agenda temporarily on a file not in
6899 this list, or on just one file in the list, or even on only a subtree in a
6900 file, then this can be done in different ways. For a single agenda command,
6901 you may press @kbd{<} once or several times in the dispatcher
6902 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
6903 extended period, use the following commands:
6906 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
6907 Permanently restrict the agenda to the current subtree. When with a
6908 prefix argument, or with the cursor before the first headline in a file,
6909 the agenda scope is set to the entire file. This restriction remains in
6910 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
6911 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
6912 agenda view, the new restriction takes effect immediately.
6913 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
6914 Remove the permanent restriction created by @kbd{C-c C-x <}.
6918 When working with @file{speedbar.el}, you can use the following commands in
6921 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
6922 Permanently restrict the agenda to the item---either an Org file or a subtree
6923 in such a file---at the cursor in the Speedbar frame.
6924 If there is a window displaying an agenda view, the new restriction takes
6926 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
6927 Lift the restriction.
6930 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
6931 @section The agenda dispatcher
6932 @cindex agenda dispatcher
6933 @cindex dispatching agenda commands
6934 The views are created through a dispatcher, which should be bound to a
6935 global key---for example @kbd{C-c a} (@pxref{Installation}). In the
6936 following we will assume that @kbd{C-c a} is indeed how the dispatcher
6937 is accessed and list keyboard access to commands accordingly. After
6938 pressing @kbd{C-c a}, an additional letter is required to execute a
6939 command. The dispatcher offers the following default commands:
6942 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
6944 Create a list of all TODO items (@pxref{Global TODO list}).
6946 Create a list of headlines matching a TAGS expression (@pxref{Matching
6947 tags and properties}).
6949 Create the timeline view for the current buffer (@pxref{Timeline}).
6951 Create a list of entries selected by a boolean expression of keywords
6952 and/or regular expressions that must or must not occur in the entry.
6954 @vindex org-agenda-text-search-extra-files
6955 Search for a regular expression in all agenda files and additionally in
6956 the files listed in @code{org-agenda-text-search-extra-files}. This
6957 uses the Emacs command @code{multi-occur}. A prefix argument can be
6958 used to specify the number of context lines for each match, default is
6961 Create a list of stuck projects (@pxref{Stuck projects}).
6963 Restrict an agenda command to the current buffer@footnote{For backward
6964 compatibility, you can also press @kbd{1} to restrict to the current
6965 buffer.}. After pressing @kbd{<}, you still need to press the character
6966 selecting the command.
6968 If there is an active region, restrict the following agenda command to
6969 the region. Otherwise, restrict it to the current subtree@footnote{For
6970 backward compatibility, you can also press @kbd{0} to restrict to the
6971 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
6972 character selecting the command.
6975 You can also define custom commands that will be accessible through the
6976 dispatcher, just like the default commands. This includes the
6977 possibility to create extended agenda buffers that contain several
6978 blocks together, for example the weekly agenda, the global TODO list and
6979 a number of special tags matches. @xref{Custom agenda views}.
6981 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
6982 @section The built-in agenda views
6984 In this section we describe the built-in views.
6987 * Weekly/daily agenda:: The calendar page with current tasks
6988 * Global TODO list:: All unfinished action items
6989 * Matching tags and properties:: Structured information with fine-tuned search
6990 * Timeline:: Time-sorted view for single file
6991 * Search view:: Find entries by searching for text
6992 * Stuck projects:: Find projects you need to review
6995 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
6996 @subsection The weekly/daily agenda
6998 @cindex weekly agenda
6999 @cindex daily agenda
7001 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7002 paper agenda, showing all the tasks for the current week or day.
7005 @cindex org-agenda, command
7006 @orgcmd{C-c a a,org-agenda-list}
7007 Compile an agenda for the current week from a list of Org files. The agenda
7008 shows the entries for each day. With a numeric prefix@footnote{For backward
7009 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7010 listed before the agenda. This feature is deprecated, use the dedicated TODO
7011 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7012 C-c a a}) you may set the number of days to be displayed.
7015 @vindex org-agenda-span
7016 @vindex org-agenda-ndays
7017 The default number of days displayed in the agenda is set by the variable
7018 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7019 variable can be set to any number of days you want to see by default in the
7020 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7023 Remote editing from the agenda buffer means, for example, that you can
7024 change the dates of deadlines and appointments from the agenda buffer.
7025 The commands available in the Agenda buffer are listed in @ref{Agenda
7028 @subsubheading Calendar/Diary integration
7029 @cindex calendar integration
7030 @cindex diary integration
7032 Emacs contains the calendar and diary by Edward M. Reingold. The
7033 calendar displays a three-month calendar with holidays from different
7034 countries and cultures. The diary allows you to keep track of
7035 anniversaries, lunar phases, sunrise/set, recurrent appointments
7036 (weekly, monthly) and more. In this way, it is quite complementary to
7037 Org. It can be very useful to combine output from Org with
7040 In order to include entries from the Emacs diary into Org-mode's
7041 agenda, you only need to customize the variable
7044 (setq org-agenda-include-diary t)
7047 @noindent After that, everything will happen automatically. All diary
7048 entries including holidays, anniversaries, etc., will be included in the
7049 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
7050 @key{RET} can be used from the agenda buffer to jump to the diary
7051 file in order to edit existing diary entries. The @kbd{i} command to
7052 insert new entries for the current date works in the agenda buffer, as
7053 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7054 Sunrise/Sunset times, show lunar phases and to convert to other
7055 calendars, respectively. @kbd{c} can be used to switch back and forth
7056 between calendar and agenda.
7058 If you are using the diary only for sexp entries and holidays, it is
7059 faster to not use the above setting, but instead to copy or even move
7060 the entries into an Org file. Org-mode evaluates diary-style sexp
7061 entries, and does it faster because there is no overhead for first
7062 creating the diary display. Note that the sexp entries must start at
7063 the left margin, no whitespace is allowed before them. For example,
7064 the following segment of an Org file will be processed and entries
7065 will be made in the agenda:
7068 * Birthdays and similar stuff
7070 %%(org-calendar-holiday) ; special function for holiday names
7072 %%(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
7073 %%(diary-anniversary 10 2 1869) Mahatma Gandhi would be %d years old
7076 @subsubheading Anniversaries from BBDB
7077 @cindex BBDB, anniversaries
7078 @cindex anniversaries, from BBDB
7080 If you are using the Big Brothers Database to store your contacts, you will
7081 very likely prefer to store anniversaries in BBDB rather than in a
7082 separate Org or diary file. Org supports this and will show BBDB
7083 anniversaries as part of the agenda. All you need to do is to add the
7084 following to one your your agenda files:
7091 %%(org-bbdb-anniversaries)
7094 You can then go ahead and define anniversaries for a BBDB record. Basically,
7095 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7096 record and then add the date in the format @code{YYYY-MM-DD}, followed by a
7097 space and the class of the anniversary (@samp{birthday} or @samp{wedding}, or
7098 a format string). If you omit the class, it will default to @samp{birthday}.
7099 Here are a few examples, the header for the file @file{org-bbdb.el} contains
7100 more detailed information.
7105 2008-04-14 %s released version 6.01 of org-mode, %d years ago
7108 After a change to BBDB, or for the first agenda display during an Emacs
7109 session, the agenda display will suffer a short delay as Org updates its
7110 hash with anniversaries. However, from then on things will be very fast---much
7111 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7112 in an Org or Diary file.
7114 @subsubheading Appointment reminders
7115 @cindex @file{appt.el}
7116 @cindex appointment reminders
7118 Org can interact with Emacs appointments notification facility. To add all
7119 the appointments of your agenda files, use the command
7120 @code{org-agenda-to-appt}. This command also lets you filter through the
7121 list of your appointments and add only those belonging to a specific category
7122 or matching a regular expression. See the docstring for details.
7124 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7125 @subsection The global TODO list
7126 @cindex global TODO list
7127 @cindex TODO list, global
7129 The global TODO list contains all unfinished TODO items formatted and
7130 collected into a single place.
7133 @orgcmd{C-c a t,org-todo-list}
7134 Show the global TODO list. This collects the TODO items from all agenda
7135 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7136 items with a state the is not a DONE state. The buffer is in
7137 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7138 entries directly from that buffer (@pxref{Agenda commands}).
7139 @orgcmd{C-c a T,org-todo-list}
7140 @cindex TODO keyword matching
7141 @vindex org-todo-keywords
7142 Like the above, but allows selection of a specific TODO keyword. You can
7143 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7144 prompted for a keyword, and you may also specify several keywords by
7145 separating them with @samp{|} as the boolean OR operator. With a numeric
7146 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7148 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7149 a prefix argument to this command to change the selected TODO keyword,
7150 for example @kbd{3 r}. If you often need a search for a specific
7151 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7152 Matching specific TODO keywords can also be done as part of a tags
7153 search (@pxref{Tag searches}).
7156 Remote editing of TODO items means that you can change the state of a
7157 TODO entry with a single key press. The commands available in the
7158 TODO list are described in @ref{Agenda commands}.
7160 @cindex sublevels, inclusion into TODO list
7161 Normally the global TODO list simply shows all headlines with TODO
7162 keywords. This list can become very long. There are two ways to keep
7166 @vindex org-agenda-todo-ignore-scheduled
7167 @vindex org-agenda-todo-ignore-deadlines
7168 @vindex org-agenda-todo-ignore-timestamp
7169 @vindex org-agenda-todo-ignore-with-date
7170 Some people view a TODO item that has been @emph{scheduled} for execution or
7171 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7172 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7173 @code{org-agenda-todo-ignore-deadlines},
7174 @code{org-agenda-todo-ignore-timestamp} and/or
7175 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7178 @vindex org-agenda-todo-list-sublevels
7179 TODO items may have sublevels to break up the task into subtasks. In
7180 such cases it may be enough to list only the highest level TODO headline
7181 and omit the sublevels from the global list. Configure the variable
7182 @code{org-agenda-todo-list-sublevels} to get this behavior.
7185 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7186 @subsection Matching tags and properties
7187 @cindex matching, of tags
7188 @cindex matching, of properties
7192 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7193 or have properties (@pxref{Properties and Columns}), you can select headlines
7194 based on this metadata and collect them into an agenda buffer. The match
7195 syntax described here also applies when creating sparse trees with @kbd{C-c /
7199 @orgcmd{C-c a m,org-tags-view}
7200 Produce a list of all headlines that match a given set of tags. The
7201 command prompts for a selection criterion, which is a boolean logic
7202 expression with tags, like @samp{+work+urgent-withboss} or
7203 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7204 define a custom command for it (@pxref{Agenda dispatcher}).
7205 @orgcmd{C-c a M,org-tags-view}
7206 @vindex org-tags-match-list-sublevels
7207 @vindex org-agenda-tags-todo-honor-ignore-options
7208 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7209 not-DONE state and force checking subitems (see variable
7210 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7211 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7212 specific TODO keywords together with a tags match is also possible, see
7216 The commands available in the tags list are described in @ref{Agenda
7219 @subsubheading Match syntax
7221 @cindex Boolean logic, for tag/property searches
7222 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7223 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7224 not implemented. Each element in the search is either a tag, a regular
7225 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7226 VALUE} with a comparison operator, accessing a property value. Each element
7227 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7228 sugar for positive selection. The AND operator @samp{&} is optional when
7229 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7233 Select headlines tagged @samp{:work:}, but discard those also tagged
7236 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7237 @item work|laptop+night
7238 Like before, but require the @samp{:laptop:} lines to be tagged also
7242 @cindex regular expressions, with tags search
7243 Instead of a tag, you may also specify a regular expression enclosed in curly
7244 braces. For example,
7245 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7246 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7248 @cindex TODO keyword matching, with tags search
7249 @cindex level, require for tags/property match
7250 @cindex category, require for tags/property match
7251 @vindex org-odd-levels-only
7252 You may also test for properties (@pxref{Properties and Columns}) at the same
7253 time as matching tags. The properties may be real properties, or special
7254 properties that represent other metadata (@pxref{Special properties}). For
7255 example, the ``property'' @code{TODO} represents the TODO keyword of the
7256 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7257 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7258 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7259 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7260 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7262 Here are more examples:
7264 @item work+TODO="WAITING"
7265 Select @samp{:work:}-tagged TODO lines with the specific TODO
7266 keyword @samp{WAITING}.
7267 @item work+TODO="WAITING"|home+TODO="WAITING"
7268 Waiting tasks both at work and at home.
7271 When matching properties, a number of different operators can be used to test
7272 the value of a property. Here is a complex example:
7275 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7276 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7280 The type of comparison will depend on how the comparison value is written:
7283 If the comparison value is a plain number, a numerical comparison is done,
7284 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7285 @samp{>=}, and @samp{<>}.
7287 If the comparison value is enclosed in double-quotes,
7288 a string comparison is done, and the same operators are allowed.
7290 If the comparison value is enclosed in double-quotes @emph{and} angular
7291 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7292 assumed to be date/time specifications in the standard Org way, and the
7293 comparison will be done accordingly. Special values that will be recognized
7294 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7295 @code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time
7296 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7297 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7298 respectively, can be used.
7300 If the comparison value is enclosed
7301 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7302 regexp matches the property value, and @samp{<>} meaning that it does not
7306 So the search string in the example finds entries tagged @samp{:work:} but
7307 not @samp{:boss:}, which also have a priority value @samp{A}, a
7308 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7309 property that is numerically smaller than 2, a @samp{:With:} property that is
7310 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7311 on or after October 11, 2008.
7313 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7314 other properties will slow down the search. However, once you have paid the
7315 price by accessing one property, testing additional properties is cheap
7318 You can configure Org-mode to use property inheritance during a search, but
7319 beware that this can slow down searches considerably. See @ref{Property
7320 inheritance}, for details.
7322 For backward compatibility, and also for typing speed, there is also a
7323 different way to test TODO states in a search. For this, terminate the
7324 tags/property part of the search string (which may include several terms
7325 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7326 expression just for TODO keywords. The syntax is then similar to that for
7327 tags, but should be applied with care: for example, a positive selection on
7328 several TODO keywords cannot meaningfully be combined with boolean AND.
7329 However, @emph{negative selection} combined with AND can be meaningful. To
7330 make sure that only lines are checked that actually have any TODO keyword
7331 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7332 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7333 not match TODO keywords in a DONE state. Examples:
7337 Same as @samp{work+TODO="WAITING"}
7338 @item work/!-WAITING-NEXT
7339 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7341 @item work/!+WAITING|+NEXT
7342 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7346 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7347 @subsection Timeline for a single file
7348 @cindex timeline, single file
7349 @cindex time-sorted view
7351 The timeline summarizes all time-stamped items from a single Org-mode
7352 file in a @emph{time-sorted view}. The main purpose of this command is
7353 to give an overview over events in a project.
7356 @orgcmd{C-c a L,org-timeline}
7357 Show a time-sorted view of the Org file, with all time-stamped items.
7358 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7359 (scheduled or not) are also listed under the current date.
7363 The commands available in the timeline buffer are listed in
7364 @ref{Agenda commands}.
7366 @node Search view, Stuck projects, Timeline, Built-in agenda views
7367 @subsection Search view
7370 @cindex searching, for text
7372 This agenda view is a general text search facility for Org-mode entries.
7373 It is particularly useful to find notes.
7376 @orgcmd{C-c a s,org-search-view}
7377 This is a special search that lets you select entries by matching a substring
7378 or specific words using a boolean logic.
7380 For example, the search string @samp{computer equipment} will find entries
7381 that contain @samp{computer equipment} as a substring. If the two words are
7382 separated by more space or a line break, the search will still match.
7383 Search view can also search for specific keywords in the entry, using Boolean
7384 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7385 will search for note entries that contain the keywords @code{computer}
7386 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7387 not matched by the regular expression @code{8\.11[bg]}, meaning to
7388 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7389 word search, other @samp{+} characters are optional. For more details, see
7390 the docstring of the command @code{org-search-view}.
7392 @vindex org-agenda-text-search-extra-files
7393 Note that in addition to the agenda files, this command will also search
7394 the files listed in @code{org-agenda-text-search-extra-files}.
7396 @node Stuck projects, , Search view, Built-in agenda views
7397 @subsection Stuck projects
7399 If you are following a system like David Allen's GTD to organize your
7400 work, one of the ``duties'' you have is a regular review to make sure
7401 that all projects move along. A @emph{stuck} project is a project that
7402 has no defined next actions, so it will never show up in the TODO lists
7403 Org-mode produces. During the review, you need to identify such
7404 projects and define next actions for them.
7407 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7408 List projects that are stuck.
7411 @vindex org-stuck-projects
7412 Customize the variable @code{org-stuck-projects} to define what a stuck
7413 project is and how to find it.
7416 You almost certainly will have to configure this view before it will
7417 work for you. The built-in default assumes that all your projects are
7418 level-2 headlines, and that a project is not stuck if it has at least
7419 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7421 Let's assume that you, in your own way of using Org-mode, identify
7422 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7423 indicate a project that should not be considered yet. Let's further
7424 assume that the TODO keyword DONE marks finished projects, and that NEXT
7425 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7426 is a next action even without the NEXT tag. Finally, if the project
7427 contains the special word IGNORE anywhere, it should not be listed
7428 either. In this case you would start by identifying eligible projects
7429 with a tags/todo match@footnote{@xref{Tag searches}.}
7430 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7431 IGNORE in the subtree to identify projects that are not stuck. The
7432 correct customization for this is
7435 (setq org-stuck-projects
7436 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7440 Note that if a project is identified as non-stuck, the subtree of this entry
7441 will still be searched for stuck projects.
7443 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7444 @section Presentation and sorting
7445 @cindex presentation, of agenda items
7447 @vindex org-agenda-prefix-format
7448 Before displaying items in an agenda view, Org-mode visually prepares
7449 the items and sorts them. Each item occupies a single line. The line
7450 starts with a @emph{prefix} that contains the @emph{category}
7451 (@pxref{Categories}) of the item and other important information. You can
7452 customize the prefix using the option @code{org-agenda-prefix-format}.
7453 The prefix is followed by a cleaned-up version of the outline headline
7454 associated with the item.
7457 * Categories:: Not all tasks are equal
7458 * Time-of-day specifications:: How the agenda knows the time
7459 * Sorting of agenda items:: The order of things
7462 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7463 @subsection Categories
7467 The category is a broad label assigned to each agenda item. By default,
7468 the category is simply derived from the file name, but you can also
7469 specify it with a special line in the buffer, like this@footnote{For
7470 backward compatibility, the following also works: if there are several
7471 such lines in a file, each specifies the category for the text below it.
7472 The first category also applies to any text before the first CATEGORY
7473 line. However, using this method is @emph{strongly} deprecated as it is
7474 incompatible with the outline structure of the document. The correct
7475 method for setting multiple categories in a buffer is using a
7483 @cindex property, CATEGORY
7484 If you would like to have a special CATEGORY for a single entry or a
7485 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7486 special category you want to apply as the value.
7489 The display in the agenda buffer looks best if the category is not
7490 longer than 10 characters.
7493 You can set up icons for category by customizing the
7494 @code{org-agenda-category-icon-alist} variable.
7496 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7497 @subsection Time-of-day specifications
7498 @cindex time-of-day specification
7500 Org-mode checks each agenda item for a time-of-day specification. The
7501 time can be part of the timestamp that triggered inclusion into the
7502 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7503 ranges can be specified with two timestamps, like
7505 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7507 In the headline of the entry itself, a time(range) may also appear as
7508 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7509 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7510 specifications in diary entries are recognized as well.
7512 For agenda display, Org-mode extracts the time and displays it in a
7513 standard 24 hour format as part of the prefix. The example times in
7514 the previous paragraphs would end up in the agenda like this:
7517 8:30-13:00 Arthur Dent lies in front of the bulldozer
7518 12:45...... Ford Prefect arrives and takes Arthur to the pub
7519 19:00...... The Vogon reads his poem
7520 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7524 If the agenda is in single-day mode, or for the display of today, the
7525 timed entries are embedded in a time grid, like
7528 8:00...... ------------------
7529 8:30-13:00 Arthur Dent lies in front of the bulldozer
7530 10:00...... ------------------
7531 12:00...... ------------------
7532 12:45...... Ford Prefect arrives and takes Arthur to the pub
7533 14:00...... ------------------
7534 16:00...... ------------------
7535 18:00...... ------------------
7536 19:00...... The Vogon reads his poem
7537 20:00...... ------------------
7538 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7541 @vindex org-agenda-use-time-grid
7542 @vindex org-agenda-time-grid
7543 The time grid can be turned on and off with the variable
7544 @code{org-agenda-use-time-grid}, and can be configured with
7545 @code{org-agenda-time-grid}.
7547 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7548 @subsection Sorting of agenda items
7549 @cindex sorting, of agenda items
7550 @cindex priorities, of agenda items
7551 Before being inserted into a view, the items are sorted. How this is
7552 done depends on the type of view.
7555 @vindex org-agenda-files
7556 For the daily/weekly agenda, the items for each day are sorted. The
7557 default order is to first collect all items containing an explicit
7558 time-of-day specification. These entries will be shown at the beginning
7559 of the list, as a @emph{schedule} for the day. After that, items remain
7560 grouped in categories, in the sequence given by @code{org-agenda-files}.
7561 Within each category, items are sorted by priority (@pxref{Priorities}),
7562 which is composed of the base priority (2000 for priority @samp{A}, 1000
7563 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7564 overdue scheduled or deadline items.
7566 For the TODO list, items remain in the order of categories, but within
7567 each category, sorting takes place according to priority
7568 (@pxref{Priorities}). The priority used for sorting derives from the
7569 priority cookie, with additions depending on how close an item is to its due
7572 For tags matches, items are not sorted at all, but just appear in the
7573 sequence in which they are found in the agenda files.
7576 @vindex org-agenda-sorting-strategy
7577 Sorting can be customized using the variable
7578 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7579 the estimated effort of an entry (@pxref{Effort estimates}).
7581 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7582 @section Commands in the agenda buffer
7583 @cindex commands, in agenda buffer
7585 Entries in the agenda buffer are linked back to the Org file or diary
7586 file where they originate. You are not allowed to edit the agenda
7587 buffer itself, but commands are provided to show and jump to the
7588 original entry location, and to edit the Org files ``remotely'' from
7589 the agenda buffer. In this way, all information is stored only once,
7590 removing the risk that your agenda and note files may diverge.
7592 Some commands can be executed with mouse clicks on agenda lines. For
7593 the other commands, the cursor needs to be in the desired line.
7596 @tsubheading{Motion}
7597 @cindex motion commands in agenda
7598 @orgcmd{n,org-agenda-next-line}
7599 Next line (same as @key{up} and @kbd{C-p}).
7600 @orgcmd{p,org-agenda-previous-line}
7601 Previous line (same as @key{down} and @kbd{C-n}).
7602 @tsubheading{View/Go to Org file}
7603 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
7604 Display the original location of the item in another window.
7605 With prefix arg, make sure that the entire entry is made visible in the
7606 outline, not only the heading.
7608 @orgcmd{L,org-agenda-recenter}
7609 Display original location and recenter that window.
7611 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
7612 Go to the original location of the item in another window.
7614 @orgcmd{@key{RET},org-agenda-switch-to}
7615 Go to the original location of the item and delete other windows.
7617 @orgcmd{F,org-agenda-follow-mode}
7618 @vindex org-agenda-start-with-follow-mode
7619 Toggle Follow mode. In Follow mode, as you move the cursor through
7620 the agenda buffer, the other window always shows the corresponding
7621 location in the Org file. The initial setting for this mode in new
7622 agenda buffers can be set with the variable
7623 @code{org-agenda-start-with-follow-mode}.
7625 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
7626 Display the entire subtree of the current item in an indirect buffer. With a
7627 numeric prefix argument N, go up to level N and then take that tree. If N is
7628 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
7629 previously used indirect buffer.
7631 @orgcmd{C-c C-o,org-agenda-open-link}
7632 Follow a link in the entry. This will offer a selection of any links in the
7633 text belonging to the referenced Org node. If there is only one link, it
7634 will be followed without a selection prompt.
7636 @tsubheading{Change display}
7637 @cindex display changing, in agenda
7640 Delete other windows.
7642 @orgcmdkskc{v d,d,org-aganda-day-view}
7643 @xorgcmdkskc{v w,w,org-aganda-day-view}
7644 @xorgcmd{v m,org-agenda-month-view}
7645 @xorgcmd{v y,org-agenda-month-year}
7646 Switch to day/week/month/year view. When switching to day or week view,
7647 this setting becomes the default for subsequent agenda commands. Since
7648 month and year views are slow to create, they do not become the default.
7649 A numeric prefix argument may be used to jump directly to a specific day
7650 of the year, ISO week, month, or year, respectively. For example,
7651 @kbd{32 d} jumps to February 1st, @kbd{9 w} to ISO week number 9. When
7652 setting day, week, or month view, a year may be encoded in the prefix
7653 argument as well. For example, @kbd{200712 w} will jump to week 12 in
7654 2007. If such a year specification has only one or two digits, it will
7655 be mapped to the interval 1938-2037.
7657 @orgcmd{f,org-agenda-later}
7658 Go forward in time to display the following @code{org-agenda-current-span} days.
7659 For example, if the display covers a week, switch to the following week.
7660 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
7662 @orgcmd{b,org-agenda-earlier}
7663 Go backward in time to display earlier dates.
7665 @orgcmd{.,org-agenda-goto-today}
7668 @orgcmd{j,org-agenda-goto-date}
7669 Prompt for a date and go there.
7671 @orgcmd{J,org-agenda-clock-goto}
7672 Go to the currently clocked-in task @i{in the agenda buffer}.
7674 @orgcmd{D,org-agenda-toggle-diary}
7675 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7677 @orgcmdkskc{v l,l,org-agenda-log-mode}
7679 @vindex org-log-done
7680 @vindex org-agenda-log-mode-items
7681 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7682 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7683 entries that have been clocked on that day. You can configure the entry
7684 types that should be included in log mode using the variable
7685 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7686 all possible logbook entries, including state changes. When called with two
7687 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7688 @kbd{v L} is equivalent to @kbd{C-u v l}.
7690 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
7691 Include inactive timestamps into the current view. Only for weekly/daily
7692 agenda and timeline views.
7694 @orgcmd{v a,org-agenda-archives-mode}
7695 @xorgcmd{v A,org-agenda-archives-mode 'files}
7696 Toggle Archives mode. In Archives mode, trees that are marked
7697 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7698 capital @kbd{A}, even all archive files are included. To exit archives mode,
7699 press @kbd{v a} again.
7701 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
7702 @vindex org-agenda-start-with-clockreport-mode
7703 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7704 always show a table with the clocked times for the timespan and file scope
7705 covered by the current agenda view. The initial setting for this mode in new
7706 agenda buffers can be set with the variable
7707 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
7708 when toggling this mode (i.e. @kbd{C-u R}), the clock table will not show
7709 contributions from entries that are hidden by agenda filtering@footnote{Only
7710 tags filtering will be respected here, effort filtering is ignored.}.
7712 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
7713 @vindex org-agenda-start-with-entry-text-mode
7714 @vindex org-agenda-entry-text-maxlines
7715 Toggle entry text mode. In entry text mode, a number of lines from the Org
7716 outline node referenced by an agenda line will be displayed below the line.
7717 The maximum number of lines is given by the variable
7718 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
7719 prefix argument will temporarily modify that number to the prefix value.
7721 @orgcmd{G,org-agenda-toggle-time-grid}
7722 @vindex org-agenda-use-time-grid
7723 @vindex org-agenda-time-grid
7724 Toggle the time grid on and off. See also the variables
7725 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
7727 @orgcmd{r,org-agenda-rodo}
7728 Recreate the agenda buffer, for example to reflect the changes after
7729 modification of the timestamps of items with @kbd{S-@key{left}} and
7730 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
7731 argument is interpreted to create a selective list for a specific TODO
7733 @orgcmd{g,org-agenda-rodo}
7736 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
7737 Save all Org buffers in the current Emacs session, and also the locations of
7740 @orgcmd{C-c C-x C-c,org-agenda-columns}
7741 @vindex org-columns-default-format
7742 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
7743 view format is taken from the entry at point, or (if there is no entry at
7744 point), from the first entry in the agenda view. So whatever the format for
7745 that entry would be in the original buffer (taken from a property, from a
7746 @code{#+COLUMNS} line, or from the default variable
7747 @code{org-columns-default-format}), will be used in the agenda.
7749 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7750 Remove the restriction lock on the agenda, if it is currently restricted to a
7751 file or subtree (@pxref{Agenda files}).
7753 @tsubheading{Secondary filtering and query editing}
7754 @cindex filtering, by tag and effort, in agenda
7755 @cindex tag filtering, in agenda
7756 @cindex effort filtering, in agenda
7757 @cindex query editing, in agenda
7759 @orgcmd{/,org-agenda-filter-by-tag}
7760 @vindex org-agenda-filter-preset
7761 Filter the current agenda view with respect to a tag and/or effort estimates.
7762 The difference between this and a custom agenda command is that filtering is
7763 very fast, so that you can switch quickly between different filters without
7764 having to recreate the agenda.@footnote{Custom commands can preset a filter by
7765 binding the variable @code{org-agenda-filter-preset} as an option. This
7766 filter will then be applied to the view and persist as a basic filter through
7767 refreshes and more secondary filtering. The filter is a global property of
7768 the entire agenda view---in a block agenda, you should only set this in the
7769 global options section, not in the section of an individual block.}
7771 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
7772 all. Pressing @key{TAB} at that prompt will offer use completion to select a
7773 tag (including any tags that do not have a selection character). The command
7774 then hides all entries that do not contain or inherit this tag. When called
7775 with prefix arg, remove the entries that @emph{do} have the tag. A second
7776 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
7777 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
7778 will be narrowed by requiring or forbidding the selected additional tag.
7779 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
7780 immediately use the @kbd{\} command.
7782 @vindex org-sort-agenda-noeffort-is-high
7783 In order to filter for effort estimates, you should set up allowed
7784 efforts globally, for example
7786 (setq org-global-properties
7787 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
7789 You can then filter for an effort by first typing an operator, one of
7790 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
7791 estimate in your array of allowed values, where @kbd{0} means the 10th value.
7792 The filter will then restrict to entries with effort smaller-or-equal, equal,
7793 or larger-or-equal than the selected value. If the digits 0-9 are not used
7794 as fast access keys to tags, you can also simply press the index digit
7795 directly without an operator. In this case, @kbd{<} will be assumed. For
7796 application of the operator, entries without a defined effort will be treated
7797 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
7798 for tasks without effort definition, press @kbd{?} as the operator.
7800 Org also supports automatic, context-aware tag filtering. If the variable
7801 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
7802 that function can decide which tags should be excluded from the agenda
7803 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
7804 as a sub-option key and runs the auto exclusion logic. For example, let's
7805 say you use a @code{Net} tag to identify tasks which need network access, an
7806 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
7807 calls. You could auto-exclude these tags based on the availability of the
7808 Internet, and outside of business hours, with something like this:
7812 (defun org-my-auto-exclude-function (tag)
7814 ((string= tag "Net")
7815 (/= 0 (call-process "/sbin/ping" nil nil nil
7816 "-c1" "-q" "-t1" "mail.gnu.org")))
7817 ((or (string= tag "Errand") (string= tag "Call"))
7818 (let ((hour (nth 2 (decode-time))))
7819 (or (< hour 8) (> hour 21)))))
7822 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
7826 @orgcmd{\,org-agenda-filter-by-tag-refine}
7827 Narrow the current agenda filter by an additional condition. When called with
7828 prefix arg, remove the entries that @emph{do} have the tag, or that do match
7829 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
7830 @kbd{-} as the first key after the @kbd{/} command.
7839 @item @r{in} search view
7840 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
7841 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
7842 add a positive search term prefixed by @samp{+}, indicating that this search
7843 term @i{must} occur/match in the entry. The closing bracket/brace will add a
7844 negative search term which @i{must not} occur/match in the entry for it to be
7848 @tsubheading{Remote editing}
7849 @cindex remote editing, from agenda
7854 @cindex undoing remote-editing events
7855 @cindex remote editing, undo
7856 @orgcmd{C-_,org-agenda-undo}
7857 Undo a change due to a remote editing command. The change is undone
7858 both in the agenda buffer and in the remote buffer.
7860 @orgcmd{t,org-agenda-todo}
7861 Change the TODO state of the item, both in the agenda and in the
7864 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
7865 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
7866 Switch to the next/previous set of TODO keywords.
7868 @orgcmd{C-k,org-agenda-kill}
7869 @vindex org-agenda-confirm-kill
7870 Delete the current agenda item along with the entire subtree belonging
7871 to it in the original Org file. If the text to be deleted remotely
7872 is longer than one line, the kill needs to be confirmed by the user. See
7873 variable @code{org-agenda-confirm-kill}.
7875 @orgcmd{C-c C-w,org-agenda-refile}
7876 Refile the entry at point.
7878 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
7879 @vindex org-archive-default-command
7880 Archive the subtree corresponding to the entry at point using the default
7881 archiving command set in @code{org-archive-default-command}. When using the
7882 @code{a} key, confirmation will be required.
7884 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
7885 Toggle the ARCHIVE tag for the current headline.
7887 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
7888 Move the subtree corresponding to the current entry to its @emph{archive
7891 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
7892 Archive the subtree corresponding to the current headline. This means the
7893 entry will be moved to the configured archive location, most likely a
7896 @orgcmd{T,org-agenda-show-tags}
7897 @vindex org-agenda-show-inherited-tags
7898 Show all tags associated with the current item. This is useful if you have
7899 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
7900 tags of a headline occasionally.
7902 @orgcmd{:,org-agenda-set-tags}
7903 Set tags for the current headline. If there is an active region in the
7904 agenda, change a tag for all headings in the region.
7908 Set the priority for the current item (@command{org-agenda-priority}).
7909 Org-mode prompts for the priority character. If you reply with @key{SPC}, the
7910 priority cookie is removed from the entry.
7912 @orgcmd{P,org-agenda-show-priority}
7913 Display weighted priority of current item.
7915 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
7916 Increase the priority of the current item. The priority is changed in
7917 the original buffer, but the agenda is not resorted. Use the @kbd{r}
7920 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
7921 Decrease the priority of the current item.
7923 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
7924 @vindex org-log-into-drawer
7925 Add a note to the entry. This note will be recorded, and then filed to the
7926 same location where state change notes are put. Depending on
7927 @code{org-log-into-drawer}, this may be inside a drawer.
7929 @orgcmd{C-c C-a,org-attach}
7930 Dispatcher for all command related to attachments.
7932 @orgcmd{C-c C-s,org-agenda-schedule}
7933 Schedule this item. With prefix arg remove the scheduling timestamp
7935 @orgcmd{C-c C-d,org-agenda-deadline}
7936 Set a deadline for this item. With prefix arg remove the deadline.
7938 @orgcmd{k,org-agenda-action}
7939 Agenda actions, to set dates for selected items to the cursor date.
7940 This command also works in the calendar! The command prompts for an
7943 m @r{Mark the entry at point for action. You can also make entries}
7944 @r{in Org files with @kbd{C-c C-x C-k}.}
7945 d @r{Set the deadline of the marked entry to the date at point.}
7946 s @r{Schedule the marked entry at the date at point.}
7947 r @r{Call @code{org-capture} with the cursor date as default date.}
7950 Press @kbd{r} afterward to refresh the agenda and see the effect of the
7953 @orgcmd{S-@key{right},org-agenda-do-date-later}
7954 Change the timestamp associated with the current line by one day into the
7955 future. With a numeric prefix argument, change it by that many days. For
7956 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
7957 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
7958 command, it will continue to change hours even without the prefix arg. With
7959 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
7960 is changed in the original Org file, but the change is not directly reflected
7961 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
7963 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
7964 Change the timestamp associated with the current line by one day
7967 @orgcmd{>,org-agenda-date-prompt}
7968 Change the timestamp associated with the current line. The key @kbd{>} has
7969 been chosen, because it is the same as @kbd{S-.} on my keyboard.
7971 @orgcmd{I,org-agenda-clock-in}
7972 Start the clock on the current item. If a clock is running already, it
7975 @orgcmd{O,org-agenda-clock-out}
7976 Stop the previously started clock.
7978 @orgcmd{X,org-agenda-clock-cancel}
7979 Cancel the currently running clock.
7981 @orgcmd{J,org-agenda-clock-goto}
7982 Jump to the running clock in another window.
7984 @tsubheading{Bulk remote editing selected entries}
7985 @cindex remote editing, bulk, from agenda
7987 @orgcmd{m,org-agenda-bulk-mark}
7988 Mark the entry at point for bulk action. With prefix arg, mark that many
7991 @orgcmd{u,org-agenda-bulk-unmark}
7992 Unmark entry for bulk action.
7994 @orgcmd{U,org-agenda-bulk-remove-all-marks}
7995 Unmark all marked entries for bulk action.
7997 @orgcmd{B,org-agenda-bulk-action}
7998 Bulk action: act on all marked entries in the agenda. This will prompt for
7999 another key to select the action to be applied. The prefix arg to @kbd{B}
8000 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8001 these special timestamps.
8003 r @r{Prompt for a single refile target and move all entries. The entries}
8004 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8005 $ @r{Archive all selected entries.}
8006 A @r{Archive entries by moving them to their respective archive siblings.}
8007 t @r{Change TODO state. This prompts for a single TODO keyword and}
8008 @r{changes the state of all selected entries, bypassing blocking and}
8009 @r{suppressing logging notes (but not time stamps).}
8010 + @r{Add a tag to all selected entries.}
8011 - @r{Remove a tag from all selected entries.}
8012 s @r{Schedule all items to a new date. To shift existing schedule dates}
8013 @r{by a fixed number of days, use something starting with double plus}
8014 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8015 S @r{Reschedule randomly by N days. N will be prompted for. With prefix}
8016 @r{arg (@kbd{C-u B S}), scatter only accross weekdays.}
8017 d @r{Set deadline to a specific date.}
8021 @tsubheading{Calendar commands}
8022 @cindex calendar commands, from agenda
8024 @orgcmd{c,org-agenda-goto-calendar}
8025 Open the Emacs calendar and move to the date at the agenda cursor.
8027 @orgcmd{c,org-calendar-goto-agenda}
8028 When in the calendar, compute and show the Org-mode agenda for the
8031 @cindex diary entries, creating from agenda
8032 @orgcmd{i,org-agenda-diary-entry}
8033 @vindex org-agenda-diary-file
8034 Insert a new entry into the diary, using the date at the cursor and (for
8035 block entries) the date at the mark. This will add to the Emacs diary
8036 file@footnote{This file is parsed for the agenda when
8037 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8038 command in the calendar. The diary file will pop up in another window, where
8039 you can add the entry.
8041 If you configure @code{org-agenda-diary-file} to point to an Org-mode file,
8042 Org will create entries (in org-mode syntax) in that file instead. Most
8043 entries will be stored in a date-based outline tree that will later make it
8044 easy to archive appointments from previous months/years. The tree will be
8045 built under an entry with a @code{DATE_TREE} property, or else with years as
8046 top-level entries. Emacs will prompt you for the entry text---if you specify
8047 it, the entry will be created in @code{org-agenda-diary-file} without further
8048 interaction. If you directly press @key{RET} at the prompt without typing
8049 text, the target file will be shown in another window for you to finish the
8050 entry there. See also the @kbd{k r} command.
8052 @orgcmd{M,org-agenda-phases-of-moon}
8053 Show the phases of the moon for the three months around current date.
8055 @orgcmd{S,org-agenda-sunrise-sunset}
8056 Show sunrise and sunset times. The geographical location must be set
8057 with calendar variables, see the documentation for the Emacs calendar.
8059 @orgcmd{C,org-agenda-convert-date}
8060 Convert the date at cursor into many other cultural and historic
8063 @orgcmd{H,org-agenda-holidays}
8064 Show holidays for three months around the cursor date.
8066 @item M-x org-export-icalendar-combine-agenda-files
8067 Export a single iCalendar file containing entries from all agenda files.
8068 This is a globally available command, and also available in the agenda menu.
8070 @tsubheading{Exporting to a file}
8071 @orgcmd{C-x C-w,org-write-agenda}
8072 @cindex exporting agenda views
8073 @cindex agenda views, exporting
8074 @vindex org-agenda-exporter-settings
8075 Write the agenda view to a file. Depending on the extension of the selected
8076 file name, the view will be exported as HTML (extension @file{.html} or
8077 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8078 and plain text (any other extension). When called with a @kbd{C-u} prefix
8079 argument, immediately open the newly created file. Use the variable
8080 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8081 for @file{htmlize} to be used during export.
8083 @tsubheading{Quit and Exit}
8084 @orgcmd{q,org-agenda-quit}
8085 Quit agenda, remove the agenda buffer.
8087 @cindex agenda files, removing buffers
8088 @orgcmd{x,org-agenda-exit}
8089 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8090 for the compilation of the agenda. Buffers created by the user to
8091 visit Org files will not be removed.
8095 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8096 @section Custom agenda views
8097 @cindex custom agenda views
8098 @cindex agenda views, custom
8100 Custom agenda commands serve two purposes: to store and quickly access
8101 frequently used TODO and tags searches, and to create special composite
8102 agenda buffers. Custom agenda commands will be accessible through the
8103 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8106 * Storing searches:: Type once, use often
8107 * Block agenda:: All the stuff you need in a single buffer
8108 * Setting Options:: Changing the rules
8111 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8112 @subsection Storing searches
8114 The first application of custom searches is the definition of keyboard
8115 shortcuts for frequently used searches, either creating an agenda
8116 buffer, or a sparse tree (the latter covering of course only the current
8119 @vindex org-agenda-custom-commands
8120 Custom commands are configured in the variable
8121 @code{org-agenda-custom-commands}. You can customize this variable, for
8122 example by pressing @kbd{C-c a C}. You can also directly set it with
8123 Emacs Lisp in @file{.emacs}. The following example contains all valid
8128 (setq org-agenda-custom-commands
8129 '(("w" todo "WAITING")
8130 ("W" todo-tree "WAITING")
8131 ("u" tags "+boss-urgent")
8132 ("v" tags-todo "+boss-urgent")
8133 ("U" tags-tree "+boss-urgent")
8134 ("f" occur-tree "\\<FIXME\\>")
8135 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8136 ("hl" tags "+home+Lisa")
8137 ("hp" tags "+home+Peter")
8138 ("hk" tags "+home+Kim")))
8143 The initial string in each entry defines the keys you have to press
8144 after the dispatcher command @kbd{C-c a} in order to access the command.
8145 Usually this will be just a single character, but if you have many
8146 similar commands, you can also define two-letter combinations where the
8147 first character is the same in several combinations and serves as a
8148 prefix key@footnote{You can provide a description for a prefix key by
8149 inserting a cons cell with the prefix and the description.}. The second
8150 parameter is the search type, followed by the string or regular
8151 expression to be used for the matching. The example above will
8156 as a global search for TODO entries with @samp{WAITING} as the TODO
8159 as the same search, but only in the current buffer and displaying the
8160 results as a sparse tree
8162 as a global tags search for headlines marked @samp{:boss:} but not
8165 as the same search as @kbd{C-c a u}, but limiting the search to
8166 headlines that are also TODO items
8168 as the same search as @kbd{C-c a u}, but only in the current buffer and
8169 displaying the result as a sparse tree
8171 to create a sparse tree (again: current buffer only) with all entries
8172 containing the word @samp{FIXME}
8174 as a prefix command for a HOME tags search where you have to press an
8175 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8176 Peter, or Kim) as additional tag to match.
8179 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8180 @subsection Block agenda
8181 @cindex block agenda
8182 @cindex agenda, with block views
8184 Another possibility is the construction of agenda views that comprise
8185 the results of @emph{several} commands, each of which creates a block in
8186 the agenda buffer. The available commands include @code{agenda} for the
8187 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8188 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8189 matching commands discussed above: @code{todo}, @code{tags}, and
8190 @code{tags-todo}. Here are two examples:
8194 (setq org-agenda-custom-commands
8195 '(("h" "Agenda and Home-related tasks"
8199 ("o" "Agenda and Office-related tasks"
8207 This will define @kbd{C-c a h} to create a multi-block view for stuff
8208 you need to attend to at home. The resulting agenda buffer will contain
8209 your agenda for the current week, all TODO items that carry the tag
8210 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8211 command @kbd{C-c a o} provides a similar view for office tasks.
8213 @node Setting Options, , Block agenda, Custom agenda views
8214 @subsection Setting options for custom commands
8215 @cindex options, for custom agenda views
8217 @vindex org-agenda-custom-commands
8218 Org-mode contains a number of variables regulating agenda construction
8219 and display. The global variables define the behavior for all agenda
8220 commands, including the custom commands. However, if you want to change
8221 some settings just for a single custom view, you can do so. Setting
8222 options requires inserting a list of variable names and values at the
8223 right spot in @code{org-agenda-custom-commands}. For example:
8227 (setq org-agenda-custom-commands
8228 '(("w" todo "WAITING"
8229 ((org-agenda-sorting-strategy '(priority-down))
8230 (org-agenda-prefix-format " Mixed: ")))
8231 ("U" tags-tree "+boss-urgent"
8232 ((org-show-following-heading nil)
8233 (org-show-hierarchy-above nil)))
8235 ((org-agenda-files '("~org/notes.org"))
8236 (org-agenda-text-search-extra-files nil)))))
8241 Now the @kbd{C-c a w} command will sort the collected entries only by
8242 priority, and the prefix format is modified to just say @samp{ Mixed: }
8243 instead of giving the category of the entry. The sparse tags tree of
8244 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8245 headline hierarchy above the match, nor the headline following the match
8246 will be shown. The command @kbd{C-c a N} will do a text search limited
8247 to only a single file.
8249 @vindex org-agenda-custom-commands
8250 For command sets creating a block agenda,
8251 @code{org-agenda-custom-commands} has two separate spots for setting
8252 options. You can add options that should be valid for just a single
8253 command in the set, and options that should be valid for all commands in
8254 the set. The former are just added to the command entry; the latter
8255 must come after the list of command entries. Going back to the block
8256 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8257 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8258 the results for GARDEN tags query in the opposite order,
8259 @code{priority-up}. This would look like this:
8263 (setq org-agenda-custom-commands
8264 '(("h" "Agenda and Home-related tasks"
8268 ((org-agenda-sorting-strategy '(priority-up)))))
8269 ((org-agenda-sorting-strategy '(priority-down))))
8270 ("o" "Agenda and Office-related tasks"
8277 As you see, the values and parentheses setting is a little complex.
8278 When in doubt, use the customize interface to set this variable---it
8279 fully supports its structure. Just one caveat: when setting options in
8280 this interface, the @emph{values} are just Lisp expressions. So if the
8281 value is a string, you need to add the double-quotes around the value
8285 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8286 @section Exporting Agenda Views
8287 @cindex agenda views, exporting
8289 If you are away from your computer, it can be very useful to have a printed
8290 version of some agenda views to carry around. Org-mode can export custom
8291 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8292 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8293 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8294 a PDF file with also create the postscript file.}, and iCalendar files. If
8295 you want to do this only occasionally, use the command
8298 @orgcmd{C-x C-w,org-write-agenda}
8299 @cindex exporting agenda views
8300 @cindex agenda views, exporting
8301 @vindex org-agenda-exporter-settings
8302 Write the agenda view to a file. Depending on the extension of the selected
8303 file name, the view will be exported as HTML (extension @file{.html} or
8304 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8305 @file{.ics}), or plain text (any other extension). Use the variable
8306 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8307 for @file{htmlize} to be used during export, for example
8309 @vindex org-agenda-add-entry-text-maxlines
8310 @vindex htmlize-output-type
8311 @vindex ps-number-of-columns
8312 @vindex ps-landscape-mode
8314 (setq org-agenda-exporter-settings
8315 '((ps-number-of-columns 2)
8316 (ps-landscape-mode t)
8317 (org-agenda-add-entry-text-maxlines 5)
8318 (htmlize-output-type 'css)))
8322 If you need to export certain agenda views frequently, you can associate
8323 any custom agenda command with a list of output file names
8324 @footnote{If you want to store standard views like the weekly agenda
8325 or the global TODO list as well, you need to define custom commands for
8326 them in order to be able to specify file names.}. Here is an example
8327 that first defines custom commands for the agenda and the global
8328 TODO list, together with a number of files to which to export them.
8329 Then we define two block agenda commands and specify file names for them
8330 as well. File names can be relative to the current working directory,
8335 (setq org-agenda-custom-commands
8336 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8337 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8338 ("h" "Agenda and Home-related tasks"
8343 ("~/views/home.html"))
8344 ("o" "Agenda and Office-related tasks"
8349 ("~/views/office.ps" "~/calendars/office.ics"))))
8353 The extension of the file name determines the type of export. If it is
8354 @file{.html}, Org-mode will use the @file{htmlize.el} package to convert
8355 the buffer to HTML and save it to this file name. If the extension is
8356 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8357 Postscript output. If the extension is @file{.ics}, iCalendar export is
8358 run export over all files that were used to construct the agenda, and
8359 limit the export to entries listed in the agenda. Any other
8360 extension produces a plain ASCII file.
8362 The export files are @emph{not} created when you use one of those
8363 commands interactively because this might use too much overhead.
8364 Instead, there is a special command to produce @emph{all} specified
8368 @orgcmd{C-c a e,org-store-agenda-views}
8369 Export all agenda views that have export file names associated with
8373 You can use the options section of the custom agenda commands to also
8374 set options for the export commands. For example:
8377 (setq org-agenda-custom-commands
8379 ((ps-number-of-columns 2)
8380 (ps-landscape-mode t)
8381 (org-agenda-prefix-format " [ ] ")
8382 (org-agenda-with-colors nil)
8383 (org-agenda-remove-tags t))
8388 This command sets two options for the Postscript exporter, to make it
8389 print in two columns in landscape format---the resulting page can be cut
8390 in two and then used in a paper agenda. The remaining settings modify
8391 the agenda prefix to omit category and scheduling information, and
8392 instead include a checkbox to check off items. We also remove the tags
8393 to make the lines compact, and we don't want to use colors for the
8394 black-and-white printer. Settings specified in
8395 @code{org-agenda-exporter-settings} will also apply, but the settings
8396 in @code{org-agenda-custom-commands} take precedence.
8399 From the command line you may also use
8401 emacs -f org-batch-store-agenda-views -kill
8404 or, if you need to modify some parameters@footnote{Quoting depends on the
8405 system you use, please check the FAQ for examples.}
8407 emacs -eval '(org-batch-store-agenda-views \
8408 org-agenda-span month \
8409 org-agenda-start-day "2007-11-01" \
8410 org-agenda-include-diary nil \
8411 org-agenda-files (quote ("~/org/project.org")))' \
8415 which will create the agenda views restricted to the file
8416 @file{~/org/project.org}, without diary entries and with a 30-day
8419 You can also extract agenda information in a way that allows further
8420 processing by other programs. See @ref{Extracting agenda information}, for
8424 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8425 @section Using column view in the agenda
8426 @cindex column view, in agenda
8427 @cindex agenda, column view
8429 Column view (@pxref{Column view}) is normally used to view and edit
8430 properties embedded in the hierarchical structure of an Org file. It can be
8431 quite useful to use column view also from the agenda, where entries are
8432 collected by certain criteria.
8435 @orgcmd{C-c C-x C-c,org-agenda-columns}
8436 Turn on column view in the agenda.
8439 To understand how to use this properly, it is important to realize that the
8440 entries in the agenda are no longer in their proper outline environment.
8441 This causes the following issues:
8445 @vindex org-columns-default-format
8446 @vindex org-overriding-columns-format
8447 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8448 entries in the agenda are collected from different files, and different files
8449 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8450 Org first checks if the variable @code{org-overriding-columns-format} is
8451 currently set, and if so, takes the format from there. Otherwise it takes
8452 the format associated with the first item in the agenda, or, if that item
8453 does not have a specific format (defined in a property, or in its file), it
8454 uses @code{org-columns-default-format}.
8456 @cindex property, special, CLOCKSUM
8457 If any of the columns has a summary type defined (@pxref{Column attributes}),
8458 turning on column view in the agenda will visit all relevant agenda files and
8459 make sure that the computations of this property are up to date. This is
8460 also true for the special @code{CLOCKSUM} property. Org will then sum the
8461 values displayed in the agenda. In the daily/weekly agenda, the sums will
8462 cover a single day; in all other views they cover the entire block. It is
8463 vital to realize that the agenda may show the same entry @emph{twice} (for
8464 example as scheduled and as a deadline), and it may show two entries from the
8465 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8466 cases, the summation in the agenda will lead to incorrect results because
8467 some values will count double.
8469 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8470 the entire clocked time for this item. So even in the daily/weekly agenda,
8471 the clocksum listed in column view may originate from times outside the
8472 current view. This has the advantage that you can compare these values with
8473 a column listing the planned total effort for a task---one of the major
8474 applications for column view in the agenda. If you want information about
8475 clocked time in the displayed period use clock table mode (press @kbd{R} in
8480 @node Markup, Exporting, Agenda Views, Top
8481 @chapter Markup for rich export
8483 When exporting Org-mode documents, the exporter tries to reflect the
8484 structure of the document as accurately as possible in the backend. Since
8485 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
8486 Org-mode has rules on how to prepare text for rich export. This section
8487 summarizes the markup rules used in an Org-mode buffer.
8490 * Structural markup elements:: The basic structure as seen by the exporter
8491 * Images and tables:: Tables and Images will be included
8492 * Literal examples:: Source code examples with special formatting
8493 * Include files:: Include additional files into a document
8494 * Index entries:: Making an index
8495 * Macro replacement:: Use macros to create complex output
8496 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
8499 @node Structural markup elements, Images and tables, Markup, Markup
8500 @section Structural markup elements
8503 * Document title:: Where the title is taken from
8504 * Headings and sections:: The document structure as seen by the exporter
8505 * Table of contents:: The if and where of the table of contents
8506 * Initial text:: Text before the first heading?
8508 * Paragraphs:: Paragraphs
8509 * Footnote markup:: Footnotes
8510 * Emphasis and monospace:: Bold, italic, etc.
8511 * Horizontal rules:: Make a line
8512 * Comment lines:: What will *not* be exported
8515 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8516 @subheading Document title
8517 @cindex document title, markup rules
8520 The title of the exported document is taken from the special line
8524 #+TITLE: This is the title of the document
8528 If this line does not exist, the title is derived from the first non-empty,
8529 non-comment line in the buffer. If no such line exists, or if you have
8530 turned off exporting of the text before the first headline (see below), the
8531 title will be the file name without extension.
8533 @cindex property, EXPORT_TITLE
8534 If you are exporting only a subtree by marking is as the region, the heading
8535 of the subtree will become the title of the document. If the subtree has a
8536 property @code{EXPORT_TITLE}, that will take precedence.
8538 @node Headings and sections, Table of contents, Document title, Structural markup elements
8539 @subheading Headings and sections
8540 @cindex headings and sections, markup rules
8542 @vindex org-export-headline-levels
8543 The outline structure of the document as described in @ref{Document
8544 Structure}, forms the basis for defining sections of the exported document.
8545 However, since the outline structure is also used for (for example) lists of
8546 tasks, only the first three outline levels will be used as headings. Deeper
8547 levels will become itemized lists. You can change the location of this
8548 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8549 per-file basis with a line
8556 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8557 @subheading Table of contents
8558 @cindex table of contents, markup rules
8560 @vindex org-export-with-toc
8561 The table of contents is normally inserted directly before the first headline
8562 of the file. If you would like to get it to a different location, insert the
8563 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8564 location. The depth of the table of contents is by default the same as the
8565 number of headline levels, but you can choose a smaller number, or turn off
8566 the table of contents entirely, by configuring the variable
8567 @code{org-export-with-toc}, or on a per-file basis with a line like
8570 #+OPTIONS: toc:2 (only to two levels in TOC)
8571 #+OPTIONS: toc:nil (no TOC at all)
8574 @node Initial text, Lists, Table of contents, Structural markup elements
8575 @subheading Text before the first headline
8576 @cindex text before first headline, markup rules
8579 Org-mode normally exports the text before the first headline, and even uses
8580 the first line as the document title. The text will be fully marked up. If
8581 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
8582 constructs described below in the sections for the individual exporters.
8584 @vindex org-export-skip-text-before-1st-heading
8585 Some people like to use the space before the first headline for setup and
8586 internal links and therefore would like to control the exported text before
8587 the first headline in a different way. You can do so by setting the variable
8588 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8589 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8592 If you still want to have some text before the first headline, use the
8593 @code{#+TEXT} construct:
8597 #+TEXT: This text will go before the *first* headline.
8598 #+TEXT: [TABLE-OF-CONTENTS]
8599 #+TEXT: This goes between the table of contents and the first headline
8602 @node Lists, Paragraphs, Initial text, Structural markup elements
8604 @cindex lists, markup rules
8606 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8607 syntax for such lists. Most backends support unordered, ordered, and
8610 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8611 @subheading Paragraphs, line breaks, and quoting
8612 @cindex paragraphs, markup rules
8614 Paragraphs are separated by at least one empty line. If you need to enforce
8615 a line break within a paragraph, use @samp{\\} at the end of a line.
8617 To keep the line breaks in a region, but otherwise use normal formatting, you
8618 can use this construct, which can also be used to format poetry.
8620 @cindex #+BEGIN_VERSE
8623 Great clouds overhead
8624 Tiny black birds rise and fall
8631 When quoting a passage from another document, it is customary to format this
8632 as a paragraph that is indented on both the left and the right margin. You
8633 can include quotations in Org-mode documents like this:
8635 @cindex #+BEGIN_QUOTE
8638 Everything should be made as simple as possible,
8639 but not any simpler -- Albert Einstein
8643 If you would like to center some text, do it like this:
8644 @cindex #+BEGIN_CENTER
8647 Everything should be made as simple as possible, \\
8653 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8654 @subheading Footnote markup
8655 @cindex footnotes, markup rules
8656 @cindex @file{footnote.el}
8658 Footnotes defined in the way described in @ref{Footnotes}, will be exported by
8659 all backends. Org allows multiple references to the same note, and
8660 different backends support this to varying degrees.
8662 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8663 @subheading Emphasis and monospace
8665 @cindex underlined text, markup rules
8666 @cindex bold text, markup rules
8667 @cindex italic text, markup rules
8668 @cindex verbatim text, markup rules
8669 @cindex code text, markup rules
8670 @cindex strike-through text, markup rules
8671 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8672 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8673 in the code and verbatim string is not processed for Org-mode specific
8674 syntax; it is exported verbatim.
8676 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8677 @subheading Horizontal rules
8678 @cindex horizontal rules, markup rules
8679 A line consisting of only dashes, and at least 5 of them, will be
8680 exported as a horizontal line (@samp{<hr/>} in HTML).
8682 @node Comment lines, , Horizontal rules, Structural markup elements
8683 @subheading Comment lines
8684 @cindex comment lines
8685 @cindex exporting, not
8686 @cindex #+BEGIN_COMMENT
8688 Lines starting with @samp{#} in column zero are treated as comments and will
8689 never be exported. If you want an indented line to be treated as a comment,
8690 start it with @samp{#+ }. Also entire subtrees starting with the word
8691 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8692 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8697 Toggle the COMMENT keyword at the beginning of an entry.
8701 @node Images and tables, Literal examples, Structural markup elements, Markup
8702 @section Images and Tables
8704 @cindex tables, markup rules
8707 Both the native Org-mode tables (@pxref{Tables}) and tables formatted with
8708 the @file{table.el} package will be exported properly. For Org-mode tables,
8709 the lines before the first horizontal separator line will become table header
8710 lines. You can use the following lines somewhere before the table to assign
8711 a caption and a label for cross references, and in the text you can refer to
8712 the object with @code{\ref@{tab:basic-data@}}:
8715 #+CAPTION: This is the caption for the next table (or link)
8716 #+LABEL: tbl:basic-data
8721 @cindex inlined images, markup rules
8722 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
8723 images into the exported document. Org does this, if a link to an image
8724 files does not have a description part, for example @code{[[./img/a.jpg]]}.
8725 If you wish to define a caption for the image and maybe a label for internal
8726 cross references, make sure that the link is on a line by itself and precede
8727 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
8730 #+CAPTION: This is the caption for the next figure link (or table)
8731 #+LABEL: fig:SED-HR4049
8735 You may also define additional attributes for the figure. As this is
8736 backend-specific, see the sections about the individual backends for more
8739 @xref{Handling links,the discussion of image links}.
8741 @node Literal examples, Include files, Images and tables, Markup
8742 @section Literal examples
8743 @cindex literal examples, markup rules
8744 @cindex code line references, markup rules
8746 You can include literal examples that should not be subjected to
8747 markup. Such examples will be typeset in monospace, so this is well suited
8748 for source code and similar examples.
8749 @cindex #+BEGIN_EXAMPLE
8753 Some example from a text file.
8757 Note that such blocks may be @i{indented} in order to align nicely with
8758 indented text and in particular with plain list structure (@pxref{Plain
8759 lists}). For simplicity when using small examples, you can also start the
8760 example lines with a colon followed by a space. There may also be additional
8761 whitespace before the colon:
8765 : Some example from a text file.
8768 @cindex formatting source code, markup rules
8769 If the example is source code from a programming language, or any other text
8770 that can be marked up by font-lock in Emacs, you can ask for the example to
8771 look like the fontified Emacs buffer@footnote{This works automatically for
8772 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
8773 which is distributed with Org). Fontified code chunks in LaTeX can be
8774 achieved using either the listings or the
8775 @url{http://code.google.com/p/minted, minted,} package. To use listings, turn
8776 on the variable @code{org-export-latex-listings} and ensure that the listings
8777 package is included by the LaTeX header (e.g. by configuring
8778 @code{org-export-latex-packages-alist}). See the listings documentation for
8779 configuration options, including obtaining colored output. For minted it is
8780 necessary to install the program @url{http://pygments.org, pygments}, in
8781 addition to setting @code{org-export-latex-minted}, ensuring that the minted
8782 package is included by the LaTeX header, and ensuring that the
8783 @code{-shell-escape} option is passed to @file{pdflatex} (see
8784 @code{org-latex-to-pdf-process}). See the documentation of the variables
8785 @code{org-export-latex-listings} and @code{org-export-latex-minted} for
8786 further details.}. This is done with the @samp{src} block, where you also
8787 need to specify the name of the major mode that should be used to fontify the
8792 #+BEGIN_SRC emacs-lisp
8793 (defun org-xor (a b)
8799 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
8800 switch to the end of the @code{BEGIN} line, to get the lines of the example
8801 numbered. If you use a @code{+n} switch, the numbering from the previous
8802 numbered snippet will be continued in the current one. In literal examples,
8803 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
8804 targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference name
8805 enclosed in single parenthesis). In HTML, hovering the mouse over such a
8806 link will remote-highlight the corresponding code line, which is kind of
8809 You can also add a @code{-r} switch which @i{removes} the labels from the
8810 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
8811 labels in the source code while using line numbers for the links, which might
8812 be useful to explain those in an org-mode example code.}. With the @code{-n}
8813 switch, links to these references will be labeled by the line numbers from
8814 the code listing, otherwise links will use the labels with no parentheses.
8818 #+BEGIN_SRC emacs-lisp -n -r
8819 (save-excursion (ref:sc)
8820 (goto-char (point-min)) (ref:jump)
8822 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
8826 @vindex org-coderef-label-format
8827 If the syntax for the label format conflicts with the language syntax, use a
8828 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
8829 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8831 HTML export also allows examples to be published as text areas, @xref{Text
8832 areas in HTML export}.
8837 Edit the source code example at point in its native mode. This works by
8838 switching to a temporary buffer with the source code. You need to exit by
8839 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
8840 or @samp{#} will get a comma prepended, to keep them from being interpreted
8841 by Org as outline nodes or special comments. These commas will be stripped
8842 for editing with @kbd{C-c '}, and also for export.}. The edited version will
8843 then replace the old version in the Org buffer. Fixed-width regions
8844 (where each line starts with a colon followed by a space) will be edited
8845 using @code{artist-mode}@footnote{You may select a different-mode with the
8846 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
8847 drawings easily. Using this command in an empty line will create a new
8851 Calling @code{org-store-link} while editing a source code example in a
8852 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
8853 that it is unique in the current buffer, and insert it with the proper
8854 formatting like @samp{(ref:label)} at the end of the current line. Then the
8855 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8859 @node Include files, Index entries, Literal examples, Markup
8860 @section Include files
8861 @cindex include files, markup rules
8863 During export, you can include the content of another file. For example, to
8864 include your @file{.emacs} file, you could use:
8868 #+INCLUDE: "~/.emacs" src emacs-lisp
8871 The optional second and third parameter are the markup (e.g. @samp{quote},
8872 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8873 language for formatting the contents. The markup is optional; if it is not
8874 given, the text will be assumed to be in Org-mode format and will be
8875 processed normally. The include line will also allow additional keyword
8876 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8877 first line and for each following line, @code{:minlevel} in order to get
8878 org-mode content demoted to a specified level, as well as any options
8879 accepted by the selected markup. For example, to include a file as an item,
8883 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8886 You can also include a portion of a file by specifying a lines range using
8887 the @code{:lines} parameter. The line at the upper end of the range will not
8888 be included. The start and/or the end of the range may be omitted to use the
8892 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
8893 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
8894 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
8900 Visit the include file at point.
8903 @node Index entries, Macro replacement, Include files, Markup
8904 @section Index entries
8905 @cindex index entries, for publishing
8907 You can specify entries that will be used for generating an index during
8908 publishing. This is done by lines starting with @code{#+INDEX}. An entry
8909 the contains an exclamation mark will create a sub item. See @ref{Generating
8910 an index} for more information.
8915 #+INDEX: Application!CV
8921 @node Macro replacement, Embedded LaTeX, Index entries, Markup
8922 @section Macro replacement
8923 @cindex macro replacement, during export
8926 You can define text snippets with
8929 #+MACRO: name replacement text $1, $2 are arguments
8932 @noindent which can be referenced anywhere in the document (even in
8933 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
8934 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
8935 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
8936 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
8937 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
8938 and to the modification time of the file being exported, respectively.
8939 @var{FORMAT} should be a format string understood by
8940 @code{format-time-string}.
8942 Macro expansion takes place during export, and some people use it to
8943 construct complex HTML code.
8946 @node Embedded LaTeX, , Macro replacement, Markup
8947 @section Embedded @LaTeX{}
8948 @cindex @TeX{} interpretation
8949 @cindex @LaTeX{} interpretation
8951 Plain ASCII is normally sufficient for almost all note taking. Exceptions
8952 include scientific notes, which often require mathematical symbols and the
8953 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
8954 Donald E. Knuth's @TeX{} system. Many of the features described here as
8955 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
8956 distinction.} is widely used to typeset scientific documents. Org-mode
8957 supports embedding @LaTeX{} code into its files, because many academics are
8958 used to writing and reading @LaTeX{} source code, and because it can be
8959 readily processed to produce pretty output for a number of export backends.
8962 * Special symbols:: Greek letters and other symbols
8963 * Subscripts and superscripts:: Simple syntax for raising/lowering text
8964 * LaTeX fragments:: Complex formulas made easy
8965 * Previewing LaTeX fragments:: What will this snippet look like?
8966 * CDLaTeX mode:: Speed up entering of formulas
8969 @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
8970 @subsection Special symbols
8971 @cindex math symbols
8972 @cindex special symbols
8973 @cindex @TeX{} macros
8974 @cindex @LaTeX{} fragments, markup rules
8975 @cindex HTML entities
8976 @cindex @LaTeX{} entities
8978 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
8979 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
8980 for these macros is available, just type @samp{\} and maybe a few letters,
8981 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
8982 code, Org-mode allows these macros to be present without surrounding math
8983 delimiters, for example:
8986 Angles are written as Greek letters \alpha, \beta and \gamma.
8989 @vindex org-entities
8990 During export, these symbols will be transformed into the native format of
8991 the exporter backend. Strings like @code{\alpha} will be exported as
8992 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
8993 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
8994 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
8995 like this: @samp{\Aacute@{@}stor}.
8997 A large number of entities is provided, with names taken from both HTML and
8998 @LaTeX{}; see the variable @code{org-entities} for the complete list.
8999 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9000 @samp{...} are all converted into special commands creating hyphens of
9001 different lengths or a compact set of dots.
9003 If you would like to see entities displayed as UTF8 characters, use the
9004 following command@footnote{You can turn this on by default by setting the
9005 variable @code{org-pretty-entities}, or on a per-file base with the
9006 @code{#+STARTUP} option @code{entitiespretty}.}:
9011 Toggle display of entities as UTF-8 characters. This does not change the
9012 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9013 for display purposes only.
9016 @node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
9017 @subsection Subscripts and superscripts
9021 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9022 and subscripts. Again, these can be used without embedding them in
9023 math-mode delimiters. To increase the readability of ASCII text, it is
9024 not necessary (but OK) to surround multi-character sub- and superscripts
9025 with curly braces. For example
9028 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9029 the sun is R_@{sun@} = 6.96 x 10^8 m.
9032 @vindex org-export-with-sub-superscripts
9033 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9034 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9035 where the underscore is often used in a different context, Org's convention
9036 to always interpret these as subscripts can get in your way. Configure the
9037 variable @code{org-export-with-sub-superscripts} to globally change this
9038 convention, or use, on a per-file basis:
9044 @noindent With this setting, @samp{a_b} will not be interpreted as a
9045 subscript, but @samp{a_@{b@}} will.
9050 In addition to showing entities as UTF-8 characters, this command will also
9051 format sub- and superscripts in a WYSIWYM way.
9054 @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
9055 @subsection @LaTeX{} fragments
9056 @cindex @LaTeX{} fragments
9058 @vindex org-format-latex-header
9059 Going beyond symbols and sub- and superscripts, a full formula language is
9060 needed. Org-mode can contain @LaTeX{} math fragments, and it supports ways
9061 to process these for several export backends. When exporting to @LaTeX{},
9062 the code is obviously left as it is. When exporting to HTML, Org invokes the
9063 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9064 HTML export}) to process and display the math@footnote{If you plan to use
9065 this regularly or on pages with significant page views, you should install
9066 @file{MathJax} on your own
9067 server in order to limit the load of our server.}. Finally, it can also
9068 process the mathematical expressions into images@footnote{For this to work
9069 you need to be on a system with a working @LaTeX{} installation. You also
9070 need the @file{dvipng} program, available at
9071 @url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will
9072 be used when processing a fragment can be configured with the variable
9073 @code{org-format-latex-header}.} that can be displayed in a browser or in
9076 @LaTeX{} fragments don't need any special marking at all. The following
9077 snippets will be identified as @LaTeX{} source code:
9080 Environments of any kind@footnote{When @file{MathJax} is used, only the
9081 environment recognized by @file{MathJax} will be processed. When
9082 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9083 handled.}. The only requirement is that the @code{\begin} statement appears
9084 on a new line, preceded by only whitespace.
9086 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9087 currency specifications, single @samp{$} characters are only recognized as
9088 math delimiters if the enclosed text contains at most two line breaks, is
9089 directly attached to the @samp{$} characters with no whitespace in between,
9090 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9091 For the other delimiters, there is no such restriction, so when in doubt, use
9092 @samp{\(...\)} as inline math delimiters.
9095 @noindent For example:
9098 \begin@{equation@} % arbitrary environments,
9099 x=\sqrt@{b@} % even tables, figures
9100 \end@{equation@} % etc
9102 If $a^2=b$ and \( b=2 \), then the solution must be
9103 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9107 @vindex org-format-latex-options
9108 If you need any of the delimiter ASCII sequences for other purposes, you
9109 can configure the option @code{org-format-latex-options} to deselect the
9110 ones you do not wish to have interpreted by the @LaTeX{} converter.
9112 @vindex org-export-with-LaTeX-fragments
9113 LaTeX processing can be configured with the variable
9114 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9115 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9116 LaTeX backends. You can also set this variable on a per-file basis using one
9120 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9121 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9122 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9123 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9126 @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
9127 @subsection Previewing LaTeX fragments
9128 @cindex LaTeX fragments, preview
9130 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9131 produce preview images of the typeset expressions:
9136 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9137 over the source code. If there is no fragment at point, process all
9138 fragments in the current entry (between two headlines). When called
9139 with a prefix argument, process the entire subtree. When called with
9140 two prefix arguments, or when the cursor is before the first headline,
9141 process the entire buffer.
9144 Remove the overlay preview images.
9147 @vindex org-format-latex-options
9148 You can customize the variable @code{org-format-latex-options} to influence
9149 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9150 export, @code{:html-scale}) property can be used to adjust the size of the
9153 @node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX
9154 @subsection Using CDLa@TeX{} to enter math
9157 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
9158 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9159 environments and math templates. Inside Org-mode, you can make use of
9160 some of the features of CDLa@TeX{} mode. You need to install
9161 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9162 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9163 Don't use CDLa@TeX{} mode itself under Org-mode, but use the light
9164 version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it
9165 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9169 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9172 When this mode is enabled, the following features are present (for more
9173 details see the documentation of CDLa@TeX{} mode):
9177 Environment templates can be inserted with @kbd{C-c @{}.
9180 The @key{TAB} key will do template expansion if the cursor is inside a
9181 @LaTeX{} fragment@footnote{Org-mode has a method to test if the cursor is
9182 inside such a fragment, see the documentation of the function
9183 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9184 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9185 correctly inside the first brace. Another @key{TAB} will get you into
9186 the second brace. Even outside fragments, @key{TAB} will expand
9187 environment abbreviations at the beginning of a line. For example, if
9188 you write @samp{equ} at the beginning of a line and press @key{TAB},
9189 this abbreviation will be expanded to an @code{equation} environment.
9190 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9194 @vindex cdlatex-simplify-sub-super-scripts
9195 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9196 characters together with a pair of braces. If you use @key{TAB} to move
9197 out of the braces, and if the braces surround only a single character or
9198 macro, they are removed again (depending on the variable
9199 @code{cdlatex-simplify-sub-super-scripts}).
9202 Pressing the backquote @kbd{`} followed by a character inserts math
9203 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9204 after the backquote, a help window will pop up.
9207 Pressing the single-quote @kbd{'} followed by another character modifies
9208 the symbol before point with an accent or a font. If you wait more than
9209 1.5 seconds after the single-quote, a help window will pop up. Character
9210 modification will work only inside @LaTeX{} fragments; outside the quote
9214 @node Exporting, Publishing, Markup, Top
9218 Org-mode documents can be exported into a variety of other formats. For
9219 printing and sharing of notes, ASCII export produces a readable and simple
9220 version of an Org file. HTML export allows you to publish a notes file on
9221 the web, while the XOXO format provides a solid base for exchange with a
9222 broad range of other applications. @LaTeX{} export lets you use Org-mode and
9223 its structured editing functions to easily create @LaTeX{} files. DocBook
9224 export makes it possible to convert Org files to many other formats using
9225 DocBook tools. For project management you can create gantt and resource
9226 charts by using TaskJuggler export. To incorporate entries with associated
9227 times like deadlines or appointments into a desktop calendar program like
9228 iCal, Org-mode can also produce extracts in the iCalendar format. Currently
9229 Org-mode only supports export, not import of these different formats.
9231 Org supports export of selected regions when @code{transient-mark-mode} is
9232 enabled (default in Emacs 23).
9235 * Selective export:: Using tags to select and exclude trees
9236 * Export options:: Per-file export settings
9237 * The export dispatcher:: How to access exporter commands
9238 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9239 * HTML export:: Exporting to HTML
9240 * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9241 * DocBook export:: Exporting to DocBook
9242 * TaskJuggler export:: Exporting to TaskJuggler
9243 * Freemind export:: Exporting to Freemind mind maps
9244 * XOXO export:: Exporting to XOXO
9245 * iCalendar export:: Exporting in iCalendar format
9248 @node Selective export, Export options, Exporting, Exporting
9249 @section Selective export
9250 @cindex export, selective by tags
9252 @vindex org-export-select-tags
9253 @vindex org-export-exclude-tags
9254 You may use tags to select the parts of a document that should be exported,
9255 or to exclude parts from export. This behavior is governed by two variables:
9256 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
9258 Org first checks if any of the @emph{select} tags is present in the buffer.
9259 If yes, all trees that do not carry one of these tags will be excluded. If a
9260 selected tree is a subtree, the heading hierarchy above it will also be
9261 selected for export, but not the text below those headings.
9264 If none of the select tags is found, the whole buffer will be selected for
9268 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9269 be removed from the export buffer.
9271 @node Export options, The export dispatcher, Selective export, Exporting
9272 @section Export options
9273 @cindex options, for export
9275 @cindex completion, of option keywords
9276 The exporter recognizes special lines in the buffer which provide
9277 additional information. These lines may be put anywhere in the file.
9278 The whole set of lines can be inserted into the buffer with @kbd{C-c
9279 C-e t}. For individual lines, a good way to make sure the keyword is
9280 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9281 (@pxref{Completion}). For a summary of other in-buffer settings not
9282 specifically related to export, see @ref{In-buffer settings}.
9283 In particular, note that you can place commonly-used (export) options in
9284 a separate file which can be included using @code{#+SETUPFILE}.
9287 @orgcmd{C-c C-e t,org-insert-export-options-template}
9288 Insert template with export options, see example below.
9295 @cindex #+DESCRIPTION
9303 @cindex #+EXPORT_SELECT_TAGS
9304 @cindex #+EXPORT_EXCLUDE_TAGS
9306 @cindex #+LATEX_HEADER
9307 @vindex user-full-name
9308 @vindex user-mail-address
9309 @vindex org-export-default-language
9311 #+TITLE: the title to be shown (default is the buffer name)
9312 #+AUTHOR: the author (default taken from @code{user-full-name})
9313 #+DATE: a date, fixed, or a format string for @code{format-time-string}
9314 #+EMAIL: his/her email address (default from @code{user-mail-address})
9315 #+DESCRIPTION: the page description, e.g. for the XHTML meta tag
9316 #+KEYWORDS: the page keywords, e.g. for the XHTML meta tag
9317 #+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language})
9318 #+TEXT: Some descriptive text to be inserted at the beginning.
9319 #+TEXT: Several lines may be given.
9320 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9321 #+BIND: lisp-var lisp-val, e.g.: org-export-latex-low-levels itemize
9322 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9323 #+LINK_UP: the ``up'' link of an exported page
9324 #+LINK_HOME: the ``home'' link of an exported page
9325 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
9326 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9327 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9328 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9332 The OPTIONS line is a compact@footnote{If you want to configure many options
9333 this way, you can use several OPTIONS lines.} form to specify export
9334 settings. Here you can:
9335 @cindex headline levels
9336 @cindex section-numbers
9337 @cindex table of contents
9338 @cindex line-break preservation
9339 @cindex quoted HTML tags
9340 @cindex fixed-width sections
9342 @cindex @TeX{}-like syntax for sub- and superscripts
9344 @cindex special strings
9345 @cindex emphasized text
9346 @cindex @TeX{} macros
9347 @cindex @LaTeX{} fragments
9348 @cindex author info, in export
9349 @cindex time info, in export
9351 H: @r{set the number of headline levels for export}
9352 num: @r{turn on/off section-numbers}
9353 toc: @r{turn on/off table of contents, or set level limit (integer)}
9354 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9355 @@: @r{turn on/off quoted HTML tags}
9356 :: @r{turn on/off fixed-width sections}
9357 |: @r{turn on/off tables}
9358 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9359 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9360 @r{the simple @code{a_b} will be left as it is.}
9361 -: @r{turn on/off conversion of special strings.}
9362 f: @r{turn on/off footnotes like this[1].}
9363 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9364 pri: @r{turn on/off priority cookies}
9365 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9366 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9367 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9368 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9369 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
9370 skip: @r{turn on/off skipping the text before the first heading}
9371 author: @r{turn on/off inclusion of author name/email into exported file}
9372 email: @r{turn on/off inclusion of author email into exported file}
9373 creator: @r{turn on/off inclusion of creator info into exported file}
9374 timestamp: @r{turn on/off inclusion creation time into exported file}
9375 d: @r{turn on/off inclusion of drawers}
9378 These options take effect in both the HTML and @LaTeX{} export, except for
9379 @code{TeX} and @code{LaTeX}, which are respectively @code{t} and @code{nil}
9380 for the @LaTeX{} export. The default values for these and many other options
9381 are given by a set of variables. For a list of such variables, the
9382 corresponding OPTIONS keys and also the publishing keys (@pxref{Project
9383 alist}), see the constant @code{org-export-plist-vars}.
9385 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9386 calling an export command, the subtree can overrule some of the file's export
9387 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9388 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9389 @code{EXPORT_OPTIONS}.
9391 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9392 @section The export dispatcher
9393 @cindex dispatcher, for export commands
9395 All export commands can be reached using the export dispatcher, which is a
9396 prefix key that prompts for an additional key specifying the command.
9397 Normally the entire file is exported, but if there is an active region that
9398 contains one outline tree, the first heading is used as document title and
9399 the subtrees are exported.
9402 @orgcmd{C-c C-e,org-export}
9403 @vindex org-export-run-in-background
9404 Dispatcher for export and publishing commands. Displays a help-window
9405 listing the additional key(s) needed to launch an export or publishing
9406 command. The prefix arg is passed through to the exporter. A double prefix
9407 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9408 separate Emacs process@footnote{To make this behavior the default, customize
9409 the variable @code{org-export-run-in-background}.}.
9410 @orgcmd{C-c C-e v,org-export-visible}
9411 Like @kbd{C-c C-e}, but only export the text that is currently visible
9412 (i.e. not hidden by outline visibility).
9413 @orgcmd{C-u C-u C-c C-e,org-export}
9414 @vindex org-export-run-in-background
9415 Call the exporter, but reverse the setting of
9416 @code{org-export-run-in-background}, i.e. request background processing if
9417 not set, or force processing in the current Emacs process if set.
9420 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9421 @section ASCII/Latin-1/UTF-8 export
9422 @cindex ASCII export
9423 @cindex Latin-1 export
9424 @cindex UTF-8 export
9426 ASCII export produces a simple and very readable version of an Org-mode
9427 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9428 with special characters and symbols available in these encodings.
9430 @cindex region, active
9431 @cindex active region
9432 @cindex transient-mark-mode
9434 @orgcmd{C-c C-e a,org-export-as-ascii}
9435 @cindex property, EXPORT_FILE_NAME
9436 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9437 will be @file{myfile.txt}. The file will be overwritten without
9438 warning. If there is an active region@footnote{This requires
9439 @code{transient-mark-mode} be turned on.}, only the region will be
9440 exported. If the selected region is a single tree@footnote{To select the
9441 current subtree, use @kbd{C-c @@}.}, the tree head will
9442 become the document title. If the tree head entry has or inherits an
9443 @code{EXPORT_FILE_NAME} property, that name will be used for the
9445 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9446 Export to a temporary buffer. Do not create a file.
9447 @orgcmd{C-c C-e n,org-export-as-latin1}
9448 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
9449 Like the above commands, but use Latin-1 encoding.
9450 @orgcmd{C-c C-e u,org-export-as-utf8}
9451 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
9452 Like the above commands, but use UTF-8 encoding.
9453 @item C-c C-e v a/n/u
9454 Export only the visible part of the document.
9457 @cindex headline levels, for exporting
9458 In the exported version, the first 3 outline levels will become
9459 headlines, defining a general document structure. Additional levels
9460 will be exported as itemized lists. If you want that transition to occur
9461 at a different level, specify it with a prefix argument. For example,
9468 creates only top level headlines and does the rest as items. When
9469 headlines are converted to items, the indentation of the text following
9470 the headline is changed to fit nicely under the item. This is done with
9471 the assumption that the first body line indicates the base indentation of
9472 the body text. Any indentation larger than this is adjusted to preserve
9473 the layout relative to the first line. Should there be lines with less
9474 indentation than the first, these are left alone.
9476 @vindex org-export-ascii-links-to-notes
9477 Links will be exported in a footnote-like style, with the descriptive part in
9478 the text and the link in a note before the next heading. See the variable
9479 @code{org-export-ascii-links-to-notes} for details and other options.
9481 @node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9482 @section HTML export
9485 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9486 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9487 language, but with additional support for tables.
9490 * HTML Export commands:: How to invoke HTML export
9491 * Quoting HTML tags:: Using direct HTML in Org-mode
9492 * Links in HTML export:: How links will be interpreted and formatted
9493 * Tables in HTML export:: How to modify the formatting of tables
9494 * Images in HTML export:: How to insert figures into HTML output
9495 * Math formatting in HTML export:: Beautiful math also on the web
9496 * Text areas in HTML export:: An alternative way to show an example
9497 * CSS support:: Changing the appearance of the output
9498 * JavaScript support:: Info and Folding in a web browser
9501 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
9502 @subsection HTML export commands
9504 @cindex region, active
9505 @cindex active region
9506 @cindex transient-mark-mode
9508 @orgcmd{C-c C-e h,org-export-as-html}
9509 @cindex property, EXPORT_FILE_NAME
9510 Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
9511 the ASCII file will be @file{myfile.html}. The file will be overwritten
9512 without warning. If there is an active region@footnote{This requires
9513 @code{transient-mark-mode} be turned on.}, only the region will be
9514 exported. If the selected region is a single tree@footnote{To select the
9515 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9516 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9517 property, that name will be used for the export.
9518 @orgcmd{C-c C-e b,org-export-as-html-and-open}
9519 Export as HTML file and immediately open it with a browser.
9520 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
9521 Export to a temporary buffer. Do not create a file.
9522 @orgcmd{C-c C-e R,org-export-region-as-html}
9523 Export the active region to a temporary buffer. With a prefix argument, do
9524 not produce the file header and footer, but just the plain HTML section for
9525 the region. This is good for cut-and-paste operations.
9526 @item C-c C-e v h/b/H/R
9527 Export only the visible part of the document.
9528 @item M-x org-export-region-as-html
9529 Convert the region to HTML under the assumption that it was Org-mode
9530 syntax before. This is a global command that can be invoked in any
9532 @item M-x org-replace-region-by-HTML
9533 Replace the active region (assumed to be in Org-mode syntax) by HTML
9537 @cindex headline levels, for exporting
9538 In the exported version, the first 3 outline levels will become headlines,
9539 defining a general document structure. Additional levels will be exported as
9540 itemized lists. If you want that transition to occur at a different level,
9541 specify it with a numeric prefix argument. For example,
9548 creates two levels of headings and does the rest as items.
9550 @node Quoting HTML tags, Links in HTML export, HTML Export commands, HTML export
9551 @subsection Quoting HTML tags
9553 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
9554 @samp{>} in HTML export. If you want to include simple HTML tags
9555 which should be interpreted as such, mark them with @samp{@@} as in
9556 @samp{@@<b>bold text@@</b>}. Note that this really works only for
9557 simple tags. For more extensive HTML that should be copied verbatim to
9558 the exported file use either
9561 @cindex #+BEGIN_HTML
9563 #+HTML: Literal HTML code for export
9567 @cindex #+BEGIN_HTML
9571 All lines between these markers are exported literally
9576 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9577 @subsection Links in HTML export
9579 @cindex links, in HTML export
9580 @cindex internal links, in HTML export
9581 @cindex external links, in HTML export
9582 Internal links (@pxref{Internal links}) will continue to work in HTML. This
9583 includes automatic links created by radio targets (@pxref{Radio
9584 targets}). Links to external files will still work if the target file is on
9585 the same @i{relative} path as the published Org file. Links to other
9586 @file{.org} files will be translated into HTML links under the assumption
9587 that an HTML version also exists of the linked file, at the same relative
9588 path. @samp{id:} links can then be used to jump to specific entries across
9589 files. For information related to linking files while publishing them to a
9590 publishing directory see @ref{Publishing links}.
9592 If you want to specify attributes for links, you can do so using a special
9593 @code{#+ATTR_HTML} line to define attributes that will be added to the
9594 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
9595 and @code{style} attributes for a link:
9599 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
9600 [[http://orgmode.org]]
9603 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9605 @cindex tables, in HTML
9606 @vindex org-export-html-table-tag
9608 Org-mode tables are exported to HTML using the table tag defined in
9609 @code{org-export-html-table-tag}. The default setting makes tables without
9610 cell borders and frame. If you would like to change this for individual
9611 tables, place something like the following before the table:
9616 #+CAPTION: This is a table with lines around and between cells
9617 #+ATTR_HTML: border="2" rules="all" frame="all"
9620 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
9621 @subsection Images in HTML export
9623 @cindex images, inline in HTML
9624 @cindex inlining images in HTML
9625 @vindex org-export-html-inline-images
9626 HTML export can inline images given as links in the Org file, and
9627 it can make an image the clickable part of a link. By
9628 default@footnote{But see the variable
9629 @code{org-export-html-inline-images}.}, images are inlined if a link does
9630 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
9631 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
9632 @samp{the image} that points to the image. If the description part
9633 itself is a @code{file:} link or a @code{http:} URL pointing to an
9634 image, this image will be inlined and activated so that clicking on the
9635 image will activate the link. For example, to include a thumbnail that
9636 will link to a high resolution version of the image, you could use:
9639 [[file:highres.jpg][file:thumb.jpg]]
9642 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
9643 In the example below we specify the @code{alt} and @code{title} attributes to
9644 support text viewers and accessibility, and align it to the right.
9649 #+CAPTION: A black cat stalking a spider
9650 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
9655 and you could use @code{http} addresses just as well.
9657 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
9658 @subsection Math formatting in HTML export
9662 @LaTeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two
9663 different ways on HTML pages. The default is to use the
9664 @uref{http://www.mathjax.org, MathJax system} which should work out of the
9665 box with Org mode installation because @code{http://orgmode.org} serves
9666 @file{MathJax} for Org-mode users for small applications and for testing
9667 purposes. @b{If you plan to use this regularly or on pages with significant
9668 page views, you should install@footnote{Installation instructions can be
9669 found on the MathJax website, see
9670 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
9671 your own server in order to limit the load of our server.} To configure
9672 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
9673 insert something like the following into the buffer:
9676 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
9679 @noindent See the docstring of the variable
9680 @code{org-export-html-mathjax-options} for the meaning of the parameters in
9683 If you prefer, you can also request that @LaTeX{} fragments are processed
9684 into small images that will be inserted into the browser page. Before the
9685 availability of MathJax, this was the default method for Org files. This
9686 method requires that the @file{dvipng} program is available on your system.
9687 You can still get this processing with
9690 #+OPTIONS: LaTeX:dvipng
9693 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
9694 @subsection Text areas in HTML export
9696 @cindex text areas, in HTML
9697 An alternative way to publish literal code examples in HTML is to use text
9698 areas, where the example can even be edited before pasting it into an
9699 application. It is triggered by a @code{-t} switch at an @code{example} or
9700 @code{src} block. Using this switch disables any options for syntax and
9701 label highlighting, and line numbering, which may be present. You may also
9702 use @code{-h} and @code{-w} switches to specify the height and width of the
9703 text area, which default to the number of lines in the example, and 80,
9704 respectively. For example
9707 #+BEGIN_EXAMPLE -t -w 40
9708 (defun org-xor (a b)
9715 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
9716 @subsection CSS support
9717 @cindex CSS, for HTML export
9718 @cindex HTML export, CSS
9720 @vindex org-export-html-todo-kwd-class-prefix
9721 @vindex org-export-html-tag-class-prefix
9722 You can also give style information for the exported file. The HTML exporter
9723 assigns the following special CSS classes@footnote{If the classes on TODO
9724 keywords and tags lead to conflicts, use the variables
9725 @code{org-export-html-todo-kwd-class-prefix} and
9726 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
9727 parts of the document---your style specifications may change these, in
9728 addition to any of the standard classes like for headlines, tables, etc.
9730 p.author @r{author information, including email}
9731 p.date @r{publishing date}
9732 p.creator @r{creator info, about org-mode version}
9733 .title @r{document title}
9734 .todo @r{TODO keywords, all not-done states}
9735 .done @r{the DONE keywords, all stated the count as done}
9736 .WAITING @r{each TODO keyword also uses a class named after itself}
9737 .timestamp @r{timestamp}
9738 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
9739 .timestamp-wrapper @r{span around keyword plus timestamp}
9740 .tag @r{tag in a headline}
9741 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
9742 .target @r{target for links}
9743 .linenr @r{the line number in a code example}
9744 .code-highlighted @r{for highlighting referenced code lines}
9745 div.outline-N @r{div for outline level N (headline plus text))}
9746 div.outline-text-N @r{extra div for text at outline level N}
9747 .section-number-N @r{section number in headlines, different for each level}
9748 div.figure @r{how to format an inlined image}
9749 pre.src @r{formatted source code}
9750 pre.example @r{normal example}
9751 p.verse @r{verse paragraph}
9752 div.footnotes @r{footnote section headline}
9753 p.footnote @r{footnote definition paragraph, containing a footnote}
9754 .footref @r{a footnote reference number (always a <sup>)}
9755 .footnum @r{footnote number in footnote definition (always <sup>)}
9758 @vindex org-export-html-style-default
9759 @vindex org-export-html-style-include-default
9760 @vindex org-export-html-style
9761 @vindex org-export-html-extra
9762 @vindex org-export-html-style-default
9763 Each exported file contains a compact default style that defines these
9764 classes in a basic way@footnote{This style is defined in the constant
9765 @code{org-export-html-style-default}, which you should not modify. To turn
9766 inclusion of these defaults off, customize
9767 @code{org-export-html-style-include-default}}. You may overwrite these
9768 settings, or add to them by using the variables @code{org-export-html-style}
9769 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
9770 fine-grained settings, like file-local settings). To set the latter variable
9771 individually for each file, you can use
9775 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
9779 For longer style definitions, you can use several such lines. You could also
9780 directly write a @code{<style>} @code{</style>} section in this way, without
9781 referring to an external file.
9783 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
9784 property to assign a class to the tree. In order to specify CSS styles for a
9785 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
9788 @c FIXME: More about header and footer styles
9789 @c FIXME: Talk about links and targets.
9791 @node JavaScript support, , CSS support, HTML export
9792 @subsection JavaScript supported display of web pages
9794 @cindex Rose, Sebastian
9795 Sebastian Rose has written a JavaScript program especially designed to
9796 enhance the web viewing experience of HTML files created with Org. This
9797 program allows you to view large files in two different ways. The first one
9798 is an @emph{Info}-like mode where each section is displayed separately and
9799 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
9800 as well, press @kbd{?} for an overview of the available keys). The second
9801 view type is a @emph{folding} view much like Org provides inside Emacs. The
9802 script is available at @url{http://orgmode.org/org-info.js} and you can find
9803 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
9804 We host the script at our site, but if you use it a lot, you might
9805 not want to be dependent on @url{orgmode.org} and prefer to install a local
9806 copy on your own web server.
9808 To use the script, you need to make sure that the @file{org-jsinfo.el} module
9809 gets loaded. It should be loaded by default, but you can try @kbd{M-x
9810 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
9811 this is indeed the case. All it then takes to make use of the program is
9812 adding a single line to the Org file:
9814 @cindex #+INFOJS_OPT
9816 #+INFOJS_OPT: view:info toc:nil
9820 If this line is found, the HTML header will automatically contain the code
9821 needed to invoke the script. Using the line above, you can set the following
9825 path: @r{The path to the script. The default is to grab the script from}
9826 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
9827 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
9828 view: @r{Initial view when website is first shown. Possible values are:}
9829 info @r{Info-like interface with one section per page.}
9830 overview @r{Folding interface, initially showing only top-level.}
9831 content @r{Folding interface, starting with all headlines visible.}
9832 showall @r{Folding interface, all headlines and text visible.}
9833 sdepth: @r{Maximum headline level that will still become an independent}
9834 @r{section for info and folding modes. The default is taken from}
9835 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
9836 @r{If this is smaller than in @code{org-export-headline-levels}, each}
9837 @r{info/folding section can still contain child headlines.}
9838 toc: @r{Should the table of contents @emph{initially} be visible?}
9839 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
9840 tdepth: @r{The depth of the table of contents. The defaults are taken from}
9841 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
9842 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
9843 @r{If yes, the toc will never be displayed as a section.}
9844 ltoc: @r{Should there be short contents (children) in each section?}
9845 @r{Make this @code{above} if the section should be above initial text.}
9846 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
9847 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
9848 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
9849 @r{default), only one such button will be present.}
9852 @vindex org-infojs-options
9853 @vindex org-export-html-use-infojs
9854 You can choose default values for these options by customizing the variable
9855 @code{org-infojs-options}. If you always want to apply the script to your
9856 pages, configure the variable @code{org-export-html-use-infojs}.
9858 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
9859 @section @LaTeX{} and PDF export
9860 @cindex @LaTeX{} export
9862 @cindex Guerry, Bastien
9864 Org-mode contains a @LaTeX{} exporter written by Bastien Guerry. With
9865 further processing@footnote{The default LaTeX output is designed for
9866 processing with pdftex or latex. It includes packages that are not
9867 compatible with xetex and possibly luatex. See the variables
9868 @code{org-export-latex-default-packages-alist} and
9869 @code{org-export-latex-packages-alist}.}, this backend is also used to
9870 produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
9871 implement links and cross references, the PDF output file will be fully
9875 * LaTeX/PDF export commands:: Which key invokes which commands
9876 * Header and sectioning:: Setting up the export file structure
9877 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code
9878 * Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
9879 * Images in LaTeX export:: How to insert figures into @LaTeX{} output
9880 * Beamer class export:: Turning the file into a presentation
9883 @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
9884 @subsection @LaTeX{} export commands
9886 @cindex region, active
9887 @cindex active region
9888 @cindex transient-mark-mode
9890 @orgcmd{C-c C-e l,org-export-as-latex}
9891 @cindex property EXPORT_FILE_NAME
9892 Export as @LaTeX{} file @file{myfile.tex}. For an Org file
9893 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
9894 be overwritten without warning. If there is an active region@footnote{This
9895 requires @code{transient-mark-mode} be turned on.}, only the region will be
9896 exported. If the selected region is a single tree@footnote{To select the
9897 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9898 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
9899 property, that name will be used for the export.
9900 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
9901 Export to a temporary buffer. Do not create a file.
9903 Export only the visible part of the document.
9904 @item M-x org-export-region-as-latex
9905 Convert the region to @LaTeX{} under the assumption that it was Org-mode
9906 syntax before. This is a global command that can be invoked in any
9908 @item M-x org-replace-region-by-latex
9909 Replace the active region (assumed to be in Org-mode syntax) by @LaTeX{}
9911 @orgcmd{C-c C-e p,org-export-as-pdf}
9912 Export as @LaTeX{} and then process to PDF.
9913 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
9914 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
9917 @cindex headline levels, for exporting
9918 @vindex org-latex-low-levels
9919 In the exported version, the first 3 outline levels will become
9920 headlines, defining a general document structure. Additional levels
9921 will be exported as description lists. The exporter can ignore them or
9922 convert them to a custom string depending on
9923 @code{org-latex-low-levels}.
9925 If you want that transition to occur at a different level, specify it
9926 with a numeric prefix argument. For example,
9933 creates two levels of headings and does the rest as items.
9935 @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
9936 @subsection Header and sectioning structure
9937 @cindex @LaTeX{} class
9938 @cindex @LaTeX{} sectioning structure
9939 @cindex @LaTeX{} header
9940 @cindex header, for LaTeX files
9941 @cindex sectioning structure, for LaTeX export
9943 By default, the @LaTeX{} output uses the class @code{article}.
9945 @vindex org-export-latex-default-class
9946 @vindex org-export-latex-classes
9947 @vindex org-export-latex-default-packages-alist
9948 @vindex org-export-latex-packages-alist
9949 @cindex #+LATEX_HEADER
9950 @cindex #+LATEX_CLASS
9951 @cindex #+LATEX_CLASS_OPTIONS
9952 @cindex property, LATEX_CLASS
9953 @cindex property, LATEX_CLASS_OPTIONS
9954 You can change this globally by setting a different value for
9955 @code{org-export-latex-default-class} or locally by adding an option like
9956 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
9957 property that applies when exporting a region containing only this (sub)tree.
9958 The class must be listed in @code{org-export-latex-classes}. This variable
9959 defines a header template for each class@footnote{Into which the values of
9960 @code{org-export-latex-default-packages-alist} and
9961 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
9962 define the sectioning structure for each class. You can also define your own
9963 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
9964 property can specify the options for the @code{\documentclass} macro. You
9965 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
9966 header. See the docstring of @code{org-export-latex-classes} for more
9969 @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export
9970 @subsection Quoting @LaTeX{} code
9972 Embedded @LaTeX{} as described in @ref{Embedded LaTeX}, will be correctly
9973 inserted into the @LaTeX{} file. This includes simple macros like
9974 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
9975 you can add special code that should only be present in @LaTeX{} export with
9976 the following constructs:
9979 @cindex #+BEGIN_LaTeX
9981 #+LaTeX: Literal LaTeX code for export
9985 @cindex #+BEGIN_LaTeX
9989 All lines between these markers are exported literally
9994 @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
9995 @subsection Tables in @LaTeX{} export
9996 @cindex tables, in @LaTeX{} export
9998 For @LaTeX{} export of a table, you can specify a label and a caption
9999 (@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to
10000 request a @code{longtable} environment for the table, so that it may span
10001 several pages, or to change the default table environment from @code{table}
10002 to @code{table*} or to change the default inner tabular environment to
10003 @code{tabularx} or @code{tabulary}. Finally, you can set the alignment
10004 string, and (with @code{tabularx} or @code{tabulary}) the width:
10008 @cindex #+ATTR_LaTeX
10010 #+CAPTION: A long table
10012 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10017 or to specify a multicolumn table with @code{tabulary}
10021 @cindex #+ATTR_LaTeX
10023 #+CAPTION: A wide table with tabulary
10025 #+ATTR_LaTeX: table* tabulary width=\textwidth
10030 @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
10031 @subsection Images in @LaTeX{} export
10032 @cindex images, inline in @LaTeX{}
10033 @cindex inlining images in @LaTeX{}
10035 Images that are linked to without a description part in the link, like
10036 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10037 output file resulting from @LaTeX{} processing. Org will use an
10038 @code{\includegraphics} macro to insert the image. If you have specified a
10039 caption and/or a label as described in @ref{Images and tables}, the figure
10040 will be wrapped into a @code{figure} environment and thus become a floating
10041 element. You can use an @code{#+ATTR_LaTeX:} line to specify the various
10042 options that can be used in the optional argument of the
10043 @code{\includegraphics} macro. To modify the placement option of the
10044 @code{figure} environment, add something like @samp{placement=[h!]} to the
10047 If you would like to let text flow around the image, add the word @samp{wrap}
10048 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10049 half of the page. To fine-tune, the @code{placement} field will be the set
10050 of additional arguments needed by the @code{wrapfigure} environment. Note
10051 that if you change the size of the image, you need to use compatible settings
10052 for @code{\includegraphics} and @code{wrapfigure}.
10056 @cindex #+ATTR_LaTeX
10058 #+CAPTION: The black-body emission of the disk around HR 4049
10059 #+LABEL: fig:SED-HR4049
10060 #+ATTR_LaTeX: width=5cm,angle=90
10061 [[./img/sed-hr4049.pdf]]
10063 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10067 If you need references to a label created in this way, write
10068 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10070 @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export
10071 @subsection Beamer class export
10073 The LaTeX class @file{beamer} allows production of high quality presentations
10074 using LaTeX and pdf processing. Org-mode has special support for turning an
10075 Org-mode file or tree into a @file{beamer} presentation.
10077 When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS:
10078 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10079 @code{beamer}, a special export mode will turn the file or tree into a beamer
10080 presentation. Any tree with not-too-deep level nesting should in principle be
10081 exportable as a beamer presentation. By default, the top-level entries (or
10082 the first level below the selected subtree heading) will be turned into
10083 frames, and the outline structure below this level will become itemize lists.
10084 You can also configure the variable @code{org-beamer-frame-level} to a
10085 different level---then the hierarchy above frames will produce the sectioning
10086 structure of the presentation.
10088 A template for useful in-buffer settings or properties can be inserted into
10089 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10090 things, this will install a column view format which is very handy for
10091 editing special properties used by beamer.
10093 You can influence the structure of the presentation using the following
10098 The environment that should be used to format this entry. Valid environments
10099 are defined in the constant @code{org-beamer-environments-default}, and you
10100 can define more in @code{org-beamer-environments-extra}. If this property is
10101 set, the entry will also get a @code{:B_environment:} tag to make this
10102 visible. This tag has no semantic meaning, it is only a visual aid.
10103 @item BEAMER_envargs
10104 The beamer-special arguments that should be used for the environment, like
10105 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10106 property is also set, something like @code{C[t]} can be added here as well to
10107 set an options argument for the implied @code{columns} environment.
10108 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10111 The width of a column that should start with this entry. If this property is
10112 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10113 Also this tag is only a visual aid. When this is a plain number, it will be
10114 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10115 that you have specified the units, like @samp{3cm}. The first such property
10116 in a frame will start a @code{columns} environment to surround the columns.
10117 This environment is closed when an entry has a @code{BEAMER_col} property
10118 with value 0 or 1, or automatically at the end of the frame.
10120 Additional commands that should be inserted after the environment has been
10121 opened. For example, when creating a frame, this can be used to specify
10125 Frames will automatically receive a @code{fragile} option if they contain
10126 source code that uses the verbatim environment. Special @file{beamer}
10127 specific code can be inserted using @code{#+BEAMER:} and
10128 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
10129 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10130 in the presentation as well.
10132 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10133 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10134 into @code{\note@{...@}}. The former will include the heading as part of the
10135 note text, the latter will ignore the heading of that node. To simplify note
10136 generation, it is actually enough to mark the note with a @emph{tag} (either
10137 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10138 @code{BEAMER_env} property.
10140 You can turn on a special minor mode @code{org-beamer-mode} for editing
10148 @orgcmd{C-c C-b,org-beamer-select-environment}
10149 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10150 environment or the @code{BEAMER_col} property.
10153 Column view provides a great way to set the environment of a node and other
10154 important parameters. Make sure you are using a COLUMN format that is geared
10155 toward this special purpose. The command @kbd{M-x
10156 org-insert-beamer-options-template} defines such a format.
10158 Here is a simple example Org document that is intended for beamer export.
10161 #+LaTeX_CLASS: beamer
10162 #+TITLE: Example Presentation
10163 #+AUTHOR: Carsten Dominik
10164 #+LaTeX_CLASS_OPTIONS: [presentation]
10165 #+BEAMER_FRAME_LEVEL: 2
10166 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10167 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10169 * This is the first structural section
10171 ** Frame 1 \\ with a subtitle
10172 *** Thanks to Eric Fraga :BMCOL:B_block:
10175 :BEAMER_envargs: C[t]
10178 for the first viable beamer setup in Org
10179 *** Thanks to everyone else :BMCOL:B_block:
10183 :BEAMER_envargs: <2->
10185 for contributing to the discussion
10186 **** This will be formatted as a beamer note :B_note:
10187 ** Frame 2 \\ where we will not use columns
10188 *** Request :B_block:
10189 Please test this stuff!
10195 For more information, see the documentation on Worg.
10197 @node DocBook export, TaskJuggler export, LaTeX and PDF export, Exporting
10198 @section DocBook export
10199 @cindex DocBook export
10201 @cindex Cui, Baoqiu
10203 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10204 exported to DocBook format, it can be further processed to produce other
10205 formats, including PDF, HTML, man pages, etc., using many available DocBook
10206 tools and stylesheets.
10208 Currently DocBook exporter only supports DocBook V5.0.
10211 * DocBook export commands:: How to invoke DocBook export
10212 * Quoting DocBook code:: Incorporating DocBook code in Org files
10213 * Recursive sections:: Recursive sections in DocBook
10214 * Tables in DocBook export:: Tables are exported as HTML tables
10215 * Images in DocBook export:: How to insert figures into DocBook output
10216 * Special characters:: How to handle special characters
10219 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10220 @subsection DocBook export commands
10222 @cindex region, active
10223 @cindex active region
10224 @cindex transient-mark-mode
10226 @orgcmd{C-c C-e D,org-export-as-docbook}
10227 @cindex property EXPORT_FILE_NAME
10228 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10229 file will be @file{myfile.xml}. The file will be overwritten without
10230 warning. If there is an active region@footnote{This requires
10231 @code{transient-mark-mode} to be turned on}, only the region will be
10232 exported. If the selected region is a single tree@footnote{To select the
10233 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10234 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10235 property, that name will be used for the export.
10236 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10237 Export as DocBook file, process to PDF, then open the resulting PDF file.
10239 @vindex org-export-docbook-xslt-proc-command
10240 @vindex org-export-docbook-xsl-fo-proc-command
10241 Note that, in order to produce PDF output based on exported DocBook file, you
10242 need to have XSLT processor and XSL-FO processor software installed on your
10243 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10244 @code{org-export-docbook-xsl-fo-proc-command}.
10246 @vindex org-export-docbook-xslt-stylesheet
10247 The stylesheet argument @code{%s} in variable
10248 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10249 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10250 the user. You can also overrule this global setting on a per-file basis by
10251 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10253 @orgkey{C-c C-e v D}
10254 Export only the visible part of the document.
10257 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10258 @subsection Quoting DocBook code
10260 You can quote DocBook code in Org files and copy it verbatim into exported
10261 DocBook file with the following constructs:
10264 @cindex #+BEGIN_DOCBOOK
10266 #+DOCBOOK: Literal DocBook code for export
10270 @cindex #+BEGIN_DOCBOOK
10274 All lines between these markers are exported by DocBook exporter
10279 For example, you can use the following lines to include a DocBook warning
10280 admonition. As to what this warning says, you should pay attention to the
10281 document context when quoting DocBook code in Org files. You may make
10282 exported DocBook XML files invalid by not quoting DocBook code correctly.
10287 <para>You should know what you are doing when quoting DocBook XML code
10288 in your Org file. Invalid DocBook XML may be generated by
10289 DocBook exporter if you are not careful!</para>
10294 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10295 @subsection Recursive sections
10296 @cindex DocBook recursive sections
10298 DocBook exporter exports Org files as articles using the @code{article}
10299 element in DocBook. Recursive sections, i.e. @code{section} elements, are
10300 used in exported articles. Top level headlines in Org files are exported as
10301 top level sections, and lower level headlines are exported as nested
10302 sections. The entire structure of Org files will be exported completely, no
10303 matter how many nested levels of headlines there are.
10305 Using recursive sections makes it easy to port and reuse exported DocBook
10306 code in other DocBook document types like @code{book} or @code{set}.
10308 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10309 @subsection Tables in DocBook export
10310 @cindex tables, in DocBook export
10312 Tables in Org files are exported as HTML tables, which have been supported since
10315 If a table does not have a caption, an informal table is generated using the
10316 @code{informaltable} element; otherwise, a formal table will be generated
10317 using the @code{table} element.
10319 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10320 @subsection Images in DocBook export
10321 @cindex images, inline in DocBook
10322 @cindex inlining images in DocBook
10324 Images that are linked to without a description part in the link, like
10325 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10326 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10327 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10328 specified a caption for an image as described in @ref{Images and tables}, a
10329 @code{caption} element will be added in @code{mediaobject}. If a label is
10330 also specified, it will be exported as an @code{xml:id} attribute of the
10331 @code{mediaobject} element.
10333 @vindex org-export-docbook-default-image-attributes
10334 Image attributes supported by the @code{imagedata} element, like @code{align}
10335 or @code{width}, can be specified in two ways: you can either customize
10336 variable @code{org-export-docbook-default-image-attributes} or use the
10337 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10338 @code{org-export-docbook-default-image-attributes} are applied to all inline
10339 images in the Org file to be exported (unless they are overridden by image
10340 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10342 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10343 attributes or override default image attributes for individual images. If
10344 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10345 variable @code{org-export-docbook-default-image-attributes}, the former
10346 takes precedence. Here is an example about how image attributes can be
10351 @cindex #+ATTR_DOCBOOK
10353 #+CAPTION: The logo of Org-mode
10354 #+LABEL: unicorn-svg
10355 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10356 [[./img/org-mode-unicorn.svg]]
10359 @vindex org-export-docbook-inline-image-extensions
10360 By default, DocBook exporter recognizes the following image file types:
10361 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10362 customize variable @code{org-export-docbook-inline-image-extensions} to add
10363 more types to this list as long as DocBook supports them.
10365 @node Special characters, , Images in DocBook export, DocBook export
10366 @subsection Special characters in DocBook export
10367 @cindex Special characters in DocBook export
10369 @vindex org-export-docbook-doctype
10370 @vindex org-entities
10371 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10372 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10373 characters are rewritten to XML entities, like @code{α},
10374 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10375 @code{org-entities}. As long as the generated DocBook file includes the
10376 corresponding entities, these special characters are recognized.
10378 You can customize variable @code{org-export-docbook-doctype} to include the
10379 entities you need. For example, you can set variable
10380 @code{org-export-docbook-doctype} to the following value to recognize all
10381 special characters included in XHTML entities:
10384 "<!DOCTYPE article [
10385 <!ENTITY % xhtml1-symbol PUBLIC
10386 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10387 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10394 @node TaskJuggler export, Freemind export, DocBook export, Exporting
10395 @section TaskJuggler export
10396 @cindex TaskJuggler export
10397 @cindex Project management
10399 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
10400 It provides an optimizing scheduler that computes your project time lines and
10401 resource assignments based on the project outline and the constraints that
10404 The TaskJuggler exporter is a bit different from other exporters, such as the
10405 HTML and LaTeX exporters for example, in that it does not export all the
10406 nodes of a document or strictly follow the order of the nodes in the
10409 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
10410 a optionally tree that defines the resources for this project. It then
10411 creates a TaskJuggler file based on these trees and the attributes defined in
10414 @subsection TaskJuggler export commands
10417 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
10418 Export as TaskJuggler file.
10420 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
10421 Export as TaskJuggler file and then open the file with TaskJugglerUI.
10426 @vindex org-export-taskjuggler-project-tag
10427 Create your tasks as you usually do with Org-mode. Assign efforts to each
10428 task using properties (it's easiest to do this in the column view). You
10429 should end up with something similar to the example by Peter Jones in
10430 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
10431 Now mark the top node of your tasks with a tag named
10432 @code{:taskjuggler_project:} (or whatever you customized
10433 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
10434 the project plan with @kbd{C-c C-e J} which will export the project plan and
10435 open a gantt chart in TaskJugglerUI.
10437 @subsection Resources
10439 @vindex org-export-taskjuggler-resource-tag
10440 Next you can define resources and assign those to work on specific tasks. You
10441 can group your resources hierarchically. Tag the top node of the resources
10442 with @code{:taskjuggler_resource:} (or whatever you customized
10443 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
10444 identifier (named @samp{resource_id}) to the resources (using the standard
10445 Org properties commands, @pxref{Property syntax}) or you can let the exporter
10446 generate identifiers automatically (the exporter picks the first word of the
10447 headline as the identifier as long as it is unique---see the documentation of
10448 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
10449 allocate resources to tasks. This is again done with the @samp{allocate}
10450 property on the tasks. Do this in column view or when on the task type
10451 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
10453 Once the allocations are done you can again export to TaskJuggler and check
10454 in the Resource Allocation Graph which person is working on what task at what
10457 @subsection Export of properties
10459 The exporter also takes TODO state information into consideration, i.e. if a
10460 task is marked as done it will have the corresponding attribute in
10461 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
10462 resource or resource node which is known to TaskJuggler, such as
10463 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
10464 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
10465 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
10466 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
10467 @samp{scheduling}, etc for tasks.
10469 @subsection Dependencies
10471 The exporter will handle dependencies that are defined in the tasks either
10472 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
10473 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
10474 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
10475 attribute can be either @samp{previous-sibling} or a reference to an
10476 identifier (named @samp{task_id}) which is defined for another task in the
10477 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
10478 dependencies separated by either space or comma. You can also specify
10479 optional attributes on the dependency by simply appending it. The following
10480 examples should illustrate this:
10485 :task_id: preparation
10488 * Training material
10490 :task_id: training_material
10493 ** Markup Guidelines
10497 ** Workflow Guidelines
10504 :BLOCKER: training_material @{ gapduration 1d @} preparation
10508 @subsection Reports
10510 @vindex org-export-taskjuggler-default-reports
10511 TaskJuggler can produce many kinds of reports (e.g. gantt chart, resource
10512 allocation, etc). The user defines what kind of reports should be generated
10513 for a project in the TaskJuggler file. The exporter will automatically insert
10514 some default reports in the file. These defaults are defined in
10515 @code{org-export-taskjuggler-default-reports}. They can be modified using
10516 customize along with a number of other options. For a more complete list, see
10517 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
10519 For more information and examples see the Org-taskjuggler tutorial at
10520 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
10522 @node Freemind export, XOXO export, TaskJuggler export, Exporting
10523 @section Freemind export
10524 @cindex Freemind export
10527 The Freemind exporter was written by Lennart Borgman.
10530 @orgcmd{C-c C-e m,org-export-as-freemind}
10531 Export as Freemind mind map @file{myfile.mm}.
10534 @node XOXO export, iCalendar export, Freemind export, Exporting
10535 @section XOXO export
10536 @cindex XOXO export
10538 Org-mode contains an exporter that produces XOXO-style output.
10539 Currently, this exporter only handles the general outline structure and
10540 does not interpret any additional Org-mode features.
10543 @orgcmd{C-c C-e x,org-export-as-xoxo}
10544 Export as XOXO file @file{myfile.html}.
10545 @orgkey{C-c C-e v x}
10546 Export only the visible part of the document.
10549 @node iCalendar export, , XOXO export, Exporting
10550 @section iCalendar export
10551 @cindex iCalendar export
10553 @vindex org-icalendar-include-todo
10554 @vindex org-icalendar-use-deadline
10555 @vindex org-icalendar-use-scheduled
10556 @vindex org-icalendar-categories
10557 @vindex org-icalendar-alarm-time
10558 Some people use Org-mode for keeping track of projects, but still prefer a
10559 standard calendar application for anniversaries and appointments. In this
10560 case it can be useful to show deadlines and other time-stamped items in Org
10561 files in the calendar application. Org-mode can export calendar information
10562 in the standard iCalendar format. If you also want to have TODO entries
10563 included in the export, configure the variable
10564 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
10565 and TODO items as VTODO. It will also create events from deadlines that are
10566 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
10567 to set the start and due dates for the TODO entry@footnote{See the variables
10568 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
10569 As categories, it will use the tags locally defined in the heading, and the
10570 file/tree category@footnote{To add inherited tags or the TODO state,
10571 configure the variable @code{org-icalendar-categories}.}. See the variable
10572 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
10575 @vindex org-icalendar-store-UID
10576 @cindex property, ID
10577 The iCalendar standard requires each entry to have a globally unique
10578 identifier (UID). Org creates these identifiers during export. If you set
10579 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
10580 @code{:ID:} property of the entry and re-used next time you report this
10581 entry. Since a single entry can give rise to multiple iCalendar entries (as
10582 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
10583 prefixes to the UID, depending on what triggered the inclusion of the entry.
10584 In this way the UID remains unique, but a synchronization program can still
10585 figure out from which entry all the different instances originate.
10588 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
10589 Create iCalendar entries for the current file and store them in the same
10590 directory, using a file extension @file{.ics}.
10591 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
10592 @vindex org-agenda-files
10593 Like @kbd{C-c C-e i}, but do this for all files in
10594 @code{org-agenda-files}. For each of these files, a separate iCalendar
10595 file will be written.
10596 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
10597 @vindex org-combined-agenda-icalendar-file
10598 Create a single large iCalendar file from all files in
10599 @code{org-agenda-files} and write it to the file given by
10600 @code{org-combined-agenda-icalendar-file}.
10603 @vindex org-use-property-inheritance
10604 @vindex org-icalendar-include-body
10605 @cindex property, SUMMARY
10606 @cindex property, DESCRIPTION
10607 @cindex property, LOCATION
10608 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
10609 property can be inherited from higher in the hierarchy if you configure
10610 @code{org-use-property-inheritance} accordingly.} properties if the selected
10611 entries have them. If not, the summary will be derived from the headline,
10612 and the description from the body (limited to
10613 @code{org-icalendar-include-body} characters).
10615 How this calendar is best read and updated, depends on the application
10616 you are using. The FAQ covers this issue.
10618 @node Publishing, Working With Source Code, Exporting, Top
10619 @chapter Publishing
10622 Org includes a publishing management system that allows you to configure
10623 automatic HTML conversion of @emph{projects} composed of interlinked org
10624 files. You can also configure Org to automatically upload your exported HTML
10625 pages and related attachments, such as images and source code files, to a web
10628 You can also use Org to convert files into PDF, or even combine HTML and PDF
10629 conversion so that files are available in both formats on the server.
10631 Publishing has been contributed to Org by David O'Toole.
10634 * Configuration:: Defining projects
10635 * Uploading files:: How to get files up on the server
10636 * Sample configuration:: Example projects
10637 * Triggering publication:: Publication commands
10640 @node Configuration, Uploading files, Publishing, Publishing
10641 @section Configuration
10643 Publishing needs significant configuration to specify files, destination
10644 and many other properties of a project.
10647 * Project alist:: The central configuration variable
10648 * Sources and destinations:: From here to there
10649 * Selecting files:: What files are part of the project?
10650 * Publishing action:: Setting the function doing the publishing
10651 * Publishing options:: Tweaking HTML export
10652 * Publishing links:: Which links keep working after publishing?
10653 * Sitemap:: Generating a list of all pages
10654 * Generating an index:: An index that reaches across pages
10657 @node Project alist, Sources and destinations, Configuration, Configuration
10658 @subsection The variable @code{org-publish-project-alist}
10659 @cindex org-publish-project-alist
10660 @cindex projects, for publishing
10662 @vindex org-publish-project-alist
10663 Publishing is configured almost entirely through setting the value of one
10664 variable, called @code{org-publish-project-alist}. Each element of the list
10665 configures one project, and may be in one of the two following forms:
10668 ("project-name" :property value :property value ...)
10669 @r{i.e. a well-formed property list with alternating keys and values}
10671 ("project-name" :components ("project-name" "project-name" ...))
10675 In both cases, projects are configured by specifying property values. A
10676 project defines the set of files that will be published, as well as the
10677 publishing configuration to use when publishing those files. When a project
10678 takes the second form listed above, the individual members of the
10679 @code{:components} property are taken to be sub-projects, which group
10680 together files requiring different publishing options. When you publish such
10681 a ``meta-project'', all the components will also be published, in the
10684 @node Sources and destinations, Selecting files, Project alist, Configuration
10685 @subsection Sources and destinations for files
10686 @cindex directories, for publishing
10688 Most properties are optional, but some should always be set. In
10689 particular, Org needs to know where to look for source files,
10690 and where to put published files.
10692 @multitable @columnfractions 0.3 0.7
10693 @item @code{:base-directory}
10694 @tab Directory containing publishing source files
10695 @item @code{:publishing-directory}
10696 @tab Directory where output files will be published. You can directly
10697 publish to a webserver using a file name syntax appropriate for
10698 the Emacs @file{tramp} package. Or you can publish to a local directory and
10699 use external tools to upload your website (@pxref{Uploading files}).
10700 @item @code{:preparation-function}
10701 @tab Function or list of functions to be called before starting the
10702 publishing process, for example, to run @code{make} for updating files to be
10703 published. The project property list is scoped into this call as the
10704 variable @code{project-plist}.
10705 @item @code{:completion-function}
10706 @tab Function or list of functions called after finishing the publishing
10707 process, for example, to change permissions of the resulting files. The
10708 project property list is scoped into this call as the variable
10709 @code{project-plist}.
10713 @node Selecting files, Publishing action, Sources and destinations, Configuration
10714 @subsection Selecting files
10715 @cindex files, selecting for publishing
10717 By default, all files with extension @file{.org} in the base directory
10718 are considered part of the project. This can be modified by setting the
10720 @multitable @columnfractions 0.25 0.75
10721 @item @code{:base-extension}
10722 @tab Extension (without the dot!) of source files. This actually is a
10723 regular expression. Set this to the symbol @code{any} if you want to get all
10724 files in @code{:base-directory}, even without extension.
10726 @item @code{:exclude}
10727 @tab Regular expression to match file names that should not be
10728 published, even though they have been selected on the basis of their
10731 @item @code{:include}
10732 @tab List of files to be included regardless of @code{:base-extension}
10733 and @code{:exclude}.
10735 @item @code{:recursive}
10736 @tab Non-nil means, check base-directory recursively for files to publish.
10739 @node Publishing action, Publishing options, Selecting files, Configuration
10740 @subsection Publishing action
10741 @cindex action, for publishing
10743 Publishing means that a file is copied to the destination directory and
10744 possibly transformed in the process. The default transformation is to export
10745 Org files as HTML files, and this is done by the function
10746 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
10747 export}). But you also can publish your content as PDF files using
10748 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
10749 @code{utf8} encoded files using the corresponding functions. If you want to
10750 publish the Org file itself, but with @i{archived}, @i{commented}, and
10751 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
10752 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
10753 produce @file{file.org} and @file{file.org.html} in the publishing
10754 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
10755 source and publishing directories are equal. Note that with this kind of
10756 setup, you need to add @code{:exclude "-source\\.org"} to the project
10757 definition in @code{org-publish-project-alist} to prevent the published
10758 source files from being considered as new org files the next time the project
10759 is published.}. Other files like images only need to be copied to the
10760 publishing destination; for this you may use @code{org-publish-attachment}.
10761 For non-Org files, you always need to specify the publishing function:
10763 @multitable @columnfractions 0.3 0.7
10764 @item @code{:publishing-function}
10765 @tab Function executing the publication of a file. This may also be a
10766 list of functions, which will all be called in turn.
10767 @item @code{:plain-source}
10768 @tab Non-nil means, publish plain source.
10769 @item @code{:htmlized-source}
10770 @tab Non-nil means, publish htmlized source.
10773 The function must accept three arguments: a property list containing at least
10774 a @code{:publishing-directory} property, the name of the file to be
10775 published, and the path to the publishing directory of the output file. It
10776 should take the specified file, make the necessary transformation (if any)
10777 and place the result into the destination folder.
10779 @node Publishing options, Publishing links, Publishing action, Configuration
10780 @subsection Options for the HTML/@LaTeX{} exporters
10781 @cindex options, for publishing
10783 The property list can be used to set many export options for the HTML
10784 and @LaTeX{} exporters. In most cases, these properties correspond to user
10785 variables in Org. The table below lists these properties along
10786 with the variable they belong to. See the documentation string for the
10787 respective variable for details.
10789 @vindex org-export-html-link-up
10790 @vindex org-export-html-link-home
10791 @vindex org-export-default-language
10792 @vindex org-display-custom-times
10793 @vindex org-export-headline-levels
10794 @vindex org-export-with-section-numbers
10795 @vindex org-export-section-number-format
10796 @vindex org-export-with-toc
10797 @vindex org-export-preserve-breaks
10798 @vindex org-export-with-archived-trees
10799 @vindex org-export-with-emphasize
10800 @vindex org-export-with-sub-superscripts
10801 @vindex org-export-with-special-strings
10802 @vindex org-export-with-footnotes
10803 @vindex org-export-with-drawers
10804 @vindex org-export-with-tags
10805 @vindex org-export-with-todo-keywords
10806 @vindex org-export-with-priority
10807 @vindex org-export-with-TeX-macros
10808 @vindex org-export-with-LaTeX-fragments
10809 @vindex org-export-skip-text-before-1st-heading
10810 @vindex org-export-with-fixed-width
10811 @vindex org-export-with-timestamps
10812 @vindex org-export-author-info
10813 @vindex org-export-email
10814 @vindex org-export-creator-info
10815 @vindex org-export-with-tables
10816 @vindex org-export-highlight-first-table-line
10817 @vindex org-export-html-style-include-default
10818 @vindex org-export-html-style-include-scripts
10819 @vindex org-export-html-style
10820 @vindex org-export-html-style-extra
10821 @vindex org-export-html-link-org-files-as-html
10822 @vindex org-export-html-inline-images
10823 @vindex org-export-html-extension
10824 @vindex org-export-html-table-tag
10825 @vindex org-export-html-expand
10826 @vindex org-export-html-with-timestamp
10827 @vindex org-export-publishing-directory
10828 @vindex org-export-html-preamble
10829 @vindex org-export-html-postamble
10830 @vindex org-export-html-auto-preamble
10831 @vindex org-export-html-auto-postamble
10832 @vindex user-full-name
10833 @vindex user-mail-address
10834 @vindex org-export-select-tags
10835 @vindex org-export-exclude-tags
10837 @multitable @columnfractions 0.32 0.68
10838 @item @code{:link-up} @tab @code{org-export-html-link-up}
10839 @item @code{:link-home} @tab @code{org-export-html-link-home}
10840 @item @code{:language} @tab @code{org-export-default-language}
10841 @item @code{:customtime} @tab @code{org-display-custom-times}
10842 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
10843 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
10844 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
10845 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
10846 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
10847 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
10848 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
10849 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
10850 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
10851 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
10852 @item @code{:drawers} @tab @code{org-export-with-drawers}
10853 @item @code{:tags} @tab @code{org-export-with-tags}
10854 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
10855 @item @code{:priority} @tab @code{org-export-with-priority}
10856 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
10857 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
10858 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
10859 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
10860 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
10861 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
10862 @item @code{:author-info} @tab @code{org-export-author-info}
10863 @item @code{:email-info} @tab @code{org-export-email-info}
10864 @item @code{:creator-info} @tab @code{org-export-creator-info}
10865 @item @code{:tables} @tab @code{org-export-with-tables}
10866 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
10867 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
10868 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
10869 @item @code{:style} @tab @code{org-export-html-style}
10870 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
10871 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
10872 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
10873 @item @code{:html-extension} @tab @code{org-export-html-extension}
10874 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
10875 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
10876 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
10877 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
10878 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
10879 @item @code{:preamble} @tab @code{org-export-html-preamble}
10880 @item @code{:postamble} @tab @code{org-export-html-postamble}
10881 @item @code{:auto-preamble} @tab @code{org-export-html-auto-preamble}
10882 @item @code{:auto-postamble} @tab @code{org-export-html-auto-postamble}
10883 @item @code{:author} @tab @code{user-full-name}
10884 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
10885 @item @code{:select-tags} @tab @code{org-export-select-tags}
10886 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
10887 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
10890 Most of the @code{org-export-with-*} variables have the same effect in
10891 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
10892 @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the
10895 @vindex org-publish-project-alist
10896 When a property is given a value in @code{org-publish-project-alist},
10897 its setting overrides the value of the corresponding user variable (if
10898 any) during publishing. Options set within a file (@pxref{Export
10899 options}), however, override everything.
10901 @node Publishing links, Sitemap, Publishing options, Configuration
10902 @subsection Links between published files
10903 @cindex links, publishing
10905 To create a link from one Org file to another, you would use
10906 something like @samp{[[file:foo.org][The foo]]} or simply
10907 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
10908 becomes a link to @file{foo.html}. In this way, you can interlink the
10909 pages of your "org web" project and the links will work as expected when
10910 you publish them to HTML. If you also publish the Org source file and want
10911 to link to that, use an @code{http:} link instead of a @code{file:} link,
10912 because @code{file:} links are converted to link to the corresponding
10915 You may also link to related files, such as images. Provided you are careful
10916 with relative file names, and provided you have also configured Org to upload
10917 the related files, these links will work too. See @ref{Complex example}, for
10918 an example of this usage.
10920 Sometimes an Org file to be published may contain links that are
10921 only valid in your production environment, but not in the publishing
10922 location. In this case, use the property
10924 @multitable @columnfractions 0.4 0.6
10925 @item @code{:link-validation-function}
10926 @tab Function to validate links
10930 to define a function for checking link validity. This function must
10931 accept two arguments, the file name and a directory relative to which
10932 the file name is interpreted in the production environment. If this
10933 function returns @code{nil}, then the HTML generator will only insert a
10934 description into the HTML file, but no link. One option for this
10935 function is @code{org-publish-validate-link} which checks if the given
10936 file is part of any project in @code{org-publish-project-alist}.
10938 @node Sitemap, Generating an index, Publishing links, Configuration
10939 @subsection Generating a sitemap
10940 @cindex sitemap, of published pages
10942 The following properties may be used to control publishing of
10943 a map of files for a given project.
10945 @multitable @columnfractions 0.35 0.65
10946 @item @code{:auto-sitemap}
10947 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
10948 or @code{org-publish-all}.
10950 @item @code{:sitemap-filename}
10951 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
10952 becomes @file{sitemap.html}).
10954 @item @code{:sitemap-title}
10955 @tab Title of sitemap page. Defaults to name of file.
10957 @item @code{:sitemap-function}
10958 @tab Plug-in function to use for generation of the sitemap.
10959 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
10960 of links to all files in the project.
10962 @item @code{:sitemap-sort-folders}
10963 @tab Where folders should appear in the sitemap. Set this to @code{first}
10964 (default) or @code{last} to display folders first or last,
10965 respectively. Any other value will mix files and folders.
10967 @item @code{:sitemap-alphabetically}
10968 @tab The site map is normally sorted alphabetically. Set this explicitly to
10969 @code{nil} to turn off sorting.
10971 @item @code{:sitemap-ignore-case}
10972 @tab Should sorting be case-sensitive? Default @code{nil}.
10976 @node Generating an index, , Sitemap, Configuration
10977 @subsection Generating an index
10978 @cindex index, in a publishing project
10980 Org-mode can generate an index across the files of a publishing project.
10982 @multitable @columnfractions 0.25 0.75
10983 @item @code{:makeindex}
10984 @tab When non-nil, generate in index in the file @file{theindex.org} and
10985 publish it as @file{theindex.html}.
10988 The file will be created when first publishing a project with the
10989 @code{:makeindex} set. The file only contains a statement @code{#+include:
10990 "theindex.inc"}. You can then build around this include statement by adding
10991 a title, style information, etc.
10993 @node Uploading files, Sample configuration, Configuration, Publishing
10994 @section Uploading files
10998 For those people already utilizing third party sync tools such as
10999 @command{rsync} or @command{unison}, it might be preferable not to use the built in
11000 @i{remote} publishing facilities of Org-mode which rely heavily on
11001 Tramp. Tramp, while very useful and powerful, tends not to be
11002 so efficient for multiple file transfer and has been known to cause problems
11005 Specialized synchronization utilities offer several advantages. In addition
11006 to timestamp comparison, they also do content and permissions/attribute
11007 checks. For this reason you might prefer to publish your web to a local
11008 directory (possibly even @i{in place} with your Org files) and then use
11009 @file{unison} or @file{rsync} to do the synchronization with the remote host.
11011 Since Unison (for example) can be configured as to which files to transfer to
11012 a certain remote destination, it can greatly simplify the project publishing
11013 definition. Simply keep all files in the correct location, process your Org
11014 files with @code{org-publish} and let the synchronization tool do the rest.
11015 You do not need, in this scenario, to include attachments such as @file{jpg},
11016 @file{css} or @file{gif} files in the project definition since the 3rd party
11019 Publishing to a local directory is also much faster than to a remote one, so
11020 that you can afford more easily to republish entire projects. If you set
11021 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
11022 benefit of re-including any changed external files such as source example
11023 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
11024 Org is not smart enough to detect if included files have been modified.
11026 @node Sample configuration, Triggering publication, Uploading files, Publishing
11027 @section Sample configuration
11029 Below we provide two example configurations. The first one is a simple
11030 project publishing only a set of Org files. The second example is
11031 more complex, with a multi-component project.
11034 * Simple example:: One-component publishing
11035 * Complex example:: A multi-component publishing example
11038 @node Simple example, Complex example, Sample configuration, Sample configuration
11039 @subsection Example: simple publishing configuration
11041 This example publishes a set of Org files to the @file{public_html}
11042 directory on the local machine.
11045 (setq org-publish-project-alist
11047 :base-directory "~/org/"
11048 :publishing-directory "~/public_html"
11049 :section-numbers nil
11050 :table-of-contents nil
11051 :style "<link rel=\"stylesheet\"
11052 href=\"../other/mystyle.css\"
11053 type=\"text/css\"/>")))
11056 @node Complex example, , Simple example, Sample configuration
11057 @subsection Example: complex publishing configuration
11059 This more complicated example publishes an entire website, including
11060 Org files converted to HTML, image files, Emacs Lisp source code, and
11061 style sheets. The publishing directory is remote and private files are
11064 To ensure that links are preserved, care should be taken to replicate
11065 your directory structure on the web server, and to use relative file
11066 paths. For example, if your Org files are kept in @file{~/org} and your
11067 publishable images in @file{~/images}, you would link to an image with
11070 file:../images/myimage.png
11073 On the web server, the relative path to the image should be the
11074 same. You can accomplish this by setting up an "images" folder in the
11075 right place on the web server, and publishing images to it.
11078 (setq org-publish-project-alist
11080 :base-directory "~/org/"
11081 :base-extension "org"
11082 :publishing-directory "/ssh:user@@host:~/html/notebook/"
11083 :publishing-function org-publish-org-to-html
11084 :exclude "PrivatePage.org" ;; regexp
11086 :section-numbers nil
11087 :table-of-contents nil
11088 :style "<link rel=\"stylesheet\"
11089 href=\"../other/mystyle.css\" type=\"text/css\"/>"
11091 :auto-postamble nil)
11094 :base-directory "~/images/"
11095 :base-extension "jpg\\|gif\\|png"
11096 :publishing-directory "/ssh:user@@host:~/html/images/"
11097 :publishing-function org-publish-attachment)
11100 :base-directory "~/other/"
11101 :base-extension "css\\|el"
11102 :publishing-directory "/ssh:user@@host:~/html/other/"
11103 :publishing-function org-publish-attachment)
11104 ("website" :components ("orgfiles" "images" "other"))))
11107 @node Triggering publication, , Sample configuration, Publishing
11108 @section Triggering publication
11110 Once properly configured, Org can publish with the following commands:
11113 @orgcmd{C-c C-e X,org-publish}
11114 Prompt for a specific project and publish all files that belong to it.
11115 @orgcmd{C-c C-e P,org-publish-current-project}
11116 Publish the project containing the current file.
11117 @orgcmd{C-c C-e F,org-publish-current-file}
11118 Publish only the current file.
11119 @orgcmd{C-c C-e E,org-publish-all}
11120 Publish every project.
11123 @vindex org-publish-use-timestamps-flag
11124 Org uses timestamps to track when a file has changed. The above functions
11125 normally only publish changed files. You can override this and force
11126 publishing of all files by giving a prefix argument to any of the commands
11127 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
11128 This may be necessary in particular if files include other files via
11129 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
11131 @comment node-name, next, previous, up
11132 @comment Working With Source Code, Miscellaneous, Publishing, Top
11134 @node Working With Source Code, Miscellaneous, Publishing, Top
11135 @chapter Working with source code
11136 @cindex Schulte, Eric
11137 @cindex Davison, Dan
11138 @cindex source code, working with
11140 Source code can be included in Org-mode documents using a @samp{src} block,
11144 #+BEGIN_SRC emacs-lisp
11145 (defun org-xor (a b)
11151 Org-mode provides a number of features for working with live source code,
11152 including editing of code blocks in their native major-mode, evaluation of
11153 code blocks, tangling of code blocks, and exporting code blocks and their
11154 results in several formats. This functionality was contributed by Eric
11155 Schulte and Dan Davison, and was originally named Org-babel.
11157 The following sections describe Org-mode's code block handling facilities.
11160 * Structure of code blocks:: Code block syntax described
11161 * Editing source code:: Language major-mode editing
11162 * Exporting code blocks:: Export contents and/or results
11163 * Extracting source code:: Create pure source code files
11164 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
11165 * Library of Babel:: Use and contribute to a library of useful code blocks
11166 * Languages:: List of supported code block languages
11167 * Header arguments:: Configure code block functionality
11168 * Results of evaluation:: How evaluation results are handled
11169 * Noweb reference syntax:: Literate programming in Org-mode
11170 * Key bindings and useful functions:: Work quickly with code blocks
11171 * Batch execution:: Call functions from the command line
11174 @comment node-name, next, previous, up
11175 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11177 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11178 @section Structure of code blocks
11179 @cindex code block, structure
11180 @cindex source code, block structure
11182 The structure of code blocks is as follows:
11186 #+begin_src <language> <switches> <header arguments>
11191 Switches and header arguments are optional. Code can also be embedded in text
11195 src_<language>@{<body>@}
11201 src_<language>[<header arguments>]@{<body>@}
11206 This name is associated with the code block. This is similar to the
11207 @samp{#+tblname} lines that can be used to name tables in Org-mode files.
11208 Referencing the name of a code block makes it possible to evaluate the
11209 block from other places in the file, other files, or from Org-mode table
11210 formulas (see @ref{The spreadsheet}).
11212 The language of the code in the block.
11214 Optional switches controlling exportation of the code block (see switches discussion in
11215 @ref{Literal examples})
11216 @item <header arguments>
11217 Optional header arguments control many aspects of evaluation, export and
11218 tangling of code blocks. See the @ref{Header arguments}
11219 section. Header arguments can also be set on a per-buffer or per-subtree
11220 basis using properties.
11225 @comment node-name, next, previous, up
11226 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11228 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11229 @section Editing source code
11230 @cindex code block, editing
11231 @cindex source code, editing
11234 Use @kbd{C-c '} to edit the current code block. This brings up
11235 a language major-mode edit buffer containing the body of the code
11236 block. Saving this buffer will write the new contents back to the Org
11237 buffer. Use @kbd{C-c '} again to exit.
11239 The @code{org-src-mode} minor mode will be active in the edit buffer. The
11240 following variables can be used to configure the behavior of the edit
11241 buffer. See also the customization group @code{org-edit-structure} for
11242 further configuration options.
11245 @item org-src-lang-modes
11246 If an Emacs major-mode named @code{<lang>-mode} exists, where
11247 @code{<lang>} is the language named in the header line of the code block,
11248 then the edit buffer will be placed in that major-mode. This variable
11249 can be used to map arbitrary language names to existing major modes.
11250 @item org-src-window-setup
11251 Controls the way Emacs windows are rearranged when the edit buffer is created.
11252 @item org-src-preserve-indentation
11253 This variable is especially useful for tangling languages such as
11254 Python, in which whitespace indentation in the output is critical.
11255 @item org-src-ask-before-returning-to-edit-buffer
11256 By default, Org will ask before returning to an open edit buffer. Set
11257 this variable to nil to switch without asking.
11260 To turn on native code fontification in the @emph{Org} buffer, configure the
11261 variable @code{org-src-fontify-natively}.
11263 @comment node-name, next, previous, up
11264 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11266 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11267 @section Exporting code blocks
11268 @cindex code block, exporting
11269 @cindex source code, exporting
11271 It is possible to export the @emph{contents} of code blocks, the
11272 @emph{results} of code block evaluation, @emph{neither}, or @emph{both}. For
11273 most languages, the default exports the contents of code blocks. However, for
11274 some languages (e.g. @code{ditaa}) the default exports the results of code
11275 block evaluation. For information on exporting code block bodies, see
11276 @ref{Literal examples}.
11278 The @code{:exports} header argument can be used to specify export
11281 @subsubheading Header arguments:
11283 @item :exports code
11284 The default in most languages. The body of the code block is exported, as
11285 described in @ref{Literal examples}.
11286 @item :exports results
11287 The code block will be evaluated and the results will be placed in the
11288 Org-mode buffer for export, either updating previous results of the code
11289 block located anywhere in the buffer or, if no previous results exist,
11290 placing the results immediately after the code block. The body of the code
11291 block will not be exported.
11292 @item :exports both
11293 Both the code block and its results will be exported.
11294 @item :exports none
11295 Neither the code block nor its results will be exported.
11298 It is possible to inhibit the evaluation of code blocks during export.
11299 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
11300 ensure that no code blocks are evaluated as part of the export process. This
11301 can be useful in situations where potentially untrusted Org-mode files are
11302 exported in an automated fashion, for example when Org-mode is used as the
11303 markup language for a wiki.
11305 @comment node-name, next, previous, up
11306 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11307 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11308 @section Extracting source code
11309 @cindex source code, extracting
11310 @cindex code block, extracting source code
11312 Creating pure source code files by extracting code from source blocks is
11313 referred to as ``tangling''---a term adopted from the literate programming
11314 community. During ``tangling'' of code blocks their bodies are expanded
11315 using @code{org-babel-expand-src-block} which can expand both variable and
11316 ``noweb'' style references (see @ref{Noweb reference syntax}).
11318 @subsubheading Header arguments
11321 The default. The code block is not included in the tangled output.
11323 Include the code block in the tangled output. The output file name is the
11324 name of the org file with the extension @samp{.org} replaced by the extension
11325 for the block language.
11326 @item :tangle filename
11327 Include the code block in the tangled output to file @samp{filename}.
11331 @subsubheading Functions
11333 @item org-babel-tangle
11334 Tangle the current file. Bound to @kbd{C-c C-v t}.
11335 @item org-babel-tangle-file
11336 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
11339 @subsubheading Hooks
11341 @item org-babel-post-tangle-hook
11342 This hook is run from within code files tangled by @code{org-babel-tangle}.
11343 Example applications could include post-processing, compilation or evaluation
11344 of tangled code files.
11347 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
11348 @section Evaluating code blocks
11349 @cindex code block, evaluating
11350 @cindex source code, evaluating
11352 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
11353 potential for that code to do harm. Org-mode provides a number of safeguards
11354 to ensure that it only evaluates code with explicit confirmation from the
11355 user. For information on these safeguards (and on how to disable them) see
11356 @ref{Code evaluation security}.} and the results placed in the Org-mode
11357 buffer. By default, evaluation is only turned on for @code{emacs-lisp} code
11358 blocks, however support exists for evaluating blocks in many languages. See
11359 @ref{Languages} for a list of supported languages. See @ref{Structure of
11360 code blocks} for information on the syntax used to define a code block.
11363 There are a number of ways to evaluate code blocks. The simplest is to press
11364 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
11365 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
11366 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
11367 @code{org-babel-execute-src-block} function to evaluate the block and insert
11368 its results into the Org-mode buffer.
11370 It is also possible to evaluate named code blocks from anywhere in an
11371 Org-mode buffer or an Org-mode table. @code{#+call} (or synonymously
11372 @code{#+function} or @code{#+lob}) lines can be used to remotely execute code
11373 blocks located in the current Org-mode buffer or in the ``Library of Babel''
11374 (see @ref{Library of Babel}). These lines use the following syntax.
11377 #+call: <name>(<arguments>) <header arguments>
11378 #+function: <name>(<arguments>) <header arguments>
11379 #+lob: <name>(<arguments>) <header arguments>
11384 The name of the code block to be evaluated.
11386 Arguments specified in this section will be passed to the code block. These
11387 arguments should relate to @code{:var} header arguments in the called code
11388 block expressed using standard function call syntax. For example if the
11389 original code block named @code{double} has the header argument @code{:var
11390 n=2}, then the call line passing the number four to that block would be
11391 written as @code{#+call: double(n=2)}.
11392 @item <header arguments>
11393 Header arguments can be placed after the function invocation. See
11394 @ref{Header arguments} for more information on header arguments.
11397 All header arguments placed in the @code{<header arguments>} section
11398 described above will be applied to the evaluation of the @code{#+call:} line,
11399 however it is sometimes desirable to specify header arguments to be passed to
11400 the code block being evaluated.
11402 This is possible through the use of the following optional extended syntax.
11405 #+call: <name>[<block header arguments>](<arguments>) <header arguments>
11408 Any header argument placed between the square brackets in the @code{<block
11409 header arguments>} section will be applied to the evaluation of the named
11410 code block. For more examples of passing header arguments to @code{#+call:}
11411 lines see @ref{Header arguments in function calls}.
11413 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
11414 @section Library of Babel
11415 @cindex babel, library of
11416 @cindex source code, library
11417 @cindex code block, library
11419 The ``Library of Babel'' is a library of code blocks
11420 that can be called from any Org-mode file. The library is housed in an
11421 Org-mode file located in the @samp{contrib} directory of Org-mode.
11422 Org-mode users can deposit functions they believe to be generally
11423 useful in the library.
11425 Code blocks defined in the ``Library of Babel'' can be called remotely as if
11426 they were in the current Org-mode buffer (see @ref{Evaluating code blocks}
11427 for information on the syntax of remote code block evaluation).
11430 Code blocks located in any Org-mode file can be loaded into the ``Library of
11431 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
11434 @node Languages, Header arguments, Library of Babel, Working With Source Code
11436 @cindex babel, languages
11437 @cindex source code, languages
11438 @cindex code block, languages
11440 Code blocks in the following languages are supported.
11442 @multitable @columnfractions 0.28 0.3 0.22 0.2
11443 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
11444 @item Asymptote @tab asymptote @tab C @tab C
11445 @item C++ @tab C++ @tab Clojure @tab clojure
11446 @item CSS @tab css @tab ditaa @tab ditaa
11447 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
11448 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
11449 @item LaTeX @tab latex @tab MATLAB @tab matlab
11450 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
11451 @item Octave @tab octave @tab Oz @tab oz
11452 @item Perl @tab perl @tab Python @tab python
11453 @item R @tab R @tab Ruby @tab ruby
11454 @item Sass @tab sass @tab GNU Screen @tab screen
11455 @item shell @tab sh @tab SQL @tab sql
11456 @item SQLite @tab sqlite
11459 Language-specific documentation is available for some languages. If
11460 available, it can be found at
11461 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
11463 The @code{org-babel-load-languages} controls which languages are enabled for
11464 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
11465 be set using the customization interface or by adding code like the following
11466 to your emacs configuration.
11469 The following disables @code{emacs-lisp} evaluation and enables evaluation of
11470 @code{R} code blocks.
11474 (org-babel-do-load-languages
11475 'org-babel-load-languages
11476 '((emacs-lisp . nil)
11480 It is also possible to enable support for a language by loading the related
11481 elisp file with @code{require}.
11484 The following adds support for evaluating @code{clojure} code blocks.
11488 (require 'ob-clojure)
11491 @node Header arguments, Results of evaluation, Languages, Working With Source Code
11492 @section Header arguments
11493 @cindex code block, header arguments
11494 @cindex source code, block header arguments
11496 Code block functionality can be configured with header arguments. This
11497 section provides an overview of the use of header arguments, and then
11498 describes each header argument in detail.
11501 * Using header arguments:: Different ways to set header arguments
11502 * Specific header arguments:: List of header arguments
11505 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
11506 @subsection Using header arguments
11508 The values of header arguments can be set in six different ways, each more
11509 specific (and having higher priority) than the last.
11511 * System-wide header arguments:: Set global default values
11512 * Language-specific header arguments:: Set default values by language
11513 * Buffer-wide header arguments:: Set default values for a specific buffer
11514 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
11515 * Code block specific header arguments:: The most common way to set values
11516 * Header arguments in function calls:: The most specific level
11520 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
11521 @subsubheading System-wide header arguments
11522 @vindex org-babel-default-header-args
11523 System-wide values of header arguments can be specified by customizing the
11524 @code{org-babel-default-header-args} variable:
11528 :results => "replace"
11535 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
11537 @c ((:session . "none")
11538 @c (:results . "replace")
11539 @c (:exports . "code")
11541 @c (:noweb . "no"))
11545 @c Default arguments to use when evaluating a code block.
11548 For example, the following example could be used to set the default value of
11549 @code{:noweb} header arguments to @code{yes}. This would have the effect of
11550 expanding @code{:noweb} references by default when evaluating source code
11554 (setq org-babel-default-header-args
11555 (cons '(:noweb . "yes")
11556 (assq-delete-all :noweb org-babel-default-header-args)))
11559 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
11560 @subsubheading Language-specific header arguments
11561 Each language can define its own set of default header arguments. See the
11562 language-specific documentation available online at
11563 @uref{http://orgmode.org/worg/org-contrib/babel}.
11565 @node Buffer-wide header arguments, Header arguments in Org-mode properties, Language-specific header arguments, Using header arguments
11566 @subsubheading Buffer-wide header arguments
11567 Buffer-wide header arguments may be specified through the use of a special
11568 line placed anywhere in an Org-mode file. The line consists of the
11569 @code{#+BABEL:} keyword followed by a series of header arguments which may be
11570 specified using the standard header argument syntax.
11572 For example the following would set @code{session} to @code{*R*}, and
11573 @code{results} to @code{silent} for every code block in the buffer, ensuring
11574 that all execution took place in the same session, and no results would be
11575 inserted into the buffer.
11578 #+BABEL: :session *R* :results silent
11581 @node Header arguments in Org-mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
11582 @subsubheading Header arguments in Org-mode properties
11584 Header arguments are also read from Org-mode properties (see @ref{Property
11585 syntax}), which can be set on a buffer-wide or per-heading basis. An example
11586 of setting a header argument for all code blocks in a buffer is
11589 #+property: tangle yes
11592 When properties are used to set default header arguments, they are looked up
11593 with inheritance, so the value of the @code{:cache} header argument will default
11594 to @code{yes} in all code blocks in the subtree rooted at the following
11605 @vindex org-babel-default-header-args
11606 Properties defined in this way override the properties set in
11607 @code{org-babel-default-header-args}. It is convenient to use the
11608 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
11609 in Org-mode documents.
11611 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org-mode properties, Using header arguments
11612 @subsubheading Code block specific header arguments
11614 The most common way to assign values to header arguments is at the
11615 code block level. This can be done by listing a sequence of header
11616 arguments and their values as part of the @code{#+begin_src} line.
11617 Properties set in this way override both the values of
11618 @code{org-babel-default-header-args} and header arguments specified as
11619 properties. In the following example, the @code{:results} header argument
11620 is set to @code{silent}, meaning the results of execution will not be
11621 inserted in the buffer, and the @code{:exports} header argument is set to
11622 @code{code}, meaning only the body of the code block will be
11623 preserved on export to HTML or LaTeX.
11626 #+source: factorial
11627 #+begin_src haskell :results silent :exports code :var n=0
11629 fac n = n * fac (n-1)
11632 Similarly, it is possible to set header arguments for inline code blocks:
11635 src_haskell[:exports both]@{fac 5@}
11638 Code block header arguments can span multiple lines using =#+header:= or
11639 =#+headers:= lines preceding a code block or nested in between the name and
11640 body of a named code block.
11642 Multi-line header arguments on an un-named code block:
11644 #+headers: :var data1=1
11645 #+begin_src emacs-lisp :var data2=2
11646 (message "data1:%S, data2:%S" data1 data2)
11653 Multi-line header arguments on a named code block:
11655 #+source: named-block
11656 #+header: :var data=2
11657 #+begin_src emacs-lisp
11658 (message "data:%S" data)
11661 #+results: named-block
11665 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
11666 @comment node-name, next, previous, up
11667 @subsubheading Header arguments in function calls
11669 At the most specific level, header arguments for ``Library of Babel'' or
11670 function call lines can be set as shown in the two examples below. For more
11671 information on the structure of @code{#+call:} lines see @ref{Evaluating code
11674 The following will apply the @code{:exports results} header argument to the
11675 evaluation of the @code{#+call:} line.
11677 #+call: factorial(n=5) :exports results
11680 The following will apply the @code{:session special} header argument to the
11681 evaluation of the @code{factorial} code block.
11683 #+call: factorial[:session special](n=5)
11686 @node Specific header arguments, , Using header arguments, Header arguments
11687 @subsection Specific header arguments
11688 The following header arguments are defined:
11691 * var:: Pass arguments to code blocks
11692 * results:: Specify the type of results and how they will
11693 be collected and handled
11694 * file:: Specify a path for file output
11695 * dir:: Specify the default (possibly remote)
11696 directory for code block execution
11697 * exports:: Export code and/or results
11698 * tangle:: Toggle tangling and specify file name
11699 * comments:: Toggle insertion of comments in tangled
11701 * no-expand:: Turn off variable assignment and noweb
11702 expansion during tangling
11703 * session:: Preserve the state of code evaluation
11704 * noweb:: Toggle expansion of noweb references
11705 * cache:: Avoid re-evaluating unchanged code blocks
11706 * sep:: Delimiter for writing tabular results outside Org
11707 * hlines:: Handle horizontal lines in tables
11708 * colnames:: Handle column names in tables
11709 * rownames:: Handle row names in tables
11710 * shebang:: Make tangled files executable
11711 * eval:: Limit evaluation of specific code blocks
11714 @node var, results, Specific header arguments, Specific header arguments
11715 @subsubsection @code{:var}
11716 The @code{:var} header argument is used to pass arguments to code blocks.
11717 The specifics of how arguments are included in a code block vary by language;
11718 these are addressed in the language-specific documentation. However, the
11719 syntax used to specify arguments is the same across all languages. The
11720 values passed to arguments can be literal values, values from org-mode tables
11721 and literal example blocks, or the results of other code blocks.
11723 These values can be indexed in a manner similar to arrays---see the
11724 ``indexable variable values'' heading below.
11726 The following syntax is used to pass arguments to code blocks using the
11727 @code{:var} header argument.
11733 where @code{assign} can take one of the following forms
11736 @item literal value
11737 either a string @code{"string"} or a number @code{9}.
11742 #+tblname: example-table
11748 #+source: table-length
11749 #+begin_src emacs-lisp :var table=example-table
11753 #+results: table-length
11757 a code block name, as assigned by @code{#+srcname:}, followed by
11761 #+begin_src emacs-lisp :var length=table-length()
11769 In addition, an argument can be passed to the code block referenced
11770 by @code{:var}. The argument is passed within the parentheses following the
11775 #+begin_src emacs-lisp :var input=8
11783 #+begin_src emacs-lisp :var input=double(input=1)
11792 @subsubheading Alternate argument syntax
11793 It is also possible to specify arguments in a potentially more natural way
11794 using the @code{#+source:} line of a code block. As in the following
11795 example arguments can be packed inside of parenthesis, separated by commas,
11796 following the source name.
11799 #+source: double(input=0, x=2)
11800 #+begin_src emacs-lisp
11805 @subsubheading Indexable variable values
11806 It is possible to reference portions of variable values by ``indexing'' into
11807 the variables. Indexes are 0 based with negative values counting back from
11808 the end. If an index is separated by @code{,}s then each subsequent section
11809 will index into the next deepest nesting or dimension of the value. The
11810 following example assigns the last cell of the first row the table
11811 @code{example-table} to the variable @code{data}:
11814 #+results: example-table
11820 #+begin_src emacs-lisp :var data=example-table[0,-1]
11828 Ranges of variable values can be referenced using two integers separated by a
11829 @code{:}, in which case the entire inclusive range is referenced. For
11830 example the following assigns the middle three rows of @code{example-table}
11834 #+results: example-table
11841 #+begin_src emacs-lisp :var data=example-table[1:3]
11851 Additionally, an empty index, or the single character @code{*}, are both
11852 interpreted to mean the entire range and as such are equivalent to
11853 @code{0:-1}, as shown in the following example in which the entire first
11854 column is referenced.
11857 #+results: example-table
11863 #+begin_src emacs-lisp :var data=example-table[,0]
11871 It is possible to index into the results of code blocks as well as tables.
11872 Any number of dimensions can be indexed. Dimensions are separated from one
11873 another by commas, as shown in the following example.
11877 #+begin_src emacs-lisp
11878 '(((1 2 3) (4 5 6) (7 8 9))
11879 ((10 11 12) (13 14 15) (16 17 18))
11880 ((19 20 21) (22 23 24) (25 26 27)))
11883 #+begin_src emacs-lisp :var data=3D[1,,1]
11891 @node results, file, var, Specific header arguments
11892 @subsubsection @code{:results}
11894 There are three classes of @code{:results} header argument. Only one option
11895 per class may be supplied per code block.
11899 @b{collection} header arguments specify how the results should be collected
11900 from the code block
11902 @b{type} header arguments specify what type of result the code block will
11903 return---which has implications for how they will be inserted into the
11906 @b{handling} header arguments specify how the results of evaluating the code
11907 block should be handled.
11910 @subsubheading Collection
11911 The following options are mutually exclusive, and specify how the results
11912 should be collected from the code block.
11916 This is the default. The result is the value of the last statement in the
11917 code block. This header argument places the evaluation in functional
11918 mode. Note that in some languages, e.g., Python, use of this result type
11919 requires that a @code{return} statement be included in the body of the source
11920 code block. E.g., @code{:results value}.
11921 @item @code{output}
11922 The result is the collection of everything printed to STDOUT during the
11923 execution of the code block. This header argument places the
11924 evaluation in scripting mode. E.g., @code{:results output}.
11927 @subsubheading Type
11929 The following options are mutually exclusive and specify what type of results
11930 the code block will return. By default, results are inserted as either a
11931 table or scalar depending on their value.
11934 @item @code{table}, @code{vector}
11935 The results should be interpreted as an Org-mode table. If a single value is
11936 returned, it will be converted into a table with one row and one column.
11937 E.g., @code{:results value table}.
11939 The results should be interpreted as an Org-mode list. If a single scalar
11940 value is returned it will be converted into a list with only one element.
11941 @item @code{scalar}, @code{verbatim}
11942 The results should be interpreted literally---they will not be
11943 converted into a table. The results will be inserted into the Org-mode
11944 buffer as quoted text. E.g., @code{:results value verbatim}.
11946 The results will be interpreted as the path to a file, and will be inserted
11947 into the Org-mode buffer as a file link. E.g., @code{:results value file}.
11948 @item @code{raw}, @code{org}
11949 The results are interpreted as raw Org-mode code and are inserted directly
11950 into the buffer. If the results look like a table they will be aligned as
11951 such by Org-mode. E.g., @code{:results value raw}.
11953 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
11954 block. E.g., @code{:results value html}.
11956 Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block.
11957 E.g., @code{:results value latex}.
11959 Result are assumed to be parseable code and are enclosed in a code block.
11960 E.g., @code{:results value code}.
11962 The result is converted to pretty-printed code and is enclosed in a code
11963 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
11964 @code{:results value pp}.
11967 @subsubheading Handling
11968 The following results options indicate what happens with the
11969 results once they are collected.
11972 @item @code{silent}
11973 The results will be echoed in the minibuffer but will not be inserted into
11974 the Org-mode buffer. E.g., @code{:results output silent}.
11975 @item @code{replace}
11976 The default value. Any existing results will be removed, and the new results
11977 will be inserted into the Org-mode buffer in their place. E.g.,
11978 @code{:results output replace}.
11979 @item @code{append}
11980 If there are pre-existing results of the code block then the new results will
11981 be appended to the existing results. Otherwise the new results will be
11982 inserted as with @code{replace}.
11983 @item @code{prepend}
11984 If there are pre-existing results of the code block then the new results will
11985 be prepended to the existing results. Otherwise the new results will be
11986 inserted as with @code{replace}.
11989 @node file, dir, results, Specific header arguments
11990 @subsubsection @code{:file}
11992 The header argument @code{:file} is used to specify an external file in which
11993 to save code block results. After code block evaluation an Org-mode style
11994 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
11995 into the Org-mode buffer. Some languages including R, gnuplot, dot, and
11996 ditaa provide special handling of the @code{:file} header argument
11997 automatically wrapping the code block body in the boilerplate code required
11998 to save output to the specified file. This is often useful for saving
11999 graphical output of a code block to the specified file.
12001 The argument to @code{:file} should be either a string specifying the path to
12002 a file, or a list of two strings in which case the first element of the list
12003 should be the path to a file and the second a description for the link.
12005 @node dir, exports, file, Specific header arguments
12006 @subsubsection @code{:dir} and remote execution
12008 While the @code{:file} header argument can be used to specify the path to the
12009 output file, @code{:dir} specifies the default directory during code block
12010 execution. If it is absent, then the directory associated with the current
12011 buffer is used. In other words, supplying @code{:dir path} temporarily has
12012 the same effect as changing the current directory with @kbd{M-x cd path}, and
12013 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
12014 the value of the Emacs variable @code{default-directory}.
12016 When using @code{:dir}, you should supply a relative path for file output
12017 (e.g. @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
12018 case that path will be interpreted relative to the default directory.
12020 In other words, if you want your plot to go into a folder called @file{Work}
12021 in your home directory, you could use
12024 #+begin_src R :file myplot.png :dir ~/Work
12025 matplot(matrix(rnorm(100), 10), type="l")
12029 @subsubheading Remote execution
12030 A directory on a remote machine can be specified using tramp file syntax, in
12031 which case the code will be evaluated on the remote machine. An example is
12034 #+begin_src R :file plot.png :dir /dand@@yakuba.princeton.edu:
12035 plot(1:10, main=system("hostname", intern=TRUE))
12039 Text results will be returned to the local Org-mode buffer as usual, and file
12040 output will be created on the remote machine with relative paths interpreted
12041 relative to the remote directory. An Org-mode link to the remote file will be
12044 So, in the above example a plot will be created on the remote machine,
12045 and a link of the following form will be inserted in the org buffer:
12048 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
12051 Most of this functionality follows immediately from the fact that @code{:dir}
12052 sets the value of the Emacs variable @code{default-directory}, thanks to
12053 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
12054 install tramp separately in order for these features to work correctly.
12056 @subsubheading Further points
12060 If @code{:dir} is used in conjunction with @code{:session}, although it will
12061 determine the starting directory for a new session as expected, no attempt is
12062 currently made to alter the directory associated with an existing session.
12064 @code{:dir} should typically not be used to create files during export with
12065 @code{:exports results} or @code{:exports both}. The reason is that, in order
12066 to retain portability of exported material between machines, during export
12067 links inserted into the buffer will *not* be expanded against @code{default
12068 directory}. Therefore, if @code{default-directory} is altered using
12069 @code{:dir}, it is probable that the file will be created in a location to
12070 which the link does not point.
12073 @node exports, tangle, dir, Specific header arguments
12074 @subsubsection @code{:exports}
12076 The @code{:exports} header argument specifies what should be included in HTML
12077 or LaTeX exports of the Org-mode file.
12081 The default. The body of code is included into the exported file. E.g.,
12082 @code{:exports code}.
12083 @item @code{results}
12084 The result of evaluating the code is included in the exported file. E.g.,
12085 @code{:exports results}.
12087 Both the code and results are included in the exported file. E.g.,
12088 @code{:exports both}.
12090 Nothing is included in the exported file. E.g., @code{:exports none}.
12093 @node tangle, comments, exports, Specific header arguments
12094 @subsubsection @code{:tangle}
12096 The @code{:tangle} header argument specifies whether or not the code
12097 block should be included in tangled extraction of source code files.
12100 @item @code{tangle}
12101 The code block is exported to a source code file named after the
12102 basename (name w/o extension) of the Org-mode file. E.g., @code{:tangle
12105 The default. The code block is not exported to a source code file.
12106 E.g., @code{:tangle no}.
12108 Any other string passed to the @code{:tangle} header argument is interpreted
12109 as a file basename to which the block will be exported. E.g., @code{:tangle
12113 @node comments, no-expand, tangle, Specific header arguments
12114 @subsubsection @code{:comments}
12115 By default code blocks are tangled to source-code files without any insertion
12116 of comments beyond those which may already exist in the body of the code
12117 block. The @code{:comments} header argument can be set as follows to control
12118 the insertion of extra comments into the tangled code file.
12122 The default. No extra comments are inserted during tangling.
12124 The code block is wrapped in comments which contain pointers back to the
12125 original Org file from which the code was tangled.
12127 A synonym for ``link'' to maintain backwards compatibility.
12129 Include text from the org-mode file as a comment.
12131 The text is picked from the leading context of the tangled code and is
12132 limited by the nearest headline or source block as the case may be.
12134 Turns on both the ``link'' and ``org'' comment options.
12136 Turns on the ``link'' comment option, and additionally wraps expanded noweb
12137 references in the code block body in link comments.
12140 @node no-expand, session, comments, Specific header arguments
12141 @subsubsection @code{:no-expand}
12143 By default, code blocks are expanded with @code{org-babel-expand-src-block}
12144 during tangling. This has the effect of assigning values to variables
12145 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
12146 references (see @ref{Noweb reference syntax}) with their targets. The
12147 @code{:no-expand} header argument can be used to turn off this behavior.
12149 @node session, noweb, no-expand, Specific header arguments
12150 @subsubsection @code{:session}
12152 The @code{:session} header argument starts a session for an interpreted
12153 language where state is preserved.
12155 By default, a session is not started.
12157 A string passed to the @code{:session} header argument will give the session
12158 a name. This makes it possible to run concurrent sessions for each
12159 interpreted language.
12161 @node noweb, cache, session, Specific header arguments
12162 @subsubsection @code{:noweb}
12164 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
12165 @ref{Noweb reference syntax}) references in a code block. This header
12166 argument can have one of three values: @code{yes} @code{no} or @code{tangle}.
12170 All ``noweb'' syntax references in the body of the code block will be
12171 expanded before the block is evaluated, tangled or exported.
12173 The default. No ``noweb'' syntax specific action is taken on evaluating
12174 code blocks, However, noweb references will still be expanded during
12176 @item @code{tangle}
12177 All ``noweb'' syntax references in the body of the code block will be
12178 expanded before the block is tangled, however ``noweb'' references will not
12179 be expanded when the block is evaluated or exported.
12182 @subsubheading Noweb prefix lines
12183 Noweb insertions are now placed behind the line prefix of the
12184 @code{<<reference>>}.
12185 This behavior is illustrated in the following example. Because the
12186 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
12187 each line of the expanded noweb reference will be commented.
12200 -- multi-line body of example
12203 Note that noweb replacement text that does not contain any newlines will not
12204 be affected by this change, so it is still possible to use inline noweb
12207 @node cache, sep, noweb, Specific header arguments
12208 @subsubsection @code{:cache}
12210 The @code{:cache} header argument controls the use of in-buffer caching of
12211 the results of evaluating code blocks. It can be used to avoid re-evaluating
12212 unchanged code blocks. This header argument can have one of two
12213 values: @code{yes} or @code{no}.
12217 The default. No caching takes place, and the code block will be evaluated
12218 every time it is called.
12220 Every time the code block is run a SHA1 hash of the code and arguments
12221 passed to the block will be generated. This hash is packed into the
12222 @code{#+results:} line and will be checked on subsequent
12223 executions of the code block. If the code block has not
12224 changed since the last time it was evaluated, it will not be re-evaluated.
12227 Code block caches notice if the value of a variable argument
12228 to the code block has changed. If this is the case, the cache is
12229 invalidated and the code block is re-run. In the following example,
12230 @code{caller} will not be re-run unless the results of @code{random} have
12231 changed since it was last run.
12235 #+begin_src R :cache yes
12239 #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
12243 #+begin_src emacs-lisp :var x=random :cache yes
12247 #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
12251 @node sep, hlines, cache, Specific header arguments
12252 @subsubsection @code{:sep}
12254 The @code{:sep} header argument can be used to control the delimiter used
12255 when writing tabular results out to files external to Org-mode. This is used
12256 either when opening tabular results of a code block by calling the
12257 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
12258 or when writing code block results to an external file (see @ref{file})
12261 By default, when @code{:sep} is not specified output tables are tab
12264 @node hlines, colnames, sep, Specific header arguments
12265 @subsubsection @code{:hlines}
12267 Tables are frequently represented with one or more horizontal lines, or
12268 hlines. The @code{:hlines} argument to a code block accepts the
12269 values @code{yes} or @code{no}, with a default value of @code{no}.
12273 Strips horizontal lines from the input table. In most languages this is the
12274 desired effect because an @code{hline} symbol is interpreted as an unbound
12275 variable and raises an error. Setting @code{:hlines no} or relying on the
12276 default value yields the following results.
12279 #+tblname: many-cols
12286 #+source: echo-table
12287 #+begin_src python :var tab=many-cols
12291 #+results: echo-table
12298 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
12301 #+tblname: many-cols
12308 #+source: echo-table
12309 #+begin_src python :var tab=many-cols :hlines yes
12313 #+results: echo-table
12322 @node colnames, rownames, hlines, Specific header arguments
12323 @subsubsection @code{:colnames}
12325 The @code{:colnames} header argument accepts the values @code{yes},
12326 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
12330 If an input table looks like it has column names
12331 (because its second row is an hline), then the column
12332 names will be removed from the table before
12333 processing, then reapplied to the results.
12336 #+tblname: less-cols
12342 #+srcname: echo-table-again
12343 #+begin_src python :var tab=less-cols
12344 return [[val + '*' for val in row] for row in tab]
12347 #+results: echo-table-again
12355 No column name pre-processing takes place
12358 Column names are removed and reapplied as with @code{nil} even if the table
12359 does not ``look like'' it has column names (i.e. the second row is not an
12363 @node rownames, shebang, colnames, Specific header arguments
12364 @subsubsection @code{:rownames}
12366 The @code{:rownames} header argument can take on the values @code{yes}
12367 or @code{no}, with a default value of @code{no}.
12371 No row name pre-processing will take place.
12374 The first column of the table is removed from the table before processing,
12375 and is then reapplied to the results.
12378 #+tblname: with-rownames
12379 | one | 1 | 2 | 3 | 4 | 5 |
12380 | two | 6 | 7 | 8 | 9 | 10 |
12382 #+srcname: echo-table-once-again
12383 #+begin_src python :var tab=with-rownames :rownames yes
12384 return [[val + 10 for val in row] for row in tab]
12387 #+results: echo-table-once-again
12388 | one | 11 | 12 | 13 | 14 | 15 |
12389 | two | 16 | 17 | 18 | 19 | 20 |
12393 @node shebang, eval, rownames, Specific header arguments
12394 @subsubsection @code{:shebang}
12396 Setting the @code{:shebang} header argument to a string value
12397 (e.g. @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
12398 first line of any tangled file holding the code block, and the file
12399 permissions of the tangled file are set to make it executable.
12401 @node eval, , shebang, Specific header arguments
12402 @subsubsection @code{:eval}
12403 The @code{:eval} header argument can be used to limit the evaluation of
12404 specific code blocks. @code{:eval} accepts two arguments ``never'' and
12405 ``query''. @code{:eval never} will ensure that a code block is never
12406 evaluated, this can be useful for protecting against the evaluation of
12407 dangerous code blocks. @code{:eval query} will require a query for every
12408 execution of a code block regardless of the value of the
12409 @code{org-confirm-babel-evaluate} variable.
12411 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
12412 @section Results of evaluation
12413 @cindex code block, results of evaluation
12414 @cindex source code, results of evaluation
12416 The way in which results are handled depends on whether a session is invoked,
12417 as well as on whether @code{:results value} or @code{:results output} is
12418 used. The following table shows the table possibilities. For a full listing
12419 of the possible results header arguments see @ref{results}.
12421 @multitable @columnfractions 0.26 0.33 0.41
12422 @item @tab @b{Non-session} @tab @b{Session}
12423 @item @code{:results value} @tab value of last expression @tab value of last expression
12424 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
12427 Note: With @code{:results value}, the result in both @code{:session} and
12428 non-session is returned to Org-mode as a table (a one- or two-dimensional
12429 vector of strings or numbers) when appropriate.
12431 @subsection Non-session
12432 @subsubsection @code{:results value}
12433 This is the default. Internally, the value is obtained by wrapping the code
12434 in a function definition in the external language, and evaluating that
12435 function. Therefore, code should be written as if it were the body of such a
12436 function. In particular, note that Python does not automatically return a
12437 value from a function unless a @code{return} statement is present, and so a
12438 @samp{return} statement will usually be required in Python.
12440 This is the only one of the four evaluation contexts in which the code is
12441 automatically wrapped in a function definition.
12443 @subsubsection @code{:results output}
12444 The code is passed to the interpreter as an external process, and the
12445 contents of the standard output stream are returned as text. (In certain
12446 languages this also contains the error output stream; this is an area for
12449 @subsection Session
12450 @subsubsection @code{:results value}
12451 The code is passed to the interpreter running as an interactive Emacs
12452 inferior process. The result returned is the result of the last evaluation
12453 performed by the interpreter. (This is obtained in a language-specific
12454 manner: the value of the variable @code{_} in Python and Ruby, and the value
12455 of @code{.Last.value} in R).
12457 @subsubsection @code{:results output}
12458 The code is passed to the interpreter running as an interactive Emacs
12459 inferior process. The result returned is the concatenation of the sequence of
12460 (text) output from the interactive interpreter. Notice that this is not
12461 necessarily the same as what would be sent to @code{STDOUT} if the same code
12462 were passed to a non-interactive interpreter running as an external
12463 process. For example, compare the following two blocks:
12466 #+begin_src python :results output
12477 In non-session mode, the `2' is not printed and does not appear.
12479 #+begin_src python :results output :session
12491 But in @code{:session} mode, the interactive interpreter receives input `2'
12492 and prints out its value, `2'. (Indeed, the other print statements are
12495 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
12496 @section Noweb reference syntax
12497 @cindex code block, noweb reference
12498 @cindex syntax, noweb
12499 @cindex source code, noweb reference
12501 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
12502 Programming system allows named blocks of code to be referenced by using the
12503 familiar Noweb syntax:
12506 <<code-block-name>>
12509 When a code block is tangled or evaluated, whether or not ``noweb''
12510 references are expanded depends upon the value of the @code{:noweb} header
12511 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
12512 evaluation. If @code{:noweb no}, the default, then the reference is not
12513 expanded before evaluation.
12515 Note: the default value, @code{:noweb no}, was chosen to ensure that
12516 correct code is not broken in a language, such as Ruby, where
12517 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
12518 syntactically valid in languages that you use, then please consider setting
12521 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
12522 @section Key bindings and useful functions
12523 @cindex code block, key bindings
12525 Many common Org-mode key sequences are re-bound depending on
12528 Within a code block, the following key bindings
12531 @multitable @columnfractions 0.25 0.75
12533 @item @kbd{C-c C-c} @tab org-babel-execute-src-block
12535 @item @kbd{C-c C-o} @tab org-babel-open-src-block-result
12537 @item @kbd{C-@key{up}} @tab org-babel-load-in-session
12539 @item @kbd{M-@key{down}} @tab org-babel-pop-to-session
12542 In an Org-mode buffer, the following key bindings are active:
12544 @multitable @columnfractions 0.45 0.55
12546 @kindex C-c C-v C-a
12547 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab org-babel-sha1-hash
12549 @kindex C-c C-v C-b
12550 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
12552 @kindex C-c C-v C-f
12553 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab org-babel-tangle-file
12555 @item @kbd{C-c C-v g} @tab org-babel-goto-named-source-block
12557 @item @kbd{C-c C-v h} @tab org-babel-describe-bindings
12559 @kindex C-c C-v C-l
12560 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
12562 @kindex C-c C-v C-p
12563 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
12565 @kindex C-c C-v C-s
12566 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
12568 @kindex C-c C-v C-t
12569 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab org-babel-tangle
12571 @kindex C-c C-v C-z
12572 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
12575 @c When possible these keybindings were extended to work when the control key is
12576 @c kept pressed, resulting in the following additional keybindings.
12578 @c @multitable @columnfractions 0.25 0.75
12579 @c @item @kbd{C-c C-v C-a} @tab org-babel-sha1-hash
12580 @c @item @kbd{C-c C-v C-b} @tab org-babel-execute-buffer
12581 @c @item @kbd{C-c C-v C-f} @tab org-babel-tangle-file
12582 @c @item @kbd{C-c C-v C-l} @tab org-babel-lob-ingest
12583 @c @item @kbd{C-c C-v C-p} @tab org-babel-expand-src-block
12584 @c @item @kbd{C-c C-v C-s} @tab org-babel-execute-subtree
12585 @c @item @kbd{C-c C-v C-t} @tab org-babel-tangle
12586 @c @item @kbd{C-c C-v C-z} @tab org-babel-switch-to-session
12589 @node Batch execution, , Key bindings and useful functions, Working With Source Code
12590 @section Batch execution
12591 @cindex code block, batch execution
12592 @cindex source code, batch execution
12594 It is possible to call functions from the command line. This shell
12595 script calls @code{org-babel-tangle} on every one of its arguments.
12597 Be sure to adjust the paths to fit your system.
12601 # -*- mode: shell-script -*-
12603 # tangle files with org-mode
12607 ORGINSTALL="~/src/org/lisp/org-install.el"
12609 # wrap each argument in the code required to call tangle on it
12611 FILES="$FILES \"$i\""
12614 emacs -Q --batch -l $ORGINSTALL \
12616 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
12617 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
12618 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
12619 (mapc (lambda (file)
12620 (find-file (expand-file-name file \"$DIR\"))
12622 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
12625 @node Miscellaneous, Hacking, Working With Source Code, Top
12626 @chapter Miscellaneous
12629 * Completion:: M-TAB knows what you need
12630 * Easy Templates:: Quick insertion of structural elements
12631 * Speed keys:: Electric commands at the beginning of a headline
12632 * Code evaluation security:: Org mode files evaluate inline code
12633 * Customization:: Adapting Org to your taste
12634 * In-buffer settings:: Overview of the #+KEYWORDS
12635 * The very busy C-c C-c key:: When in doubt, press C-c C-c
12636 * Clean view:: Getting rid of leading stars in the outline
12637 * TTY keys:: Using Org on a tty
12638 * Interaction:: Other Emacs packages
12642 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
12643 @section Completion
12644 @cindex completion, of @TeX{} symbols
12645 @cindex completion, of TODO keywords
12646 @cindex completion, of dictionary words
12647 @cindex completion, of option keywords
12648 @cindex completion, of tags
12649 @cindex completion, of property keys
12650 @cindex completion, of link abbreviations
12651 @cindex @TeX{} symbol completion
12652 @cindex TODO keywords completion
12653 @cindex dictionary word completion
12654 @cindex option keyword completion
12655 @cindex tag completion
12656 @cindex link abbreviations, completion of
12658 Emacs would not be Emacs without completion, and Org-mode uses it whenever it
12659 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
12660 some of the completion prompts, you can specify your preference by setting at
12661 most one of the variables @code{org-completion-use-iswitchb}
12662 @code{org-completion-use-ido}.
12664 Org supports in-buffer completion. This type of completion does
12665 not make use of the minibuffer. You simply type a few letters into
12666 the buffer and use the key to complete text right there.
12669 @kindex M-@key{TAB}
12671 Complete word at point
12674 At the beginning of a headline, complete TODO keywords.
12676 After @samp{\}, complete @TeX{} symbols supported by the exporter.
12678 After @samp{*}, complete headlines in the current buffer so that they
12679 can be used in search links like @samp{[[*find this headline]]}.
12681 After @samp{:} in a headline, complete tags. The list of tags is taken
12682 from the variable @code{org-tag-alist} (possibly set through the
12683 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
12684 dynamically from all tags used in the current buffer.
12686 After @samp{:} and not in a headline, complete property keys. The list
12687 of keys is constructed dynamically from all keys used in the current
12690 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
12692 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
12693 @samp{OPTIONS} which set file-specific options for Org-mode. When the
12694 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
12695 will insert example settings for this keyword.
12697 In the line after @samp{#+STARTUP: }, complete startup keywords,
12698 i.e. valid keys for this line.
12700 Elsewhere, complete dictionary words using Ispell.
12704 @node Easy Templates, Speed keys, Completion, Miscellaneous
12705 @section Easy Templates
12706 @cindex template insertion
12707 @cindex insertion, of templates
12709 Org-mode supports insertion of empty structural elements (like
12710 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
12711 strokes. This is achieved through a native template expansion mechanism.
12712 Note that Emacs has several other template mechanisms which could be used in
12713 a similar way, for example @file{yasnippet}.
12715 To insert a structural element, type a @samp{<}, followed by a template
12716 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
12717 keystrokes are typed on a line by itself.
12719 The following template selectors are currently supported.
12721 @multitable @columnfractions 0.1 0.9
12722 @item @kbd{s} @tab @code{#+begin_src ... #+end_src}
12723 @item @kbd{e} @tab @code{#+begin_example ... #+end_example}
12724 @item @kbd{q} @tab @code{#+begin_quote ... #+end_quote}
12725 @item @kbd{v} @tab @code{#+begin_verse ... #+end_verse}
12726 @item @kbd{c} @tab @code{#+begin_center ... #+end_center}
12727 @item @kbd{l} @tab @code{#+begin_latex ... #+end_latex}
12728 @item @kbd{L} @tab @code{#+latex:}
12729 @item @kbd{h} @tab @code{#+begin_html ... #+end_html}
12730 @item @kbd{H} @tab @code{#+html:}
12731 @item @kbd{a} @tab @code{#+begin_ascii ... #+end_ascii}
12732 @item @kbd{A} @tab @code{#+ascii:}
12733 @item @kbd{i} @tab @code{#+include:} line
12736 For example, on an empty line, typing "<e" and then pressing TAB, will expand
12737 into a complete EXAMPLE template.
12739 You can install additional templates by customizing the variable
12740 @code{org-structure-template-alist}. See the docstring of the variable for
12741 additional details.
12743 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
12744 @section Speed keys
12746 @vindex org-use-speed-commands
12747 @vindex org-speed-commands-user
12749 Single keys can be made to execute commands when the cursor is at the
12750 beginning of a headline, i.e. before the first star. Configure the variable
12751 @code{org-use-speed-commands} to activate this feature. There is a
12752 pre-defined list of commands, and you can add more such commands using the
12753 variable @code{org-speed-commands-user}. Speed keys do not only speed up
12754 navigation and other commands, but they also provide an alternative way to
12755 execute commands bound to keys that are not or not easily available on a TTY,
12756 or on a small mobile device with a limited keyboard.
12758 To see which commands are available, activate the feature and press @kbd{?}
12759 with the cursor at the beginning of a headline.
12761 @node Code evaluation security, Customization, Speed keys, Miscellaneous
12762 @section Code evaluation and security issues
12764 Org provides tools to work with the code snippets, including evaluating them.
12766 Running code on your machine always comes with a security risk. Badly
12767 written or malicious code can be executed on purpose or by accident. Org has
12768 default settings which will only evaluate such code if you give explicit
12769 permission to do so, and as a casual user of these features you should leave
12770 these precautions intact.
12772 For people who regularly work with such code, the confirmation prompts can
12773 become annoying, and you might want to turn them off. This can be done, but
12774 you must be aware of the risks that are involved.
12776 Code evaluation can happen under the following circumstances:
12779 @item Source code blocks
12780 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
12781 C-c} in the block. The most important thing to realize here is that Org mode
12782 files which contain code snippets are, in a certain sense, like executable
12783 files. So you should accept them and load them into Emacs only from trusted
12784 sources---just like you would do with a program you install on your computer.
12786 Make sure you know what you are doing before customizing the variables
12787 which take off the default security brakes.
12789 @defopt org-confirm-babel-evaluate
12790 When t (the default), the user is asked before every code block evaluation.
12791 When nil, the user is not asked. When set to a function, it is called with
12792 two arguments (language and body of the code block) and should return t to
12793 ask and nil not to ask.
12796 For example, here is how to execute "ditaa" code (which is considered safe)
12799 (defun my-org-confirm-babel-evaluate (lang body)
12800 (not (string= lang "ditaa"))) ; don't ask for ditaa
12801 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
12804 @item Following @code{shell} and @code{elisp} links
12805 Org has two link types that can directly evaluate code (@pxref{External
12806 links}). These links can be problematic because the code to be evaluated is
12809 @defopt org-confirm-shell-link-function
12810 Function to queries user about shell link execution.
12812 @defopt org-confirm-elisp-link-function
12813 Functions to query user for Emacs Lisp link execution.
12816 @item Formulas in tables
12817 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
12818 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
12821 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
12822 @section Customization
12823 @cindex customization
12824 @cindex options, for customization
12825 @cindex variables, for customization
12827 There are more than 180 variables that can be used to customize
12828 Org. For the sake of compactness of the manual, I am not
12829 describing the variables here. A structured overview of customization
12830 variables is available with @kbd{M-x org-customize}. Or select
12831 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
12832 settings can also be activated on a per-file basis, by putting special
12833 lines into the buffer (@pxref{In-buffer settings}).
12835 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
12836 @section Summary of in-buffer settings
12837 @cindex in-buffer settings
12838 @cindex special keywords
12840 Org-mode uses special lines in the buffer to define settings on a
12841 per-file basis. These lines start with a @samp{#+} followed by a
12842 keyword, a colon, and then individual words defining a setting. Several
12843 setting words can be in the same line, but you can also have multiple
12844 lines for the keyword. While these settings are described throughout
12845 the manual, here is a summary. After changing any of those lines in the
12846 buffer, press @kbd{C-c C-c} with the cursor still in the line to
12847 activate the changes immediately. Otherwise they become effective only
12848 when the file is visited again in a new Emacs session.
12850 @vindex org-archive-location
12852 @item #+ARCHIVE: %s_done::
12853 This line sets the archive location for the agenda file. It applies for
12854 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
12855 of the file. The first such line also applies to any entries before it.
12856 The corresponding variable is @code{org-archive-location}.
12858 This line sets the category for the agenda file. The category applies
12859 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
12860 end of the file. The first such line also applies to any entries before it.
12861 @item #+COLUMNS: %25ITEM .....
12862 @cindex property, COLUMNS
12863 Set the default format for columns view. This format applies when
12864 columns view is invoked in locations where no @code{COLUMNS} property
12866 @item #+CONSTANTS: name1=value1 ...
12867 @vindex org-table-formula-constants
12868 @vindex org-table-formula
12869 Set file-local values for constants to be used in table formulas. This
12870 line sets the local variable @code{org-table-formula-constants-local}.
12871 The global version of this variable is
12872 @code{org-table-formula-constants}.
12873 @item #+FILETAGS: :tag1:tag2:tag3:
12874 Set tags that can be inherited by any entry in the file, including the
12876 @item #+DRAWERS: NAME1 .....
12877 @vindex org-drawers
12878 Set the file-local set of drawers. The corresponding global variable is
12879 @code{org-drawers}.
12880 @item #+LINK: linkword replace
12881 @vindex org-link-abbrev-alist
12882 These lines (several are allowed) specify link abbreviations.
12883 @xref{Link abbreviations}. The corresponding variable is
12884 @code{org-link-abbrev-alist}.
12885 @item #+PRIORITIES: highest lowest default
12886 @vindex org-highest-priority
12887 @vindex org-lowest-priority
12888 @vindex org-default-priority
12889 This line sets the limits and the default for the priorities. All three
12890 must be either letters A-Z or numbers 0-9. The highest priority must
12891 have a lower ASCII number than the lowest priority.
12892 @item #+PROPERTY: Property_Name Value
12893 This line sets a default inheritance value for entries in the current
12894 buffer, most useful for specifying the allowed values of a property.
12895 @cindex #+SETUPFILE
12896 @item #+SETUPFILE: file
12897 This line defines a file that holds more in-buffer setup. Normally this is
12898 entirely ignored. Only when the buffer is parsed for option-setting lines
12899 (i.e. when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a
12900 settings line, or when exporting), then the contents of this file are parsed
12901 as if they had been included in the buffer. In particular, the file can be
12902 any other Org-mode file with internal setup. You can visit the file the
12903 cursor is in the line with @kbd{C-c '}.
12906 This line sets options to be used at startup of Org-mode, when an
12907 Org file is being visited.
12909 The first set of options deals with the initial visibility of the outline
12910 tree. The corresponding variable for global default settings is
12911 @code{org-startup-folded}, with a default value @code{t}, which means
12913 @vindex org-startup-folded
12914 @cindex @code{overview}, STARTUP keyword
12915 @cindex @code{content}, STARTUP keyword
12916 @cindex @code{showall}, STARTUP keyword
12917 @cindex @code{showeverything}, STARTUP keyword
12919 overview @r{top-level headlines only}
12920 content @r{all headlines}
12921 showall @r{no folding of any entries}
12922 showeverything @r{show even drawer contents}
12925 @vindex org-startup-indented
12926 @cindex @code{indent}, STARTUP keyword
12927 @cindex @code{noindent}, STARTUP keyword
12928 Dynamic virtual indentation is controlled by the variable
12929 @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
12931 indent @r{start with @code{org-indent-mode} turned on}
12932 noindent @r{start with @code{org-indent-mode} turned off}
12935 @vindex org-startup-align-all-tables
12936 Then there are options for aligning tables upon visiting a file. This
12937 is useful in files containing narrowed table columns. The corresponding
12938 variable is @code{org-startup-align-all-tables}, with a default value
12940 @cindex @code{align}, STARTUP keyword
12941 @cindex @code{noalign}, STARTUP keyword
12943 align @r{align all tables}
12944 noalign @r{don't align tables on startup}
12947 @vindex org-startup-with-inline-images
12948 When visiting a file, inline images can be automatically displayed. The
12949 corresponding variable is @code{org-startup-with-inline-images}, with a
12950 default value @code{nil} to avoid delays when visiting a file.
12951 @cindex @code{inlineimages}, STARTUP keyword
12952 @cindex @code{noinlineimages}, STARTUP keyword
12954 inlineimages @r{show inline images}
12955 noinlineimages @r{don't show inline images on startup}
12958 @vindex org-log-done
12959 @vindex org-log-note-clock-out
12960 @vindex org-log-repeat
12961 Logging the closing and reopening of TODO items and clock intervals can be
12962 configured using these options (see variables @code{org-log-done},
12963 @code{org-log-note-clock-out} and @code{org-log-repeat})
12964 @cindex @code{logdone}, STARTUP keyword
12965 @cindex @code{lognotedone}, STARTUP keyword
12966 @cindex @code{nologdone}, STARTUP keyword
12967 @cindex @code{lognoteclock-out}, STARTUP keyword
12968 @cindex @code{nolognoteclock-out}, STARTUP keyword
12969 @cindex @code{logrepeat}, STARTUP keyword
12970 @cindex @code{lognoterepeat}, STARTUP keyword
12971 @cindex @code{nologrepeat}, STARTUP keyword
12972 @cindex @code{logreschedule}, STARTUP keyword
12973 @cindex @code{lognotereschedule}, STARTUP keyword
12974 @cindex @code{nologreschedule}, STARTUP keyword
12975 @cindex @code{logredeadline}, STARTUP keyword
12976 @cindex @code{lognoteredeadline}, STARTUP keyword
12977 @cindex @code{nologredeadline}, STARTUP keyword
12978 @cindex @code{logrefile}, STARTUP keyword
12979 @cindex @code{lognoterefile}, STARTUP keyword
12980 @cindex @code{nologrefile}, STARTUP keyword
12982 logdone @r{record a timestamp when an item is marked DONE}
12983 lognotedone @r{record timestamp and a note when DONE}
12984 nologdone @r{don't record when items are marked DONE}
12985 logrepeat @r{record a time when reinstating a repeating item}
12986 lognoterepeat @r{record a note when reinstating a repeating item}
12987 nologrepeat @r{do not record when reinstating repeating item}
12988 lognoteclock-out @r{record a note when clocking out}
12989 nolognoteclock-out @r{don't record a note when clocking out}
12990 logreschedule @r{record a timestamp when scheduling time changes}
12991 lognotereschedule @r{record a note when scheduling time changes}
12992 nologreschedule @r{do not record when a scheduling date changes}
12993 logredeadline @r{record a timestamp when deadline changes}
12994 lognoteredeadline @r{record a note when deadline changes}
12995 nologredeadline @r{do not record when a deadline date changes}
12996 logrefile @r{record a timestamp when refiling}
12997 lognoterefile @r{record a note when refiling}
12998 nologrefile @r{do not record when refiling}
13000 @vindex org-hide-leading-stars
13001 @vindex org-odd-levels-only
13002 Here are the options for hiding leading stars in outline headings, and for
13003 indenting outlines. The corresponding variables are
13004 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
13005 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
13006 @cindex @code{hidestars}, STARTUP keyword
13007 @cindex @code{showstars}, STARTUP keyword
13008 @cindex @code{odd}, STARTUP keyword
13009 @cindex @code{even}, STARTUP keyword
13011 hidestars @r{make all but one of the stars starting a headline invisible.}
13012 showstars @r{show all stars starting a headline}
13013 indent @r{virtual indentation according to outline level}
13014 noindent @r{no virtual indentation according to outline level}
13015 odd @r{allow only odd outline levels (1,3,...)}
13016 oddeven @r{allow all outline levels}
13018 @vindex org-put-time-stamp-overlays
13019 @vindex org-time-stamp-overlay-formats
13020 To turn on custom format overlays over timestamps (variables
13021 @code{org-put-time-stamp-overlays} and
13022 @code{org-time-stamp-overlay-formats}), use
13023 @cindex @code{customtime}, STARTUP keyword
13025 customtime @r{overlay custom time format}
13027 @vindex constants-unit-system
13028 The following options influence the table spreadsheet (variable
13029 @code{constants-unit-system}).
13030 @cindex @code{constcgs}, STARTUP keyword
13031 @cindex @code{constSI}, STARTUP keyword
13033 constcgs @r{@file{constants.el} should use the c-g-s unit system}
13034 constSI @r{@file{constants.el} should use the SI unit system}
13036 @vindex org-footnote-define-inline
13037 @vindex org-footnote-auto-label
13038 @vindex org-footnote-auto-adjust
13039 To influence footnote settings, use the following keywords. The
13040 corresponding variables are @code{org-footnote-define-inline},
13041 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
13042 @cindex @code{fninline}, STARTUP keyword
13043 @cindex @code{nofninline}, STARTUP keyword
13044 @cindex @code{fnlocal}, STARTUP keyword
13045 @cindex @code{fnprompt}, STARTUP keyword
13046 @cindex @code{fnauto}, STARTUP keyword
13047 @cindex @code{fnconfirm}, STARTUP keyword
13048 @cindex @code{fnplain}, STARTUP keyword
13049 @cindex @code{fnadjust}, STARTUP keyword
13050 @cindex @code{nofnadjust}, STARTUP keyword
13052 fninline @r{define footnotes inline}
13053 fnnoinline @r{define footnotes in separate section}
13054 fnlocal @r{define footnotes near first reference, but not inline}
13055 fnprompt @r{prompt for footnote labels}
13056 fnauto @r{create [fn:1]-like labels automatically (default)}
13057 fnconfirm @r{offer automatic label for editing or confirmation}
13058 fnplain @r{create [1]-like labels automatically}
13059 fnadjust @r{automatically renumber and sort footnotes}
13060 nofnadjust @r{do not renumber and sort automatically}
13062 @cindex org-hide-block-startup
13063 To hide blocks on startup, use these keywords. The corresponding variable is
13064 @code{org-hide-block-startup}.
13065 @cindex @code{hideblocks}, STARTUP keyword
13066 @cindex @code{nohideblocks}, STARTUP keyword
13068 hideblocks @r{Hide all begin/end blocks on startup}
13069 nohideblocks @r{Do not hide blocks on startup}
13071 @cindex org-pretty-entities
13072 The display of entities as UTF-8 characters is governed by the variable
13073 @code{org-pretty-entities} and the keywords
13074 @cindex @code{entitiespretty}, STARTUP keyword
13075 @cindex @code{entitiesplain}, STARTUP keyword
13077 entitiespretty @r{Show entities as UTF-8 characters where possible}
13078 entitiesplain @r{Leave entities plain}
13080 @item #+TAGS: TAG1(c1) TAG2(c2)
13081 @vindex org-tag-alist
13082 These lines (several such lines are allowed) specify the valid tags in
13083 this file, and (potentially) the corresponding @emph{fast tag selection}
13084 keys. The corresponding variable is @code{org-tag-alist}.
13086 This line contains the formulas for the table directly above the line.
13087 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
13088 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
13089 @itemx #+DESCRIPTION:, #+KEYWORDS:,
13090 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
13091 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
13092 These lines provide settings for exporting files. For more details see
13093 @ref{Export options}.
13094 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
13095 @vindex org-todo-keywords
13096 These lines set the TODO keywords and their interpretation in the
13097 current file. The corresponding variable is @code{org-todo-keywords}.
13100 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
13101 @section The very busy C-c C-c key
13103 @cindex C-c C-c, overview
13105 The key @kbd{C-c C-c} has many purposes in Org, which are all
13106 mentioned scattered throughout this manual. One specific function of
13107 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
13108 other circumstances it means something like @emph{``Hey Org, look
13109 here and update according to what you see here''}. Here is a summary of
13110 what this means in different contexts.
13114 If there are highlights in the buffer from the creation of a sparse
13115 tree, or from clock display, remove these highlights.
13117 If the cursor is in one of the special @code{#+KEYWORD} lines, this
13118 triggers scanning the buffer for these lines and updating the
13121 If the cursor is inside a table, realign the table. This command
13122 works even if the automatic table editor has been turned off.
13124 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
13127 If the current buffer is a capture buffer, close the note and file it.
13128 With a prefix argument, file it, without further interaction, to the
13131 If the cursor is on a @code{<<<target>>>}, update radio targets and
13132 corresponding links in this buffer.
13134 If the cursor is in a property line or at the start or end of a property
13135 drawer, offer property commands.
13137 If the cursor is at a footnote reference, go to the corresponding
13138 definition, and vice versa.
13140 If the cursor is on a statistics cookie, update it.
13142 If the cursor is in a plain list item with a checkbox, toggle the status
13145 If the cursor is on a numbered item in a plain list, renumber the
13148 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
13152 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
13153 @section A cleaner outline view
13154 @cindex hiding leading stars
13155 @cindex dynamic indentation
13156 @cindex odd-levels-only outlines
13157 @cindex clean outline view
13159 Some people find it noisy and distracting that the Org headlines start with a
13160 potentially large number of stars, and that text below the headlines is not
13161 indented. While this is no problem when writing a @emph{book-like} document
13162 where the outline headings are really section headings, in a more
13163 @emph{list-oriented} outline, indented structure is a lot cleaner:
13167 * Top level headline | * Top level headline
13168 ** Second level | * Second level
13169 *** 3rd level | * 3rd level
13170 some text | some text
13171 *** 3rd level | * 3rd level
13172 more text | more text
13173 * Another top level headline | * Another top level headline
13179 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
13180 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
13181 be achieved dynamically at display time using @code{org-indent-mode}. In
13182 this minor mode, all lines are prefixed for display with the necessary amount
13183 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
13184 property, such that @code{visual-line-mode} (or purely setting
13185 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
13186 }. Also headlines are prefixed with additional stars, so that the amount of
13187 indentation shifts by two@footnote{See the variable
13188 @code{org-indent-indentation-per-level}.} spaces per level. All headline
13189 stars but the last one are made invisible using the @code{org-hide}
13190 face@footnote{Turning on @code{org-indent-mode} sets
13191 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
13192 @code{nil}.} - see below under @samp{2.} for more information on how this
13193 works. You can turn on @code{org-indent-mode} for all files by customizing
13194 the variable @code{org-startup-indented}, or you can turn it on for
13195 individual files using
13201 If you want a similar effect in an earlier version of Emacs and/or Org, or if
13202 you want the indentation to be hard space characters so that the plain text
13203 file looks as similar as possible to the Emacs display, Org supports you in
13208 @emph{Indentation of text below headlines}@*
13209 You may indent text below each headline to make the left boundary line up
13210 with the headline, like
13214 more text, now indented
13217 @vindex org-adapt-indentation
13218 Org supports this with paragraph filling, line wrapping, and structure
13219 editing@footnote{See also the variable @code{org-adapt-indentation}.},
13220 preserving or adapting the indentation as appropriate.
13223 @vindex org-hide-leading-stars
13224 @emph{Hiding leading stars}@* You can modify the display in such a way that
13225 all leading stars become invisible. To do this in a global way, configure
13226 the variable @code{org-hide-leading-stars} or change this on a per-file basis
13230 #+STARTUP: hidestars
13231 #+STARTUP: showstars
13234 With hidden stars, the tree becomes:
13238 * Top level headline
13246 @vindex org-hide @r{(face)}
13247 The leading stars are not truly replaced by whitespace, they are only
13248 fontified with the face @code{org-hide} that uses the background color as
13249 font color. If you are not using either white or black background, you may
13250 have to customize this face to get the wanted effect. Another possibility is
13251 to set this font such that the extra stars are @i{almost} invisible, for
13252 example using the color @code{grey90} on a white background.
13255 @vindex org-odd-levels-only
13256 Things become cleaner still if you skip all the even levels and use only odd
13257 levels 1, 3, 5..., effectively adding two stars to go from one outline level
13258 to the next@footnote{When you need to specify a level for a property search
13259 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
13260 way we get the outline view shown at the beginning of this section. In order
13261 to make the structure editing and export commands handle this convention
13262 correctly, configure the variable @code{org-odd-levels-only}, or set this on
13263 a per-file basis with one of the following lines:
13270 You can convert an Org file from single-star-per-level to the
13271 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
13272 RET} in that file. The reverse operation is @kbd{M-x
13273 org-convert-to-oddeven-levels}.
13276 @node TTY keys, Interaction, Clean view, Miscellaneous
13277 @section Using Org on a tty
13278 @cindex tty key bindings
13280 Because Org contains a large number of commands, by default many of
13281 Org's core commands are bound to keys that are generally not
13282 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
13283 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
13284 together with modifiers like @key{Meta} and/or @key{Shift}. To access
13285 these commands on a tty when special keys are unavailable, the following
13286 alternative bindings can be used. The tty bindings below will likely be
13287 more cumbersome; you may find for some of the bindings below that a
13288 customized workaround suits you better. For example, changing a timestamp
13289 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
13290 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
13292 @multitable @columnfractions 0.15 0.2 0.1 0.2
13293 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
13294 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
13295 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
13296 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
13297 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
13298 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
13299 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
13300 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
13301 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
13302 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
13303 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
13304 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
13305 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
13306 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
13307 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
13308 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
13309 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
13310 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
13311 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
13315 @node Interaction, , TTY keys, Miscellaneous
13316 @section Interaction with other packages
13317 @cindex packages, interaction with other
13318 Org lives in the world of GNU Emacs and interacts in various ways
13319 with other code out there.
13322 * Cooperation:: Packages Org cooperates with
13323 * Conflicts:: Packages that lead to conflicts
13326 @node Cooperation, Conflicts, Interaction, Interaction
13327 @subsection Packages that Org cooperates with
13330 @cindex @file{calc.el}
13331 @cindex Gillespie, Dave
13332 @item @file{calc.el} by Dave Gillespie
13333 Org uses the Calc package for implementing spreadsheet
13334 functionality in its tables (@pxref{The spreadsheet}). Org
13335 checks for the availability of Calc by looking for the function
13336 @code{calc-eval} which will have been autoloaded during setup if Calc has
13337 been installed properly. As of Emacs 22, Calc is part of the Emacs
13338 distribution. Another possibility for interaction between the two
13339 packages is using Calc for embedded calculations. @xref{Embedded Mode,
13340 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
13341 @item @file{constants.el} by Carsten Dominik
13342 @cindex @file{constants.el}
13343 @cindex Dominik, Carsten
13344 @vindex org-table-formula-constants
13345 In a table formula (@pxref{The spreadsheet}), it is possible to use
13346 names for natural constants or units. Instead of defining your own
13347 constants in the variable @code{org-table-formula-constants}, install
13348 the @file{constants} package which defines a large number of constants
13349 and units, and lets you use unit prefixes like @samp{M} for
13350 @samp{Mega}, etc@. You will need version 2.0 of this package, available
13351 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
13352 the function @code{constants-get}, which has to be autoloaded in your
13353 setup. See the installation instructions in the file
13354 @file{constants.el}.
13355 @item @file{cdlatex.el} by Carsten Dominik
13356 @cindex @file{cdlatex.el}
13357 @cindex Dominik, Carsten
13358 Org-mode can make use of the CDLa@TeX{} package to efficiently enter
13359 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
13360 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
13361 @cindex @file{imenu.el}
13362 Imenu allows menu access to an index of items in a file. Org-mode
13363 supports Imenu---all you need to do to get the index is the following:
13365 (add-hook 'org-mode-hook
13366 (lambda () (imenu-add-to-menubar "Imenu")))
13368 @vindex org-imenu-depth
13369 By default the index is two levels deep---you can modify the depth using
13370 the option @code{org-imenu-depth}.
13371 @item @file{remember.el} by John Wiegley
13372 @cindex @file{remember.el}
13373 @cindex Wiegley, John
13374 Org used to use this package for capture, but no longer does.
13375 @item @file{speedbar.el} by Eric M. Ludlam
13376 @cindex @file{speedbar.el}
13377 @cindex Ludlam, Eric M.
13378 Speedbar is a package that creates a special frame displaying files and
13379 index items in files. Org-mode supports Speedbar and allows you to
13380 drill into Org files directly from the Speedbar. It also allows you to
13381 restrict the scope of agenda commands to a file or a subtree by using
13382 the command @kbd{<} in the Speedbar frame.
13383 @cindex @file{table.el}
13384 @item @file{table.el} by Takaaki Ota
13386 @cindex table editor, @file{table.el}
13387 @cindex @file{table.el}
13388 @cindex Ota, Takaaki
13390 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
13391 and alignment can be created using the Emacs table package by Takaaki Ota
13392 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
13393 Org-mode will recognize these tables and export them properly. Because of
13394 interference with other Org-mode functionality, you unfortunately cannot edit
13395 these tables directly in the buffer. Instead, you need to use the command
13396 @kbd{C-c '} to edit them, similar to source code snippets.
13399 @orgcmd{C-c ',org-edit-special}
13400 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
13402 @orgcmd{C-c ~,org-table-create-with-table.el}
13403 Insert a @file{table.el} table. If there is already a table at point, this
13404 command converts it between the @file{table.el} format and the Org-mode
13405 format. See the documentation string of the command
13406 @code{org-convert-table} for the restrictions under which this is
13409 @file{table.el} is part of Emacs since Emacs 22.
13410 @item @file{footnote.el} by Steven L. Baur
13411 @cindex @file{footnote.el}
13412 @cindex Baur, Steven L.
13413 Org-mode recognizes numerical footnotes as provided by this package.
13414 However, Org-mode also has its own footnote support (@pxref{Footnotes}),
13415 which makes using @file{footnote.el} unnecessary.
13418 @node Conflicts, , Cooperation, Interaction
13419 @subsection Packages that lead to conflicts with Org-mode
13423 @cindex @code{shift-selection-mode}
13424 @vindex org-support-shift-select
13425 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
13426 cursor motions combined with the shift key should start or enlarge regions.
13427 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
13428 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
13429 at such a location. By default, @kbd{S-@key{cursor}} commands outside
13430 special contexts don't do anything, but you can customize the variable
13431 @code{org-support-shift-select}. Org-mode then tries to accommodate shift
13432 selection by (i) using it outside of the special contexts where special
13433 commands apply, and by (ii) extending an existing active region even if the
13434 cursor moves across a special context.
13436 @item @file{CUA.el} by Kim. F. Storm
13437 @cindex @file{CUA.el}
13438 @cindex Storm, Kim. F.
13439 @vindex org-replace-disputed-keys
13440 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
13441 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
13442 region. In fact, Emacs 23 has this built-in in the form of
13443 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
13444 23, you probably don't want to use another package for this purpose. However,
13445 if you prefer to leave these keys to a different package while working in
13446 Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
13447 Org will move the following key bindings in Org files, and in the agenda
13448 buffer (but not during date selection).
13451 S-UP -> M-p S-DOWN -> M-n
13452 S-LEFT -> M-- S-RIGHT -> M-+
13453 C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+
13456 @vindex org-disputed-keys
13457 Yes, these are unfortunately more difficult to remember. If you want
13458 to have other replacement keys, look at the variable
13459 @code{org-disputed-keys}.
13461 @item @file{yasnippet.el}
13462 @cindex @file{yasnippet.el}
13463 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
13464 @code{"\t"}) overrules YASnippet's access to this key. The following code
13465 fixed this problem:
13468 (add-hook 'org-mode-hook
13470 (org-set-local 'yas/trigger-key [tab])
13471 (define-key yas/keymap [tab] 'yas/next-field-group)))
13474 The latest version of yasnippet doesn't play well with Org mode. If the
13475 above code does not fix the conflict, start by defining the following
13479 (defun yas/org-very-safe-expand ()
13480 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
13483 Then, tell Org mode what to do with the new function:
13486 (add-hook 'org-mode-hook
13488 (make-variable-buffer-local 'yas/trigger-key)
13489 (setq yas/trigger-key [tab])
13490 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
13491 (define-key yas/keymap [tab] 'yas/next-field)))
13494 @item @file{windmove.el} by Hovav Shacham
13495 @cindex @file{windmove.el}
13496 This package also uses the @kbd{S-<cursor>} keys, so everything written
13497 in the paragraph above about CUA mode also applies here. If you want make
13498 the windmove function active in locations where Org-mode does not have
13499 special functionality on @kbd{S-@key{cursor}}, add this to your
13503 ;; Make windmove work in org-mode:
13504 (add-hook 'org-shiftup-final-hook 'windmove-up)
13505 (add-hook 'org-shiftleft-final-hook 'windmove-left)
13506 (add-hook 'org-shiftdown-final-hook 'windmove-down)
13507 (add-hook 'org-shiftright-final-hook 'windmove-right)
13510 @item @file{viper.el} by Michael Kifer
13511 @cindex @file{viper.el}
13513 Viper uses @kbd{C-c /} and therefore makes this key not access the
13514 corresponding Org-mode command @code{org-sparse-tree}. You need to find
13515 another key for this command, or override the key in
13516 @code{viper-vi-global-user-map} with
13519 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
13525 @node Hacking, MobileOrg, Miscellaneous, Top
13529 This appendix covers some aspects where users can extend the functionality of
13533 * Hooks:: Who to reach into Org's internals
13534 * Add-on packages:: Available extensions
13535 * Adding hyperlink types:: New custom link types
13536 * Context-sensitive commands:: How to add functionality to such commands
13537 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
13538 * Dynamic blocks:: Automatically filled blocks
13539 * Special agenda views:: Customized views
13540 * Extracting agenda information:: Postprocessing of agenda information
13541 * Using the property API:: Writing programs that use entry properties
13542 * Using the mapping API:: Mapping over all or selected entries
13545 @node Hooks, Add-on packages, Hacking, Hacking
13549 Org has a large number of hook variables that can be used to add
13550 functionality. This appendix about hacking is going to illustrate the
13551 use of some of them. A complete list of all hooks with documentation is
13552 maintained by the Worg project and can be found at
13553 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
13555 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
13556 @section Add-on packages
13557 @cindex add-on packages
13559 A large number of add-on packages have been written by various authors.
13560 These packages are not part of Emacs, but they are distributed as contributed
13561 packages with the separate release available at the Org-mode home page at
13562 @uref{http://orgmode.org}. The list of contributed packages, along with
13563 documentation about each package, is maintained by the Worg project at
13564 @uref{http://orgmode.org/worg/org-contrib/}.
13568 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
13569 @section Adding hyperlink types
13570 @cindex hyperlinks, adding new types
13572 Org has a large number of hyperlink types built-in
13573 (@pxref{Hyperlinks}). If you would like to add new link types, Org
13574 provides an interface for doing so. Let's look at an example file,
13575 @file{org-man.el}, that will add support for creating links like
13576 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
13580 ;;; org-man.el - Support for links to manpages in Org
13584 (org-add-link-type "man" 'org-man-open)
13585 (add-hook 'org-store-link-functions 'org-man-store-link)
13587 (defcustom org-man-command 'man
13588 "The Emacs command to be used to display a man page."
13590 :type '(choice (const man) (const woman)))
13592 (defun org-man-open (path)
13593 "Visit the manpage on PATH.
13594 PATH should be a topic that can be thrown at the man command."
13595 (funcall org-man-command path))
13597 (defun org-man-store-link ()
13598 "Store a link to a manpage."
13599 (when (memq major-mode '(Man-mode woman-mode))
13600 ;; This is a man page, we do make this link
13601 (let* ((page (org-man-get-page-name))
13602 (link (concat "man:" page))
13603 (description (format "Manpage for %s" page)))
13604 (org-store-link-props
13607 :description description))))
13609 (defun org-man-get-page-name ()
13610 "Extract the page name from the buffer name."
13611 ;; This works for both `Man-mode' and `woman-mode'.
13612 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
13613 (match-string 1 (buffer-name))
13614 (error "Cannot create link to this man page")))
13618 ;;; org-man.el ends here
13622 You would activate this new link type in @file{.emacs} with
13629 Let's go through the file and see what it does.
13632 It does @code{(require 'org)} to make sure that @file{org.el} has been
13635 The next line calls @code{org-add-link-type} to define a new link type
13636 with prefix @samp{man}. The call also contains the name of a function
13637 that will be called to follow such a link.
13639 @vindex org-store-link-functions
13640 The next line adds a function to @code{org-store-link-functions}, in
13641 order to allow the command @kbd{C-c l} to record a useful link in a
13642 buffer displaying a man page.
13645 The rest of the file defines the necessary variables and functions.
13646 First there is a customization variable that determines which Emacs
13647 command should be used to display man pages. There are two options,
13648 @code{man} and @code{woman}. Then the function to follow a link is
13649 defined. It gets the link path as an argument---in this case the link
13650 path is just a topic for the manual command. The function calls the
13651 value of @code{org-man-command} to display the man page.
13653 Finally the function @code{org-man-store-link} is defined. When you try
13654 to store a link with @kbd{C-c l}, this function will be called to
13655 try to make a link. The function must first decide if it is supposed to
13656 create the link for this buffer type; we do this by checking the value
13657 of the variable @code{major-mode}. If not, the function must exit and
13658 return the value @code{nil}. If yes, the link is created by getting the
13659 manual topic from the buffer name and prefixing it with the string
13660 @samp{man:}. Then it must call the command @code{org-store-link-props}
13661 and set the @code{:type} and @code{:link} properties. Optionally you
13662 can also set the @code{:description} property to provide a default for
13663 the link description when the link is later inserted into an Org
13664 buffer with @kbd{C-c C-l}.
13666 When it makes sense for your new link type, you may also define a function
13667 @code{org-PREFIX-complete-link} that implements special (e.g. completion)
13668 support for inserting such a link with @kbd{C-c C-l}. Such a function should
13669 not accept any arguments, and return the full link with prefix.
13671 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
13672 @section Context-sensitive commands
13673 @cindex context-sensitive commands, hooks
13674 @cindex add-ons, context-sensitive commands
13675 @vindex org-ctrl-c-ctrl-c-hook
13677 Org has several commands that act differently depending on context. The most
13678 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
13679 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
13681 Add-ons can tap into this functionality by providing a function that detects
13682 special context for that add-on and executes functionality appropriate for
13683 the context. Here is an example from Dan Davison's @file{org-R.el} which
13684 allows you to evaluate commands based on the @file{R} programming language
13685 @footnote{@file{org-R.el} has been replaced by the org-mode functionality
13686 described in @ref{Working With Source Code} and is now obsolete.}. For this
13687 package, special contexts are lines that start with @code{#+R:} or
13691 (defun org-R-apply-maybe ()
13692 "Detect if this is context for org-R and execute R commands."
13693 (if (save-excursion
13694 (beginning-of-line 1)
13695 (looking-at "#\\+RR?:"))
13696 (progn (call-interactively 'org-R-apply)
13697 t) ;; to signal that we took action
13698 nil)) ;; to signal that we did not
13700 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
13703 The function first checks if the cursor is in such a line. If that is the
13704 case, @code{org-R-apply} is called and the function returns @code{t} to
13705 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
13706 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
13709 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
13710 @section Tables and lists in arbitrary syntax
13711 @cindex tables, in other modes
13712 @cindex lists, in other modes
13713 @cindex Orgtbl mode
13715 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
13716 frequent feature request has been to make it work with native tables in
13717 specific languages, for example @LaTeX{}. However, this is extremely
13718 hard to do in a general way, would lead to a customization nightmare,
13719 and would take away much of the simplicity of the Orgtbl-mode table
13722 This appendix describes a different approach. We keep the Orgtbl mode
13723 table in its native format (the @i{source table}), and use a custom
13724 function to @i{translate} the table to the correct syntax, and to
13725 @i{install} it in the right location (the @i{target table}). This puts
13726 the burden of writing conversion functions on the user, but it allows
13727 for a very flexible system.
13729 Bastien added the ability to do the same with lists, in Orgstruct mode. You
13730 can use Org's facilities to edit and structure lists by turning
13731 @code{orgstruct-mode} on, then locally exporting such lists in another format
13732 (HTML, @LaTeX{} or Texinfo.)
13736 * Radio tables:: Sending and receiving radio tables
13737 * A LaTeX example:: Step by step, almost a tutorial
13738 * Translator functions:: Copy and modify
13739 * Radio lists:: Doing the same for lists
13742 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
13743 @subsection Radio tables
13744 @cindex radio tables
13746 To define the location of the target table, you first need to create two
13747 lines that are comments in the current mode, but contain magic words for
13748 Orgtbl mode to find. Orgtbl mode will insert the translated table
13749 between these lines, replacing whatever was there before. For example:
13752 /* BEGIN RECEIVE ORGTBL table_name */
13753 /* END RECEIVE ORGTBL table_name */
13757 Just above the source table, we put a special line that tells
13758 Orgtbl mode how to translate this table and where to install it. For
13762 #+ORGTBL: SEND table_name translation_function arguments....
13766 @code{table_name} is the reference name for the table that is also used
13767 in the receiver lines. @code{translation_function} is the Lisp function
13768 that does the translation. Furthermore, the line can contain a list of
13769 arguments (alternating key and value) at the end. The arguments will be
13770 passed as a property list to the translation function for
13771 interpretation. A few standard parameters are already recognized and
13772 acted upon before the translation function is called:
13776 Skip the first N lines of the table. Hlines do count as separate lines for
13779 @item :skipcols (n1 n2 ...)
13780 List of columns that should be skipped. If the table has a column with
13781 calculation marks, that column is automatically discarded as well.
13782 Please note that the translator function sees the table @emph{after} the
13783 removal of these columns, the function never knows that there have been
13784 additional columns.
13788 The one problem remaining is how to keep the source table in the buffer
13789 without disturbing the normal workings of the file, for example during
13790 compilation of a C file or processing of a @LaTeX{} file. There are a
13791 number of different solutions:
13795 The table could be placed in a block comment if that is supported by the
13796 language. For example, in C mode you could wrap the table between
13797 @samp{/*} and @samp{*/} lines.
13799 Sometimes it is possible to put the table after some kind of @i{END}
13800 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
13803 You can just comment the table line-by-line whenever you want to process
13804 the file, and uncomment it whenever you need to edit the table. This
13805 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
13806 makes this comment-toggling very easy, in particular if you bind it to a
13810 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
13811 @subsection A @LaTeX{} example of radio tables
13812 @cindex @LaTeX{}, and Orgtbl mode
13814 The best way to wrap the source table in @LaTeX{} is to use the
13815 @code{comment} environment provided by @file{comment.sty}. It has to be
13816 activated by placing @code{\usepackage@{comment@}} into the document
13817 header. Orgtbl mode can insert a radio table skeleton@footnote{By
13818 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
13819 variable @code{orgtbl-radio-tables} to install templates for other
13820 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
13821 be prompted for a table name, let's say we use @samp{salesfigures}. You
13822 will then get the following template:
13824 @cindex #+ORGTBL, SEND
13826 % BEGIN RECEIVE ORGTBL salesfigures
13827 % END RECEIVE ORGTBL salesfigures
13829 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13835 @vindex @LaTeX{}-verbatim-environments
13836 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
13837 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
13838 into the receiver location with name @code{salesfigures}. You may now
13839 fill in the table---feel free to use the spreadsheet features@footnote{If
13840 the @samp{#+TBLFM} line contains an odd number of dollar characters,
13841 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
13842 example you can fix this by adding an extra line inside the
13843 @code{comment} environment that is used to balance the dollar
13844 expressions. If you are using AUC@TeX{} with the font-latex library, a
13845 much better solution is to add the @code{comment} environment to the
13846 variable @code{LaTeX-verbatim-environments}.}:
13849 % BEGIN RECEIVE ORGTBL salesfigures
13850 % END RECEIVE ORGTBL salesfigures
13852 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13853 | Month | Days | Nr sold | per day |
13854 |-------+------+---------+---------|
13855 | Jan | 23 | 55 | 2.4 |
13856 | Feb | 21 | 16 | 0.8 |
13857 | March | 22 | 278 | 12.6 |
13858 #+TBLFM: $4=$3/$2;%.1f
13859 % $ (optional extra dollar to keep font-lock happy, see footnote)
13864 When you are done, press @kbd{C-c C-c} in the table to get the converted
13865 table inserted between the two marker lines.
13867 Now let's assume you want to make the table header by hand, because you
13868 want to control how columns are aligned, etc@. In this case we make sure
13869 that the table translator skips the first 2 lines of the source
13870 table, and tell the command to work as a @i{splice}, i.e. to not produce
13871 header and footer commands of the target table:
13874 \begin@{tabular@}@{lrrr@}
13875 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
13876 % BEGIN RECEIVE ORGTBL salesfigures
13877 % END RECEIVE ORGTBL salesfigures
13881 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
13882 | Month | Days | Nr sold | per day |
13883 |-------+------+---------+---------|
13884 | Jan | 23 | 55 | 2.4 |
13885 | Feb | 21 | 16 | 0.8 |
13886 | March | 22 | 278 | 12.6 |
13887 #+TBLFM: $4=$3/$2;%.1f
13891 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
13892 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
13893 and marks horizontal lines with @code{\hline}. Furthermore, it
13894 interprets the following parameters (see also @pxref{Translator functions}):
13897 @item :splice nil/t
13898 When set to t, return only table body lines, don't wrap them into a
13899 tabular environment. Default is nil.
13902 A format to be used to wrap each field, it should contain @code{%s} for the
13903 original field value. For example, to wrap each field value in dollars,
13904 you could use @code{:fmt "$%s$"}. This may also be a property list with
13905 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
13906 A function of one argument can be used in place of the strings; the
13907 function must return a formatted string.
13910 Use this format to print numbers with exponentials. The format should
13911 have @code{%s} twice for inserting mantissa and exponent, for example
13912 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
13913 may also be a property list with column numbers and formats, for example
13914 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
13915 @code{efmt} has been applied to a value, @code{fmt} will also be
13916 applied. Similar to @code{fmt}, functions of two arguments can be
13917 supplied instead of strings.
13920 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
13921 @subsection Translator functions
13922 @cindex HTML, and Orgtbl mode
13923 @cindex translator function
13925 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
13926 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
13927 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
13928 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
13929 code that produces tables during HTML export.}, these all use a generic
13930 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
13931 itself is a very short function that computes the column definitions for the
13932 @code{tabular} environment, defines a few field and line separators and then
13933 hands processing over to the generic translator. Here is the entire code:
13937 (defun orgtbl-to-latex (table params)
13938 "Convert the Orgtbl mode TABLE to LaTeX."
13939 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
13940 org-table-last-alignment ""))
13943 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
13944 :tend "\\end@{tabular@}"
13945 :lstart "" :lend " \\\\" :sep " & "
13946 :efmt "%s\\,(%s)" :hline "\\hline")))
13947 (orgtbl-to-generic table (org-combine-plists params2 params))))
13951 As you can see, the properties passed into the function (variable
13952 @var{PARAMS}) are combined with the ones newly defined in the function
13953 (variable @var{PARAMS2}). The ones passed into the function (i.e. the
13954 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
13955 would like to use the @LaTeX{} translator, but wanted the line endings to
13956 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
13957 overrule the default with
13960 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
13963 For a new language, you can either write your own converter function in
13964 analogy with the @LaTeX{} translator, or you can use the generic function
13965 directly. For example, if you have a language where a table is started
13966 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
13967 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
13968 separator is a TAB, you could call the generic translator like this (on
13972 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
13973 :lstart "!BL! " :lend " !EL!" :sep "\t"
13977 Please check the documentation string of the function
13978 @code{orgtbl-to-generic} for a full list of parameters understood by
13979 that function, and remember that you can pass each of them into
13980 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
13981 using the generic function.
13983 Of course you can also write a completely new function doing complicated
13984 things the generic translator cannot do. A translator function takes
13985 two arguments. The first argument is the table, a list of lines, each
13986 line either the symbol @code{hline} or a list of fields. The second
13987 argument is the property list containing all parameters specified in the
13988 @samp{#+ORGTBL: SEND} line. The function must return a single string
13989 containing the formatted table. If you write a generally useful
13990 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
13991 others can benefit from your work.
13993 @node Radio lists, , Translator functions, Tables in arbitrary syntax
13994 @subsection Radio lists
13995 @cindex radio lists
13996 @cindex org-list-insert-radio-list
13998 Sending and receiving radio lists works exactly the same way as sending and
13999 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
14000 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
14001 @code{org-list-insert-radio-list}.
14003 Here are the differences with radio tables:
14007 Orgstruct mode must be active.
14009 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
14011 The available translation functions for radio lists don't take
14014 @kbd{C-c C-c} will work when pressed on the first item of the list.
14017 Here is a @LaTeX{} example. Let's say that you have this in your
14022 % BEGIN RECEIVE ORGLST to-buy
14023 % END RECEIVE ORGLST to-buy
14025 #+ORGLST: SEND to-buy org-list-to-latex
14034 Pressing `C-c C-c' on @code{a new house} and will insert the converted
14035 @LaTeX{} list between the two marker lines.
14037 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
14038 @section Dynamic blocks
14039 @cindex dynamic blocks
14041 Org documents can contain @emph{dynamic blocks}. These are
14042 specially marked regions that are updated by some user-written function.
14043 A good example for such a block is the clock table inserted by the
14044 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
14046 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
14047 to the block and can also specify parameters for the function producing
14048 the content of the block.
14050 @cindex #+BEGIN:dynamic block
14052 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
14057 Dynamic blocks are updated with the following commands
14060 @orgcmd{C-c C-x C-u,org-dblock-update}
14061 Update dynamic block at point.
14062 @orgkey{C-u C-c C-x C-u}
14063 Update all dynamic blocks in the current file.
14066 Updating a dynamic block means to remove all the text between BEGIN and
14067 END, parse the BEGIN line for parameters and then call the specific
14068 writer function for this block to insert the new content. If you want
14069 to use the original content in the writer function, you can use the
14070 extra parameter @code{:content}.
14072 For a block with name @code{myblock}, the writer function is
14073 @code{org-dblock-write:myblock} with as only parameter a property list
14074 with the parameters given in the begin line. Here is a trivial example
14075 of a block that keeps track of when the block update function was last
14079 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
14085 The corresponding block writer function could look like this:
14088 (defun org-dblock-write:block-update-time (params)
14089 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
14090 (insert "Last block update at: "
14091 (format-time-string fmt (current-time)))))
14094 If you want to make sure that all dynamic blocks are always up-to-date,
14095 you could add the function @code{org-update-all-dblocks} to a hook, for
14096 example @code{before-save-hook}. @code{org-update-all-dblocks} is
14097 written in a way such that it does nothing in buffers that are not in
14100 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
14101 @section Special agenda views
14102 @cindex agenda views, user-defined
14104 @vindex org-agenda-skip-function
14105 @vindex org-agenda-skip-function-global
14106 Org provides a special hook that can be used to narrow down the selection
14107 made by these agenda views: @code{todo}, @code{alltodo}, @code{tags},
14108 @code{tags-todo}, @code{tags-tree}. You may specify a function that is used
14109 at each match to verify if the match should indeed be part of the agenda
14110 view, and if not, how much should be skipped. You can specify a global
14111 condition that will be applied to all agenda views, this condition would be
14112 stored in the variable @code{org-agenda-skip-function-global}. More
14113 commonly, such a definition is applied only to specific custom searches,
14114 using @code{org-agenda-skip-function}.
14116 Let's say you want to produce a list of projects that contain a WAITING
14117 tag anywhere in the project tree. Let's further assume that you have
14118 marked all tree headings that define a project with the TODO keyword
14119 PROJECT. In this case you would run a TODO search for the keyword
14120 PROJECT, but skip the match unless there is a WAITING tag anywhere in
14121 the subtree belonging to the project line.
14123 To achieve this, you must write a function that searches the subtree for
14124 the tag. If the tag is found, the function must return @code{nil} to
14125 indicate that this match should not be skipped. If there is no such
14126 tag, return the location of the end of the subtree, to indicate that
14127 search should continue from there.
14130 (defun my-skip-unless-waiting ()
14131 "Skip trees that are not waiting"
14132 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
14133 (if (re-search-forward ":waiting:" subtree-end t)
14134 nil ; tag found, do not skip
14135 subtree-end))) ; tag not found, continue after end of subtree
14138 Now you may use this function in an agenda custom command, for example
14142 (org-add-agenda-custom-command
14143 '("b" todo "PROJECT"
14144 ((org-agenda-skip-function 'my-skip-unless-waiting)
14145 (org-agenda-overriding-header "Projects waiting for something: "))))
14148 @vindex org-agenda-overriding-header
14149 Note that this also binds @code{org-agenda-overriding-header} to get a
14150 meaningful header in the agenda view.
14152 @vindex org-odd-levels-only
14153 @vindex org-agenda-skip-function
14154 A general way to create custom searches is to base them on a search for
14155 entries with a certain level limit. If you want to study all entries with
14156 your custom search function, simply do a search for
14157 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
14158 level number corresponds to order in the hierarchy, not to the number of
14159 stars.}, and then use @code{org-agenda-skip-function} to select the entries
14160 you really want to have.
14162 You may also put a Lisp form into @code{org-agenda-skip-function}. In
14163 particular, you may use the functions @code{org-agenda-skip-entry-if}
14164 and @code{org-agenda-skip-subtree-if} in this form, for example:
14167 @item '(org-agenda-skip-entry-if 'scheduled)
14168 Skip current entry if it has been scheduled.
14169 @item '(org-agenda-skip-entry-if 'notscheduled)
14170 Skip current entry if it has not been scheduled.
14171 @item '(org-agenda-skip-entry-if 'deadline)
14172 Skip current entry if it has a deadline.
14173 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
14174 Skip current entry if it has a deadline, or if it is scheduled.
14175 @item '(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
14176 Skip current entry if the TODO keyword is TODO or WAITING.
14177 @item '(org-agenda-skip-entry-if 'todo 'done)
14178 Skip current entry if the TODO keyword marks a DONE state.
14179 @item '(org-agenda-skip-entry-if 'timestamp)
14180 Skip current entry if it has any timestamp, may also be deadline or scheduled.
14181 @item '(org-agenda-skip-entry 'regexp "regular expression")
14182 Skip current entry if the regular expression matches in the entry.
14183 @item '(org-agenda-skip-entry 'notregexp "regular expression")
14184 Skip current entry unless the regular expression matches.
14185 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
14186 Same as above, but check and skip the entire subtree.
14189 Therefore we could also have written the search for WAITING projects
14190 like this, even without defining a special function:
14193 (org-add-agenda-custom-command
14194 '("b" todo "PROJECT"
14195 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
14196 'regexp ":waiting:"))
14197 (org-agenda-overriding-header "Projects waiting for something: "))))
14200 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
14201 @section Extracting agenda information
14202 @cindex agenda, pipe
14203 @cindex Scripts, for agenda processing
14205 @vindex org-agenda-custom-commands
14206 Org provides commands to access agenda information for the command
14207 line in Emacs batch mode. This extracted information can be sent
14208 directly to a printer, or it can be read by a program that does further
14209 processing of the data. The first of these commands is the function
14210 @code{org-batch-agenda}, that produces an agenda view and sends it as
14211 ASCII text to STDOUT. The command takes a single string as parameter.
14212 If the string has length 1, it is used as a key to one of the commands
14213 you have configured in @code{org-agenda-custom-commands}, basically any
14214 key you can use after @kbd{C-c a}. For example, to directly print the
14215 current TODO list, you could use
14218 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
14221 If the parameter is a string with 2 or more characters, it is used as a
14222 tags/TODO match string. For example, to print your local shopping list
14223 (all items with the tag @samp{shop}, but excluding the tag
14224 @samp{NewYork}), you could use
14227 emacs -batch -l ~/.emacs \
14228 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
14232 You may also modify parameters on the fly like this:
14235 emacs -batch -l ~/.emacs \
14236 -eval '(org-batch-agenda "a" \
14237 org-agenda-span month \
14238 org-agenda-include-diary nil \
14239 org-agenda-files (quote ("~/org/project.org")))' \
14244 which will produce a 30-day agenda, fully restricted to the Org file
14245 @file{~/org/projects.org}, not even including the diary.
14247 If you want to process the agenda data in more sophisticated ways, you
14248 can use the command @code{org-batch-agenda-csv} to get a comma-separated
14249 list of values for each agenda item. Each line in the output will
14250 contain a number of fields separated by commas. The fields in a line
14254 category @r{The category of the item}
14255 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
14256 type @r{The type of the agenda entry, can be}
14257 todo @r{selected in TODO match}
14258 tagsmatch @r{selected in tags match}
14259 diary @r{imported from diary}
14260 deadline @r{a deadline}
14261 scheduled @r{scheduled}
14262 timestamp @r{appointment, selected by timestamp}
14263 closed @r{entry was closed on date}
14264 upcoming-deadline @r{warning about nearing deadline}
14265 past-scheduled @r{forwarded scheduled item}
14266 block @r{entry has date block including date}
14267 todo @r{The TODO keyword, if any}
14268 tags @r{All tags including inherited ones, separated by colons}
14269 date @r{The relevant date, like 2007-2-14}
14270 time @r{The time, like 15:00-16:50}
14271 extra @r{String with extra planning info}
14272 priority-l @r{The priority letter if any was given}
14273 priority-n @r{The computed numerical priority}
14277 Time and date will only be given if a timestamp (or deadline/scheduled)
14278 led to the selection of the item.
14280 A CSV list like this is very easy to use in a post-processing script.
14281 For example, here is a Perl program that gets the TODO list from
14282 Emacs/Org and prints all the items, preceded by a checkbox:
14287 # define the Emacs command to run
14288 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
14290 # run it and capture the output
14291 $agenda = qx@{$cmd 2>/dev/null@};
14293 # loop over all lines
14294 foreach $line (split(/\n/,$agenda)) @{
14295 # get the individual values
14296 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
14297 $priority_l,$priority_n) = split(/,/,$line);
14298 # process and print
14299 print "[ ] $head\n";
14303 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
14304 @section Using the property API
14305 @cindex API, for properties
14306 @cindex properties, API
14308 Here is a description of the functions that can be used to work with
14311 @defun org-entry-properties &optional pom which
14312 Get all properties of the entry at point-or-marker POM.@*
14313 This includes the TODO keyword, the tags, time strings for deadline,
14314 scheduled, and clocking, and any additional properties defined in the
14315 entry. The return value is an alist. Keys may occur multiple times
14316 if the property key was used several times.@*
14317 POM may also be nil, in which case the current entry is used.
14318 If WHICH is nil or `all', get all properties. If WHICH is
14319 `special' or `standard', only get that subclass.
14321 @vindex org-use-property-inheritance
14322 @defun org-entry-get pom property &optional inherit
14323 Get value of PROPERTY for entry at point-or-marker POM. By default,
14324 this only looks at properties defined locally in the entry. If INHERIT
14325 is non-nil and the entry does not have the property, then also check
14326 higher levels of the hierarchy. If INHERIT is the symbol
14327 @code{selective}, use inheritance if and only if the setting of
14328 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
14331 @defun org-entry-delete pom property
14332 Delete the property PROPERTY from entry at point-or-marker POM.
14335 @defun org-entry-put pom property value
14336 Set PROPERTY to VALUE for entry at point-or-marker POM.
14339 @defun org-buffer-property-keys &optional include-specials
14340 Get all property keys in the current buffer.
14343 @defun org-insert-property-drawer
14344 Insert a property drawer at point.
14347 @defun org-entry-put-multivalued-property pom property &rest values
14348 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
14349 strings. They will be concatenated, with spaces as separators.
14352 @defun org-entry-get-multivalued-property pom property
14353 Treat the value of the property PROPERTY as a whitespace-separated list of
14354 values and return the values as a list of strings.
14357 @defun org-entry-add-to-multivalued-property pom property value
14358 Treat the value of the property PROPERTY as a whitespace-separated list of
14359 values and make sure that VALUE is in this list.
14362 @defun org-entry-remove-from-multivalued-property pom property value
14363 Treat the value of the property PROPERTY as a whitespace-separated list of
14364 values and make sure that VALUE is @emph{not} in this list.
14367 @defun org-entry-member-in-multivalued-property pom property value
14368 Treat the value of the property PROPERTY as a whitespace-separated list of
14369 values and check if VALUE is in this list.
14372 @defopt org-property-allowed-value-functions
14373 Hook for functions supplying allowed values for a specific property.
14374 The functions must take a single argument, the name of the property, and
14375 return a flat list of allowed values. If @samp{:ETC} is one of
14376 the values, use the values as completion help, but allow also other values
14377 to be entered. The functions must return @code{nil} if they are not
14378 responsible for this property.
14381 @node Using the mapping API, , Using the property API, Hacking
14382 @section Using the mapping API
14383 @cindex API, for mapping
14384 @cindex mapping entries, API
14386 Org has sophisticated mapping capabilities to find all entries satisfying
14387 certain criteria. Internally, this functionality is used to produce agenda
14388 views, but there is also an API that can be used to execute arbitrary
14389 functions for each or selected entries. The main entry point for this API
14392 @defun org-map-entries func &optional match scope &rest skip
14393 Call FUNC at each headline selected by MATCH in SCOPE.
14395 FUNC is a function or a Lisp form. The function will be called without
14396 arguments, with the cursor positioned at the beginning of the headline.
14397 The return values of all calls to the function will be collected and
14398 returned as a list.
14400 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14401 does not need to preserve point. After evaluation, the cursor will be
14402 moved to the end of the line (presumably of the headline of the
14403 processed entry) and search continues from there. Under some
14404 circumstances, this may not produce the wanted results. For example,
14405 if you have removed (e.g. archived) the current (sub)tree it could
14406 mean that the next entry will be skipped entirely. In such cases, you
14407 can specify the position from where search should continue by making
14408 FUNC set the variable `org-map-continue-from' to the desired buffer
14411 MATCH is a tags/property/todo match as it is used in the agenda match view.
14412 Only headlines that are matched by this query will be considered during
14413 the iteration. When MATCH is nil or t, all headlines will be
14414 visited by the iteration.
14416 SCOPE determines the scope of this command. It can be any of:
14419 nil @r{the current buffer, respecting the restriction if any}
14420 tree @r{the subtree started with the entry at point}
14421 file @r{the current buffer, without restriction}
14423 @r{the current buffer, and any archives associated with it}
14424 agenda @r{all agenda files}
14425 agenda-with-archives
14426 @r{all agenda files with any archive files associated with them}
14428 @r{if this is a list, all files in the list will be scanned}
14431 The remaining args are treated as settings for the skipping facilities of
14432 the scanner. The following items can be given here:
14434 @vindex org-agenda-skip-function
14436 archive @r{skip trees with the archive tag}
14437 comment @r{skip trees with the COMMENT keyword}
14438 function or Lisp form
14439 @r{will be used as value for @code{org-agenda-skip-function},}
14440 @r{so whenever the function returns t, FUNC}
14441 @r{will not be called for that entry and search will}
14442 @r{continue from the point where the function leaves it}
14446 The function given to that mapping routine can really do anything you like.
14447 It can use the property API (@pxref{Using the property API}) to gather more
14448 information about the entry, or in order to change metadata in the entry.
14449 Here are a couple of functions that might be handy:
14451 @defun org-todo &optional arg
14452 Change the TODO state of the entry. See the docstring of the functions for
14453 the many possible values for the argument ARG.
14456 @defun org-priority &optional action
14457 Change the priority of the entry. See the docstring of this function for the
14458 possible values for ACTION.
14461 @defun org-toggle-tag tag &optional onoff
14462 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
14463 or @code{off} will not toggle tag, but ensure that it is either on or off.
14467 Promote the current entry.
14471 Demote the current entry.
14474 Here is a simple example that will turn all entries in the current file with
14475 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
14476 Entries in comment trees and in archive trees will be ignored.
14480 '(org-todo "UPCOMING")
14481 "+TOMORROW" 'file 'archive 'comment)
14484 The following example counts the number of entries with TODO keyword
14485 @code{WAITING}, in all agenda files.
14488 (length (org-map-entries t "/+WAITING" 'agenda))
14491 @node MobileOrg, History and Acknowledgments, Hacking, Top
14492 @appendix MobileOrg
14496 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
14497 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
14498 @i{MobileOrg} offers offline viewing and capture support for an Org-mode
14499 system rooted on a ``real'' computer. It does also allow you to record
14500 changes to existing entries. Android users should check out
14501 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
14504 This appendix describes the support Org has for creating agenda views in a
14505 format that can be displayed by @i{MobileOrg}, and for integrating notes
14506 captured and changes made by @i{MobileOrg} into the main system.
14508 For changing tags and TODO states in MobileOrg, you should have set up the
14509 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
14510 cover all important tags and TODO keywords, even if individual files use only
14511 part of these. MobileOrg will also offer you states and tags set up with
14512 in-buffer settings, but it will understand the logistics of TODO state
14513 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
14514 (@pxref{Setting tags}) only for those set in these variables.
14517 * Setting up the staging area:: Where to interact with the mobile device
14518 * Pushing to MobileOrg:: Uploading Org files and agendas
14519 * Pulling from MobileOrg:: Integrating captured and flagged items
14522 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
14523 @section Setting up the staging area
14525 MobileOrg needs to interact with Emacs through a directory on a server. If you
14526 are using a public server, you should consider to encrypt the files that are
14527 uploaded to the server. This can be done with Org-mode 7.02 and with
14528 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
14529 installation on your system. To turn on encryption, set a password in
14530 @i{MobileOrg} and, on the Emacs side, configure the variable
14531 @code{org-mobile-use-encryption}@footnote{If you can safely store the
14532 password in your Emacs setup, you might also want to configure
14533 @code{org-mobile-encryption-password}. Please read the docstring of that
14534 variable. Note that encryption will apply only to the contents of the
14535 @file{.org} files. The file names themselves will remain visible.}.
14537 The easiest way to create that directory is to use a free
14538 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
14539 Dropbox, or if your version of MobileOrg does not support it, you can use a
14540 webdav server. For more information, check out the documentation of MobileOrg and also this
14541 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
14542 When MobileOrg first connects to your Dropbox, it will create a directory
14543 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
14547 (setq org-mobile-directory "~/Dropbox/MobileOrg")
14550 Org-mode has commands to put files for @i{MobileOrg} into that directory,
14551 and to read captured notes from there.
14553 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
14554 @section Pushing to MobileOrg
14556 This operation copies all files currently listed in @code{org-mobile-files}
14557 to the directory @code{org-mobile-directory}. By default this list contains
14558 all agenda files (as listed in @code{org-agenda-files}), but additional files
14559 can be included by customizing @code{org-mobiles-files}. File names will be
14560 staged with paths relative to @code{org-directory}, so all files should be
14561 inside this directory. The push operation also creates a special Org file
14562 @file{agendas.org} with all custom agenda view defined by the
14563 user@footnote{While creating the agendas, Org-mode will force ID properties
14564 on all referenced entries, so that these entries can be uniquely identified
14565 if @i{MobileOrg} flags them for further action. If you do not want to get
14566 these properties in so many entries, you can set the variable
14567 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
14568 rely on outline paths, in the hope that these will be unique enough.}.
14569 Finally, Org writes the file @file{index.org}, containing links to all other
14570 files. @i{MobileOrg} first reads this file from the server, and then
14571 downloads all agendas and Org files listed in it. To speed up the download,
14572 MobileOrg will only read files whose checksums@footnote{stored automatically
14573 in the file @file{checksums.dat}} have changed.
14575 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
14576 @section Pulling from MobileOrg
14578 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
14579 files for viewing. It also appends captured entries and pointers to flagged
14580 and changed entries to the file @file{mobileorg.org} on the server. Org has
14581 a @emph{pull} operation that integrates this information into an inbox file
14582 and operates on the pointers to flagged entries. Here is how it works:
14586 Org moves all entries found in
14587 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
14588 operation.} and appends them to the file pointed to by the variable
14589 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
14590 will be a top-level entry in the inbox file.
14592 After moving the entries, Org will attempt to implement the changes made in
14593 @i{MobileOrg}. Some changes are applied directly and without user
14594 interaction. Examples are all changes to tags, TODO state, headline and body
14595 text that can be cleanly applied. Entries that have been flagged for further
14596 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
14597 again. When there is a problem finding an entry or applying the change, the
14598 pointer entry will remain in the inbox and will be marked with an error
14599 message. You need to later resolve these issues by hand.
14601 Org will then generate an agenda view with all flagged entries. The user
14602 should then go through these entries and do whatever actions are necessary.
14603 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
14604 will be displayed in the echo area when the cursor is on the corresponding
14609 Pressing @kbd{?} in that special agenda will display the full flagging note in
14610 another window and also push it onto the kill ring. So you could use @kbd{?
14611 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
14612 Pressing @kbd{?} twice in succession will offer to remove the
14613 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
14614 in a property). In this way you indicate that the intended processing for
14615 this flagged entry is finished.
14620 If you are not able to process all flagged entries directly, you can always
14621 return to this agenda view@footnote{Note, however, that there is a subtle
14622 difference. The view created automatically by @kbd{M-x org-mobile-pull
14623 @key{RET}} is guaranteed to search all files that have been addressed by the
14624 last pull. This might include a file that is not currently in your list of
14625 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
14626 the current agenda files will be searched.} using @kbd{C-c a ?}.
14628 @node History and Acknowledgments, Main Index, MobileOrg, Top
14629 @appendix History and acknowledgments
14630 @cindex acknowledgments
14634 Org was born in 2003, out of frustration over the user interface of the Emacs
14635 Outline mode. I was trying to organize my notes and projects, and using
14636 Emacs seemed to be the natural way to go. However, having to remember eleven
14637 different commands with two or three keys per command, only to hide and show
14638 parts of the outline tree, that seemed entirely unacceptable to me. Also,
14639 when using outlines to take notes, I constantly wanted to restructure the
14640 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
14641 cycling} and @emph{structure editing} were originally implemented in the
14642 package @file{outline-magic.el}, but quickly moved to the more general
14643 @file{org.el}. As this environment became comfortable for project planning,
14644 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
14645 @emph{table support}. These areas highlighted the two main goals that Org
14646 still has today: to be a new, outline-based, plain text mode with innovative
14647 and intuitive editing features, and to incorporate project planning
14648 functionality directly into a notes file.
14650 Since the first release, literally thousands of emails to me or to
14651 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
14652 reports, feedback, new ideas, and sometimes patches and add-on code.
14653 Many thanks to everyone who has helped to improve this package. I am
14654 trying to keep here a list of the people who had significant influence
14655 in shaping one or more aspects of Org. The list may not be
14656 complete, if I have forgotten someone, please accept my apologies and
14659 Before I get to this list, a few special mentions are in order:
14662 @item Bastien Guerry
14663 Bastien has written a large number of extensions to Org (most of them
14664 integrated into the core by now), including the LaTeX exporter and the plain
14665 list parser. His support during the early days, when he basically acted as
14666 co-maintainer, was central to the success of this project. Bastien also
14667 invented Worg, helped establishing the Web presence of Org, and sponsors
14668 hosting costs for the orgmode.org website.
14669 @item Eric Schulte and Dan Davison
14670 Eric and Dan are jointly responsible for the Org-babel system, which turns
14671 Org into a multi-language environment for evaluating code and doing literate
14672 programming and reproducible research.
14674 John has contributed a number of great ideas and patches directly to Org,
14675 including the attachment system (@file{org-attach.el}), integration with
14676 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
14677 items, habit tracking (@file{org-habits.el}), and encryption
14678 (@file{org-crypt.el}). Also, the capture system is really an extended copy
14679 of his great @file{remember.el}.
14680 @item Sebastian Rose
14681 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
14682 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
14683 higher level. He also wrote @file{org-info.js}, a Java script for displaying
14684 webpages derived from Org using an Info-like or a folding interface with
14685 single-key navigation.
14688 @noindent OK, now to the full list of contributions! Again, please let me
14689 know what I am missing here!
14694 @i{Russel Adams} came up with the idea for drawers.
14696 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
14698 @i{Christophe Bataillon} created the great unicorn logo that we use on the
14701 @i{Alex Bochannek} provided a patch for rounding timestamps.
14703 @i{Jan Böcker} wrote @file{org-docview.el}.
14705 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
14707 @i{Tom Breton} wrote @file{org-choose.el}.
14709 @i{Charles Cave}'s suggestion sparked the implementation of templates
14710 for Remember, which are now templates for capture.
14712 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
14715 @i{Gregory Chernov} patched support for Lisp forms into table
14716 calculations and improved XEmacs compatibility, in particular by porting
14717 @file{nouline.el} to XEmacs.
14719 @i{Sacha Chua} suggested copying some linking code from Planner.
14721 @i{Baoqiu Cui} contributed the DocBook exporter.
14723 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
14724 came up with the idea of properties, and that there should be an API for
14727 @i{Nick Dokos} tracked down several nasty bugs.
14729 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
14730 inspired some of the early development, including HTML export. He also
14731 asked for a way to narrow wide table columns.
14733 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
14734 the Org-Babel documentation into the manual.
14736 @i{Christian Egli} converted the documentation into Texinfo format, inspired
14737 the agenda, patched CSS formatting into the HTML exporter, and wrote
14738 @file{org-taskjuggler.el}.
14740 @i{David Emery} provided a patch for custom CSS support in exported
14743 @i{Nic Ferrier} contributed mailcap and XOXO support.
14745 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
14747 @i{John Foerch} figured out how to make incremental search show context
14748 around a match in a hidden outline tree.
14750 @i{Raimar Finken} wrote @file{org-git-line.el}.
14752 @i{Mikael Fornius} works as a mailing list moderator.
14754 @i{Austin Frank} works as a mailing list moderator.
14756 @i{Eric Fraga} drove the development of BEAMER export with ideas and
14759 @i{Barry Gidden} did proofreading the manual in preparation for the book
14760 publication through Network Theory Ltd.
14762 @i{Niels Giesen} had the idea to automatically archive DONE trees.
14764 @i{Nicolas Goaziou} rewrote much of the plain list code.
14766 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
14768 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
14771 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
14772 task state change logging, and the clocktable. His clear explanations have
14773 been critical when we started to adopt the Git version control system.
14775 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
14778 @i{Phil Jackson} wrote @file{org-irc.el}.
14780 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
14781 folded entries, and column view for properties.
14783 @i{Matt Jones} wrote @i{MobileOrg Android}.
14785 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
14787 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
14788 provided frequent feedback and some patches.
14790 @i{Matt Lundin} has proposed last-row references for table formulas and named
14791 invisible anchors. He has also worked a lot on the FAQ.
14793 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
14794 and is a prolific contributor on the mailing list with competent replies,
14795 small fixes and patches.
14797 @i{Jason F. McBrayer} suggested agenda export to CSV format.
14799 @i{Max Mikhanosha} came up with the idea of refiling.
14801 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
14804 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
14807 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
14809 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
14810 and being able to quickly restrict the agenda to a subtree.
14812 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
14814 @i{Greg Newman} refreshed the unicorn logo into its current form.
14816 @i{Tim O'Callaghan} suggested in-file links, search options for general
14817 file links, and TAGS.
14819 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
14820 version of the reference card.
14822 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
14825 @i{Oliver Oppitz} suggested multi-state TODO items.
14827 @i{Scott Otterson} sparked the introduction of descriptive text for
14828 links, among other things.
14830 @i{Pete Phillips} helped during the development of the TAGS feature, and
14831 provided frequent feedback.
14833 @i{Martin Pohlack} provided the code snippet to bundle character insertion
14834 into bundles of 20 for undo.
14836 @i{T.V. Raman} reported bugs and suggested improvements.
14838 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
14841 @i{Paul Rivier} provided the basic implementation of named footnotes. He
14842 also acted as mailing list moderator for some time.
14844 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
14846 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
14847 conflict with @file{allout.el}.
14849 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
14852 @i{Philip Rooke} created the Org reference card, provided lots
14853 of feedback, developed and applied standards to the Org documentation.
14855 @i{Christian Schlauer} proposed angular brackets around links, among
14858 @i{Paul Sexton} wrote @file{org-ctags.el}.
14860 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
14861 @file{organizer-mode.el}.
14863 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
14864 examples, and remote highlighting for referenced code lines.
14866 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
14867 now packaged into Org's @file{contrib} directory.
14869 @i{Daniel Sinder} came up with the idea of internal archiving by locking
14872 @i{Dale Smith} proposed link abbreviations.
14874 @i{James TD Smith} has contributed a large number of patches for useful
14875 tweaks and features.
14877 @i{Adam Spiers} asked for global linking commands, inspired the link
14878 extension system, added support for mairix, and proposed the mapping API.
14880 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
14881 LaTeX, UTF-8, Latin-1 and ASCII.
14883 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
14884 with links transformation to Org syntax.
14886 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
14887 chapter about publishing.
14889 @i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and
14890 enabled source code highlighling in Gnus.
14892 @i{Stefan Vollmar} organized a video-recorded talk at the
14893 Max-Planck-Institute for Neurology. He also inspired the creation of a
14894 concept index for HTML export.
14896 @i{J@"urgen Vollmer} contributed code generating the table of contents
14899 @i{Samuel Wales} has provided important feedback and bug reports.
14901 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
14904 @i{David Wainberg} suggested archiving, and improvements to the linking
14907 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
14910 @i{Roland Winkler} requested additional key bindings to make Org
14913 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
14914 and contributed various ideas and code snippets.
14918 @node Main Index, Key Index, History and Acknowledgments, Top
14919 @unnumbered Concept index
14923 @node Key Index, Command and Function Index, Main Index, Top
14924 @unnumbered Key index
14928 @node Command and Function Index, Variable Index, Key Index, Top
14929 @unnumbered Command and function index
14933 @node Variable Index, , Command and Function Index, Top
14934 @unnumbered Variable index
14936 This is not a complete index of variables and faces, only the ones that are
14937 mentioned in the manual. For a more complete list, use @kbd{M-x
14938 org-customize @key{RET}} and then click yourself through the tree.
14945 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
14948 @c Local variables:
14950 @c indent-tabs-mode: nil
14951 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
14952 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
14956 @c LocalWords: webdavhost pre