4 @setfilename ../../info/org
5 @settitle The Org Manual
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 and range formulas:: Formula for specific (ranges of) fields
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 * HTML preamble and postamble:: How to insert a preamble and a postamble
585 * Quoting HTML tags:: Using direct HTML in Org-mode
586 * Links in HTML export:: How links will be interpreted and formatted
587 * Tables in HTML export:: How to modify the formatting of tables
588 * Images in HTML export:: How to insert figures into HTML output
589 * Math formatting in HTML export:: Beautiful math also on the web
590 * Text areas in HTML export:: An alternative way to show an example
591 * CSS support:: Changing the appearance of the output
592 * JavaScript support:: Info and Folding in a web browser
594 @LaTeX{} and PDF export
596 * LaTeX/PDF export commands:: Which key invokes which commands
597 * Header and sectioning:: Setting up the export file structure
598 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code
599 * Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
600 * Images in LaTeX export:: How to insert figures into @LaTeX{} output
601 * Beamer class export:: Turning the file into a presentation
605 * DocBook export commands:: How to invoke DocBook export
606 * Quoting DocBook code:: Incorporating DocBook code in Org files
607 * Recursive sections:: Recursive sections in DocBook
608 * Tables in DocBook export:: Tables are exported as HTML tables
609 * Images in DocBook export:: How to insert figures into DocBook output
610 * Special characters:: How to handle special characters
614 * Configuration:: Defining projects
615 * Uploading files:: How to get files up on the server
616 * Sample configuration:: Example projects
617 * Triggering publication:: Publication commands
621 * Project alist:: The central configuration variable
622 * Sources and destinations:: From here to there
623 * Selecting files:: What files are part of the project?
624 * Publishing action:: Setting the function doing the publishing
625 * Publishing options:: Tweaking HTML/@LaTeX{} export
626 * Publishing links:: Which links keep working after publishing?
627 * Sitemap:: Generating a list of all pages
628 * Generating an index:: An index that reaches across pages
632 * Simple example:: One-component publishing
633 * Complex example:: A multi-component publishing example
635 Working with source code
637 * Structure of code blocks:: Code block syntax described
638 * Editing source code:: Language major-mode editing
639 * Exporting code blocks:: Export contents and/or results
640 * Extracting source code:: Create pure source code files
641 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
642 * Library of Babel:: Use and contribute to a library of useful code blocks
643 * Languages:: List of supported code block languages
644 * Header arguments:: Configure code block functionality
645 * Results of evaluation:: How evaluation results are handled
646 * Noweb reference syntax:: Literate programming in Org-mode
647 * Key bindings and useful functions:: Work quickly with code blocks
648 * Batch execution:: Call functions from the command line
652 * Using header arguments:: Different ways to set header arguments
653 * Specific header arguments:: List of header arguments
655 Using header arguments
657 * System-wide header arguments:: Set global default values
658 * Language-specific header arguments:: Set default values by language
659 * Buffer-wide header arguments:: Set default values for a specific buffer
660 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
661 * Code block specific header arguments:: The most common way to set values
662 * Header arguments in function calls:: The most specific level
664 Specific header arguments
666 * var:: Pass arguments to code blocks
667 * results:: Specify the type of results and how they will
668 be collected and handled
669 * file:: Specify a path for file output
670 * dir:: Specify the default (possibly remote)
671 directory for code block execution
672 * exports:: Export code and/or results
673 * tangle:: Toggle tangling and specify file name
674 * mkdirp:: Toggle creation of parent directories of target
675 files during tangling
676 * comments:: Toggle insertion of comments in tangled
678 * padline:: Control insertion of padding lines in tangled
680 * no-expand:: Turn off variable assignment and noweb
681 expansion during tangling
682 * session:: Preserve the state of code evaluation
683 * noweb:: Toggle expansion of noweb references
684 * cache:: Avoid re-evaluating unchanged code blocks
685 * sep:: Delimiter for writing tabular results outside Org
686 * hlines:: Handle horizontal lines in tables
687 * colnames:: Handle column names in tables
688 * rownames:: Handle row names in tables
689 * shebang:: Make tangled files executable
690 * eval:: Limit evaluation of specific code blocks
694 * Completion:: M-TAB knows what you need
695 * Easy Templates:: Quick insertion of structural elements
696 * Speed keys:: Electric commands at the beginning of a headline
697 * Code evaluation security:: Org mode files evaluate inline code
698 * Customization:: Adapting Org to your taste
699 * In-buffer settings:: Overview of the #+KEYWORDS
700 * The very busy C-c C-c key:: When in doubt, press C-c C-c
701 * Clean view:: Getting rid of leading stars in the outline
702 * TTY keys:: Using Org on a tty
703 * Interaction:: Other Emacs packages
705 Interaction with other packages
707 * Cooperation:: Packages Org cooperates with
708 * Conflicts:: Packages that lead to conflicts
712 * Hooks:: Who to reach into Org's internals
713 * Add-on packages:: Available extensions
714 * Adding hyperlink types:: New custom link types
715 * Context-sensitive commands:: How to add functionality to such commands
716 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
717 * Dynamic blocks:: Automatically filled blocks
718 * Special agenda views:: Customized views
719 * Extracting agenda information:: Postprocessing of agenda information
720 * Using the property API:: Writing programs that use entry properties
721 * Using the mapping API:: Mapping over all or selected entries
723 Tables and lists in arbitrary syntax
725 * Radio tables:: Sending and receiving radio tables
726 * A LaTeX example:: Step by step, almost a tutorial
727 * Translator functions:: Copy and modify
728 * Radio lists:: Doing the same for lists
732 * Setting up the staging area:: Where to interact with the mobile device
733 * Pushing to MobileOrg:: Uploading Org files and agendas
734 * Pulling from MobileOrg:: Integrating captured and flagged items
739 @node Introduction, Document Structure, Top, Top
740 @chapter Introduction
744 * Summary:: Brief summary of what Org does
745 * Installation:: How to install a downloaded version of Org
746 * Activation:: How to activate Org for certain buffers
747 * Feedback:: Bug reports, ideas, patches etc.
748 * Conventions:: Type-setting conventions in the manual
751 @node Summary, Installation, Introduction, Introduction
755 Org is a mode for keeping notes, maintaining TODO lists, and doing
756 project planning with a fast and effective plain-text system.
758 Org develops organizational tasks around NOTES files that contain
759 lists or information about projects as plain text. Org is
760 implemented on top of Outline mode, which makes it possible to keep the
761 content of large files well structured. Visibility cycling and
762 structure editing help to work with the tree. Tables are easily created
763 with a built-in table editor. Org supports TODO items, deadlines,
764 timestamps, and scheduling. It dynamically compiles entries into an
765 agenda that utilizes and smoothly integrates much of the Emacs calendar
766 and diary. Plain text URL-like links connect to websites, emails,
767 Usenet messages, BBDB entries, and any files related to the projects.
768 For printing and sharing of notes, an Org file can be exported as a
769 structured ASCII file, as HTML, or (TODO and agenda items only) as an
770 iCalendar file. It can also serve as a publishing tool for a set of
773 As a project planning environment, Org works by adding metadata to outline
774 nodes. Based on this data, specific entries can be extracted in queries and
775 create dynamic @i{agenda views}.
777 Org mode contains the Org Babel environment which allows you to work with
778 embedded source code blocks in a file, to facilitate code evaluation,
779 documentation, and literate programming techniques.
781 Org's automatic, context-sensitive table editor with spreadsheet
782 capabilities can be integrated into any major mode by activating the
783 minor Orgtbl mode. Using a translation step, it can be used to maintain
784 tables in arbitrary file types, for example in @LaTeX{}. The structure
785 editing and list creation capabilities can be used outside Org with
786 the minor Orgstruct mode.
788 Org keeps simple things simple. When first fired up, it should
789 feel like a straightforward, easy to use outliner. Complexity is not
790 imposed, but a large amount of functionality is available when you need
791 it. Org is a toolbox and can be used in different ways and for different
795 @r{@bullet{} an outline extension with visibility cycling and structure editing}
796 @r{@bullet{} an ASCII system and table editor for taking structured notes}
797 @r{@bullet{} a TODO list editor}
798 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
799 @pindex GTD, Getting Things Done
800 @r{@bullet{} an environment in which to implement David Allen's GTD system}
801 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
802 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
803 @r{@bullet{} an environment for literate programming}
808 There is a website for Org which provides links to the newest
809 version of Org, as well as additional information, frequently asked
810 questions (FAQ), links to tutorials, etc@. This page is located at
811 @uref{http://orgmode.org}.
813 @cindex print edition
814 The version 7.3 of this manual is available as a
815 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
821 @node Installation, Activation, Summary, Introduction
822 @section Installation
826 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
827 distribution or an XEmacs package, please skip this section and go directly
828 to @ref{Activation}. To see what version of Org (if any) is part of your
829 Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x
832 If you have downloaded Org from the Web, either as a distribution @file{.zip}
833 or @file{.tar} file, or as a Git archive, you must take the following steps
834 to install it: go into the unpacked Org distribution directory and edit the
835 top section of the file @file{Makefile}. You must set the name of the Emacs
836 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
837 directories where local Lisp and Info files are kept. If you don't have
838 access to the system-wide directories, you can simply run Org directly from
839 the distribution directory by adding the @file{lisp} subdirectory to the
840 Emacs load path. To do this, add the following line to @file{.emacs}:
843 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
847 If you plan to use code from the @file{contrib} subdirectory, do a similar
848 step for this directory:
851 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
854 @noindent Now byte-compile the Lisp files with the shell command:
860 @noindent If you are running Org from the distribution directory, this is
861 all. If you want to install Org into the system directories, use (as
868 Installing Info files is system dependent, because of differences in the
869 @file{install-info} program. In Debian it copies the info files into the
870 correct directory and modifies the info directory file. In many other
871 systems, the files need to be copied to the correct directory separately, and
872 @file{install-info} then only modifies the directory file. Check your system
873 documentation to find out which of the following commands you need:
877 make install-info-debian
880 Then add the following line to @file{.emacs}. It is needed so that
881 Emacs can autoload functions that are located in files not immediately loaded
882 when Org-mode starts.
884 (require 'org-install)
887 Do not forget to activate Org as described in the following section.
890 @node Activation, Feedback, Installation, Introduction
894 @cindex global key bindings
895 @cindex key bindings, global
897 To make sure files with extension @file{.org} use Org mode, add the following
898 line to your @file{.emacs} file.
900 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
902 @noindent Org mode buffers need font-lock to be turned on - this is the
903 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
904 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
906 The four Org commands @command{org-store-link}, @command{org-capture},
907 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
908 global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are
909 suggested bindings for these keys, please modify the keys to your own
912 (global-set-key "\C-cl" 'org-store-link)
913 (global-set-key "\C-cc" 'org-capture)
914 (global-set-key "\C-ca" 'org-agenda)
915 (global-set-key "\C-cb" 'org-iswitchb)
918 @cindex Org-mode, turning on
919 With this setup, all files with extension @samp{.org} will be put
920 into Org-mode. As an alternative, make the first line of a file look
924 MY PROJECTS -*- mode: org; -*-
927 @vindex org-insert-mode-line-in-empty-file
928 @noindent which will select Org-mode for this buffer no matter what
929 the file's name is. See also the variable
930 @code{org-insert-mode-line-in-empty-file}.
932 Many commands in Org work on the region if the region is @i{active}. To make
933 use of this, you need to have @code{transient-mark-mode}
934 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
935 in Emacs 22 you need to do this yourself with
937 (transient-mark-mode 1)
939 @noindent If you do not like @code{transient-mark-mode}, you can create an
940 active region by using the mouse to select a region, or pressing
941 @kbd{C-@key{SPC}} twice before moving the cursor.
943 @node Feedback, Conventions, Activation, Introduction
950 If you find problems with Org, or if you have questions, remarks, or ideas
951 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
952 If you are not a member of the mailing list, your mail will be passed to the
953 list after a moderator has approved it@footnote{Please consider subscribing
954 to the mailing list, in order to minimize the work the mailing list
955 moderators have to do.}.
957 For bug reports, please first try to reproduce the bug with the latest
958 version of Org available---if you are running an outdated version, it is
959 quite possible that the bug has been fixed already. If the bug persists,
960 prepare a report and provide as much information as possible, including the
961 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
962 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
963 @file{.emacs}. The easiest way to do this is to use the command
965 @kbd{M-x org-submit-bug-report}
967 @noindent which will put all this information into an Emacs mail buffer so
968 that you only need to add your description. If you re not sending the Email
969 from within Emacs, please copy and paste the content into your Email program.
971 If an error occurs, a backtrace can be very useful (see below on how to
972 create one). Often a small example file helps, along with clear information
976 @item What exactly did you do?
977 @item What did you expect to happen?
978 @item What happened instead?
980 @noindent Thank you for helping to improve this program.
982 @subsubheading How to create a useful backtrace
984 @cindex backtrace of an error
985 If working with Org produces an error with a message you don't
986 understand, you may have hit a bug. The best way to report this is by
987 providing, in addition to what was mentioned above, a @emph{backtrace}.
988 This is information from the built-in debugger about where and how the
989 error occurred. Here is how to produce a useful backtrace:
993 Reload uncompiled versions of all Org-mode Lisp files. The backtrace
994 contains much more information if it is produced with uncompiled code.
997 C-u M-x org-reload RET
1000 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1003 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1004 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1006 Do whatever you have to do to hit the error. Don't forget to
1007 document the steps you take.
1009 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1010 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1011 attach it to your bug report.
1014 @node Conventions, , Feedback, Introduction
1015 @section Typesetting conventions used in this manual
1017 Org uses three types of keywords: TODO keywords, tags, and property
1018 names. In this manual we use the following conventions:
1023 TODO keywords are written with all capitals, even if they are
1027 User-defined tags are written in lowercase; built-in tags with special
1028 meaning are written with all capitals.
1031 User-defined properties are capitalized; built-in properties with
1032 special meaning are written with all capitals.
1035 The manual lists both the keys and the corresponding commands for accessing
1036 functionality. Org mode often uses the same key for different functions,
1037 depending on context. The command that is bound to such keys has a generic
1038 name, like @code{org-metaright}. In the manual we will, wherever possible,
1039 give the function that is internally called by the generic command. For
1040 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1041 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1042 be listed to call org-table-move-column-right.
1044 If you prefer, you can compile the manual without the command names by
1045 unsetting the flag @code{cmdnames} in @file{org.texi}.
1047 @node Document Structure, Tables, Introduction, Top
1048 @chapter Document structure
1049 @cindex document structure
1050 @cindex structure of document
1052 Org is based on Outline mode and provides flexible commands to
1053 edit the structure of the document.
1056 * Outlines:: Org is based on Outline mode
1057 * Headlines:: How to typeset Org tree headlines
1058 * Visibility cycling:: Show and hide, much simplified
1059 * Motion:: Jumping to other headlines
1060 * Structure editing:: Changing sequence and level of headlines
1061 * Sparse trees:: Matches embedded in context
1062 * Plain lists:: Additional structure within an entry
1063 * Drawers:: Tucking stuff away
1064 * Blocks:: Folding blocks
1065 * Footnotes:: How footnotes are defined in Org's syntax
1066 * Orgstruct mode:: Structure editing outside Org
1069 @node Outlines, Headlines, Document Structure, Document Structure
1072 @cindex Outline mode
1074 Org is implemented on top of Outline mode. Outlines allow a
1075 document to be organized in a hierarchical structure, which (at least
1076 for me) is the best representation of notes and thoughts. An overview
1077 of this structure is achieved by folding (hiding) large parts of the
1078 document to show only the general document structure and the parts
1079 currently being worked on. Org greatly simplifies the use of
1080 outlines by compressing the entire show/hide functionality into a single
1081 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1083 @node Headlines, Visibility cycling, Outlines, Document Structure
1086 @cindex outline tree
1087 @vindex org-special-ctrl-a/e
1088 @vindex org-special-ctrl-k
1089 @vindex org-ctrl-k-protect-subtree
1091 Headlines define the structure of an outline tree. The headlines in Org
1092 start with one or more stars, on the left margin@footnote{See the variables
1093 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1094 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1095 @kbd{C-e}, and @kbd{C-k} in headlines.}. For example:
1098 * Top level headline
1105 * Another top level headline
1108 @noindent Some people find the many stars too noisy and would prefer an
1109 outline that has whitespace followed by a single star as headline
1110 starters. @ref{Clean view}, describes a setup to realize this.
1112 @vindex org-cycle-separator-lines
1113 An empty line after the end of a subtree is considered part of it and
1114 will be hidden when the subtree is folded. However, if you leave at
1115 least two empty lines, one empty line will remain visible after folding
1116 the subtree, in order to structure the collapsed view. See the
1117 variable @code{org-cycle-separator-lines} to modify this behavior.
1119 @node Visibility cycling, Motion, Headlines, Document Structure
1120 @section Visibility cycling
1121 @cindex cycling, visibility
1122 @cindex visibility cycling
1123 @cindex trees, visibility
1124 @cindex show hidden text
1127 Outlines make it possible to hide parts of the text in the buffer.
1128 Org uses just two commands, bound to @key{TAB} and
1129 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1131 @cindex subtree visibility states
1132 @cindex subtree cycling
1133 @cindex folded, subtree visibility state
1134 @cindex children, subtree visibility state
1135 @cindex subtree, subtree visibility state
1137 @orgcmd{@key{TAB},org-cycle}
1138 @emph{Subtree cycling}: Rotate current subtree among the states
1141 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1142 '-----------------------------------'
1145 @vindex org-cycle-emulate-tab
1146 @vindex org-cycle-global-at-bob
1147 The cursor must be on a headline for this to work@footnote{see, however,
1148 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1149 beginning of the buffer and the first line is not a headline, then
1150 @key{TAB} actually runs global cycling (see below)@footnote{see the
1151 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1152 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1154 @cindex global visibility states
1155 @cindex global cycling
1156 @cindex overview, global visibility state
1157 @cindex contents, global visibility state
1158 @cindex show all, global visibility state
1159 @orgcmd{S-@key{TAB},org-global-cycle}
1160 @itemx C-u @key{TAB}
1161 @emph{Global cycling}: Rotate the entire buffer among the states
1164 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1165 '--------------------------------------'
1168 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1169 CONTENTS view up to headlines of level N will be shown. Note that inside
1170 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1172 @cindex show all, command
1173 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1174 Show all, including drawers.
1175 @orgcmd{C-c C-r,org-reveal}
1176 Reveal context around point, showing the current entry, the following heading
1177 and the hierarchy above. Useful for working near a location that has been
1178 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1179 (@pxref{Agenda commands}). With a prefix argument show, on each
1180 level, all sibling headings. With double prefix arg, also show the entire
1181 subtree of the parent.
1182 @orgcmd{C-c C-k,show-branches}
1183 Expose all the headings of the subtree, CONTENT view for just one subtree.
1184 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1185 Show the current subtree in an indirect buffer@footnote{The indirect
1188 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1191 (see the Emacs manual for more information about indirect buffers)
1193 will contain the entire buffer, but will be narrowed to the current
1194 tree. Editing the indirect buffer will also change the original buffer,
1195 but without affecting visibility in that buffer.}. With a numeric
1196 prefix argument N, go up to level N and then take that tree. If N is
1197 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1198 the previously used indirect buffer.
1201 @vindex org-startup-folded
1202 @cindex @code{overview}, STARTUP keyword
1203 @cindex @code{content}, STARTUP keyword
1204 @cindex @code{showall}, STARTUP keyword
1205 @cindex @code{showeverything}, STARTUP keyword
1207 When Emacs first visits an Org file, the global state is set to
1208 OVERVIEW, i.e.@: only the top level headlines are visible. This can be
1209 configured through the variable @code{org-startup-folded}, or on a
1210 per-file basis by adding one of the following lines anywhere in the
1217 #+STARTUP: showeverything
1220 @cindex property, VISIBILITY
1222 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1223 and Columns}) will get their visibility adapted accordingly. Allowed values
1224 for this property are @code{folded}, @code{children}, @code{content}, and
1227 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1228 Switch back to the startup visibility of the buffer, i.e.@: whatever is
1229 requested by startup options and @samp{VISIBILITY} properties in individual
1233 @node Motion, Structure editing, Visibility cycling, Document Structure
1235 @cindex motion, between headlines
1236 @cindex jumping, to headlines
1237 @cindex headline navigation
1238 The following commands jump to other headlines in the buffer.
1241 @orgcmd{C-c C-n,outline-next-visible-heading}
1243 @orgcmd{C-c C-p,outline-previous-visible-heading}
1245 @orgcmd{C-c C-f,org-forward-same-level}
1246 Next heading same level.
1247 @orgcmd{C-c C-b,org-backward-same-level}
1248 Previous heading same level.
1249 @orgcmd{C-c C-u,outline-up-heading}
1250 Backward to higher level heading.
1251 @orgcmd{C-c C-j,org-goto}
1252 Jump to a different place without changing the current outline
1253 visibility. Shows the document structure in a temporary buffer, where
1254 you can use the following keys to find your destination:
1255 @vindex org-goto-auto-isearch
1257 @key{TAB} @r{Cycle visibility.}
1258 @key{down} / @key{up} @r{Next/previous visible headline.}
1259 @key{RET} @r{Select this location.}
1260 @kbd{/} @r{Do a Sparse-tree search}
1261 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1262 n / p @r{Next/previous visible headline.}
1263 f / b @r{Next/previous headline same level.}
1265 0-9 @r{Digit argument.}
1268 @vindex org-goto-interface
1270 See also the variable @code{org-goto-interface}.
1273 @node Structure editing, Sparse trees, Motion, Document Structure
1274 @section Structure editing
1275 @cindex structure editing
1276 @cindex headline, promotion and demotion
1277 @cindex promotion, of subtrees
1278 @cindex demotion, of subtrees
1279 @cindex subtree, cut and paste
1280 @cindex pasting, of subtrees
1281 @cindex cutting, of subtrees
1282 @cindex copying, of subtrees
1283 @cindex sorting, of subtrees
1284 @cindex subtrees, cut and paste
1287 @orgcmd{M-@key{RET},org-insert-heading}
1288 @vindex org-M-RET-may-split-line
1289 Insert new heading with same level as current. If the cursor is in a plain
1290 list item, a new item is created (@pxref{Plain lists}). To force creation of
1291 a new headline, use a prefix argument. When this command is used in the
1292 middle of a line, the line is split and the rest of the line becomes the new
1293 headline@footnote{If you do not want the line to be split, customize the
1294 variable @code{org-M-RET-may-split-line}.}. If the command is used at the
1295 beginning of a headline, the new headline is created before the current line.
1296 If at the beginning of any other line, the content of that line is made the
1297 new heading. If the command is used at the end of a folded subtree (i.e.@:
1298 behind the ellipses at the end of a headline), then a headline like the
1299 current one will be inserted after the end of the subtree.
1300 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1301 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1302 current heading, the new heading is placed after the body instead of before
1303 it. This command works from anywhere in the entry.
1304 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1305 @vindex org-treat-insert-todo-heading-as-state-change
1306 Insert new TODO entry with same level as current heading. See also the
1307 variable @code{org-treat-insert-todo-heading-as-state-change}.
1308 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1309 Insert new TODO entry with same level as current heading. Like
1310 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1312 @orgcmd{@key{TAB},org-cycle}
1313 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1314 become a child of the previous one. The next @key{TAB} makes it a parent,
1315 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1316 to the initial level.
1317 @orgcmd{M-@key{left},org-do-promote}
1318 Promote current heading by one level.
1319 @orgcmd{M-@key{right},org-do-demote}
1320 Demote current heading by one level.
1321 @orgcmd{M-S-@key{left},org-promote-subtree}
1322 Promote the current subtree by one level.
1323 @orgcmd{M-S-@key{right},org-demote-subtree}
1324 Demote the current subtree by one level.
1325 @orgcmd{M-S-@key{up},org-move-subtree-up}
1326 Move subtree up (swap with previous subtree of same
1328 @orgcmd{M-S-@key{down},org-move-subtree-down}
1329 Move subtree down (swap with next subtree of same level).
1330 @orgcmd{C-c C-x C-w,org-cut-subtree}
1331 Kill subtree, i.e.@: remove it from buffer but save in kill ring.
1332 With a numeric prefix argument N, kill N sequential subtrees.
1333 @orgcmd{C-c C-x M-w,org-copy-subtree}
1334 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1335 sequential subtrees.
1336 @orgcmd{C-c C-x C-y,org-paste-subtree}
1337 Yank subtree from kill ring. This does modify the level of the subtree to
1338 make sure the tree fits in nicely at the yank position. The yank level can
1339 also be specified with a numeric prefix argument, or by yanking after a
1340 headline marker like @samp{****}.
1341 @orgcmd{C-y,org-yank}
1342 @vindex org-yank-adjusted-subtrees
1343 @vindex org-yank-folded-subtrees
1344 Depending on the variables @code{org-yank-adjusted-subtrees} and
1345 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1346 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1347 C-x C-y}. With the default settings, no level adjustment will take place,
1348 but the yanked tree will be folded unless doing so would swallow text
1349 previously visible. Any prefix argument to this command will force a normal
1350 @code{yank} to be executed, with the prefix passed along. A good way to
1351 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1352 yank, it will yank previous kill items plainly, without adjustment and
1354 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1355 Clone a subtree by making a number of sibling copies of it. You will be
1356 prompted for the number of copies to make, and you can also specify if any
1357 timestamps in the entry should be shifted. This can be useful, for example,
1358 to create a number of tasks related to a series of lectures to prepare. For
1359 more details, see the docstring of the command
1360 @code{org-clone-subtree-with-time-shift}.
1361 @orgcmd{C-c C-w,org-refile}
1362 Refile entry or region to a different location. @xref{Refiling notes}.
1363 @orgcmd{C-c ^,org-sort-entries-or-items}
1364 Sort same-level entries. When there is an active region, all entries in the
1365 region will be sorted. Otherwise the children of the current headline are
1366 sorted. The command prompts for the sorting method, which can be
1367 alphabetically, numerically, by time (first timestamp with active preferred,
1368 creation time, scheduled time, deadline time), by priority, by TODO keyword
1369 (in the sequence the keywords have been defined in the setup) or by the value
1370 of a property. Reverse sorting is possible as well. You can also supply
1371 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1372 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1373 entries will also be removed.
1374 @orgcmd{C-x n s,org-narrow-to-subtree}
1375 Narrow buffer to current subtree.
1376 @orgcmd{C-x n b,org-narrow-to-block}
1377 Narrow buffer to current block.
1378 @orgcmd{C-x n w,widen}
1379 Widen buffer to remove narrowing.
1380 @orgcmd{C-c *,org-toggle-heading}
1381 Turn a normal line or plain list item into a headline (so that it becomes a
1382 subheading at its location). Also turn a headline into a normal line by
1383 removing the stars. If there is an active region, turn all lines in the
1384 region into headlines. If the first line in the region was an item, turn
1385 only the item lines into headlines. Finally, if the first line is a
1386 headline, remove the stars from all headlines in the region.
1389 @cindex region, active
1390 @cindex active region
1391 @cindex transient mark mode
1392 When there is an active region (Transient Mark mode), promotion and
1393 demotion work on all headlines in the region. To select a region of
1394 headlines, it is best to place both point and mark at the beginning of a
1395 line, mark at the beginning of the first headline, and point at the line
1396 just after the last headline to change. Note that when the cursor is
1397 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1401 @node Sparse trees, Plain lists, Structure editing, Document Structure
1402 @section Sparse trees
1403 @cindex sparse trees
1404 @cindex trees, sparse
1405 @cindex folding, sparse trees
1406 @cindex occur, command
1408 @vindex org-show-hierarchy-above
1409 @vindex org-show-following-heading
1410 @vindex org-show-siblings
1411 @vindex org-show-entry-below
1412 An important feature of Org-mode is the ability to construct @emph{sparse
1413 trees} for selected information in an outline tree, so that the entire
1414 document is folded as much as possible, but the selected information is made
1415 visible along with the headline structure above it@footnote{See also the
1416 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1417 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1418 control on how much context is shown around each match.}. Just try it out
1419 and you will see immediately how it works.
1421 Org-mode contains several commands creating such trees, all these
1422 commands can be accessed through a dispatcher:
1425 @orgcmd{C-c /,org-sparse-tree}
1426 This prompts for an extra key to select a sparse-tree creating command.
1427 @orgcmd{C-c / r,org-occur}
1428 @vindex org-remove-highlights-with-change
1429 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1430 the match is in a headline, the headline is made visible. If the match is in
1431 the body of an entry, headline and body are made visible. In order to
1432 provide minimal context, also the full hierarchy of headlines above the match
1433 is shown, as well as the headline following the match. Each match is also
1434 highlighted; the highlights disappear when the buffer is changed by an
1435 editing command@footnote{This depends on the option
1436 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1437 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1438 so several calls to this command can be stacked.
1439 @orgcmdkkc{M-g n,M-g M-n,next-error}
1440 Jump to the next sparse tree match in this buffer.
1441 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1442 Jump to the previous sparse tree match in this buffer.
1447 @vindex org-agenda-custom-commands
1448 For frequently used sparse trees of specific search strings, you can
1449 use the variable @code{org-agenda-custom-commands} to define fast
1450 keyboard access to specific sparse trees. These commands will then be
1451 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1455 (setq org-agenda-custom-commands
1456 '(("f" occur-tree "FIXME")))
1459 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1460 a sparse tree matching the string @samp{FIXME}.
1462 The other sparse tree commands select headings based on TODO keywords,
1463 tags, or properties and will be discussed later in this manual.
1466 @cindex printing sparse trees
1467 @cindex visible text, printing
1468 To print a sparse tree, you can use the Emacs command
1469 @code{ps-print-buffer-with-faces} which does not print invisible parts
1470 of the document @footnote{This does not work under XEmacs, because
1471 XEmacs uses selective display for outlining, not text properties.}.
1472 Or you can use the command @kbd{C-c C-e v} to export only the visible
1473 part of the document and print the resulting file.
1475 @node Plain lists, Drawers, Sparse trees, Document Structure
1476 @section Plain lists
1478 @cindex lists, plain
1479 @cindex lists, ordered
1480 @cindex ordered lists
1482 Within an entry of the outline tree, hand-formatted lists can provide
1483 additional structure. They also provide a way to create lists of checkboxes
1484 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1485 (@pxref{Exporting}) can parse and format them.
1487 Org knows ordered lists, unordered lists, and description lists.
1490 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1491 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1492 they will be seen as top-level headlines. Also, when you are hiding leading
1493 stars to get a clean outline view, plain list items starting with a star may
1494 be hard to distinguish from true headlines. In short: even though @samp{*}
1495 is supported, it may be better to not use it for plain list items.} as
1498 @vindex org-plain-list-ordered-item-terminator
1499 @vindex org-alphabetical-lists
1500 @emph{Ordered} list items start with a numeral followed by either a period or
1501 a right parenthesis@footnote{You can filter out any of them by configuring
1502 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1503 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1504 @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
1505 confusion with normal text, those are limited to one character only. Beyond
1506 that limit, bullets will automatically fallback to numbers.}. If you want a
1507 list to start with a different value (e.g.@: 20), start the text of the item
1508 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1509 must be put @emph{before} the checkbox. If you have activated alphabetical
1510 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1511 be used in any item of the list in order to enforce a particular numbering.
1513 @emph{Description} list items are unordered list items, and contain the
1514 separator @samp{ :: } to distinguish the description @emph{term} from the
1518 Items belonging to the same list must have the same indentation on the first
1519 line. In particular, if an ordered list reaches number @samp{10.}, then the
1520 2--digit numbers must be written left-aligned with the other numbers in the
1521 list. An item ends before the next line that is less or equally indented
1522 than its bullet/number.
1524 @vindex org-list-ending-method
1525 @vindex org-list-end-regexp
1526 @vindex org-empty-line-terminates-plain-lists
1527 Two methods@footnote{To disable either of them, configure
1528 @code{org-list-ending-method}.} are provided to terminate lists. A list ends
1529 whenever every item has ended, which means before any line less or equally
1530 indented than items at top level. It also ends before two blank
1531 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
1532 that case, all items are closed. For finer control, you can end lists with
1533 any pattern set in @code{org-list-end-regexp}. Here is an example:
1537 ** Lord of the Rings
1538 My favorite scenes are (in this order)
1539 1. The attack of the Rohirrim
1540 2. Eowyn's fight with the witch king
1541 + this was already my favorite scene in the book
1542 + I really like Miranda Otto.
1543 3. Peter Jackson being shot by Legolas
1545 He makes a really funny face when it happens.
1546 But in the end, no individual scenes matter but the film as a whole.
1547 Important actors in this film are:
1548 - @b{Elijah Wood} :: He plays Frodo
1549 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1550 him very well from his role as Mikey Walsh in @i{The Goonies}.
1554 Org supports these lists by tuning filling and wrapping commands to deal with
1555 them correctly@footnote{Org only changes the filling settings for Emacs. For
1556 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1557 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1558 properly (@pxref{Exporting}). Since indentation is what governs the
1559 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1560 blocks can be indented to signal that they belong to a particular item.
1562 @vindex org-list-demote-modify-bullet
1563 If you find that using a different bullet for a sub-list (than that used for
1564 the current list-level) improves readability, customize the variable
1565 @code{org-list-demote-modify-bullet}.
1567 @vindex org-list-automatic-rules
1568 The following commands act on items when the cursor is in the first line of
1569 an item (the line with the bullet or number). Some of them imply the
1570 application of automatic rules to keep list structure intact. If some of
1571 these actions get in your way, configure @code{org-list-automatic-rules}
1572 to disable them individually.
1575 @orgcmd{@key{TAB},org-cycle}
1576 @vindex org-cycle-include-plain-lists
1577 Items can be folded just like headline levels. Normally this works only if
1578 the cursor is on a plain list item. For more details, see the variable
1579 @code{org-cycle-include-plain-lists}. If this variable is set to
1580 @code{integrate}, plain list items will be treated like low-level
1581 headlines. The level of an item is then given by the
1582 indentation of the bullet/number. Items are always subordinate to real
1583 headlines, however; the hierarchies remain completely separated.
1584 @orgcmd{M-@key{RET},org-insert-heading}
1585 @vindex org-M-RET-may-split-line
1586 @vindex org-list-automatic-rules
1587 Insert new item at current level. With a prefix argument, force a new
1588 heading (@pxref{Structure editing}). If this command is used in the middle
1589 of an item, that item is @emph{split} in two, and the second part becomes the
1590 new item@footnote{If you do not want the item to be split, customize the
1591 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1592 @emph{before item's body}, the new item is created @emph{before} the current
1594 @kindex M-S-@key{RET}
1596 Insert a new item with a checkbox (@pxref{Checkboxes}).
1597 @orgcmd{@key{TAB},org-cycle}
1598 In a new item with no text yet, the first @key{TAB} demotes the item to
1599 become a child of the previous one. Subsequent @key{TAB}s move the item to
1600 meaningful levels in the list and eventually get it back to its initial
1602 @kindex S-@key{down}
1605 @cindex shift-selection-mode
1606 @vindex org-support-shift-select
1607 Jump to the previous/next item in the current list, but only if
1608 @code{org-support-shift-select} is off. If not, you can still use paragraph
1609 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1611 @kindex M-S-@key{up}
1612 @kindex M-S-@key{down}
1614 @itemx M-S-@key{down}
1615 Move the item including subitems up/down (swap with previous/next item
1616 of same indentation). If the list is ordered, renumbering is
1618 @kindex M-@key{left}
1619 @kindex M-@key{right}
1621 @itemx M-@key{right}
1622 Decrease/increase the indentation of an item, leaving children alone.
1623 @kindex M-S-@key{left}
1624 @kindex M-S-@key{right}
1625 @item M-S-@key{left}
1626 @itemx M-S-@key{right}
1627 Decrease/increase the indentation of the item, including subitems.
1628 Initially, the item tree is selected based on current indentation. When
1629 these commands are executed several times in direct succession, the initially
1630 selected region is used, even if the new indentation would imply a different
1631 hierarchy. To use the new hierarchy, break the command chain with a cursor
1634 As a special case, using this command on the very first item of a list will
1635 move the whole list. This behavior can be disabled by configuring
1636 @code{org-list-automatic-rules}. The global indentation of a list has no
1637 influence on the text @emph{after} the list.
1640 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1641 state of the checkbox. In any case, verify bullets and indentation
1642 consistency in the whole list.
1644 @vindex org-plain-list-ordered-item-terminator
1645 @vindex org-list-automatic-rules
1647 Cycle the entire list level through the different itemize/enumerate bullets
1648 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1649 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1650 and its position@footnote{See @code{bullet} rule in
1651 @code{org-list-automatic-rules} for more information.}. With a numeric
1652 prefix argument N, select the Nth bullet from this list. If there is an
1653 active region when calling this, selected text will be changed into an item.
1654 With a prefix argument, all lines will be converted to list items. If the
1655 first line already was a list item, any item marker will be removed from the
1656 list. Finally, even without an active region, a normal line will be
1657 converted into a list item.
1660 Turn a plain list item into a headline (so that it becomes a subheading at
1661 its location). @xref{Structure editing}, for a detailed explanation.
1664 Turn the whole plain list into a subtree of the current heading. Checkboxes
1665 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1667 @kindex S-@key{left}
1668 @kindex S-@key{right}
1669 @item S-@key{left}/@key{right}
1670 @vindex org-support-shift-select
1671 This command also cycles bullet styles when the cursor in on the bullet or
1672 anywhere in an item line, details depending on
1673 @code{org-support-shift-select}.
1676 Sort the plain list. You will be prompted for the sorting method:
1677 numerically, alphabetically, by time, or by custom function.
1680 @node Drawers, Blocks, Plain lists, Document Structure
1684 @cindex visibility cycling, drawers
1687 Sometimes you want to keep information associated with an entry, but you
1688 normally don't want to see it. For this, Org-mode has @emph{drawers}.
1689 Drawers need to be configured with the variable
1690 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1691 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1695 ** This is a headline
1696 Still outside the drawer
1698 This is inside the drawer.
1703 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1704 show the entry, but keep the drawer collapsed to a single line. In order to
1705 look inside the drawer, you need to move the cursor to the drawer line and
1706 press @key{TAB} there. Org-mode uses the @code{PROPERTIES} drawer for
1707 storing properties (@pxref{Properties and Columns}), and you can also arrange
1708 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1709 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1710 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1715 Add a time-stamped note to the LOGBOOK drawer.
1718 @node Blocks, Footnotes, Drawers, Document Structure
1721 @vindex org-hide-block-startup
1722 @cindex blocks, folding
1723 Org-mode uses begin...end blocks for various purposes from including source
1724 code examples (@pxref{Literal examples}) to capturing time logging
1725 information (@pxref{Clocking work time}). These blocks can be folded and
1726 unfolded by pressing TAB in the begin line. You can also get all blocks
1727 folded at startup by configuring the variable @code{org-hide-block-startup}
1728 or on a per-file basis by using
1730 @cindex @code{hideblocks}, STARTUP keyword
1731 @cindex @code{nohideblocks}, STARTUP keyword
1733 #+STARTUP: hideblocks
1734 #+STARTUP: nohideblocks
1737 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1741 Org-mode supports the creation of footnotes. In contrast to the
1742 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
1743 larger document, not only for one-off documents like emails. The basic
1744 syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
1745 defined in a paragraph that is started by a footnote marker in square
1746 brackets in column 0, no indentation allowed. If you need a paragraph break
1747 inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
1748 is simply the marker in square brackets, inside text. For example:
1751 The Org homepage[fn:1] now looks a lot better than it used to.
1753 [fn:1] The link is: http://orgmode.org
1756 Org-mode extends the number-based syntax to @emph{named} footnotes and
1757 optional inline definition. Using plain numbers as markers (as
1758 @file{footnote.el} does) is supported for backward compatibility, but not
1759 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1760 LaTeX}). Here are the valid references:
1764 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1765 recommended because something like @samp{[1]} could easily be part of a code
1768 A named footnote reference, where @code{name} is a unique label word, or, for
1769 simplicity of automatic creation, a number.
1770 @item [fn:: This is the inline definition of this footnote]
1771 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1773 @item [fn:name: a definition]
1774 An inline definition of a footnote, which also specifies a name for the note.
1775 Since Org allows multiple references to the same note, you can then use
1776 @code{[fn:name]} to create additional references.
1779 @vindex org-footnote-auto-label
1780 Footnote labels can be created automatically, or you can create names yourself.
1781 This is handled by the variable @code{org-footnote-auto-label} and its
1782 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1785 @noindent The following command handles footnotes:
1790 The footnote action command.
1792 When the cursor is on a footnote reference, jump to the definition. When it
1793 is at a definition, jump to the (first) reference.
1795 @vindex org-footnote-define-inline
1796 @vindex org-footnote-section
1797 @vindex org-footnote-auto-adjust
1798 Otherwise, create a new footnote. Depending on the variable
1799 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1800 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1801 definition will be placed right into the text as part of the reference, or
1802 separately into the location determined by the variable
1803 @code{org-footnote-section}.
1805 When this command is called with a prefix argument, a menu of additional
1808 s @r{Sort the footnote definitions by reference sequence. During editing,}
1809 @r{Org makes no effort to sort footnote definitions into a particular}
1810 @r{sequence. If you want them sorted, use this command, which will}
1811 @r{also move entries according to @code{org-footnote-section}. Automatic}
1812 @r{sorting after each insertion/deletion can be configured using the}
1813 @r{variable @code{org-footnote-auto-adjust}.}
1814 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1815 @r{after each insertion/deletion can be configured using the variable}
1816 @r{@code{org-footnote-auto-adjust}.}
1817 S @r{Short for first @code{r}, then @code{s} action.}
1818 n @r{Normalize the footnotes by collecting all definitions (including}
1819 @r{inline definitions) into a special section, and then numbering them}
1820 @r{in sequence. The references will then also be numbers. This is}
1821 @r{meant to be the final step before finishing a document (e.g.@: sending}
1822 @r{off an email). The exporters do this automatically, and so could}
1823 @r{something like @code{message-send-hook}.}
1824 d @r{Delete the footnote at point, and all definitions of and references}
1827 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1828 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1829 renumbering and sorting footnotes can be automatic after each insertion or
1834 If the cursor is on a footnote reference, jump to the definition. If it is a
1835 the definition, jump back to the reference. When called at a footnote
1836 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1840 @item C-c C-o @r{or} mouse-1/2
1841 Footnote labels are also links to the corresponding definition/reference, and
1842 you can use the usual commands to follow these links.
1845 @node Orgstruct mode, , Footnotes, Document Structure
1846 @section The Orgstruct minor mode
1847 @cindex Orgstruct mode
1848 @cindex minor mode for structure editing
1850 If you like the intuitive way the Org-mode structure editing and list
1851 formatting works, you might want to use these commands in other modes like
1852 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1853 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1854 turn it on by default, for example in Message mode, with one of:
1857 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1858 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1861 When this mode is active and the cursor is on a line that looks to Org like a
1862 headline or the first line of a list item, most structure editing commands
1863 will work, even if the same keys normally have different functionality in the
1864 major mode you are using. If the cursor is not in one of those special
1865 lines, Orgstruct mode lurks silently in the shadows. When you use
1866 @code{orgstruct++-mode}, Org will also export indentation and autofill
1867 settings into that mode, and detect item context after the first line of an
1870 @node Tables, Hyperlinks, Document Structure, Top
1873 @cindex editing tables
1875 Org comes with a fast and intuitive table editor. Spreadsheet-like
1876 calculations are supported using the Emacs @file{calc} package
1878 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1881 (see the Emacs Calculator manual for more information about the Emacs
1886 * Built-in table editor:: Simple tables
1887 * Column width and alignment:: Overrule the automatic settings
1888 * Column groups:: Grouping to trigger vertical lines
1889 * Orgtbl mode:: The table editor as minor mode
1890 * The spreadsheet:: The table editor has spreadsheet capabilities
1891 * Org-Plot:: Plotting from org tables
1894 @node Built-in table editor, Column width and alignment, Tables, Tables
1895 @section The built-in table editor
1896 @cindex table editor, built-in
1898 Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as
1899 the first non-whitespace character is considered part of a table. @samp{|}
1900 is also the column separator@footnote{To insert a vertical bar into a table
1901 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
1902 might look like this:
1905 | Name | Phone | Age |
1906 |-------+-------+-----|
1907 | Peter | 1234 | 17 |
1908 | Anna | 4321 | 25 |
1911 A table is re-aligned automatically each time you press @key{TAB} or
1912 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1913 the next field (@key{RET} to the next row) and creates new table rows
1914 at the end of the table or before horizontal lines. The indentation
1915 of the table is set by the first line. Any line starting with
1916 @samp{|-} is considered as a horizontal separator line and will be
1917 expanded on the next re-align to span the whole table width. So, to
1918 create the above table, you would only type
1925 @noindent and then press @key{TAB} to align the table and start filling in
1926 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1927 @kbd{C-c @key{RET}}.
1929 @vindex org-enable-table-editor
1930 @vindex org-table-auto-blank-field
1931 When typing text into a field, Org treats @key{DEL},
1932 @key{Backspace}, and all character keys in a special way, so that
1933 inserting and deleting avoids shifting other fields. Also, when
1934 typing @emph{immediately after the cursor was moved into a new field
1935 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1936 field is automatically made blank. If this behavior is too
1937 unpredictable for you, configure the variables
1938 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1941 @tsubheading{Creation and conversion}
1942 @orgcmd{C-c |,org-table-create-or-convert-from-region}
1943 Convert the active region to table. If every line contains at least one
1944 TAB character, the function assumes that the material is tab separated.
1945 If every line contains a comma, comma-separated values (CSV) are assumed.
1946 If not, lines are split at whitespace into fields. You can use a prefix
1947 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1948 C-u} forces TAB, and a numeric argument N indicates that at least N
1949 consecutive spaces, or alternatively a TAB will be the separator.
1951 If there is no active region, this command creates an empty Org
1952 table. But it's easier just to start typing, like
1953 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1955 @tsubheading{Re-aligning and field motion}
1956 @orgcmd{C-c C-c,org-table-align}
1957 Re-align the table without moving the cursor.
1959 @orgcmd{<TAB>,org-table-next-field}
1960 Re-align the table, move to the next field. Creates a new row if
1963 @orgcmd{S-@key{TAB},org-table-previous-field}
1964 Re-align, move to previous field.
1966 @orgcmd{@key{RET},org-table-next-row}
1967 Re-align the table and move down to next row. Creates a new row if
1968 necessary. At the beginning or end of a line, @key{RET} still does
1969 NEWLINE, so it can be used to split a table.
1971 @orgcmd{M-a,org-table-beginning-of-field}
1972 Move to beginning of the current table field, or on to the previous field.
1973 @orgcmd{M-e,org-table-end-of-field}
1974 Move to end of the current table field, or on to the next field.
1976 @tsubheading{Column and row editing}
1977 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
1978 Move the current column left/right.
1980 @orgcmd{M-S-@key{left},org-table-delete-column}
1981 Kill the current column.
1983 @orgcmd{M-S-@key{right},org-table-insert-column}
1984 Insert a new column to the left of the cursor position.
1986 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
1987 Move the current row up/down.
1989 @orgcmd{M-S-@key{up},org-table-kill-row}
1990 Kill the current row or horizontal line.
1992 @orgcmd{M-S-@key{down},org-table-insert-row}
1993 Insert a new row above the current row. With a prefix argument, the line is
1994 created below the current one.
1996 @orgcmd{C-c -,org-table-insert-hline}
1997 Insert a horizontal line below current row. With a prefix argument, the line
1998 is created above the current line.
2000 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2001 Insert a horizontal line below current row, and move the cursor into the row
2004 @orgcmd{C-c ^,org-table-sort-lines}
2005 Sort the table lines in the region. The position of point indicates the
2006 column to be used for sorting, and the range of lines is the range
2007 between the nearest horizontal separator lines, or the entire table. If
2008 point is before the first column, you will be prompted for the sorting
2009 column. If there is an active region, the mark specifies the first line
2010 and the sorting column, while point should be in the last line to be
2011 included into the sorting. The command prompts for the sorting type
2012 (alphabetically, numerically, or by time). When called with a prefix
2013 argument, alphabetic sorting will be case-sensitive.
2015 @tsubheading{Regions}
2016 @orgcmd{C-c C-x M-w,org-table-copy-region}
2017 Copy a rectangular region from a table to a special clipboard. Point and
2018 mark determine edge fields of the rectangle. If there is no active region,
2019 copy just the current field. The process ignores horizontal separator lines.
2021 @orgcmd{C-c C-x C-w,org-table-cut-region}
2022 Copy a rectangular region from a table to a special clipboard, and
2023 blank all fields in the rectangle. So this is the ``cut'' operation.
2025 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2026 Paste a rectangular region into a table.
2027 The upper left corner ends up in the current field. All involved fields
2028 will be overwritten. If the rectangle does not fit into the present table,
2029 the table is enlarged as needed. The process ignores horizontal separator
2032 @orgcmd{M-@key{RET},org-table-wrap-region}
2033 Split the current field at the cursor position and move the rest to the line
2034 below. If there is an active region, and both point and mark are in the same
2035 column, the text in the column is wrapped to minimum width for the given
2036 number of lines. A numeric prefix argument may be used to change the number
2037 of desired lines. If there is no region, but you specify a prefix argument,
2038 the current field is made blank, and the content is appended to the field
2041 @tsubheading{Calculations}
2042 @cindex formula, in tables
2043 @cindex calculations, in tables
2044 @cindex region, active
2045 @cindex active region
2046 @cindex transient mark mode
2047 @orgcmd{C-c +,org-table-sum}
2048 Sum the numbers in the current column, or in the rectangle defined by
2049 the active region. The result is shown in the echo area and can
2050 be inserted with @kbd{C-y}.
2052 @orgcmd{S-@key{RET},org-table-copy-down}
2053 @vindex org-table-copy-increment
2054 When current field is empty, copy from first non-empty field above. When not
2055 empty, copy current field down to next row and move cursor along with it.
2056 Depending on the variable @code{org-table-copy-increment}, integer field
2057 values will be incremented during copy. Integers that are too large will not
2058 be incremented. Also, a @code{0} prefix argument temporarily disables the
2059 increment. This key is also used by shift-selection and related modes
2060 (@pxref{Conflicts}).
2062 @tsubheading{Miscellaneous}
2063 @orgcmd{C-c `,org-table-edit-field}
2064 Edit the current field in a separate window. This is useful for fields that
2065 are not fully visible (@pxref{Column width and alignment}). When called with
2066 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2069 @item M-x org-table-import
2070 Import a file as a table. The table should be TAB or whitespace
2071 separated. Use, for example, to import a spreadsheet table or data
2072 from a database, because these programs generally can write
2073 TAB-separated text files. This command works by inserting the file into
2074 the buffer and then converting the region to a table. Any prefix
2075 argument is passed on to the converter, which uses it to determine the
2077 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2078 Tables can also be imported by pasting tabular text into the Org
2079 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2080 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2082 @item M-x org-table-export
2083 @findex org-table-export
2084 @vindex org-table-export-default-format
2085 Export the table, by default as a TAB-separated file. Use for data
2086 exchange with, for example, spreadsheet or database programs. The format
2087 used to export the file can be configured in the variable
2088 @code{org-table-export-default-format}. You may also use properties
2089 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2090 name and the format for table export in a subtree. Org supports quite
2091 general formats for exported tables. The exporter format is the same as the
2092 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2093 detailed description.
2096 If you don't like the automatic table editor because it gets in your
2097 way on lines which you would like to start with @samp{|}, you can turn
2101 (setq org-enable-table-editor nil)
2104 @noindent Then the only table command that still works is
2105 @kbd{C-c C-c} to do a manual re-align.
2107 @node Column width and alignment, Column groups, Built-in table editor, Tables
2108 @section Column width and alignment
2109 @cindex narrow columns in tables
2110 @cindex alignment in tables
2112 The width of columns is automatically determined by the table editor. And
2113 also the alignment of a column is determined automatically from the fraction
2114 of number-like versus non-number fields in the column.
2116 Sometimes a single field or a few fields need to carry more text, leading to
2117 inconveniently wide columns. Or maybe you want to make a table with several
2118 columns having a fixed width, regardless of content. To set@footnote{This
2119 feature does not work on XEmacs.} the width of a column, one field anywhere
2120 in the column may contain just the string @samp{<N>} where @samp{N} is an
2121 integer specifying the width of the column in characters. The next re-align
2122 will then set the width of this column to this value.
2126 |---+------------------------------| |---+--------|
2128 | 1 | one | | 1 | one |
2129 | 2 | two | ----\ | 2 | two |
2130 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2131 | 4 | four | | 4 | four |
2132 |---+------------------------------| |---+--------|
2137 Fields that are wider become clipped and end in the string @samp{=>}.
2138 Note that the full text is still in the buffer but is hidden.
2139 To see the full text, hold the mouse over the field---a tool-tip window
2140 will show the full content. To edit such a field, use the command
2141 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2142 open a new window with the full field. Edit it and finish with @kbd{C-c
2145 @vindex org-startup-align-all-tables
2146 When visiting a file containing a table with narrowed columns, the
2147 necessary character hiding has not yet happened, and the table needs to
2148 be aligned before it looks nice. Setting the option
2149 @code{org-startup-align-all-tables} will realign all tables in a file
2150 upon visiting, but also slow down startup. You can also set this option
2151 on a per-file basis with:
2158 If you would like to overrule the automatic alignment of number-rich columns
2159 to the right and of string-rich column to the left, you can use @samp{<r>},
2160 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2161 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2162 also combine alignment and field width like this: @samp{<l10>}.
2164 Lines which only contain these formatting cookies will be removed
2165 automatically when exporting the document.
2167 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2168 @section Column groups
2169 @cindex grouping columns in tables
2171 When Org exports tables, it does so by default without vertical
2172 lines because that is visually more satisfying in general. Occasionally
2173 however, vertical lines can be useful to structure a table into groups
2174 of columns, much like horizontal lines can do for groups of rows. In
2175 order to specify column groups, you can use a special row where the
2176 first field contains only @samp{/}. The further fields can either
2177 contain @samp{<} to indicate that this column should start a group,
2178 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2179 a group of its own. Boundaries between column groups will upon export be
2180 marked with vertical lines. Here is an example:
2183 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2184 |---+-----+-----+-----+---------+------------|
2185 | / | < | | > | < | > |
2186 | 1 | 1 | 1 | 1 | 1 | 1 |
2187 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2188 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2189 |---+-----+-----+-----+---------+------------|
2190 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2193 It is also sufficient to just insert the column group starters after
2194 every vertical line you would like to have:
2197 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2198 |----+-----+-----+-----+---------+------------|
2202 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2203 @section The Orgtbl minor mode
2205 @cindex minor mode for tables
2207 If you like the intuitive way the Org table editor works, you
2208 might also want to use it in other modes like Text mode or Mail mode.
2209 The minor mode Orgtbl mode makes this possible. You can always toggle
2210 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2211 example in Message mode, use
2214 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2217 Furthermore, with some special setup, it is possible to maintain tables
2218 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2219 construct @LaTeX{} tables with the underlying ease and power of
2220 Orgtbl mode, including spreadsheet capabilities. For details, see
2221 @ref{Tables in arbitrary syntax}.
2223 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2224 @section The spreadsheet
2225 @cindex calculations, in tables
2226 @cindex spreadsheet capabilities
2227 @cindex @file{calc} package
2229 The table editor makes use of the Emacs @file{calc} package to implement
2230 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2231 derive fields from other fields. While fully featured, Org's implementation
2232 is not identical to other spreadsheets. For example, Org knows the concept
2233 of a @emph{column formula} that will be applied to all non-header fields in a
2234 column without having to copy the formula to each relevant field. There is
2235 also a formula debugger, and a formula editor with features for highlighting
2236 fields in the table corresponding to the references at the point in the
2237 formula, moving these references by arrow keys
2240 * References:: How to refer to another field or range
2241 * Formula syntax for Calc:: Using Calc to compute stuff
2242 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2243 * Field and range formulas:: Formula for specific (ranges of) fields
2244 * Column formulas:: Formulas valid for an entire column
2245 * Editing and debugging formulas:: Fixing formulas
2246 * Updating the table:: Recomputing all dependent fields
2247 * Advanced features:: Field names, parameters and automatic recalc
2250 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2251 @subsection References
2254 To compute fields in the table from other fields, formulas must
2255 reference other fields or ranges. In Org, fields can be referenced
2256 by name, by absolute coordinates, and by relative coordinates. To find
2257 out what the coordinates of a field are, press @kbd{C-c ?} in that
2258 field, or press @kbd{C-c @}} to toggle the display of a grid.
2260 @subsubheading Field references
2261 @cindex field references
2262 @cindex references, to fields
2264 Formulas can reference the value of another field in two ways. Like in
2265 any other spreadsheet, you may reference fields with a letter/number
2266 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2267 @vindex org-table-use-standard-references
2268 However, Org prefers@footnote{Org will understand references typed by the
2269 user as @samp{B4}, but it will not use this syntax when offering a formula
2270 for editing. You can customize this behavior using the variable
2271 @code{org-table-use-standard-references}.} to use another, more general
2272 representation that looks like this:
2274 @@@var{row}$@var{column}
2277 Column specifications can be absolute like @code{$1},
2278 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
2279 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2280 @code{$<} and @code{$>} are immutable references to the first and last
2281 column, respectively, and you can use @code{$>>>} to indicate the third
2282 column from the right.
2284 The row specification only counts data lines and ignores horizontal separator
2285 lines (hlines). Like with columns, you can use absolute row numbers
2286 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2287 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2288 immutable references the first and last@footnote{For backward compatibility
2289 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2290 a stable way to the 5th and 12th field in the last row of the table.
2291 However, this syntax is deprecated, it should not be used for new documents.
2292 Use @code{@@>$} instead.} row in the table, respectively. You may also
2293 specify the row relative to one of the hlines: @code{@@I} refers to the first
2294 hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such
2295 line above the current line, @code{@@+I} to the first such line below the
2296 current line. You can also write @code{@@III+2} which is the second data line
2297 after the third hline in the table.
2299 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2300 i.e. to the row/column for the field being computed. Also, if you omit
2301 either the column or the row part of the reference, the current row/column is
2304 Org's references with @emph{unsigned} numbers are fixed references
2305 in the sense that if you use the same reference in the formula for two
2306 different fields, the same field will be referenced each time.
2307 Org's references with @emph{signed} numbers are floating
2308 references because the same reference operator can reference different
2309 fields depending on the field being calculated by the formula.
2311 Here are a few examples:
2314 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2315 $5 @r{column 5 in the current row (same as @code{E&})}
2316 @@2 @r{current column, row 2}
2317 @@-1$-3 @r{the field one row up, three columns to the left}
2318 @@-I$2 @r{field just under hline above current row, column 2}
2319 @@>$5 @r{field in the last row, in column 5}
2322 @subsubheading Range references
2323 @cindex range references
2324 @cindex references, to ranges
2326 You may reference a rectangular range of fields by specifying two field
2327 references connected by two dots @samp{..}. If both fields are in the
2328 current row, you may simply use @samp{$2..$7}, but if at least one field
2329 is in a different row, you need to use the general @code{@@row$column}
2330 format at least for the first field (i.e the reference must start with
2331 @samp{@@} in order to be interpreted correctly). Examples:
2334 $1..$3 @r{first three fields in the current row}
2335 $P..$Q @r{range, using column names (see under Advanced)}
2336 $<<<..$>> @r{start in third column, continue to the one but last}
2337 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2338 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2339 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2342 @noindent Range references return a vector of values that can be fed
2343 into Calc vector functions. Empty fields in ranges are normally
2344 suppressed, so that the vector contains only the non-empty fields (but
2345 see the @samp{E} mode switch below). If there are no non-empty fields,
2346 @samp{[0]} is returned to avoid syntax errors in formulas.
2348 @subsubheading Field coordinates in formulas
2349 @cindex field coordinates
2350 @cindex coordinates, of field
2351 @cindex row, of field coordinates
2352 @cindex column, of field coordinates
2354 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2355 get the row or column number of the field where the formula result goes.
2356 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2357 and @code{org-table-current-column}. Examples:
2360 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2361 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2362 @r{column 3 of the current table}
2365 @noindent For the second example, table FOO must have at least as many rows
2366 as the current table. Note that this is inefficient@footnote{The computation time scales as
2367 O(N^2) because table FOO is parsed for each field to be copied.} for large
2370 @subsubheading Named references
2371 @cindex named references
2372 @cindex references, named
2373 @cindex name, of column or field
2374 @cindex constants, in calculations
2377 @vindex org-table-formula-constants
2378 @samp{$name} is interpreted as the name of a column, parameter or
2379 constant. Constants are defined globally through the variable
2380 @code{org-table-formula-constants}, and locally (for the file) through a
2384 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2388 @vindex constants-unit-system
2389 @pindex constants.el
2390 Also properties (@pxref{Properties and Columns}) can be used as
2391 constants in table formulas: for a property @samp{:Xyz:} use the name
2392 @samp{$PROP_Xyz}, and the property will be searched in the current
2393 outline entry and in the hierarchy above it. If you have the
2394 @file{constants.el} package, it will also be used to resolve constants,
2395 including natural constants like @samp{$h} for Planck's constant, and
2396 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2397 supply the values of constants in two different unit systems, @code{SI}
2398 and @code{cgs}. Which one is used depends on the value of the variable
2399 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2400 @code{constSI} and @code{constcgs} to set this value for the current
2401 buffer.}. Column names and parameters can be specified in special table
2402 lines. These are described below, see @ref{Advanced features}. All
2403 names must start with a letter, and further consist of letters and
2406 @subsubheading Remote references
2407 @cindex remote references
2408 @cindex references, remote
2409 @cindex references, to a different table
2410 @cindex name, of column or field
2411 @cindex constants, in calculations
2414 You may also reference constants, fields and ranges from a different table,
2415 either in the current file or even in a different file. The syntax is
2418 remote(NAME-OR-ID,REF)
2422 where NAME can be the name of a table in the current file as set by a
2423 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2424 entry, even in a different file, and the reference then refers to the first
2425 table in that entry. REF is an absolute field or range reference as
2426 described above for example @code{@@3$3} or @code{$somename}, valid in the
2429 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2430 @subsection Formula syntax for Calc
2431 @cindex formula syntax, Calc
2432 @cindex syntax, of formulas
2434 A formula can be any algebraic expression understood by the Emacs
2435 @file{Calc} package. @b{Note that @file{calc} has the
2436 non-standard convention that @samp{/} has lower precedence than
2437 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2438 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2439 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2440 Emacs Calc Manual}),
2441 @c FIXME: The link to the Calc manual in HTML does not work.
2442 variable substitution takes place according to the rules described above.
2443 @cindex vectors, in table calculations
2444 The range vectors can be directly fed into the Calc vector functions
2445 like @samp{vmean} and @samp{vsum}.
2447 @cindex format specifier
2448 @cindex mode, for @file{calc}
2449 @vindex org-calc-default-modes
2450 A formula can contain an optional mode string after a semicolon. This
2451 string consists of flags to influence Calc and other modes during
2452 execution. By default, Org uses the standard Calc modes (precision
2453 12, angular units degrees, fraction and symbolic modes off). The display
2454 format, however, has been changed to @code{(float 8)} to keep tables
2455 compact. The default settings can be configured using the variable
2456 @code{org-calc-default-modes}.
2459 p20 @r{set the internal Calc calculation precision to 20 digits}
2460 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2461 @r{format of the result of Calc passed back to Org.}
2462 @r{Calc formatting is unlimited in precision as}
2463 @r{long as the Calc calculation precision is greater.}
2464 D R @r{angle modes: degrees, radians}
2465 F S @r{fraction and symbolic modes}
2466 N @r{interpret all fields as numbers, use 0 for non-numbers}
2467 T @r{force text interpretation}
2468 E @r{keep empty fields in ranges}
2473 Unless you use large integer numbers or high-precision-calculation
2474 and -display for floating point numbers you may alternatively provide a
2475 @code{printf} format specifier to reformat the Calc result after it has been
2476 passed back to Org instead of letting Calc already do the
2477 formatting@footnote{The @code{printf} reformatting is limited in precision
2478 because the value passed to it is converted into an @code{integer} or
2479 @code{double}. The @code{integer} is limited in size by truncating the
2480 signed value to 32 bits. The @code{double} is limited in precision to 64
2481 bits overall which leaves approximately 16 significant decimal digits.}.
2485 $1+$2 @r{Sum of first and second field}
2486 $1+$2;%.2f @r{Same, format result to two decimals}
2487 exp($2)+exp($1) @r{Math functions can be used}
2488 $0;%.1f @r{Reformat current cell to 1 decimal}
2489 ($3-32)*5/9 @r{Degrees F -> C conversion}
2490 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2491 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2492 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2493 vmean($2..$7) @r{Compute column range mean, using vector function}
2494 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2495 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2498 Calc also contains a complete set of logical operations. For example
2501 if($1<20,teen,string("")) @r{"teen" if age $1 less than 20, else empty}
2504 @node Formula syntax for Lisp, Field and range formulas, Formula syntax for Calc, The spreadsheet
2505 @subsection Emacs Lisp forms as formulas
2506 @cindex Lisp forms, as table formulas
2508 It is also possible to write a formula in Emacs Lisp; this can be useful for
2509 string manipulation and control structures, if Calc's functionality is not
2510 enough. If a formula starts with a single-quote followed by an opening
2511 parenthesis, then it is evaluated as a Lisp form. The evaluation should
2512 return either a string or a number. Just as with @file{calc} formulas, you
2513 can specify modes and a printf format after a semicolon. With Emacs Lisp
2514 forms, you need to be conscious about the way field references are
2515 interpolated into the form. By default, a reference will be interpolated as
2516 a Lisp string (in double-quotes) containing the field. If you provide the
2517 @samp{N} mode switch, all referenced elements will be numbers (non-number
2518 fields will be zero) and interpolated as Lisp numbers, without quotes. If
2519 you provide the @samp{L} flag, all fields will be interpolated literally,
2520 without quotes. i.e., if you want a reference to be interpreted as a string
2521 by the Lisp form, enclose the reference operator itself in double-quotes,
2522 like @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2523 embed them in list or vector syntax. Here are a few examples---note how the
2524 @samp{N} mode is used when we do computations in Lisp:
2527 @r{Swap the first two characters of the content of column 1}
2528 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2529 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2531 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2532 '(apply '+ '($1..$4));N
2535 @node Field and range formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2536 @subsection Field and range formulas
2537 @cindex field formula
2538 @cindex range formula
2539 @cindex formula, for individual table field
2540 @cindex formula, for range of fields
2542 To assign a formula to a particular field, type it directly into the field,
2543 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2544 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2545 the formula will be stored as the formula for this field, evaluated, and the
2546 current field will be replaced with the result.
2549 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2550 below the table. If you type the equation in the 4th field of the 3rd data
2551 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2552 inserting/deleting/swapping column and rows with the appropriate commands,
2553 @i{absolute references} (but not relative ones) in stored formulas are
2554 modified in order to still reference the same field. To avoid this from
2555 happening, in particular in range references, anchor ranges at the table
2556 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2557 using the @code{@@I} notation. Automatic adaptation of field references does
2558 of cause not happen if you edit the table structure with normal editing
2559 commands---then you must fix the equations yourself.
2561 Instead of typing an equation into the field, you may also use the following
2565 @orgcmd{C-u C-c =,org-table-eval-formula}
2566 Install a new formula for the current field. The command prompts for a
2567 formula with default taken from the @samp{#+TBLFM:} line, applies
2568 it to the current field, and stores it.
2571 The left-hand side of a formula can also be a special expression in order to
2572 assign the formula to a number of different fields. There is no keyboard
2573 shortcut to enter such range formulas. To add them, use the formula editor
2574 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2579 Column formula, valid for the entire column. This is so common that Org
2580 treats these formulas in a special way, see @ref{Column formulas}.
2582 Row formula, applies to all fields in the specified row. @code{@@>=} means
2585 Range formula, applies to all fields in the given rectangular range. This
2586 can also be used to assign a formula to some but not all fields in a row.
2588 Named field, see @ref{Advanced features}.
2591 @node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
2592 @subsection Column formulas
2593 @cindex column formula
2594 @cindex formula, for table column
2596 When you assign a formula to a simple column reference like @code{$3=}, the
2597 same formula will be used in all fields of that column, with the following
2598 very convenient exceptions: (i) If the table contains horizontal separator
2599 hlines, everything before the first such line is considered part of the table
2600 @emph{header} and will not be modified by column formulas. (ii) Fields that
2601 already get a value from a field/range formula will be left alone by column
2602 formulas. These conditions make column formulas very easy to use.
2604 To assign a formula to a column, type it directly into any field in the
2605 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2606 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2607 the formula will be stored as the formula for the current column, evaluated
2608 and the current field replaced with the result. If the field contains only
2609 @samp{=}, the previously stored formula for this column is used. For each
2610 column, Org will only remember the most recently used formula. In the
2611 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2612 left-hand side of a column formula can not be the name of column, it must be
2613 the numeric column reference or @code{$>}.
2615 Instead of typing an equation into the field, you may also use the
2619 @orgcmd{C-c =,org-table-eval-formula}
2620 Install a new formula for the current column and replace current field with
2621 the result of the formula. The command prompts for a formula, with default
2622 taken from the @samp{#+TBLFM} line, applies it to the current field and
2623 stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
2624 will apply it to that many consecutive fields in the current column.
2627 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2628 @subsection Editing and debugging formulas
2629 @cindex formula editing
2630 @cindex editing, of table formulas
2632 @vindex org-table-use-standard-references
2633 You can edit individual formulas in the minibuffer or directly in the
2634 field. Org can also prepare a special buffer with all active
2635 formulas of a table. When offering a formula for editing, Org
2636 converts references to the standard format (like @code{B3} or @code{D&})
2637 if possible. If you prefer to only work with the internal format (like
2638 @code{@@3$2} or @code{$4}), configure the variable
2639 @code{org-table-use-standard-references}.
2642 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2643 Edit the formula associated with the current column/field in the
2644 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2645 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2646 Re-insert the active formula (either a
2647 field formula, or a column formula) into the current field, so that you
2648 can edit it directly in the field. The advantage over editing in the
2649 minibuffer is that you can use the command @kbd{C-c ?}.
2650 @orgcmd{C-c ?,org-table-field-info}
2651 While editing a formula in a table field, highlight the field(s)
2652 referenced by the reference at the cursor position in the formula.
2654 @findex org-table-toggle-coordinate-overlays
2656 Toggle the display of row and column numbers for a table, using overlays
2657 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2658 time the table is aligned; you can force it with @kbd{C-c C-c}.
2660 @findex org-table-toggle-formula-debugger
2662 Toggle the formula debugger on and off
2663 (@command{org-table-toggle-formula-debugger}). See below.
2664 @orgcmd{C-c ',org-table-edit-formulas}
2665 Edit all formulas for the current table in a special buffer, where the
2666 formulas will be displayed one per line. If the current field has an
2667 active formula, the cursor in the formula editor will mark it.
2668 While inside the special buffer, Org will automatically highlight
2669 any field or range reference at the cursor position. You may edit,
2670 remove and add formulas, and use the following commands:
2672 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2673 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2674 prefix, also apply the new formulas to the entire table.
2675 @orgcmd{C-c C-q,org-table-fedit-abort}
2676 Exit the formula editor without installing changes.
2677 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2678 Toggle all references in the formula editor between standard (like
2679 @code{B3}) and internal (like @code{@@3$2}).
2680 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2681 Pretty-print or indent Lisp formula at point. When in a line containing
2682 a Lisp formula, format the formula according to Emacs Lisp rules.
2683 Another @key{TAB} collapses the formula back again. In the open
2684 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2685 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2686 Complete Lisp symbols, just like in Emacs Lisp mode.
2688 @kindex S-@key{down}
2689 @kindex S-@key{left}
2690 @kindex S-@key{right}
2691 @findex org-table-fedit-ref-up
2692 @findex org-table-fedit-ref-down
2693 @findex org-table-fedit-ref-left
2694 @findex org-table-fedit-ref-right
2695 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2696 Shift the reference at point. For example, if the reference is
2697 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2698 This also works for relative references and for hline references.
2699 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2700 Move the test line for column formulas in the Org buffer up and
2702 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2703 Scroll the window displaying the table.
2705 @findex org-table-toggle-coordinate-overlays
2707 Turn the coordinate grid in the table on and off.
2711 Making a table field blank does not remove the formula associated with
2712 the field, because that is stored in a different line (the @samp{#+TBLFM}
2713 line)---during the next recalculation the field will be filled again.
2714 To remove a formula from a field, you have to give an empty reply when
2715 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2718 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2719 equations with @kbd{C-c C-c} in that line or with the normal
2720 recalculation commands in the table.
2722 @subsubheading Debugging formulas
2723 @cindex formula debugging
2724 @cindex debugging, of table formulas
2725 When the evaluation of a formula leads to an error, the field content
2726 becomes the string @samp{#ERROR}. If you would like see what is going
2727 on during variable substitution and calculation in order to find a bug,
2728 turn on formula debugging in the @code{Tbl} menu and repeat the
2729 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2730 field. Detailed information will be displayed.
2732 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2733 @subsection Updating the table
2734 @cindex recomputing table fields
2735 @cindex updating, table
2737 Recalculation of a table is normally not automatic, but needs to be
2738 triggered by a command. See @ref{Advanced features}, for a way to make
2739 recalculation at least semi-automatic.
2741 In order to recalculate a line of a table or the entire table, use the
2745 @orgcmd{C-c *,org-table-recalculate}
2746 Recalculate the current row by first applying the stored column formulas
2747 from left to right, and all field/range formulas in the current row.
2753 Recompute the entire table, line by line. Any lines before the first
2754 hline are left alone, assuming that these are part of the table header.
2756 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2757 Iterate the table by recomputing it until no further changes occur.
2758 This may be necessary if some computed fields use the value of other
2759 fields that are computed @i{later} in the calculation sequence.
2760 @item M-x org-table-recalculate-buffer-tables
2761 @findex org-table-recalculate-buffer-tables
2762 Recompute all tables in the current buffer.
2763 @item M-x org-table-iterate-buffer-tables
2764 @findex org-table-iterate-buffer-tables
2765 Iterate all tables in the current buffer, in order to converge table-to-table
2769 @node Advanced features, , Updating the table, The spreadsheet
2770 @subsection Advanced features
2772 If you want the recalculation of fields to happen automatically, or if
2773 you want to be able to assign @i{names} to fields and columns, you need
2774 to reserve the first column of the table for special marking characters.
2776 @orgcmd{C-#,org-table-rotate-recalc-marks}
2777 Rotate the calculation mark in first column through the states @samp{ },
2778 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2779 change all marks in the region.
2782 Here is an example of a table that collects exam results of students and
2783 makes use of these features:
2787 |---+---------+--------+--------+--------+-------+------|
2788 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2789 |---+---------+--------+--------+--------+-------+------|
2790 | ! | | P1 | P2 | P3 | Tot | |
2791 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2792 | ^ | | m1 | m2 | m3 | mt | |
2793 |---+---------+--------+--------+--------+-------+------|
2794 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2795 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2796 |---+---------+--------+--------+--------+-------+------|
2797 | | Average | | | | 29.7 | |
2798 | ^ | | | | | at | |
2799 | $ | max=50 | | | | | |
2800 |---+---------+--------+--------+--------+-------+------|
2801 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2805 @noindent @b{Important}: please note that for these special tables,
2806 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2807 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2808 to the field itself. The column formulas are not applied in rows with
2811 @cindex marking characters, tables
2812 The marking characters have the following meaning:
2815 The fields in this line define names for the columns, so that you may
2816 refer to a column as @samp{$Tot} instead of @samp{$6}.
2818 This row defines names for the fields @emph{above} the row. With such
2819 a definition, any formula in the table may use @samp{$m1} to refer to
2820 the value @samp{10}. Also, if you assign a formula to a names field, it
2821 will be stored as @samp{$name=...}.
2823 Similar to @samp{^}, but defines names for the fields in the row
2826 Fields in this row can define @emph{parameters} for formulas. For
2827 example, if a field in a @samp{$} row contains @samp{max=50}, then
2828 formulas in this table can refer to the value 50 using @samp{$max}.
2829 Parameters work exactly like constants, only that they can be defined on
2832 Fields in this row are automatically recalculated when pressing
2833 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
2834 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
2835 lines will be left alone by this command.
2837 Selects this line for global recalculation with @kbd{C-u C-c *}, but
2838 not for automatic recalculation. Use this when automatic
2839 recalculation slows down editing too much.
2841 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
2842 All lines that should be recalculated should be marked with @samp{#}
2845 Do not export this line. Useful for lines that contain the narrowing
2846 @samp{<N>} markers or column group markers.
2849 Finally, just to whet your appetite for what can be done with the
2850 fantastic @file{calc.el} package, here is a table that computes the Taylor
2851 series of degree @code{n} at location @code{x} for a couple of
2856 |---+-------------+---+-----+--------------------------------------|
2857 | | Func | n | x | Result |
2858 |---+-------------+---+-----+--------------------------------------|
2859 | # | exp(x) | 1 | x | 1 + x |
2860 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
2861 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
2862 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
2863 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
2864 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
2865 |---+-------------+---+-----+--------------------------------------|
2866 #+TBLFM: $5=taylor($2,$4,$3);n3
2870 @node Org-Plot, , The spreadsheet, Tables
2872 @cindex graph, in tables
2873 @cindex plot tables using Gnuplot
2876 Org-Plot can produce 2D and 3D graphs of information stored in org tables
2877 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
2878 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
2879 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
2880 on your system, then call @code{org-plot/gnuplot} on the following table.
2884 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
2885 | Sede | Max cites | H-index |
2886 |-----------+-----------+---------|
2887 | Chile | 257.72 | 21.39 |
2888 | Leeds | 165.77 | 19.68 |
2889 | Sao Paolo | 71.00 | 11.50 |
2890 | Stockholm | 134.19 | 14.33 |
2891 | Morelia | 257.56 | 17.67 |
2895 Notice that Org Plot is smart enough to apply the table's headers as labels.
2896 Further control over the labels, type, content, and appearance of plots can
2897 be exercised through the @code{#+PLOT:} lines preceding a table. See below
2898 for a complete list of Org-plot options. For more information and examples
2899 see the Org-plot tutorial at
2900 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
2902 @subsubheading Plot Options
2906 Specify any @command{gnuplot} option to be set when graphing.
2909 Specify the title of the plot.
2912 Specify which column of the table to use as the @code{x} axis.
2915 Specify the columns to graph as a Lisp style list, surrounded by parentheses
2916 and separated by spaces for example @code{dep:(3 4)} to graph the third and
2917 fourth columns (defaults to graphing all other columns aside from the @code{ind}
2921 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
2924 Specify a @code{with} option to be inserted for every col being plotted
2925 (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
2926 Defaults to @code{lines}.
2929 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
2932 List of labels to be used for the @code{deps} (defaults to the column headers
2936 Specify an entire line to be inserted in the Gnuplot script.
2939 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
2940 flat mapping rather than a @code{3d} slope.
2943 Specify format of Org-mode timestamps as they will be parsed by Gnuplot.
2944 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
2947 If you want total control, you can specify a script file (place the file name
2948 between double-quotes) which will be used to plot. Before plotting, every
2949 instance of @code{$datafile} in the specified script will be replaced with
2950 the path to the generated data file. Note: even if you set this option, you
2951 may still want to specify the plot type, as that can impact the content of
2955 @node Hyperlinks, TODO Items, Tables, Top
2959 Like HTML, Org provides links inside a file, external links to
2960 other files, Usenet articles, emails, and much more.
2963 * Link format:: How links in Org are formatted
2964 * Internal links:: Links to other places in the current file
2965 * External links:: URL-like links to the world
2966 * Handling links:: Creating, inserting and following
2967 * Using links outside Org:: Linking from my C source code?
2968 * Link abbreviations:: Shortcuts for writing complex links
2969 * Search options:: Linking to a specific location
2970 * Custom searches:: When the default search is not enough
2973 @node Link format, Internal links, Hyperlinks, Hyperlinks
2974 @section Link format
2976 @cindex format, of links
2978 Org will recognize plain URL-like links and activate them as
2979 clickable links. The general link format, however, looks like this:
2982 [[link][description]] @r{or alternatively} [[link]]
2986 Once a link in the buffer is complete (all brackets present), Org
2987 will change the display so that @samp{description} is displayed instead
2988 of @samp{[[link][description]]} and @samp{link} is displayed instead of
2989 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
2990 which by default is an underlined face. You can directly edit the
2991 visible part of a link. Note that this can be either the @samp{link}
2992 part (if there is no description) or the @samp{description} part. To
2993 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
2996 If you place the cursor at the beginning or just behind the end of the
2997 displayed text and press @key{BACKSPACE}, you will remove the
2998 (invisible) bracket at that location. This makes the link incomplete
2999 and the internals are again displayed as plain text. Inserting the
3000 missing bracket hides the link internals again. To show the
3001 internal structure of all links, use the menu entry
3002 @code{Org->Hyperlinks->Literal links}.
3004 @node Internal links, External links, Link format, Hyperlinks
3005 @section Internal links
3006 @cindex internal links
3007 @cindex links, internal
3008 @cindex targets, for links
3010 @cindex property, CUSTOM_ID
3011 If the link does not look like a URL, it is considered to be internal in the
3012 current file. The most important case is a link like
3013 @samp{[[#my-custom-id]]} which will link to the entry with the
3014 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
3015 for HTML export (@pxref{HTML export}) where they produce pretty section
3016 links. You are responsible yourself to make sure these custom IDs are unique
3019 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3020 lead to a text search in the current file.
3022 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3023 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3024 point to the corresponding headline. The preferred match for a text link is
3025 a @i{dedicated target}: the same string in double angular brackets. Targets
3026 may be located anywhere; sometimes it is convenient to put them into a
3027 comment line. For example
3033 @noindent In HTML export (@pxref{HTML export}), such targets will become
3034 named anchors for direct access through @samp{http} links@footnote{Note that
3035 text before the first headline is usually not exported, so the first such
3036 target should be after the first headline, or in the line directly before the
3039 If no dedicated target exists, Org will search for a headline that is exactly
3040 the link text but may also include a TODO keyword and tags@footnote{To insert
3041 a link targeting a headline, in-buffer completion can be used. Just type a
3042 star followed by a few optional letters into the buffer and press
3043 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3044 completions.}. In non-Org files, the search will look for the words in the
3045 link text. In the above example the search would be for @samp{my target}.
3047 Following a link pushes a mark onto Org's own mark ring. You can
3048 return to the previous position with @kbd{C-c &}. Using this command
3049 several times in direct succession goes back to positions recorded
3053 * Radio targets:: Make targets trigger links in plain text
3056 @node Radio targets, , Internal links, Internal links
3057 @subsection Radio targets
3058 @cindex radio targets
3059 @cindex targets, radio
3060 @cindex links, radio targets
3062 Org can automatically turn any occurrences of certain target names
3063 in normal text into a link. So without explicitly creating a link, the
3064 text connects to the target radioing its position. Radio targets are
3065 enclosed by triple angular brackets. For example, a target @samp{<<<My
3066 Target>>>} causes each occurrence of @samp{my target} in normal text to
3067 become activated as a link. The Org file is scanned automatically
3068 for radio targets only when the file is first loaded into Emacs. To
3069 update the target list during editing, press @kbd{C-c C-c} with the
3070 cursor on or at a target.
3072 @node External links, Handling links, Internal links, Hyperlinks
3073 @section External links
3074 @cindex links, external
3075 @cindex external links
3076 @cindex links, external
3084 @cindex WANDERLUST links
3086 @cindex USENET links
3091 Org supports links to files, websites, Usenet and email messages,
3092 BBDB database entries and links to both IRC conversations and their
3093 logs. External links are URL-like locators. They start with a short
3094 identifying string followed by a colon. There can be no space after
3095 the colon. The following list shows examples for each link type.
3098 http://www.astro.uva.nl/~dominik @r{on the web}
3099 doi:10.1000/182 @r{DOI for an electronic resource}
3100 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3101 /home/dominik/images/jupiter.jpg @r{same as above}
3102 file:papers/last.pdf @r{file, relative path}
3103 ./papers/last.pdf @r{same as above}
3104 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3105 /myself@@some.where:papers/last.pdf @r{same as above}
3106 file:sometextfile::NNN @r{file with line number to jump to}
3107 file:projects.org @r{another Org file}
3108 file:projects.org::some words @r{text search in Org file}
3109 file:projects.org::*task title @r{heading search in Org file}
3110 docview:papers/last.pdf::NNN @r{open file in doc-view mode at page NNN}
3111 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3112 news:comp.emacs @r{Usenet link}
3113 mailto:adent@@galaxy.net @r{Mail link}
3114 vm:folder @r{VM folder link}
3115 vm:folder#id @r{VM message link}
3116 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3117 wl:folder @r{WANDERLUST folder link}
3118 wl:folder#id @r{WANDERLUST message link}
3119 mhe:folder @r{MH-E folder link}
3120 mhe:folder#id @r{MH-E message link}
3121 rmail:folder @r{RMAIL folder link}
3122 rmail:folder#id @r{RMAIL message link}
3123 gnus:group @r{Gnus group link}
3124 gnus:group#id @r{Gnus article link}
3125 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3126 irc:/irc.com/#emacs/bob @r{IRC link}
3127 info:org#External%20links @r{Info node link (with encoded space)}
3128 shell:ls *.org @r{A shell command}
3129 elisp:org-agenda @r{Interactive Elisp command}
3130 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3133 For customizing Org to add new link types @ref{Adding hyperlink types}.
3135 A link should be enclosed in double brackets and may contain a
3136 descriptive text to be displayed instead of the URL (@pxref{Link
3137 format}), for example:
3140 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3144 If the description is a file name or URL that points to an image, HTML
3145 export (@pxref{HTML export}) will inline the image as a clickable
3146 button. If there is no description at all and the link points to an
3148 that image will be inlined into the exported HTML file.
3150 @cindex square brackets, around links
3151 @cindex plain text external links
3152 Org also finds external links in the normal text and activates them
3153 as links. If spaces must be part of the link (for example in
3154 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3155 about the end of the link, enclose them in square brackets.
3157 @node Handling links, Using links outside Org, External links, Hyperlinks
3158 @section Handling links
3159 @cindex links, handling
3161 Org provides methods to create a link in the correct syntax, to
3162 insert it into an Org file, and to follow the link.
3165 @orgcmd{C-c l,org-store-link}
3166 @cindex storing links
3167 Store a link to the current location. This is a @emph{global} command (you
3168 must create the key binding yourself) which can be used in any buffer to
3169 create a link. The link will be stored for later insertion into an Org
3170 buffer (see below). What kind of link will be created depends on the current
3173 @b{Org-mode buffers}@*
3174 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3175 to the target. Otherwise it points to the current headline, which will also
3178 @vindex org-link-to-org-use-id
3179 @cindex property, CUSTOM_ID
3180 @cindex property, ID
3181 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3182 will be stored. In addition or alternatively (depending on the value of
3183 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3184 created and/or used to construct a link. So using this command in Org
3185 buffers will potentially create two links: a human-readable from the custom
3186 ID, and one that is globally unique and works even if the entry is moved from
3187 file to file. Later, when inserting the link, you need to decide which one
3190 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3191 Pretty much all Emacs mail clients are supported. The link will point to the
3192 current article, or, in some GNUS buffers, to the group. The description is
3193 constructed from the author and the subject.
3195 @b{Web browsers: W3 and W3M}@*
3196 Here the link will be the current URL, with the page title as description.
3198 @b{Contacts: BBDB}@*
3199 Links created in a BBDB buffer will point to the current entry.
3202 @vindex org-irc-link-to-logs
3203 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3204 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3205 the current conversation is created. Otherwise an @samp{irc:/} style link to
3206 the user/channel/server under the point will be stored.
3209 For any other files, the link will point to the file, with a search string
3210 (@pxref{Search options}) pointing to the contents of the current line. If
3211 there is an active region, the selected words will form the basis of the
3212 search string. If the automatically created link is not working correctly or
3213 accurately enough, you can write custom functions to select the search string
3214 and to do the search for particular file types---see @ref{Custom searches}.
3215 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3218 When the cursor is in an agenda view, the created link points to the
3219 entry referenced by the current line.
3222 @orgcmd{C-c C-l,org-insert-link}
3223 @cindex link completion
3224 @cindex completion, of links
3225 @cindex inserting links
3226 @vindex org-keep-stored-link-after-insertion
3227 Insert a link@footnote{ Note that you don't have to use this command to
3228 insert a link. Links in Org are plain text, and you can type or paste them
3229 straight into the buffer. By using this command, the links are automatically
3230 enclosed in double brackets, and you will be asked for the optional
3231 descriptive text.}. This prompts for a link to be inserted into the buffer.
3232 You can just type a link, using text for an internal link, or one of the link
3233 type prefixes mentioned in the examples above. The link will be inserted
3234 into the buffer@footnote{After insertion of a stored link, the link will be
3235 removed from the list of stored links. To keep it in the list later use, use
3236 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3237 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3238 If some text was selected when this command is called, the selected text
3239 becomes the default description.
3241 @b{Inserting stored links}@*
3242 All links stored during the
3243 current session are part of the history for this prompt, so you can access
3244 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3246 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3247 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3248 defined through link abbreviations (@pxref{Link abbreviations}). If you
3249 press @key{RET} after inserting only the @var{prefix}, Org will offer
3250 specific completion support for some link types@footnote{This works by
3251 calling a special function @code{org-PREFIX-complete-link}.} For
3252 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3253 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3254 @key{RET}} you can complete contact names.
3256 @cindex file name completion
3257 @cindex completion, of file names
3258 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3259 a file will be inserted and you may use file name completion to select
3260 the name of the file. The path to the file is inserted relative to the
3261 directory of the current Org file, if the linked file is in the current
3262 directory or in a sub-directory of it, or if the path is written relative
3263 to the current directory using @samp{../}. Otherwise an absolute path
3264 is used, if possible with @samp{~/} for your home directory. You can
3265 force an absolute path with two @kbd{C-u} prefixes.
3267 @item C-c C-l @ @r{(with cursor on existing link)}
3268 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3269 link and description parts of the link.
3271 @cindex following links
3272 @orgcmd{C-c C-o,org-open-at-point}
3273 @vindex org-file-apps
3274 Open link at point. This will launch a web browser for URLs (using
3275 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3276 the corresponding links, and execute the command in a shell link. When the
3277 cursor is on an internal link, this command runs the corresponding search.
3278 When the cursor is on a TAG list in a headline, it creates the corresponding
3279 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3280 date. Furthermore, it will visit text and remote files in @samp{file:} links
3281 with Emacs and select a suitable application for local non-text files.
3282 Classification of files is based on file extension only. See option
3283 @code{org-file-apps}. If you want to override the default application and
3284 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3285 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3286 If the cursor is on a headline, but not on a link, offer all links in the
3287 headline and entry text.
3289 @vindex org-return-follows-link
3290 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3297 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3298 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3302 @vindex org-display-internal-link-with-indirect-buffer
3303 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3304 internal links to be displayed in another window@footnote{See the
3305 variable @code{org-display-internal-link-with-indirect-buffer}}.
3307 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3308 @cindex inlining images
3309 @cindex images, inlining
3310 @vindex org-startup-with-inline-images
3311 @cindex @code{inlineimages}, STARTUP keyword
3312 @cindex @code{noinlineimages}, STARTUP keyword
3313 Toggle the inline display of linked images. Normally this will only inline
3314 images that have no description part in the link, i.e.@: images that will also
3315 be inlined during export. When called with a prefix argument, also display
3316 images that do have a link description. You can ask for inline images to be
3317 displayed at startup by configuring the variable
3318 @code{org-startup-with-inline-images}@footnote{with corresponding
3319 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3320 @orgcmd{C-c %,org-mark-ring-push}
3322 Push the current position onto the mark ring, to be able to return
3323 easily. Commands following an internal link do this automatically.
3325 @orgcmd{C-c &,org-mark-ring-goto}
3326 @cindex links, returning to
3327 Jump back to a recorded position. A position is recorded by the
3328 commands following internal links, and by @kbd{C-c %}. Using this
3329 command several times in direct succession moves through a ring of
3330 previously recorded positions.
3332 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3333 @cindex links, finding next/previous
3334 Move forward/backward to the next link in the buffer. At the limit of
3335 the buffer, the search fails once, and then wraps around. The key
3336 bindings for this are really too long; you might want to bind this also
3337 to @kbd{C-n} and @kbd{C-p}
3339 (add-hook 'org-load-hook
3341 (define-key org-mode-map "\C-n" 'org-next-link)
3342 (define-key org-mode-map "\C-p" 'org-previous-link)))
3346 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3347 @section Using links outside Org
3349 You can insert and follow links that have Org syntax not only in
3350 Org, but in any Emacs buffer. For this, you should create two
3351 global commands, like this (please select suitable global keys
3355 (global-set-key "\C-c L" 'org-insert-link-global)
3356 (global-set-key "\C-c o" 'org-open-at-point-global)
3359 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3360 @section Link abbreviations
3361 @cindex link abbreviations
3362 @cindex abbreviation, links
3364 Long URLs can be cumbersome to type, and often many similar links are
3365 needed in a document. For this you can use link abbreviations. An
3366 abbreviated link looks like this
3369 [[linkword:tag][description]]
3373 @vindex org-link-abbrev-alist
3374 where the tag is optional.
3375 The @i{linkword} must be a word, starting with a letter, followed by
3376 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3377 according to the information in the variable @code{org-link-abbrev-alist}
3378 that relates the linkwords to replacement text. Here is an example:
3382 (setq org-link-abbrev-alist
3383 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3384 ("google" . "http://www.google.com/search?q=")
3385 ("gmap" . "http://maps.google.com/maps?q=%s")
3386 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3387 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3391 If the replacement text contains the string @samp{%s}, it will be
3392 replaced with the tag. Otherwise the tag will be appended to the string
3393 in order to create the link. You may also specify a function that will
3394 be called with the tag as the only argument to create the link.
3396 With the above setting, you could link to a specific bug with
3397 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3398 @code{[[google:OrgMode]]}, show the map location of the Free Software
3399 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3400 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3401 what the Org author is doing besides Emacs hacking with
3402 @code{[[ads:Dominik,C]]}.
3404 If you need special abbreviations just for a single Org buffer, you
3405 can define them in the file with
3409 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3410 #+LINK: google http://www.google.com/search?q=%s
3414 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3415 complete link abbreviations. You may also define a function
3416 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
3417 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3418 not accept any arguments, and return the full link with prefix.
3420 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3421 @section Search options in file links
3422 @cindex search option in file links
3423 @cindex file links, searching
3425 File links can contain additional information to make Emacs jump to a
3426 particular location in the file when following a link. This can be a
3427 line number or a search option after a double@footnote{For backward
3428 compatibility, line numbers can also follow a single colon.} colon. For
3429 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3430 links}) to a file, it encodes the words in the current line as a search
3431 string that can be used to find this line back later when following the
3432 link with @kbd{C-c C-o}.
3434 Here is the syntax of the different ways to attach a search to a file
3435 link, together with an explanation:
3438 [[file:~/code/main.c::255]]
3439 [[file:~/xx.org::My Target]]
3440 [[file:~/xx.org::*My Target]]
3441 [[file:~/xx.org::#my-custom-id]]
3442 [[file:~/xx.org::/regexp/]]
3449 Search for a link target @samp{<<My Target>>}, or do a text search for
3450 @samp{my target}, similar to the search in internal links, see
3451 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3452 link will become an HTML reference to the corresponding named anchor in
3455 In an Org file, restrict search to headlines.
3457 Link to a heading with a @code{CUSTOM_ID} property
3459 Do a regular expression search for @code{regexp}. This uses the Emacs
3460 command @code{occur} to list all matches in a separate window. If the
3461 target file is in Org-mode, @code{org-occur} is used to create a
3462 sparse tree with the matches.
3463 @c If the target file is a directory,
3464 @c @code{grep} will be used to search all files in the directory.
3467 As a degenerate case, a file link with an empty file name can be used
3468 to search the current file. For example, @code{[[file:::find me]]} does
3469 a search for @samp{find me} in the current file, just as
3470 @samp{[[find me]]} would.
3472 @node Custom searches, , Search options, Hyperlinks
3473 @section Custom Searches
3474 @cindex custom search strings
3475 @cindex search strings, custom
3477 The default mechanism for creating search strings and for doing the
3478 actual search related to a file link may not work correctly in all
3479 cases. For example, Bib@TeX{} database files have many entries like
3480 @samp{year="1993"} which would not result in good search strings,
3481 because the only unique identification for a Bib@TeX{} entry is the
3484 @vindex org-create-file-search-functions
3485 @vindex org-execute-file-search-functions
3486 If you come across such a problem, you can write custom functions to set
3487 the right search string for a particular file type, and to do the search
3488 for the string in the file. Using @code{add-hook}, these functions need
3489 to be added to the hook variables
3490 @code{org-create-file-search-functions} and
3491 @code{org-execute-file-search-functions}. See the docstring for these
3492 variables for more information. Org actually uses this mechanism
3493 for Bib@TeX{} database files, and you can use the corresponding code as
3494 an implementation example. See the file @file{org-bibtex.el}.
3496 @node TODO Items, Tags, Hyperlinks, Top
3500 Org-mode does not maintain TODO lists as separate documents@footnote{Of
3501 course, you can make a document that contains only long lists of TODO items,
3502 but this is not required.}. Instead, TODO items are an integral part of the
3503 notes file, because TODO items usually come up while taking notes! With Org
3504 mode, simply mark any entry in a tree as being a TODO item. In this way,
3505 information is not duplicated, and the entire context from which the TODO
3506 item emerged is always present.
3508 Of course, this technique for managing TODO items scatters them
3509 throughout your notes file. Org-mode compensates for this by providing
3510 methods to give you an overview of all the things that you have to do.
3513 * TODO basics:: Marking and displaying TODO entries
3514 * TODO extensions:: Workflow and assignments
3515 * Progress logging:: Dates and notes for progress
3516 * Priorities:: Some things are more important than others
3517 * Breaking down tasks:: Splitting a task into manageable pieces
3518 * Checkboxes:: Tick-off lists
3521 @node TODO basics, TODO extensions, TODO Items, TODO Items
3522 @section Basic TODO functionality
3524 Any headline becomes a TODO item when it starts with the word
3525 @samp{TODO}, for example:
3528 *** TODO Write letter to Sam Fortune
3532 The most important commands to work with TODO entries are:
3535 @orgcmd{C-c C-t,org-todo}
3536 @cindex cycling, of TODO states
3537 Rotate the TODO state of the current item among
3540 ,-> (unmarked) -> TODO -> DONE --.
3541 '--------------------------------'
3544 The same rotation can also be done ``remotely'' from the timeline and
3545 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3547 @orgkey{C-u C-c C-t}
3548 Select a specific keyword using completion or (if it has been set up)
3549 the fast selection interface. For the latter, you need to assign keys
3550 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3553 @kindex S-@key{right}
3554 @kindex S-@key{left}
3555 @item S-@key{right} @ @r{/} @ S-@key{left}
3556 @vindex org-treat-S-cursor-todo-selection-as-state-change
3557 Select the following/preceding TODO state, similar to cycling. Useful
3558 mostly if more than two TODO states are possible (@pxref{TODO
3559 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3560 with @code{shift-selection-mode}. See also the variable
3561 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3562 @orgcmd{C-c / t,org-show-todo-key}
3563 @cindex sparse tree, for TODO
3564 @vindex org-todo-keywords
3565 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3566 entire buffer, but shows all TODO items (with not-DONE state) and the
3567 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3568 / T}), search for a specific TODO. You will be prompted for the keyword, and
3569 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3570 entries that match any one of these keywords. With numeric prefix argument
3571 N, show the tree for the Nth keyword in the variable
3572 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3573 both un-done and done.
3574 @orgcmd{C-c a t,org-todo-list}
3575 Show the global TODO list. Collects the TODO items (with not-DONE states)
3576 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3577 buffer will be in @code{agenda-mode}, which provides commands to examine and
3578 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3579 @xref{Global TODO list}, for more information.
3580 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3581 Insert a new TODO entry below the current one.
3585 @vindex org-todo-state-tags-triggers
3586 Changing a TODO state can also trigger tag changes. See the docstring of the
3587 option @code{org-todo-state-tags-triggers} for details.
3589 @node TODO extensions, Progress logging, TODO basics, TODO Items
3590 @section Extended use of TODO keywords
3591 @cindex extended TODO keywords
3593 @vindex org-todo-keywords
3594 By default, marked TODO entries have one of only two states: TODO and
3595 DONE. Org-mode allows you to classify TODO items in more complex ways
3596 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3597 special setup, the TODO keyword system can work differently in different
3600 Note that @i{tags} are another way to classify headlines in general and
3601 TODO items in particular (@pxref{Tags}).
3604 * Workflow states:: From TODO to DONE in steps
3605 * TODO types:: I do this, Fred does the rest
3606 * Multiple sets in one file:: Mixing it all, and still finding your way
3607 * Fast access to TODO states:: Single letter selection of a state
3608 * Per-file keywords:: Different files, different requirements
3609 * Faces for TODO keywords:: Highlighting states
3610 * TODO dependencies:: When one task needs to wait for others
3613 @node Workflow states, TODO types, TODO extensions, TODO extensions
3614 @subsection TODO keywords as workflow states
3615 @cindex TODO workflow
3616 @cindex workflow states as TODO keywords
3618 You can use TODO keywords to indicate different @emph{sequential} states
3619 in the process of working on an item, for example@footnote{Changing
3620 this variable only becomes effective after restarting Org-mode in a
3624 (setq org-todo-keywords
3625 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3628 The vertical bar separates the TODO keywords (states that @emph{need
3629 action}) from the DONE states (which need @emph{no further action}). If
3630 you don't provide the separator bar, the last state is used as the DONE
3632 @cindex completion, of TODO keywords
3633 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3634 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3635 also use a numeric prefix argument to quickly select a specific state. For
3636 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3637 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3638 define many keywords, you can use in-buffer completion
3639 (@pxref{Completion}) or even a special one-key selection scheme
3640 (@pxref{Fast access to TODO states}) to insert these words into the
3641 buffer. Changing a TODO state can be logged with a timestamp, see
3642 @ref{Tracking TODO state changes}, for more information.
3644 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3645 @subsection TODO keywords as types
3647 @cindex names as TODO keywords
3648 @cindex types as TODO keywords
3650 The second possibility is to use TODO keywords to indicate different
3651 @emph{types} of action items. For example, you might want to indicate
3652 that items are for ``work'' or ``home''. Or, when you work with several
3653 people on a single project, you might want to assign action items
3654 directly to persons, by using their names as TODO keywords. This would
3655 be set up like this:
3658 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3661 In this case, different keywords do not indicate a sequence, but rather
3662 different types. So the normal work flow would be to assign a task to a
3663 person, and later to mark it DONE. Org-mode supports this style by adapting
3664 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3665 @kbd{t} command in the timeline and agenda buffers.}. When used several
3666 times in succession, it will still cycle through all names, in order to first
3667 select the right type for a task. But when you return to the item after some
3668 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3669 to DONE. Use prefix arguments or completion to quickly select a specific
3670 name. You can also review the items of a specific TODO type in a sparse tree
3671 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3672 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3673 from all agenda files into a single buffer, you would use the numeric prefix
3674 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3676 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3677 @subsection Multiple keyword sets in one file
3678 @cindex TODO keyword sets
3680 Sometimes you may want to use different sets of TODO keywords in
3681 parallel. For example, you may want to have the basic
3682 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3683 separate state indicating that an item has been canceled (so it is not
3684 DONE, but also does not require action). Your setup would then look
3688 (setq org-todo-keywords
3689 '((sequence "TODO" "|" "DONE")
3690 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3691 (sequence "|" "CANCELED")))
3694 The keywords should all be different, this helps Org-mode to keep track
3695 of which subsequence should be used for a given entry. In this setup,
3696 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3697 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3698 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3699 select the correct sequence. Besides the obvious ways like typing a
3700 keyword or using completion, you may also apply the following commands:
3703 @kindex C-S-@key{right}
3704 @kindex C-S-@key{left}
3705 @kindex C-u C-u C-c C-t
3706 @item C-u C-u C-c C-t
3707 @itemx C-S-@key{right}
3708 @itemx C-S-@key{left}
3709 These keys jump from one TODO subset to the next. In the above example,
3710 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3711 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3712 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3713 @code{shift-selection-mode} (@pxref{Conflicts}).
3714 @kindex S-@key{right}
3715 @kindex S-@key{left}
3718 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3719 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3720 from @code{DONE} to @code{REPORT} in the example above. See also
3721 @ref{Conflicts}, for a discussion of the interaction with
3722 @code{shift-selection-mode}.
3725 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3726 @subsection Fast access to TODO states
3728 If you would like to quickly change an entry to an arbitrary TODO state
3729 instead of cycling through the states, you can set up keys for
3730 single-letter access to the states. This is done by adding the section
3731 key after each keyword, in parentheses. For example:
3734 (setq org-todo-keywords
3735 '((sequence "TODO(t)" "|" "DONE(d)")
3736 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3737 (sequence "|" "CANCELED(c)")))
3740 @vindex org-fast-tag-selection-include-todo
3741 If you then press @code{C-c C-t} followed by the selection key, the entry
3742 will be switched to this state. @key{SPC} can be used to remove any TODO
3743 keyword from an entry.@footnote{Check also the variable
3744 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3745 state through the tags interface (@pxref{Setting tags}), in case you like to
3746 mingle the two concepts. Note that this means you need to come up with
3747 unique keys across both sets of keywords.}
3749 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3750 @subsection Setting up keywords for individual files
3751 @cindex keyword options
3752 @cindex per-file keywords
3757 It can be very useful to use different aspects of the TODO mechanism in
3758 different files. For file-local settings, you need to add special lines
3759 to the file which set the keywords and interpretation for that file
3760 only. For example, to set one of the two examples discussed above, you
3761 need one of the following lines, starting in column zero anywhere in the
3765 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3767 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3768 interpretation, but it means the same as @code{#+TODO}), or
3770 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3773 A setup for using several sets in parallel would be:
3777 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3781 @cindex completion, of option keywords
3783 @noindent To make sure you are using the correct keyword, type
3784 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3786 @cindex DONE, final TODO keyword
3787 Remember that the keywords after the vertical bar (or the last keyword
3788 if no bar is there) must always mean that the item is DONE (although you
3789 may use a different word). After changing one of these lines, use
3790 @kbd{C-c C-c} with the cursor still in the line to make the changes
3791 known to Org-mode@footnote{Org-mode parses these lines only when
3792 Org-mode is activated after visiting a file. @kbd{C-c C-c} with the
3793 cursor in a line starting with @samp{#+} is simply restarting Org-mode
3794 for the current buffer.}.
3796 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3797 @subsection Faces for TODO keywords
3798 @cindex faces, for TODO keywords
3800 @vindex org-todo @r{(face)}
3801 @vindex org-done @r{(face)}
3802 @vindex org-todo-keyword-faces
3803 Org-mode highlights TODO keywords with special faces: @code{org-todo}
3804 for keywords indicating that an item still has to be acted upon, and
3805 @code{org-done} for keywords indicating that an item is finished. If
3806 you are using more than 2 different states, you might want to use
3807 special faces for some of them. This can be done using the variable
3808 @code{org-todo-keyword-faces}. For example:
3812 (setq org-todo-keyword-faces
3813 '(("TODO" . org-warning) ("STARTED" . "yellow")
3814 ("CANCELED" . (:foreground "blue" :weight bold))))
3818 While using a list with face properties as shown for CANCELED @emph{should}
3819 work, this does not aways seem to be the case. If necessary, define a
3820 special face and use that. A string is interpreted as a color. The variable
3821 @code{org-faces-easy-properties} determines if that color is interpreted as a
3822 foreground or a background color.
3824 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
3825 @subsection TODO dependencies
3826 @cindex TODO dependencies
3827 @cindex dependencies, of TODO states
3829 @vindex org-enforce-todo-dependencies
3830 @cindex property, ORDERED
3831 The structure of Org files (hierarchy and lists) makes it easy to define TODO
3832 dependencies. Usually, a parent TODO task should not be marked DONE until
3833 all subtasks (defined as children tasks) are marked as DONE. And sometimes
3834 there is a logical sequence to a number of (sub)tasks, so that one task
3835 cannot be acted upon before all siblings above it are done. If you customize
3836 the variable @code{org-enforce-todo-dependencies}, Org will block entries
3837 from changing state to DONE while they have children that are not DONE.
3838 Furthermore, if an entry has a property @code{ORDERED}, each of its children
3839 will be blocked until all earlier siblings are marked DONE. Here is an
3843 * TODO Blocked until (two) is done
3852 ** TODO b, needs to wait for (a)
3853 ** TODO c, needs to wait for (a) and (b)
3857 @orgcmd{C-c C-x o,org-toggle-ordered-property}
3858 @vindex org-track-ordered-property-with-tag
3859 @cindex property, ORDERED
3860 Toggle the @code{ORDERED} property of the current entry. A property is used
3861 for this behavior because this should be local to the current entry, not
3862 inherited like a tag. However, if you would like to @i{track} the value of
3863 this property with a tag for better visibility, customize the variable
3864 @code{org-track-ordered-property-with-tag}.
3865 @orgkey{C-u C-u C-u C-c C-t}
3866 Change TODO state, circumventing any state blocking.
3869 @vindex org-agenda-dim-blocked-tasks
3870 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
3871 that cannot be closed because of such dependencies will be shown in a dimmed
3872 font or even made invisible in agenda views (@pxref{Agenda Views}).
3874 @cindex checkboxes and TODO dependencies
3875 @vindex org-enforce-todo-dependencies
3876 You can also block changes of TODO states by looking at checkboxes
3877 (@pxref{Checkboxes}). If you set the variable
3878 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
3879 checkboxes will be blocked from switching to DONE.
3881 If you need more complex dependency structures, for example dependencies
3882 between entries in different trees or files, check out the contributed
3883 module @file{org-depend.el}.
3886 @node Progress logging, Priorities, TODO extensions, TODO Items
3887 @section Progress logging
3888 @cindex progress logging
3889 @cindex logging, of progress
3891 Org-mode can automatically record a timestamp and possibly a note when
3892 you mark a TODO item as DONE, or even each time you change the state of
3893 a TODO item. This system is highly configurable, settings can be on a
3894 per-keyword basis and can be localized to a file or even a subtree. For
3895 information on how to clock working time for a task, see @ref{Clocking
3899 * Closing items:: When was this entry marked DONE?
3900 * Tracking TODO state changes:: When did the status change?
3901 * Tracking your habits:: How consistent have you been?
3904 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
3905 @subsection Closing items
3907 The most basic logging is to keep track of @emph{when} a certain TODO
3908 item was finished. This is achieved with@footnote{The corresponding
3909 in-buffer setting is: @code{#+STARTUP: logdone}}
3912 (setq org-log-done 'time)
3916 Then each time you turn an entry from a TODO (not-done) state into any
3917 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
3918 just after the headline. If you turn the entry back into a TODO item
3919 through further state cycling, that line will be removed again. If you
3920 want to record a note along with the timestamp, use@footnote{The
3921 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
3924 (setq org-log-done 'note)
3928 You will then be prompted for a note, and that note will be stored below
3929 the entry with a @samp{Closing Note} heading.
3931 In the timeline (@pxref{Timeline}) and in the agenda
3932 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
3933 display the TODO items with a @samp{CLOSED} timestamp on each day,
3934 giving you an overview of what has been done.
3936 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
3937 @subsection Tracking TODO state changes
3938 @cindex drawer, for state change recording
3940 @vindex org-log-states-order-reversed
3941 @vindex org-log-into-drawer
3942 @cindex property, LOG_INTO_DRAWER
3943 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
3944 might want to keep track of when a state change occurred and maybe take a
3945 note about this change. You can either record just a timestamp, or a
3946 time-stamped note for a change. These records will be inserted after the
3947 headline as an itemized list, newest first@footnote{See the variable
3948 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
3949 want to get the notes out of the way into a drawer (@pxref{Drawers}).
3950 Customize the variable @code{org-log-into-drawer} to get this
3951 behavior---the recommended drawer for this is called @code{LOGBOOK}. You can
3952 also overrule the setting of this variable for a subtree by setting a
3953 @code{LOG_INTO_DRAWER} property.
3955 Since it is normally too much to record a note for every state, Org-mode
3956 expects configuration on a per-keyword basis for this. This is achieved by
3957 adding special markers @samp{!} (for a timestamp) and @samp{@@} (for a note)
3958 in parentheses after each keyword. For example, with the setting
3961 (setq org-todo-keywords
3962 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
3966 @vindex org-log-done
3967 you not only define global TODO keywords and fast access keys, but also
3968 request that a time is recorded when the entry is set to
3969 DONE@footnote{It is possible that Org-mode will record two timestamps
3970 when you are using both @code{org-log-done} and state change logging.
3971 However, it will never prompt for two notes---if you have configured
3972 both, the state change recording note will take precedence and cancel
3973 the @samp{Closing Note}.}, and that a note is recorded when switching to
3974 WAIT or CANCELED. The setting for WAIT is even more special: the
3975 @samp{!} after the slash means that in addition to the note taken when
3976 entering the state, a timestamp should be recorded when @i{leaving} the
3977 WAIT state, if and only if the @i{target} state does not configure
3978 logging for entering it. So it has no effect when switching from WAIT
3979 to DONE, because DONE is configured to record a timestamp only. But
3980 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
3981 setting now triggers a timestamp even though TODO has no logging
3984 You can use the exact same syntax for setting logging preferences local
3987 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
3990 @cindex property, LOGGING
3991 In order to define logging settings that are local to a subtree or a
3992 single item, define a LOGGING property in this entry. Any non-empty
3993 LOGGING property resets all logging settings to nil. You may then turn
3994 on logging for this specific tree using STARTUP keywords like
3995 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
3996 settings like @code{TODO(!)}. For example
3999 * TODO Log each state with only a time
4001 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4003 * TODO Only log when switching to WAIT, and when repeating
4005 :LOGGING: WAIT(@@) logrepeat
4007 * TODO No logging at all
4013 @node Tracking your habits, , Tracking TODO state changes, Progress logging
4014 @subsection Tracking your habits
4017 Org has the ability to track the consistency of a special category of TODOs,
4018 called ``habits''. A habit has the following properties:
4022 You have enabled the @code{habits} module by customizing the variable
4025 The habit is a TODO, with a TODO keyword representing an open state.
4027 The property @code{STYLE} is set to the value @code{habit}.
4029 The TODO has a scheduled date, usually with a @code{.+} style repeat
4030 interval. A @code{++} style may be appropriate for habits with time
4031 constraints, e.g., must be done on weekends, or a @code{+} style for an
4032 unusual habit that can have a backlog, e.g., weekly reports.
4034 The TODO may also have minimum and maximum ranges specified by using the
4035 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4036 three days, but at most every two days.
4038 You must also have state logging for the @code{DONE} state enabled, in order
4039 for historical data to be represented in the consistency graph. If it's not
4040 enabled it's not an error, but the consistency graphs will be largely
4044 To give you an idea of what the above rules look like in action, here's an
4045 actual habit with some history:
4049 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4050 - State "DONE" from "TODO" [2009-10-15 Thu]
4051 - State "DONE" from "TODO" [2009-10-12 Mon]
4052 - State "DONE" from "TODO" [2009-10-10 Sat]
4053 - State "DONE" from "TODO" [2009-10-04 Sun]
4054 - State "DONE" from "TODO" [2009-10-02 Fri]
4055 - State "DONE" from "TODO" [2009-09-29 Tue]
4056 - State "DONE" from "TODO" [2009-09-25 Fri]
4057 - State "DONE" from "TODO" [2009-09-19 Sat]
4058 - State "DONE" from "TODO" [2009-09-16 Wed]
4059 - State "DONE" from "TODO" [2009-09-12 Sat]
4062 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4066 What this habit says is: I want to shave at most every 2 days (given by the
4067 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4068 today is the 15th, then the habit first appears in the agenda on Oct 17,
4069 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4070 after four days have elapsed.
4072 What's really useful about habits is that they are displayed along with a
4073 consistency graph, to show how consistent you've been at getting that task
4074 done in the past. This graph shows every day that the task was done over the
4075 past three weeks, with colors for each day. The colors used are:
4079 If the task wasn't to be done yet on that day.
4081 If the task could have been done on that day.
4083 If the task was going to be overdue the next day.
4085 If the task was overdue on that day.
4088 In addition to coloring each day, the day is also marked with an asterisk if
4089 the task was actually done that day, and an exclamation mark to show where
4090 the current day falls in the graph.
4092 There are several configuration variables that can be used to change the way
4093 habits are displayed in the agenda.
4096 @item org-habit-graph-column
4097 The buffer column at which the consistency graph should be drawn. This will
4098 overwrite any text in that column, so it's a good idea to keep your habits'
4099 titles brief and to the point.
4100 @item org-habit-preceding-days
4101 The amount of history, in days before today, to appear in consistency graphs.
4102 @item org-habit-following-days
4103 The number of days after today that will appear in consistency graphs.
4104 @item org-habit-show-habits-only-for-today
4105 If non-nil, only show habits in today's agenda view. This is set to true by
4109 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4110 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4111 bring them back. They are also subject to tag filtering, if you have habits
4112 which should only be done in certain contexts, for example.
4114 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4118 If you use Org-mode extensively, you may end up with enough TODO items that
4119 it starts to make sense to prioritize them. Prioritizing can be done by
4120 placing a @emph{priority cookie} into the headline of a TODO item, like this
4123 *** TODO [#A] Write letter to Sam Fortune
4127 @vindex org-priority-faces
4128 By default, Org-mode supports three priorities: @samp{A}, @samp{B}, and
4129 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4130 treated just like priority @samp{B}. Priorities make a difference only for
4131 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4132 have no inherent meaning to Org-mode. The cookies can be highlighted with
4133 special faces by customizing the variable @code{org-priority-faces}.
4135 Priorities can be attached to any outline node; they do not need to be TODO
4141 @findex org-priority
4142 Set the priority of the current headline (@command{org-priority}). The
4143 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4144 When you press @key{SPC} instead, the priority cookie is removed from the
4145 headline. The priorities can also be changed ``remotely'' from the timeline
4146 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4148 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4149 @vindex org-priority-start-cycle-with-default
4150 Increase/decrease priority of current headline@footnote{See also the option
4151 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4152 also used to modify timestamps (@pxref{Creating timestamps}). See also
4153 @ref{Conflicts}, for a discussion of the interaction with
4154 @code{shift-selection-mode}.
4157 @vindex org-highest-priority
4158 @vindex org-lowest-priority
4159 @vindex org-default-priority
4160 You can change the range of allowed priorities by setting the variables
4161 @code{org-highest-priority}, @code{org-lowest-priority}, and
4162 @code{org-default-priority}. For an individual buffer, you may set
4163 these values (highest, lowest, default) like this (please make sure that
4164 the highest priority is earlier in the alphabet than the lowest
4167 @cindex #+PRIORITIES
4172 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4173 @section Breaking tasks down into subtasks
4174 @cindex tasks, breaking down
4175 @cindex statistics, for TODO items
4177 @vindex org-agenda-todo-list-sublevels
4178 It is often advisable to break down large tasks into smaller, manageable
4179 subtasks. You can do this by creating an outline tree below a TODO item,
4180 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4181 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4182 the overview over the fraction of subtasks that are already completed, insert
4183 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4184 be updated each time the TODO status of a child changes, or when pressing
4185 @kbd{C-c C-c} on the cookie. For example:
4188 * Organize Party [33%]
4189 ** TODO Call people [1/2]
4193 ** DONE Talk to neighbor
4196 @cindex property, COOKIE_DATA
4197 If a heading has both checkboxes and TODO children below it, the meaning of
4198 the statistics cookie become ambiguous. Set the property
4199 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4202 @vindex org-hierarchical-todo-statistics
4203 If you would like to have the statistics cookie count any TODO entries in the
4204 subtree (not just direct children), configure the variable
4205 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4206 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4210 * Parent capturing statistics [2/20]
4212 :COOKIE_DATA: todo recursive
4216 If you would like a TODO entry to automatically change to DONE
4217 when all children are done, you can use the following setup:
4220 (defun org-summary-todo (n-done n-not-done)
4221 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4222 (let (org-log-done org-log-states) ; turn off logging
4223 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4225 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4229 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4230 large number of subtasks (@pxref{Checkboxes}).
4233 @node Checkboxes, , Breaking down tasks, TODO Items
4237 @vindex org-list-automatic-rules
4238 Every item in a plain list@footnote{With the exception of description
4239 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4240 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4241 it with the string @samp{[ ]}. This feature is similar to TODO items
4242 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4243 into the global TODO list, so they are often great to split a task into a
4244 number of simple steps. Or you can use them in a shopping list. To toggle a
4245 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4246 @file{org-mouse.el}).
4248 Here is an example of a checkbox list.
4251 * TODO Organize party [2/4]
4252 - [-] call people [1/3]
4257 - [ ] think about what music to play
4258 - [X] talk to the neighbors
4261 Checkboxes work hierarchically, so if a checkbox item has children that
4262 are checkboxes, toggling one of the children checkboxes will make the
4263 parent checkbox reflect if none, some, or all of the children are
4266 @cindex statistics, for checkboxes
4267 @cindex checkbox statistics
4268 @cindex property, COOKIE_DATA
4269 @vindex org-hierarchical-checkbox-statistics
4270 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4271 indicating how many checkboxes present in this entry have been checked off,
4272 and the total number of checkboxes present. This can give you an idea on how
4273 many checkboxes remain, even without opening a folded entry. The cookies can
4274 be placed into a headline or into (the first line of) a plain list item.
4275 Each cookie covers checkboxes of direct children structurally below the
4276 headline/item on which the cookie appears@footnote{Set the variable
4277 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4278 count all checkboxes below the cookie, not just those belonging to direct
4279 children.}. You have to insert the cookie yourself by typing either
4280 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4281 result, as in the examples above. With @samp{[%]} you get information about
4282 the percentage of checkboxes checked (in the above example, this would be
4283 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4284 count either checkboxes below the heading or TODO states of children, and it
4285 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4286 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4288 @cindex blocking, of checkboxes
4289 @cindex checkbox blocking
4290 @cindex property, ORDERED
4291 If the current outline node has an @code{ORDERED} property, checkboxes must
4292 be checked off in sequence, and an error will be thrown if you try to check
4293 off a box while there are unchecked boxes above it.
4295 @noindent The following commands work with checkboxes:
4298 @orgcmd{C-c C-c,org-toggle-checkbox}
4299 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4300 double prefix argument, set it to @samp{[-]}, which is considered to be an
4302 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4303 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4304 double prefix argument, set it to @samp{[-]}, which is considered to be an
4308 If there is an active region, toggle the first checkbox in the region
4309 and set all remaining boxes to the same status as the first. With a prefix
4310 arg, add or remove the checkbox for all items in the region.
4312 If the cursor is in a headline, toggle checkboxes in the region between
4313 this headline and the next (so @emph{not} the entire subtree).
4315 If there is no active region, just toggle the checkbox at point.
4317 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4318 Insert a new item with a checkbox. This works only if the cursor is already
4319 in a plain list item (@pxref{Plain lists}).
4320 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4321 @vindex org-track-ordered-property-with-tag
4322 @cindex property, ORDERED
4323 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4324 be checked off in sequence. A property is used for this behavior because
4325 this should be local to the current entry, not inherited like a tag.
4326 However, if you would like to @i{track} the value of this property with a tag
4327 for better visibility, customize the variable
4328 @code{org-track-ordered-property-with-tag}.
4329 @orgcmd{C-c #,org-update-statistics-cookies}
4330 Update the statistics cookie in the current outline entry. When called with
4331 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4332 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4333 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4334 changing TODO states. If you delete boxes/entries or add/change them by
4335 hand, use this command to get things back into sync.
4338 @node Tags, Properties and Columns, TODO Items, Top
4341 @cindex headline tagging
4342 @cindex matching, tags
4343 @cindex sparse tree, tag based
4345 An excellent way to implement labels and contexts for cross-correlating
4346 information is to assign @i{tags} to headlines. Org-mode has extensive
4349 @vindex org-tag-faces
4350 Every headline can contain a list of tags; they occur at the end of the
4351 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4352 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4353 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4354 Tags will by default be in bold face with the same color as the headline.
4355 You may specify special faces for specific tags using the variable
4356 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4357 (@pxref{Faces for TODO keywords}).
4360 * Tag inheritance:: Tags use the tree structure of the outline
4361 * Setting tags:: How to assign tags to a headline
4362 * Tag searches:: Searching for combinations of tags
4365 @node Tag inheritance, Setting tags, Tags, Tags
4366 @section Tag inheritance
4367 @cindex tag inheritance
4368 @cindex inheritance, of tags
4369 @cindex sublevels, inclusion into tags match
4371 @i{Tags} make use of the hierarchical structure of outline trees. If a
4372 heading has a certain tag, all subheadings will inherit the tag as
4373 well. For example, in the list
4376 * Meeting with the French group :work:
4377 ** Summary by Frank :boss:notes:
4378 *** TODO Prepare slides for him :action:
4382 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4383 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4384 explicitly marked with those tags. You can also set tags that all entries in
4385 a file should inherit just as if these tags were defined in a hypothetical
4386 level zero that surrounds the entire file. Use a line like this@footnote{As
4387 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4388 changes in the line.}:
4392 #+FILETAGS: :Peter:Boss:Secret:
4396 @vindex org-use-tag-inheritance
4397 @vindex org-tags-exclude-from-inheritance
4398 To limit tag inheritance to specific tags, or to turn it off entirely, use
4399 the variables @code{org-use-tag-inheritance} and
4400 @code{org-tags-exclude-from-inheritance}.
4402 @vindex org-tags-match-list-sublevels
4403 When a headline matches during a tags search while tag inheritance is turned
4404 on, all the sublevels in the same tree will (for a simple match form) match
4405 as well@footnote{This is only true if the search does not involve more
4406 complex tests including properties (@pxref{Property searches}).}. The list
4407 of matches may then become very long. If you only want to see the first tags
4408 match in a subtree, configure the variable
4409 @code{org-tags-match-list-sublevels} (not recommended).
4411 @node Setting tags, Tag searches, Tag inheritance, Tags
4412 @section Setting tags
4413 @cindex setting tags
4414 @cindex tags, setting
4417 Tags can simply be typed into the buffer at the end of a headline.
4418 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4419 also a special command for inserting tags:
4422 @orgcmd{C-c C-q,org-set-tags-command}
4423 @cindex completion, of tags
4424 @vindex org-tags-column
4425 Enter new tags for the current headline. Org-mode will either offer
4426 completion or a special single-key interface for setting tags, see
4427 below. After pressing @key{RET}, the tags will be inserted and aligned
4428 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4429 tags in the current buffer will be aligned to that column, just to make
4430 things look nice. TAGS are automatically realigned after promotion,
4431 demotion, and TODO state changes (@pxref{TODO basics}).
4432 @orgcmd{C-c C-c,org-set-tags-command}
4433 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4436 @vindex org-tag-alist
4437 Org will support tag insertion based on a @emph{list of tags}. By
4438 default this list is constructed dynamically, containing all tags
4439 currently used in the buffer. You may also globally specify a hard list
4440 of tags with the variable @code{org-tag-alist}. Finally you can set
4441 the default tags for a given file with lines like
4445 #+TAGS: @@work @@home @@tennisclub
4446 #+TAGS: laptop car pc sailboat
4449 If you have globally defined your preferred set of tags using the
4450 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4451 in a specific file, add an empty TAGS option line to that file:
4457 @vindex org-tag-persistent-alist
4458 If you have a preferred set of tags that you would like to use in every file,
4459 in addition to those defined on a per-file basis by TAGS option lines, then
4460 you may specify a list of tags with the variable
4461 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4462 by adding a STARTUP option line to that file:
4468 By default Org-mode uses the standard minibuffer completion facilities for
4469 entering tags. However, it also implements another, quicker, tag selection
4470 method called @emph{fast tag selection}. This allows you to select and
4471 deselect tags with just a single key press. For this to work well you should
4472 assign unique letters to most of your commonly used tags. You can do this
4473 globally by configuring the variable @code{org-tag-alist} in your
4474 @file{.emacs} file. For example, you may find the need to tag many items in
4475 different files with @samp{:@@home:}. In this case you can set something
4479 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4482 @noindent If the tag is only relevant to the file you are working on, then you
4483 can instead set the TAGS option line as:
4486 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4489 @noindent The tags interface will show the available tags in a splash
4490 window. If you want to start a new line after a specific tag, insert
4491 @samp{\n} into the tag list
4494 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4497 @noindent or write them in two lines:
4500 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4501 #+TAGS: laptop(l) pc(p)
4505 You can also group together tags that are mutually exclusive by using
4509 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4512 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4513 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4515 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4516 these lines to activate any changes.
4519 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4520 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4521 of the braces. Similarly, you can use @code{:newline} to indicate a line
4522 break. The previous example would be set globally by the following
4526 (setq org-tag-alist '((:startgroup . nil)
4527 ("@@work" . ?w) ("@@home" . ?h)
4528 ("@@tennisclub" . ?t)
4530 ("laptop" . ?l) ("pc" . ?p)))
4533 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4534 automatically present you with a special interface, listing inherited tags,
4535 the tags of the current headline, and a list of all valid tags with
4536 corresponding keys@footnote{Keys will automatically be assigned to tags which
4537 have no configured keys.}. In this interface, you can use the following
4542 Pressing keys assigned to tags will add or remove them from the list of
4543 tags in the current line. Selecting a tag in a group of mutually
4544 exclusive tags will turn off any other tags from that group.
4547 Enter a tag in the minibuffer, even if the tag is not in the predefined
4548 list. You will be able to complete on all tags present in the buffer.
4549 You can also add several tags: just separate them with a comma.
4553 Clear all tags for this line.
4556 Accept the modified set.
4558 Abort without installing changes.
4560 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4562 Turn off groups of mutually exclusive tags. Use this to (as an
4563 exception) assign several tags from such a group.
4565 Toggle auto-exit after the next change (see below).
4566 If you are using expert mode, the first @kbd{C-c} will display the
4571 This method lets you assign tags to a headline with very few keys. With
4572 the above setup, you could clear the current tags and set @samp{@@home},
4573 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4574 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4575 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4576 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4577 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4578 @key{RET} @key{RET}}.
4580 @vindex org-fast-tag-selection-single-key
4581 If you find that most of the time you need only a single key press to
4582 modify your list of tags, set the variable
4583 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4584 press @key{RET} to exit fast tag selection---it will immediately exit
4585 after the first change. If you then occasionally need more keys, press
4586 @kbd{C-c} to turn off auto-exit for the current tag selection process
4587 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4588 C-c}). If you set the variable to the value @code{expert}, the special
4589 window is not even shown for single-key tag selection, it comes up only
4590 when you press an extra @kbd{C-c}.
4592 @node Tag searches, , Setting tags, Tags
4593 @section Tag searches
4594 @cindex tag searches
4595 @cindex searching for tags
4597 Once a system of tags has been set up, it can be used to collect related
4598 information into special lists.
4601 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
4602 Create a sparse tree with all headlines matching a tags search. With a
4603 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4604 @orgcmd{C-c a m,org-tags-view}
4605 Create a global list of tag matches from all agenda files.
4606 @xref{Matching tags and properties}.
4607 @orgcmd{C-c a M,org-tags-view}
4608 @vindex org-tags-match-list-sublevels
4609 Create a global list of tag matches from all agenda files, but check
4610 only TODO items and force checking subitems (see variable
4611 @code{org-tags-match-list-sublevels}).
4614 These commands all prompt for a match string which allows basic Boolean logic
4615 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4616 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4617 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4618 string is rich and allows also matching against TODO keywords, entry levels
4619 and properties. For a complete description with many examples, see
4620 @ref{Matching tags and properties}.
4623 @node Properties and Columns, Dates and Times, Tags, Top
4624 @chapter Properties and columns
4627 Properties are a set of key-value pairs associated with an entry. There
4628 are two main applications for properties in Org-mode. First, properties
4629 are like tags, but with a value. Second, you can use properties to
4630 implement (very basic) database capabilities in an Org buffer. For
4631 an example of the first application, imagine maintaining a file where
4632 you document bugs and plan releases for a piece of software. Instead of
4633 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4634 property, say @code{:Release:}, that in different subtrees has different
4635 values, such as @code{1.0} or @code{2.0}. For an example of the second
4636 application of properties, imagine keeping track of your music CDs,
4637 where properties could be things such as the album, artist, date of
4638 release, number of tracks, and so on.
4640 Properties can be conveniently edited and viewed in column view
4641 (@pxref{Column view}).
4644 * Property syntax:: How properties are spelled out
4645 * Special properties:: Access to other Org-mode features
4646 * Property searches:: Matching property values
4647 * Property inheritance:: Passing values down the tree
4648 * Column view:: Tabular viewing and editing
4649 * Property API:: Properties for Lisp programmers
4652 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4653 @section Property syntax
4654 @cindex property syntax
4655 @cindex drawer, for properties
4657 Properties are key-value pairs. They need to be inserted into a special
4658 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4659 is specified on a single line, with the key (surrounded by colons)
4660 first, and the value after it. Here is an example:
4665 *** Goldberg Variations
4667 :Title: Goldberg Variations
4668 :Composer: J.S. Bach
4670 :Publisher: Deutsche Grammophon
4675 You may define the allowed values for a particular property @samp{:Xyz:}
4676 by setting a property @samp{:Xyz_ALL:}. This special property is
4677 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4678 the entire tree. When allowed values are defined, setting the
4679 corresponding property becomes easier and is less prone to typing
4680 errors. For the example with the CD collection, we can predefine
4681 publishers and the number of disks in a box like this:
4686 :NDisks_ALL: 1 2 3 4
4687 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4691 If you want to set properties that can be inherited by any entry in a
4692 file, use a line like
4693 @cindex property, _ALL
4696 #+PROPERTY: NDisks_ALL 1 2 3 4
4699 @vindex org-global-properties
4700 Property values set with the global variable
4701 @code{org-global-properties} can be inherited by all entries in all
4705 The following commands help to work with properties:
4708 @orgcmd{M-@key{TAB},pcomplete}
4709 After an initial colon in a line, complete property keys. All keys used
4710 in the current file will be offered as possible completions.
4711 @orgcmd{C-c C-x p,org-set-property}
4712 Set a property. This prompts for a property name and a value. If
4713 necessary, the property drawer is created as well.
4714 @item M-x org-insert-property-drawer
4715 @findex org-insert-property-drawer
4716 Insert a property drawer into the current entry. The drawer will be
4717 inserted early in the entry, but after the lines with planning
4718 information like deadlines.
4719 @orgcmd{C-c C-c,org-property-action}
4720 With the cursor in a property drawer, this executes property commands.
4721 @orgcmd{C-c C-c s,org-set-property}
4722 Set a property in the current entry. Both the property and the value
4723 can be inserted using completion.
4724 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4725 Switch property at point to the next/previous allowed value.
4726 @orgcmd{C-c C-c d,org-delete-property}
4727 Remove a property from the current entry.
4728 @orgcmd{C-c C-c D,org-delete-property-globally}
4729 Globally remove a property, from all entries in the current file.
4730 @orgcmd{C-c C-c c,org-compute-property-at-point}
4731 Compute the property at point, using the operator and scope from the
4732 nearest column format definition.
4735 @node Special properties, Property searches, Property syntax, Properties and Columns
4736 @section Special properties
4737 @cindex properties, special
4739 Special properties provide an alternative access method to Org-mode features,
4740 like the TODO state or the priority of an entry, discussed in the previous
4741 chapters. This interface exists so that you can include these states in a
4742 column view (@pxref{Column view}), or to use them in queries. The following
4743 property names are special and (except for @code{:CATEGORY:}) should not be
4744 used as keys in the properties drawer:
4746 @cindex property, special, TODO
4747 @cindex property, special, TAGS
4748 @cindex property, special, ALLTAGS
4749 @cindex property, special, CATEGORY
4750 @cindex property, special, PRIORITY
4751 @cindex property, special, DEADLINE
4752 @cindex property, special, SCHEDULED
4753 @cindex property, special, CLOSED
4754 @cindex property, special, TIMESTAMP
4755 @cindex property, special, TIMESTAMP_IA
4756 @cindex property, special, CLOCKSUM
4757 @cindex property, special, BLOCKED
4758 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4759 @cindex property, special, ITEM
4760 @cindex property, special, FILE
4762 TODO @r{The TODO keyword of the entry.}
4763 TAGS @r{The tags defined directly in the headline.}
4764 ALLTAGS @r{All tags, including inherited ones.}
4765 CATEGORY @r{The category of an entry.}
4766 PRIORITY @r{The priority of the entry, a string with a single letter.}
4767 DEADLINE @r{The deadline time string, without the angular brackets.}
4768 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4769 CLOSED @r{When was this entry closed?}
4770 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4771 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4772 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4773 @r{must be run first to compute the values.}
4774 BLOCKED @r{"t" if task is currently blocked by children or siblings}
4775 ITEM @r{The content of the entry.}
4776 FILE @r{The filename the entry is located in.}
4779 @node Property searches, Property inheritance, Special properties, Properties and Columns
4780 @section Property searches
4781 @cindex properties, searching
4782 @cindex searching, of properties
4784 To create sparse trees and special lists with selection based on properties,
4785 the same commands are used as for tag searches (@pxref{Tag searches}).
4787 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4788 Create a sparse tree with all matching entries. With a
4789 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4790 @orgcmd{C-c a m,org-tags-view}
4791 Create a global list of tag/property matches from all agenda files.
4792 @xref{Matching tags and properties}.
4793 @orgcmd{C-c a M,org-tags-view}
4794 @vindex org-tags-match-list-sublevels
4795 Create a global list of tag matches from all agenda files, but check
4796 only TODO items and force checking of subitems (see variable
4797 @code{org-tags-match-list-sublevels}).
4800 The syntax for the search string is described in @ref{Matching tags and
4803 There is also a special command for creating sparse trees based on a
4808 Create a sparse tree based on the value of a property. This first
4809 prompts for the name of a property, and then for a value. A sparse tree
4810 is created with all entries that define this property with the given
4811 value. If you enclose the value in curly braces, it is interpreted as
4812 a regular expression and matched against the property values.
4815 @node Property inheritance, Column view, Property searches, Properties and Columns
4816 @section Property Inheritance
4817 @cindex properties, inheritance
4818 @cindex inheritance, of properties
4820 @vindex org-use-property-inheritance
4821 The outline structure of Org-mode documents lends itself to an
4822 inheritance model of properties: if the parent in a tree has a certain
4823 property, the children can inherit this property. Org-mode does not
4824 turn this on by default, because it can slow down property searches
4825 significantly and is often not needed. However, if you find inheritance
4826 useful, you can turn it on by setting the variable
4827 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4828 all properties inherited from the parent, to a list of properties
4829 that should be inherited, or to a regular expression that matches
4830 inherited properties. If a property has the value @samp{nil}, this is
4831 interpreted as an explicit undefine of the property, so that inheritance
4832 search will stop at this value and return @code{nil}.
4834 Org-mode has a few properties for which inheritance is hard-coded, at
4835 least for the special applications for which they are used:
4837 @cindex property, COLUMNS
4840 The @code{:COLUMNS:} property defines the format of column view
4841 (@pxref{Column view}). It is inherited in the sense that the level
4842 where a @code{:COLUMNS:} property is defined is used as the starting
4843 point for a column view table, independently of the location in the
4844 subtree from where columns view is turned on.
4846 @cindex property, CATEGORY
4847 For agenda view, a category set through a @code{:CATEGORY:} property
4848 applies to the entire subtree.
4850 @cindex property, ARCHIVE
4851 For archiving, the @code{:ARCHIVE:} property may define the archive
4852 location for the entire subtree (@pxref{Moving subtrees}).
4854 @cindex property, LOGGING
4855 The LOGGING property may define logging settings for an entry or a
4856 subtree (@pxref{Tracking TODO state changes}).
4859 @node Column view, Property API, Property inheritance, Properties and Columns
4860 @section Column view
4862 A great way to view and edit properties in an outline tree is
4863 @emph{column view}. In column view, each outline node is turned into a
4864 table row. Columns in this table provide access to properties of the
4865 entries. Org-mode implements columns by overlaying a tabular structure
4866 over the headline of each item. While the headlines have been turned
4867 into a table row, you can still change the visibility of the outline
4868 tree. For example, you get a compact table by switching to CONTENTS
4869 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4870 is active), but you can still open, read, and edit the entry below each
4871 headline. Or, you can switch to column view after executing a sparse
4872 tree command and in this way get a table only for the selected items.
4873 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4874 queries have collected selected items, possibly from a number of files.
4877 * Defining columns:: The COLUMNS format property
4878 * Using column view:: How to create and use column view
4879 * Capturing column view:: A dynamic block for column view
4882 @node Defining columns, Using column view, Column view, Column view
4883 @subsection Defining columns
4884 @cindex column view, for properties
4885 @cindex properties, column view
4887 Setting up a column view first requires defining the columns. This is
4888 done by defining a column format line.
4891 * Scope of column definitions:: Where defined, where valid?
4892 * Column attributes:: Appearance and content of a column
4895 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4896 @subsubsection Scope of column definitions
4898 To define a column format for an entire file, use a line like
4902 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4905 To specify a format that only applies to a specific tree, add a
4906 @code{:COLUMNS:} property to the top node of that tree, for example:
4909 ** Top node for columns view
4911 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4915 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4916 for the entry itself, and for the entire subtree below it. Since the
4917 column definition is part of the hierarchical structure of the document,
4918 you can define columns on level 1 that are general enough for all
4919 sublevels, and more specific columns further down, when you edit a
4920 deeper part of the tree.
4922 @node Column attributes, , Scope of column definitions, Defining columns
4923 @subsubsection Column attributes
4924 A column definition sets the attributes of a column. The general
4925 definition looks like this:
4928 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
4932 Except for the percent sign and the property name, all items are
4933 optional. The individual parts have the following meaning:
4936 @var{width} @r{An integer specifying the width of the column in characters.}
4937 @r{If omitted, the width will be determined automatically.}
4938 @var{property} @r{The property that should be edited in this column.}
4939 @r{Special properties representing meta data are allowed here}
4940 @r{as well (@pxref{Special properties})}
4941 @var{title} @r{The header text for the column. If omitted, the property}
4943 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
4944 @r{parent nodes are computed from the children.}
4945 @r{Supported summary types are:}
4946 @{+@} @r{Sum numbers in this column.}
4947 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4948 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4949 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
4950 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
4951 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
4952 @{X%@} @r{Checkbox status, @samp{[n%]}.}
4953 @{min@} @r{Smallest number in column.}
4954 @{max@} @r{Largest number.}
4955 @{mean@} @r{Arithmetic mean of numbers.}
4956 @{:min@} @r{Smallest time value in column.}
4957 @{:max@} @r{Largest time value.}
4958 @{:mean@} @r{Arithmetic mean of time values.}
4959 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
4960 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
4961 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
4962 @{est+@} @r{Add low-high estimates.}
4966 Be aware that you can only have one summary type for any property you
4967 include. Subsequent columns referencing the same property will all display the
4968 same summary information.
4970 The @code{est+} summary type requires further explanation. It is used for
4971 combining estimates, expressed as low-high ranges. For example, instead
4972 of estimating a particular task will take 5 days, you might estimate it as
4973 5-6 days if you're fairly confident you know how much work is required, or
4974 1-10 days if you don't really know what needs to be done. Both ranges
4975 average at 5.5 days, but the first represents a more predictable delivery.
4977 When combining a set of such estimates, simply adding the lows and highs
4978 produces an unrealistically wide result. Instead, @code{est+} adds the
4979 statistical mean and variance of the sub-tasks, generating a final estimate
4980 from the sum. For example, suppose you had ten tasks, each of which was
4981 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
4982 of 5 to 20 days, representing what to expect if everything goes either
4983 extremely well or extremely poorly. In contrast, @code{est+} estimates the
4984 full job more realistically, at 10-15 days.
4986 Here is an example for a complete columns definition, along with allowed
4990 :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.}
4991 %10Time_Estimate@{:@} %CLOCKSUM
4992 :Owner_ALL: Tammy Mark Karl Lisa Don
4993 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4994 :Approved_ALL: "[ ]" "[X]"
4998 The first column, @samp{%25ITEM}, means the first 25 characters of the
4999 item itself, i.e.@: of the headline. You probably always should start the
5000 column definition with the @samp{ITEM} specifier. The other specifiers
5001 create columns @samp{Owner} with a list of names as allowed values, for
5002 @samp{Status} with four different possible values, and for a checkbox
5003 field @samp{Approved}. When no width is given after the @samp{%}
5004 character, the column will be exactly as wide as it needs to be in order
5005 to fully display all values. The @samp{Approved} column does have a
5006 modified title (@samp{Approved?}, with a question mark). Summaries will
5007 be created for the @samp{Time_Estimate} column by adding time duration
5008 expressions like HH:MM, and for the @samp{Approved} column, by providing
5009 an @samp{[X]} status if all children have been checked. The
5010 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
5013 @node Using column view, Capturing column view, Defining columns, Column view
5014 @subsection Using column view
5017 @tsubheading{Turning column view on and off}
5018 @orgcmd{C-c C-x C-c,org-columns}
5019 @vindex org-columns-default-format
5020 Turn on column view. If the cursor is before the first headline in the file,
5021 column view is turned on for the entire file, using the @code{#+COLUMNS}
5022 definition. If the cursor is somewhere inside the outline, this command
5023 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5024 defines a format. When one is found, the column view table is established
5025 for the tree starting at the entry that contains the @code{:COLUMNS:}
5026 property. If no such property is found, the format is taken from the
5027 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5028 and column view is established for the current entry and its subtree.
5029 @orgcmd{r,org-columns-redo}
5030 Recreate the column view, to include recent changes made in the buffer.
5031 @orgcmd{g,org-columns-redo}
5033 @orgcmd{q,org-columns-quit}
5035 @tsubheading{Editing values}
5036 @item @key{left} @key{right} @key{up} @key{down}
5037 Move through the column view from field to field.
5038 @kindex S-@key{left}
5039 @kindex S-@key{right}
5040 @item S-@key{left}/@key{right}
5041 Switch to the next/previous allowed value of the field. For this, you
5042 have to have specified allowed values for a property.
5044 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5045 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5046 Same as @kbd{S-@key{left}/@key{right}}
5047 @orgcmd{e,org-columns-edit-value}
5048 Edit the property at point. For the special properties, this will
5049 invoke the same interface that you normally use to change that
5050 property. For example, when editing a TAGS property, the tag completion
5051 or fast selection interface will pop up.
5052 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5053 When there is a checkbox at point, toggle it.
5054 @orgcmd{v,org-columns-show-value}
5055 View the full value of this property. This is useful if the width of
5056 the column is smaller than that of the value.
5057 @orgcmd{a,org-columns-edit-allowed}
5058 Edit the list of allowed values for this property. If the list is found
5059 in the hierarchy, the modified values is stored there. If no list is
5060 found, the new value is stored in the first entry that is part of the
5061 current column view.
5062 @tsubheading{Modifying the table structure}
5063 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5064 Make the column narrower/wider by one character.
5065 @orgcmd{S-M-@key{right},org-columns-new}
5066 Insert a new column, to the left of the current column.
5067 @orgcmd{S-M-@key{left},org-columns-delete}
5068 Delete the current column.
5071 @node Capturing column view, , Using column view, Column view
5072 @subsection Capturing column view
5074 Since column view is just an overlay over a buffer, it cannot be
5075 exported or printed directly. If you want to capture a column view, use
5076 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5077 of this block looks like this:
5079 @cindex #+BEGIN, columnview
5082 #+BEGIN: columnview :hlines 1 :id "label"
5087 @noindent This dynamic block has the following parameters:
5091 This is the most important parameter. Column view is a feature that is
5092 often localized to a certain (sub)tree, and the capture block might be
5093 at a different location in the file. To identify the tree whose view to
5094 capture, you can use 4 values:
5095 @cindex property, ID
5097 local @r{use the tree in which the capture block is located}
5098 global @r{make a global view, including all headings in the file}
5099 "file:@var{path-to-file}"
5100 @r{run column view at the top of this file}
5101 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5102 @r{property with the value @i{label}. You can use}
5103 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5104 @r{the current entry and copy it to the kill-ring.}
5107 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5108 an hline before each headline with level @code{<= @var{N}}.
5110 When set to @code{t}, force column groups to get vertical lines.
5112 When set to a number, don't capture entries below this level.
5113 @item :skip-empty-rows
5114 When set to @code{t}, skip rows where the only non-empty specifier of the
5115 column view is @code{ITEM}.
5120 The following commands insert or update the dynamic block:
5123 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5124 Insert a dynamic block capturing a column view. You will be prompted
5125 for the scope or ID of the view.
5126 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5127 Update dynamic block at point. The cursor needs to be in the
5128 @code{#+BEGIN} line of the dynamic block.
5129 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5130 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5131 you have several clock table blocks, column-capturing blocks or other dynamic
5135 You can add formulas to the column view table and you may add plotting
5136 instructions in front of the table---these will survive an update of the
5137 block. If there is a @code{#+TBLFM:} after the table, the table will
5138 actually be recalculated automatically after an update.
5140 An alternative way to capture and process property values into a table is
5141 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5142 package@footnote{Contributed packages are not part of Emacs, but are
5143 distributed with the main distribution of Org (visit
5144 @uref{http://orgmode.org}).}. It provides a general API to collect
5145 properties from entries in a certain scope, and arbitrary Lisp expressions to
5146 process these values before inserting them into a table or a dynamic block.
5148 @node Property API, , Column view, Properties and Columns
5149 @section The Property API
5150 @cindex properties, API
5151 @cindex API, for properties
5153 There is a full API for accessing and changing properties. This API can
5154 be used by Emacs Lisp programs to work with properties and to implement
5155 features based on them. For more information see @ref{Using the
5158 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5159 @chapter Dates and times
5165 To assist project planning, TODO items can be labeled with a date and/or
5166 a time. The specially formatted string carrying the date and time
5167 information is called a @emph{timestamp} in Org-mode. This may be a
5168 little confusing because timestamp is often used as indicating when
5169 something was created or last changed. However, in Org-mode this term
5170 is used in a much wider sense.
5173 * Timestamps:: Assigning a time to a tree entry
5174 * Creating timestamps:: Commands which insert timestamps
5175 * Deadlines and scheduling:: Planning your work
5176 * Clocking work time:: Tracking how long you spend on a task
5177 * Effort estimates:: Planning work effort in advance
5178 * Relative timer:: Notes with a running timer
5179 * Countdown timer:: Starting a countdown timer for a task
5183 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5184 @section Timestamps, deadlines, and scheduling
5186 @cindex ranges, time
5191 A timestamp is a specification of a date (possibly with a time or a range of
5192 times) in a special format, either @samp{<2003-09-16 Tue>} or
5193 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
5194 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601 date/time
5195 format. To use an alternative format, see @ref{Custom time format}.}. A
5196 timestamp can appear anywhere in the headline or body of an Org tree entry.
5197 Its presence causes entries to be shown on specific dates in the agenda
5198 (@pxref{Weekly/daily agenda}). We distinguish:
5201 @item Plain timestamp; Event; Appointment
5203 A simple timestamp just assigns a date/time to an item. This is just
5204 like writing down an appointment or event in a paper agenda. In the
5205 timeline and agenda displays, the headline of an entry associated with a
5206 plain timestamp will be shown exactly on that date.
5209 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5210 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5213 @item Timestamp with repeater interval
5214 @cindex timestamp, with repeater interval
5215 A timestamp may contain a @emph{repeater interval}, indicating that it
5216 applies not only on the given date, but again and again after a certain
5217 interval of N days (d), weeks (w), months (m), or years (y). The
5218 following will show up in the agenda every Wednesday:
5221 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5224 @item Diary-style sexp entries
5225 For more complex date specifications, Org-mode supports using the
5226 special sexp diary entries implemented in the Emacs calendar/diary
5227 package. For example
5230 * The nerd meeting on every 2nd Thursday of the month
5231 <%%(diary-float t 4 2)>
5234 @item Time/Date range
5237 Two timestamps connected by @samp{--} denote a range. The headline
5238 will be shown on the first and last day of the range, and on any dates
5239 that are displayed and fall in the range. Here is an example:
5242 ** Meeting in Amsterdam
5243 <2004-08-23 Mon>--<2004-08-26 Thu>
5246 @item Inactive timestamp
5247 @cindex timestamp, inactive
5248 @cindex inactive timestamp
5249 Just like a plain timestamp, but with square brackets instead of
5250 angular ones. These timestamps are inactive in the sense that they do
5251 @emph{not} trigger an entry to show up in the agenda.
5254 * Gillian comes late for the fifth time [2006-11-01 Wed]
5259 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5260 @section Creating timestamps
5261 @cindex creating timestamps
5262 @cindex timestamps, creating
5264 For Org-mode to recognize timestamps, they need to be in the specific
5265 format. All commands listed below produce timestamps in the correct
5269 @orgcmd{C-c .,org-time-stamp}
5270 Prompt for a date and insert a corresponding timestamp. When the cursor is
5271 at an existing timestamp in the buffer, the command is used to modify this
5272 timestamp instead of inserting a new one. When this command is used twice in
5273 succession, a time range is inserted.
5275 @orgcmd{C-c !,org-time-stamp-inactive}
5276 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5283 @vindex org-time-stamp-rounding-minutes
5284 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5285 contains date and time. The default time can be rounded to multiples of 5
5286 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5288 @orgcmd{C-c <,org-date-from-calendar}
5289 Insert a timestamp corresponding to the cursor date in the Calendar.
5291 @orgcmd{C-c >,org-goto-calendar}
5292 Access the Emacs calendar for the current date. If there is a
5293 timestamp in the current line, go to the corresponding date
5296 @orgcmd{C-c C-o,org-open-at-point}
5297 Access the agenda for the date given by the timestamp or -range at
5298 point (@pxref{Weekly/daily agenda}).
5300 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5301 Change date at cursor by one day. These key bindings conflict with
5302 shift-selection and related modes (@pxref{Conflicts}).
5304 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5305 Change the item under the cursor in a timestamp. The cursor can be on a
5306 year, month, day, hour or minute. When the timestamp contains a time range
5307 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5308 shifting the time block with constant length. To change the length, modify
5309 the second time. Note that if the cursor is in a headline and not at a
5310 timestamp, these same keys modify the priority of an item.
5311 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5312 related modes (@pxref{Conflicts}).
5314 @orgcmd{C-c C-y,org-evaluate-time-range}
5315 @cindex evaluate time range
5316 Evaluate a time range by computing the difference between start and end.
5317 With a prefix argument, insert result after the time range (in a table: into
5318 the following column).
5323 * The date/time prompt:: How Org-mode helps you entering date and time
5324 * Custom time format:: Making dates look different
5327 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5328 @subsection The date/time prompt
5329 @cindex date, reading in minibuffer
5330 @cindex time, reading in minibuffer
5332 @vindex org-read-date-prefer-future
5333 When Org-mode prompts for a date/time, the default is shown in default
5334 date/time format, and the prompt therefore seems to ask for a specific
5335 format. But it will in fact accept any string containing some date and/or
5336 time information, and it is really smart about interpreting your input. You
5337 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5338 copied from an email message. Org-mode will find whatever information is in
5339 there and derive anything you have not specified from the @emph{default date
5340 and time}. The default is usually the current date and time, but when
5341 modifying an existing timestamp, or when entering the second stamp of a
5342 range, it is taken from the stamp in the buffer. When filling in
5343 information, Org-mode assumes that most of the time you will want to enter a
5344 date in the future: if you omit the month/year and the given day/month is
5345 @i{before} today, it will assume that you mean a future date@footnote{See the
5346 variable @code{org-read-date-prefer-future}. You may set that variable to
5347 the symbol @code{time} to even make a time before now shift the date to
5348 tomorrow.}. If the date has been automatically shifted into the future, the
5349 time prompt will show this with @samp{(=>F).}
5351 For example, let's assume that today is @b{June 13, 2006}. Here is how
5352 various inputs will be interpreted, the items filled in by Org-mode are
5356 3-2-5 @result{} 2003-02-05
5357 2/5/3 @result{} 2003-02-05
5358 14 @result{} @b{2006}-@b{06}-14
5359 12 @result{} @b{2006}-@b{07}-12
5360 2/5 @result{} @b{2007}-02-05
5361 Fri @result{} nearest Friday (default date or later)
5362 sep 15 @result{} @b{2006}-09-15
5363 feb 15 @result{} @b{2007}-02-15
5364 sep 12 9 @result{} 2009-09-12
5365 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5366 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5367 w4 @result{} ISO week for of the current year @b{2006}
5368 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5369 2012-w04-5 @result{} Same as above
5372 Furthermore you can specify a relative date by giving, as the
5373 @emph{first} thing in the input: a plus/minus sign, a number and a
5374 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5375 single plus or minus, the date is always relative to today. With a
5376 double plus or minus, it is relative to the default date. If instead of
5377 a single letter, you use the abbreviation of day name, the date will be
5378 the Nth such day. e.g.@:
5383 +4d @result{} four days from today
5384 +4 @result{} same as above
5385 +2w @result{} two weeks from today
5386 ++5 @result{} five days from default date
5387 +2tue @result{} second Tuesday from now.
5390 @vindex parse-time-months
5391 @vindex parse-time-weekdays
5392 The function understands English month and weekday abbreviations. If
5393 you want to use unabbreviated names and/or other languages, configure
5394 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5396 @vindex org-read-date-force-compatible-dates
5397 Not all dates can be represented in a given Emacs implementation. By default
5398 Org mode forces dates into the compatibility range 1970--2037 which works on
5399 all Emacs implementations. If you want to use dates outside of this range,
5400 read the docstring of the variable
5401 @code{org-read-date-force-compatible-dates}.
5403 You can specify a time range by giving start and end times or by giving a
5404 start time and a duration (in HH:MM format). Use `-' or `-@{@}-' as the
5405 separator in the former case and use '+' as the separator in the latter
5409 11am-1:15pm @result{} 11:00-13:15
5410 11am--1:15pm @result{} same as above
5411 11am+2:15 @result{} same as above
5414 @cindex calendar, for selecting date
5415 @vindex org-popup-calendar-for-date-prompt
5416 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5417 you don't need/want the calendar, configure the variable
5418 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5419 prompt, either by clicking on a date in the calendar, or by pressing
5420 @key{RET}, the date selected in the calendar will be combined with the
5421 information entered at the prompt. You can control the calendar fully
5422 from the minibuffer:
5429 @kindex S-@key{right}
5430 @kindex S-@key{left}
5431 @kindex S-@key{down}
5433 @kindex M-S-@key{right}
5434 @kindex M-S-@key{left}
5437 @key{RET} @r{Choose date at cursor in calendar.}
5438 mouse-1 @r{Select date by clicking on it.}
5439 S-@key{right}/@key{left} @r{One day forward/backward.}
5440 S-@key{down}/@key{up} @r{One week forward/backward.}
5441 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5442 > / < @r{Scroll calendar forward/backward by one month.}
5443 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5446 @vindex org-read-date-display-live
5447 The actions of the date/time prompt may seem complex, but I assure you they
5448 will grow on you, and you will start getting annoyed by pretty much any other
5449 way of entering a date/time out there. To help you understand what is going
5450 on, the current interpretation of your input will be displayed live in the
5451 minibuffer@footnote{If you find this distracting, turn the display of with
5452 @code{org-read-date-display-live}.}.
5454 @node Custom time format, , The date/time prompt, Creating timestamps
5455 @subsection Custom time format
5456 @cindex custom date/time format
5457 @cindex time format, custom
5458 @cindex date format, custom
5460 @vindex org-display-custom-times
5461 @vindex org-time-stamp-custom-formats
5462 Org-mode uses the standard ISO notation for dates and times as it is
5463 defined in ISO 8601. If you cannot get used to this and require another
5464 representation of date and time to keep you happy, you can get it by
5465 customizing the variables @code{org-display-custom-times} and
5466 @code{org-time-stamp-custom-formats}.
5469 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5470 Toggle the display of custom formats for dates and times.
5474 Org-mode needs the default format for scanning, so the custom date/time
5475 format does not @emph{replace} the default format---instead it is put
5476 @emph{over} the default format using text properties. This has the
5477 following consequences:
5480 You cannot place the cursor onto a timestamp anymore, only before or
5483 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5484 each component of a timestamp. If the cursor is at the beginning of
5485 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5486 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5487 time will be changed by one minute.
5489 If the timestamp contains a range of clock times or a repeater, these
5490 will not be overlaid, but remain in the buffer as they were.
5492 When you delete a timestamp character-by-character, it will only
5493 disappear from the buffer after @emph{all} (invisible) characters
5494 belonging to the ISO timestamp have been removed.
5496 If the custom timestamp format is longer than the default and you are
5497 using dates in tables, table alignment will be messed up. If the custom
5498 format is shorter, things do work as expected.
5502 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5503 @section Deadlines and scheduling
5505 A timestamp may be preceded by special keywords to facilitate planning:
5509 @cindex DEADLINE keyword
5511 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5512 to be finished on that date.
5514 @vindex org-deadline-warning-days
5515 On the deadline date, the task will be listed in the agenda. In
5516 addition, the agenda for @emph{today} will carry a warning about the
5517 approaching or missed deadline, starting
5518 @code{org-deadline-warning-days} before the due date, and continuing
5519 until the entry is marked DONE. An example:
5522 *** TODO write article about the Earth for the Guide
5523 The editor in charge is [[bbdb:Ford Prefect]]
5524 DEADLINE: <2004-02-29 Sun>
5527 You can specify a different lead time for warnings for a specific
5528 deadlines using the following syntax. Here is an example with a warning
5529 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5532 @cindex SCHEDULED keyword
5534 Meaning: you are planning to start working on that task on the given
5537 @vindex org-agenda-skip-scheduled-if-done
5538 The headline will be listed under the given date@footnote{It will still
5539 be listed on that date after it has been marked DONE. If you don't like
5540 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5541 addition, a reminder that the scheduled date has passed will be present
5542 in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
5543 the task will automatically be forwarded until completed.
5546 *** TODO Call Trillian for a date on New Years Eve.
5547 SCHEDULED: <2004-12-25 Sat>
5551 @b{Important:} Scheduling an item in Org-mode should @i{not} be
5552 understood in the same way that we understand @i{scheduling a meeting}.
5553 Setting a date for a meeting is just a simple appointment, you should
5554 mark this entry with a simple plain timestamp, to get this item shown
5555 on the date where it applies. This is a frequent misunderstanding by
5556 Org users. In Org-mode, @i{scheduling} means setting a date when you
5557 want to start working on an action item.
5560 You may use timestamps with repeaters in scheduling and deadline
5561 entries. Org-mode will issue early and late warnings based on the
5562 assumption that the timestamp represents the @i{nearest instance} of
5563 the repeater. However, the use of diary sexp entries like
5565 @code{<%%(diary-float t 42)>}
5567 in scheduling and deadline timestamps is limited. Org-mode does not
5568 know enough about the internals of each sexp function to issue early and
5569 late warnings. However, it will show the item on each day where the
5573 * Inserting deadline/schedule:: Planning items
5574 * Repeated tasks:: Items that show up again and again
5577 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5578 @subsection Inserting deadlines or schedules
5580 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
5581 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
5582 any text between this line and the headline.} a deadline or to schedule
5587 @orgcmd{C-c C-d,org-deadline}
5588 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5589 in the line directly following the headline. When called with a prefix arg,
5590 an existing deadline will be removed from the entry. Depending on the
5591 variable @code{org-log-redeadline}@footnote{with corresponding
5592 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5593 and @code{nologredeadline}}, a note will be taken when changing an existing
5595 @c FIXME Any CLOSED timestamp will be removed.????????
5597 @orgcmd{C-c C-s,org-schedule}
5598 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5599 happen in the line directly following the headline. Any CLOSED timestamp
5600 will be removed. When called with a prefix argument, remove the scheduling
5601 date from the entry. Depending on the variable
5602 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5603 keywords @code{logreschedule}, @code{lognotereschedule}, and
5604 @code{nologreschedule}}, a note will be taken when changing an existing
5607 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5610 Mark the current entry for agenda action. After you have marked the entry
5611 like this, you can open the agenda or the calendar to find an appropriate
5612 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5613 schedule the marked item.
5615 @orgcmd{C-c / d,org-check-deadlines}
5616 @cindex sparse tree, for deadlines
5617 @vindex org-deadline-warning-days
5618 Create a sparse tree with all deadlines that are either past-due, or
5619 which will become due within @code{org-deadline-warning-days}.
5620 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5621 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5622 all deadlines due tomorrow.
5624 @orgcmd{C-c / b,org-check-before-date}
5625 Sparse tree for deadlines and scheduled items before a given date.
5627 @orgcmd{C-c / a,org-check-after-date}
5628 Sparse tree for deadlines and scheduled items after a given date.
5631 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5632 @subsection Repeated tasks
5633 @cindex tasks, repeated
5634 @cindex repeated tasks
5636 Some tasks need to be repeated again and again. Org-mode helps to
5637 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5638 or plain timestamp. In the following example
5640 ** TODO Pay the rent
5641 DEADLINE: <2005-10-01 Sat +1m>
5644 the @code{+1m} is a repeater; the intended interpretation is that the task
5645 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5646 from that time. If you need both a repeater and a special warning period in
5647 a deadline entry, the repeater should come first and the warning period last:
5648 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5650 @vindex org-todo-repeat-to-state
5651 Deadlines and scheduled items produce entries in the agenda when they are
5652 over-due, so it is important to be able to mark such an entry as completed
5653 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5654 keyword DONE, it will no longer produce entries in the agenda. The problem
5655 with this is, however, that then also the @emph{next} instance of the
5656 repeated entry will not be active. Org-mode deals with this in the following
5657 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5658 shift the base date of the repeating timestamp by the repeater interval, and
5659 immediately set the entry state back to TODO@footnote{In fact, the target
5660 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5661 the variable @code{org-todo-repeat-to-state}. If neither of these is
5662 specified, the target state defaults to the first state of the TODO state
5663 sequence.}. In the example above, setting the state to DONE would actually
5664 switch the date like this:
5667 ** TODO Pay the rent
5668 DEADLINE: <2005-11-01 Tue +1m>
5671 @vindex org-log-repeat
5672 A timestamp@footnote{You can change this using the option
5673 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5674 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5675 will also be prompted for a note.} will be added under the deadline, to keep
5676 a record that you actually acted on the previous instance of this deadline.
5678 As a consequence of shifting the base date, this entry will no longer be
5679 visible in the agenda when checking past dates, but all future instances
5682 With the @samp{+1m} cookie, the date shift will always be exactly one
5683 month. So if you have not paid the rent for three months, marking this
5684 entry DONE will still keep it as an overdue deadline. Depending on the
5685 task, this may not be the best way to handle it. For example, if you
5686 forgot to call your father for 3 weeks, it does not make sense to call
5687 him 3 times in a single day to make up for it. Finally, there are tasks
5688 like changing batteries which should always repeat a certain time
5689 @i{after} the last time you did it. For these tasks, Org-mode has
5690 special repeaters @samp{++} and @samp{.+}. For example:
5694 DEADLINE: <2008-02-10 Sun ++1w>
5695 Marking this DONE will shift the date by at least one week,
5696 but also by as many weeks as it takes to get this date into
5697 the future. However, it stays on a Sunday, even if you called
5698 and marked it done on Saturday.
5699 ** TODO Check the batteries in the smoke detectors
5700 DEADLINE: <2005-11-01 Tue .+1m>
5701 Marking this DONE will shift the date to one month after
5705 You may have both scheduling and deadline information for a specific
5706 task---just make sure that the repeater intervals on both are the same.
5708 An alternative to using a repeater is to create a number of copies of a task
5709 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5710 created for this purpose, it is described in @ref{Structure editing}.
5713 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5714 @section Clocking work time
5715 @cindex clocking time
5716 @cindex time clocking
5718 Org-mode allows you to clock the time you spend on specific tasks in a
5719 project. When you start working on an item, you can start the clock.
5720 When you stop working on that task, or when you mark the task done, the
5721 clock is stopped and the corresponding time interval is recorded. It
5722 also computes the total time spent on each subtree of a project. And it
5723 remembers a history or tasks recently clocked, to that you can jump quickly
5724 between a number of tasks absorbing your time.
5726 To save the clock history across Emacs sessions, use
5728 (setq org-clock-persist 'history)
5729 (org-clock-persistence-insinuate)
5731 When you clock into a new task after resuming Emacs, the incomplete
5732 clock@footnote{To resume the clock under the assumption that you have worked
5733 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5734 will be found (@pxref{Resolving idle time}) and you will be prompted about
5738 * Clocking commands:: Starting and stopping a clock
5739 * The clock table:: Detailed reports
5740 * Resolving idle time:: Resolving time when you've been idle
5743 @node Clocking commands, The clock table, Clocking work time, Clocking work time
5744 @subsection Clocking commands
5747 @orgcmd{C-c C-x C-i,org-clock-in}
5748 @vindex org-clock-into-drawer
5749 Start the clock on the current item (clock-in). This inserts the CLOCK
5750 keyword together with a timestamp. If this is not the first clocking of
5751 this item, the multiple CLOCK lines will be wrapped into a
5752 @code{:LOGBOOK:} drawer (see also the variable
5753 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5754 select the task from a list of recently clocked tasks. With two @kbd{C-u
5755 C-u} prefixes, clock into the task at point and mark it as the default task.
5756 The default task will always be available when selecting a clocking task,
5757 with letter @kbd{d}.@*
5758 @cindex property: CLOCK_MODELINE_TOTAL
5759 @cindex property: LAST_REPEAT
5760 @vindex org-clock-modeline-total
5761 While the clock is running, the current clocking time is shown in the mode
5762 line, along with the title of the task. The clock time shown will be all
5763 time ever clocked for this task and its children. If the task has an effort
5764 estimate (@pxref{Effort estimates}), the mode line displays the current
5765 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5766 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5767 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5768 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5769 will be shown. More control over what time is shown can be exercised with
5770 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5771 @code{current} to show only the current clocking instance, @code{today} to
5772 show all time clocked on this tasks today (see also the variable
5773 @code{org-extend-today-until}), @code{all} to include all time, or
5774 @code{auto} which is the default@footnote{See also the variable
5775 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5776 mode line entry will pop up a menu with clocking options.
5778 @orgcmd{C-c C-x C-o,org-clock-out}
5779 @vindex org-log-note-clock-out
5780 Stop the clock (clock-out). This inserts another timestamp at the same
5781 location where the clock was last started. It also directly computes
5782 the resulting time in inserts it after the time range as @samp{=>
5783 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5784 possibility to record an additional note together with the clock-out
5785 timestamp@footnote{The corresponding in-buffer setting is:
5786 @code{#+STARTUP: lognoteclock-out}}.
5787 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5788 Update the effort estimate for the current clock task.
5791 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
5792 Recompute the time interval after changing one of the timestamps. This
5793 is only necessary if you edit the timestamps directly. If you change
5794 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5795 @orgcmd{C-c C-t,org-todo}
5796 Changing the TODO state of an item to DONE automatically stops the clock
5797 if it is running in this same item.
5798 @orgcmd{C-c C-x C-x,org-clock-cancel}
5799 Cancel the current clock. This is useful if a clock was started by
5800 mistake, or if you ended up working on something else.
5801 @orgcmd{C-c C-x C-j,org-clock-goto}
5802 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
5803 prefix arg, select the target task from a list of recently clocked tasks.
5804 @orgcmd{C-c C-x C-d,org-clock-display}
5805 @vindex org-remove-highlights-with-change
5806 Display time summaries for each subtree in the current buffer. This
5807 puts overlays at the end of each headline, showing the total time
5808 recorded under that heading, including the time of any subheadings. You
5809 can use visibility cycling to study the tree, but the overlays disappear
5810 when you change the buffer (see variable
5811 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5814 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5815 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5816 worked on or closed during a day.
5818 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
5819 @subsection The clock table
5820 @cindex clocktable, dynamic block
5821 @cindex report, of clocked time
5823 Org mode can produce quite complex reports based on the time clocking
5824 information. Such a report is called a @emph{clock table}, because it is
5825 formatted as one or several Org tables.
5828 @orgcmd{C-c C-x C-r,org-clock-report}
5829 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5830 report as an Org-mode table into the current file. When the cursor is
5831 at an existing clock table, just update it. When called with a prefix
5832 argument, jump to the first clock report in the current document and
5834 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5835 Update dynamic block at point. The cursor needs to be in the
5836 @code{#+BEGIN} line of the dynamic block.
5837 @orgkey{C-u C-c C-x C-u}
5838 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5839 you have several clock table blocks in a buffer.
5840 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
5841 Shift the current @code{:block} interval and update the table. The cursor
5842 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5843 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5847 Here is an example of the frame for a clock table as it is inserted into the
5848 buffer with the @kbd{C-c C-x C-r} command:
5850 @cindex #+BEGIN, clocktable
5852 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5856 @vindex org-clocktable-defaults
5857 The @samp{BEGIN} line and specify a number of options to define the scope,
5858 structure, and formatting of the report. Defaults for all these options can
5859 be configured in the variable @code{org-clocktable-defaults}.
5861 @noindent First there are options that determine which clock entries are to
5864 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5865 @r{Clocks at deeper levels will be summed into the upper level.}
5866 :scope @r{The scope to consider. This can be any of the following:}
5867 nil @r{the current buffer or narrowed region}
5868 file @r{the full current buffer}
5869 subtree @r{the subtree where the clocktable is located}
5870 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
5871 tree @r{the surrounding level 1 tree}
5872 agenda @r{all agenda files}
5873 ("file"..) @r{scan these files}
5874 file-with-archives @r{current file and its archives}
5875 agenda-with-archives @r{all agenda files, including archives}
5876 :block @r{The time block to consider. This block is specified either}
5877 @r{absolute, or relative to the current time and may be any of}
5879 2007-12-31 @r{New year eve 2007}
5880 2007-12 @r{December 2007}
5881 2007-W50 @r{ISO-week 50 in 2007}
5882 2007-Q2 @r{2nd quarter in 2007}
5883 2007 @r{the year 2007}
5884 today, yesterday, today-@var{N} @r{a relative day}
5885 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
5886 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
5887 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
5888 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5889 :tstart @r{A time string specifying when to start considering times.}
5890 :tend @r{A time string specifying when to stop considering times.}
5891 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5892 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5893 :stepskip0 @r{Do not show steps that have zero time.}
5894 :fileskip0 @r{Do not show table sections from files which did not contribute.}
5895 :tags @r{A tags match to select entries that should contribute. See}
5896 @r{@ref{Matching tags and properties} for the match syntax.}
5899 Then there are options which determine the formatting of the table. There
5900 options are interpreted by the function @code{org-clocktable-write-default},
5901 but you can specify your own function using the @code{:formatter} parameter.
5903 :emphasize @r{When @code{t}, emphasize level one and level two items.}
5904 :lang @r{Language@footnote{Language terms can be set through the variable @code{org-clock-clocktable-language-setup}.} to use for descriptive cells like "Task".}
5905 :link @r{Link the item headlines in the table to their origins.}
5906 :narrow @r{An integer to limit the width of the headline column in}
5907 @r{the org table. If you write it like @samp{50!}, then the}
5908 @r{headline will also be shortened in export.}
5909 :indent @r{Indent each headline field according to its level.}
5910 :tcolumns @r{Number of columns to be used for times. If this is smaller}
5911 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
5912 :level @r{Should a level number column be included?}
5913 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
5914 @r{All are overwritten except if there is an explicit @code{:narrow}}
5915 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
5916 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
5917 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5918 @r{As a special case, @samp{:formula %} adds a column with % time.}
5919 @r{If you do not specify a formula here, any existing formula}
5920 @r{below the clock table will survive updates and be evaluated.}
5921 :formatter @r{A function to format clock data and insert it into the buffer.}
5923 To get a clock summary of the current level 1 tree, for the current
5924 day, you could write
5926 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5930 and to use a specific time range you could write@footnote{Note that all
5931 parameters must be specified in a single line---the line is broken here
5932 only to fit it into the manual.}
5934 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5935 :tend "<2006-08-10 Thu 12:00>"
5938 A summary of the current subtree with % times would be
5940 #+BEGIN: clocktable :scope subtree :link t :formula %
5943 A horizontally compact representation of everything clocked during last week
5946 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
5950 @node Resolving idle time, , The clock table, Clocking work time
5951 @subsection Resolving idle time
5952 @cindex resolve idle time
5954 @cindex idle, resolve, dangling
5955 If you clock in on a work item, and then walk away from your
5956 computer---perhaps to take a phone call---you often need to ``resolve'' the
5957 time you were away by either subtracting it from the current clock, or
5958 applying it to another one.
5960 @vindex org-clock-idle-time
5961 By customizing the variable @code{org-clock-idle-time} to some integer, such
5962 as 10 or 15, Emacs can alert you when you get back to your computer after
5963 being idle for that many minutes@footnote{On computers using Mac OS X,
5964 idleness is based on actual user idleness, not just Emacs' idle time. For
5965 X11, you can install a utility program @file{x11idle.c}, available in the
5966 UTILITIES directory of the Org git distribution, to get the same general
5967 treatment of idleness. On other systems, idle time refers to Emacs idle time
5968 only.}, and ask what you want to do with the idle time. There will be a
5969 question waiting for you when you get back, indicating how much idle time has
5970 passed (constantly updated with the current amount), as well as a set of
5971 choices to correct the discrepancy:
5975 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
5976 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
5977 effectively changing nothing, or enter a number to keep that many minutes.
5979 If you use the shift key and press @kbd{K}, it will keep however many minutes
5980 you request and then immediately clock out of that task. If you keep all of
5981 the minutes, this is the same as just clocking out of the current task.
5983 To keep none of the minutes, use @kbd{s} to subtract all the away time from
5984 the clock, and then check back in from the moment you returned.
5986 To keep none of the minutes and just clock out at the start of the away time,
5987 use the shift key and press @kbd{S}. Remember that using shift will always
5988 leave you clocked out, no matter which option you choose.
5990 To cancel the clock altogether, use @kbd{C}. Note that if instead of
5991 canceling you subtract the away time, and the resulting clock amount is less
5992 than a minute, the clock will still be canceled rather than clutter up the
5993 log with an empty entry.
5996 What if you subtracted those away minutes from the current clock, and now
5997 want to apply them to a new clock? Simply clock in to any task immediately
5998 after the subtraction. Org will notice that you have subtracted time ``on
5999 the books'', so to speak, and will ask if you want to apply those minutes to
6000 the next task you clock in on.
6002 There is one other instance when this clock resolution magic occurs. Say you
6003 were clocked in and hacking away, and suddenly your cat chased a mouse who
6004 scared a hamster that crashed into your UPS's power button! You suddenly
6005 lose all your buffers, but thanks to auto-save you still have your recent Org
6006 mode changes, including your last clock in.
6008 If you restart Emacs and clock into any task, Org will notice that you have a
6009 dangling clock which was never clocked out from your last session. Using
6010 that clock's starting time as the beginning of the unaccounted-for period,
6011 Org will ask how you want to resolve that time. The logic and behavior is
6012 identical to dealing with away time due to idleness; it's just happening due
6013 to a recovery event rather than a set amount of idle time.
6015 You can also check all the files visited by your Org agenda for dangling
6016 clocks at any time using @kbd{M-x org-resolve-clocks}.
6018 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6019 @section Effort estimates
6020 @cindex effort estimates
6022 @cindex property, Effort
6023 @vindex org-effort-property
6024 If you want to plan your work in a very detailed way, or if you need to
6025 produce offers with quotations of the estimated work effort, you may want to
6026 assign effort estimates to entries. If you are also clocking your work, you
6027 may later want to compare the planned effort with the actual working time, a
6028 great way to improve planning estimates. Effort estimates are stored in a
6029 special property @samp{Effort}@footnote{You may change the property being
6030 used with the variable @code{org-effort-property}.}. You can set the effort
6031 for an entry with the following commands:
6034 @orgcmd{C-c C-x e,org-set-effort}
6035 Set the effort estimate for the current entry. With a numeric prefix
6036 argument, set it to the Nth allowed value (see below). This command is also
6037 accessible from the agenda with the @kbd{e} key.
6038 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6039 Modify the effort estimate of the item currently being clocked.
6042 Clearly the best way to work with effort estimates is through column view
6043 (@pxref{Column view}). You should start by setting up discrete values for
6044 effort estimates, and a @code{COLUMNS} format that displays these values
6045 together with clock sums (if you want to clock your time). For a specific
6049 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
6050 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6054 @vindex org-global-properties
6055 @vindex org-columns-default-format
6056 or, even better, you can set up these values globally by customizing the
6057 variables @code{org-global-properties} and @code{org-columns-default-format}.
6058 In particular if you want to use this setup also in the agenda, a global
6059 setup may be advised.
6061 The way to assign estimates to individual items is then to switch to column
6062 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6063 value. The values you enter will immediately be summed up in the hierarchy.
6064 In the column next to it, any clocked time will be displayed.
6066 @vindex org-agenda-columns-add-appointments-to-effort-sum
6067 If you switch to column view in the daily/weekly agenda, the effort column
6068 will summarize the estimated work effort for each day@footnote{Please note
6069 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6070 column view}).}, and you can use this to find space in your schedule. To get
6071 an overview of the entire part of the day that is committed, you can set the
6072 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6073 appointments on a day that take place over a specified time interval will
6074 then also be added to the load estimate of the day.
6076 Effort estimates can be used in secondary agenda filtering that is triggered
6077 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6078 these estimates defined consistently, two or three key presses will narrow
6079 down the list to stuff that fits into an available time slot.
6081 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6082 @section Taking notes with a relative timer
6083 @cindex relative timer
6085 When taking notes during, for example, a meeting or a video viewing, it can
6086 be useful to have access to times relative to a starting time. Org provides
6087 such a relative timer and make it easy to create timed notes.
6090 @orgcmd{C-c C-x .,org-timer}
6091 Insert a relative time into the buffer. The first time you use this, the
6092 timer will be started. When called with a prefix argument, the timer is
6094 @orgcmd{C-c C-x -,org-timer-item}
6095 Insert a description list item with the current relative time. With a prefix
6096 argument, first reset the timer to 0.
6097 @orgcmd{M-@key{RET},org-insert-heading}
6098 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6100 @c for key sequences with a comma, command name macros fail :(
6103 Pause the timer, or continue it if it is already paused
6104 (@command{org-timer-pause-or-continue}).
6105 @c removed the sentence because it is redundant to the following item
6106 @kindex C-u C-c C-x ,
6108 Stop the timer. After this, you can only start a new timer, not continue the
6109 old one. This command also removes the timer from the mode line.
6110 @orgcmd{C-c C-x 0,org-timer-start}
6111 Reset the timer without inserting anything into the buffer. By default, the
6112 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6113 specific starting offset. The user is prompted for the offset, with a
6114 default taken from a timer string at point, if any, So this can be used to
6115 restart taking notes after a break in the process. When called with a double
6116 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6117 by a certain amount. This can be used to fix timer strings if the timer was
6118 not started at exactly the right moment.
6121 @node Countdown timer, , Relative timer, Dates and Times
6122 @section Countdown timer
6123 @cindex Countdown timer
6127 Calling @code{org-timer-set-timer} from an Org-mode buffer runs a countdown
6128 timer. Use @key{;} from agenda buffers, @key{C-c C-x ;} everwhere else.
6130 @code{org-timer-set-timer} prompts the user for a duration and displays a
6131 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6132 default countdown value. Giving a prefix numeric argument overrides this
6135 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6136 @chapter Capture - Refile - Archive
6139 An important part of any organization system is the ability to quickly
6140 capture new ideas and tasks, and to associate reference material with them.
6141 Org does this using a process called @i{capture}. It also can store files
6142 related to a task (@i{attachments}) in a special directory. Once in the
6143 system, tasks and projects need to be moved around. Moving completed project
6144 trees to an archive file keeps the system compact and fast.
6147 * Capture:: Capturing new stuff
6148 * Attachments:: Add files to tasks
6149 * RSS Feeds:: Getting input from RSS feeds
6150 * Protocols:: External (e.g.@: Browser) access to Emacs and Org
6151 * Refiling notes:: Moving a tree from one place to another
6152 * Archiving:: What to do with finished projects
6155 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6159 Org's method for capturing new items is heavily inspired by John Wiegley
6160 excellent remember package. Up to version 6.36 Org used a special setup
6161 for @file{remember.el}. @file{org-remember.el} is still part of Org-mode for
6162 backward compatibility with existing setups. You can find the documentation
6163 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6165 The new capturing setup described here is preferred and should be used by new
6166 users. To convert your @code{org-remember-templates}, run the command
6168 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6170 @noindent and then customize the new variable with @kbd{M-x
6171 customize-variable org-capture-templates}, check the result, and save the
6172 customization. You can then use both remember and capture until
6173 you are familiar with the new mechanism.
6175 Capture lets you quickly store notes with little interruption of your work
6176 flow. The basic process of capturing is very similar to remember, but Org
6177 does enhance it with templates and more.
6180 * Setting up capture:: Where notes will be stored
6181 * Using capture:: Commands to invoke and terminate capture
6182 * Capture templates:: Define the outline of different note types
6185 @node Setting up capture, Using capture, Capture, Capture
6186 @subsection Setting up capture
6188 The following customization sets a default target file for notes, and defines
6189 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6190 suggestion.} for capturing new material.
6192 @vindex org-default-notes-file
6194 (setq org-default-notes-file (concat org-directory "/notes.org"))
6195 (define-key global-map "\C-cc" 'org-capture)
6198 @node Using capture, Capture templates, Setting up capture, Capture
6199 @subsection Using capture
6202 @orgcmd{C-c c,org-capture}
6203 Call the command @code{org-capture}. Note that this keybinding is global and
6204 not active by default - you need to install it. If you have templates
6206 defined @pxref{Capture templates}, it will offer these templates for
6207 selection or use a new Org outline node as the default template. It will
6208 insert the template into the target file and switch to an indirect buffer
6209 narrowed to this new node. You may then insert the information you want.
6211 @orgcmd{C-c C-c,org-capture-finalize}
6212 Once you have finished entering information into the capture buffer, @kbd{C-c
6213 C-c} will return you to the window configuration before the capture process,
6214 so that you can resume your work without further distraction. When called
6215 with a prefix arg, finalize and then jump to the captured item.
6217 @orgcmd{C-c C-w,org-capture-refile}
6218 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6219 a different place. Please realize that this is a normal refiling command
6220 that will be executed---so the cursor position at the moment you run this
6221 command is important. If you have inserted a tree with a parent and
6222 children, first move the cursor back to the parent. Any prefix argument
6223 given to this command will be passed on to the @code{org-refile} command.
6225 @orgcmd{C-c C-k,org-capture-kill}
6226 Abort the capture process and return to the previous state.
6230 You can also call @code{org-capture} in a special way from the agenda, using
6231 the @kbd{k c} key combination. With this access, any timestamps inserted by
6232 the selected capture template will default to the cursor date in the agenda,
6233 rather than to the current date.
6235 To find the locations of the last stored capture, use @code{org-capture} with
6240 Visit the target location of a cpature template. You get to select the
6241 template in the usual way.
6242 @orgkey{C-u C-u C-c c}
6243 Visit the last stored capture item in its buffer.
6246 @node Capture templates, , Using capture, Capture
6247 @subsection Capture templates
6248 @cindex templates, for Capture
6250 You can use templates for different types of capture items, and
6251 for different target locations. The easiest way to create such templates is
6252 through the customize interface.
6256 Customize the variable @code{org-capture-templates}.
6259 Before we give the formal description of template definitions, let's look at
6260 an example. Say you would like to use one template to create general TODO
6261 entries, and you want to put these entries under the heading @samp{Tasks} in
6262 your file @file{~/org/gtd.org}. Also, a date tree in the file
6263 @file{journal.org} should capture journal entries. A possible configuration
6267 (setq org-capture-templates
6268 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6269 "* TODO %?\n %i\n %a")
6270 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6271 "* %?\nEntered on %U\n %i\n %a")))
6274 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6278 [[file:@var{link to where you initiated capture}]]
6282 During expansion of the template, @code{%a} has been replaced by a link to
6283 the location from where you called the capture command. This can be
6284 extremely useful for deriving tasks from emails, for example. You fill in
6285 the task definition, press @code{C-c C-c} and Org returns you to the same
6286 place where you started the capture process.
6288 To define special keys to capture to a particular template without going
6289 through the interactive template selection, you can create your key binding
6293 (define-key global-map "\C-cx"
6294 (lambda () (interactive) (org-capture nil "x")))
6298 * Template elements:: What is needed for a complete template entry
6299 * Template expansion:: Filling in information about time and context
6302 @node Template elements, Template expansion, Capture templates, Capture templates
6303 @subsubsection Template elements
6305 Now lets look at the elements of a template definition. Each entry in
6306 @code{org-capture-templates} is a list with the following items:
6310 The keys that will select the template, as a string, characters
6311 only, for example @code{"a"} for a template to be selected with a
6312 single key, or @code{"bt"} for selection with two keys. When using
6313 several keys, keys using the same prefix key must be sequential
6314 in the list and preceded by a 2-element entry explaining the
6315 prefix key, for example
6317 ("b" "Templates for marking stuff to buy")
6319 @noindent If you do not define a template for the @kbd{C} key, this key will
6320 be used to open the customize buffer for this complex variable.
6323 A short string describing the template, which will be shown during
6327 The type of entry, a symbol. Valid values are:
6330 An Org-mode node, with a headline. Will be filed as the child of the
6331 target entry or as a top-level entry. The target file should be an Org-mode
6334 A plain list item, placed in the first plain list at the target
6335 location. Again the target file should be an Org file.
6337 A checkbox item. This only differs from the plain list item by the
6340 a new line in the first table at the target location. Where exactly the
6341 line will be inserted depends on the properties @code{:prepend} and
6342 @code{:table-line-pos} (see below).
6344 Text to be inserted as it is.
6348 @vindex org-default-notes-file
6349 Specification of where the captured item should be placed. In Org-mode
6350 files, targets usually define a node. Entries will become children of this
6351 node. Other types will be added to the table or list in the body of this
6352 node. Most target specifications contain a file name. If that file name is
6353 the empty string, it defaults to @code{org-default-notes-file}. A file can
6354 also be given as a variable, function, or Emacs Lisp form.
6358 @item (file "path/to/file")
6359 Text will be placed at the beginning or end of that file.
6361 @item (id "id of existing org entry")
6362 Filing as child of this entry, or in the body of the entry.
6364 @item (file+headline "path/to/file" "node headline")
6365 Fast configuration if the target heading is unique in the file.
6367 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6368 For non-unique headings, the full path is safer.
6370 @item (file+regexp "path/to/file" "regexp to find location")
6371 Use a regular expression to position the cursor.
6373 @item (file+datetree "path/to/file")
6374 Will create a heading in a date tree for today's date.
6376 @item (file+datetree+prompt "path/to/file")
6377 Will create a heading in a date tree, but will prompt for the date.
6379 @item (file+function "path/to/file" function-finding-location)
6380 A function to find the right location in the file.
6383 File to the entry that is currently being clocked.
6385 @item (function function-finding-location)
6386 Most general way, write your own function to find both
6391 The template for creating the capture item. If you leave this empty, an
6392 appropriate default template will be used. Otherwise this is a string with
6393 escape codes, which will be replaced depending on time and context of the
6394 capture call. The string with escapes may be loaded from a template file,
6395 using the special syntax @code{(file "path/to/template")}. See below for
6399 The rest of the entry is a property list of additional options.
6400 Recognized properties are:
6403 Normally new captured information will be appended at
6404 the target location (last child, last table line, last list item...).
6405 Setting this property will change that.
6407 @item :immediate-finish
6408 When set, do not offer to edit the information, just
6409 file it away immediately. This makes sense if the template only needs
6410 information that can be added automatically.
6413 Set this to the number of lines to insert
6414 before and after the new item. Default 0, only common other value is 1.
6417 Start the clock in this item.
6420 Keep the clock running when filing the captured entry.
6423 If starting the capture interrupted a clock, restart that clock when finished
6424 with the capture. Note that @code{:clock-keep} has precedence over
6425 @code{:clock-resume}. When setting both to @code{t}, the current clock will
6426 run and the previous one will not be resumed.
6429 Do not narrow the target buffer, simply show the full buffer. Default is to
6430 narrow it so that you only see the new material.
6433 If the target file was not yet visited when capture was invoked, kill the
6434 buffer again after capture is completed.
6438 @node Template expansion, , Template elements, Capture templates
6439 @subsubsection Template expansion
6441 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6442 these sequences literally, escape the @kbd{%} with a backslash.} allow
6443 dynamic insertion of content:
6445 @comment SJE: should these sentences terminate in period?
6447 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6448 @r{You may specify a default value and a completion table with}
6449 @r{%^@{prompt|default|completion2|completion3...@}}
6450 @r{The arrow keys access a prompt-specific history.}
6451 %a @r{annotation, normally the link created with @code{org-store-link}}
6452 %A @r{like @code{%a}, but prompt for the description part}
6453 %i @r{initial content, the region when capture is called while the}
6454 @r{region is active.}
6455 @r{The entire text will be indented like @code{%i} itself.}
6456 %t @r{timestamp, date only}
6457 %T @r{timestamp with date and time}
6458 %u, %U @r{like the above, but inactive timestamps}
6459 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
6460 @r{You may define a prompt like @code{%^@{Birthday@}t}}
6461 %<...> @r{the result of format-time-string on the ... format specification}
6462 %n @r{user name (taken from @code{user-full-name})}
6463 %c @r{Current kill ring head.}
6464 %x @r{Content of the X clipboard.}
6465 %^C @r{Interactive selection of which kill or clip to use.}
6466 %^L @r{Like @code{%^C}, but insert as link.}
6467 %k @r{title of the currently clocked task}
6468 %K @r{link to the currently clocked task}
6469 %f @r{file visited by current buffer when org-capture was called}
6470 %F @r{like @code{%f}, but include full path}
6471 %^g @r{prompt for tags, with completion on tags in target file.}
6472 %^G @r{prompt for tags, with completion all tags in all agenda files.}
6473 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
6474 %:keyword @r{specific information for certain link types, see below}
6475 %[@var{file}] @r{insert the contents of the file given by @var{file}}
6476 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
6480 For specific link types, the following keywords will be
6481 defined@footnote{If you define your own link types (@pxref{Adding
6482 hyperlink types}), any property you store with
6483 @code{org-store-link-props} can be accessed in capture templates in a
6486 @vindex org-from-is-user-regexp
6488 Link type | Available keywords
6489 -------------------+----------------------------------------------
6490 bbdb | %:name %:company
6491 irc | %:server %:port %:nick
6492 vm, wl, mh, mew, rmail | %:type %:subject %:message-id
6493 | %:from %:fromname %:fromaddress
6494 | %:to %:toname %:toaddress
6495 | %:date @r{(message date header field)}
6496 | %:date-timestamp @r{(date as active timestamp)}
6497 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6498 | %: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}.}}
6499 gnus | %:group, @r{for messages also all email fields}
6501 info | %:file %:node
6506 To place the cursor after template expansion use:
6509 %? @r{After completing the template, position cursor here.}
6513 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6514 @section Attachments
6517 @vindex org-attach-directory
6518 It is often useful to associate reference material with an outline node/task.
6519 Small chunks of plain text can simply be stored in the subtree of a project.
6520 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6521 files that live elsewhere on your computer or in the cloud, like emails or
6522 source code files belonging to a project. Another method is @i{attachments},
6523 which are files located in a directory belonging to an outline node. Org
6524 uses directories named by the unique ID of each entry. These directories are
6525 located in the @file{data} directory which lives in the same directory where
6526 your Org file lives@footnote{If you move entries or Org files from one
6527 directory to another, you may want to configure @code{org-attach-directory}
6528 to contain an absolute path.}. If you initialize this directory with
6529 @code{git init}, Org will automatically commit changes when it sees them.
6530 The attachment system has been contributed to Org by John Wiegley.
6532 In cases where it seems better to do so, you can also attach a directory of your
6533 choice to an entry. You can also make children inherit the attachment
6534 directory from a parent, so that an entire subtree uses the same attached
6537 @noindent The following commands deal with attachments:
6541 @orgcmd{C-c C-a,org-attach}
6542 The dispatcher for commands related to the attachment system. After these
6543 keys, a list of commands is displayed and you must press an additional key
6544 to select a command:
6547 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6548 @vindex org-attach-method
6549 Select a file and move it into the task's attachment directory. The file
6550 will be copied, moved, or linked, depending on @code{org-attach-method}.
6551 Note that hard links are not supported on all systems.
6557 Attach a file using the copy/move/link method.
6558 Note that hard links are not supported on all systems.
6560 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6561 Create a new attachment as an Emacs buffer.
6563 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6564 Synchronize the current task with its attachment directory, in case you added
6565 attachments yourself.
6567 @orgcmdtkc{o,C-c C-a o,org-attach-open}
6568 @vindex org-file-apps
6569 Open current task's attachment. If there is more than one, prompt for a
6570 file name first. Opening will follow the rules set by @code{org-file-apps}.
6571 For more details, see the information on following hyperlinks
6572 (@pxref{Handling links}).
6574 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6575 Also open the attachment, but force opening the file in Emacs.
6577 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6578 Open the current task's attachment directory.
6580 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6581 Also open the directory, but force using @command{dired} in Emacs.
6583 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6584 Select and delete a single attachment.
6586 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6587 Delete all of a task's attachments. A safer way is to open the directory in
6588 @command{dired} and delete from there.
6590 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6591 @cindex property, ATTACH_DIR
6592 Set a specific directory as the entry's attachment directory. This works by
6593 putting the directory path into the @code{ATTACH_DIR} property.
6595 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6596 @cindex property, ATTACH_DIR_INHERIT
6597 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6598 same directory for attachments as the parent does.
6602 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6607 Org can add and change entries based on information found in RSS feeds and
6608 Atom feeds. You could use this to make a task out of each new podcast in a
6609 podcast feed. Or you could use a phone-based note-creating service on the
6610 web to import tasks into Org. To access feeds, configure the variable
6611 @code{org-feed-alist}. The docstring of this variable has detailed
6612 information. Here is just an example:
6615 (setq org-feed-alist
6617 "http://rss.slashdot.org/Slashdot/slashdot"
6618 "~/txt/org/feeds.org" "Slashdot Entries")))
6622 will configure that new items from the feed provided by
6623 @code{rss.slashdot.org} will result in new entries in the file
6624 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6625 the following command is used:
6628 @orgcmd{C-c C-x g,org-feed-update-all}
6630 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6632 @orgcmd{C-c C-x G,org-feed-goto-inbox}
6633 Prompt for a feed name and go to the inbox configured for this feed.
6636 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6637 it will store information about the status of items in the feed, to avoid
6638 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6639 list of drawers in that file:
6642 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6645 For more information, including how to read atom feeds, see
6646 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6648 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6649 @section Protocols for external access
6650 @cindex protocols, for external access
6653 You can set up Org for handling protocol calls from outside applications that
6654 are passed to Emacs through the @file{emacsserver}. For example, you can
6655 configure bookmarks in your web browser to send a link to the current page to
6656 Org and create a note from it using capture (@pxref{Capture}). Or you
6657 could create a bookmark that will tell Emacs to open the local source file of
6658 a remote website you are looking at with the browser. See
6659 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6660 documentation and setup instructions.
6662 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6663 @section Refiling notes
6664 @cindex refiling notes
6666 When reviewing the captured data, you may want to refile some of the entries
6667 into a different list, for example into a project. Cutting, finding the
6668 right location, and then pasting the note is cumbersome. To simplify this
6669 process, you can use the following special command:
6672 @orgcmd{C-c C-w,org-refile}
6673 @vindex org-reverse-note-order
6674 @vindex org-refile-targets
6675 @vindex org-refile-use-outline-path
6676 @vindex org-outline-path-complete-in-steps
6677 @vindex org-refile-allow-creating-parent-nodes
6678 @vindex org-log-refile
6679 @vindex org-refile-use-cache
6680 Refile the entry or region at point. This command offers possible locations
6681 for refiling the entry and lets you select one with completion. The item (or
6682 all items in the region) is filed below the target heading as a subitem.
6683 Depending on @code{org-reverse-note-order}, it will be either the first or
6685 By default, all level 1 headlines in the current buffer are considered to be
6686 targets, but you can have more complex definitions across a number of files.
6687 See the variable @code{org-refile-targets} for details. If you would like to
6688 select a location via a file-path-like completion along the outline path, see
6689 the variables @code{org-refile-use-outline-path} and
6690 @code{org-outline-path-complete-in-steps}. If you would like to be able to
6691 create new nodes as new parents for refiling on the fly, check the
6692 variable @code{org-refile-allow-creating-parent-nodes}.
6693 When the variable @code{org-log-refile}@footnote{with corresponding
6694 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6695 and @code{nologrefile}} is set, a timestamp or a note will be
6696 recorded when an entry has been refiled.
6697 @orgkey{C-u C-c C-w}
6698 Use the refile interface to jump to a heading.
6699 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
6700 Jump to the location where @code{org-refile} last moved a tree to.
6702 Refile as the child of the item currently being clocked.
6703 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6705 @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}
6707 Clear the target cache. Caching of refile targets can be turned on by
6708 setting @code{org-refile-use-cache}. To make the command see new possible
6709 targets, you have to clear the cache with this command.
6712 @node Archiving, , Refiling notes, Capture - Refile - Archive
6716 When a project represented by a (sub)tree is finished, you may want
6717 to move the tree out of the way and to stop it from contributing to the
6718 agenda. Archiving is important to keep your working files compact and global
6719 searches like the construction of agenda views fast.
6722 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
6723 @vindex org-archive-default-command
6724 Archive the current entry using the command specified in the variable
6725 @code{org-archive-default-command}.
6729 * Moving subtrees:: Moving a tree to an archive file
6730 * Internal archiving:: Switch off a tree but keep it in the file
6733 @node Moving subtrees, Internal archiving, Archiving, Archiving
6734 @subsection Moving a tree to the archive file
6735 @cindex external archiving
6737 The most common archiving action is to move a project tree to another file,
6741 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
6742 @vindex org-archive-location
6743 Archive the subtree starting at the cursor position to the location
6744 given by @code{org-archive-location}.
6745 @orgkey{C-u C-c C-x C-s}
6746 Check if any direct children of the current headline could be moved to
6747 the archive. To do this, each subtree is checked for open TODO entries.
6748 If none are found, the command offers to move it to the archive
6749 location. If the cursor is @emph{not} on a headline when this command
6750 is invoked, the level 1 trees will be checked.
6753 @cindex archive locations
6754 The default archive location is a file in the same directory as the
6755 current file, with the name derived by appending @file{_archive} to the
6756 current file name. For information and examples on how to change this,
6757 see the documentation string of the variable
6758 @code{org-archive-location}. There is also an in-buffer option for
6759 setting this variable, for example@footnote{For backward compatibility,
6760 the following also works: If there are several such lines in a file,
6761 each specifies the archive location for the text below it. The first
6762 such line also applies to any text before its definition. However,
6763 using this method is @emph{strongly} deprecated as it is incompatible
6764 with the outline structure of the document. The correct method for
6765 setting multiple archive locations in a buffer is using properties.}:
6769 #+ARCHIVE: %s_done::
6772 @cindex property, ARCHIVE
6774 If you would like to have a special ARCHIVE location for a single entry
6775 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6776 location as the value (@pxref{Properties and Columns}).
6778 @vindex org-archive-save-context-info
6779 When a subtree is moved, it receives a number of special properties that
6780 record context information like the file from where the entry came, its
6781 outline path the archiving time etc. Configure the variable
6782 @code{org-archive-save-context-info} to adjust the amount of information
6786 @node Internal archiving, , Moving subtrees, Archiving
6787 @subsection Internal archiving
6789 If you want to just switch off (for agenda views) certain subtrees without
6790 moving them to a different file, you can use the @code{ARCHIVE tag}.
6792 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6793 its location in the outline tree, but behaves in the following way:
6796 @vindex org-cycle-open-archived-trees
6797 It does not open when you attempt to do so with a visibility cycling
6798 command (@pxref{Visibility cycling}). You can force cycling archived
6799 subtrees with @kbd{C-@key{TAB}}, or by setting the option
6800 @code{org-cycle-open-archived-trees}. Also normal outline commands like
6801 @code{show-all} will open archived subtrees.
6803 @vindex org-sparse-tree-open-archived-trees
6804 During sparse tree construction (@pxref{Sparse trees}), matches in
6805 archived subtrees are not exposed, unless you configure the option
6806 @code{org-sparse-tree-open-archived-trees}.
6808 @vindex org-agenda-skip-archived-trees
6809 During agenda view construction (@pxref{Agenda Views}), the content of
6810 archived trees is ignored unless you configure the option
6811 @code{org-agenda-skip-archived-trees}, in which case these trees will always
6812 be included. In the agenda you can press @kbd{v a} to get archives
6813 temporarily included.
6815 @vindex org-export-with-archived-trees
6816 Archived trees are not exported (@pxref{Exporting}), only the headline
6817 is. Configure the details using the variable
6818 @code{org-export-with-archived-trees}.
6820 @vindex org-columns-skip-archived-trees
6821 Archived trees are excluded from column view unless the variable
6822 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
6825 The following commands help manage the ARCHIVE tag:
6828 @orgcmd{C-c C-x a,org-toggle-archive-tag}
6829 Toggle the ARCHIVE tag for the current headline. When the tag is set,
6830 the headline changes to a shadowed face, and the subtree below it is
6832 @orgkey{C-u C-c C-x a}
6833 Check if any direct children of the current headline should be archived.
6834 To do this, each subtree is checked for open TODO entries. If none are
6835 found, the command offers to set the ARCHIVE tag for the child. If the
6836 cursor is @emph{not} on a headline when this command is invoked, the
6837 level 1 trees will be checked.
6838 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
6839 Cycle a tree even if it is tagged with ARCHIVE.
6840 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
6841 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
6842 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
6843 entry becomes a child of that sibling and in this way retains a lot of its
6844 original context, including inherited tags and approximate position in the
6849 @node Agenda Views, Markup, Capture - Refile - Archive, Top
6850 @chapter Agenda views
6851 @cindex agenda views
6853 Due to the way Org works, TODO items, time-stamped items, and
6854 tagged headlines can be scattered throughout a file or even a number of
6855 files. To get an overview of open action items, or of events that are
6856 important for a particular date, this information must be collected,
6857 sorted and displayed in an organized way.
6859 Org can select items based on various criteria and display them
6860 in a separate buffer. Seven different view types are provided:
6864 an @emph{agenda} that is like a calendar and shows information
6867 a @emph{TODO list} that covers all unfinished
6870 a @emph{match view}, showings headlines based on the tags, properties, and
6871 TODO state associated with them,
6873 a @emph{timeline view} that shows all events in a single Org file,
6874 in time-sorted view,
6876 a @emph{text search view} that shows all entries from multiple files
6877 that contain specified keywords,
6879 a @emph{stuck projects view} showing projects that currently don't move
6882 @emph{custom views} that are special searches and combinations of different
6887 The extracted information is displayed in a special @emph{agenda
6888 buffer}. This buffer is read-only, but provides commands to visit the
6889 corresponding locations in the original Org files, and even to
6890 edit these files remotely.
6892 @vindex org-agenda-window-setup
6893 @vindex org-agenda-restore-windows-after-quit
6894 Two variables control how the agenda buffer is displayed and whether the
6895 window configuration is restored when the agenda exits:
6896 @code{org-agenda-window-setup} and
6897 @code{org-agenda-restore-windows-after-quit}.
6900 * Agenda files:: Files being searched for agenda information
6901 * Agenda dispatcher:: Keyboard access to agenda views
6902 * Built-in agenda views:: What is available out of the box?
6903 * Presentation and sorting:: How agenda items are prepared for display
6904 * Agenda commands:: Remote editing of Org trees
6905 * Custom agenda views:: Defining special searches and views
6906 * Exporting Agenda Views:: Writing a view to a file
6907 * Agenda column view:: Using column view for collected entries
6910 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
6911 @section Agenda files
6912 @cindex agenda files
6913 @cindex files for agenda
6915 @vindex org-agenda-files
6916 The information to be shown is normally collected from all @emph{agenda
6917 files}, the files listed in the variable
6918 @code{org-agenda-files}@footnote{If the value of that variable is not a
6919 list, but a single file name, then the list of agenda files will be
6920 maintained in that external file.}. If a directory is part of this list,
6921 all files with the extension @file{.org} in this directory will be part
6924 Thus, even if you only work with a single Org file, that file should
6925 be put into the list@footnote{When using the dispatcher, pressing
6926 @kbd{<} before selecting a command will actually limit the command to
6927 the current file, and ignore @code{org-agenda-files} until the next
6928 dispatcher command.}. You can customize @code{org-agenda-files}, but
6929 the easiest way to maintain it is through the following commands
6931 @cindex files, adding to agenda list
6933 @orgcmd{C-c [,org-agenda-file-to-front}
6934 Add current file to the list of agenda files. The file is added to
6935 the front of the list. If it was already in the list, it is moved to
6936 the front. With a prefix argument, file is added/moved to the end.
6937 @orgcmd{C-c ],org-remove-file}
6938 Remove current file from the list of agenda files.
6940 @orgcmd{C-',org-cycle-agenda-files}
6942 Cycle through agenda file list, visiting one file after the other.
6943 @kindex M-x org-iswitchb
6944 @item M-x org-iswitchb
6945 Command to use an @code{iswitchb}-like interface to switch to and between Org
6950 The Org menu contains the current list of files and can be used
6951 to visit any of them.
6953 If you would like to focus the agenda temporarily on a file not in
6954 this list, or on just one file in the list, or even on only a subtree in a
6955 file, then this can be done in different ways. For a single agenda command,
6956 you may press @kbd{<} once or several times in the dispatcher
6957 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
6958 extended period, use the following commands:
6961 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
6962 Permanently restrict the agenda to the current subtree. When with a
6963 prefix argument, or with the cursor before the first headline in a file,
6964 the agenda scope is set to the entire file. This restriction remains in
6965 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
6966 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
6967 agenda view, the new restriction takes effect immediately.
6968 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
6969 Remove the permanent restriction created by @kbd{C-c C-x <}.
6973 When working with @file{speedbar.el}, you can use the following commands in
6976 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
6977 Permanently restrict the agenda to the item---either an Org file or a subtree
6978 in such a file---at the cursor in the Speedbar frame.
6979 If there is a window displaying an agenda view, the new restriction takes
6981 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
6982 Lift the restriction.
6985 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
6986 @section The agenda dispatcher
6987 @cindex agenda dispatcher
6988 @cindex dispatching agenda commands
6989 The views are created through a dispatcher, which should be bound to a
6990 global key---for example @kbd{C-c a} (@pxref{Installation}). In the
6991 following we will assume that @kbd{C-c a} is indeed how the dispatcher
6992 is accessed and list keyboard access to commands accordingly. After
6993 pressing @kbd{C-c a}, an additional letter is required to execute a
6994 command. The dispatcher offers the following default commands:
6997 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
6999 Create a list of all TODO items (@pxref{Global TODO list}).
7001 Create a list of headlines matching a TAGS expression (@pxref{Matching
7002 tags and properties}).
7004 Create the timeline view for the current buffer (@pxref{Timeline}).
7006 Create a list of entries selected by a boolean expression of keywords
7007 and/or regular expressions that must or must not occur in the entry.
7009 @vindex org-agenda-text-search-extra-files
7010 Search for a regular expression in all agenda files and additionally in
7011 the files listed in @code{org-agenda-text-search-extra-files}. This
7012 uses the Emacs command @code{multi-occur}. A prefix argument can be
7013 used to specify the number of context lines for each match, default is
7016 Create a list of stuck projects (@pxref{Stuck projects}).
7018 Restrict an agenda command to the current buffer@footnote{For backward
7019 compatibility, you can also press @kbd{1} to restrict to the current
7020 buffer.}. After pressing @kbd{<}, you still need to press the character
7021 selecting the command.
7023 If there is an active region, restrict the following agenda command to
7024 the region. Otherwise, restrict it to the current subtree@footnote{For
7025 backward compatibility, you can also press @kbd{0} to restrict to the
7026 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7027 character selecting the command.
7030 You can also define custom commands that will be accessible through the
7031 dispatcher, just like the default commands. This includes the
7032 possibility to create extended agenda buffers that contain several
7033 blocks together, for example the weekly agenda, the global TODO list and
7034 a number of special tags matches. @xref{Custom agenda views}.
7036 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7037 @section The built-in agenda views
7039 In this section we describe the built-in views.
7042 * Weekly/daily agenda:: The calendar page with current tasks
7043 * Global TODO list:: All unfinished action items
7044 * Matching tags and properties:: Structured information with fine-tuned search
7045 * Timeline:: Time-sorted view for single file
7046 * Search view:: Find entries by searching for text
7047 * Stuck projects:: Find projects you need to review
7050 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7051 @subsection The weekly/daily agenda
7053 @cindex weekly agenda
7054 @cindex daily agenda
7056 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7057 paper agenda, showing all the tasks for the current week or day.
7060 @cindex org-agenda, command
7061 @orgcmd{C-c a a,org-agenda-list}
7062 Compile an agenda for the current week from a list of Org files. The agenda
7063 shows the entries for each day. With a numeric prefix@footnote{For backward
7064 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7065 listed before the agenda. This feature is deprecated, use the dedicated TODO
7066 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7067 C-c a a}) you may set the number of days to be displayed.
7070 @vindex org-agenda-span
7071 @vindex org-agenda-ndays
7072 The default number of days displayed in the agenda is set by the variable
7073 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7074 variable can be set to any number of days you want to see by default in the
7075 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7078 Remote editing from the agenda buffer means, for example, that you can
7079 change the dates of deadlines and appointments from the agenda buffer.
7080 The commands available in the Agenda buffer are listed in @ref{Agenda
7083 @subsubheading Calendar/Diary integration
7084 @cindex calendar integration
7085 @cindex diary integration
7087 Emacs contains the calendar and diary by Edward M. Reingold. The
7088 calendar displays a three-month calendar with holidays from different
7089 countries and cultures. The diary allows you to keep track of
7090 anniversaries, lunar phases, sunrise/set, recurrent appointments
7091 (weekly, monthly) and more. In this way, it is quite complementary to
7092 Org. It can be very useful to combine output from Org with
7095 In order to include entries from the Emacs diary into Org-mode's
7096 agenda, you only need to customize the variable
7099 (setq org-agenda-include-diary t)
7102 @noindent After that, everything will happen automatically. All diary
7103 entries including holidays, anniversaries, etc., will be included in the
7104 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
7105 @key{RET} can be used from the agenda buffer to jump to the diary
7106 file in order to edit existing diary entries. The @kbd{i} command to
7107 insert new entries for the current date works in the agenda buffer, as
7108 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7109 Sunrise/Sunset times, show lunar phases and to convert to other
7110 calendars, respectively. @kbd{c} can be used to switch back and forth
7111 between calendar and agenda.
7113 If you are using the diary only for sexp entries and holidays, it is
7114 faster to not use the above setting, but instead to copy or even move
7115 the entries into an Org file. Org-mode evaluates diary-style sexp
7116 entries, and does it faster because there is no overhead for first
7117 creating the diary display. Note that the sexp entries must start at
7118 the left margin, no whitespace is allowed before them. For example,
7119 the following segment of an Org file will be processed and entries
7120 will be made in the agenda:
7123 * Birthdays and similar stuff
7125 %%(org-calendar-holiday) ; special function for holiday names
7127 %%(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
7128 %%(diary-anniversary 10 2 1869) Mahatma Gandhi would be %d years old
7131 @subsubheading Anniversaries from BBDB
7132 @cindex BBDB, anniversaries
7133 @cindex anniversaries, from BBDB
7135 If you are using the Big Brothers Database to store your contacts, you will
7136 very likely prefer to store anniversaries in BBDB rather than in a
7137 separate Org or diary file. Org supports this and will show BBDB
7138 anniversaries as part of the agenda. All you need to do is to add the
7139 following to one your your agenda files:
7146 %%(org-bbdb-anniversaries)
7149 You can then go ahead and define anniversaries for a BBDB record. Basically,
7150 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7151 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7152 followed by a space and the class of the anniversary (@samp{birthday} or
7153 @samp{wedding}, or a format string). If you omit the class, it will default to
7154 @samp{birthday}. Here are a few examples, the header for the file
7155 @file{org-bbdb.el} contains more detailed information.
7161 2008-04-14 %s released version 6.01 of org-mode, %d years ago
7164 After a change to BBDB, or for the first agenda display during an Emacs
7165 session, the agenda display will suffer a short delay as Org updates its
7166 hash with anniversaries. However, from then on things will be very fast---much
7167 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7168 in an Org or Diary file.
7170 @subsubheading Appointment reminders
7171 @cindex @file{appt.el}
7172 @cindex appointment reminders
7174 Org can interact with Emacs appointments notification facility. To add all
7175 the appointments of your agenda files, use the command
7176 @code{org-agenda-to-appt}. This command also lets you filter through the
7177 list of your appointments and add only those belonging to a specific category
7178 or matching a regular expression. See the docstring for details.
7180 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7181 @subsection The global TODO list
7182 @cindex global TODO list
7183 @cindex TODO list, global
7185 The global TODO list contains all unfinished TODO items formatted and
7186 collected into a single place.
7189 @orgcmd{C-c a t,org-todo-list}
7190 Show the global TODO list. This collects the TODO items from all agenda
7191 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7192 items with a state the is not a DONE state. The buffer is in
7193 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7194 entries directly from that buffer (@pxref{Agenda commands}).
7195 @orgcmd{C-c a T,org-todo-list}
7196 @cindex TODO keyword matching
7197 @vindex org-todo-keywords
7198 Like the above, but allows selection of a specific TODO keyword. You can
7199 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7200 prompted for a keyword, and you may also specify several keywords by
7201 separating them with @samp{|} as the boolean OR operator. With a numeric
7202 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7204 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7205 a prefix argument to this command to change the selected TODO keyword,
7206 for example @kbd{3 r}. If you often need a search for a specific
7207 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7208 Matching specific TODO keywords can also be done as part of a tags
7209 search (@pxref{Tag searches}).
7212 Remote editing of TODO items means that you can change the state of a
7213 TODO entry with a single key press. The commands available in the
7214 TODO list are described in @ref{Agenda commands}.
7216 @cindex sublevels, inclusion into TODO list
7217 Normally the global TODO list simply shows all headlines with TODO
7218 keywords. This list can become very long. There are two ways to keep
7222 @vindex org-agenda-todo-ignore-scheduled
7223 @vindex org-agenda-todo-ignore-deadlines
7224 @vindex org-agenda-todo-ignore-timestamp
7225 @vindex org-agenda-todo-ignore-with-date
7226 Some people view a TODO item that has been @emph{scheduled} for execution or
7227 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7228 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7229 @code{org-agenda-todo-ignore-deadlines},
7230 @code{org-agenda-todo-ignore-timestamp} and/or
7231 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7234 @vindex org-agenda-todo-list-sublevels
7235 TODO items may have sublevels to break up the task into subtasks. In
7236 such cases it may be enough to list only the highest level TODO headline
7237 and omit the sublevels from the global list. Configure the variable
7238 @code{org-agenda-todo-list-sublevels} to get this behavior.
7241 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7242 @subsection Matching tags and properties
7243 @cindex matching, of tags
7244 @cindex matching, of properties
7248 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7249 or have properties (@pxref{Properties and Columns}), you can select headlines
7250 based on this metadata and collect them into an agenda buffer. The match
7251 syntax described here also applies when creating sparse trees with @kbd{C-c /
7255 @orgcmd{C-c a m,org-tags-view}
7256 Produce a list of all headlines that match a given set of tags. The
7257 command prompts for a selection criterion, which is a boolean logic
7258 expression with tags, like @samp{+work+urgent-withboss} or
7259 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7260 define a custom command for it (@pxref{Agenda dispatcher}).
7261 @orgcmd{C-c a M,org-tags-view}
7262 @vindex org-tags-match-list-sublevels
7263 @vindex org-agenda-tags-todo-honor-ignore-options
7264 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7265 not-DONE state and force checking subitems (see variable
7266 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7267 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7268 specific TODO keywords together with a tags match is also possible, see
7272 The commands available in the tags list are described in @ref{Agenda
7275 @subsubheading Match syntax
7277 @cindex Boolean logic, for tag/property searches
7278 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7279 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7280 not implemented. Each element in the search is either a tag, a regular
7281 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7282 VALUE} with a comparison operator, accessing a property value. Each element
7283 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7284 sugar for positive selection. The AND operator @samp{&} is optional when
7285 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7289 Select headlines tagged @samp{:work:}, but discard those also tagged
7292 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7293 @item work|laptop+night
7294 Like before, but require the @samp{:laptop:} lines to be tagged also
7298 @cindex regular expressions, with tags search
7299 Instead of a tag, you may also specify a regular expression enclosed in curly
7300 braces. For example,
7301 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7302 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7304 @cindex TODO keyword matching, with tags search
7305 @cindex level, require for tags/property match
7306 @cindex category, require for tags/property match
7307 @vindex org-odd-levels-only
7308 You may also test for properties (@pxref{Properties and Columns}) at the same
7309 time as matching tags. The properties may be real properties, or special
7310 properties that represent other metadata (@pxref{Special properties}). For
7311 example, the ``property'' @code{TODO} represents the TODO keyword of the
7312 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7313 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7314 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7315 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7316 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7318 Here are more examples:
7320 @item work+TODO="WAITING"
7321 Select @samp{:work:}-tagged TODO lines with the specific TODO
7322 keyword @samp{WAITING}.
7323 @item work+TODO="WAITING"|home+TODO="WAITING"
7324 Waiting tasks both at work and at home.
7327 When matching properties, a number of different operators can be used to test
7328 the value of a property. Here is a complex example:
7331 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7332 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7336 The type of comparison will depend on how the comparison value is written:
7339 If the comparison value is a plain number, a numerical comparison is done,
7340 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7341 @samp{>=}, and @samp{<>}.
7343 If the comparison value is enclosed in double-quotes,
7344 a string comparison is done, and the same operators are allowed.
7346 If the comparison value is enclosed in double-quotes @emph{and} angular
7347 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7348 assumed to be date/time specifications in the standard Org way, and the
7349 comparison will be done accordingly. Special values that will be recognized
7350 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7351 @code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
7352 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7353 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7354 respectively, can be used.
7356 If the comparison value is enclosed
7357 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7358 regexp matches the property value, and @samp{<>} meaning that it does not
7362 So the search string in the example finds entries tagged @samp{:work:} but
7363 not @samp{:boss:}, which also have a priority value @samp{A}, a
7364 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7365 property that is numerically smaller than 2, a @samp{:With:} property that is
7366 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7367 on or after October 11, 2008.
7369 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7370 other properties will slow down the search. However, once you have paid the
7371 price by accessing one property, testing additional properties is cheap
7374 You can configure Org-mode to use property inheritance during a search, but
7375 beware that this can slow down searches considerably. See @ref{Property
7376 inheritance}, for details.
7378 For backward compatibility, and also for typing speed, there is also a
7379 different way to test TODO states in a search. For this, terminate the
7380 tags/property part of the search string (which may include several terms
7381 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7382 expression just for TODO keywords. The syntax is then similar to that for
7383 tags, but should be applied with care: for example, a positive selection on
7384 several TODO keywords cannot meaningfully be combined with boolean AND.
7385 However, @emph{negative selection} combined with AND can be meaningful. To
7386 make sure that only lines are checked that actually have any TODO keyword
7387 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7388 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7389 not match TODO keywords in a DONE state. Examples:
7393 Same as @samp{work+TODO="WAITING"}
7394 @item work/!-WAITING-NEXT
7395 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7397 @item work/!+WAITING|+NEXT
7398 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7402 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7403 @subsection Timeline for a single file
7404 @cindex timeline, single file
7405 @cindex time-sorted view
7407 The timeline summarizes all time-stamped items from a single Org-mode
7408 file in a @emph{time-sorted view}. The main purpose of this command is
7409 to give an overview over events in a project.
7412 @orgcmd{C-c a L,org-timeline}
7413 Show a time-sorted view of the Org file, with all time-stamped items.
7414 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7415 (scheduled or not) are also listed under the current date.
7419 The commands available in the timeline buffer are listed in
7420 @ref{Agenda commands}.
7422 @node Search view, Stuck projects, Timeline, Built-in agenda views
7423 @subsection Search view
7426 @cindex searching, for text
7428 This agenda view is a general text search facility for Org-mode entries.
7429 It is particularly useful to find notes.
7432 @orgcmd{C-c a s,org-search-view}
7433 This is a special search that lets you select entries by matching a substring
7434 or specific words using a boolean logic.
7436 For example, the search string @samp{computer equipment} will find entries
7437 that contain @samp{computer equipment} as a substring. If the two words are
7438 separated by more space or a line break, the search will still match.
7439 Search view can also search for specific keywords in the entry, using Boolean
7440 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7441 will search for note entries that contain the keywords @code{computer}
7442 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7443 not matched by the regular expression @code{8\.11[bg]}, meaning to
7444 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7445 word search, other @samp{+} characters are optional. For more details, see
7446 the docstring of the command @code{org-search-view}.
7448 @vindex org-agenda-text-search-extra-files
7449 Note that in addition to the agenda files, this command will also search
7450 the files listed in @code{org-agenda-text-search-extra-files}.
7452 @node Stuck projects, , Search view, Built-in agenda views
7453 @subsection Stuck projects
7454 @pindex GTD, Getting Things Done
7456 If you are following a system like David Allen's GTD to organize your
7457 work, one of the ``duties'' you have is a regular review to make sure
7458 that all projects move along. A @emph{stuck} project is a project that
7459 has no defined next actions, so it will never show up in the TODO lists
7460 Org-mode produces. During the review, you need to identify such
7461 projects and define next actions for them.
7464 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7465 List projects that are stuck.
7468 @vindex org-stuck-projects
7469 Customize the variable @code{org-stuck-projects} to define what a stuck
7470 project is and how to find it.
7473 You almost certainly will have to configure this view before it will
7474 work for you. The built-in default assumes that all your projects are
7475 level-2 headlines, and that a project is not stuck if it has at least
7476 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7478 Let's assume that you, in your own way of using Org-mode, identify
7479 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7480 indicate a project that should not be considered yet. Let's further
7481 assume that the TODO keyword DONE marks finished projects, and that NEXT
7482 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7483 is a next action even without the NEXT tag. Finally, if the project
7484 contains the special word IGNORE anywhere, it should not be listed
7485 either. In this case you would start by identifying eligible projects
7486 with a tags/todo match@footnote{@xref{Tag searches}.}
7487 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7488 IGNORE in the subtree to identify projects that are not stuck. The
7489 correct customization for this is
7492 (setq org-stuck-projects
7493 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7497 Note that if a project is identified as non-stuck, the subtree of this entry
7498 will still be searched for stuck projects.
7500 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7501 @section Presentation and sorting
7502 @cindex presentation, of agenda items
7504 @vindex org-agenda-prefix-format
7505 @vindex org-agenda-tags-column
7506 Before displaying items in an agenda view, Org-mode visually prepares the
7507 items and sorts them. Each item occupies a single line. The line starts
7508 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
7509 of the item and other important information. You can customize in which
7510 column tags will be displayed through @code{org-agenda-tags-column}. You can
7511 also customize the prefix using the option @code{org-agenda-prefix-format}.
7512 This prefix is followed by a cleaned-up version of the outline headline
7513 associated with the item.
7516 * Categories:: Not all tasks are equal
7517 * Time-of-day specifications:: How the agenda knows the time
7518 * Sorting of agenda items:: The order of things
7521 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7522 @subsection Categories
7526 The category is a broad label assigned to each agenda item. By default,
7527 the category is simply derived from the file name, but you can also
7528 specify it with a special line in the buffer, like this@footnote{For
7529 backward compatibility, the following also works: if there are several
7530 such lines in a file, each specifies the category for the text below it.
7531 The first category also applies to any text before the first CATEGORY
7532 line. However, using this method is @emph{strongly} deprecated as it is
7533 incompatible with the outline structure of the document. The correct
7534 method for setting multiple categories in a buffer is using a
7542 @cindex property, CATEGORY
7543 If you would like to have a special CATEGORY for a single entry or a
7544 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7545 special category you want to apply as the value.
7548 The display in the agenda buffer looks best if the category is not
7549 longer than 10 characters.
7552 You can set up icons for category by customizing the
7553 @code{org-agenda-category-icon-alist} variable.
7555 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7556 @subsection Time-of-day specifications
7557 @cindex time-of-day specification
7559 Org-mode checks each agenda item for a time-of-day specification. The
7560 time can be part of the timestamp that triggered inclusion into the
7561 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7562 ranges can be specified with two timestamps, like
7564 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7566 In the headline of the entry itself, a time(range) may also appear as
7567 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7568 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7569 specifications in diary entries are recognized as well.
7571 For agenda display, Org-mode extracts the time and displays it in a
7572 standard 24 hour format as part of the prefix. The example times in
7573 the previous paragraphs would end up in the agenda like this:
7576 8:30-13:00 Arthur Dent lies in front of the bulldozer
7577 12:45...... Ford Prefect arrives and takes Arthur to the pub
7578 19:00...... The Vogon reads his poem
7579 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7583 If the agenda is in single-day mode, or for the display of today, the
7584 timed entries are embedded in a time grid, like
7587 8:00...... ------------------
7588 8:30-13:00 Arthur Dent lies in front of the bulldozer
7589 10:00...... ------------------
7590 12:00...... ------------------
7591 12:45...... Ford Prefect arrives and takes Arthur to the pub
7592 14:00...... ------------------
7593 16:00...... ------------------
7594 18:00...... ------------------
7595 19:00...... The Vogon reads his poem
7596 20:00...... ------------------
7597 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7600 @vindex org-agenda-use-time-grid
7601 @vindex org-agenda-time-grid
7602 The time grid can be turned on and off with the variable
7603 @code{org-agenda-use-time-grid}, and can be configured with
7604 @code{org-agenda-time-grid}.
7606 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7607 @subsection Sorting of agenda items
7608 @cindex sorting, of agenda items
7609 @cindex priorities, of agenda items
7610 Before being inserted into a view, the items are sorted. How this is
7611 done depends on the type of view.
7614 @vindex org-agenda-files
7615 For the daily/weekly agenda, the items for each day are sorted. The
7616 default order is to first collect all items containing an explicit
7617 time-of-day specification. These entries will be shown at the beginning
7618 of the list, as a @emph{schedule} for the day. After that, items remain
7619 grouped in categories, in the sequence given by @code{org-agenda-files}.
7620 Within each category, items are sorted by priority (@pxref{Priorities}),
7621 which is composed of the base priority (2000 for priority @samp{A}, 1000
7622 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7623 overdue scheduled or deadline items.
7625 For the TODO list, items remain in the order of categories, but within
7626 each category, sorting takes place according to priority
7627 (@pxref{Priorities}). The priority used for sorting derives from the
7628 priority cookie, with additions depending on how close an item is to its due
7631 For tags matches, items are not sorted at all, but just appear in the
7632 sequence in which they are found in the agenda files.
7635 @vindex org-agenda-sorting-strategy
7636 Sorting can be customized using the variable
7637 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7638 the estimated effort of an entry (@pxref{Effort estimates}).
7640 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7641 @section Commands in the agenda buffer
7642 @cindex commands, in agenda buffer
7644 Entries in the agenda buffer are linked back to the Org file or diary
7645 file where they originate. You are not allowed to edit the agenda
7646 buffer itself, but commands are provided to show and jump to the
7647 original entry location, and to edit the Org files ``remotely'' from
7648 the agenda buffer. In this way, all information is stored only once,
7649 removing the risk that your agenda and note files may diverge.
7651 Some commands can be executed with mouse clicks on agenda lines. For
7652 the other commands, the cursor needs to be in the desired line.
7655 @tsubheading{Motion}
7656 @cindex motion commands in agenda
7657 @orgcmd{n,org-agenda-next-line}
7658 Next line (same as @key{up} and @kbd{C-p}).
7659 @orgcmd{p,org-agenda-previous-line}
7660 Previous line (same as @key{down} and @kbd{C-n}).
7661 @tsubheading{View/Go to Org file}
7662 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
7663 Display the original location of the item in another window.
7664 With prefix arg, make sure that the entire entry is made visible in the
7665 outline, not only the heading.
7667 @orgcmd{L,org-agenda-recenter}
7668 Display original location and recenter that window.
7670 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
7671 Go to the original location of the item in another window.
7673 @orgcmd{@key{RET},org-agenda-switch-to}
7674 Go to the original location of the item and delete other windows.
7676 @orgcmd{F,org-agenda-follow-mode}
7677 @vindex org-agenda-start-with-follow-mode
7678 Toggle Follow mode. In Follow mode, as you move the cursor through
7679 the agenda buffer, the other window always shows the corresponding
7680 location in the Org file. The initial setting for this mode in new
7681 agenda buffers can be set with the variable
7682 @code{org-agenda-start-with-follow-mode}.
7684 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
7685 Display the entire subtree of the current item in an indirect buffer. With a
7686 numeric prefix argument N, go up to level N and then take that tree. If N is
7687 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
7688 previously used indirect buffer.
7690 @orgcmd{C-c C-o,org-agenda-open-link}
7691 Follow a link in the entry. This will offer a selection of any links in the
7692 text belonging to the referenced Org node. If there is only one link, it
7693 will be followed without a selection prompt.
7695 @tsubheading{Change display}
7696 @cindex display changing, in agenda
7699 Interactively select another agenda view and append it to the current view.
7703 Delete other windows.
7705 @orgcmdkskc{v d,d,org-aganda-day-view}
7706 @xorgcmdkskc{v w,w,org-aganda-day-view}
7707 @xorgcmd{v m,org-agenda-month-view}
7708 @xorgcmd{v y,org-agenda-month-year}
7709 @xorgcmd{v SPC,org-agenda-reset-view}
7710 @vindex org-agenda-span
7711 Switch to day/week/month/year view. When switching to day or week view, this
7712 setting becomes the default for subsequent agenda refreshes. Since month and
7713 year views are slow to create, they do not become the default. A numeric
7714 prefix argument may be used to jump directly to a specific day of the year,
7715 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
7716 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
7717 month view, a year may be encoded in the prefix argument as well. For
7718 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
7719 specification has only one or two digits, it will be mapped to the interval
7720 1938-2037. @kbd{v @key{SPC}} will reset to what is set in
7721 @code{org-agenda-span}.
7723 @orgcmd{f,org-agenda-later}
7724 Go forward in time to display the following @code{org-agenda-current-span} days.
7725 For example, if the display covers a week, switch to the following week.
7726 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
7728 @orgcmd{b,org-agenda-earlier}
7729 Go backward in time to display earlier dates.
7731 @orgcmd{.,org-agenda-goto-today}
7734 @orgcmd{j,org-agenda-goto-date}
7735 Prompt for a date and go there.
7737 @orgcmd{J,org-agenda-clock-goto}
7738 Go to the currently clocked-in task @i{in the agenda buffer}.
7740 @orgcmd{D,org-agenda-toggle-diary}
7741 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7743 @orgcmdkskc{v l,l,org-agenda-log-mode}
7745 @vindex org-log-done
7746 @vindex org-agenda-log-mode-items
7747 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7748 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7749 entries that have been clocked on that day. You can configure the entry
7750 types that should be included in log mode using the variable
7751 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7752 all possible logbook entries, including state changes. When called with two
7753 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7754 @kbd{v L} is equivalent to @kbd{C-u v l}.
7756 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
7757 Include inactive timestamps into the current view. Only for weekly/daily
7758 agenda and timeline views.
7760 @orgcmd{v a,org-agenda-archives-mode}
7761 @xorgcmd{v A,org-agenda-archives-mode 'files}
7762 Toggle Archives mode. In Archives mode, trees that are marked
7763 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7764 capital @kbd{A}, even all archive files are included. To exit archives mode,
7765 press @kbd{v a} again.
7767 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
7768 @vindex org-agenda-start-with-clockreport-mode
7769 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7770 always show a table with the clocked times for the timespan and file scope
7771 covered by the current agenda view. The initial setting for this mode in new
7772 agenda buffers can be set with the variable
7773 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
7774 when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
7775 contributions from entries that are hidden by agenda filtering@footnote{Only
7776 tags filtering will be respected here, effort filtering is ignored.}.
7779 @vindex org-agenda-clock-consistency-checks
7780 Show overlapping clock entries, clocking gaps, and other clocking problems in
7781 the current agenda range. You can then visit clocking lines and fix them
7782 manually. See the variable @code{org-agenda-clock-consistency-checks} for
7783 information on how to customize the definition of what constituted a clocking
7784 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
7787 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
7788 @vindex org-agenda-start-with-entry-text-mode
7789 @vindex org-agenda-entry-text-maxlines
7790 Toggle entry text mode. In entry text mode, a number of lines from the Org
7791 outline node referenced by an agenda line will be displayed below the line.
7792 The maximum number of lines is given by the variable
7793 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
7794 prefix argument will temporarily modify that number to the prefix value.
7796 @orgcmd{G,org-agenda-toggle-time-grid}
7797 @vindex org-agenda-use-time-grid
7798 @vindex org-agenda-time-grid
7799 Toggle the time grid on and off. See also the variables
7800 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
7802 @orgcmd{r,org-agenda-rodo}
7803 Recreate the agenda buffer, for example to reflect the changes after
7804 modification of the timestamps of items with @kbd{S-@key{left}} and
7805 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
7806 argument is interpreted to create a selective list for a specific TODO
7808 @orgcmd{g,org-agenda-rodo}
7811 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
7812 Save all Org buffers in the current Emacs session, and also the locations of
7815 @orgcmd{C-c C-x C-c,org-agenda-columns}
7816 @vindex org-columns-default-format
7817 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
7818 view format is taken from the entry at point, or (if there is no entry at
7819 point), from the first entry in the agenda view. So whatever the format for
7820 that entry would be in the original buffer (taken from a property, from a
7821 @code{#+COLUMNS} line, or from the default variable
7822 @code{org-columns-default-format}), will be used in the agenda.
7824 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7825 Remove the restriction lock on the agenda, if it is currently restricted to a
7826 file or subtree (@pxref{Agenda files}).
7828 @tsubheading{Secondary filtering and query editing}
7829 @cindex filtering, by tag and effort, in agenda
7830 @cindex tag filtering, in agenda
7831 @cindex effort filtering, in agenda
7832 @cindex query editing, in agenda
7834 @orgcmd{/,org-agenda-filter-by-tag}
7835 @vindex org-agenda-filter-preset
7836 Filter the current agenda view with respect to a tag and/or effort estimates.
7837 The difference between this and a custom agenda command is that filtering is
7838 very fast, so that you can switch quickly between different filters without
7839 having to recreate the agenda.@footnote{Custom commands can preset a filter by
7840 binding the variable @code{org-agenda-filter-preset} as an option. This
7841 filter will then be applied to the view and persist as a basic filter through
7842 refreshes and more secondary filtering. The filter is a global property of
7843 the entire agenda view---in a block agenda, you should only set this in the
7844 global options section, not in the section of an individual block.}
7846 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
7847 all. Pressing @key{TAB} at that prompt will offer use completion to select a
7848 tag (including any tags that do not have a selection character). The command
7849 then hides all entries that do not contain or inherit this tag. When called
7850 with prefix arg, remove the entries that @emph{do} have the tag. A second
7851 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
7852 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
7853 will be narrowed by requiring or forbidding the selected additional tag.
7854 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
7855 immediately use the @kbd{\} command.
7857 @vindex org-sort-agenda-noeffort-is-high
7858 In order to filter for effort estimates, you should set up allowed
7859 efforts globally, for example
7861 (setq org-global-properties
7862 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
7864 You can then filter for an effort by first typing an operator, one of
7865 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
7866 estimate in your array of allowed values, where @kbd{0} means the 10th value.
7867 The filter will then restrict to entries with effort smaller-or-equal, equal,
7868 or larger-or-equal than the selected value. If the digits 0-9 are not used
7869 as fast access keys to tags, you can also simply press the index digit
7870 directly without an operator. In this case, @kbd{<} will be assumed. For
7871 application of the operator, entries without a defined effort will be treated
7872 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
7873 for tasks without effort definition, press @kbd{?} as the operator.
7875 Org also supports automatic, context-aware tag filtering. If the variable
7876 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
7877 that function can decide which tags should be excluded from the agenda
7878 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
7879 as a sub-option key and runs the auto exclusion logic. For example, let's
7880 say you use a @code{Net} tag to identify tasks which need network access, an
7881 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
7882 calls. You could auto-exclude these tags based on the availability of the
7883 Internet, and outside of business hours, with something like this:
7887 (defun org-my-auto-exclude-function (tag)
7889 ((string= tag "Net")
7890 (/= 0 (call-process "/sbin/ping" nil nil nil
7891 "-c1" "-q" "-t1" "mail.gnu.org")))
7892 ((or (string= tag "Errand") (string= tag "Call"))
7893 (let ((hour (nth 2 (decode-time))))
7894 (or (< hour 8) (> hour 21)))))
7897 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
7901 @orgcmd{\\,org-agenda-filter-by-tag-refine}
7902 Narrow the current agenda filter by an additional condition. When called with
7903 prefix arg, remove the entries that @emph{do} have the tag, or that do match
7904 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
7905 @kbd{-} as the first key after the @kbd{/} command.
7914 @item @r{in} search view
7915 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
7916 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
7917 add a positive search term prefixed by @samp{+}, indicating that this search
7918 term @i{must} occur/match in the entry. The closing bracket/brace will add a
7919 negative search term which @i{must not} occur/match in the entry for it to be
7923 @tsubheading{Remote editing}
7924 @cindex remote editing, from agenda
7929 @cindex undoing remote-editing events
7930 @cindex remote editing, undo
7931 @orgcmd{C-_,org-agenda-undo}
7932 Undo a change due to a remote editing command. The change is undone
7933 both in the agenda buffer and in the remote buffer.
7935 @orgcmd{t,org-agenda-todo}
7936 Change the TODO state of the item, both in the agenda and in the
7939 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
7940 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
7941 Switch to the next/previous set of TODO keywords.
7943 @orgcmd{C-k,org-agenda-kill}
7944 @vindex org-agenda-confirm-kill
7945 Delete the current agenda item along with the entire subtree belonging
7946 to it in the original Org file. If the text to be deleted remotely
7947 is longer than one line, the kill needs to be confirmed by the user. See
7948 variable @code{org-agenda-confirm-kill}.
7950 @orgcmd{C-c C-w,org-agenda-refile}
7951 Refile the entry at point.
7953 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
7954 @vindex org-archive-default-command
7955 Archive the subtree corresponding to the entry at point using the default
7956 archiving command set in @code{org-archive-default-command}. When using the
7957 @code{a} key, confirmation will be required.
7959 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
7960 Toggle the ARCHIVE tag for the current headline.
7962 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
7963 Move the subtree corresponding to the current entry to its @emph{archive
7966 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
7967 Archive the subtree corresponding to the current headline. This means the
7968 entry will be moved to the configured archive location, most likely a
7971 @orgcmd{T,org-agenda-show-tags}
7972 @vindex org-agenda-show-inherited-tags
7973 Show all tags associated with the current item. This is useful if you have
7974 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
7975 tags of a headline occasionally.
7977 @orgcmd{:,org-agenda-set-tags}
7978 Set tags for the current headline. If there is an active region in the
7979 agenda, change a tag for all headings in the region.
7983 Set the priority for the current item (@command{org-agenda-priority}).
7984 Org-mode prompts for the priority character. If you reply with @key{SPC}, the
7985 priority cookie is removed from the entry.
7987 @orgcmd{P,org-agenda-show-priority}
7988 Display weighted priority of current item.
7990 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
7991 Increase the priority of the current item. The priority is changed in
7992 the original buffer, but the agenda is not resorted. Use the @kbd{r}
7995 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
7996 Decrease the priority of the current item.
7998 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
7999 @vindex org-log-into-drawer
8000 Add a note to the entry. This note will be recorded, and then filed to the
8001 same location where state change notes are put. Depending on
8002 @code{org-log-into-drawer}, this may be inside a drawer.
8004 @orgcmd{C-c C-a,org-attach}
8005 Dispatcher for all command related to attachments.
8007 @orgcmd{C-c C-s,org-agenda-schedule}
8008 Schedule this item. With prefix arg remove the scheduling timestamp
8010 @orgcmd{C-c C-d,org-agenda-deadline}
8011 Set a deadline for this item. With prefix arg remove the deadline.
8013 @orgcmd{k,org-agenda-action}
8014 Agenda actions, to set dates for selected items to the cursor date.
8015 This command also works in the calendar! The command prompts for an
8018 m @r{Mark the entry at point for action. You can also make entries}
8019 @r{in Org files with @kbd{C-c C-x C-k}.}
8020 d @r{Set the deadline of the marked entry to the date at point.}
8021 s @r{Schedule the marked entry at the date at point.}
8022 r @r{Call @code{org-capture} with the cursor date as default date.}
8025 Press @kbd{r} afterward to refresh the agenda and see the effect of the
8028 @orgcmd{S-@key{right},org-agenda-do-date-later}
8029 Change the timestamp associated with the current line by one day into the
8030 future. With a numeric prefix argument, change it by that many days. For
8031 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
8032 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
8033 command, it will continue to change hours even without the prefix arg. With
8034 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
8035 is changed in the original Org file, but the change is not directly reflected
8036 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8038 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8039 Change the timestamp associated with the current line by one day
8042 @orgcmd{>,org-agenda-date-prompt}
8043 Change the timestamp associated with the current line. The key @kbd{>} has
8044 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8046 @orgcmd{I,org-agenda-clock-in}
8047 Start the clock on the current item. If a clock is running already, it
8050 @orgcmd{O,org-agenda-clock-out}
8051 Stop the previously started clock.
8053 @orgcmd{X,org-agenda-clock-cancel}
8054 Cancel the currently running clock.
8056 @orgcmd{J,org-agenda-clock-goto}
8057 Jump to the running clock in another window.
8059 @tsubheading{Bulk remote editing selected entries}
8060 @cindex remote editing, bulk, from agenda
8062 @orgcmd{m,org-agenda-bulk-mark}
8063 Mark the entry at point for bulk action. With prefix arg, mark that many
8066 @orgcmd{%,org-agenda-bulk-mark-regexp}
8067 Mark entries matching a regular expression for bulk action.
8069 @orgcmd{u,org-agenda-bulk-unmark}
8070 Unmark entry for bulk action.
8072 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8073 Unmark all marked entries for bulk action.
8075 @orgcmd{B,org-agenda-bulk-action}
8076 Bulk action: act on all marked entries in the agenda. This will prompt for
8077 another key to select the action to be applied. The prefix arg to @kbd{B}
8078 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8079 these special timestamps.
8081 r @r{Prompt for a single refile target and move all entries. The entries}
8082 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8083 $ @r{Archive all selected entries.}
8084 A @r{Archive entries by moving them to their respective archive siblings.}
8085 t @r{Change TODO state. This prompts for a single TODO keyword and}
8086 @r{changes the state of all selected entries, bypassing blocking and}
8087 @r{suppressing logging notes (but not timestamps).}
8088 + @r{Add a tag to all selected entries.}
8089 - @r{Remove a tag from all selected entries.}
8090 s @r{Schedule all items to a new date. To shift existing schedule dates}
8091 @r{by a fixed number of days, use something starting with double plus}
8092 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8093 S @r{Reschedule randomly into the coming N days. N will be prompted for.}
8094 @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
8095 d @r{Set deadline to a specific date.}
8096 f @r{Apply a function to marked entries.}
8097 @r{For example, the function below sets the CATEGORY property of the}
8099 @r{(defun set-category ()}
8100 @r{ (interactive "P")}
8101 @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
8102 @r{ (org-agenda-error)))}
8103 @r{ (buffer (marker-buffer marker)))}
8104 @r{ (with-current-buffer buffer}
8105 @r{ (save-excursion}
8106 @r{ (save-restriction}
8108 @r{ (goto-char marker)}
8109 @r{ (org-back-to-heading t)}
8110 @r{ (org-set-property "CATEGORY" "web"))))))}
8114 @tsubheading{Calendar commands}
8115 @cindex calendar commands, from agenda
8117 @orgcmd{c,org-agenda-goto-calendar}
8118 Open the Emacs calendar and move to the date at the agenda cursor.
8120 @orgcmd{c,org-calendar-goto-agenda}
8121 When in the calendar, compute and show the Org-mode agenda for the
8124 @cindex diary entries, creating from agenda
8125 @orgcmd{i,org-agenda-diary-entry}
8126 @vindex org-agenda-diary-file
8127 Insert a new entry into the diary, using the date at the cursor and (for
8128 block entries) the date at the mark. This will add to the Emacs diary
8129 file@footnote{This file is parsed for the agenda when
8130 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8131 command in the calendar. The diary file will pop up in another window, where
8132 you can add the entry.
8134 If you configure @code{org-agenda-diary-file} to point to an Org-mode file,
8135 Org will create entries (in org-mode syntax) in that file instead. Most
8136 entries will be stored in a date-based outline tree that will later make it
8137 easy to archive appointments from previous months/years. The tree will be
8138 built under an entry with a @code{DATE_TREE} property, or else with years as
8139 top-level entries. Emacs will prompt you for the entry text---if you specify
8140 it, the entry will be created in @code{org-agenda-diary-file} without further
8141 interaction. If you directly press @key{RET} at the prompt without typing
8142 text, the target file will be shown in another window for you to finish the
8143 entry there. See also the @kbd{k r} command.
8145 @orgcmd{M,org-agenda-phases-of-moon}
8146 Show the phases of the moon for the three months around current date.
8148 @orgcmd{S,org-agenda-sunrise-sunset}
8149 Show sunrise and sunset times. The geographical location must be set
8150 with calendar variables, see the documentation for the Emacs calendar.
8152 @orgcmd{C,org-agenda-convert-date}
8153 Convert the date at cursor into many other cultural and historic
8156 @orgcmd{H,org-agenda-holidays}
8157 Show holidays for three months around the cursor date.
8159 @item M-x org-export-icalendar-combine-agenda-files
8160 Export a single iCalendar file containing entries from all agenda files.
8161 This is a globally available command, and also available in the agenda menu.
8163 @tsubheading{Exporting to a file}
8164 @orgcmd{C-x C-w,org-write-agenda}
8165 @cindex exporting agenda views
8166 @cindex agenda views, exporting
8167 @vindex org-agenda-exporter-settings
8168 Write the agenda view to a file. Depending on the extension of the selected
8169 file name, the view will be exported as HTML (extension @file{.html} or
8170 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8171 and plain text (any other extension). When called with a @kbd{C-u} prefix
8172 argument, immediately open the newly created file. Use the variable
8173 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8174 for @file{htmlize} to be used during export.
8176 @tsubheading{Quit and Exit}
8177 @orgcmd{q,org-agenda-quit}
8178 Quit agenda, remove the agenda buffer.
8180 @cindex agenda files, removing buffers
8181 @orgcmd{x,org-agenda-exit}
8182 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8183 for the compilation of the agenda. Buffers created by the user to
8184 visit Org files will not be removed.
8188 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8189 @section Custom agenda views
8190 @cindex custom agenda views
8191 @cindex agenda views, custom
8193 Custom agenda commands serve two purposes: to store and quickly access
8194 frequently used TODO and tags searches, and to create special composite
8195 agenda buffers. Custom agenda commands will be accessible through the
8196 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8199 * Storing searches:: Type once, use often
8200 * Block agenda:: All the stuff you need in a single buffer
8201 * Setting Options:: Changing the rules
8204 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8205 @subsection Storing searches
8207 The first application of custom searches is the definition of keyboard
8208 shortcuts for frequently used searches, either creating an agenda
8209 buffer, or a sparse tree (the latter covering of course only the current
8212 @vindex org-agenda-custom-commands
8213 Custom commands are configured in the variable
8214 @code{org-agenda-custom-commands}. You can customize this variable, for
8215 example by pressing @kbd{C-c a C}. You can also directly set it with
8216 Emacs Lisp in @file{.emacs}. The following example contains all valid
8221 (setq org-agenda-custom-commands
8222 '(("w" todo "WAITING")
8223 ("W" todo-tree "WAITING")
8224 ("u" tags "+boss-urgent")
8225 ("v" tags-todo "+boss-urgent")
8226 ("U" tags-tree "+boss-urgent")
8227 ("f" occur-tree "\\<FIXME\\>")
8228 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8229 ("hl" tags "+home+Lisa")
8230 ("hp" tags "+home+Peter")
8231 ("hk" tags "+home+Kim")))
8236 The initial string in each entry defines the keys you have to press
8237 after the dispatcher command @kbd{C-c a} in order to access the command.
8238 Usually this will be just a single character, but if you have many
8239 similar commands, you can also define two-letter combinations where the
8240 first character is the same in several combinations and serves as a
8241 prefix key@footnote{You can provide a description for a prefix key by
8242 inserting a cons cell with the prefix and the description.}. The second
8243 parameter is the search type, followed by the string or regular
8244 expression to be used for the matching. The example above will
8249 as a global search for TODO entries with @samp{WAITING} as the TODO
8252 as the same search, but only in the current buffer and displaying the
8253 results as a sparse tree
8255 as a global tags search for headlines marked @samp{:boss:} but not
8258 as the same search as @kbd{C-c a u}, but limiting the search to
8259 headlines that are also TODO items
8261 as the same search as @kbd{C-c a u}, but only in the current buffer and
8262 displaying the result as a sparse tree
8264 to create a sparse tree (again: current buffer only) with all entries
8265 containing the word @samp{FIXME}
8267 as a prefix command for a HOME tags search where you have to press an
8268 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8269 Peter, or Kim) as additional tag to match.
8272 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8273 @subsection Block agenda
8274 @cindex block agenda
8275 @cindex agenda, with block views
8277 Another possibility is the construction of agenda views that comprise
8278 the results of @emph{several} commands, each of which creates a block in
8279 the agenda buffer. The available commands include @code{agenda} for the
8280 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8281 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8282 matching commands discussed above: @code{todo}, @code{tags}, and
8283 @code{tags-todo}. Here are two examples:
8287 (setq org-agenda-custom-commands
8288 '(("h" "Agenda and Home-related tasks"
8292 ("o" "Agenda and Office-related tasks"
8300 This will define @kbd{C-c a h} to create a multi-block view for stuff
8301 you need to attend to at home. The resulting agenda buffer will contain
8302 your agenda for the current week, all TODO items that carry the tag
8303 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8304 command @kbd{C-c a o} provides a similar view for office tasks.
8306 @node Setting Options, , Block agenda, Custom agenda views
8307 @subsection Setting options for custom commands
8308 @cindex options, for custom agenda views
8310 @vindex org-agenda-custom-commands
8311 Org-mode contains a number of variables regulating agenda construction
8312 and display. The global variables define the behavior for all agenda
8313 commands, including the custom commands. However, if you want to change
8314 some settings just for a single custom view, you can do so. Setting
8315 options requires inserting a list of variable names and values at the
8316 right spot in @code{org-agenda-custom-commands}. For example:
8320 (setq org-agenda-custom-commands
8321 '(("w" todo "WAITING"
8322 ((org-agenda-sorting-strategy '(priority-down))
8323 (org-agenda-prefix-format " Mixed: ")))
8324 ("U" tags-tree "+boss-urgent"
8325 ((org-show-following-heading nil)
8326 (org-show-hierarchy-above nil)))
8328 ((org-agenda-files '("~org/notes.org"))
8329 (org-agenda-text-search-extra-files nil)))))
8334 Now the @kbd{C-c a w} command will sort the collected entries only by
8335 priority, and the prefix format is modified to just say @samp{ Mixed: }
8336 instead of giving the category of the entry. The sparse tags tree of
8337 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8338 headline hierarchy above the match, nor the headline following the match
8339 will be shown. The command @kbd{C-c a N} will do a text search limited
8340 to only a single file.
8342 @vindex org-agenda-custom-commands
8343 For command sets creating a block agenda,
8344 @code{org-agenda-custom-commands} has two separate spots for setting
8345 options. You can add options that should be valid for just a single
8346 command in the set, and options that should be valid for all commands in
8347 the set. The former are just added to the command entry; the latter
8348 must come after the list of command entries. Going back to the block
8349 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8350 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8351 the results for GARDEN tags query in the opposite order,
8352 @code{priority-up}. This would look like this:
8356 (setq org-agenda-custom-commands
8357 '(("h" "Agenda and Home-related tasks"
8361 ((org-agenda-sorting-strategy '(priority-up)))))
8362 ((org-agenda-sorting-strategy '(priority-down))))
8363 ("o" "Agenda and Office-related tasks"
8370 As you see, the values and parentheses setting is a little complex.
8371 When in doubt, use the customize interface to set this variable---it
8372 fully supports its structure. Just one caveat: when setting options in
8373 this interface, the @emph{values} are just Lisp expressions. So if the
8374 value is a string, you need to add the double-quotes around the value
8378 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8379 @section Exporting Agenda Views
8380 @cindex agenda views, exporting
8382 If you are away from your computer, it can be very useful to have a printed
8383 version of some agenda views to carry around. Org-mode can export custom
8384 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8385 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8386 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8387 a PDF file with also create the postscript file.}, and iCalendar files. If
8388 you want to do this only occasionally, use the command
8391 @orgcmd{C-x C-w,org-write-agenda}
8392 @cindex exporting agenda views
8393 @cindex agenda views, exporting
8394 @vindex org-agenda-exporter-settings
8395 Write the agenda view to a file. Depending on the extension of the selected
8396 file name, the view will be exported as HTML (extension @file{.html} or
8397 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8398 @file{.ics}), or plain text (any other extension). Use the variable
8399 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8400 for @file{htmlize} to be used during export, for example
8402 @vindex org-agenda-add-entry-text-maxlines
8403 @vindex htmlize-output-type
8404 @vindex ps-number-of-columns
8405 @vindex ps-landscape-mode
8407 (setq org-agenda-exporter-settings
8408 '((ps-number-of-columns 2)
8409 (ps-landscape-mode t)
8410 (org-agenda-add-entry-text-maxlines 5)
8411 (htmlize-output-type 'css)))
8415 If you need to export certain agenda views frequently, you can associate
8416 any custom agenda command with a list of output file names
8417 @footnote{If you want to store standard views like the weekly agenda
8418 or the global TODO list as well, you need to define custom commands for
8419 them in order to be able to specify file names.}. Here is an example
8420 that first defines custom commands for the agenda and the global
8421 TODO list, together with a number of files to which to export them.
8422 Then we define two block agenda commands and specify file names for them
8423 as well. File names can be relative to the current working directory,
8428 (setq org-agenda-custom-commands
8429 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8430 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8431 ("h" "Agenda and Home-related tasks"
8436 ("~/views/home.html"))
8437 ("o" "Agenda and Office-related tasks"
8442 ("~/views/office.ps" "~/calendars/office.ics"))))
8446 The extension of the file name determines the type of export. If it is
8447 @file{.html}, Org-mode will use the @file{htmlize.el} package to convert
8448 the buffer to HTML and save it to this file name. If the extension is
8449 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8450 Postscript output. If the extension is @file{.ics}, iCalendar export is
8451 run export over all files that were used to construct the agenda, and
8452 limit the export to entries listed in the agenda. Any other
8453 extension produces a plain ASCII file.
8455 The export files are @emph{not} created when you use one of those
8456 commands interactively because this might use too much overhead.
8457 Instead, there is a special command to produce @emph{all} specified
8461 @orgcmd{C-c a e,org-store-agenda-views}
8462 Export all agenda views that have export file names associated with
8466 You can use the options section of the custom agenda commands to also
8467 set options for the export commands. For example:
8470 (setq org-agenda-custom-commands
8472 ((ps-number-of-columns 2)
8473 (ps-landscape-mode t)
8474 (org-agenda-prefix-format " [ ] ")
8475 (org-agenda-with-colors nil)
8476 (org-agenda-remove-tags t))
8481 This command sets two options for the Postscript exporter, to make it
8482 print in two columns in landscape format---the resulting page can be cut
8483 in two and then used in a paper agenda. The remaining settings modify
8484 the agenda prefix to omit category and scheduling information, and
8485 instead include a checkbox to check off items. We also remove the tags
8486 to make the lines compact, and we don't want to use colors for the
8487 black-and-white printer. Settings specified in
8488 @code{org-agenda-exporter-settings} will also apply, but the settings
8489 in @code{org-agenda-custom-commands} take precedence.
8492 From the command line you may also use
8494 emacs -f org-batch-store-agenda-views -kill
8497 or, if you need to modify some parameters@footnote{Quoting depends on the
8498 system you use, please check the FAQ for examples.}
8500 emacs -eval '(org-batch-store-agenda-views \
8501 org-agenda-span month \
8502 org-agenda-start-day "2007-11-01" \
8503 org-agenda-include-diary nil \
8504 org-agenda-files (quote ("~/org/project.org")))' \
8508 which will create the agenda views restricted to the file
8509 @file{~/org/project.org}, without diary entries and with a 30-day
8512 You can also extract agenda information in a way that allows further
8513 processing by other programs. See @ref{Extracting agenda information}, for
8517 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8518 @section Using column view in the agenda
8519 @cindex column view, in agenda
8520 @cindex agenda, column view
8522 Column view (@pxref{Column view}) is normally used to view and edit
8523 properties embedded in the hierarchical structure of an Org file. It can be
8524 quite useful to use column view also from the agenda, where entries are
8525 collected by certain criteria.
8528 @orgcmd{C-c C-x C-c,org-agenda-columns}
8529 Turn on column view in the agenda.
8532 To understand how to use this properly, it is important to realize that the
8533 entries in the agenda are no longer in their proper outline environment.
8534 This causes the following issues:
8538 @vindex org-columns-default-format
8539 @vindex org-overriding-columns-format
8540 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8541 entries in the agenda are collected from different files, and different files
8542 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8543 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
8544 currently set, and if so, takes the format from there. Otherwise it takes
8545 the format associated with the first item in the agenda, or, if that item
8546 does not have a specific format (defined in a property, or in its file), it
8547 uses @code{org-columns-default-format}.
8549 @cindex property, special, CLOCKSUM
8550 If any of the columns has a summary type defined (@pxref{Column attributes}),
8551 turning on column view in the agenda will visit all relevant agenda files and
8552 make sure that the computations of this property are up to date. This is
8553 also true for the special @code{CLOCKSUM} property. Org will then sum the
8554 values displayed in the agenda. In the daily/weekly agenda, the sums will
8555 cover a single day; in all other views they cover the entire block. It is
8556 vital to realize that the agenda may show the same entry @emph{twice} (for
8557 example as scheduled and as a deadline), and it may show two entries from the
8558 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8559 cases, the summation in the agenda will lead to incorrect results because
8560 some values will count double.
8562 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8563 the entire clocked time for this item. So even in the daily/weekly agenda,
8564 the clocksum listed in column view may originate from times outside the
8565 current view. This has the advantage that you can compare these values with
8566 a column listing the planned total effort for a task---one of the major
8567 applications for column view in the agenda. If you want information about
8568 clocked time in the displayed period use clock table mode (press @kbd{R} in
8573 @node Markup, Exporting, Agenda Views, Top
8574 @chapter Markup for rich export
8576 When exporting Org-mode documents, the exporter tries to reflect the
8577 structure of the document as accurately as possible in the backend. Since
8578 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
8579 Org-mode has rules on how to prepare text for rich export. This section
8580 summarizes the markup rules used in an Org-mode buffer.
8583 * Structural markup elements:: The basic structure as seen by the exporter
8584 * Images and tables:: Tables and Images will be included
8585 * Literal examples:: Source code examples with special formatting
8586 * Include files:: Include additional files into a document
8587 * Index entries:: Making an index
8588 * Macro replacement:: Use macros to create complex output
8589 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
8592 @node Structural markup elements, Images and tables, Markup, Markup
8593 @section Structural markup elements
8596 * Document title:: Where the title is taken from
8597 * Headings and sections:: The document structure as seen by the exporter
8598 * Table of contents:: The if and where of the table of contents
8599 * Initial text:: Text before the first heading?
8601 * Paragraphs:: Paragraphs
8602 * Footnote markup:: Footnotes
8603 * Emphasis and monospace:: Bold, italic, etc.
8604 * Horizontal rules:: Make a line
8605 * Comment lines:: What will *not* be exported
8608 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8609 @subheading Document title
8610 @cindex document title, markup rules
8613 The title of the exported document is taken from the special line
8617 #+TITLE: This is the title of the document
8621 If this line does not exist, the title is derived from the first non-empty,
8622 non-comment line in the buffer. If no such line exists, or if you have
8623 turned off exporting of the text before the first headline (see below), the
8624 title will be the file name without extension.
8626 @cindex property, EXPORT_TITLE
8627 If you are exporting only a subtree by marking is as the region, the heading
8628 of the subtree will become the title of the document. If the subtree has a
8629 property @code{EXPORT_TITLE}, that will take precedence.
8631 @node Headings and sections, Table of contents, Document title, Structural markup elements
8632 @subheading Headings and sections
8633 @cindex headings and sections, markup rules
8635 @vindex org-export-headline-levels
8636 The outline structure of the document as described in @ref{Document
8637 Structure}, forms the basis for defining sections of the exported document.
8638 However, since the outline structure is also used for (for example) lists of
8639 tasks, only the first three outline levels will be used as headings. Deeper
8640 levels will become itemized lists. You can change the location of this
8641 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8642 per-file basis with a line
8649 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8650 @subheading Table of contents
8651 @cindex table of contents, markup rules
8653 @vindex org-export-with-toc
8654 The table of contents is normally inserted directly before the first headline
8655 of the file. If you would like to get it to a different location, insert the
8656 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8657 location. The depth of the table of contents is by default the same as the
8658 number of headline levels, but you can choose a smaller number, or turn off
8659 the table of contents entirely, by configuring the variable
8660 @code{org-export-with-toc}, or on a per-file basis with a line like
8663 #+OPTIONS: toc:2 (only to two levels in TOC)
8664 #+OPTIONS: toc:nil (no TOC at all)
8667 @node Initial text, Lists, Table of contents, Structural markup elements
8668 @subheading Text before the first headline
8669 @cindex text before first headline, markup rules
8672 Org-mode normally exports the text before the first headline, and even uses
8673 the first line as the document title. The text will be fully marked up. If
8674 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
8675 constructs described below in the sections for the individual exporters.
8677 @vindex org-export-skip-text-before-1st-heading
8678 Some people like to use the space before the first headline for setup and
8679 internal links and therefore would like to control the exported text before
8680 the first headline in a different way. You can do so by setting the variable
8681 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8682 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8685 If you still want to have some text before the first headline, use the
8686 @code{#+TEXT} construct:
8690 #+TEXT: This text will go before the *first* headline.
8691 #+TEXT: [TABLE-OF-CONTENTS]
8692 #+TEXT: This goes between the table of contents and the first headline
8695 @node Lists, Paragraphs, Initial text, Structural markup elements
8697 @cindex lists, markup rules
8699 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8700 syntax for such lists. Most backends support unordered, ordered, and
8703 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8704 @subheading Paragraphs, line breaks, and quoting
8705 @cindex paragraphs, markup rules
8707 Paragraphs are separated by at least one empty line. If you need to enforce
8708 a line break within a paragraph, use @samp{\\} at the end of a line.
8710 To keep the line breaks in a region, but otherwise use normal formatting, you
8711 can use this construct, which can also be used to format poetry.
8713 @cindex #+BEGIN_VERSE
8716 Great clouds overhead
8717 Tiny black birds rise and fall
8724 When quoting a passage from another document, it is customary to format this
8725 as a paragraph that is indented on both the left and the right margin. You
8726 can include quotations in Org-mode documents like this:
8728 @cindex #+BEGIN_QUOTE
8731 Everything should be made as simple as possible,
8732 but not any simpler -- Albert Einstein
8736 If you would like to center some text, do it like this:
8737 @cindex #+BEGIN_CENTER
8740 Everything should be made as simple as possible, \\
8746 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8747 @subheading Footnote markup
8748 @cindex footnotes, markup rules
8749 @cindex @file{footnote.el}
8751 Footnotes defined in the way described in @ref{Footnotes}, will be exported by
8752 all backends. Org allows multiple references to the same note, and
8753 different backends support this to varying degrees.
8755 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8756 @subheading Emphasis and monospace
8758 @cindex underlined text, markup rules
8759 @cindex bold text, markup rules
8760 @cindex italic text, markup rules
8761 @cindex verbatim text, markup rules
8762 @cindex code text, markup rules
8763 @cindex strike-through text, markup rules
8764 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8765 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8766 in the code and verbatim string is not processed for Org-mode specific
8767 syntax; it is exported verbatim.
8769 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8770 @subheading Horizontal rules
8771 @cindex horizontal rules, markup rules
8772 A line consisting of only dashes, and at least 5 of them, will be exported as
8773 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
8775 @node Comment lines, , Horizontal rules, Structural markup elements
8776 @subheading Comment lines
8777 @cindex comment lines
8778 @cindex exporting, not
8779 @cindex #+BEGIN_COMMENT
8781 Lines starting with @samp{#} in column zero are treated as comments and will
8782 never be exported. If you want an indented line to be treated as a comment,
8783 start it with @samp{#+ }. Also entire subtrees starting with the word
8784 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8785 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8790 Toggle the COMMENT keyword at the beginning of an entry.
8794 @node Images and tables, Literal examples, Structural markup elements, Markup
8795 @section Images and Tables
8797 @cindex tables, markup rules
8800 Both the native Org-mode tables (@pxref{Tables}) and tables formatted with
8801 the @file{table.el} package will be exported properly. For Org-mode tables,
8802 the lines before the first horizontal separator line will become table header
8803 lines. You can use the following lines somewhere before the table to assign
8804 a caption and a label for cross references, and in the text you can refer to
8805 the object with @code{\ref@{tab:basic-data@}}:
8808 #+CAPTION: This is the caption for the next table (or link)
8809 #+LABEL: tbl:basic-data
8814 @cindex inlined images, markup rules
8815 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
8816 images into the exported document. Org does this, if a link to an image
8817 files does not have a description part, for example @code{[[./img/a.jpg]]}.
8818 If you wish to define a caption for the image and maybe a label for internal
8819 cross references, make sure that the link is on a line by itself and precede
8820 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
8823 #+CAPTION: This is the caption for the next figure link (or table)
8824 #+LABEL: fig:SED-HR4049
8828 You may also define additional attributes for the figure. As this is
8829 backend-specific, see the sections about the individual backends for more
8832 @xref{Handling links,the discussion of image links}.
8834 @node Literal examples, Include files, Images and tables, Markup
8835 @section Literal examples
8836 @cindex literal examples, markup rules
8837 @cindex code line references, markup rules
8839 You can include literal examples that should not be subjected to
8840 markup. Such examples will be typeset in monospace, so this is well suited
8841 for source code and similar examples.
8842 @cindex #+BEGIN_EXAMPLE
8846 Some example from a text file.
8850 Note that such blocks may be @i{indented} in order to align nicely with
8851 indented text and in particular with plain list structure (@pxref{Plain
8852 lists}). For simplicity when using small examples, you can also start the
8853 example lines with a colon followed by a space. There may also be additional
8854 whitespace before the colon:
8858 : Some example from a text file.
8861 @cindex formatting source code, markup rules
8862 If the example is source code from a programming language, or any other text
8863 that can be marked up by font-lock in Emacs, you can ask for the example to
8864 look like the fontified Emacs buffer@footnote{This works automatically for
8865 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
8866 which is distributed with Org). Fontified code chunks in LaTeX can be
8867 achieved using either the listings or the
8868 @url{http://code.google.com/p/minted, minted,} package. To use listings, turn
8869 on the variable @code{org-export-latex-listings} and ensure that the listings
8870 package is included by the LaTeX header (e.g.@: by configuring
8871 @code{org-export-latex-packages-alist}). See the listings documentation for
8872 configuration options, including obtaining colored output. For minted it is
8873 necessary to install the program @url{http://pygments.org, pygments}, in
8874 addition to setting @code{org-export-latex-minted}, ensuring that the minted
8875 package is included by the LaTeX header, and ensuring that the
8876 @code{-shell-escape} option is passed to @file{pdflatex} (see
8877 @code{org-latex-to-pdf-process}). See the documentation of the variables
8878 @code{org-export-latex-listings} and @code{org-export-latex-minted} for
8879 further details.}. This is done with the @samp{src} block, where you also
8880 need to specify the name of the major mode that should be used to fontify the
8881 example@footnote{Code in @samp{src} blocks may also be evaluated either
8882 interactively or on export. See @pxref{Working With Source Code} for more
8883 information on evaluating code blocks.}:
8887 #+BEGIN_SRC emacs-lisp
8888 (defun org-xor (a b)
8894 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
8895 switch to the end of the @code{BEGIN} line, to get the lines of the example
8896 numbered. If you use a @code{+n} switch, the numbering from the previous
8897 numbered snippet will be continued in the current one. In literal examples,
8898 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
8899 targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
8900 enclosed in single parenthesis). In HTML, hovering the mouse over such a
8901 link will remote-highlight the corresponding code line, which is kind of
8904 You can also add a @code{-r} switch which @i{removes} the labels from the
8905 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
8906 labels in the source code while using line numbers for the links, which might
8907 be useful to explain those in an org-mode example code.}. With the @code{-n}
8908 switch, links to these references will be labeled by the line numbers from
8909 the code listing, otherwise links will use the labels with no parentheses.
8913 #+BEGIN_SRC emacs-lisp -n -r
8914 (save-excursion (ref:sc)
8915 (goto-char (point-min)) (ref:jump)
8917 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
8921 @vindex org-coderef-label-format
8922 If the syntax for the label format conflicts with the language syntax, use a
8923 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
8924 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8926 HTML export also allows examples to be published as text areas, @xref{Text
8927 areas in HTML export}.
8929 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
8930 so often, shortcuts are provided using the Easy Templates facility
8931 (@pxref{Easy Templates}).
8936 Edit the source code example at point in its native mode. This works by
8937 switching to a temporary buffer with the source code. You need to exit by
8938 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
8939 or @samp{#} will get a comma prepended, to keep them from being interpreted
8940 by Org as outline nodes or special comments. These commas will be stripped
8941 for editing with @kbd{C-c '}, and also for export.}. The edited version will
8942 then replace the old version in the Org buffer. Fixed-width regions
8943 (where each line starts with a colon followed by a space) will be edited
8944 using @code{artist-mode}@footnote{You may select a different-mode with the
8945 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
8946 drawings easily. Using this command in an empty line will create a new
8950 Calling @code{org-store-link} while editing a source code example in a
8951 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
8952 that it is unique in the current buffer, and insert it with the proper
8953 formatting like @samp{(ref:label)} at the end of the current line. Then the
8954 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8958 @node Include files, Index entries, Literal examples, Markup
8959 @section Include files
8960 @cindex include files, markup rules
8962 During export, you can include the content of another file. For example, to
8963 include your @file{.emacs} file, you could use:
8967 #+INCLUDE: "~/.emacs" src emacs-lisp
8970 The optional second and third parameter are the markup (e.g.@: @samp{quote},
8971 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8972 language for formatting the contents. The markup is optional; if it is not
8973 given, the text will be assumed to be in Org-mode format and will be
8974 processed normally. The include line will also allow additional keyword
8975 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8976 first line and for each following line, @code{:minlevel} in order to get
8977 org-mode content demoted to a specified level, as well as any options
8978 accepted by the selected markup. For example, to include a file as an item,
8982 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8985 You can also include a portion of a file by specifying a lines range using
8986 the @code{:lines} parameter. The line at the upper end of the range will not
8987 be included. The start and/or the end of the range may be omitted to use the
8991 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
8992 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
8993 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
8999 Visit the include file at point.
9002 @node Index entries, Macro replacement, Include files, Markup
9003 @section Index entries
9004 @cindex index entries, for publishing
9006 You can specify entries that will be used for generating an index during
9007 publishing. This is done by lines starting with @code{#+INDEX}. An entry
9008 the contains an exclamation mark will create a sub item. See @ref{Generating
9009 an index} for more information.
9014 #+INDEX: Application!CV
9020 @node Macro replacement, Embedded LaTeX, Index entries, Markup
9021 @section Macro replacement
9022 @cindex macro replacement, during export
9025 You can define text snippets with
9028 #+MACRO: name replacement text $1, $2 are arguments
9031 @noindent which can be referenced anywhere in the document (even in
9032 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
9033 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
9034 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
9035 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9036 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9037 and to the modification time of the file being exported, respectively.
9038 @var{FORMAT} should be a format string understood by
9039 @code{format-time-string}.
9041 Macro expansion takes place during export, and some people use it to
9042 construct complex HTML code.
9045 @node Embedded LaTeX, , Macro replacement, Markup
9046 @section Embedded @LaTeX{}
9047 @cindex @TeX{} interpretation
9048 @cindex @LaTeX{} interpretation
9050 Plain ASCII is normally sufficient for almost all note taking. Exceptions
9051 include scientific notes, which often require mathematical symbols and the
9052 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9053 Donald E. Knuth's @TeX{} system. Many of the features described here as
9054 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9055 distinction.} is widely used to typeset scientific documents. Org-mode
9056 supports embedding @LaTeX{} code into its files, because many academics are
9057 used to writing and reading @LaTeX{} source code, and because it can be
9058 readily processed to produce pretty output for a number of export backends.
9061 * Special symbols:: Greek letters and other symbols
9062 * Subscripts and superscripts:: Simple syntax for raising/lowering text
9063 * LaTeX fragments:: Complex formulas made easy
9064 * Previewing LaTeX fragments:: What will this snippet look like?
9065 * CDLaTeX mode:: Speed up entering of formulas
9068 @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
9069 @subsection Special symbols
9070 @cindex math symbols
9071 @cindex special symbols
9072 @cindex @TeX{} macros
9073 @cindex @LaTeX{} fragments, markup rules
9074 @cindex HTML entities
9075 @cindex @LaTeX{} entities
9077 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
9078 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
9079 for these macros is available, just type @samp{\} and maybe a few letters,
9080 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
9081 code, Org-mode allows these macros to be present without surrounding math
9082 delimiters, for example:
9085 Angles are written as Greek letters \alpha, \beta and \gamma.
9088 @vindex org-entities
9089 During export, these symbols will be transformed into the native format of
9090 the exporter backend. Strings like @code{\alpha} will be exported as
9091 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9092 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
9093 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
9094 like this: @samp{\Aacute@{@}stor}.
9096 A large number of entities is provided, with names taken from both HTML and
9097 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9098 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9099 @samp{...} are all converted into special commands creating hyphens of
9100 different lengths or a compact set of dots.
9102 If you would like to see entities displayed as UTF8 characters, use the
9103 following command@footnote{You can turn this on by default by setting the
9104 variable @code{org-pretty-entities}, or on a per-file base with the
9105 @code{#+STARTUP} option @code{entitiespretty}.}:
9110 Toggle display of entities as UTF-8 characters. This does not change the
9111 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9112 for display purposes only.
9115 @node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
9116 @subsection Subscripts and superscripts
9120 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9121 and subscripts. Again, these can be used without embedding them in
9122 math-mode delimiters. To increase the readability of ASCII text, it is
9123 not necessary (but OK) to surround multi-character sub- and superscripts
9124 with curly braces. For example
9127 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9128 the sun is R_@{sun@} = 6.96 x 10^8 m.
9131 @vindex org-export-with-sub-superscripts
9132 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9133 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9134 where the underscore is often used in a different context, Org's convention
9135 to always interpret these as subscripts can get in your way. Configure the
9136 variable @code{org-export-with-sub-superscripts} to globally change this
9137 convention, or use, on a per-file basis:
9143 @noindent With this setting, @samp{a_b} will not be interpreted as a
9144 subscript, but @samp{a_@{b@}} will.
9149 In addition to showing entities as UTF-8 characters, this command will also
9150 format sub- and superscripts in a WYSIWYM way.
9153 @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
9154 @subsection @LaTeX{} fragments
9155 @cindex @LaTeX{} fragments
9157 @vindex org-format-latex-header
9158 Going beyond symbols and sub- and superscripts, a full formula language is
9159 needed. Org-mode can contain @LaTeX{} math fragments, and it supports ways
9160 to process these for several export backends. When exporting to @LaTeX{},
9161 the code is obviously left as it is. When exporting to HTML, Org invokes the
9162 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9163 HTML export}) to process and display the math@footnote{If you plan to use
9164 this regularly or on pages with significant page views, you should install
9165 @file{MathJax} on your own
9166 server in order to limit the load of our server.}. Finally, it can also
9167 process the mathematical expressions into images@footnote{For this to work
9168 you need to be on a system with a working @LaTeX{} installation. You also
9169 need the @file{dvipng} program, available at
9170 @url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will
9171 be used when processing a fragment can be configured with the variable
9172 @code{org-format-latex-header}.} that can be displayed in a browser or in
9175 @LaTeX{} fragments don't need any special marking at all. The following
9176 snippets will be identified as @LaTeX{} source code:
9179 Environments of any kind@footnote{When @file{MathJax} is used, only the
9180 environment recognized by @file{MathJax} will be processed. When
9181 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9182 handled.}. The only requirement is that the @code{\begin} statement appears
9183 on a new line, preceded by only whitespace.
9185 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9186 currency specifications, single @samp{$} characters are only recognized as
9187 math delimiters if the enclosed text contains at most two line breaks, is
9188 directly attached to the @samp{$} characters with no whitespace in between,
9189 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9190 For the other delimiters, there is no such restriction, so when in doubt, use
9191 @samp{\(...\)} as inline math delimiters.
9194 @noindent For example:
9197 \begin@{equation@} % arbitrary environments,
9198 x=\sqrt@{b@} % even tables, figures
9199 \end@{equation@} % etc
9201 If $a^2=b$ and \( b=2 \), then the solution must be
9202 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9206 @vindex org-format-latex-options
9207 If you need any of the delimiter ASCII sequences for other purposes, you
9208 can configure the option @code{org-format-latex-options} to deselect the
9209 ones you do not wish to have interpreted by the @LaTeX{} converter.
9211 @vindex org-export-with-LaTeX-fragments
9212 LaTeX processing can be configured with the variable
9213 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9214 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9215 LaTeX backends. You can also set this variable on a per-file basis using one
9219 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9220 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9221 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9222 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9225 @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
9226 @subsection Previewing LaTeX fragments
9227 @cindex LaTeX fragments, preview
9229 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9230 produce preview images of the typeset expressions:
9235 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9236 over the source code. If there is no fragment at point, process all
9237 fragments in the current entry (between two headlines). When called
9238 with a prefix argument, process the entire subtree. When called with
9239 two prefix arguments, or when the cursor is before the first headline,
9240 process the entire buffer.
9243 Remove the overlay preview images.
9246 @vindex org-format-latex-options
9247 You can customize the variable @code{org-format-latex-options} to influence
9248 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9249 export, @code{:html-scale}) property can be used to adjust the size of the
9252 @node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX
9253 @subsection Using CDLa@TeX{} to enter math
9256 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
9257 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9258 environments and math templates. Inside Org-mode, you can make use of
9259 some of the features of CDLa@TeX{} mode. You need to install
9260 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9261 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9262 Don't use CDLa@TeX{} mode itself under Org-mode, but use the light
9263 version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it
9264 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9268 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9271 When this mode is enabled, the following features are present (for more
9272 details see the documentation of CDLa@TeX{} mode):
9276 Environment templates can be inserted with @kbd{C-c @{}.
9279 The @key{TAB} key will do template expansion if the cursor is inside a
9280 @LaTeX{} fragment@footnote{Org-mode has a method to test if the cursor is
9281 inside such a fragment, see the documentation of the function
9282 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9283 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9284 correctly inside the first brace. Another @key{TAB} will get you into
9285 the second brace. Even outside fragments, @key{TAB} will expand
9286 environment abbreviations at the beginning of a line. For example, if
9287 you write @samp{equ} at the beginning of a line and press @key{TAB},
9288 this abbreviation will be expanded to an @code{equation} environment.
9289 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9293 @vindex cdlatex-simplify-sub-super-scripts
9294 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9295 characters together with a pair of braces. If you use @key{TAB} to move
9296 out of the braces, and if the braces surround only a single character or
9297 macro, they are removed again (depending on the variable
9298 @code{cdlatex-simplify-sub-super-scripts}).
9301 Pressing the backquote @kbd{`} followed by a character inserts math
9302 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9303 after the backquote, a help window will pop up.
9306 Pressing the single-quote @kbd{'} followed by another character modifies
9307 the symbol before point with an accent or a font. If you wait more than
9308 1.5 seconds after the single-quote, a help window will pop up. Character
9309 modification will work only inside @LaTeX{} fragments; outside the quote
9313 @node Exporting, Publishing, Markup, Top
9317 Org-mode documents can be exported into a variety of other formats. For
9318 printing and sharing of notes, ASCII export produces a readable and simple
9319 version of an Org file. HTML export allows you to publish a notes file on
9320 the web, while the XOXO format provides a solid base for exchange with a
9321 broad range of other applications. @LaTeX{} export lets you use Org-mode and
9322 its structured editing functions to easily create @LaTeX{} files. DocBook
9323 export makes it possible to convert Org files to many other formats using
9324 DocBook tools. For project management you can create gantt and resource
9325 charts by using TaskJuggler export. To incorporate entries with associated
9326 times like deadlines or appointments into a desktop calendar program like
9327 iCal, Org-mode can also produce extracts in the iCalendar format. Currently
9328 Org-mode only supports export, not import of these different formats.
9330 Org supports export of selected regions when @code{transient-mark-mode} is
9331 enabled (default in Emacs 23).
9334 * Selective export:: Using tags to select and exclude trees
9335 * Export options:: Per-file export settings
9336 * The export dispatcher:: How to access exporter commands
9337 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9338 * HTML export:: Exporting to HTML
9339 * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9340 * DocBook export:: Exporting to DocBook
9341 * TaskJuggler export:: Exporting to TaskJuggler
9342 * Freemind export:: Exporting to Freemind mind maps
9343 * XOXO export:: Exporting to XOXO
9344 * iCalendar export:: Exporting in iCalendar format
9347 @node Selective export, Export options, Exporting, Exporting
9348 @section Selective export
9349 @cindex export, selective by tags or TODO keyword
9351 @vindex org-export-select-tags
9352 @vindex org-export-exclude-tags
9353 @cindex org-export-with-tasks
9354 You may use tags to select the parts of a document that should be exported,
9355 or to exclude parts from export. This behavior is governed by two variables:
9356 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
9360 Org first checks if any of the @emph{select} tags is present in the
9361 buffer. If yes, all trees that do not carry one of these tags will be
9362 excluded. If a selected tree is a subtree, the heading hierarchy above it
9363 will also be selected for export, but not the text below those headings.
9366 If none of the select tags is found, the whole buffer will be selected for
9370 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9371 be removed from the export buffer.
9374 The variable @code{org-export-with-tasks} can be configured to select which
9375 kind of tasks should be included for export. See the docstring of the
9376 variable for more information.
9378 @node Export options, The export dispatcher, Selective export, Exporting
9379 @section Export options
9380 @cindex options, for export
9382 @cindex completion, of option keywords
9383 The exporter recognizes special lines in the buffer which provide
9384 additional information. These lines may be put anywhere in the file.
9385 The whole set of lines can be inserted into the buffer with @kbd{C-c
9386 C-e t}. For individual lines, a good way to make sure the keyword is
9387 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9388 (@pxref{Completion}). For a summary of other in-buffer settings not
9389 specifically related to export, see @ref{In-buffer settings}.
9390 In particular, note that you can place commonly-used (export) options in
9391 a separate file which can be included using @code{#+SETUPFILE}.
9394 @orgcmd{C-c C-e t,org-insert-export-options-template}
9395 Insert template with export options, see example below.
9402 @cindex #+DESCRIPTION
9410 @cindex #+EXPORT_SELECT_TAGS
9411 @cindex #+EXPORT_EXCLUDE_TAGS
9413 @cindex #+LATEX_HEADER
9414 @vindex user-full-name
9415 @vindex user-mail-address
9416 @vindex org-export-default-language
9418 #+TITLE: the title to be shown (default is the buffer name)
9419 #+AUTHOR: the author (default taken from @code{user-full-name})
9420 #+DATE: a date, fixed, or a format string for @code{format-time-string}
9421 #+EMAIL: his/her email address (default from @code{user-mail-address})
9422 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
9423 #+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
9424 #+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
9425 #+TEXT: Some descriptive text to be inserted at the beginning.
9426 #+TEXT: Several lines may be given.
9427 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9428 #+BIND: lisp-var lisp-val, e.g.@:: org-export-latex-low-levels itemize
9429 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9430 #+LINK_UP: the ``up'' link of an exported page
9431 #+LINK_HOME: the ``home'' link of an exported page
9432 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
9433 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9434 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9435 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9439 The OPTIONS line is a compact@footnote{If you want to configure many options
9440 this way, you can use several OPTIONS lines.} form to specify export
9441 settings. Here you can:
9442 @cindex headline levels
9443 @cindex section-numbers
9444 @cindex table of contents
9445 @cindex line-break preservation
9446 @cindex quoted HTML tags
9447 @cindex fixed-width sections
9449 @cindex @TeX{}-like syntax for sub- and superscripts
9451 @cindex special strings
9452 @cindex emphasized text
9453 @cindex @TeX{} macros
9454 @cindex @LaTeX{} fragments
9455 @cindex author info, in export
9456 @cindex time info, in export
9457 @vindex org-export-plist-vars
9458 @vindex org-export-author-info
9459 @vindex org-export-creator-info
9460 @vindex org-export-email-info
9461 @vindex org-export-time-stamp-file
9463 H: @r{set the number of headline levels for export}
9464 num: @r{turn on/off section-numbers}
9465 toc: @r{turn on/off table of contents, or set level limit (integer)}
9466 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9467 @@: @r{turn on/off quoted HTML tags}
9468 :: @r{turn on/off fixed-width sections}
9469 |: @r{turn on/off tables}
9470 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9471 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9472 @r{the simple @code{a_b} will be left as it is.}
9473 -: @r{turn on/off conversion of special strings.}
9474 f: @r{turn on/off footnotes like this[1].}
9475 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9476 tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
9477 @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
9478 pri: @r{turn on/off priority cookies}
9479 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9480 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9481 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9482 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9483 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
9484 skip: @r{turn on/off skipping the text before the first heading}
9485 author: @r{turn on/off inclusion of author name/email into exported file}
9486 email: @r{turn on/off inclusion of author email into exported file}
9487 creator: @r{turn on/off inclusion of creator info into exported file}
9488 timestamp: @r{turn on/off inclusion creation time into exported file}
9489 d: @r{turn on/off inclusion of drawers}
9492 These options take effect in both the HTML and @LaTeX{} export, except for
9493 @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
9494 @code{nil} for the @LaTeX{} export.
9496 The default values for these and many other options are given by a set of
9497 variables. For a list of such variables, the corresponding OPTIONS keys and
9498 also the publishing keys (@pxref{Project alist}), see the constant
9499 @code{org-export-plist-vars}.
9501 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9502 calling an export command, the subtree can overrule some of the file's export
9503 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9504 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9505 @code{EXPORT_OPTIONS}.
9507 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9508 @section The export dispatcher
9509 @cindex dispatcher, for export commands
9511 All export commands can be reached using the export dispatcher, which is a
9512 prefix key that prompts for an additional key specifying the command.
9513 Normally the entire file is exported, but if there is an active region that
9514 contains one outline tree, the first heading is used as document title and
9515 the subtrees are exported.
9518 @orgcmd{C-c C-e,org-export}
9519 @vindex org-export-run-in-background
9520 Dispatcher for export and publishing commands. Displays a help-window
9521 listing the additional key(s) needed to launch an export or publishing
9522 command. The prefix arg is passed through to the exporter. A double prefix
9523 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9524 separate Emacs process@footnote{To make this behavior the default, customize
9525 the variable @code{org-export-run-in-background}.}.
9526 @orgcmd{C-c C-e v,org-export-visible}
9527 Like @kbd{C-c C-e}, but only export the text that is currently visible
9528 (i.e.@: not hidden by outline visibility).
9529 @orgcmd{C-u C-u C-c C-e,org-export}
9530 @vindex org-export-run-in-background
9531 Call the exporter, but reverse the setting of
9532 @code{org-export-run-in-background}, i.e.@: request background processing if
9533 not set, or force processing in the current Emacs process if set.
9536 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9537 @section ASCII/Latin-1/UTF-8 export
9538 @cindex ASCII export
9539 @cindex Latin-1 export
9540 @cindex UTF-8 export
9542 ASCII export produces a simple and very readable version of an Org-mode
9543 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9544 with special characters and symbols available in these encodings.
9546 @cindex region, active
9547 @cindex active region
9548 @cindex transient-mark-mode
9550 @orgcmd{C-c C-e a,org-export-as-ascii}
9551 @cindex property, EXPORT_FILE_NAME
9552 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9553 will be @file{myfile.txt}. The file will be overwritten without
9554 warning. If there is an active region@footnote{This requires
9555 @code{transient-mark-mode} be turned on.}, only the region will be
9556 exported. If the selected region is a single tree@footnote{To select the
9557 current subtree, use @kbd{C-c @@}.}, the tree head will
9558 become the document title. If the tree head entry has or inherits an
9559 @code{EXPORT_FILE_NAME} property, that name will be used for the
9561 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9562 Export to a temporary buffer. Do not create a file.
9563 @orgcmd{C-c C-e n,org-export-as-latin1}
9564 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
9565 Like the above commands, but use Latin-1 encoding.
9566 @orgcmd{C-c C-e u,org-export-as-utf8}
9567 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
9568 Like the above commands, but use UTF-8 encoding.
9569 @item C-c C-e v a/n/u
9570 Export only the visible part of the document.
9573 @cindex headline levels, for exporting
9574 In the exported version, the first 3 outline levels will become
9575 headlines, defining a general document structure. Additional levels
9576 will be exported as itemized lists. If you want that transition to occur
9577 at a different level, specify it with a prefix argument. For example,
9584 creates only top level headlines and does the rest as items. When
9585 headlines are converted to items, the indentation of the text following
9586 the headline is changed to fit nicely under the item. This is done with
9587 the assumption that the first body line indicates the base indentation of
9588 the body text. Any indentation larger than this is adjusted to preserve
9589 the layout relative to the first line. Should there be lines with less
9590 indentation than the first, these are left alone.
9592 @vindex org-export-ascii-links-to-notes
9593 Links will be exported in a footnote-like style, with the descriptive part in
9594 the text and the link in a note before the next heading. See the variable
9595 @code{org-export-ascii-links-to-notes} for details and other options.
9597 @node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9598 @section HTML export
9601 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9602 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9603 language, but with additional support for tables.
9606 * HTML Export commands:: How to invoke HTML export
9607 * HTML preamble and postamble:: How to insert a preamble and a postamble
9608 * Quoting HTML tags:: Using direct HTML in Org-mode
9609 * Links in HTML export:: How links will be interpreted and formatted
9610 * Tables in HTML export:: How to modify the formatting of tables
9611 * Images in HTML export:: How to insert figures into HTML output
9612 * Math formatting in HTML export:: Beautiful math also on the web
9613 * Text areas in HTML export:: An alternative way to show an example
9614 * CSS support:: Changing the appearance of the output
9615 * JavaScript support:: Info and Folding in a web browser
9618 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
9619 @subsection HTML export commands
9621 @cindex region, active
9622 @cindex active region
9623 @cindex transient-mark-mode
9625 @orgcmd{C-c C-e h,org-export-as-html}
9626 @cindex property, EXPORT_FILE_NAME
9627 Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
9628 the ASCII file will be @file{myfile.html}. The file will be overwritten
9629 without warning. If there is an active region@footnote{This requires
9630 @code{transient-mark-mode} be turned on.}, only the region will be
9631 exported. If the selected region is a single tree@footnote{To select the
9632 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9633 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9634 property, that name will be used for the export.
9635 @orgcmd{C-c C-e b,org-export-as-html-and-open}
9636 Export as HTML file and immediately open it with a browser.
9637 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
9638 Export to a temporary buffer. Do not create a file.
9639 @orgcmd{C-c C-e R,org-export-region-as-html}
9640 Export the active region to a temporary buffer. With a prefix argument, do
9641 not produce the file header and footer, but just the plain HTML section for
9642 the region. This is good for cut-and-paste operations.
9643 @item C-c C-e v h/b/H/R
9644 Export only the visible part of the document.
9645 @item M-x org-export-region-as-html
9646 Convert the region to HTML under the assumption that it was Org-mode
9647 syntax before. This is a global command that can be invoked in any
9649 @item M-x org-replace-region-by-HTML
9650 Replace the active region (assumed to be in Org-mode syntax) by HTML
9654 @cindex headline levels, for exporting
9655 In the exported version, the first 3 outline levels will become headlines,
9656 defining a general document structure. Additional levels will be exported as
9657 itemized lists. If you want that transition to occur at a different level,
9658 specify it with a numeric prefix argument. For example,
9665 creates two levels of headings and does the rest as items.
9668 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
9669 @subsection HTML preamble and postamble
9670 @vindex org-export-html-preamble
9671 @vindex org-export-html-postamble
9672 @vindex org-export-html-preamble-format
9673 @vindex org-export-html-postamble-format
9674 @vindex org-export-html-validation-link
9675 @vindex org-export-author-info
9676 @vindex org-export-email-info
9677 @vindex org-export-creator-info
9678 @vindex org-export-time-stamp-file
9680 The HTML exporter lets you define a preamble and a postamble.
9682 The default value for @code{org-export-html-preamble} is @code{t}, which
9683 means that the preamble is inserted depending on the relevant formatting
9684 string in @code{org-export-html-preamble-format}. Setting
9685 @code{org-export-html-preamble} to a string will override the default
9686 formatting string. Setting it to a function, will insert the output of the
9687 function. Setting to @code{nil} will not insert any preamble.
9689 The default value for @code{org-export-html-postamble} is @code{'auto}, which
9690 means that the HTML exporter will look for the value of
9691 @code{org-export-author-info}, @code{org-export-email-info},
9692 @code{org-export-creator-info} and @code{org-export-time-stamp-file},
9693 @code{org-export-html-validation-link} and build the postamble from these
9694 values. Setting @code{org-export-html-postamble} to @code{t} will insert the
9695 postamble from the relevant formatting string found in
9696 @code{org-export-html-postamble-format}. Setting it to @code{nil} will not
9697 insert any postamble.
9699 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
9700 @subsection Quoting HTML tags
9702 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
9703 @samp{>} in HTML export. If you want to include simple HTML tags
9704 which should be interpreted as such, mark them with @samp{@@} as in
9705 @samp{@@<b>bold text@@</b>}. Note that this really works only for
9706 simple tags. For more extensive HTML that should be copied verbatim to
9707 the exported file use either
9710 @cindex #+BEGIN_HTML
9712 #+HTML: Literal HTML code for export
9716 @cindex #+BEGIN_HTML
9720 All lines between these markers are exported literally
9725 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9726 @subsection Links in HTML export
9728 @cindex links, in HTML export
9729 @cindex internal links, in HTML export
9730 @cindex external links, in HTML export
9731 Internal links (@pxref{Internal links}) will continue to work in HTML. This
9732 includes automatic links created by radio targets (@pxref{Radio
9733 targets}). Links to external files will still work if the target file is on
9734 the same @i{relative} path as the published Org file. Links to other
9735 @file{.org} files will be translated into HTML links under the assumption
9736 that an HTML version also exists of the linked file, at the same relative
9737 path. @samp{id:} links can then be used to jump to specific entries across
9738 files. For information related to linking files while publishing them to a
9739 publishing directory see @ref{Publishing links}.
9741 If you want to specify attributes for links, you can do so using a special
9742 @code{#+ATTR_HTML} line to define attributes that will be added to the
9743 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
9744 and @code{style} attributes for a link:
9748 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
9749 [[http://orgmode.org]]
9752 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9754 @cindex tables, in HTML
9755 @vindex org-export-html-table-tag
9757 Org-mode tables are exported to HTML using the table tag defined in
9758 @code{org-export-html-table-tag}. The default setting makes tables without
9759 cell borders and frame. If you would like to change this for individual
9760 tables, place something like the following before the table:
9765 #+CAPTION: This is a table with lines around and between cells
9766 #+ATTR_HTML: border="2" rules="all" frame="all"
9769 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
9770 @subsection Images in HTML export
9772 @cindex images, inline in HTML
9773 @cindex inlining images in HTML
9774 @vindex org-export-html-inline-images
9775 HTML export can inline images given as links in the Org file, and
9776 it can make an image the clickable part of a link. By
9777 default@footnote{But see the variable
9778 @code{org-export-html-inline-images}.}, images are inlined if a link does
9779 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
9780 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
9781 @samp{the image} that points to the image. If the description part
9782 itself is a @code{file:} link or a @code{http:} URL pointing to an
9783 image, this image will be inlined and activated so that clicking on the
9784 image will activate the link. For example, to include a thumbnail that
9785 will link to a high resolution version of the image, you could use:
9788 [[file:highres.jpg][file:thumb.jpg]]
9791 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
9792 In the example below we specify the @code{alt} and @code{title} attributes to
9793 support text viewers and accessibility, and align it to the right.
9798 #+CAPTION: A black cat stalking a spider
9799 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
9804 and you could use @code{http} addresses just as well.
9806 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
9807 @subsection Math formatting in HTML export
9811 @LaTeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two
9812 different ways on HTML pages. The default is to use the
9813 @uref{http://www.mathjax.org, MathJax system} which should work out of the
9814 box with Org mode installation because @code{http://orgmode.org} serves
9815 @file{MathJax} for Org-mode users for small applications and for testing
9816 purposes. @b{If you plan to use this regularly or on pages with significant
9817 page views, you should install@footnote{Installation instructions can be
9818 found on the MathJax website, see
9819 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
9820 your own server in order to limit the load of our server.} To configure
9821 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
9822 insert something like the following into the buffer:
9825 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
9828 @noindent See the docstring of the variable
9829 @code{org-export-html-mathjax-options} for the meaning of the parameters in
9832 If you prefer, you can also request that @LaTeX{} fragments are processed
9833 into small images that will be inserted into the browser page. Before the
9834 availability of MathJax, this was the default method for Org files. This
9835 method requires that the @file{dvipng} program is available on your system.
9836 You can still get this processing with
9839 #+OPTIONS: LaTeX:dvipng
9842 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
9843 @subsection Text areas in HTML export
9845 @cindex text areas, in HTML
9846 An alternative way to publish literal code examples in HTML is to use text
9847 areas, where the example can even be edited before pasting it into an
9848 application. It is triggered by a @code{-t} switch at an @code{example} or
9849 @code{src} block. Using this switch disables any options for syntax and
9850 label highlighting, and line numbering, which may be present. You may also
9851 use @code{-h} and @code{-w} switches to specify the height and width of the
9852 text area, which default to the number of lines in the example, and 80,
9853 respectively. For example
9856 #+BEGIN_EXAMPLE -t -w 40
9857 (defun org-xor (a b)
9864 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
9865 @subsection CSS support
9866 @cindex CSS, for HTML export
9867 @cindex HTML export, CSS
9869 @vindex org-export-html-todo-kwd-class-prefix
9870 @vindex org-export-html-tag-class-prefix
9871 You can also give style information for the exported file. The HTML exporter
9872 assigns the following special CSS classes@footnote{If the classes on TODO
9873 keywords and tags lead to conflicts, use the variables
9874 @code{org-export-html-todo-kwd-class-prefix} and
9875 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
9876 parts of the document---your style specifications may change these, in
9877 addition to any of the standard classes like for headlines, tables, etc.
9879 p.author @r{author information, including email}
9880 p.date @r{publishing date}
9881 p.creator @r{creator info, about org-mode version}
9882 .title @r{document title}
9883 .todo @r{TODO keywords, all not-done states}
9884 .done @r{the DONE keywords, all states that count as done}
9885 .WAITING @r{each TODO keyword also uses a class named after itself}
9886 .timestamp @r{timestamp}
9887 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
9888 .timestamp-wrapper @r{span around keyword plus timestamp}
9889 .tag @r{tag in a headline}
9890 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
9891 .target @r{target for links}
9892 .linenr @r{the line number in a code example}
9893 .code-highlighted @r{for highlighting referenced code lines}
9894 div.outline-N @r{div for outline level N (headline plus text))}
9895 div.outline-text-N @r{extra div for text at outline level N}
9896 .section-number-N @r{section number in headlines, different for each level}
9897 div.figure @r{how to format an inlined image}
9898 pre.src @r{formatted source code}
9899 pre.example @r{normal example}
9900 p.verse @r{verse paragraph}
9901 div.footnotes @r{footnote section headline}
9902 p.footnote @r{footnote definition paragraph, containing a footnote}
9903 .footref @r{a footnote reference number (always a <sup>)}
9904 .footnum @r{footnote number in footnote definition (always <sup>)}
9907 @vindex org-export-html-style-default
9908 @vindex org-export-html-style-include-default
9909 @vindex org-export-html-style
9910 @vindex org-export-html-extra
9911 @vindex org-export-html-style-default
9912 Each exported file contains a compact default style that defines these
9913 classes in a basic way@footnote{This style is defined in the constant
9914 @code{org-export-html-style-default}, which you should not modify. To turn
9915 inclusion of these defaults off, customize
9916 @code{org-export-html-style-include-default}}. You may overwrite these
9917 settings, or add to them by using the variables @code{org-export-html-style}
9918 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
9919 fine-grained settings, like file-local settings). To set the latter variable
9920 individually for each file, you can use
9924 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
9928 For longer style definitions, you can use several such lines. You could also
9929 directly write a @code{<style>} @code{</style>} section in this way, without
9930 referring to an external file.
9932 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
9933 property to assign a class to the tree. In order to specify CSS styles for a
9934 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
9937 @c FIXME: More about header and footer styles
9938 @c FIXME: Talk about links and targets.
9940 @node JavaScript support, , CSS support, HTML export
9941 @subsection JavaScript supported display of web pages
9943 @cindex Rose, Sebastian
9944 Sebastian Rose has written a JavaScript program especially designed to
9945 enhance the web viewing experience of HTML files created with Org. This
9946 program allows you to view large files in two different ways. The first one
9947 is an @emph{Info}-like mode where each section is displayed separately and
9948 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
9949 as well, press @kbd{?} for an overview of the available keys). The second
9950 view type is a @emph{folding} view much like Org provides inside Emacs. The
9951 script is available at @url{http://orgmode.org/org-info.js} and you can find
9952 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
9953 We host the script at our site, but if you use it a lot, you might
9954 not want to be dependent on @url{orgmode.org} and prefer to install a local
9955 copy on your own web server.
9957 To use the script, you need to make sure that the @file{org-jsinfo.el} module
9958 gets loaded. It should be loaded by default, but you can try @kbd{M-x
9959 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
9960 this is indeed the case. All it then takes to make use of the program is
9961 adding a single line to the Org file:
9963 @cindex #+INFOJS_OPT
9965 #+INFOJS_OPT: view:info toc:nil
9969 If this line is found, the HTML header will automatically contain the code
9970 needed to invoke the script. Using the line above, you can set the following
9974 path: @r{The path to the script. The default is to grab the script from}
9975 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
9976 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
9977 view: @r{Initial view when website is first shown. Possible values are:}
9978 info @r{Info-like interface with one section per page.}
9979 overview @r{Folding interface, initially showing only top-level.}
9980 content @r{Folding interface, starting with all headlines visible.}
9981 showall @r{Folding interface, all headlines and text visible.}
9982 sdepth: @r{Maximum headline level that will still become an independent}
9983 @r{section for info and folding modes. The default is taken from}
9984 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
9985 @r{If this is smaller than in @code{org-export-headline-levels}, each}
9986 @r{info/folding section can still contain child headlines.}
9987 toc: @r{Should the table of contents @emph{initially} be visible?}
9988 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
9989 tdepth: @r{The depth of the table of contents. The defaults are taken from}
9990 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
9991 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
9992 @r{If yes, the toc will never be displayed as a section.}
9993 ltoc: @r{Should there be short contents (children) in each section?}
9994 @r{Make this @code{above} if the section should be above initial text.}
9995 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
9996 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
9997 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
9998 @r{default), only one such button will be present.}
10001 @vindex org-infojs-options
10002 @vindex org-export-html-use-infojs
10003 You can choose default values for these options by customizing the variable
10004 @code{org-infojs-options}. If you always want to apply the script to your
10005 pages, configure the variable @code{org-export-html-use-infojs}.
10007 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
10008 @section @LaTeX{} and PDF export
10009 @cindex @LaTeX{} export
10011 @cindex Guerry, Bastien
10013 Org-mode contains a @LaTeX{} exporter written by Bastien Guerry. With
10014 further processing@footnote{The default LaTeX output is designed for
10015 processing with pdftex or latex. It includes packages that are not
10016 compatible with xetex and possibly luatex. See the variables
10017 @code{org-export-latex-default-packages-alist} and
10018 @code{org-export-latex-packages-alist}.}, this backend is also used to
10019 produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
10020 implement links and cross references, the PDF output file will be fully
10021 linked. Beware of the fact that your @code{org} file has to be properly
10022 structured in order to be correctly exported: respect the hierarchy of
10026 * LaTeX/PDF export commands:: Which key invokes which commands
10027 * Header and sectioning:: Setting up the export file structure
10028 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code
10029 * Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
10030 * Images in LaTeX export:: How to insert figures into @LaTeX{} output
10031 * Beamer class export:: Turning the file into a presentation
10034 @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
10035 @subsection @LaTeX{} export commands
10037 @cindex region, active
10038 @cindex active region
10039 @cindex transient-mark-mode
10041 @orgcmd{C-c C-e l,org-export-as-latex}
10042 @cindex property EXPORT_FILE_NAME
10043 Export as @LaTeX{} file @file{myfile.tex}. For an Org file
10044 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
10045 be overwritten without warning. If there is an active region@footnote{This
10046 requires @code{transient-mark-mode} be turned on.}, only the region will be
10047 exported. If the selected region is a single tree@footnote{To select the
10048 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10049 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
10050 property, that name will be used for the export.
10051 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
10052 Export to a temporary buffer. Do not create a file.
10053 @item C-c C-e v l/L
10054 Export only the visible part of the document.
10055 @item M-x org-export-region-as-latex
10056 Convert the region to @LaTeX{} under the assumption that it was Org-mode
10057 syntax before. This is a global command that can be invoked in any
10059 @item M-x org-replace-region-by-latex
10060 Replace the active region (assumed to be in Org-mode syntax) by @LaTeX{}
10062 @orgcmd{C-c C-e p,org-export-as-pdf}
10063 Export as @LaTeX{} and then process to PDF.
10064 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
10065 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10068 @cindex headline levels, for exporting
10069 @vindex org-latex-low-levels
10070 In the exported version, the first 3 outline levels will become
10071 headlines, defining a general document structure. Additional levels
10072 will be exported as description lists. The exporter can ignore them or
10073 convert them to a custom string depending on
10074 @code{org-latex-low-levels}.
10076 If you want that transition to occur at a different level, specify it
10077 with a numeric prefix argument. For example,
10080 @kbd{C-2 C-c C-e l}
10084 creates two levels of headings and does the rest as items.
10086 @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
10087 @subsection Header and sectioning structure
10088 @cindex @LaTeX{} class
10089 @cindex @LaTeX{} sectioning structure
10090 @cindex @LaTeX{} header
10091 @cindex header, for LaTeX files
10092 @cindex sectioning structure, for LaTeX export
10094 By default, the @LaTeX{} output uses the class @code{article}.
10096 @vindex org-export-latex-default-class
10097 @vindex org-export-latex-classes
10098 @vindex org-export-latex-default-packages-alist
10099 @vindex org-export-latex-packages-alist
10100 @cindex #+LATEX_HEADER
10101 @cindex #+LATEX_CLASS
10102 @cindex #+LATEX_CLASS_OPTIONS
10103 @cindex property, LATEX_CLASS
10104 @cindex property, LATEX_CLASS_OPTIONS
10105 You can change this globally by setting a different value for
10106 @code{org-export-latex-default-class} or locally by adding an option like
10107 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
10108 property that applies when exporting a region containing only this (sub)tree.
10109 The class must be listed in @code{org-export-latex-classes}. This variable
10110 defines a header template for each class@footnote{Into which the values of
10111 @code{org-export-latex-default-packages-alist} and
10112 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
10113 define the sectioning structure for each class. You can also define your own
10114 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
10115 property can specify the options for the @code{\documentclass} macro. You
10116 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
10117 header. See the docstring of @code{org-export-latex-classes} for more
10120 @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export
10121 @subsection Quoting @LaTeX{} code
10123 Embedded @LaTeX{} as described in @ref{Embedded LaTeX}, will be correctly
10124 inserted into the @LaTeX{} file. This includes simple macros like
10125 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
10126 you can add special code that should only be present in @LaTeX{} export with
10127 the following constructs:
10130 @cindex #+BEGIN_LaTeX
10132 #+LaTeX: Literal LaTeX code for export
10136 @cindex #+BEGIN_LaTeX
10140 All lines between these markers are exported literally
10145 @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
10146 @subsection Tables in @LaTeX{} export
10147 @cindex tables, in @LaTeX{} export
10149 For @LaTeX{} export of a table, you can specify a label and a caption
10150 (@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to
10151 request a @code{longtable} environment for the table, so that it may span
10152 several pages, or to change the default table environment from @code{table}
10153 to @code{table*} or to change the default inner tabular environment to
10154 @code{tabularx} or @code{tabulary}. Finally, you can set the alignment
10155 string, and (with @code{tabularx} or @code{tabulary}) the width:
10159 @cindex #+ATTR_LaTeX
10161 #+CAPTION: A long table
10163 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10168 or to specify a multicolumn table with @code{tabulary}
10172 @cindex #+ATTR_LaTeX
10174 #+CAPTION: A wide table with tabulary
10176 #+ATTR_LaTeX: table* tabulary width=\textwidth
10181 @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
10182 @subsection Images in @LaTeX{} export
10183 @cindex images, inline in @LaTeX{}
10184 @cindex inlining images in @LaTeX{}
10186 Images that are linked to without a description part in the link, like
10187 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10188 output file resulting from @LaTeX{} processing. Org will use an
10189 @code{\includegraphics} macro to insert the image. If you have specified a
10190 caption and/or a label as described in @ref{Images and tables}, the figure
10191 will be wrapped into a @code{figure} environment and thus become a floating
10192 element. You can use an @code{#+ATTR_LaTeX:} line to specify the various
10193 options that can be used in the optional argument of the
10194 @code{\includegraphics} macro. To modify the placement option of the
10195 @code{figure} environment, add something like @samp{placement=[h!]} to the
10198 If you would like to let text flow around the image, add the word @samp{wrap}
10199 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10200 half of the page. To fine-tune, the @code{placement} field will be the set
10201 of additional arguments needed by the @code{wrapfigure} environment. Note
10202 that if you change the size of the image, you need to use compatible settings
10203 for @code{\includegraphics} and @code{wrapfigure}.
10207 @cindex #+ATTR_LaTeX
10209 #+CAPTION: The black-body emission of the disk around HR 4049
10210 #+LABEL: fig:SED-HR4049
10211 #+ATTR_LaTeX: width=5cm,angle=90
10212 [[./img/sed-hr4049.pdf]]
10214 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10218 If you need references to a label created in this way, write
10219 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10221 @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export
10222 @subsection Beamer class export
10224 The LaTeX class @file{beamer} allows production of high quality presentations
10225 using LaTeX and pdf processing. Org-mode has special support for turning an
10226 Org-mode file or tree into a @file{beamer} presentation.
10228 When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS:
10229 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10230 @code{beamer}, a special export mode will turn the file or tree into a beamer
10231 presentation. Any tree with not-too-deep level nesting should in principle be
10232 exportable as a beamer presentation. By default, the top-level entries (or
10233 the first level below the selected subtree heading) will be turned into
10234 frames, and the outline structure below this level will become itemize lists.
10235 You can also configure the variable @code{org-beamer-frame-level} to a
10236 different level---then the hierarchy above frames will produce the sectioning
10237 structure of the presentation.
10239 A template for useful in-buffer settings or properties can be inserted into
10240 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10241 things, this will install a column view format which is very handy for
10242 editing special properties used by beamer.
10244 You can influence the structure of the presentation using the following
10249 The environment that should be used to format this entry. Valid environments
10250 are defined in the constant @code{org-beamer-environments-default}, and you
10251 can define more in @code{org-beamer-environments-extra}. If this property is
10252 set, the entry will also get a @code{:B_environment:} tag to make this
10253 visible. This tag has no semantic meaning, it is only a visual aid.
10254 @item BEAMER_envargs
10255 The beamer-special arguments that should be used for the environment, like
10256 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10257 property is also set, something like @code{C[t]} can be added here as well to
10258 set an options argument for the implied @code{columns} environment.
10259 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10262 The width of a column that should start with this entry. If this property is
10263 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10264 Also this tag is only a visual aid. When this is a plain number, it will be
10265 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10266 that you have specified the units, like @samp{3cm}. The first such property
10267 in a frame will start a @code{columns} environment to surround the columns.
10268 This environment is closed when an entry has a @code{BEAMER_col} property
10269 with value 0 or 1, or automatically at the end of the frame.
10271 Additional commands that should be inserted after the environment has been
10272 opened. For example, when creating a frame, this can be used to specify
10276 Frames will automatically receive a @code{fragile} option if they contain
10277 source code that uses the verbatim environment. Special @file{beamer}
10278 specific code can be inserted using @code{#+BEAMER:} and
10279 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
10280 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10281 in the presentation as well.
10283 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10284 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10285 into @code{\note@{...@}}. The former will include the heading as part of the
10286 note text, the latter will ignore the heading of that node. To simplify note
10287 generation, it is actually enough to mark the note with a @emph{tag} (either
10288 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10289 @code{BEAMER_env} property.
10291 You can turn on a special minor mode @code{org-beamer-mode} for editing
10299 @orgcmd{C-c C-b,org-beamer-select-environment}
10300 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10301 environment or the @code{BEAMER_col} property.
10304 Column view provides a great way to set the environment of a node and other
10305 important parameters. Make sure you are using a COLUMN format that is geared
10306 toward this special purpose. The command @kbd{M-x
10307 org-insert-beamer-options-template} defines such a format.
10309 Here is a simple example Org document that is intended for beamer export.
10312 #+LaTeX_CLASS: beamer
10313 #+TITLE: Example Presentation
10314 #+AUTHOR: Carsten Dominik
10315 #+LaTeX_CLASS_OPTIONS: [presentation]
10316 #+BEAMER_FRAME_LEVEL: 2
10317 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10318 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10320 * This is the first structural section
10322 ** Frame 1 \\ with a subtitle
10323 *** Thanks to Eric Fraga :BMCOL:B_block:
10326 :BEAMER_envargs: C[t]
10329 for the first viable beamer setup in Org
10330 *** Thanks to everyone else :BMCOL:B_block:
10334 :BEAMER_envargs: <2->
10336 for contributing to the discussion
10337 **** This will be formatted as a beamer note :B_note:
10338 ** Frame 2 \\ where we will not use columns
10339 *** Request :B_block:
10340 Please test this stuff!
10346 For more information, see the documentation on Worg.
10348 @node DocBook export, TaskJuggler export, LaTeX and PDF export, Exporting
10349 @section DocBook export
10350 @cindex DocBook export
10352 @cindex Cui, Baoqiu
10354 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10355 exported to DocBook format, it can be further processed to produce other
10356 formats, including PDF, HTML, man pages, etc., using many available DocBook
10357 tools and stylesheets.
10359 Currently DocBook exporter only supports DocBook V5.0.
10362 * DocBook export commands:: How to invoke DocBook export
10363 * Quoting DocBook code:: Incorporating DocBook code in Org files
10364 * Recursive sections:: Recursive sections in DocBook
10365 * Tables in DocBook export:: Tables are exported as HTML tables
10366 * Images in DocBook export:: How to insert figures into DocBook output
10367 * Special characters:: How to handle special characters
10370 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10371 @subsection DocBook export commands
10373 @cindex region, active
10374 @cindex active region
10375 @cindex transient-mark-mode
10377 @orgcmd{C-c C-e D,org-export-as-docbook}
10378 @cindex property EXPORT_FILE_NAME
10379 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10380 file will be @file{myfile.xml}. The file will be overwritten without
10381 warning. If there is an active region@footnote{This requires
10382 @code{transient-mark-mode} to be turned on}, only the region will be
10383 exported. If the selected region is a single tree@footnote{To select the
10384 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10385 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10386 property, that name will be used for the export.
10387 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10388 Export as DocBook file, process to PDF, then open the resulting PDF file.
10390 @vindex org-export-docbook-xslt-proc-command
10391 @vindex org-export-docbook-xsl-fo-proc-command
10392 Note that, in order to produce PDF output based on exported DocBook file, you
10393 need to have XSLT processor and XSL-FO processor software installed on your
10394 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10395 @code{org-export-docbook-xsl-fo-proc-command}.
10397 @vindex org-export-docbook-xslt-stylesheet
10398 The stylesheet argument @code{%s} in variable
10399 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10400 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10401 the user. You can also overrule this global setting on a per-file basis by
10402 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10404 @orgkey{C-c C-e v D}
10405 Export only the visible part of the document.
10408 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10409 @subsection Quoting DocBook code
10411 You can quote DocBook code in Org files and copy it verbatim into exported
10412 DocBook file with the following constructs:
10415 @cindex #+BEGIN_DOCBOOK
10417 #+DOCBOOK: Literal DocBook code for export
10421 @cindex #+BEGIN_DOCBOOK
10425 All lines between these markers are exported by DocBook exporter
10430 For example, you can use the following lines to include a DocBook warning
10431 admonition. As to what this warning says, you should pay attention to the
10432 document context when quoting DocBook code in Org files. You may make
10433 exported DocBook XML files invalid by not quoting DocBook code correctly.
10438 <para>You should know what you are doing when quoting DocBook XML code
10439 in your Org file. Invalid DocBook XML may be generated by
10440 DocBook exporter if you are not careful!</para>
10445 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10446 @subsection Recursive sections
10447 @cindex DocBook recursive sections
10449 DocBook exporter exports Org files as articles using the @code{article}
10450 element in DocBook. Recursive sections, i.e.@: @code{section} elements, are
10451 used in exported articles. Top level headlines in Org files are exported as
10452 top level sections, and lower level headlines are exported as nested
10453 sections. The entire structure of Org files will be exported completely, no
10454 matter how many nested levels of headlines there are.
10456 Using recursive sections makes it easy to port and reuse exported DocBook
10457 code in other DocBook document types like @code{book} or @code{set}.
10459 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10460 @subsection Tables in DocBook export
10461 @cindex tables, in DocBook export
10463 Tables in Org files are exported as HTML tables, which have been supported since
10466 If a table does not have a caption, an informal table is generated using the
10467 @code{informaltable} element; otherwise, a formal table will be generated
10468 using the @code{table} element.
10470 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10471 @subsection Images in DocBook export
10472 @cindex images, inline in DocBook
10473 @cindex inlining images in DocBook
10475 Images that are linked to without a description part in the link, like
10476 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10477 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10478 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10479 specified a caption for an image as described in @ref{Images and tables}, a
10480 @code{caption} element will be added in @code{mediaobject}. If a label is
10481 also specified, it will be exported as an @code{xml:id} attribute of the
10482 @code{mediaobject} element.
10484 @vindex org-export-docbook-default-image-attributes
10485 Image attributes supported by the @code{imagedata} element, like @code{align}
10486 or @code{width}, can be specified in two ways: you can either customize
10487 variable @code{org-export-docbook-default-image-attributes} or use the
10488 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10489 @code{org-export-docbook-default-image-attributes} are applied to all inline
10490 images in the Org file to be exported (unless they are overridden by image
10491 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10493 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10494 attributes or override default image attributes for individual images. If
10495 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10496 variable @code{org-export-docbook-default-image-attributes}, the former
10497 takes precedence. Here is an example about how image attributes can be
10502 @cindex #+ATTR_DOCBOOK
10504 #+CAPTION: The logo of Org-mode
10505 #+LABEL: unicorn-svg
10506 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10507 [[./img/org-mode-unicorn.svg]]
10510 @vindex org-export-docbook-inline-image-extensions
10511 By default, DocBook exporter recognizes the following image file types:
10512 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10513 customize variable @code{org-export-docbook-inline-image-extensions} to add
10514 more types to this list as long as DocBook supports them.
10516 @node Special characters, , Images in DocBook export, DocBook export
10517 @subsection Special characters in DocBook export
10518 @cindex Special characters in DocBook export
10520 @vindex org-export-docbook-doctype
10521 @vindex org-entities
10522 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10523 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10524 characters are rewritten to XML entities, like @code{α},
10525 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10526 @code{org-entities}. As long as the generated DocBook file includes the
10527 corresponding entities, these special characters are recognized.
10529 You can customize variable @code{org-export-docbook-doctype} to include the
10530 entities you need. For example, you can set variable
10531 @code{org-export-docbook-doctype} to the following value to recognize all
10532 special characters included in XHTML entities:
10535 "<!DOCTYPE article [
10536 <!ENTITY % xhtml1-symbol PUBLIC
10537 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10538 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10545 @node TaskJuggler export, Freemind export, DocBook export, Exporting
10546 @section TaskJuggler export
10547 @cindex TaskJuggler export
10548 @cindex Project management
10550 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
10551 It provides an optimizing scheduler that computes your project time lines and
10552 resource assignments based on the project outline and the constraints that
10555 The TaskJuggler exporter is a bit different from other exporters, such as the
10556 HTML and LaTeX exporters for example, in that it does not export all the
10557 nodes of a document or strictly follow the order of the nodes in the
10560 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
10561 a optionally tree that defines the resources for this project. It then
10562 creates a TaskJuggler file based on these trees and the attributes defined in
10565 @subsection TaskJuggler export commands
10568 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
10569 Export as TaskJuggler file.
10571 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
10572 Export as TaskJuggler file and then open the file with TaskJugglerUI.
10577 @vindex org-export-taskjuggler-project-tag
10578 Create your tasks as you usually do with Org-mode. Assign efforts to each
10579 task using properties (it's easiest to do this in the column view). You
10580 should end up with something similar to the example by Peter Jones in
10581 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
10582 Now mark the top node of your tasks with a tag named
10583 @code{:taskjuggler_project:} (or whatever you customized
10584 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
10585 the project plan with @kbd{C-c C-e J} which will export the project plan and
10586 open a gantt chart in TaskJugglerUI.
10588 @subsection Resources
10590 @vindex org-export-taskjuggler-resource-tag
10591 Next you can define resources and assign those to work on specific tasks. You
10592 can group your resources hierarchically. Tag the top node of the resources
10593 with @code{:taskjuggler_resource:} (or whatever you customized
10594 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
10595 identifier (named @samp{resource_id}) to the resources (using the standard
10596 Org properties commands, @pxref{Property syntax}) or you can let the exporter
10597 generate identifiers automatically (the exporter picks the first word of the
10598 headline as the identifier as long as it is unique---see the documentation of
10599 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
10600 allocate resources to tasks. This is again done with the @samp{allocate}
10601 property on the tasks. Do this in column view or when on the task type
10602 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
10604 Once the allocations are done you can again export to TaskJuggler and check
10605 in the Resource Allocation Graph which person is working on what task at what
10608 @subsection Export of properties
10610 The exporter also takes TODO state information into consideration, i.e.@: if a
10611 task is marked as done it will have the corresponding attribute in
10612 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
10613 resource or resource node which is known to TaskJuggler, such as
10614 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
10615 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
10616 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
10617 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
10618 @samp{scheduling}, etc for tasks.
10620 @subsection Dependencies
10622 The exporter will handle dependencies that are defined in the tasks either
10623 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
10624 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
10625 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
10626 attribute can be either @samp{previous-sibling} or a reference to an
10627 identifier (named @samp{task_id}) which is defined for another task in the
10628 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
10629 dependencies separated by either space or comma. You can also specify
10630 optional attributes on the dependency by simply appending it. The following
10631 examples should illustrate this:
10636 :task_id: preparation
10639 * Training material
10641 :task_id: training_material
10644 ** Markup Guidelines
10648 ** Workflow Guidelines
10655 :BLOCKER: training_material @{ gapduration 1d @} preparation
10659 @subsection Reports
10661 @vindex org-export-taskjuggler-default-reports
10662 TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
10663 allocation, etc). The user defines what kind of reports should be generated
10664 for a project in the TaskJuggler file. The exporter will automatically insert
10665 some default reports in the file. These defaults are defined in
10666 @code{org-export-taskjuggler-default-reports}. They can be modified using
10667 customize along with a number of other options. For a more complete list, see
10668 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
10670 For more information and examples see the Org-taskjuggler tutorial at
10671 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
10673 @node Freemind export, XOXO export, TaskJuggler export, Exporting
10674 @section Freemind export
10675 @cindex Freemind export
10678 The Freemind exporter was written by Lennart Borgman.
10681 @orgcmd{C-c C-e m,org-export-as-freemind}
10682 Export as Freemind mind map @file{myfile.mm}.
10685 @node XOXO export, iCalendar export, Freemind export, Exporting
10686 @section XOXO export
10687 @cindex XOXO export
10689 Org-mode contains an exporter that produces XOXO-style output.
10690 Currently, this exporter only handles the general outline structure and
10691 does not interpret any additional Org-mode features.
10694 @orgcmd{C-c C-e x,org-export-as-xoxo}
10695 Export as XOXO file @file{myfile.html}.
10696 @orgkey{C-c C-e v x}
10697 Export only the visible part of the document.
10700 @node iCalendar export, , XOXO export, Exporting
10701 @section iCalendar export
10702 @cindex iCalendar export
10704 @vindex org-icalendar-include-todo
10705 @vindex org-icalendar-use-deadline
10706 @vindex org-icalendar-use-scheduled
10707 @vindex org-icalendar-categories
10708 @vindex org-icalendar-alarm-time
10709 Some people use Org-mode for keeping track of projects, but still prefer a
10710 standard calendar application for anniversaries and appointments. In this
10711 case it can be useful to show deadlines and other time-stamped items in Org
10712 files in the calendar application. Org-mode can export calendar information
10713 in the standard iCalendar format. If you also want to have TODO entries
10714 included in the export, configure the variable
10715 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
10716 and TODO items as VTODO. It will also create events from deadlines that are
10717 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
10718 to set the start and due dates for the TODO entry@footnote{See the variables
10719 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
10720 As categories, it will use the tags locally defined in the heading, and the
10721 file/tree category@footnote{To add inherited tags or the TODO state,
10722 configure the variable @code{org-icalendar-categories}.}. See the variable
10723 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
10726 @vindex org-icalendar-store-UID
10727 @cindex property, ID
10728 The iCalendar standard requires each entry to have a globally unique
10729 identifier (UID). Org creates these identifiers during export. If you set
10730 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
10731 @code{:ID:} property of the entry and re-used next time you report this
10732 entry. Since a single entry can give rise to multiple iCalendar entries (as
10733 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
10734 prefixes to the UID, depending on what triggered the inclusion of the entry.
10735 In this way the UID remains unique, but a synchronization program can still
10736 figure out from which entry all the different instances originate.
10739 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
10740 Create iCalendar entries for the current file and store them in the same
10741 directory, using a file extension @file{.ics}.
10742 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
10743 @vindex org-agenda-files
10744 Like @kbd{C-c C-e i}, but do this for all files in
10745 @code{org-agenda-files}. For each of these files, a separate iCalendar
10746 file will be written.
10747 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
10748 @vindex org-combined-agenda-icalendar-file
10749 Create a single large iCalendar file from all files in
10750 @code{org-agenda-files} and write it to the file given by
10751 @code{org-combined-agenda-icalendar-file}.
10754 @vindex org-use-property-inheritance
10755 @vindex org-icalendar-include-body
10756 @cindex property, SUMMARY
10757 @cindex property, DESCRIPTION
10758 @cindex property, LOCATION
10759 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
10760 property can be inherited from higher in the hierarchy if you configure
10761 @code{org-use-property-inheritance} accordingly.} properties if the selected
10762 entries have them. If not, the summary will be derived from the headline,
10763 and the description from the body (limited to
10764 @code{org-icalendar-include-body} characters).
10766 How this calendar is best read and updated, depends on the application
10767 you are using. The FAQ covers this issue.
10769 @node Publishing, Working With Source Code, Exporting, Top
10770 @chapter Publishing
10773 Org includes a publishing management system that allows you to configure
10774 automatic HTML conversion of @emph{projects} composed of interlinked org
10775 files. You can also configure Org to automatically upload your exported HTML
10776 pages and related attachments, such as images and source code files, to a web
10779 You can also use Org to convert files into PDF, or even combine HTML and PDF
10780 conversion so that files are available in both formats on the server.
10782 Publishing has been contributed to Org by David O'Toole.
10785 * Configuration:: Defining projects
10786 * Uploading files:: How to get files up on the server
10787 * Sample configuration:: Example projects
10788 * Triggering publication:: Publication commands
10791 @node Configuration, Uploading files, Publishing, Publishing
10792 @section Configuration
10794 Publishing needs significant configuration to specify files, destination
10795 and many other properties of a project.
10798 * Project alist:: The central configuration variable
10799 * Sources and destinations:: From here to there
10800 * Selecting files:: What files are part of the project?
10801 * Publishing action:: Setting the function doing the publishing
10802 * Publishing options:: Tweaking HTML/@LaTeX{} export
10803 * Publishing links:: Which links keep working after publishing?
10804 * Sitemap:: Generating a list of all pages
10805 * Generating an index:: An index that reaches across pages
10808 @node Project alist, Sources and destinations, Configuration, Configuration
10809 @subsection The variable @code{org-publish-project-alist}
10810 @cindex org-publish-project-alist
10811 @cindex projects, for publishing
10813 @vindex org-publish-project-alist
10814 Publishing is configured almost entirely through setting the value of one
10815 variable, called @code{org-publish-project-alist}. Each element of the list
10816 configures one project, and may be in one of the two following forms:
10819 ("project-name" :property value :property value ...)
10820 @r{i.e.@: a well-formed property list with alternating keys and values}
10822 ("project-name" :components ("project-name" "project-name" ...))
10826 In both cases, projects are configured by specifying property values. A
10827 project defines the set of files that will be published, as well as the
10828 publishing configuration to use when publishing those files. When a project
10829 takes the second form listed above, the individual members of the
10830 @code{:components} property are taken to be sub-projects, which group
10831 together files requiring different publishing options. When you publish such
10832 a ``meta-project'', all the components will also be published, in the
10835 @node Sources and destinations, Selecting files, Project alist, Configuration
10836 @subsection Sources and destinations for files
10837 @cindex directories, for publishing
10839 Most properties are optional, but some should always be set. In
10840 particular, Org needs to know where to look for source files,
10841 and where to put published files.
10843 @multitable @columnfractions 0.3 0.7
10844 @item @code{:base-directory}
10845 @tab Directory containing publishing source files
10846 @item @code{:publishing-directory}
10847 @tab Directory where output files will be published. You can directly
10848 publish to a webserver using a file name syntax appropriate for
10849 the Emacs @file{tramp} package. Or you can publish to a local directory and
10850 use external tools to upload your website (@pxref{Uploading files}).
10851 @item @code{:preparation-function}
10852 @tab Function or list of functions to be called before starting the
10853 publishing process, for example, to run @code{make} for updating files to be
10854 published. The project property list is scoped into this call as the
10855 variable @code{project-plist}.
10856 @item @code{:completion-function}
10857 @tab Function or list of functions called after finishing the publishing
10858 process, for example, to change permissions of the resulting files. The
10859 project property list is scoped into this call as the variable
10860 @code{project-plist}.
10864 @node Selecting files, Publishing action, Sources and destinations, Configuration
10865 @subsection Selecting files
10866 @cindex files, selecting for publishing
10868 By default, all files with extension @file{.org} in the base directory
10869 are considered part of the project. This can be modified by setting the
10871 @multitable @columnfractions 0.25 0.75
10872 @item @code{:base-extension}
10873 @tab Extension (without the dot!) of source files. This actually is a
10874 regular expression. Set this to the symbol @code{any} if you want to get all
10875 files in @code{:base-directory}, even without extension.
10877 @item @code{:exclude}
10878 @tab Regular expression to match file names that should not be
10879 published, even though they have been selected on the basis of their
10882 @item @code{:include}
10883 @tab List of files to be included regardless of @code{:base-extension}
10884 and @code{:exclude}.
10886 @item @code{:recursive}
10887 @tab Non-nil means, check base-directory recursively for files to publish.
10890 @node Publishing action, Publishing options, Selecting files, Configuration
10891 @subsection Publishing action
10892 @cindex action, for publishing
10894 Publishing means that a file is copied to the destination directory and
10895 possibly transformed in the process. The default transformation is to export
10896 Org files as HTML files, and this is done by the function
10897 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
10898 export}). But you also can publish your content as PDF files using
10899 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
10900 @code{utf8} encoded files using the corresponding functions. If you want to
10901 publish the Org file itself, but with @i{archived}, @i{commented}, and
10902 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
10903 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
10904 produce @file{file.org} and @file{file.org.html} in the publishing
10905 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
10906 source and publishing directories are equal. Note that with this kind of
10907 setup, you need to add @code{:exclude "-source\\.org"} to the project
10908 definition in @code{org-publish-project-alist} to prevent the published
10909 source files from being considered as new org files the next time the project
10910 is published.}. Other files like images only need to be copied to the
10911 publishing destination; for this you may use @code{org-publish-attachment}.
10912 For non-Org files, you always need to specify the publishing function:
10914 @multitable @columnfractions 0.3 0.7
10915 @item @code{:publishing-function}
10916 @tab Function executing the publication of a file. This may also be a
10917 list of functions, which will all be called in turn.
10918 @item @code{:plain-source}
10919 @tab Non-nil means, publish plain source.
10920 @item @code{:htmlized-source}
10921 @tab Non-nil means, publish htmlized source.
10924 The function must accept three arguments: a property list containing at least
10925 a @code{:publishing-directory} property, the name of the file to be
10926 published, and the path to the publishing directory of the output file. It
10927 should take the specified file, make the necessary transformation (if any)
10928 and place the result into the destination folder.
10930 @node Publishing options, Publishing links, Publishing action, Configuration
10931 @subsection Options for the HTML/@LaTeX{} exporters
10932 @cindex options, for publishing
10934 The property list can be used to set many export options for the HTML
10935 and @LaTeX{} exporters. In most cases, these properties correspond to user
10936 variables in Org. The table below lists these properties along
10937 with the variable they belong to. See the documentation string for the
10938 respective variable for details.
10940 @vindex org-export-html-link-up
10941 @vindex org-export-html-link-home
10942 @vindex org-export-default-language
10943 @vindex org-display-custom-times
10944 @vindex org-export-headline-levels
10945 @vindex org-export-with-section-numbers
10946 @vindex org-export-section-number-format
10947 @vindex org-export-with-toc
10948 @vindex org-export-preserve-breaks
10949 @vindex org-export-with-archived-trees
10950 @vindex org-export-with-emphasize
10951 @vindex org-export-with-sub-superscripts
10952 @vindex org-export-with-special-strings
10953 @vindex org-export-with-footnotes
10954 @vindex org-export-with-drawers
10955 @vindex org-export-with-tags
10956 @vindex org-export-with-todo-keywords
10957 @vindex org-export-with-tasks
10958 @vindex org-export-with-done-tasks
10959 @vindex org-export-with-priority
10960 @vindex org-export-with-TeX-macros
10961 @vindex org-export-with-LaTeX-fragments
10962 @vindex org-export-skip-text-before-1st-heading
10963 @vindex org-export-with-fixed-width
10964 @vindex org-export-with-timestamps
10965 @vindex org-export-author-info
10966 @vindex org-export-email-info
10967 @vindex org-export-creator-info
10968 @vindex org-export-time-stamp-file
10969 @vindex org-export-with-tables
10970 @vindex org-export-highlight-first-table-line
10971 @vindex org-export-html-style-include-default
10972 @vindex org-export-html-style-include-scripts
10973 @vindex org-export-html-style
10974 @vindex org-export-html-style-extra
10975 @vindex org-export-html-link-org-files-as-html
10976 @vindex org-export-html-inline-images
10977 @vindex org-export-html-extension
10978 @vindex org-export-html-table-tag
10979 @vindex org-export-html-expand
10980 @vindex org-export-html-with-timestamp
10981 @vindex org-export-publishing-directory
10982 @vindex org-export-html-preamble
10983 @vindex org-export-html-postamble
10984 @vindex user-full-name
10985 @vindex user-mail-address
10986 @vindex org-export-select-tags
10987 @vindex org-export-exclude-tags
10989 @multitable @columnfractions 0.32 0.68
10990 @item @code{:link-up} @tab @code{org-export-html-link-up}
10991 @item @code{:link-home} @tab @code{org-export-html-link-home}
10992 @item @code{:language} @tab @code{org-export-default-language}
10993 @item @code{:customtime} @tab @code{org-display-custom-times}
10994 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
10995 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
10996 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
10997 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
10998 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
10999 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
11000 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
11001 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
11002 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
11003 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
11004 @item @code{:drawers} @tab @code{org-export-with-drawers}
11005 @item @code{:tags} @tab @code{org-export-with-tags}
11006 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
11007 @item @code{:tasks} @tab @code{org-export-with-tasks}
11008 @item @code{:priority} @tab @code{org-export-with-priority}
11009 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
11010 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
11011 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
11012 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
11013 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
11014 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
11015 @item @code{:author} @tab @code{user-full-name}
11016 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
11017 @item @code{:author-info} @tab @code{org-export-author-info}
11018 @item @code{:email-info} @tab @code{org-export-email-info}
11019 @item @code{:creator-info} @tab @code{org-export-creator-info}
11020 @item @code{:tables} @tab @code{org-export-with-tables}
11021 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
11022 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
11023 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
11024 @item @code{:style} @tab @code{org-export-html-style}
11025 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
11026 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
11027 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
11028 @item @code{:html-extension} @tab @code{org-export-html-extension}
11029 @item @code{:html-preamble} @tab @code{org-export-html-preamble}
11030 @item @code{:html-postamble} @tab @code{org-export-html-postamble}
11031 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
11032 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
11033 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
11034 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
11035 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
11036 @item @code{:select-tags} @tab @code{org-export-select-tags}
11037 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
11038 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
11041 Most of the @code{org-export-with-*} variables have the same effect in
11042 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
11043 @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
11044 @LaTeX{} export. See @code{org-export-plist-vars} to check this list of
11049 @vindex org-publish-project-alist
11050 When a property is given a value in @code{org-publish-project-alist},
11051 its setting overrides the value of the corresponding user variable (if
11052 any) during publishing. Options set within a file (@pxref{Export
11053 options}), however, override everything.
11055 @node Publishing links, Sitemap, Publishing options, Configuration
11056 @subsection Links between published files
11057 @cindex links, publishing
11059 To create a link from one Org file to another, you would use
11060 something like @samp{[[file:foo.org][The foo]]} or simply
11061 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
11062 becomes a link to @file{foo.html}. In this way, you can interlink the
11063 pages of your "org web" project and the links will work as expected when
11064 you publish them to HTML. If you also publish the Org source file and want
11065 to link to that, use an @code{http:} link instead of a @code{file:} link,
11066 because @code{file:} links are converted to link to the corresponding
11069 You may also link to related files, such as images. Provided you are careful
11070 with relative file names, and provided you have also configured Org to upload
11071 the related files, these links will work too. See @ref{Complex example}, for
11072 an example of this usage.
11074 Sometimes an Org file to be published may contain links that are
11075 only valid in your production environment, but not in the publishing
11076 location. In this case, use the property
11078 @multitable @columnfractions 0.4 0.6
11079 @item @code{:link-validation-function}
11080 @tab Function to validate links
11084 to define a function for checking link validity. This function must
11085 accept two arguments, the file name and a directory relative to which
11086 the file name is interpreted in the production environment. If this
11087 function returns @code{nil}, then the HTML generator will only insert a
11088 description into the HTML file, but no link. One option for this
11089 function is @code{org-publish-validate-link} which checks if the given
11090 file is part of any project in @code{org-publish-project-alist}.
11092 @node Sitemap, Generating an index, Publishing links, Configuration
11093 @subsection Generating a sitemap
11094 @cindex sitemap, of published pages
11096 The following properties may be used to control publishing of
11097 a map of files for a given project.
11099 @multitable @columnfractions 0.35 0.65
11100 @item @code{:auto-sitemap}
11101 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
11102 or @code{org-publish-all}.
11104 @item @code{:sitemap-filename}
11105 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
11106 becomes @file{sitemap.html}).
11108 @item @code{:sitemap-title}
11109 @tab Title of sitemap page. Defaults to name of file.
11111 @item @code{:sitemap-function}
11112 @tab Plug-in function to use for generation of the sitemap.
11113 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
11114 of links to all files in the project.
11116 @item @code{:sitemap-sort-folders}
11117 @tab Where folders should appear in the sitemap. Set this to @code{first}
11118 (default) or @code{last} to display folders first or last,
11119 respectively. Any other value will mix files and folders.
11121 @item @code{:sitemap-sort-files}
11122 @tab How the files are sorted in the site map. Set this to
11123 @code{alphabetically} (default), @code{chronologically} or
11124 @code{anti-chronologically}. @code{chronologically} sorts the files with
11125 older date first while @code{anti-chronologically} sorts the files with newer
11126 date first. @code{alphabetically} sorts the files alphabetically. The date of
11127 a file is retrieved with @code{org-publish-find-date}.
11129 @item @code{:sitemap-ignore-case}
11130 @tab Should sorting be case-sensitive? Default @code{nil}.
11132 @item @code{:sitemap-file-entry-format}
11133 @tab With this option one can tell how a sitemap's entry is formated in the
11134 sitemap. This is a format string with some escape sequences: @code{%t} stands
11135 for the title of the file, @code{%a} stands for the author of the file and
11136 @code{%d} stands for the date of the file. The date is retrieved with the
11137 @code{org-publish-find-date} function and formated with
11138 @code{org-publish-sitemap-date-format}. Default @code{%t}.
11140 @item @code{:sitemap-date-format}
11141 @tab Format string for the @code{format-time-string} function that tells how
11142 a sitemap entry's date is to be formated. This property bypasses
11143 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
11147 @node Generating an index, , Sitemap, Configuration
11148 @subsection Generating an index
11149 @cindex index, in a publishing project
11151 Org-mode can generate an index across the files of a publishing project.
11153 @multitable @columnfractions 0.25 0.75
11154 @item @code{:makeindex}
11155 @tab When non-nil, generate in index in the file @file{theindex.org} and
11156 publish it as @file{theindex.html}.
11159 The file will be created when first publishing a project with the
11160 @code{:makeindex} set. The file only contains a statement @code{#+include:
11161 "theindex.inc"}. You can then build around this include statement by adding
11162 a title, style information, etc.
11164 @node Uploading files, Sample configuration, Configuration, Publishing
11165 @section Uploading files
11169 For those people already utilizing third party sync tools such as
11170 @command{rsync} or @command{unison}, it might be preferable not to use the built in
11171 @i{remote} publishing facilities of Org-mode which rely heavily on
11172 Tramp. Tramp, while very useful and powerful, tends not to be
11173 so efficient for multiple file transfer and has been known to cause problems
11176 Specialized synchronization utilities offer several advantages. In addition
11177 to timestamp comparison, they also do content and permissions/attribute
11178 checks. For this reason you might prefer to publish your web to a local
11179 directory (possibly even @i{in place} with your Org files) and then use
11180 @file{unison} or @file{rsync} to do the synchronization with the remote host.
11182 Since Unison (for example) can be configured as to which files to transfer to
11183 a certain remote destination, it can greatly simplify the project publishing
11184 definition. Simply keep all files in the correct location, process your Org
11185 files with @code{org-publish} and let the synchronization tool do the rest.
11186 You do not need, in this scenario, to include attachments such as @file{jpg},
11187 @file{css} or @file{gif} files in the project definition since the 3rd party
11190 Publishing to a local directory is also much faster than to a remote one, so
11191 that you can afford more easily to republish entire projects. If you set
11192 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
11193 benefit of re-including any changed external files such as source example
11194 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
11195 Org is not smart enough to detect if included files have been modified.
11197 @node Sample configuration, Triggering publication, Uploading files, Publishing
11198 @section Sample configuration
11200 Below we provide two example configurations. The first one is a simple
11201 project publishing only a set of Org files. The second example is
11202 more complex, with a multi-component project.
11205 * Simple example:: One-component publishing
11206 * Complex example:: A multi-component publishing example
11209 @node Simple example, Complex example, Sample configuration, Sample configuration
11210 @subsection Example: simple publishing configuration
11212 This example publishes a set of Org files to the @file{public_html}
11213 directory on the local machine.
11216 (setq org-publish-project-alist
11218 :base-directory "~/org/"
11219 :publishing-directory "~/public_html"
11220 :section-numbers nil
11221 :table-of-contents nil
11222 :style "<link rel=\"stylesheet\"
11223 href=\"../other/mystyle.css\"
11224 type=\"text/css\"/>")))
11227 @node Complex example, , Simple example, Sample configuration
11228 @subsection Example: complex publishing configuration
11230 This more complicated example publishes an entire website, including
11231 Org files converted to HTML, image files, Emacs Lisp source code, and
11232 style sheets. The publishing directory is remote and private files are
11235 To ensure that links are preserved, care should be taken to replicate
11236 your directory structure on the web server, and to use relative file
11237 paths. For example, if your Org files are kept in @file{~/org} and your
11238 publishable images in @file{~/images}, you would link to an image with
11241 file:../images/myimage.png
11244 On the web server, the relative path to the image should be the
11245 same. You can accomplish this by setting up an "images" folder in the
11246 right place on the web server, and publishing images to it.
11249 (setq org-publish-project-alist
11251 :base-directory "~/org/"
11252 :base-extension "org"
11253 :publishing-directory "/ssh:user@@host:~/html/notebook/"
11254 :publishing-function org-publish-org-to-html
11255 :exclude "PrivatePage.org" ;; regexp
11257 :section-numbers nil
11258 :table-of-contents nil
11259 :style "<link rel=\"stylesheet\"
11260 href=\"../other/mystyle.css\" type=\"text/css\"/>"
11264 :base-directory "~/images/"
11265 :base-extension "jpg\\|gif\\|png"
11266 :publishing-directory "/ssh:user@@host:~/html/images/"
11267 :publishing-function org-publish-attachment)
11270 :base-directory "~/other/"
11271 :base-extension "css\\|el"
11272 :publishing-directory "/ssh:user@@host:~/html/other/"
11273 :publishing-function org-publish-attachment)
11274 ("website" :components ("orgfiles" "images" "other"))))
11277 @node Triggering publication, , Sample configuration, Publishing
11278 @section Triggering publication
11280 Once properly configured, Org can publish with the following commands:
11283 @orgcmd{C-c C-e X,org-publish}
11284 Prompt for a specific project and publish all files that belong to it.
11285 @orgcmd{C-c C-e P,org-publish-current-project}
11286 Publish the project containing the current file.
11287 @orgcmd{C-c C-e F,org-publish-current-file}
11288 Publish only the current file.
11289 @orgcmd{C-c C-e E,org-publish-all}
11290 Publish every project.
11293 @vindex org-publish-use-timestamps-flag
11294 Org uses timestamps to track when a file has changed. The above functions
11295 normally only publish changed files. You can override this and force
11296 publishing of all files by giving a prefix argument to any of the commands
11297 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
11298 This may be necessary in particular if files include other files via
11299 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
11301 @comment node-name, next, previous, up
11302 @comment Working With Source Code, Miscellaneous, Publishing, Top
11304 @node Working With Source Code, Miscellaneous, Publishing, Top
11305 @chapter Working with source code
11306 @cindex Schulte, Eric
11307 @cindex Davison, Dan
11308 @cindex source code, working with
11310 Source code can be included in Org-mode documents using a @samp{src} block,
11314 #+BEGIN_SRC emacs-lisp
11315 (defun org-xor (a b)
11321 Org-mode provides a number of features for working with live source code,
11322 including editing of code blocks in their native major-mode, evaluation of
11323 code blocks, converting code blocks into source files (known as @dfn{tangling}
11324 in literate programming), and exporting code blocks and their
11325 results in several formats. This functionality was contributed by Eric
11326 Schulte and Dan Davison, and was originally named Org-babel.
11328 The following sections describe Org-mode's code block handling facilities.
11331 * Structure of code blocks:: Code block syntax described
11332 * Editing source code:: Language major-mode editing
11333 * Exporting code blocks:: Export contents and/or results
11334 * Extracting source code:: Create pure source code files
11335 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
11336 * Library of Babel:: Use and contribute to a library of useful code blocks
11337 * Languages:: List of supported code block languages
11338 * Header arguments:: Configure code block functionality
11339 * Results of evaluation:: How evaluation results are handled
11340 * Noweb reference syntax:: Literate programming in Org-mode
11341 * Key bindings and useful functions:: Work quickly with code blocks
11342 * Batch execution:: Call functions from the command line
11345 @comment node-name, next, previous, up
11346 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11348 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11349 @section Structure of code blocks
11350 @cindex code block, structure
11351 @cindex source code, block structure
11353 The structure of code blocks is as follows:
11357 #+begin_src <language> <switches> <header arguments>
11362 Switches and header arguments are optional. Code can also be embedded in text
11366 src_<language>@{<body>@}
11372 src_<language>[<header arguments>]@{<body>@}
11377 This name is associated with the code block. This is similar to the
11378 @samp{#+tblname} lines that can be used to name tables in Org-mode files.
11379 Referencing the name of a code block makes it possible to evaluate the
11380 block from other places in the file, other files, or from Org-mode table
11381 formulas (see @ref{The spreadsheet}).
11383 The language of the code in the block.
11385 Optional switches controlling exportation of the code block (see switches discussion in
11386 @ref{Literal examples})
11387 @item <header arguments>
11388 Optional header arguments control many aspects of evaluation, export and
11389 tangling of code blocks. See the @ref{Header arguments}
11390 section. Header arguments can also be set on a per-buffer or per-subtree
11391 basis using properties.
11396 @comment node-name, next, previous, up
11397 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11399 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11400 @section Editing source code
11401 @cindex code block, editing
11402 @cindex source code, editing
11405 Use @kbd{C-c '} to edit the current code block. This brings up
11406 a language major-mode edit buffer containing the body of the code
11407 block. Saving this buffer will write the new contents back to the Org
11408 buffer. Use @kbd{C-c '} again to exit.
11410 The @code{org-src-mode} minor mode will be active in the edit buffer. The
11411 following variables can be used to configure the behavior of the edit
11412 buffer. See also the customization group @code{org-edit-structure} for
11413 further configuration options.
11416 @item org-src-lang-modes
11417 If an Emacs major-mode named @code{<lang>-mode} exists, where
11418 @code{<lang>} is the language named in the header line of the code block,
11419 then the edit buffer will be placed in that major-mode. This variable
11420 can be used to map arbitrary language names to existing major modes.
11421 @item org-src-window-setup
11422 Controls the way Emacs windows are rearranged when the edit buffer is created.
11423 @item org-src-preserve-indentation
11424 This variable is especially useful for tangling languages such as
11425 Python, in which whitespace indentation in the output is critical.
11426 @item org-src-ask-before-returning-to-edit-buffer
11427 By default, Org will ask before returning to an open edit buffer. Set
11428 this variable to nil to switch without asking.
11431 To turn on native code fontification in the @emph{Org} buffer, configure the
11432 variable @code{org-src-fontify-natively}.
11434 @comment node-name, next, previous, up
11435 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11437 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11438 @section Exporting code blocks
11439 @cindex code block, exporting
11440 @cindex source code, exporting
11442 It is possible to export the @emph{contents} of code blocks, the
11443 @emph{results} of code block evaluation, @emph{neither}, or @emph{both}. For
11444 most languages, the default exports the contents of code blocks. However, for
11445 some languages (e.g.@: @code{ditaa}) the default exports the results of code
11446 block evaluation. For information on exporting code block bodies, see
11447 @ref{Literal examples}.
11449 The @code{:exports} header argument can be used to specify export
11452 @subsubheading Header arguments:
11454 @item :exports code
11455 The default in most languages. The body of the code block is exported, as
11456 described in @ref{Literal examples}.
11457 @item :exports results
11458 The code block will be evaluated and the results will be placed in the
11459 Org-mode buffer for export, either updating previous results of the code
11460 block located anywhere in the buffer or, if no previous results exist,
11461 placing the results immediately after the code block. The body of the code
11462 block will not be exported.
11463 @item :exports both
11464 Both the code block and its results will be exported.
11465 @item :exports none
11466 Neither the code block nor its results will be exported.
11469 It is possible to inhibit the evaluation of code blocks during export.
11470 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
11471 ensure that no code blocks are evaluated as part of the export process. This
11472 can be useful in situations where potentially untrusted Org-mode files are
11473 exported in an automated fashion, for example when Org-mode is used as the
11474 markup language for a wiki.
11476 @comment node-name, next, previous, up
11477 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11478 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11479 @section Extracting source code
11481 @cindex source code, extracting
11482 @cindex code block, extracting source code
11484 Creating pure source code files by extracting code from source blocks is
11485 referred to as ``tangling''---a term adopted from the literate programming
11486 community. During ``tangling'' of code blocks their bodies are expanded
11487 using @code{org-babel-expand-src-block} which can expand both variable and
11488 ``noweb'' style references (see @ref{Noweb reference syntax}).
11490 @subsubheading Header arguments
11493 The default. The code block is not included in the tangled output.
11495 Include the code block in the tangled output. The output file name is the
11496 name of the org file with the extension @samp{.org} replaced by the extension
11497 for the block language.
11498 @item :tangle filename
11499 Include the code block in the tangled output to file @samp{filename}.
11503 @subsubheading Functions
11505 @item org-babel-tangle
11506 Tangle the current file. Bound to @kbd{C-c C-v t}.
11507 @item org-babel-tangle-file
11508 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
11511 @subsubheading Hooks
11513 @item org-babel-post-tangle-hook
11514 This hook is run from within code files tangled by @code{org-babel-tangle}.
11515 Example applications could include post-processing, compilation or evaluation
11516 of tangled code files.
11519 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
11520 @section Evaluating code blocks
11521 @cindex code block, evaluating
11522 @cindex source code, evaluating
11524 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
11525 potential for that code to do harm. Org-mode provides a number of safeguards
11526 to ensure that it only evaluates code with explicit confirmation from the
11527 user. For information on these safeguards (and on how to disable them) see
11528 @ref{Code evaluation security}.} and the results placed in the Org-mode
11529 buffer. By default, evaluation is only turned on for @code{emacs-lisp} code
11530 blocks, however support exists for evaluating blocks in many languages. See
11531 @ref{Languages} for a list of supported languages. See @ref{Structure of
11532 code blocks} for information on the syntax used to define a code block.
11535 There are a number of ways to evaluate code blocks. The simplest is to press
11536 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
11537 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
11538 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
11539 @code{org-babel-execute-src-block} function to evaluate the block and insert
11540 its results into the Org-mode buffer.
11542 It is also possible to evaluate named code blocks from anywhere in an
11543 Org-mode buffer or an Org-mode table. @code{#+call} (or synonymously
11544 @code{#+function} or @code{#+lob}) lines can be used to remotely execute code
11545 blocks located in the current Org-mode buffer or in the ``Library of Babel''
11546 (see @ref{Library of Babel}). These lines use the following syntax.
11549 #+call: <name>(<arguments>) <header arguments>
11550 #+function: <name>(<arguments>) <header arguments>
11551 #+lob: <name>(<arguments>) <header arguments>
11556 The name of the code block to be evaluated.
11558 Arguments specified in this section will be passed to the code block. These
11559 arguments should relate to @code{:var} header arguments in the called code
11560 block expressed using standard function call syntax. For example if the
11561 original code block named @code{double} has the header argument @code{:var
11562 n=2}, then the call line passing the number four to that block would be
11563 written as @code{#+call: double(n=2)}.
11564 @item <header arguments>
11565 Header arguments can be placed after the function invocation. See
11566 @ref{Header arguments} for more information on header arguments.
11569 All header arguments placed in the @code{<header arguments>} section
11570 described above will be applied to the evaluation of the @code{#+call:} line,
11571 however it is sometimes desirable to specify header arguments to be passed to
11572 the code block being evaluated.
11574 This is possible through the use of the following optional extended syntax.
11577 #+call: <name>[<block header arguments>](<arguments>) <header arguments>
11580 Any header argument placed between the square brackets in the @code{<block
11581 header arguments>} section will be applied to the evaluation of the named
11582 code block. For more examples of passing header arguments to @code{#+call:}
11583 lines see @ref{Header arguments in function calls}.
11585 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
11586 @section Library of Babel
11587 @cindex babel, library of
11588 @cindex source code, library
11589 @cindex code block, library
11591 The ``Library of Babel'' is a library of code blocks
11592 that can be called from any Org-mode file. The library is housed in an
11593 Org-mode file located in the @samp{contrib} directory of Org-mode.
11594 Org-mode users can deposit functions they believe to be generally
11595 useful in the library.
11597 Code blocks defined in the ``Library of Babel'' can be called remotely as if
11598 they were in the current Org-mode buffer (see @ref{Evaluating code blocks}
11599 for information on the syntax of remote code block evaluation).
11602 Code blocks located in any Org-mode file can be loaded into the ``Library of
11603 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
11606 @node Languages, Header arguments, Library of Babel, Working With Source Code
11608 @cindex babel, languages
11609 @cindex source code, languages
11610 @cindex code block, languages
11612 Code blocks in the following languages are supported.
11614 @multitable @columnfractions 0.28 0.3 0.22 0.2
11615 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
11616 @item Asymptote @tab asymptote @tab Emacs Calc @tab calc
11617 @item C @tab C @tab C++ @tab C++
11618 @item Clojure @tab clojure @tab CSS @tab css
11619 @item ditaa @tab ditaa @tab Graphviz @tab dot
11620 @item Emacs Lisp @tab emacs-lisp @tab gnuplot @tab gnuplot
11621 @item Haskell @tab haskell @tab Javascript @tab js
11622 @item LaTeX @tab latex @tab Ledger @tab ledger
11623 @item Lisp @tab lisp @tab MATLAB @tab matlab
11624 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
11625 @item Octave @tab octave @tab Org-mode @tab org
11626 @item Oz @tab oz @tab Perl @tab perl
11627 @item Plantuml @tab plantuml @tab Python @tab python
11628 @item R @tab R @tab Ruby @tab ruby
11629 @item Sass @tab sass @tab Scheme @tab scheme
11630 @item GNU Screen @tab screen @tab shell @tab sh
11631 @item SQL @tab sql @tab SQLite @tab sqlite
11634 Language-specific documentation is available for some languages. If
11635 available, it can be found at
11636 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
11638 The @code{org-babel-load-languages} controls which languages are enabled for
11639 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
11640 be set using the customization interface or by adding code like the following
11641 to your emacs configuration.
11644 The following disables @code{emacs-lisp} evaluation and enables evaluation of
11645 @code{R} code blocks.
11649 (org-babel-do-load-languages
11650 'org-babel-load-languages
11651 '((emacs-lisp . nil)
11655 It is also possible to enable support for a language by loading the related
11656 elisp file with @code{require}.
11659 The following adds support for evaluating @code{clojure} code blocks.
11663 (require 'ob-clojure)
11666 @node Header arguments, Results of evaluation, Languages, Working With Source Code
11667 @section Header arguments
11668 @cindex code block, header arguments
11669 @cindex source code, block header arguments
11671 Code block functionality can be configured with header arguments. This
11672 section provides an overview of the use of header arguments, and then
11673 describes each header argument in detail.
11676 * Using header arguments:: Different ways to set header arguments
11677 * Specific header arguments:: List of header arguments
11680 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
11681 @subsection Using header arguments
11683 The values of header arguments can be set in six different ways, each more
11684 specific (and having higher priority) than the last.
11686 * System-wide header arguments:: Set global default values
11687 * Language-specific header arguments:: Set default values by language
11688 * Buffer-wide header arguments:: Set default values for a specific buffer
11689 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
11690 * Code block specific header arguments:: The most common way to set values
11691 * Header arguments in function calls:: The most specific level
11695 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
11696 @subsubheading System-wide header arguments
11697 @vindex org-babel-default-header-args
11698 System-wide values of header arguments can be specified by customizing the
11699 @code{org-babel-default-header-args} variable:
11703 :results => "replace"
11710 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
11712 @c ((:session . "none")
11713 @c (:results . "replace")
11714 @c (:exports . "code")
11716 @c (:noweb . "no"))
11720 @c Default arguments to use when evaluating a code block.
11723 For example, the following example could be used to set the default value of
11724 @code{:noweb} header arguments to @code{yes}. This would have the effect of
11725 expanding @code{:noweb} references by default when evaluating source code
11729 (setq org-babel-default-header-args
11730 (cons '(:noweb . "yes")
11731 (assq-delete-all :noweb org-babel-default-header-args)))
11734 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
11735 @subsubheading Language-specific header arguments
11736 Each language can define its own set of default header arguments. See the
11737 language-specific documentation available online at
11738 @uref{http://orgmode.org/worg/org-contrib/babel}.
11740 @node Buffer-wide header arguments, Header arguments in Org-mode properties, Language-specific header arguments, Using header arguments
11741 @subsubheading Buffer-wide header arguments
11742 Buffer-wide header arguments may be specified through the use of a special
11743 line placed anywhere in an Org-mode file. The line consists of the
11744 @code{#+BABEL:} keyword followed by a series of header arguments which may be
11745 specified using the standard header argument syntax.
11747 For example the following would set @code{session} to @code{*R*}, and
11748 @code{results} to @code{silent} for every code block in the buffer, ensuring
11749 that all execution took place in the same session, and no results would be
11750 inserted into the buffer.
11753 #+BABEL: :session *R* :results silent
11756 @node Header arguments in Org-mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
11757 @subsubheading Header arguments in Org-mode properties
11759 Header arguments are also read from Org-mode properties (see @ref{Property
11760 syntax}), which can be set on a buffer-wide or per-heading basis. An example
11761 of setting a header argument for all code blocks in a buffer is
11764 #+property: tangle yes
11767 When properties are used to set default header arguments, they are looked up
11768 with inheritance, so the value of the @code{:cache} header argument will default
11769 to @code{yes} in all code blocks in the subtree rooted at the following
11780 @vindex org-babel-default-header-args
11781 Properties defined in this way override the properties set in
11782 @code{org-babel-default-header-args}. It is convenient to use the
11783 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
11784 in Org-mode documents.
11786 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org-mode properties, Using header arguments
11787 @subsubheading Code block specific header arguments
11789 The most common way to assign values to header arguments is at the
11790 code block level. This can be done by listing a sequence of header
11791 arguments and their values as part of the @code{#+begin_src} line.
11792 Properties set in this way override both the values of
11793 @code{org-babel-default-header-args} and header arguments specified as
11794 properties. In the following example, the @code{:results} header argument
11795 is set to @code{silent}, meaning the results of execution will not be
11796 inserted in the buffer, and the @code{:exports} header argument is set to
11797 @code{code}, meaning only the body of the code block will be
11798 preserved on export to HTML or LaTeX.
11801 #+source: factorial
11802 #+begin_src haskell :results silent :exports code :var n=0
11804 fac n = n * fac (n-1)
11807 Similarly, it is possible to set header arguments for inline code blocks:
11810 src_haskell[:exports both]@{fac 5@}
11813 Code block header arguments can span multiple lines using =#+header:= or
11814 =#+headers:= lines preceding a code block or nested in between the name and
11815 body of a named code block.
11817 Multi-line header arguments on an un-named code block:
11819 #+headers: :var data1=1
11820 #+begin_src emacs-lisp :var data2=2
11821 (message "data1:%S, data2:%S" data1 data2)
11828 Multi-line header arguments on a named code block:
11830 #+source: named-block
11831 #+header: :var data=2
11832 #+begin_src emacs-lisp
11833 (message "data:%S" data)
11836 #+results: named-block
11840 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
11841 @comment node-name, next, previous, up
11842 @subsubheading Header arguments in function calls
11844 At the most specific level, header arguments for ``Library of Babel'' or
11845 function call lines can be set as shown in the two examples below. For more
11846 information on the structure of @code{#+call:} lines see @ref{Evaluating code
11849 The following will apply the @code{:exports results} header argument to the
11850 evaluation of the @code{#+call:} line.
11852 #+call: factorial(n=5) :exports results
11855 The following will apply the @code{:session special} header argument to the
11856 evaluation of the @code{factorial} code block.
11858 #+call: factorial[:session special](n=5)
11861 @node Specific header arguments, , Using header arguments, Header arguments
11862 @subsection Specific header arguments
11863 The following header arguments are defined:
11866 * var:: Pass arguments to code blocks
11867 * results:: Specify the type of results and how they will
11868 be collected and handled
11869 * file:: Specify a path for file output
11870 * dir:: Specify the default (possibly remote)
11871 directory for code block execution
11872 * exports:: Export code and/or results
11873 * tangle:: Toggle tangling and specify file name
11874 * mkdirp:: Toggle creation of parent directories of target
11875 files during tangling
11876 * comments:: Toggle insertion of comments in tangled
11878 * padline:: Control insertion of padding lines in tangled
11880 * no-expand:: Turn off variable assignment and noweb
11881 expansion during tangling
11882 * session:: Preserve the state of code evaluation
11883 * noweb:: Toggle expansion of noweb references
11884 * cache:: Avoid re-evaluating unchanged code blocks
11885 * sep:: Delimiter for writing tabular results outside Org
11886 * hlines:: Handle horizontal lines in tables
11887 * colnames:: Handle column names in tables
11888 * rownames:: Handle row names in tables
11889 * shebang:: Make tangled files executable
11890 * eval:: Limit evaluation of specific code blocks
11893 @node var, results, Specific header arguments, Specific header arguments
11894 @subsubsection @code{:var}
11895 The @code{:var} header argument is used to pass arguments to code blocks.
11896 The specifics of how arguments are included in a code block vary by language;
11897 these are addressed in the language-specific documentation. However, the
11898 syntax used to specify arguments is the same across all languages. The
11899 values passed to arguments can be literal values, values from org-mode tables
11900 and literal example blocks, the results of other code blocks, or Emacs Lisp
11901 code---see the ``Emacs Lisp evaluation of variables'' heading below.
11903 These values can be indexed in a manner similar to arrays---see the
11904 ``indexable variable values'' heading below.
11906 The following syntax is used to pass arguments to code blocks using the
11907 @code{:var} header argument.
11913 where @code{assign} can take one of the following forms
11916 @item literal value
11917 either a string @code{"string"} or a number @code{9}.
11922 #+tblname: example-table
11928 #+source: table-length
11929 #+begin_src emacs-lisp :var table=example-table
11933 #+results: table-length
11937 a code block name, as assigned by @code{#+srcname:}, followed by
11941 #+begin_src emacs-lisp :var length=table-length()
11949 In addition, an argument can be passed to the code block referenced
11950 by @code{:var}. The argument is passed within the parentheses following the
11955 #+begin_src emacs-lisp :var input=8
11963 #+begin_src emacs-lisp :var input=double(input=1)
11972 @subsubheading Alternate argument syntax
11973 It is also possible to specify arguments in a potentially more natural way
11974 using the @code{#+source:} line of a code block. As in the following
11975 example arguments can be packed inside of parenthesis, separated by commas,
11976 following the source name.
11979 #+source: double(input=0, x=2)
11980 #+begin_src emacs-lisp
11985 @subsubheading Indexable variable values
11986 It is possible to reference portions of variable values by ``indexing'' into
11987 the variables. Indexes are 0 based with negative values counting back from
11988 the end. If an index is separated by @code{,}s then each subsequent section
11989 will index into the next deepest nesting or dimension of the value. Note
11990 that this indexing occurs @emph{before} other table related header arguments
11991 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
11992 following example assigns the last cell of the first row the table
11993 @code{example-table} to the variable @code{data}:
11996 #+results: example-table
12002 #+begin_src emacs-lisp :var data=example-table[0,-1]
12010 Ranges of variable values can be referenced using two integers separated by a
12011 @code{:}, in which case the entire inclusive range is referenced. For
12012 example the following assigns the middle three rows of @code{example-table}
12016 #+results: example-table
12023 #+begin_src emacs-lisp :var data=example-table[1:3]
12033 Additionally, an empty index, or the single character @code{*}, are both
12034 interpreted to mean the entire range and as such are equivalent to
12035 @code{0:-1}, as shown in the following example in which the entire first
12036 column is referenced.
12039 #+results: example-table
12045 #+begin_src emacs-lisp :var data=example-table[,0]
12053 It is possible to index into the results of code blocks as well as tables.
12054 Any number of dimensions can be indexed. Dimensions are separated from one
12055 another by commas, as shown in the following example.
12059 #+begin_src emacs-lisp
12060 '(((1 2 3) (4 5 6) (7 8 9))
12061 ((10 11 12) (13 14 15) (16 17 18))
12062 ((19 20 21) (22 23 24) (25 26 27)))
12065 #+begin_src emacs-lisp :var data=3D[1,,1]
12073 @subsubheading Emacs Lisp evaluation of variables
12075 Emacs lisp code can be used to initialize variable values. When a variable
12076 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be evaluated as
12077 Emacs Lisp and the result of the evaluation will be assigned as the variable
12078 value. The following example demonstrates use of this evaluation to reliably
12079 pass the file-name of the org-mode buffer to a code block---note that
12080 evaluation of header arguments is guaranteed to take place in the original
12081 org-mode file, while there is no such guarantee for evaluation of the code
12085 #+begin_src sh :var filename=(buffer-file-name) :exports both
12090 Note that values read from tables and lists will not be evaluated as
12091 Emacs Lisp, as shown in the following example.
12097 #+headers: :var data=table[0,0]
12106 @node results, file, var, Specific header arguments
12107 @subsubsection @code{:results}
12109 There are three classes of @code{:results} header argument. Only one option
12110 per class may be supplied per code block.
12114 @b{collection} header arguments specify how the results should be collected
12115 from the code block
12117 @b{type} header arguments specify what type of result the code block will
12118 return---which has implications for how they will be inserted into the
12121 @b{handling} header arguments specify how the results of evaluating the code
12122 block should be handled.
12125 @subsubheading Collection
12126 The following options are mutually exclusive, and specify how the results
12127 should be collected from the code block.
12131 This is the default. The result is the value of the last statement in the
12132 code block. This header argument places the evaluation in functional
12133 mode. Note that in some languages, e.g., Python, use of this result type
12134 requires that a @code{return} statement be included in the body of the source
12135 code block. E.g., @code{:results value}.
12136 @item @code{output}
12137 The result is the collection of everything printed to STDOUT during the
12138 execution of the code block. This header argument places the
12139 evaluation in scripting mode. E.g., @code{:results output}.
12142 @subsubheading Type
12144 The following options are mutually exclusive and specify what type of results
12145 the code block will return. By default, results are inserted as either a
12146 table or scalar depending on their value.
12149 @item @code{table}, @code{vector}
12150 The results should be interpreted as an Org-mode table. If a single value is
12151 returned, it will be converted into a table with one row and one column.
12152 E.g., @code{:results value table}.
12154 The results should be interpreted as an Org-mode list. If a single scalar
12155 value is returned it will be converted into a list with only one element.
12156 @item @code{scalar}, @code{verbatim}
12157 The results should be interpreted literally---they will not be
12158 converted into a table. The results will be inserted into the Org-mode
12159 buffer as quoted text. E.g., @code{:results value verbatim}.
12161 The results will be interpreted as the path to a file, and will be inserted
12162 into the Org-mode buffer as a file link. E.g., @code{:results value file}.
12163 @item @code{raw}, @code{org}
12164 The results are interpreted as raw Org-mode code and are inserted directly
12165 into the buffer. If the results look like a table they will be aligned as
12166 such by Org-mode. E.g., @code{:results value raw}.
12168 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
12169 block. E.g., @code{:results value html}.
12171 Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block.
12172 E.g., @code{:results value latex}.
12174 Result are assumed to be parseable code and are enclosed in a code block.
12175 E.g., @code{:results value code}.
12177 The result is converted to pretty-printed code and is enclosed in a code
12178 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
12179 @code{:results value pp}.
12181 The result is wrapped in a @code{begin_result} block. This can be useful for
12182 inserting @code{raw} or @code{org} syntax results in such a way that their
12183 extend is known and they can be automatically removed or replaced.
12186 @subsubheading Handling
12187 The following results options indicate what happens with the
12188 results once they are collected.
12191 @item @code{silent}
12192 The results will be echoed in the minibuffer but will not be inserted into
12193 the Org-mode buffer. E.g., @code{:results output silent}.
12194 @item @code{replace}
12195 The default value. Any existing results will be removed, and the new results
12196 will be inserted into the Org-mode buffer in their place. E.g.,
12197 @code{:results output replace}.
12198 @item @code{append}
12199 If there are pre-existing results of the code block then the new results will
12200 be appended to the existing results. Otherwise the new results will be
12201 inserted as with @code{replace}.
12202 @item @code{prepend}
12203 If there are pre-existing results of the code block then the new results will
12204 be prepended to the existing results. Otherwise the new results will be
12205 inserted as with @code{replace}.
12208 @node file, dir, results, Specific header arguments
12209 @subsubsection @code{:file}
12211 The header argument @code{:file} is used to specify an external file in which
12212 to save code block results. After code block evaluation an Org-mode style
12213 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
12214 into the Org-mode buffer. Some languages including R, gnuplot, dot, and
12215 ditaa provide special handling of the @code{:file} header argument
12216 automatically wrapping the code block body in the boilerplate code required
12217 to save output to the specified file. This is often useful for saving
12218 graphical output of a code block to the specified file.
12220 The argument to @code{:file} should be either a string specifying the path to
12221 a file, or a list of two strings in which case the first element of the list
12222 should be the path to a file and the second a description for the link.
12224 @node dir, exports, file, Specific header arguments
12225 @subsubsection @code{:dir} and remote execution
12227 While the @code{:file} header argument can be used to specify the path to the
12228 output file, @code{:dir} specifies the default directory during code block
12229 execution. If it is absent, then the directory associated with the current
12230 buffer is used. In other words, supplying @code{:dir path} temporarily has
12231 the same effect as changing the current directory with @kbd{M-x cd path}, and
12232 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
12233 the value of the Emacs variable @code{default-directory}.
12235 When using @code{:dir}, you should supply a relative path for file output
12236 (e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
12237 case that path will be interpreted relative to the default directory.
12239 In other words, if you want your plot to go into a folder called @file{Work}
12240 in your home directory, you could use
12243 #+begin_src R :file myplot.png :dir ~/Work
12244 matplot(matrix(rnorm(100), 10), type="l")
12248 @subsubheading Remote execution
12249 A directory on a remote machine can be specified using tramp file syntax, in
12250 which case the code will be evaluated on the remote machine. An example is
12253 #+begin_src R :file plot.png :dir /dand@@yakuba.princeton.edu:
12254 plot(1:10, main=system("hostname", intern=TRUE))
12258 Text results will be returned to the local Org-mode buffer as usual, and file
12259 output will be created on the remote machine with relative paths interpreted
12260 relative to the remote directory. An Org-mode link to the remote file will be
12263 So, in the above example a plot will be created on the remote machine,
12264 and a link of the following form will be inserted in the org buffer:
12267 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
12270 Most of this functionality follows immediately from the fact that @code{:dir}
12271 sets the value of the Emacs variable @code{default-directory}, thanks to
12272 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
12273 install tramp separately in order for these features to work correctly.
12275 @subsubheading Further points
12279 If @code{:dir} is used in conjunction with @code{:session}, although it will
12280 determine the starting directory for a new session as expected, no attempt is
12281 currently made to alter the directory associated with an existing session.
12283 @code{:dir} should typically not be used to create files during export with
12284 @code{:exports results} or @code{:exports both}. The reason is that, in order
12285 to retain portability of exported material between machines, during export
12286 links inserted into the buffer will *not* be expanded against @code{default
12287 directory}. Therefore, if @code{default-directory} is altered using
12288 @code{:dir}, it is probable that the file will be created in a location to
12289 which the link does not point.
12292 @node exports, tangle, dir, Specific header arguments
12293 @subsubsection @code{:exports}
12295 The @code{:exports} header argument specifies what should be included in HTML
12296 or LaTeX exports of the Org-mode file.
12300 The default. The body of code is included into the exported file. E.g.,
12301 @code{:exports code}.
12302 @item @code{results}
12303 The result of evaluating the code is included in the exported file. E.g.,
12304 @code{:exports results}.
12306 Both the code and results are included in the exported file. E.g.,
12307 @code{:exports both}.
12309 Nothing is included in the exported file. E.g., @code{:exports none}.
12312 @node tangle, mkdirp, exports, Specific header arguments
12313 @subsubsection @code{:tangle}
12315 The @code{:tangle} header argument specifies whether or not the code
12316 block should be included in tangled extraction of source code files.
12319 @item @code{tangle}
12320 The code block is exported to a source code file named after the
12321 basename (name w/o extension) of the Org-mode file. E.g., @code{:tangle
12324 The default. The code block is not exported to a source code file.
12325 E.g., @code{:tangle no}.
12327 Any other string passed to the @code{:tangle} header argument is interpreted
12328 as a file basename to which the block will be exported. E.g., @code{:tangle
12332 @node mkdirp, comments, tangle, Specific header arguments
12333 @subsubsection @code{:mkdirp}
12335 The @code{:mkdirp} header argument can be used to create parent directories
12336 of tangled files when missing. This can be set to @code{yes} to enable
12337 directory creation or to @code{no} to inhibit directory creation.
12339 @node comments, padline, mkdirp, Specific header arguments
12340 @subsubsection @code{:comments}
12341 By default code blocks are tangled to source-code files without any insertion
12342 of comments beyond those which may already exist in the body of the code
12343 block. The @code{:comments} header argument can be set as follows to control
12344 the insertion of extra comments into the tangled code file.
12348 The default. No extra comments are inserted during tangling.
12350 The code block is wrapped in comments which contain pointers back to the
12351 original Org file from which the code was tangled.
12353 A synonym for ``link'' to maintain backwards compatibility.
12355 Include text from the org-mode file as a comment.
12357 The text is picked from the leading context of the tangled code and is
12358 limited by the nearest headline or source block as the case may be.
12360 Turns on both the ``link'' and ``org'' comment options.
12362 Turns on the ``link'' comment option, and additionally wraps expanded noweb
12363 references in the code block body in link comments.
12366 @node padline, no-expand, comments, Specific header arguments
12367 Control in insertion of padding lines around code block bodies in tangled
12368 code files. The default value is @code{yes} which results in insertion of
12369 newlines before and after each tangled code block. The following arguments
12374 Insert newlines before and after each code block body in tangled code files.
12376 Do not insert any newline padding in tangled output.
12379 @node no-expand, session, padline, Specific header arguments
12380 @subsubsection @code{:no-expand}
12382 By default, code blocks are expanded with @code{org-babel-expand-src-block}
12383 during tangling. This has the effect of assigning values to variables
12384 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
12385 references (see @ref{Noweb reference syntax}) with their targets. The
12386 @code{:no-expand} header argument can be used to turn off this behavior.
12388 @node session, noweb, no-expand, Specific header arguments
12389 @subsubsection @code{:session}
12391 The @code{:session} header argument starts a session for an interpreted
12392 language where state is preserved.
12394 By default, a session is not started.
12396 A string passed to the @code{:session} header argument will give the session
12397 a name. This makes it possible to run concurrent sessions for each
12398 interpreted language.
12400 @node noweb, cache, session, Specific header arguments
12401 @subsubsection @code{:noweb}
12403 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
12404 @ref{Noweb reference syntax}) references in a code block. This header
12405 argument can have one of three values: @code{yes} @code{no} or @code{tangle}.
12409 All ``noweb'' syntax references in the body of the code block will be
12410 expanded before the block is evaluated, tangled or exported.
12412 The default. No ``noweb'' syntax specific action is taken on evaluating
12413 code blocks, However, noweb references will still be expanded during
12415 @item @code{tangle}
12416 All ``noweb'' syntax references in the body of the code block will be
12417 expanded before the block is tangled, however ``noweb'' references will not
12418 be expanded when the block is evaluated or exported.
12421 @subsubheading Noweb prefix lines
12422 Noweb insertions are now placed behind the line prefix of the
12423 @code{<<reference>>}.
12424 This behavior is illustrated in the following example. Because the
12425 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
12426 each line of the expanded noweb reference will be commented.
12439 -- multi-line body of example
12442 Note that noweb replacement text that does not contain any newlines will not
12443 be affected by this change, so it is still possible to use inline noweb
12446 @node cache, sep, noweb, Specific header arguments
12447 @subsubsection @code{:cache}
12449 The @code{:cache} header argument controls the use of in-buffer caching of
12450 the results of evaluating code blocks. It can be used to avoid re-evaluating
12451 unchanged code blocks. This header argument can have one of two
12452 values: @code{yes} or @code{no}.
12456 The default. No caching takes place, and the code block will be evaluated
12457 every time it is called.
12459 Every time the code block is run a SHA1 hash of the code and arguments
12460 passed to the block will be generated. This hash is packed into the
12461 @code{#+results:} line and will be checked on subsequent
12462 executions of the code block. If the code block has not
12463 changed since the last time it was evaluated, it will not be re-evaluated.
12466 Code block caches notice if the value of a variable argument
12467 to the code block has changed. If this is the case, the cache is
12468 invalidated and the code block is re-run. In the following example,
12469 @code{caller} will not be re-run unless the results of @code{random} have
12470 changed since it was last run.
12474 #+begin_src R :cache yes
12478 #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
12482 #+begin_src emacs-lisp :var x=random :cache yes
12486 #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
12490 @node sep, hlines, cache, Specific header arguments
12491 @subsubsection @code{:sep}
12493 The @code{:sep} header argument can be used to control the delimiter used
12494 when writing tabular results out to files external to Org-mode. This is used
12495 either when opening tabular results of a code block by calling the
12496 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
12497 or when writing code block results to an external file (see @ref{file})
12500 By default, when @code{:sep} is not specified output tables are tab
12503 @node hlines, colnames, sep, Specific header arguments
12504 @subsubsection @code{:hlines}
12506 Tables are frequently represented with one or more horizontal lines, or
12507 hlines. The @code{:hlines} argument to a code block accepts the
12508 values @code{yes} or @code{no}, with a default value of @code{no}.
12512 Strips horizontal lines from the input table. In most languages this is the
12513 desired effect because an @code{hline} symbol is interpreted as an unbound
12514 variable and raises an error. Setting @code{:hlines no} or relying on the
12515 default value yields the following results.
12518 #+tblname: many-cols
12525 #+source: echo-table
12526 #+begin_src python :var tab=many-cols
12530 #+results: echo-table
12537 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
12540 #+tblname: many-cols
12547 #+source: echo-table
12548 #+begin_src python :var tab=many-cols :hlines yes
12552 #+results: echo-table
12561 @node colnames, rownames, hlines, Specific header arguments
12562 @subsubsection @code{:colnames}
12564 The @code{:colnames} header argument accepts the values @code{yes},
12565 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
12569 If an input table looks like it has column names
12570 (because its second row is an hline), then the column
12571 names will be removed from the table before
12572 processing, then reapplied to the results.
12575 #+tblname: less-cols
12581 #+srcname: echo-table-again
12582 #+begin_src python :var tab=less-cols
12583 return [[val + '*' for val in row] for row in tab]
12586 #+results: echo-table-again
12593 Please note that column names are not removed before the table is indexed
12594 using variable indexing @xref{var, Indexable variable values}.
12597 No column name pre-processing takes place
12600 Column names are removed and reapplied as with @code{nil} even if the table
12601 does not ``look like'' it has column names (i.e.@: the second row is not an
12605 @node rownames, shebang, colnames, Specific header arguments
12606 @subsubsection @code{:rownames}
12608 The @code{:rownames} header argument can take on the values @code{yes}
12609 or @code{no}, with a default value of @code{no}.
12613 No row name pre-processing will take place.
12616 The first column of the table is removed from the table before processing,
12617 and is then reapplied to the results.
12620 #+tblname: with-rownames
12621 | one | 1 | 2 | 3 | 4 | 5 |
12622 | two | 6 | 7 | 8 | 9 | 10 |
12624 #+srcname: echo-table-once-again
12625 #+begin_src python :var tab=with-rownames :rownames yes
12626 return [[val + 10 for val in row] for row in tab]
12629 #+results: echo-table-once-again
12630 | one | 11 | 12 | 13 | 14 | 15 |
12631 | two | 16 | 17 | 18 | 19 | 20 |
12634 Please note that row names are not removed before the table is indexed using
12635 variable indexing @xref{var, Indexable variable values}.
12639 @node shebang, eval, rownames, Specific header arguments
12640 @subsubsection @code{:shebang}
12642 Setting the @code{:shebang} header argument to a string value
12643 (e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
12644 first line of any tangled file holding the code block, and the file
12645 permissions of the tangled file are set to make it executable.
12647 @node eval, , shebang, Specific header arguments
12648 @subsubsection @code{:eval}
12649 The @code{:eval} header argument can be used to limit the evaluation of
12650 specific code blocks. @code{:eval} accepts two arguments ``never'' and
12651 ``query''. @code{:eval never} will ensure that a code block is never
12652 evaluated, this can be useful for protecting against the evaluation of
12653 dangerous code blocks. @code{:eval query} will require a query for every
12654 execution of a code block regardless of the value of the
12655 @code{org-confirm-babel-evaluate} variable.
12657 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
12658 @section Results of evaluation
12659 @cindex code block, results of evaluation
12660 @cindex source code, results of evaluation
12662 The way in which results are handled depends on whether a session is invoked,
12663 as well as on whether @code{:results value} or @code{:results output} is
12664 used. The following table shows the table possibilities. For a full listing
12665 of the possible results header arguments see @ref{results}.
12667 @multitable @columnfractions 0.26 0.33 0.41
12668 @item @tab @b{Non-session} @tab @b{Session}
12669 @item @code{:results value} @tab value of last expression @tab value of last expression
12670 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
12673 Note: With @code{:results value}, the result in both @code{:session} and
12674 non-session is returned to Org-mode as a table (a one- or two-dimensional
12675 vector of strings or numbers) when appropriate.
12677 @subsection Non-session
12678 @subsubsection @code{:results value}
12679 This is the default. Internally, the value is obtained by wrapping the code
12680 in a function definition in the external language, and evaluating that
12681 function. Therefore, code should be written as if it were the body of such a
12682 function. In particular, note that Python does not automatically return a
12683 value from a function unless a @code{return} statement is present, and so a
12684 @samp{return} statement will usually be required in Python.
12686 This is the only one of the four evaluation contexts in which the code is
12687 automatically wrapped in a function definition.
12689 @subsubsection @code{:results output}
12690 The code is passed to the interpreter as an external process, and the
12691 contents of the standard output stream are returned as text. (In certain
12692 languages this also contains the error output stream; this is an area for
12695 @subsection Session
12696 @subsubsection @code{:results value}
12697 The code is passed to the interpreter running as an interactive Emacs
12698 inferior process. The result returned is the result of the last evaluation
12699 performed by the interpreter. (This is obtained in a language-specific
12700 manner: the value of the variable @code{_} in Python and Ruby, and the value
12701 of @code{.Last.value} in R).
12703 @subsubsection @code{:results output}
12704 The code is passed to the interpreter running as an interactive Emacs
12705 inferior process. The result returned is the concatenation of the sequence of
12706 (text) output from the interactive interpreter. Notice that this is not
12707 necessarily the same as what would be sent to @code{STDOUT} if the same code
12708 were passed to a non-interactive interpreter running as an external
12709 process. For example, compare the following two blocks:
12712 #+begin_src python :results output
12723 In non-session mode, the `2' is not printed and does not appear.
12725 #+begin_src python :results output :session
12737 But in @code{:session} mode, the interactive interpreter receives input `2'
12738 and prints out its value, `2'. (Indeed, the other print statements are
12741 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
12742 @section Noweb reference syntax
12743 @cindex code block, noweb reference
12744 @cindex syntax, noweb
12745 @cindex source code, noweb reference
12747 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
12748 Programming system allows named blocks of code to be referenced by using the
12749 familiar Noweb syntax:
12752 <<code-block-name>>
12755 When a code block is tangled or evaluated, whether or not ``noweb''
12756 references are expanded depends upon the value of the @code{:noweb} header
12757 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
12758 evaluation. If @code{:noweb no}, the default, then the reference is not
12759 expanded before evaluation.
12761 Note: the default value, @code{:noweb no}, was chosen to ensure that
12762 correct code is not broken in a language, such as Ruby, where
12763 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
12764 syntactically valid in languages that you use, then please consider setting
12767 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
12768 @section Key bindings and useful functions
12769 @cindex code block, key bindings
12771 Many common Org-mode key sequences are re-bound depending on
12774 Within a code block, the following key bindings
12777 @multitable @columnfractions 0.25 0.75
12779 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
12781 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
12783 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
12785 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
12788 In an Org-mode buffer, the following key bindings are active:
12790 @multitable @columnfractions 0.45 0.55
12792 @kindex C-c C-v C-a
12793 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
12795 @kindex C-c C-v C-b
12796 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
12798 @kindex C-c C-v C-f
12799 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
12801 @item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block}
12803 @item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings}
12805 @kindex C-c C-v C-l
12806 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
12808 @kindex C-c C-v C-p
12809 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
12811 @kindex C-c C-v C-s
12812 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
12814 @kindex C-c C-v C-t
12815 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
12817 @kindex C-c C-v C-z
12818 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
12821 @c When possible these keybindings were extended to work when the control key is
12822 @c kept pressed, resulting in the following additional keybindings.
12824 @c @multitable @columnfractions 0.25 0.75
12825 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
12826 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
12827 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
12828 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
12829 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
12830 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
12831 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
12832 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
12835 @node Batch execution, , Key bindings and useful functions, Working With Source Code
12836 @section Batch execution
12837 @cindex code block, batch execution
12838 @cindex source code, batch execution
12840 It is possible to call functions from the command line. This shell
12841 script calls @code{org-babel-tangle} on every one of its arguments.
12843 Be sure to adjust the paths to fit your system.
12847 # -*- mode: shell-script -*-
12849 # tangle files with org-mode
12853 ORGINSTALL="~/src/org/lisp/org-install.el"
12855 # wrap each argument in the code required to call tangle on it
12857 FILES="$FILES \"$i\""
12860 emacs -Q --batch -l $ORGINSTALL \
12862 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
12863 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
12864 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
12865 (mapc (lambda (file)
12866 (find-file (expand-file-name file \"$DIR\"))
12868 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
12871 @node Miscellaneous, Hacking, Working With Source Code, Top
12872 @chapter Miscellaneous
12875 * Completion:: M-TAB knows what you need
12876 * Easy Templates:: Quick insertion of structural elements
12877 * Speed keys:: Electric commands at the beginning of a headline
12878 * Code evaluation security:: Org mode files evaluate inline code
12879 * Customization:: Adapting Org to your taste
12880 * In-buffer settings:: Overview of the #+KEYWORDS
12881 * The very busy C-c C-c key:: When in doubt, press C-c C-c
12882 * Clean view:: Getting rid of leading stars in the outline
12883 * TTY keys:: Using Org on a tty
12884 * Interaction:: Other Emacs packages
12888 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
12889 @section Completion
12890 @cindex completion, of @TeX{} symbols
12891 @cindex completion, of TODO keywords
12892 @cindex completion, of dictionary words
12893 @cindex completion, of option keywords
12894 @cindex completion, of tags
12895 @cindex completion, of property keys
12896 @cindex completion, of link abbreviations
12897 @cindex @TeX{} symbol completion
12898 @cindex TODO keywords completion
12899 @cindex dictionary word completion
12900 @cindex option keyword completion
12901 @cindex tag completion
12902 @cindex link abbreviations, completion of
12904 Emacs would not be Emacs without completion, and Org-mode uses it whenever it
12905 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
12906 some of the completion prompts, you can specify your preference by setting at
12907 most one of the variables @code{org-completion-use-iswitchb}
12908 @code{org-completion-use-ido}.
12910 Org supports in-buffer completion. This type of completion does
12911 not make use of the minibuffer. You simply type a few letters into
12912 the buffer and use the key to complete text right there.
12915 @kindex M-@key{TAB}
12917 Complete word at point
12920 At the beginning of a headline, complete TODO keywords.
12922 After @samp{\}, complete @TeX{} symbols supported by the exporter.
12924 After @samp{*}, complete headlines in the current buffer so that they
12925 can be used in search links like @samp{[[*find this headline]]}.
12927 After @samp{:} in a headline, complete tags. The list of tags is taken
12928 from the variable @code{org-tag-alist} (possibly set through the
12929 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
12930 dynamically from all tags used in the current buffer.
12932 After @samp{:} and not in a headline, complete property keys. The list
12933 of keys is constructed dynamically from all keys used in the current
12936 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
12938 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
12939 @samp{OPTIONS} which set file-specific options for Org-mode. When the
12940 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
12941 will insert example settings for this keyword.
12943 In the line after @samp{#+STARTUP: }, complete startup keywords,
12944 i.e.@: valid keys for this line.
12946 Elsewhere, complete dictionary words using Ispell.
12950 @node Easy Templates, Speed keys, Completion, Miscellaneous
12951 @section Easy Templates
12952 @cindex template insertion
12953 @cindex insertion, of templates
12955 Org-mode supports insertion of empty structural elements (like
12956 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
12957 strokes. This is achieved through a native template expansion mechanism.
12958 Note that Emacs has several other template mechanisms which could be used in
12959 a similar way, for example @file{yasnippet}.
12961 To insert a structural element, type a @samp{<}, followed by a template
12962 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
12963 keystrokes are typed on a line by itself.
12965 The following template selectors are currently supported.
12967 @multitable @columnfractions 0.1 0.9
12968 @item @kbd{s} @tab @code{#+begin_src ... #+end_src}
12969 @item @kbd{e} @tab @code{#+begin_example ... #+end_example}
12970 @item @kbd{q} @tab @code{#+begin_quote ... #+end_quote}
12971 @item @kbd{v} @tab @code{#+begin_verse ... #+end_verse}
12972 @item @kbd{c} @tab @code{#+begin_center ... #+end_center}
12973 @item @kbd{l} @tab @code{#+begin_latex ... #+end_latex}
12974 @item @kbd{L} @tab @code{#+latex:}
12975 @item @kbd{h} @tab @code{#+begin_html ... #+end_html}
12976 @item @kbd{H} @tab @code{#+html:}
12977 @item @kbd{a} @tab @code{#+begin_ascii ... #+end_ascii}
12978 @item @kbd{A} @tab @code{#+ascii:}
12979 @item @kbd{i} @tab @code{#+include:} line
12982 For example, on an empty line, typing "<e" and then pressing TAB, will expand
12983 into a complete EXAMPLE template.
12985 You can install additional templates by customizing the variable
12986 @code{org-structure-template-alist}. See the docstring of the variable for
12987 additional details.
12989 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
12990 @section Speed keys
12992 @vindex org-use-speed-commands
12993 @vindex org-speed-commands-user
12995 Single keys can be made to execute commands when the cursor is at the
12996 beginning of a headline, i.e.@: before the first star. Configure the variable
12997 @code{org-use-speed-commands} to activate this feature. There is a
12998 pre-defined list of commands, and you can add more such commands using the
12999 variable @code{org-speed-commands-user}. Speed keys do not only speed up
13000 navigation and other commands, but they also provide an alternative way to
13001 execute commands bound to keys that are not or not easily available on a TTY,
13002 or on a small mobile device with a limited keyboard.
13004 To see which commands are available, activate the feature and press @kbd{?}
13005 with the cursor at the beginning of a headline.
13007 @node Code evaluation security, Customization, Speed keys, Miscellaneous
13008 @section Code evaluation and security issues
13010 Org provides tools to work with the code snippets, including evaluating them.
13012 Running code on your machine always comes with a security risk. Badly
13013 written or malicious code can be executed on purpose or by accident. Org has
13014 default settings which will only evaluate such code if you give explicit
13015 permission to do so, and as a casual user of these features you should leave
13016 these precautions intact.
13018 For people who regularly work with such code, the confirmation prompts can
13019 become annoying, and you might want to turn them off. This can be done, but
13020 you must be aware of the risks that are involved.
13022 Code evaluation can happen under the following circumstances:
13025 @item Source code blocks
13026 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
13027 C-c} in the block. The most important thing to realize here is that Org mode
13028 files which contain code snippets are, in a certain sense, like executable
13029 files. So you should accept them and load them into Emacs only from trusted
13030 sources---just like you would do with a program you install on your computer.
13032 Make sure you know what you are doing before customizing the variables
13033 which take off the default security brakes.
13035 @defopt org-confirm-babel-evaluate
13036 When t (the default), the user is asked before every code block evaluation.
13037 When nil, the user is not asked. When set to a function, it is called with
13038 two arguments (language and body of the code block) and should return t to
13039 ask and nil not to ask.
13042 For example, here is how to execute "ditaa" code (which is considered safe)
13045 (defun my-org-confirm-babel-evaluate (lang body)
13046 (not (string= lang "ditaa"))) ; don't ask for ditaa
13047 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
13050 @item Following @code{shell} and @code{elisp} links
13051 Org has two link types that can directly evaluate code (@pxref{External
13052 links}). These links can be problematic because the code to be evaluated is
13055 @defopt org-confirm-shell-link-function
13056 Function to queries user about shell link execution.
13058 @defopt org-confirm-elisp-link-function
13059 Functions to query user for Emacs Lisp link execution.
13062 @item Formulas in tables
13063 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
13064 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
13067 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
13068 @section Customization
13069 @cindex customization
13070 @cindex options, for customization
13071 @cindex variables, for customization
13073 There are more than 180 variables that can be used to customize
13074 Org. For the sake of compactness of the manual, I am not
13075 describing the variables here. A structured overview of customization
13076 variables is available with @kbd{M-x org-customize}. Or select
13077 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
13078 settings can also be activated on a per-file basis, by putting special
13079 lines into the buffer (@pxref{In-buffer settings}).
13081 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
13082 @section Summary of in-buffer settings
13083 @cindex in-buffer settings
13084 @cindex special keywords
13086 Org-mode uses special lines in the buffer to define settings on a
13087 per-file basis. These lines start with a @samp{#+} followed by a
13088 keyword, a colon, and then individual words defining a setting. Several
13089 setting words can be in the same line, but you can also have multiple
13090 lines for the keyword. While these settings are described throughout
13091 the manual, here is a summary. After changing any of those lines in the
13092 buffer, press @kbd{C-c C-c} with the cursor still in the line to
13093 activate the changes immediately. Otherwise they become effective only
13094 when the file is visited again in a new Emacs session.
13096 @vindex org-archive-location
13098 @item #+ARCHIVE: %s_done::
13099 This line sets the archive location for the agenda file. It applies for
13100 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
13101 of the file. The first such line also applies to any entries before it.
13102 The corresponding variable is @code{org-archive-location}.
13104 This line sets the category for the agenda file. The category applies
13105 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
13106 end of the file. The first such line also applies to any entries before it.
13107 @item #+COLUMNS: %25ITEM .....
13108 @cindex property, COLUMNS
13109 Set the default format for columns view. This format applies when
13110 columns view is invoked in locations where no @code{COLUMNS} property
13112 @item #+CONSTANTS: name1=value1 ...
13113 @vindex org-table-formula-constants
13114 @vindex org-table-formula
13115 Set file-local values for constants to be used in table formulas. This
13116 line sets the local variable @code{org-table-formula-constants-local}.
13117 The global version of this variable is
13118 @code{org-table-formula-constants}.
13119 @item #+FILETAGS: :tag1:tag2:tag3:
13120 Set tags that can be inherited by any entry in the file, including the
13122 @item #+DRAWERS: NAME1 .....
13123 @vindex org-drawers
13124 Set the file-local set of drawers. The corresponding global variable is
13125 @code{org-drawers}.
13126 @item #+LINK: linkword replace
13127 @vindex org-link-abbrev-alist
13128 These lines (several are allowed) specify link abbreviations.
13129 @xref{Link abbreviations}. The corresponding variable is
13130 @code{org-link-abbrev-alist}.
13131 @item #+PRIORITIES: highest lowest default
13132 @vindex org-highest-priority
13133 @vindex org-lowest-priority
13134 @vindex org-default-priority
13135 This line sets the limits and the default for the priorities. All three
13136 must be either letters A-Z or numbers 0-9. The highest priority must
13137 have a lower ASCII number than the lowest priority.
13138 @item #+PROPERTY: Property_Name Value
13139 This line sets a default inheritance value for entries in the current
13140 buffer, most useful for specifying the allowed values of a property.
13141 @cindex #+SETUPFILE
13142 @item #+SETUPFILE: file
13143 This line defines a file that holds more in-buffer setup. Normally this is
13144 entirely ignored. Only when the buffer is parsed for option-setting lines
13145 (i.e.@: when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a
13146 settings line, or when exporting), then the contents of this file are parsed
13147 as if they had been included in the buffer. In particular, the file can be
13148 any other Org-mode file with internal setup. You can visit the file the
13149 cursor is in the line with @kbd{C-c '}.
13152 This line sets options to be used at startup of Org-mode, when an
13153 Org file is being visited.
13155 The first set of options deals with the initial visibility of the outline
13156 tree. The corresponding variable for global default settings is
13157 @code{org-startup-folded}, with a default value @code{t}, which means
13159 @vindex org-startup-folded
13160 @cindex @code{overview}, STARTUP keyword
13161 @cindex @code{content}, STARTUP keyword
13162 @cindex @code{showall}, STARTUP keyword
13163 @cindex @code{showeverything}, STARTUP keyword
13165 overview @r{top-level headlines only}
13166 content @r{all headlines}
13167 showall @r{no folding of any entries}
13168 showeverything @r{show even drawer contents}
13171 @vindex org-startup-indented
13172 @cindex @code{indent}, STARTUP keyword
13173 @cindex @code{noindent}, STARTUP keyword
13174 Dynamic virtual indentation is controlled by the variable
13175 @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
13177 indent @r{start with @code{org-indent-mode} turned on}
13178 noindent @r{start with @code{org-indent-mode} turned off}
13181 @vindex org-startup-align-all-tables
13182 Then there are options for aligning tables upon visiting a file. This
13183 is useful in files containing narrowed table columns. The corresponding
13184 variable is @code{org-startup-align-all-tables}, with a default value
13186 @cindex @code{align}, STARTUP keyword
13187 @cindex @code{noalign}, STARTUP keyword
13189 align @r{align all tables}
13190 noalign @r{don't align tables on startup}
13193 @vindex org-startup-with-inline-images
13194 When visiting a file, inline images can be automatically displayed. The
13195 corresponding variable is @code{org-startup-with-inline-images}, with a
13196 default value @code{nil} to avoid delays when visiting a file.
13197 @cindex @code{inlineimages}, STARTUP keyword
13198 @cindex @code{noinlineimages}, STARTUP keyword
13200 inlineimages @r{show inline images}
13201 noinlineimages @r{don't show inline images on startup}
13204 @vindex org-log-done
13205 @vindex org-log-note-clock-out
13206 @vindex org-log-repeat
13207 Logging the closing and reopening of TODO items and clock intervals can be
13208 configured using these options (see variables @code{org-log-done},
13209 @code{org-log-note-clock-out} and @code{org-log-repeat})
13210 @cindex @code{logdone}, STARTUP keyword
13211 @cindex @code{lognotedone}, STARTUP keyword
13212 @cindex @code{nologdone}, STARTUP keyword
13213 @cindex @code{lognoteclock-out}, STARTUP keyword
13214 @cindex @code{nolognoteclock-out}, STARTUP keyword
13215 @cindex @code{logrepeat}, STARTUP keyword
13216 @cindex @code{lognoterepeat}, STARTUP keyword
13217 @cindex @code{nologrepeat}, STARTUP keyword
13218 @cindex @code{logreschedule}, STARTUP keyword
13219 @cindex @code{lognotereschedule}, STARTUP keyword
13220 @cindex @code{nologreschedule}, STARTUP keyword
13221 @cindex @code{logredeadline}, STARTUP keyword
13222 @cindex @code{lognoteredeadline}, STARTUP keyword
13223 @cindex @code{nologredeadline}, STARTUP keyword
13224 @cindex @code{logrefile}, STARTUP keyword
13225 @cindex @code{lognoterefile}, STARTUP keyword
13226 @cindex @code{nologrefile}, STARTUP keyword
13228 logdone @r{record a timestamp when an item is marked DONE}
13229 lognotedone @r{record timestamp and a note when DONE}
13230 nologdone @r{don't record when items are marked DONE}
13231 logrepeat @r{record a time when reinstating a repeating item}
13232 lognoterepeat @r{record a note when reinstating a repeating item}
13233 nologrepeat @r{do not record when reinstating repeating item}
13234 lognoteclock-out @r{record a note when clocking out}
13235 nolognoteclock-out @r{don't record a note when clocking out}
13236 logreschedule @r{record a timestamp when scheduling time changes}
13237 lognotereschedule @r{record a note when scheduling time changes}
13238 nologreschedule @r{do not record when a scheduling date changes}
13239 logredeadline @r{record a timestamp when deadline changes}
13240 lognoteredeadline @r{record a note when deadline changes}
13241 nologredeadline @r{do not record when a deadline date changes}
13242 logrefile @r{record a timestamp when refiling}
13243 lognoterefile @r{record a note when refiling}
13244 nologrefile @r{do not record when refiling}
13246 @vindex org-hide-leading-stars
13247 @vindex org-odd-levels-only
13248 Here are the options for hiding leading stars in outline headings, and for
13249 indenting outlines. The corresponding variables are
13250 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
13251 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
13252 @cindex @code{hidestars}, STARTUP keyword
13253 @cindex @code{showstars}, STARTUP keyword
13254 @cindex @code{odd}, STARTUP keyword
13255 @cindex @code{even}, STARTUP keyword
13257 hidestars @r{make all but one of the stars starting a headline invisible.}
13258 showstars @r{show all stars starting a headline}
13259 indent @r{virtual indentation according to outline level}
13260 noindent @r{no virtual indentation according to outline level}
13261 odd @r{allow only odd outline levels (1,3,...)}
13262 oddeven @r{allow all outline levels}
13264 @vindex org-put-time-stamp-overlays
13265 @vindex org-time-stamp-overlay-formats
13266 To turn on custom format overlays over timestamps (variables
13267 @code{org-put-time-stamp-overlays} and
13268 @code{org-time-stamp-overlay-formats}), use
13269 @cindex @code{customtime}, STARTUP keyword
13271 customtime @r{overlay custom time format}
13273 @vindex constants-unit-system
13274 The following options influence the table spreadsheet (variable
13275 @code{constants-unit-system}).
13276 @cindex @code{constcgs}, STARTUP keyword
13277 @cindex @code{constSI}, STARTUP keyword
13279 constcgs @r{@file{constants.el} should use the c-g-s unit system}
13280 constSI @r{@file{constants.el} should use the SI unit system}
13282 @vindex org-footnote-define-inline
13283 @vindex org-footnote-auto-label
13284 @vindex org-footnote-auto-adjust
13285 To influence footnote settings, use the following keywords. The
13286 corresponding variables are @code{org-footnote-define-inline},
13287 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
13288 @cindex @code{fninline}, STARTUP keyword
13289 @cindex @code{nofninline}, STARTUP keyword
13290 @cindex @code{fnlocal}, STARTUP keyword
13291 @cindex @code{fnprompt}, STARTUP keyword
13292 @cindex @code{fnauto}, STARTUP keyword
13293 @cindex @code{fnconfirm}, STARTUP keyword
13294 @cindex @code{fnplain}, STARTUP keyword
13295 @cindex @code{fnadjust}, STARTUP keyword
13296 @cindex @code{nofnadjust}, STARTUP keyword
13298 fninline @r{define footnotes inline}
13299 fnnoinline @r{define footnotes in separate section}
13300 fnlocal @r{define footnotes near first reference, but not inline}
13301 fnprompt @r{prompt for footnote labels}
13302 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
13303 fnconfirm @r{offer automatic label for editing or confirmation}
13304 fnplain @r{create @code{[1]}-like labels automatically}
13305 fnadjust @r{automatically renumber and sort footnotes}
13306 nofnadjust @r{do not renumber and sort automatically}
13308 @cindex org-hide-block-startup
13309 To hide blocks on startup, use these keywords. The corresponding variable is
13310 @code{org-hide-block-startup}.
13311 @cindex @code{hideblocks}, STARTUP keyword
13312 @cindex @code{nohideblocks}, STARTUP keyword
13314 hideblocks @r{Hide all begin/end blocks on startup}
13315 nohideblocks @r{Do not hide blocks on startup}
13317 @cindex org-pretty-entities
13318 The display of entities as UTF-8 characters is governed by the variable
13319 @code{org-pretty-entities} and the keywords
13320 @cindex @code{entitiespretty}, STARTUP keyword
13321 @cindex @code{entitiesplain}, STARTUP keyword
13323 entitiespretty @r{Show entities as UTF-8 characters where possible}
13324 entitiesplain @r{Leave entities plain}
13326 @item #+TAGS: TAG1(c1) TAG2(c2)
13327 @vindex org-tag-alist
13328 These lines (several such lines are allowed) specify the valid tags in
13329 this file, and (potentially) the corresponding @emph{fast tag selection}
13330 keys. The corresponding variable is @code{org-tag-alist}.
13332 This line contains the formulas for the table directly above the line.
13333 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
13334 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
13335 @itemx #+DESCRIPTION:, #+KEYWORDS:,
13336 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
13337 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
13338 These lines provide settings for exporting files. For more details see
13339 @ref{Export options}.
13340 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
13341 @vindex org-todo-keywords
13342 These lines set the TODO keywords and their interpretation in the
13343 current file. The corresponding variable is @code{org-todo-keywords}.
13346 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
13347 @section The very busy C-c C-c key
13349 @cindex C-c C-c, overview
13351 The key @kbd{C-c C-c} has many purposes in Org, which are all
13352 mentioned scattered throughout this manual. One specific function of
13353 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
13354 other circumstances it means something like @emph{``Hey Org, look
13355 here and update according to what you see here''}. Here is a summary of
13356 what this means in different contexts.
13360 If there are highlights in the buffer from the creation of a sparse
13361 tree, or from clock display, remove these highlights.
13363 If the cursor is in one of the special @code{#+KEYWORD} lines, this
13364 triggers scanning the buffer for these lines and updating the
13367 If the cursor is inside a table, realign the table. This command
13368 works even if the automatic table editor has been turned off.
13370 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
13373 If the current buffer is a capture buffer, close the note and file it.
13374 With a prefix argument, file it, without further interaction, to the
13377 If the cursor is on a @code{<<<target>>>}, update radio targets and
13378 corresponding links in this buffer.
13380 If the cursor is in a property line or at the start or end of a property
13381 drawer, offer property commands.
13383 If the cursor is at a footnote reference, go to the corresponding
13384 definition, and vice versa.
13386 If the cursor is on a statistics cookie, update it.
13388 If the cursor is in a plain list item with a checkbox, toggle the status
13391 If the cursor is on a numbered item in a plain list, renumber the
13394 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
13398 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
13399 @section A cleaner outline view
13400 @cindex hiding leading stars
13401 @cindex dynamic indentation
13402 @cindex odd-levels-only outlines
13403 @cindex clean outline view
13405 Some people find it noisy and distracting that the Org headlines start with a
13406 potentially large number of stars, and that text below the headlines is not
13407 indented. While this is no problem when writing a @emph{book-like} document
13408 where the outline headings are really section headings, in a more
13409 @emph{list-oriented} outline, indented structure is a lot cleaner:
13413 * Top level headline | * Top level headline
13414 ** Second level | * Second level
13415 *** 3rd level | * 3rd level
13416 some text | some text
13417 *** 3rd level | * 3rd level
13418 more text | more text
13419 * Another top level headline | * Another top level headline
13425 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
13426 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
13427 be achieved dynamically at display time using @code{org-indent-mode}. In
13428 this minor mode, all lines are prefixed for display with the necessary amount
13429 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
13430 property, such that @code{visual-line-mode} (or purely setting
13431 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
13432 }. Also headlines are prefixed with additional stars, so that the amount of
13433 indentation shifts by two@footnote{See the variable
13434 @code{org-indent-indentation-per-level}.} spaces per level. All headline
13435 stars but the last one are made invisible using the @code{org-hide}
13436 face@footnote{Turning on @code{org-indent-mode} sets
13437 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
13438 @code{nil}.} - see below under @samp{2.} for more information on how this
13439 works. You can turn on @code{org-indent-mode} for all files by customizing
13440 the variable @code{org-startup-indented}, or you can turn it on for
13441 individual files using
13447 If you want a similar effect in an earlier version of Emacs and/or Org, or if
13448 you want the indentation to be hard space characters so that the plain text
13449 file looks as similar as possible to the Emacs display, Org supports you in
13454 @emph{Indentation of text below headlines}@*
13455 You may indent text below each headline to make the left boundary line up
13456 with the headline, like
13460 more text, now indented
13463 @vindex org-adapt-indentation
13464 Org supports this with paragraph filling, line wrapping, and structure
13465 editing@footnote{See also the variable @code{org-adapt-indentation}.},
13466 preserving or adapting the indentation as appropriate.
13469 @vindex org-hide-leading-stars
13470 @emph{Hiding leading stars}@* You can modify the display in such a way that
13471 all leading stars become invisible. To do this in a global way, configure
13472 the variable @code{org-hide-leading-stars} or change this on a per-file basis
13476 #+STARTUP: hidestars
13477 #+STARTUP: showstars
13480 With hidden stars, the tree becomes:
13484 * Top level headline
13492 @vindex org-hide @r{(face)}
13493 The leading stars are not truly replaced by whitespace, they are only
13494 fontified with the face @code{org-hide} that uses the background color as
13495 font color. If you are not using either white or black background, you may
13496 have to customize this face to get the wanted effect. Another possibility is
13497 to set this font such that the extra stars are @i{almost} invisible, for
13498 example using the color @code{grey90} on a white background.
13501 @vindex org-odd-levels-only
13502 Things become cleaner still if you skip all the even levels and use only odd
13503 levels 1, 3, 5..., effectively adding two stars to go from one outline level
13504 to the next@footnote{When you need to specify a level for a property search
13505 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
13506 way we get the outline view shown at the beginning of this section. In order
13507 to make the structure editing and export commands handle this convention
13508 correctly, configure the variable @code{org-odd-levels-only}, or set this on
13509 a per-file basis with one of the following lines:
13516 You can convert an Org file from single-star-per-level to the
13517 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
13518 RET} in that file. The reverse operation is @kbd{M-x
13519 org-convert-to-oddeven-levels}.
13522 @node TTY keys, Interaction, Clean view, Miscellaneous
13523 @section Using Org on a tty
13524 @cindex tty key bindings
13526 Because Org contains a large number of commands, by default many of
13527 Org's core commands are bound to keys that are generally not
13528 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
13529 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
13530 together with modifiers like @key{Meta} and/or @key{Shift}. To access
13531 these commands on a tty when special keys are unavailable, the following
13532 alternative bindings can be used. The tty bindings below will likely be
13533 more cumbersome; you may find for some of the bindings below that a
13534 customized workaround suits you better. For example, changing a timestamp
13535 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
13536 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
13538 @multitable @columnfractions 0.15 0.2 0.1 0.2
13539 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
13540 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
13541 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
13542 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
13543 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
13544 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
13545 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
13546 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
13547 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
13548 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
13549 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
13550 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
13551 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
13552 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
13553 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
13554 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
13555 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
13556 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
13557 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
13561 @node Interaction, , TTY keys, Miscellaneous
13562 @section Interaction with other packages
13563 @cindex packages, interaction with other
13564 Org lives in the world of GNU Emacs and interacts in various ways
13565 with other code out there.
13568 * Cooperation:: Packages Org cooperates with
13569 * Conflicts:: Packages that lead to conflicts
13572 @node Cooperation, Conflicts, Interaction, Interaction
13573 @subsection Packages that Org cooperates with
13576 @cindex @file{calc.el}
13577 @cindex Gillespie, Dave
13578 @item @file{calc.el} by Dave Gillespie
13579 Org uses the Calc package for implementing spreadsheet
13580 functionality in its tables (@pxref{The spreadsheet}). Org
13581 checks for the availability of Calc by looking for the function
13582 @code{calc-eval} which will have been autoloaded during setup if Calc has
13583 been installed properly. As of Emacs 22, Calc is part of the Emacs
13584 distribution. Another possibility for interaction between the two
13585 packages is using Calc for embedded calculations. @xref{Embedded Mode,
13586 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
13587 @item @file{constants.el} by Carsten Dominik
13588 @cindex @file{constants.el}
13589 @cindex Dominik, Carsten
13590 @vindex org-table-formula-constants
13591 In a table formula (@pxref{The spreadsheet}), it is possible to use
13592 names for natural constants or units. Instead of defining your own
13593 constants in the variable @code{org-table-formula-constants}, install
13594 the @file{constants} package which defines a large number of constants
13595 and units, and lets you use unit prefixes like @samp{M} for
13596 @samp{Mega}, etc@. You will need version 2.0 of this package, available
13597 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
13598 the function @code{constants-get}, which has to be autoloaded in your
13599 setup. See the installation instructions in the file
13600 @file{constants.el}.
13601 @item @file{cdlatex.el} by Carsten Dominik
13602 @cindex @file{cdlatex.el}
13603 @cindex Dominik, Carsten
13604 Org-mode can make use of the CDLa@TeX{} package to efficiently enter
13605 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
13606 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
13607 @cindex @file{imenu.el}
13608 Imenu allows menu access to an index of items in a file. Org-mode
13609 supports Imenu---all you need to do to get the index is the following:
13611 (add-hook 'org-mode-hook
13612 (lambda () (imenu-add-to-menubar "Imenu")))
13614 @vindex org-imenu-depth
13615 By default the index is two levels deep---you can modify the depth using
13616 the option @code{org-imenu-depth}.
13617 @item @file{remember.el} by John Wiegley
13618 @cindex @file{remember.el}
13619 @cindex Wiegley, John
13620 Org used to use this package for capture, but no longer does.
13621 @item @file{speedbar.el} by Eric M. Ludlam
13622 @cindex @file{speedbar.el}
13623 @cindex Ludlam, Eric M.
13624 Speedbar is a package that creates a special frame displaying files and
13625 index items in files. Org-mode supports Speedbar and allows you to
13626 drill into Org files directly from the Speedbar. It also allows you to
13627 restrict the scope of agenda commands to a file or a subtree by using
13628 the command @kbd{<} in the Speedbar frame.
13629 @cindex @file{table.el}
13630 @item @file{table.el} by Takaaki Ota
13632 @cindex table editor, @file{table.el}
13633 @cindex @file{table.el}
13634 @cindex Ota, Takaaki
13636 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
13637 and alignment can be created using the Emacs table package by Takaaki Ota
13638 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
13639 Org-mode will recognize these tables and export them properly. Because of
13640 interference with other Org-mode functionality, you unfortunately cannot edit
13641 these tables directly in the buffer. Instead, you need to use the command
13642 @kbd{C-c '} to edit them, similar to source code snippets.
13645 @orgcmd{C-c ',org-edit-special}
13646 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
13648 @orgcmd{C-c ~,org-table-create-with-table.el}
13649 Insert a @file{table.el} table. If there is already a table at point, this
13650 command converts it between the @file{table.el} format and the Org-mode
13651 format. See the documentation string of the command
13652 @code{org-convert-table} for the restrictions under which this is
13655 @file{table.el} is part of Emacs since Emacs 22.
13656 @item @file{footnote.el} by Steven L. Baur
13657 @cindex @file{footnote.el}
13658 @cindex Baur, Steven L.
13659 Org-mode recognizes numerical footnotes as provided by this package.
13660 However, Org-mode also has its own footnote support (@pxref{Footnotes}),
13661 which makes using @file{footnote.el} unnecessary.
13664 @node Conflicts, , Cooperation, Interaction
13665 @subsection Packages that lead to conflicts with Org-mode
13669 @cindex @code{shift-selection-mode}
13670 @vindex org-support-shift-select
13671 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
13672 cursor motions combined with the shift key should start or enlarge regions.
13673 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
13674 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
13675 at such a location. By default, @kbd{S-@key{cursor}} commands outside
13676 special contexts don't do anything, but you can customize the variable
13677 @code{org-support-shift-select}. Org-mode then tries to accommodate shift
13678 selection by (i) using it outside of the special contexts where special
13679 commands apply, and by (ii) extending an existing active region even if the
13680 cursor moves across a special context.
13682 @item @file{CUA.el} by Kim. F. Storm
13683 @cindex @file{CUA.el}
13684 @cindex Storm, Kim. F.
13685 @vindex org-replace-disputed-keys
13686 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
13687 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
13688 region. In fact, Emacs 23 has this built-in in the form of
13689 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
13690 23, you probably don't want to use another package for this purpose. However,
13691 if you prefer to leave these keys to a different package while working in
13692 Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
13693 Org will move the following key bindings in Org files, and in the agenda
13694 buffer (but not during date selection).
13697 S-UP @result{} M-p S-DOWN @result{} M-n
13698 S-LEFT @result{} M-- S-RIGHT @result{} M-+
13699 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
13702 @vindex org-disputed-keys
13703 Yes, these are unfortunately more difficult to remember. If you want
13704 to have other replacement keys, look at the variable
13705 @code{org-disputed-keys}.
13707 @item @file{yasnippet.el}
13708 @cindex @file{yasnippet.el}
13709 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
13710 @code{"\t"}) overrules YASnippet's access to this key. The following code
13711 fixed this problem:
13714 (add-hook 'org-mode-hook
13716 (org-set-local 'yas/trigger-key [tab])
13717 (define-key yas/keymap [tab] 'yas/next-field-group)))
13720 The latest version of yasnippet doesn't play well with Org mode. If the
13721 above code does not fix the conflict, start by defining the following
13725 (defun yas/org-very-safe-expand ()
13726 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
13729 Then, tell Org mode what to do with the new function:
13732 (add-hook 'org-mode-hook
13734 (make-variable-buffer-local 'yas/trigger-key)
13735 (setq yas/trigger-key [tab])
13736 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
13737 (define-key yas/keymap [tab] 'yas/next-field)))
13740 @item @file{windmove.el} by Hovav Shacham
13741 @cindex @file{windmove.el}
13742 This package also uses the @kbd{S-<cursor>} keys, so everything written
13743 in the paragraph above about CUA mode also applies here. If you want make
13744 the windmove function active in locations where Org-mode does not have
13745 special functionality on @kbd{S-@key{cursor}}, add this to your
13749 ;; Make windmove work in org-mode:
13750 (add-hook 'org-shiftup-final-hook 'windmove-up)
13751 (add-hook 'org-shiftleft-final-hook 'windmove-left)
13752 (add-hook 'org-shiftdown-final-hook 'windmove-down)
13753 (add-hook 'org-shiftright-final-hook 'windmove-right)
13756 @item @file{viper.el} by Michael Kifer
13757 @cindex @file{viper.el}
13759 Viper uses @kbd{C-c /} and therefore makes this key not access the
13760 corresponding Org-mode command @code{org-sparse-tree}. You need to find
13761 another key for this command, or override the key in
13762 @code{viper-vi-global-user-map} with
13765 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
13771 @node Hacking, MobileOrg, Miscellaneous, Top
13775 This appendix covers some aspects where users can extend the functionality of
13779 * Hooks:: Who to reach into Org's internals
13780 * Add-on packages:: Available extensions
13781 * Adding hyperlink types:: New custom link types
13782 * Context-sensitive commands:: How to add functionality to such commands
13783 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
13784 * Dynamic blocks:: Automatically filled blocks
13785 * Special agenda views:: Customized views
13786 * Extracting agenda information:: Postprocessing of agenda information
13787 * Using the property API:: Writing programs that use entry properties
13788 * Using the mapping API:: Mapping over all or selected entries
13791 @node Hooks, Add-on packages, Hacking, Hacking
13795 Org has a large number of hook variables that can be used to add
13796 functionality. This appendix about hacking is going to illustrate the
13797 use of some of them. A complete list of all hooks with documentation is
13798 maintained by the Worg project and can be found at
13799 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
13801 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
13802 @section Add-on packages
13803 @cindex add-on packages
13805 A large number of add-on packages have been written by various authors.
13806 These packages are not part of Emacs, but they are distributed as contributed
13807 packages with the separate release available at the Org-mode home page at
13808 @uref{http://orgmode.org}. The list of contributed packages, along with
13809 documentation about each package, is maintained by the Worg project at
13810 @uref{http://orgmode.org/worg/org-contrib/}.
13814 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
13815 @section Adding hyperlink types
13816 @cindex hyperlinks, adding new types
13818 Org has a large number of hyperlink types built-in
13819 (@pxref{Hyperlinks}). If you would like to add new link types, Org
13820 provides an interface for doing so. Let's look at an example file,
13821 @file{org-man.el}, that will add support for creating links like
13822 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
13826 ;;; org-man.el - Support for links to manpages in Org
13830 (org-add-link-type "man" 'org-man-open)
13831 (add-hook 'org-store-link-functions 'org-man-store-link)
13833 (defcustom org-man-command 'man
13834 "The Emacs command to be used to display a man page."
13836 :type '(choice (const man) (const woman)))
13838 (defun org-man-open (path)
13839 "Visit the manpage on PATH.
13840 PATH should be a topic that can be thrown at the man command."
13841 (funcall org-man-command path))
13843 (defun org-man-store-link ()
13844 "Store a link to a manpage."
13845 (when (memq major-mode '(Man-mode woman-mode))
13846 ;; This is a man page, we do make this link
13847 (let* ((page (org-man-get-page-name))
13848 (link (concat "man:" page))
13849 (description (format "Manpage for %s" page)))
13850 (org-store-link-props
13853 :description description))))
13855 (defun org-man-get-page-name ()
13856 "Extract the page name from the buffer name."
13857 ;; This works for both `Man-mode' and `woman-mode'.
13858 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
13859 (match-string 1 (buffer-name))
13860 (error "Cannot create link to this man page")))
13864 ;;; org-man.el ends here
13868 You would activate this new link type in @file{.emacs} with
13875 Let's go through the file and see what it does.
13878 It does @code{(require 'org)} to make sure that @file{org.el} has been
13881 The next line calls @code{org-add-link-type} to define a new link type
13882 with prefix @samp{man}. The call also contains the name of a function
13883 that will be called to follow such a link.
13885 @vindex org-store-link-functions
13886 The next line adds a function to @code{org-store-link-functions}, in
13887 order to allow the command @kbd{C-c l} to record a useful link in a
13888 buffer displaying a man page.
13891 The rest of the file defines the necessary variables and functions.
13892 First there is a customization variable that determines which Emacs
13893 command should be used to display man pages. There are two options,
13894 @code{man} and @code{woman}. Then the function to follow a link is
13895 defined. It gets the link path as an argument---in this case the link
13896 path is just a topic for the manual command. The function calls the
13897 value of @code{org-man-command} to display the man page.
13899 Finally the function @code{org-man-store-link} is defined. When you try
13900 to store a link with @kbd{C-c l}, this function will be called to
13901 try to make a link. The function must first decide if it is supposed to
13902 create the link for this buffer type; we do this by checking the value
13903 of the variable @code{major-mode}. If not, the function must exit and
13904 return the value @code{nil}. If yes, the link is created by getting the
13905 manual topic from the buffer name and prefixing it with the string
13906 @samp{man:}. Then it must call the command @code{org-store-link-props}
13907 and set the @code{:type} and @code{:link} properties. Optionally you
13908 can also set the @code{:description} property to provide a default for
13909 the link description when the link is later inserted into an Org
13910 buffer with @kbd{C-c C-l}.
13912 When it makes sense for your new link type, you may also define a function
13913 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
13914 support for inserting such a link with @kbd{C-c C-l}. Such a function should
13915 not accept any arguments, and return the full link with prefix.
13917 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
13918 @section Context-sensitive commands
13919 @cindex context-sensitive commands, hooks
13920 @cindex add-ons, context-sensitive commands
13921 @vindex org-ctrl-c-ctrl-c-hook
13923 Org has several commands that act differently depending on context. The most
13924 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
13925 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
13927 Add-ons can tap into this functionality by providing a function that detects
13928 special context for that add-on and executes functionality appropriate for
13929 the context. Here is an example from Dan Davison's @file{org-R.el} which
13930 allows you to evaluate commands based on the @file{R} programming language
13931 @footnote{@file{org-R.el} has been replaced by the org-mode functionality
13932 described in @ref{Working With Source Code} and is now obsolete.}. For this
13933 package, special contexts are lines that start with @code{#+R:} or
13937 (defun org-R-apply-maybe ()
13938 "Detect if this is context for org-R and execute R commands."
13939 (if (save-excursion
13940 (beginning-of-line 1)
13941 (looking-at "#\\+RR?:"))
13942 (progn (call-interactively 'org-R-apply)
13943 t) ;; to signal that we took action
13944 nil)) ;; to signal that we did not
13946 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
13949 The function first checks if the cursor is in such a line. If that is the
13950 case, @code{org-R-apply} is called and the function returns @code{t} to
13951 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
13952 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
13955 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
13956 @section Tables and lists in arbitrary syntax
13957 @cindex tables, in other modes
13958 @cindex lists, in other modes
13959 @cindex Orgtbl mode
13961 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
13962 frequent feature request has been to make it work with native tables in
13963 specific languages, for example @LaTeX{}. However, this is extremely
13964 hard to do in a general way, would lead to a customization nightmare,
13965 and would take away much of the simplicity of the Orgtbl-mode table
13968 This appendix describes a different approach. We keep the Orgtbl mode
13969 table in its native format (the @i{source table}), and use a custom
13970 function to @i{translate} the table to the correct syntax, and to
13971 @i{install} it in the right location (the @i{target table}). This puts
13972 the burden of writing conversion functions on the user, but it allows
13973 for a very flexible system.
13975 Bastien added the ability to do the same with lists, in Orgstruct mode. You
13976 can use Org's facilities to edit and structure lists by turning
13977 @code{orgstruct-mode} on, then locally exporting such lists in another format
13978 (HTML, @LaTeX{} or Texinfo.)
13982 * Radio tables:: Sending and receiving radio tables
13983 * A LaTeX example:: Step by step, almost a tutorial
13984 * Translator functions:: Copy and modify
13985 * Radio lists:: Doing the same for lists
13988 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
13989 @subsection Radio tables
13990 @cindex radio tables
13992 To define the location of the target table, you first need to create two
13993 lines that are comments in the current mode, but contain magic words for
13994 Orgtbl mode to find. Orgtbl mode will insert the translated table
13995 between these lines, replacing whatever was there before. For example:
13998 /* BEGIN RECEIVE ORGTBL table_name */
13999 /* END RECEIVE ORGTBL table_name */
14003 Just above the source table, we put a special line that tells
14004 Orgtbl mode how to translate this table and where to install it. For
14008 #+ORGTBL: SEND table_name translation_function arguments....
14012 @code{table_name} is the reference name for the table that is also used
14013 in the receiver lines. @code{translation_function} is the Lisp function
14014 that does the translation. Furthermore, the line can contain a list of
14015 arguments (alternating key and value) at the end. The arguments will be
14016 passed as a property list to the translation function for
14017 interpretation. A few standard parameters are already recognized and
14018 acted upon before the translation function is called:
14022 Skip the first N lines of the table. Hlines do count as separate lines for
14025 @item :skipcols (n1 n2 ...)
14026 List of columns that should be skipped. If the table has a column with
14027 calculation marks, that column is automatically discarded as well.
14028 Please note that the translator function sees the table @emph{after} the
14029 removal of these columns, the function never knows that there have been
14030 additional columns.
14034 The one problem remaining is how to keep the source table in the buffer
14035 without disturbing the normal workings of the file, for example during
14036 compilation of a C file or processing of a @LaTeX{} file. There are a
14037 number of different solutions:
14041 The table could be placed in a block comment if that is supported by the
14042 language. For example, in C mode you could wrap the table between
14043 @samp{/*} and @samp{*/} lines.
14045 Sometimes it is possible to put the table after some kind of @i{END}
14046 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
14049 You can just comment the table line-by-line whenever you want to process
14050 the file, and uncomment it whenever you need to edit the table. This
14051 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
14052 makes this comment-toggling very easy, in particular if you bind it to a
14056 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
14057 @subsection A @LaTeX{} example of radio tables
14058 @cindex @LaTeX{}, and Orgtbl mode
14060 The best way to wrap the source table in @LaTeX{} is to use the
14061 @code{comment} environment provided by @file{comment.sty}. It has to be
14062 activated by placing @code{\usepackage@{comment@}} into the document
14063 header. Orgtbl mode can insert a radio table skeleton@footnote{By
14064 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
14065 variable @code{orgtbl-radio-tables} to install templates for other
14066 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
14067 be prompted for a table name, let's say we use @samp{salesfigures}. You
14068 will then get the following template:
14070 @cindex #+ORGTBL, SEND
14072 % BEGIN RECEIVE ORGTBL salesfigures
14073 % END RECEIVE ORGTBL salesfigures
14075 #+ORGTBL: SEND salesfigures orgtbl-to-latex
14081 @vindex @LaTeX{}-verbatim-environments
14082 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
14083 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
14084 into the receiver location with name @code{salesfigures}. You may now
14085 fill in the table---feel free to use the spreadsheet features@footnote{If
14086 the @samp{#+TBLFM} line contains an odd number of dollar characters,
14087 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
14088 example you can fix this by adding an extra line inside the
14089 @code{comment} environment that is used to balance the dollar
14090 expressions. If you are using AUC@TeX{} with the font-latex library, a
14091 much better solution is to add the @code{comment} environment to the
14092 variable @code{LaTeX-verbatim-environments}.}:
14095 % BEGIN RECEIVE ORGTBL salesfigures
14096 % END RECEIVE ORGTBL salesfigures
14098 #+ORGTBL: SEND salesfigures orgtbl-to-latex
14099 | Month | Days | Nr sold | per day |
14100 |-------+------+---------+---------|
14101 | Jan | 23 | 55 | 2.4 |
14102 | Feb | 21 | 16 | 0.8 |
14103 | March | 22 | 278 | 12.6 |
14104 #+TBLFM: $4=$3/$2;%.1f
14105 % $ (optional extra dollar to keep font-lock happy, see footnote)
14110 When you are done, press @kbd{C-c C-c} in the table to get the converted
14111 table inserted between the two marker lines.
14113 Now let's assume you want to make the table header by hand, because you
14114 want to control how columns are aligned, etc@. In this case we make sure
14115 that the table translator skips the first 2 lines of the source
14116 table, and tell the command to work as a @i{splice}, i.e.@: to not produce
14117 header and footer commands of the target table:
14120 \begin@{tabular@}@{lrrr@}
14121 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
14122 % BEGIN RECEIVE ORGTBL salesfigures
14123 % END RECEIVE ORGTBL salesfigures
14127 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
14128 | Month | Days | Nr sold | per day |
14129 |-------+------+---------+---------|
14130 | Jan | 23 | 55 | 2.4 |
14131 | Feb | 21 | 16 | 0.8 |
14132 | March | 22 | 278 | 12.6 |
14133 #+TBLFM: $4=$3/$2;%.1f
14137 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
14138 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
14139 and marks horizontal lines with @code{\hline}. Furthermore, it
14140 interprets the following parameters (see also @pxref{Translator functions}):
14143 @item :splice nil/t
14144 When set to t, return only table body lines, don't wrap them into a
14145 tabular environment. Default is nil.
14148 A format to be used to wrap each field, it should contain @code{%s} for the
14149 original field value. For example, to wrap each field value in dollars,
14150 you could use @code{:fmt "$%s$"}. This may also be a property list with
14151 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
14152 A function of one argument can be used in place of the strings; the
14153 function must return a formatted string.
14156 Use this format to print numbers with exponentials. The format should
14157 have @code{%s} twice for inserting mantissa and exponent, for example
14158 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
14159 may also be a property list with column numbers and formats, for example
14160 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
14161 @code{efmt} has been applied to a value, @code{fmt} will also be
14162 applied. Similar to @code{fmt}, functions of two arguments can be
14163 supplied instead of strings.
14166 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
14167 @subsection Translator functions
14168 @cindex HTML, and Orgtbl mode
14169 @cindex translator function
14171 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
14172 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
14173 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
14174 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
14175 code that produces tables during HTML export.}, these all use a generic
14176 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
14177 itself is a very short function that computes the column definitions for the
14178 @code{tabular} environment, defines a few field and line separators and then
14179 hands processing over to the generic translator. Here is the entire code:
14183 (defun orgtbl-to-latex (table params)
14184 "Convert the Orgtbl mode TABLE to LaTeX."
14185 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
14186 org-table-last-alignment ""))
14189 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
14190 :tend "\\end@{tabular@}"
14191 :lstart "" :lend " \\\\" :sep " & "
14192 :efmt "%s\\,(%s)" :hline "\\hline")))
14193 (orgtbl-to-generic table (org-combine-plists params2 params))))
14197 As you can see, the properties passed into the function (variable
14198 @var{PARAMS}) are combined with the ones newly defined in the function
14199 (variable @var{PARAMS2}). The ones passed into the function (i.e.@: the
14200 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
14201 would like to use the @LaTeX{} translator, but wanted the line endings to
14202 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
14203 overrule the default with
14206 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
14209 For a new language, you can either write your own converter function in
14210 analogy with the @LaTeX{} translator, or you can use the generic function
14211 directly. For example, if you have a language where a table is started
14212 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
14213 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
14214 separator is a TAB, you could call the generic translator like this (on
14218 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
14219 :lstart "!BL! " :lend " !EL!" :sep "\t"
14223 Please check the documentation string of the function
14224 @code{orgtbl-to-generic} for a full list of parameters understood by
14225 that function, and remember that you can pass each of them into
14226 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
14227 using the generic function.
14229 Of course you can also write a completely new function doing complicated
14230 things the generic translator cannot do. A translator function takes
14231 two arguments. The first argument is the table, a list of lines, each
14232 line either the symbol @code{hline} or a list of fields. The second
14233 argument is the property list containing all parameters specified in the
14234 @samp{#+ORGTBL: SEND} line. The function must return a single string
14235 containing the formatted table. If you write a generally useful
14236 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
14237 others can benefit from your work.
14239 @node Radio lists, , Translator functions, Tables in arbitrary syntax
14240 @subsection Radio lists
14241 @cindex radio lists
14242 @cindex org-list-insert-radio-list
14244 Sending and receiving radio lists works exactly the same way as sending and
14245 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
14246 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
14247 @code{org-list-insert-radio-list}.
14249 Here are the differences with radio tables:
14253 Orgstruct mode must be active.
14255 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
14257 The available translation functions for radio lists don't take
14260 @kbd{C-c C-c} will work when pressed on the first item of the list.
14263 Here is a @LaTeX{} example. Let's say that you have this in your
14268 % BEGIN RECEIVE ORGLST to-buy
14269 % END RECEIVE ORGLST to-buy
14271 #+ORGLST: SEND to-buy org-list-to-latex
14280 Pressing `C-c C-c' on @code{a new house} and will insert the converted
14281 @LaTeX{} list between the two marker lines.
14283 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
14284 @section Dynamic blocks
14285 @cindex dynamic blocks
14287 Org documents can contain @emph{dynamic blocks}. These are
14288 specially marked regions that are updated by some user-written function.
14289 A good example for such a block is the clock table inserted by the
14290 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
14292 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
14293 to the block and can also specify parameters for the function producing
14294 the content of the block.
14296 @cindex #+BEGIN:dynamic block
14298 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
14303 Dynamic blocks are updated with the following commands
14306 @orgcmd{C-c C-x C-u,org-dblock-update}
14307 Update dynamic block at point.
14308 @orgkey{C-u C-c C-x C-u}
14309 Update all dynamic blocks in the current file.
14312 Updating a dynamic block means to remove all the text between BEGIN and
14313 END, parse the BEGIN line for parameters and then call the specific
14314 writer function for this block to insert the new content. If you want
14315 to use the original content in the writer function, you can use the
14316 extra parameter @code{:content}.
14318 For a block with name @code{myblock}, the writer function is
14319 @code{org-dblock-write:myblock} with as only parameter a property list
14320 with the parameters given in the begin line. Here is a trivial example
14321 of a block that keeps track of when the block update function was last
14325 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
14331 The corresponding block writer function could look like this:
14334 (defun org-dblock-write:block-update-time (params)
14335 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
14336 (insert "Last block update at: "
14337 (format-time-string fmt (current-time)))))
14340 If you want to make sure that all dynamic blocks are always up-to-date,
14341 you could add the function @code{org-update-all-dblocks} to a hook, for
14342 example @code{before-save-hook}. @code{org-update-all-dblocks} is
14343 written in a way such that it does nothing in buffers that are not in
14346 You can narrow the current buffer to the current dynamic block (like any
14347 other block) with @code{org-narrow-to-block}.
14349 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
14350 @section Special agenda views
14351 @cindex agenda views, user-defined
14353 @vindex org-agenda-skip-function
14354 @vindex org-agenda-skip-function-global
14355 Org provides a special hook that can be used to narrow down the selection
14356 made by these agenda views: @code{todo}, @code{alltodo}, @code{tags},
14357 @code{tags-todo}, @code{tags-tree}. You may specify a function that is used
14358 at each match to verify if the match should indeed be part of the agenda
14359 view, and if not, how much should be skipped. You can specify a global
14360 condition that will be applied to all agenda views, this condition would be
14361 stored in the variable @code{org-agenda-skip-function-global}. More
14362 commonly, such a definition is applied only to specific custom searches,
14363 using @code{org-agenda-skip-function}.
14365 Let's say you want to produce a list of projects that contain a WAITING
14366 tag anywhere in the project tree. Let's further assume that you have
14367 marked all tree headings that define a project with the TODO keyword
14368 PROJECT. In this case you would run a TODO search for the keyword
14369 PROJECT, but skip the match unless there is a WAITING tag anywhere in
14370 the subtree belonging to the project line.
14372 To achieve this, you must write a function that searches the subtree for
14373 the tag. If the tag is found, the function must return @code{nil} to
14374 indicate that this match should not be skipped. If there is no such
14375 tag, return the location of the end of the subtree, to indicate that
14376 search should continue from there.
14379 (defun my-skip-unless-waiting ()
14380 "Skip trees that are not waiting"
14381 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
14382 (if (re-search-forward ":waiting:" subtree-end t)
14383 nil ; tag found, do not skip
14384 subtree-end))) ; tag not found, continue after end of subtree
14387 Now you may use this function in an agenda custom command, for example
14391 (org-add-agenda-custom-command
14392 '("b" todo "PROJECT"
14393 ((org-agenda-skip-function 'my-skip-unless-waiting)
14394 (org-agenda-overriding-header "Projects waiting for something: "))))
14397 @vindex org-agenda-overriding-header
14398 Note that this also binds @code{org-agenda-overriding-header} to get a
14399 meaningful header in the agenda view.
14401 @vindex org-odd-levels-only
14402 @vindex org-agenda-skip-function
14403 A general way to create custom searches is to base them on a search for
14404 entries with a certain level limit. If you want to study all entries with
14405 your custom search function, simply do a search for
14406 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
14407 level number corresponds to order in the hierarchy, not to the number of
14408 stars.}, and then use @code{org-agenda-skip-function} to select the entries
14409 you really want to have.
14411 You may also put a Lisp form into @code{org-agenda-skip-function}. In
14412 particular, you may use the functions @code{org-agenda-skip-entry-if}
14413 and @code{org-agenda-skip-subtree-if} in this form, for example:
14416 @item '(org-agenda-skip-entry-if 'scheduled)
14417 Skip current entry if it has been scheduled.
14418 @item '(org-agenda-skip-entry-if 'notscheduled)
14419 Skip current entry if it has not been scheduled.
14420 @item '(org-agenda-skip-entry-if 'deadline)
14421 Skip current entry if it has a deadline.
14422 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
14423 Skip current entry if it has a deadline, or if it is scheduled.
14424 @item '(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
14425 Skip current entry if the TODO keyword is TODO or WAITING.
14426 @item '(org-agenda-skip-entry-if 'todo 'done)
14427 Skip current entry if the TODO keyword marks a DONE state.
14428 @item '(org-agenda-skip-entry-if 'timestamp)
14429 Skip current entry if it has any timestamp, may also be deadline or scheduled.
14430 @item '(org-agenda-skip-entry 'regexp "regular expression")
14431 Skip current entry if the regular expression matches in the entry.
14432 @item '(org-agenda-skip-entry 'notregexp "regular expression")
14433 Skip current entry unless the regular expression matches.
14434 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
14435 Same as above, but check and skip the entire subtree.
14438 Therefore we could also have written the search for WAITING projects
14439 like this, even without defining a special function:
14442 (org-add-agenda-custom-command
14443 '("b" todo "PROJECT"
14444 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
14445 'regexp ":waiting:"))
14446 (org-agenda-overriding-header "Projects waiting for something: "))))
14449 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
14450 @section Extracting agenda information
14451 @cindex agenda, pipe
14452 @cindex Scripts, for agenda processing
14454 @vindex org-agenda-custom-commands
14455 Org provides commands to access agenda information for the command
14456 line in Emacs batch mode. This extracted information can be sent
14457 directly to a printer, or it can be read by a program that does further
14458 processing of the data. The first of these commands is the function
14459 @code{org-batch-agenda}, that produces an agenda view and sends it as
14460 ASCII text to STDOUT. The command takes a single string as parameter.
14461 If the string has length 1, it is used as a key to one of the commands
14462 you have configured in @code{org-agenda-custom-commands}, basically any
14463 key you can use after @kbd{C-c a}. For example, to directly print the
14464 current TODO list, you could use
14467 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
14470 If the parameter is a string with 2 or more characters, it is used as a
14471 tags/TODO match string. For example, to print your local shopping list
14472 (all items with the tag @samp{shop}, but excluding the tag
14473 @samp{NewYork}), you could use
14476 emacs -batch -l ~/.emacs \
14477 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
14481 You may also modify parameters on the fly like this:
14484 emacs -batch -l ~/.emacs \
14485 -eval '(org-batch-agenda "a" \
14486 org-agenda-span month \
14487 org-agenda-include-diary nil \
14488 org-agenda-files (quote ("~/org/project.org")))' \
14493 which will produce a 30-day agenda, fully restricted to the Org file
14494 @file{~/org/projects.org}, not even including the diary.
14496 If you want to process the agenda data in more sophisticated ways, you
14497 can use the command @code{org-batch-agenda-csv} to get a comma-separated
14498 list of values for each agenda item. Each line in the output will
14499 contain a number of fields separated by commas. The fields in a line
14503 category @r{The category of the item}
14504 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
14505 type @r{The type of the agenda entry, can be}
14506 todo @r{selected in TODO match}
14507 tagsmatch @r{selected in tags match}
14508 diary @r{imported from diary}
14509 deadline @r{a deadline}
14510 scheduled @r{scheduled}
14511 timestamp @r{appointment, selected by timestamp}
14512 closed @r{entry was closed on date}
14513 upcoming-deadline @r{warning about nearing deadline}
14514 past-scheduled @r{forwarded scheduled item}
14515 block @r{entry has date block including date}
14516 todo @r{The TODO keyword, if any}
14517 tags @r{All tags including inherited ones, separated by colons}
14518 date @r{The relevant date, like 2007-2-14}
14519 time @r{The time, like 15:00-16:50}
14520 extra @r{String with extra planning info}
14521 priority-l @r{The priority letter if any was given}
14522 priority-n @r{The computed numerical priority}
14526 Time and date will only be given if a timestamp (or deadline/scheduled)
14527 led to the selection of the item.
14529 A CSV list like this is very easy to use in a post-processing script.
14530 For example, here is a Perl program that gets the TODO list from
14531 Emacs/Org and prints all the items, preceded by a checkbox:
14536 # define the Emacs command to run
14537 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
14539 # run it and capture the output
14540 $agenda = qx@{$cmd 2>/dev/null@};
14542 # loop over all lines
14543 foreach $line (split(/\n/,$agenda)) @{
14544 # get the individual values
14545 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
14546 $priority_l,$priority_n) = split(/,/,$line);
14547 # process and print
14548 print "[ ] $head\n";
14552 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
14553 @section Using the property API
14554 @cindex API, for properties
14555 @cindex properties, API
14557 Here is a description of the functions that can be used to work with
14560 @defun org-entry-properties &optional pom which
14561 Get all properties of the entry at point-or-marker POM.@*
14562 This includes the TODO keyword, the tags, time strings for deadline,
14563 scheduled, and clocking, and any additional properties defined in the
14564 entry. The return value is an alist. Keys may occur multiple times
14565 if the property key was used several times.@*
14566 POM may also be nil, in which case the current entry is used.
14567 If WHICH is nil or `all', get all properties. If WHICH is
14568 `special' or `standard', only get that subclass.
14570 @vindex org-use-property-inheritance
14571 @defun org-entry-get pom property &optional inherit
14572 Get value of PROPERTY for entry at point-or-marker POM. By default,
14573 this only looks at properties defined locally in the entry. If INHERIT
14574 is non-nil and the entry does not have the property, then also check
14575 higher levels of the hierarchy. If INHERIT is the symbol
14576 @code{selective}, use inheritance if and only if the setting of
14577 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
14580 @defun org-entry-delete pom property
14581 Delete the property PROPERTY from entry at point-or-marker POM.
14584 @defun org-entry-put pom property value
14585 Set PROPERTY to VALUE for entry at point-or-marker POM.
14588 @defun org-buffer-property-keys &optional include-specials
14589 Get all property keys in the current buffer.
14592 @defun org-insert-property-drawer
14593 Insert a property drawer at point.
14596 @defun org-entry-put-multivalued-property pom property &rest values
14597 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
14598 strings. They will be concatenated, with spaces as separators.
14601 @defun org-entry-get-multivalued-property pom property
14602 Treat the value of the property PROPERTY as a whitespace-separated list of
14603 values and return the values as a list of strings.
14606 @defun org-entry-add-to-multivalued-property pom property value
14607 Treat the value of the property PROPERTY as a whitespace-separated list of
14608 values and make sure that VALUE is in this list.
14611 @defun org-entry-remove-from-multivalued-property pom property value
14612 Treat the value of the property PROPERTY as a whitespace-separated list of
14613 values and make sure that VALUE is @emph{not} in this list.
14616 @defun org-entry-member-in-multivalued-property pom property value
14617 Treat the value of the property PROPERTY as a whitespace-separated list of
14618 values and check if VALUE is in this list.
14621 @defopt org-property-allowed-value-functions
14622 Hook for functions supplying allowed values for a specific property.
14623 The functions must take a single argument, the name of the property, and
14624 return a flat list of allowed values. If @samp{:ETC} is one of
14625 the values, use the values as completion help, but allow also other values
14626 to be entered. The functions must return @code{nil} if they are not
14627 responsible for this property.
14630 @node Using the mapping API, , Using the property API, Hacking
14631 @section Using the mapping API
14632 @cindex API, for mapping
14633 @cindex mapping entries, API
14635 Org has sophisticated mapping capabilities to find all entries satisfying
14636 certain criteria. Internally, this functionality is used to produce agenda
14637 views, but there is also an API that can be used to execute arbitrary
14638 functions for each or selected entries. The main entry point for this API
14641 @defun org-map-entries func &optional match scope &rest skip
14642 Call FUNC at each headline selected by MATCH in SCOPE.
14644 FUNC is a function or a Lisp form. The function will be called without
14645 arguments, with the cursor positioned at the beginning of the headline.
14646 The return values of all calls to the function will be collected and
14647 returned as a list.
14649 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14650 does not need to preserve point. After evaluation, the cursor will be
14651 moved to the end of the line (presumably of the headline of the
14652 processed entry) and search continues from there. Under some
14653 circumstances, this may not produce the wanted results. For example,
14654 if you have removed (e.g.@: archived) the current (sub)tree it could
14655 mean that the next entry will be skipped entirely. In such cases, you
14656 can specify the position from where search should continue by making
14657 FUNC set the variable `org-map-continue-from' to the desired buffer
14660 MATCH is a tags/property/todo match as it is used in the agenda match view.
14661 Only headlines that are matched by this query will be considered during
14662 the iteration. When MATCH is nil or t, all headlines will be
14663 visited by the iteration.
14665 SCOPE determines the scope of this command. It can be any of:
14668 nil @r{the current buffer, respecting the restriction if any}
14669 tree @r{the subtree started with the entry at point}
14670 file @r{the current buffer, without restriction}
14672 @r{the current buffer, and any archives associated with it}
14673 agenda @r{all agenda files}
14674 agenda-with-archives
14675 @r{all agenda files with any archive files associated with them}
14677 @r{if this is a list, all files in the list will be scanned}
14680 The remaining args are treated as settings for the skipping facilities of
14681 the scanner. The following items can be given here:
14683 @vindex org-agenda-skip-function
14685 archive @r{skip trees with the archive tag}
14686 comment @r{skip trees with the COMMENT keyword}
14687 function or Lisp form
14688 @r{will be used as value for @code{org-agenda-skip-function},}
14689 @r{so whenever the function returns t, FUNC}
14690 @r{will not be called for that entry and search will}
14691 @r{continue from the point where the function leaves it}
14695 The function given to that mapping routine can really do anything you like.
14696 It can use the property API (@pxref{Using the property API}) to gather more
14697 information about the entry, or in order to change metadata in the entry.
14698 Here are a couple of functions that might be handy:
14700 @defun org-todo &optional arg
14701 Change the TODO state of the entry. See the docstring of the functions for
14702 the many possible values for the argument ARG.
14705 @defun org-priority &optional action
14706 Change the priority of the entry. See the docstring of this function for the
14707 possible values for ACTION.
14710 @defun org-toggle-tag tag &optional onoff
14711 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
14712 or @code{off} will not toggle tag, but ensure that it is either on or off.
14716 Promote the current entry.
14720 Demote the current entry.
14723 Here is a simple example that will turn all entries in the current file with
14724 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
14725 Entries in comment trees and in archive trees will be ignored.
14729 '(org-todo "UPCOMING")
14730 "+TOMORROW" 'file 'archive 'comment)
14733 The following example counts the number of entries with TODO keyword
14734 @code{WAITING}, in all agenda files.
14737 (length (org-map-entries t "/+WAITING" 'agenda))
14740 @node MobileOrg, History and Acknowledgments, Hacking, Top
14741 @appendix MobileOrg
14745 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
14746 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
14747 @i{MobileOrg} offers offline viewing and capture support for an Org-mode
14748 system rooted on a ``real'' computer. It does also allow you to record
14749 changes to existing entries. Android users should check out
14750 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
14753 This appendix describes the support Org has for creating agenda views in a
14754 format that can be displayed by @i{MobileOrg}, and for integrating notes
14755 captured and changes made by @i{MobileOrg} into the main system.
14757 For changing tags and TODO states in MobileOrg, you should have set up the
14758 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
14759 cover all important tags and TODO keywords, even if individual files use only
14760 part of these. MobileOrg will also offer you states and tags set up with
14761 in-buffer settings, but it will understand the logistics of TODO state
14762 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
14763 (@pxref{Setting tags}) only for those set in these variables.
14766 * Setting up the staging area:: Where to interact with the mobile device
14767 * Pushing to MobileOrg:: Uploading Org files and agendas
14768 * Pulling from MobileOrg:: Integrating captured and flagged items
14771 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
14772 @section Setting up the staging area
14774 MobileOrg needs to interact with Emacs through a directory on a server. If you
14775 are using a public server, you should consider to encrypt the files that are
14776 uploaded to the server. This can be done with Org-mode 7.02 and with
14777 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
14778 installation on your system. To turn on encryption, set a password in
14779 @i{MobileOrg} and, on the Emacs side, configure the variable
14780 @code{org-mobile-use-encryption}@footnote{If you can safely store the
14781 password in your Emacs setup, you might also want to configure
14782 @code{org-mobile-encryption-password}. Please read the docstring of that
14783 variable. Note that encryption will apply only to the contents of the
14784 @file{.org} files. The file names themselves will remain visible.}.
14786 The easiest way to create that directory is to use a free
14787 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
14788 Dropbox, or if your version of MobileOrg does not support it, you can use a
14789 webdav server. For more information, check out the documentation of MobileOrg and also this
14790 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
14791 When MobileOrg first connects to your Dropbox, it will create a directory
14792 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
14796 (setq org-mobile-directory "~/Dropbox/MobileOrg")
14799 Org-mode has commands to put files for @i{MobileOrg} into that directory,
14800 and to read captured notes from there.
14802 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
14803 @section Pushing to MobileOrg
14805 This operation copies all files currently listed in @code{org-mobile-files}
14806 to the directory @code{org-mobile-directory}. By default this list contains
14807 all agenda files (as listed in @code{org-agenda-files}), but additional files
14808 can be included by customizing @code{org-mobiles-files}. File names will be
14809 staged with paths relative to @code{org-directory}, so all files should be
14810 inside this directory. The push operation also creates a special Org file
14811 @file{agendas.org} with all custom agenda view defined by the
14812 user@footnote{While creating the agendas, Org-mode will force ID properties
14813 on all referenced entries, so that these entries can be uniquely identified
14814 if @i{MobileOrg} flags them for further action. If you do not want to get
14815 these properties in so many entries, you can set the variable
14816 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
14817 rely on outline paths, in the hope that these will be unique enough.}.
14818 Finally, Org writes the file @file{index.org}, containing links to all other
14819 files. @i{MobileOrg} first reads this file from the server, and then
14820 downloads all agendas and Org files listed in it. To speed up the download,
14821 MobileOrg will only read files whose checksums@footnote{stored automatically
14822 in the file @file{checksums.dat}} have changed.
14824 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
14825 @section Pulling from MobileOrg
14827 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
14828 files for viewing. It also appends captured entries and pointers to flagged
14829 and changed entries to the file @file{mobileorg.org} on the server. Org has
14830 a @emph{pull} operation that integrates this information into an inbox file
14831 and operates on the pointers to flagged entries. Here is how it works:
14835 Org moves all entries found in
14836 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
14837 operation.} and appends them to the file pointed to by the variable
14838 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
14839 will be a top-level entry in the inbox file.
14841 After moving the entries, Org will attempt to implement the changes made in
14842 @i{MobileOrg}. Some changes are applied directly and without user
14843 interaction. Examples are all changes to tags, TODO state, headline and body
14844 text that can be cleanly applied. Entries that have been flagged for further
14845 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
14846 again. When there is a problem finding an entry or applying the change, the
14847 pointer entry will remain in the inbox and will be marked with an error
14848 message. You need to later resolve these issues by hand.
14850 Org will then generate an agenda view with all flagged entries. The user
14851 should then go through these entries and do whatever actions are necessary.
14852 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
14853 will be displayed in the echo area when the cursor is on the corresponding
14858 Pressing @kbd{?} in that special agenda will display the full flagging note in
14859 another window and also push it onto the kill ring. So you could use @kbd{?
14860 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
14861 Pressing @kbd{?} twice in succession will offer to remove the
14862 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
14863 in a property). In this way you indicate that the intended processing for
14864 this flagged entry is finished.
14869 If you are not able to process all flagged entries directly, you can always
14870 return to this agenda view@footnote{Note, however, that there is a subtle
14871 difference. The view created automatically by @kbd{M-x org-mobile-pull
14872 @key{RET}} is guaranteed to search all files that have been addressed by the
14873 last pull. This might include a file that is not currently in your list of
14874 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
14875 the current agenda files will be searched.} using @kbd{C-c a ?}.
14877 @node History and Acknowledgments, Main Index, MobileOrg, Top
14878 @appendix History and acknowledgments
14879 @cindex acknowledgments
14883 Org was born in 2003, out of frustration over the user interface of the Emacs
14884 Outline mode. I was trying to organize my notes and projects, and using
14885 Emacs seemed to be the natural way to go. However, having to remember eleven
14886 different commands with two or three keys per command, only to hide and show
14887 parts of the outline tree, that seemed entirely unacceptable to me. Also,
14888 when using outlines to take notes, I constantly wanted to restructure the
14889 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
14890 cycling} and @emph{structure editing} were originally implemented in the
14891 package @file{outline-magic.el}, but quickly moved to the more general
14892 @file{org.el}. As this environment became comfortable for project planning,
14893 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
14894 @emph{table support}. These areas highlighted the two main goals that Org
14895 still has today: to be a new, outline-based, plain text mode with innovative
14896 and intuitive editing features, and to incorporate project planning
14897 functionality directly into a notes file.
14899 Since the first release, literally thousands of emails to me or to
14900 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
14901 reports, feedback, new ideas, and sometimes patches and add-on code.
14902 Many thanks to everyone who has helped to improve this package. I am
14903 trying to keep here a list of the people who had significant influence
14904 in shaping one or more aspects of Org. The list may not be
14905 complete, if I have forgotten someone, please accept my apologies and
14908 Before I get to this list, a few special mentions are in order:
14911 @item Bastien Guerry
14912 Bastien has written a large number of extensions to Org (most of them
14913 integrated into the core by now), including the LaTeX exporter and the plain
14914 list parser. His support during the early days, when he basically acted as
14915 co-maintainer, was central to the success of this project. Bastien also
14916 invented Worg, helped establishing the Web presence of Org, and sponsors
14917 hosting costs for the orgmode.org website.
14918 @item Eric Schulte and Dan Davison
14919 Eric and Dan are jointly responsible for the Org-babel system, which turns
14920 Org into a multi-language environment for evaluating code and doing literate
14921 programming and reproducible research.
14923 John has contributed a number of great ideas and patches directly to Org,
14924 including the attachment system (@file{org-attach.el}), integration with
14925 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
14926 items, habit tracking (@file{org-habits.el}), and encryption
14927 (@file{org-crypt.el}). Also, the capture system is really an extended copy
14928 of his great @file{remember.el}.
14929 @item Sebastian Rose
14930 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
14931 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
14932 higher level. He also wrote @file{org-info.js}, a Java script for displaying
14933 webpages derived from Org using an Info-like or a folding interface with
14934 single-key navigation.
14937 @noindent OK, now to the full list of contributions! Again, please let me
14938 know what I am missing here!
14943 @i{Russel Adams} came up with the idea for drawers.
14945 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
14947 @i{Christophe Bataillon} created the great unicorn logo that we use on the
14950 @i{Alex Bochannek} provided a patch for rounding timestamps.
14952 @i{Jan Böcker} wrote @file{org-docview.el}.
14954 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
14956 @i{Tom Breton} wrote @file{org-choose.el}.
14958 @i{Charles Cave}'s suggestion sparked the implementation of templates
14959 for Remember, which are now templates for capture.
14961 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
14964 @i{Gregory Chernov} patched support for Lisp forms into table
14965 calculations and improved XEmacs compatibility, in particular by porting
14966 @file{nouline.el} to XEmacs.
14968 @i{Sacha Chua} suggested copying some linking code from Planner.
14970 @i{Baoqiu Cui} contributed the DocBook exporter.
14972 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
14973 came up with the idea of properties, and that there should be an API for
14976 @i{Nick Dokos} tracked down several nasty bugs.
14978 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
14979 inspired some of the early development, including HTML export. He also
14980 asked for a way to narrow wide table columns.
14982 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
14983 the Org-Babel documentation into the manual.
14985 @i{Christian Egli} converted the documentation into Texinfo format, inspired
14986 the agenda, patched CSS formatting into the HTML exporter, and wrote
14987 @file{org-taskjuggler.el}.
14989 @i{David Emery} provided a patch for custom CSS support in exported
14992 @i{Nic Ferrier} contributed mailcap and XOXO support.
14994 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
14996 @i{John Foerch} figured out how to make incremental search show context
14997 around a match in a hidden outline tree.
14999 @i{Raimar Finken} wrote @file{org-git-line.el}.
15001 @i{Mikael Fornius} works as a mailing list moderator.
15003 @i{Austin Frank} works as a mailing list moderator.
15005 @i{Eric Fraga} drove the development of BEAMER export with ideas and
15008 @i{Barry Gidden} did proofreading the manual in preparation for the book
15009 publication through Network Theory Ltd.
15011 @i{Niels Giesen} had the idea to automatically archive DONE trees.
15013 @i{Nicolas Goaziou} rewrote much of the plain list code.
15015 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
15017 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
15020 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
15021 task state change logging, and the clocktable. His clear explanations have
15022 been critical when we started to adopt the Git version control system.
15024 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
15027 @i{Phil Jackson} wrote @file{org-irc.el}.
15029 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
15030 folded entries, and column view for properties.
15032 @i{Matt Jones} wrote @i{MobileOrg Android}.
15034 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
15036 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
15037 provided frequent feedback and some patches.
15039 @i{Matt Lundin} has proposed last-row references for table formulas and named
15040 invisible anchors. He has also worked a lot on the FAQ.
15042 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
15043 and is a prolific contributor on the mailing list with competent replies,
15044 small fixes and patches.
15046 @i{Jason F. McBrayer} suggested agenda export to CSV format.
15048 @i{Max Mikhanosha} came up with the idea of refiling.
15050 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
15053 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
15056 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
15058 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
15059 and being able to quickly restrict the agenda to a subtree.
15061 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
15063 @i{Greg Newman} refreshed the unicorn logo into its current form.
15065 @i{Tim O'Callaghan} suggested in-file links, search options for general
15066 file links, and TAGS.
15068 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
15069 version of the reference card.
15071 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
15074 @i{Oliver Oppitz} suggested multi-state TODO items.
15076 @i{Scott Otterson} sparked the introduction of descriptive text for
15077 links, among other things.
15079 @i{Pete Phillips} helped during the development of the TAGS feature, and
15080 provided frequent feedback.
15082 @i{Martin Pohlack} provided the code snippet to bundle character insertion
15083 into bundles of 20 for undo.
15085 @i{T.V. Raman} reported bugs and suggested improvements.
15087 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
15090 @i{Paul Rivier} provided the basic implementation of named footnotes. He
15091 also acted as mailing list moderator for some time.
15093 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
15095 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
15096 conflict with @file{allout.el}.
15098 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
15101 @i{Philip Rooke} created the Org reference card, provided lots
15102 of feedback, developed and applied standards to the Org documentation.
15104 @i{Christian Schlauer} proposed angular brackets around links, among
15107 @i{Paul Sexton} wrote @file{org-ctags.el}.
15109 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
15110 @file{organizer-mode.el}.
15112 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
15113 examples, and remote highlighting for referenced code lines.
15115 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
15116 now packaged into Org's @file{contrib} directory.
15118 @i{Daniel Sinder} came up with the idea of internal archiving by locking
15121 @i{Dale Smith} proposed link abbreviations.
15123 @i{James TD Smith} has contributed a large number of patches for useful
15124 tweaks and features.
15126 @i{Adam Spiers} asked for global linking commands, inspired the link
15127 extension system, added support for mairix, and proposed the mapping API.
15129 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
15130 LaTeX, UTF-8, Latin-1 and ASCII.
15132 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
15133 with links transformation to Org syntax.
15135 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
15136 chapter about publishing.
15138 @i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and
15139 enabled source code highlighling in Gnus.
15141 @i{Stefan Vollmar} organized a video-recorded talk at the
15142 Max-Planck-Institute for Neurology. He also inspired the creation of a
15143 concept index for HTML export.
15145 @i{J@"urgen Vollmer} contributed code generating the table of contents
15148 @i{Samuel Wales} has provided important feedback and bug reports.
15150 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
15153 @i{David Wainberg} suggested archiving, and improvements to the linking
15156 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
15159 @i{Roland Winkler} requested additional key bindings to make Org
15162 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
15163 and contributed various ideas and code snippets.
15167 @node Main Index, Key Index, History and Acknowledgments, Top
15168 @unnumbered Concept index
15172 @node Key Index, Command and Function Index, Main Index, Top
15173 @unnumbered Key index
15177 @node Command and Function Index, Variable Index, Key Index, Top
15178 @unnumbered Command and function index
15182 @node Variable Index, , Command and Function Index, Top
15183 @unnumbered Variable index
15185 This is not a complete index of variables and faces, only the ones that are
15186 mentioned in the manual. For a more complete list, use @kbd{M-x
15187 org-customize @key{RET}} and then click yourself through the tree.
15194 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
15197 @c Local variables:
15199 @c indent-tabs-mode: nil
15200 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
15201 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
15205 @c LocalWords: webdavhost pre