4 @setfilename ../../info/org
5 @settitle The Org Manual
8 @set DATE December 2010
10 @c Use proper quote and backtick for code sections in PDF output
11 @c Cf. Texinfo manual 14.2
12 @set txicodequoteundirected
13 @set txicodequotebacktick
15 @c Version and Contact Info
16 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
17 @set AUTHOR Carsten Dominik
18 @set MAINTAINER Carsten Dominik
19 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
20 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
25 @c -----------------------------------------------------------------------------
27 @c Macro definitions for commands and keys
28 @c =======================================
30 @c The behavior of the key/command macros will depend on the flag cmdnames
31 @c When set, commands names are shown. When clear, they are not shown.
35 @c Below we define the following macros for Org key tables:
37 @c orgkey{key} A key item
38 @c orgcmd{key,cmd} Key with command name
39 @c xorgcmd{key,cmmand} Key with command name as @itemx
40 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
41 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
42 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
43 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
44 @c different functions, so format as @itemx
45 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
46 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
47 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
49 @c a key but no command
61 @c one key with a command
62 @c Inserts: @item KEY COMMAND
63 @macro orgcmd{key,command}
68 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
71 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
80 @c One key with one command, formatted using @itemx
81 @c Inserts: @itemx KEY COMMAND
82 @macro xorgcmd{key,command}
87 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
90 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
99 @c one key with a command, bit do not index the key
100 @c Inserts: @item KEY COMMAND
101 @macro orgcmdnki{key,command}
105 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
108 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
116 @c one key with a command, and special text to replace key in item
117 @c Inserts: @item TEXT COMMAND
118 @macro orgcmdtkc{text,key,command}
123 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
126 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
135 @c two keys with one command
136 @c Inserts: @item KEY1 or KEY2 COMMAND
137 @macro orgcmdkkc{key1,key2,command}
143 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
146 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
152 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
156 @c Two keys with one command name, but different functions, so format as
158 @c Inserts: @item KEY1
159 @c @itemx KEY2 COMMAND
160 @macro orgcmdkxkc{key1,key2,command}
167 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
171 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
182 @c Same as previous, but use "or short"
183 @c Inserts: @item KEY1 or short KEY2 COMMAND
184 @macro orgcmdkskc{key1,key2,command}
190 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
193 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
199 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
203 @c Same as previous, but use @itemx
204 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
205 @macro xorgcmdkskc{key1,key2,command}
211 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
214 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
220 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
224 @c two keys with two commands
225 @c Inserts: @item KEY1 COMMAND1
226 @c @itemx KEY2 COMMAND2
227 @macro orgcmdkkcc{key1,key2,command1,command2}
234 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
235 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
238 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
239 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
249 @c -----------------------------------------------------------------------------
252 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
255 @c Subheadings inside a table.
256 @macro tsubheading{text}
258 @subsubheading \text\
266 This manual is for Org version @value{VERSION}.
268 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010
269 Free Software Foundation, Inc.
272 Permission is granted to copy, distribute and/or modify this document
273 under the terms of the GNU Free Documentation License, Version 1.3 or
274 any later version published by the Free Software Foundation; with no
275 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
276 and with the Back-Cover Texts as in (a) below. A copy of the license
277 is included in the section entitled ``GNU Free Documentation License.''
279 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
280 modify this GNU manual. Buying copies from the FSF supports it in
281 developing GNU and promoting software freedom.''
283 This document is part of a collection distributed under the GNU Free
284 Documentation License. If you want to distribute this document
285 separately from the collection, you can do so by adding a copy of the
286 license to the document, as described in section 6 of the license.
292 * Org Mode: (org). Outline-based notes management and organizer
296 @title The Org Manual
298 @subtitle Release @value{VERSION}
299 @author by Carsten Dominik
300 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, and Thomas Dye
302 @c The following two commands start the copyright page.
304 @vskip 0pt plus 1filll
308 @c Output the table of contents at the beginning.
312 @node Top, Introduction, (dir), (dir)
319 * Introduction:: Getting started
320 * Document Structure:: A tree works like your brain
321 * Tables:: Pure magic for quick formatting
322 * Hyperlinks:: Notes in context
323 * TODO Items:: Every tree branch can be a TODO item
324 * Tags:: Tagging headlines and matching sets of tags
325 * Properties and Columns:: Storing information about an entry
326 * Dates and Times:: Making items useful for planning
327 * Capture - Refile - Archive:: The ins and outs for projects
328 * Agenda Views:: Collecting information into views
329 * Markup:: Prepare text for rich export
330 * Exporting:: Sharing and publishing of notes
331 * Publishing:: Create a web site of linked Org files
332 * Working With Source Code:: Export, evaluate, and tangle code blocks
333 * Miscellaneous:: All the rest which did not fit elsewhere
334 * Hacking:: How to hack your way around
335 * MobileOrg:: Viewing and capture on a mobile device
336 * History and Acknowledgments:: How Org came into being
337 * Main Index:: An index of Org's concepts and features
338 * Key Index:: Key bindings and where they are described
339 * Command and Function Index:: Command names and some internal functions
340 * Variable Index:: Variables mentioned in the manual
343 --- The Detailed Node Listing ---
347 * Summary:: Brief summary of what Org does
348 * Installation:: How to install a downloaded version of Org
349 * Activation:: How to activate Org for certain buffers
350 * Feedback:: Bug reports, ideas, patches etc.
351 * Conventions:: Type-setting conventions in the manual
355 * Outlines:: Org is based on Outline mode
356 * Headlines:: How to typeset Org tree headlines
357 * Visibility cycling:: Show and hide, much simplified
358 * Motion:: Jumping to other headlines
359 * Structure editing:: Changing sequence and level of headlines
360 * Sparse trees:: Matches embedded in context
361 * Plain lists:: Additional structure within an entry
362 * Drawers:: Tucking stuff away
363 * Blocks:: Folding blocks
364 * Footnotes:: How footnotes are defined in Org's syntax
365 * Orgstruct mode:: Structure editing outside Org
369 * Built-in table editor:: Simple tables
370 * Column width and alignment:: Overrule the automatic settings
371 * Column groups:: Grouping to trigger vertical lines
372 * Orgtbl mode:: The table editor as minor mode
373 * The spreadsheet:: The table editor has spreadsheet capabilities
374 * Org-Plot:: Plotting from org tables
378 * References:: How to refer to another field or range
379 * Formula syntax for Calc:: Using Calc to compute stuff
380 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
381 * Field 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 * Quoting HTML tags:: Using direct HTML in Org-mode
585 * Links in HTML export:: How links will be interpreted and formatted
586 * Tables in HTML export:: How to modify the formatting of tables
587 * Images in HTML export:: How to insert figures into HTML output
588 * Math formatting in HTML export:: Beautiful math also on the web
589 * Text areas in HTML export:: An alternative way to show an example
590 * CSS support:: Changing the appearance of the output
591 * JavaScript support:: Info and Folding in a web browser
593 @LaTeX{} and PDF export
595 * LaTeX/PDF export commands:: Which key invokes which commands
596 * Header and sectioning:: Setting up the export file structure
597 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code
598 * Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
599 * Images in LaTeX export:: How to insert figures into @LaTeX{} output
600 * Beamer class export:: Turning the file into a presentation
604 * DocBook export commands:: How to invoke DocBook export
605 * Quoting DocBook code:: Incorporating DocBook code in Org files
606 * Recursive sections:: Recursive sections in DocBook
607 * Tables in DocBook export:: Tables are exported as HTML tables
608 * Images in DocBook export:: How to insert figures into DocBook output
609 * Special characters:: How to handle special characters
613 * Configuration:: Defining projects
614 * Uploading files:: How to get files up on the server
615 * Sample configuration:: Example projects
616 * Triggering publication:: Publication commands
620 * Project alist:: The central configuration variable
621 * Sources and destinations:: From here to there
622 * Selecting files:: What files are part of the project?
623 * Publishing action:: Setting the function doing the publishing
624 * Publishing options:: Tweaking HTML export
625 * Publishing links:: Which links keep working after publishing?
626 * Sitemap:: Generating a list of all pages
627 * Generating an index:: An index that reaches across pages
631 * Simple example:: One-component publishing
632 * Complex example:: A multi-component publishing example
634 Working with source code
636 * Structure of code blocks:: Code block syntax described
637 * Editing source code:: Language major-mode editing
638 * Exporting code blocks:: Export contents and/or results
639 * Extracting source code:: Create pure source code files
640 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
641 * Library of Babel:: Use and contribute to a library of useful code blocks
642 * Languages:: List of supported code block languages
643 * Header arguments:: Configure code block functionality
644 * Results of evaluation:: How evaluation results are handled
645 * Noweb reference syntax:: Literate programming in Org-mode
646 * Key bindings and useful functions:: Work quickly with code blocks
647 * Batch execution:: Call functions from the command line
651 * Using header arguments:: Different ways to set header arguments
652 * Specific header arguments:: List of header arguments
654 Using header arguments
656 * System-wide header arguments:: Set global default values
657 * Language-specific header arguments:: Set default values by language
658 * Buffer-wide header arguments:: Set default values for a specific buffer
659 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
660 * Code block specific header arguments:: The most common way to set values
661 * Header arguments in function calls:: The most specific level
663 Specific header arguments
665 * var:: Pass arguments to code blocks
666 * results:: Specify the type of results and how they will
667 be collected and handled
668 * file:: Specify a path for file output
669 * dir:: Specify the default (possibly remote)
670 directory for code block execution
671 * exports:: Export code and/or results
672 * tangle:: Toggle tangling and specify file name
673 * mkdirp:: Toggle creation of parent directories of target
674 files during tangling
675 * comments:: Toggle insertion of comments in tangled
677 * no-expand:: Turn off variable assignment and noweb
678 expansion during tangling
679 * session:: Preserve the state of code evaluation
680 * noweb:: Toggle expansion of noweb references
681 * cache:: Avoid re-evaluating unchanged code blocks
682 * sep:: Delimiter for writing tabular results outside Org
683 * hlines:: Handle horizontal lines in tables
684 * colnames:: Handle column names in tables
685 * rownames:: Handle row names in tables
686 * shebang:: Make tangled files executable
687 * eval:: Limit evaluation of specific code blocks
691 * Completion:: M-TAB knows what you need
692 * Easy Templates:: Quick insertion of structural elements
693 * Speed keys:: Electric commands at the beginning of a headline
694 * Code evaluation security:: Org mode files evaluate inline code
695 * Customization:: Adapting Org to your taste
696 * In-buffer settings:: Overview of the #+KEYWORDS
697 * The very busy C-c C-c key:: When in doubt, press C-c C-c
698 * Clean view:: Getting rid of leading stars in the outline
699 * TTY keys:: Using Org on a tty
700 * Interaction:: Other Emacs packages
702 Interaction with other packages
704 * Cooperation:: Packages Org cooperates with
705 * Conflicts:: Packages that lead to conflicts
709 * Hooks:: Who to reach into Org's internals
710 * Add-on packages:: Available extensions
711 * Adding hyperlink types:: New custom link types
712 * Context-sensitive commands:: How to add functionality to such commands
713 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
714 * Dynamic blocks:: Automatically filled blocks
715 * Special agenda views:: Customized views
716 * Extracting agenda information:: Postprocessing of agenda information
717 * Using the property API:: Writing programs that use entry properties
718 * Using the mapping API:: Mapping over all or selected entries
720 Tables and lists in arbitrary syntax
722 * Radio tables:: Sending and receiving radio tables
723 * A LaTeX example:: Step by step, almost a tutorial
724 * Translator functions:: Copy and modify
725 * Radio lists:: Doing the same for lists
729 * Setting up the staging area:: Where to interact with the mobile device
730 * Pushing to MobileOrg:: Uploading Org files and agendas
731 * Pulling from MobileOrg:: Integrating captured and flagged items
736 @node Introduction, Document Structure, Top, Top
737 @chapter Introduction
741 * Summary:: Brief summary of what Org does
742 * Installation:: How to install a downloaded version of Org
743 * Activation:: How to activate Org for certain buffers
744 * Feedback:: Bug reports, ideas, patches etc.
745 * Conventions:: Type-setting conventions in the manual
748 @node Summary, Installation, Introduction, Introduction
752 Org is a mode for keeping notes, maintaining TODO lists, and doing
753 project planning with a fast and effective plain-text system.
755 Org develops organizational tasks around NOTES files that contain
756 lists or information about projects as plain text. Org is
757 implemented on top of Outline mode, which makes it possible to keep the
758 content of large files well structured. Visibility cycling and
759 structure editing help to work with the tree. Tables are easily created
760 with a built-in table editor. Org supports TODO items, deadlines,
761 timestamps, and scheduling. It dynamically compiles entries into an
762 agenda that utilizes and smoothly integrates much of the Emacs calendar
763 and diary. Plain text URL-like links connect to websites, emails,
764 Usenet messages, BBDB entries, and any files related to the projects.
765 For printing and sharing of notes, an Org file can be exported as a
766 structured ASCII file, as HTML, or (TODO and agenda items only) as an
767 iCalendar file. It can also serve as a publishing tool for a set of
770 As a project planning environment, Org works by adding metadata to outline
771 nodes. Based on this data, specific entries can be extracted in queries and
772 create dynamic @i{agenda views}.
774 Org mode contains the Org Babel environment which allows you to work with
775 embedded source code blocks in a file, to facilitate code evaluation,
776 documentation, and literate programming techniques.
778 Org's automatic, context-sensitive table editor with spreadsheet
779 capabilities can be integrated into any major mode by activating the
780 minor Orgtbl mode. Using a translation step, it can be used to maintain
781 tables in arbitrary file types, for example in @LaTeX{}. The structure
782 editing and list creation capabilities can be used outside Org with
783 the minor Orgstruct mode.
785 Org keeps simple things simple. When first fired up, it should
786 feel like a straightforward, easy to use outliner. Complexity is not
787 imposed, but a large amount of functionality is available when you need
788 it. Org is a toolbox and can be used in different ways and for different
792 @r{@bullet{} an outline extension with visibility cycling and structure editing}
793 @r{@bullet{} an ASCII system and table editor for taking structured notes}
794 @r{@bullet{} a TODO list editor}
795 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
796 @pindex GTD, Getting Things Done
797 @r{@bullet{} an environment in which to implement David Allen's GTD system}
798 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
799 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
800 @r{@bullet{} an environment for literate programming}
805 There is a website for Org which provides links to the newest
806 version of Org, as well as additional information, frequently asked
807 questions (FAQ), links to tutorials, etc@. This page is located at
808 @uref{http://orgmode.org}.
810 @cindex print edition
811 The version 7.3 of this manual is available as a
812 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
818 @node Installation, Activation, Summary, Introduction
819 @section Installation
823 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
824 distribution or an XEmacs package, please skip this section and go directly
825 to @ref{Activation}. To see what version of Org (if any) is part of your
826 Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x
829 If you have downloaded Org from the Web, either as a distribution @file{.zip}
830 or @file{.tar} file, or as a Git archive, you must take the following steps
831 to install it: go into the unpacked Org distribution directory and edit the
832 top section of the file @file{Makefile}. You must set the name of the Emacs
833 binary (likely either @file{emacs} or @file{xemacs}), and the paths to the
834 directories where local Lisp and Info files are kept. If you don't have
835 access to the system-wide directories, you can simply run Org directly from
836 the distribution directory by adding the @file{lisp} subdirectory to the
837 Emacs load path. To do this, add the following line to @file{.emacs}:
840 (setq load-path (cons "~/path/to/orgdir/lisp" load-path))
844 If you plan to use code from the @file{contrib} subdirectory, do a similar
845 step for this directory:
848 (setq load-path (cons "~/path/to/orgdir/contrib/lisp" load-path))
851 @noindent Now byte-compile the Lisp files with the shell command:
857 @noindent If you are running Org from the distribution directory, this is
858 all. If you want to install Org into the system directories, use (as
865 Installing Info files is system dependent, because of differences in the
866 @file{install-info} program. In Debian it copies the info files into the
867 correct directory and modifies the info directory file. In many other
868 systems, the files need to be copied to the correct directory separately, and
869 @file{install-info} then only modifies the directory file. Check your system
870 documentation to find out which of the following commands you need:
874 make install-info-debian
877 Then add the following line to @file{.emacs}. It is needed so that
878 Emacs can autoload functions that are located in files not immediately loaded
879 when Org-mode starts.
881 (require 'org-install)
884 Do not forget to activate Org as described in the following section.
887 @node Activation, Feedback, Installation, Introduction
891 @cindex global key bindings
892 @cindex key bindings, global
894 To make sure files with extension @file{.org} use Org mode, add the following
895 line to your @file{.emacs} file.
897 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
899 @noindent Org mode buffers need font-lock to be turned on - this is the
900 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
901 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
903 The four Org commands @command{org-store-link}, @command{org-capture},
904 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
905 global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are
906 suggested bindings for these keys, please modify the keys to your own
909 (global-set-key "\C-cl" 'org-store-link)
910 (global-set-key "\C-cc" 'org-capture)
911 (global-set-key "\C-ca" 'org-agenda)
912 (global-set-key "\C-cb" 'org-iswitchb)
915 @cindex Org-mode, turning on
916 With this setup, all files with extension @samp{.org} will be put
917 into Org-mode. As an alternative, make the first line of a file look
921 MY PROJECTS -*- mode: org; -*-
924 @vindex org-insert-mode-line-in-empty-file
925 @noindent which will select Org-mode for this buffer no matter what
926 the file's name is. See also the variable
927 @code{org-insert-mode-line-in-empty-file}.
929 Many commands in Org work on the region if the region is @i{active}. To make
930 use of this, you need to have @code{transient-mark-mode}
931 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
932 in Emacs 22 you need to do this yourself with
934 (transient-mark-mode 1)
936 @noindent If you do not like @code{transient-mark-mode}, you can create an
937 active region by using the mouse to select a region, or pressing
938 @kbd{C-@key{SPC}} twice before moving the cursor.
940 @node Feedback, Conventions, Activation, Introduction
947 If you find problems with Org, or if you have questions, remarks, or ideas
948 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
949 If you are not a member of the mailing list, your mail will be passed to the
950 list after a moderator has approved it@footnote{Please consider subscribing
951 to the mailing list, in order to minimize the work the mailing list
952 moderators have to do.}.
954 For bug reports, please first try to reproduce the bug with the latest
955 version of Org available---if you are running an outdated version, it is
956 quite possible that the bug has been fixed already. If the bug persists,
957 prepare a report and provide as much information as possible, including the
958 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
959 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
960 @file{.emacs}. The easiest way to do this is to use the command
962 @kbd{M-x org-submit-bug-report}
964 @noindent which will put all this information into an Emacs mail buffer so
965 that you only need to add your description. If you re not sending the Email
966 from within Emacs, please copy and paste the content into your Email program.
968 If an error occurs, a backtrace can be very useful (see below on how to
969 create one). Often a small example file helps, along with clear information
973 @item What exactly did you do?
974 @item What did you expect to happen?
975 @item What happened instead?
977 @noindent Thank you for helping to improve this program.
979 @subsubheading How to create a useful backtrace
981 @cindex backtrace of an error
982 If working with Org produces an error with a message you don't
983 understand, you may have hit a bug. The best way to report this is by
984 providing, in addition to what was mentioned above, a @emph{backtrace}.
985 This is information from the built-in debugger about where and how the
986 error occurred. Here is how to produce a useful backtrace:
990 Reload uncompiled versions of all Org-mode Lisp files. The backtrace
991 contains much more information if it is produced with uncompiled code.
994 C-u M-x org-reload RET
997 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1000 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1001 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1003 Do whatever you have to do to hit the error. Don't forget to
1004 document the steps you take.
1006 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1007 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1008 attach it to your bug report.
1011 @node Conventions, , Feedback, Introduction
1012 @section Typesetting conventions used in this manual
1014 Org uses three types of keywords: TODO keywords, tags, and property
1015 names. In this manual we use the following conventions:
1020 TODO keywords are written with all capitals, even if they are
1024 User-defined tags are written in lowercase; built-in tags with special
1025 meaning are written with all capitals.
1028 User-defined properties are capitalized; built-in properties with
1029 special meaning are written with all capitals.
1032 The manual lists both the keys and the corresponding commands for accessing
1033 functionality. Org mode often uses the same key for different functions,
1034 depending on context. The command that is bound to such keys has a generic
1035 name, like @code{org-metaright}. In the manual we will, wherever possible,
1036 give the function that is internally called by the generic command. For
1037 example, in the chapter on document structure, @kbd{M-@key{right}} will be
1038 listed to call @code{org-do-demote}, while in the chapter on tables, it will
1039 be listed to call org-table-move-column-right.
1041 If you prefer, you can compile the manual without the command names by
1042 unsetting the flag @code{cmdnames} in @file{org.texi}.
1044 @node Document Structure, Tables, Introduction, Top
1045 @chapter Document structure
1046 @cindex document structure
1047 @cindex structure of document
1049 Org is based on Outline mode and provides flexible commands to
1050 edit the structure of the document.
1053 * Outlines:: Org is based on Outline mode
1054 * Headlines:: How to typeset Org tree headlines
1055 * Visibility cycling:: Show and hide, much simplified
1056 * Motion:: Jumping to other headlines
1057 * Structure editing:: Changing sequence and level of headlines
1058 * Sparse trees:: Matches embedded in context
1059 * Plain lists:: Additional structure within an entry
1060 * Drawers:: Tucking stuff away
1061 * Blocks:: Folding blocks
1062 * Footnotes:: How footnotes are defined in Org's syntax
1063 * Orgstruct mode:: Structure editing outside Org
1066 @node Outlines, Headlines, Document Structure, Document Structure
1069 @cindex Outline mode
1071 Org is implemented on top of Outline mode. Outlines allow a
1072 document to be organized in a hierarchical structure, which (at least
1073 for me) is the best representation of notes and thoughts. An overview
1074 of this structure is achieved by folding (hiding) large parts of the
1075 document to show only the general document structure and the parts
1076 currently being worked on. Org greatly simplifies the use of
1077 outlines by compressing the entire show/hide functionality into a single
1078 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1080 @node Headlines, Visibility cycling, Outlines, Document Structure
1083 @cindex outline tree
1084 @vindex org-special-ctrl-a/e
1085 @vindex org-special-ctrl-k
1086 @vindex org-ctrl-k-protect-subtree
1088 Headlines define the structure of an outline tree. The headlines in Org
1089 start with one or more stars, on the left margin@footnote{See the variables
1090 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1091 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1092 @kbd{C-e}, and @kbd{C-k} in headlines.}. For example:
1095 * Top level headline
1102 * Another top level headline
1105 @noindent Some people find the many stars too noisy and would prefer an
1106 outline that has whitespace followed by a single star as headline
1107 starters. @ref{Clean view}, describes a setup to realize this.
1109 @vindex org-cycle-separator-lines
1110 An empty line after the end of a subtree is considered part of it and
1111 will be hidden when the subtree is folded. However, if you leave at
1112 least two empty lines, one empty line will remain visible after folding
1113 the subtree, in order to structure the collapsed view. See the
1114 variable @code{org-cycle-separator-lines} to modify this behavior.
1116 @node Visibility cycling, Motion, Headlines, Document Structure
1117 @section Visibility cycling
1118 @cindex cycling, visibility
1119 @cindex visibility cycling
1120 @cindex trees, visibility
1121 @cindex show hidden text
1124 Outlines make it possible to hide parts of the text in the buffer.
1125 Org uses just two commands, bound to @key{TAB} and
1126 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1128 @cindex subtree visibility states
1129 @cindex subtree cycling
1130 @cindex folded, subtree visibility state
1131 @cindex children, subtree visibility state
1132 @cindex subtree, subtree visibility state
1134 @orgcmd{@key{TAB},org-cycle}
1135 @emph{Subtree cycling}: Rotate current subtree among the states
1138 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1139 '-----------------------------------'
1142 @vindex org-cycle-emulate-tab
1143 @vindex org-cycle-global-at-bob
1144 The cursor must be on a headline for this to work@footnote{see, however,
1145 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1146 beginning of the buffer and the first line is not a headline, then
1147 @key{TAB} actually runs global cycling (see below)@footnote{see the
1148 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1149 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1151 @cindex global visibility states
1152 @cindex global cycling
1153 @cindex overview, global visibility state
1154 @cindex contents, global visibility state
1155 @cindex show all, global visibility state
1156 @orgcmd{S-@key{TAB},org-global-cycle}
1157 @itemx C-u @key{TAB}
1158 @emph{Global cycling}: Rotate the entire buffer among the states
1161 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1162 '--------------------------------------'
1165 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1166 CONTENTS view up to headlines of level N will be shown. Note that inside
1167 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1169 @cindex show all, command
1170 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1171 Show all, including drawers.
1172 @orgcmd{C-c C-r,org-reveal}
1173 Reveal context around point, showing the current entry, the following heading
1174 and the hierarchy above. Useful for working near a location that has been
1175 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1176 (@pxref{Agenda commands}). With a prefix argument show, on each
1177 level, all sibling headings. With double prefix arg, also show the entire
1178 subtree of the parent.
1179 @orgcmd{C-c C-k,show-branches}
1180 Expose all the headings of the subtree, CONTENT view for just one subtree.
1181 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1182 Show the current subtree in an indirect buffer@footnote{The indirect
1185 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1188 (see the Emacs manual for more information about indirect buffers)
1190 will contain the entire buffer, but will be narrowed to the current
1191 tree. Editing the indirect buffer will also change the original buffer,
1192 but without affecting visibility in that buffer.}. With a numeric
1193 prefix argument N, go up to level N and then take that tree. If N is
1194 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1195 the previously used indirect buffer.
1198 @vindex org-startup-folded
1199 @cindex @code{overview}, STARTUP keyword
1200 @cindex @code{content}, STARTUP keyword
1201 @cindex @code{showall}, STARTUP keyword
1202 @cindex @code{showeverything}, STARTUP keyword
1204 When Emacs first visits an Org file, the global state is set to
1205 OVERVIEW, i.e.@: only the top level headlines are visible. This can be
1206 configured through the variable @code{org-startup-folded}, or on a
1207 per-file basis by adding one of the following lines anywhere in the
1214 #+STARTUP: showeverything
1217 @cindex property, VISIBILITY
1219 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1220 and Columns}) will get their visibility adapted accordingly. Allowed values
1221 for this property are @code{folded}, @code{children}, @code{content}, and
1224 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1225 Switch back to the startup visibility of the buffer, i.e.@: whatever is
1226 requested by startup options and @samp{VISIBILITY} properties in individual
1230 @node Motion, Structure editing, Visibility cycling, Document Structure
1232 @cindex motion, between headlines
1233 @cindex jumping, to headlines
1234 @cindex headline navigation
1235 The following commands jump to other headlines in the buffer.
1238 @orgcmd{C-c C-n,outline-next-visible-heading}
1240 @orgcmd{C-c C-p,outline-previous-visible-heading}
1242 @orgcmd{C-c C-f,org-forward-same-level}
1243 Next heading same level.
1244 @orgcmd{C-c C-b,org-backward-same-level}
1245 Previous heading same level.
1246 @orgcmd{C-c C-u,outline-up-heading}
1247 Backward to higher level heading.
1248 @orgcmd{C-c C-j,org-goto}
1249 Jump to a different place without changing the current outline
1250 visibility. Shows the document structure in a temporary buffer, where
1251 you can use the following keys to find your destination:
1252 @vindex org-goto-auto-isearch
1254 @key{TAB} @r{Cycle visibility.}
1255 @key{down} / @key{up} @r{Next/previous visible headline.}
1256 @key{RET} @r{Select this location.}
1257 @kbd{/} @r{Do a Sparse-tree search}
1258 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1259 n / p @r{Next/previous visible headline.}
1260 f / b @r{Next/previous headline same level.}
1262 0-9 @r{Digit argument.}
1265 @vindex org-goto-interface
1267 See also the variable @code{org-goto-interface}.
1270 @node Structure editing, Sparse trees, Motion, Document Structure
1271 @section Structure editing
1272 @cindex structure editing
1273 @cindex headline, promotion and demotion
1274 @cindex promotion, of subtrees
1275 @cindex demotion, of subtrees
1276 @cindex subtree, cut and paste
1277 @cindex pasting, of subtrees
1278 @cindex cutting, of subtrees
1279 @cindex copying, of subtrees
1280 @cindex sorting, of subtrees
1281 @cindex subtrees, cut and paste
1284 @orgcmd{M-@key{RET},org-insert-heading}
1285 @vindex org-M-RET-may-split-line
1286 Insert new heading with same level as current. If the cursor is in a plain
1287 list item, a new item is created (@pxref{Plain lists}). To force creation of
1288 a new headline, use a prefix argument. When this command is used in the
1289 middle of a line, the line is split and the rest of the line becomes the new
1290 headline@footnote{If you do not want the line to be split, customize the
1291 variable @code{org-M-RET-may-split-line}.}. If the command is used at the
1292 beginning of a headline, the new headline is created before the current line.
1293 If at the beginning of any other line, the content of that line is made the
1294 new heading. If the command is used at the end of a folded subtree (i.e.@:
1295 behind the ellipses at the end of a headline), then a headline like the
1296 current one will be inserted after the end of the subtree.
1297 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1298 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1299 current heading, the new heading is placed after the body instead of before
1300 it. This command works from anywhere in the entry.
1301 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1302 @vindex org-treat-insert-todo-heading-as-state-change
1303 Insert new TODO entry with same level as current heading. See also the
1304 variable @code{org-treat-insert-todo-heading-as-state-change}.
1305 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1306 Insert new TODO entry with same level as current heading. Like
1307 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1309 @orgcmd{@key{TAB},org-cycle}
1310 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1311 become a child of the previous one. The next @key{TAB} makes it a parent,
1312 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1313 to the initial level.
1314 @orgcmd{M-@key{left},org-do-promote}
1315 Promote current heading by one level.
1316 @orgcmd{M-@key{right},org-do-demote}
1317 Demote current heading by one level.
1318 @orgcmd{M-S-@key{left},org-promote-subtree}
1319 Promote the current subtree by one level.
1320 @orgcmd{M-S-@key{right},org-demote-subtree}
1321 Demote the current subtree by one level.
1322 @orgcmd{M-S-@key{up},org-move-subtree-up}
1323 Move subtree up (swap with previous subtree of same
1325 @orgcmd{M-S-@key{down},org-move-subtree-down}
1326 Move subtree down (swap with next subtree of same level).
1327 @orgcmd{C-c C-x C-w,org-cut-subtree}
1328 Kill subtree, i.e.@: remove it from buffer but save in kill ring.
1329 With a numeric prefix argument N, kill N sequential subtrees.
1330 @orgcmd{C-c C-x M-w,org-copy-subtree}
1331 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1332 sequential subtrees.
1333 @orgcmd{C-c C-x C-y,org-paste-subtree}
1334 Yank subtree from kill ring. This does modify the level of the subtree to
1335 make sure the tree fits in nicely at the yank position. The yank level can
1336 also be specified with a numeric prefix argument, or by yanking after a
1337 headline marker like @samp{****}.
1338 @orgcmd{C-y,org-yank}
1339 @vindex org-yank-adjusted-subtrees
1340 @vindex org-yank-folded-subtrees
1341 Depending on the variables @code{org-yank-adjusted-subtrees} and
1342 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1343 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1344 C-x C-y}. With the default settings, no level adjustment will take place,
1345 but the yanked tree will be folded unless doing so would swallow text
1346 previously visible. Any prefix argument to this command will force a normal
1347 @code{yank} to be executed, with the prefix passed along. A good way to
1348 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1349 yank, it will yank previous kill items plainly, without adjustment and
1351 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1352 Clone a subtree by making a number of sibling copies of it. You will be
1353 prompted for the number of copies to make, and you can also specify if any
1354 timestamps in the entry should be shifted. This can be useful, for example,
1355 to create a number of tasks related to a series of lectures to prepare. For
1356 more details, see the docstring of the command
1357 @code{org-clone-subtree-with-time-shift}.
1358 @orgcmd{C-c C-w,org-refile}
1359 Refile entry or region to a different location. @xref{Refiling notes}.
1360 @orgcmd{C-c ^,org-sort-entries-or-items}
1361 Sort same-level entries. When there is an active region, all entries in the
1362 region will be sorted. Otherwise the children of the current headline are
1363 sorted. The command prompts for the sorting method, which can be
1364 alphabetically, numerically, by time (first timestamp with active preferred,
1365 creation time, scheduled time, deadline time), by priority, by TODO keyword
1366 (in the sequence the keywords have been defined in the setup) or by the value
1367 of a property. Reverse sorting is possible as well. You can also supply
1368 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1369 sorting will be case-sensitive. With two @kbd{C-u C-u} prefixes, duplicate
1370 entries will also be removed.
1371 @orgcmd{C-x n s,org-narrow-to-subtree}
1372 Narrow buffer to current subtree.
1373 @orgcmd{C-x n b,org-narrow-to-block}
1374 Narrow buffer to current block.
1375 @orgcmd{C-x n w,widen}
1376 Widen buffer to remove narrowing.
1377 @orgcmd{C-c *,org-toggle-heading}
1378 Turn a normal line or plain list item into a headline (so that it becomes a
1379 subheading at its location). Also turn a headline into a normal line by
1380 removing the stars. If there is an active region, turn all lines in the
1381 region into headlines. If the first line in the region was an item, turn
1382 only the item lines into headlines. Finally, if the first line is a
1383 headline, remove the stars from all headlines in the region.
1386 @cindex region, active
1387 @cindex active region
1388 @cindex transient mark mode
1389 When there is an active region (Transient Mark mode), promotion and
1390 demotion work on all headlines in the region. To select a region of
1391 headlines, it is best to place both point and mark at the beginning of a
1392 line, mark at the beginning of the first headline, and point at the line
1393 just after the last headline to change. Note that when the cursor is
1394 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1398 @node Sparse trees, Plain lists, Structure editing, Document Structure
1399 @section Sparse trees
1400 @cindex sparse trees
1401 @cindex trees, sparse
1402 @cindex folding, sparse trees
1403 @cindex occur, command
1405 @vindex org-show-hierarchy-above
1406 @vindex org-show-following-heading
1407 @vindex org-show-siblings
1408 @vindex org-show-entry-below
1409 An important feature of Org-mode is the ability to construct @emph{sparse
1410 trees} for selected information in an outline tree, so that the entire
1411 document is folded as much as possible, but the selected information is made
1412 visible along with the headline structure above it@footnote{See also the
1413 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1414 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1415 control on how much context is shown around each match.}. Just try it out
1416 and you will see immediately how it works.
1418 Org-mode contains several commands creating such trees, all these
1419 commands can be accessed through a dispatcher:
1422 @orgcmd{C-c /,org-sparse-tree}
1423 This prompts for an extra key to select a sparse-tree creating command.
1424 @orgcmd{C-c / r,org-occur}
1425 @vindex org-remove-highlights-with-change
1426 Occur. Prompts for a regexp and shows a sparse tree with all matches. If
1427 the match is in a headline, the headline is made visible. If the match is in
1428 the body of an entry, headline and body are made visible. In order to
1429 provide minimal context, also the full hierarchy of headlines above the match
1430 is shown, as well as the headline following the match. Each match is also
1431 highlighted; the highlights disappear when the buffer is changed by an
1432 editing command@footnote{This depends on the option
1433 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1434 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1435 so several calls to this command can be stacked.
1436 @orgcmdkkc{M-g n,M-g M-n,next-error}
1437 Jump to the next sparse tree match in this buffer.
1438 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1439 Jump to the previous sparse tree match in this buffer.
1444 @vindex org-agenda-custom-commands
1445 For frequently used sparse trees of specific search strings, you can
1446 use the variable @code{org-agenda-custom-commands} to define fast
1447 keyboard access to specific sparse trees. These commands will then be
1448 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1452 (setq org-agenda-custom-commands
1453 '(("f" occur-tree "FIXME")))
1456 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1457 a sparse tree matching the string @samp{FIXME}.
1459 The other sparse tree commands select headings based on TODO keywords,
1460 tags, or properties and will be discussed later in this manual.
1463 @cindex printing sparse trees
1464 @cindex visible text, printing
1465 To print a sparse tree, you can use the Emacs command
1466 @code{ps-print-buffer-with-faces} which does not print invisible parts
1467 of the document @footnote{This does not work under XEmacs, because
1468 XEmacs uses selective display for outlining, not text properties.}.
1469 Or you can use the command @kbd{C-c C-e v} to export only the visible
1470 part of the document and print the resulting file.
1472 @node Plain lists, Drawers, Sparse trees, Document Structure
1473 @section Plain lists
1475 @cindex lists, plain
1476 @cindex lists, ordered
1477 @cindex ordered lists
1479 Within an entry of the outline tree, hand-formatted lists can provide
1480 additional structure. They also provide a way to create lists of checkboxes
1481 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1482 (@pxref{Exporting}) can parse and format them.
1484 Org knows ordered lists, unordered lists, and description lists.
1487 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1488 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1489 they will be seen as top-level headlines. Also, when you are hiding leading
1490 stars to get a clean outline view, plain list items starting with a star may
1491 be hard to distinguish from true headlines. In short: even though @samp{*}
1492 is supported, it may be better to not use it for plain list items.} as
1495 @vindex org-plain-list-ordered-item-terminator
1496 @vindex org-alphabetical-lists
1497 @emph{Ordered} list items start with a numeral followed by either a period or
1498 a right parenthesis@footnote{You can filter out any of them by configuring
1499 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1500 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1501 @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
1502 confusion with normal text, those are limited to one character only. Beyond
1503 that limit, bullets will automatically fallback to numbers.}. If you want a
1504 list to start with a different value (e.g.@: 20), start the text of the item
1505 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1506 must be put @emph{before} the checkbox. If you have activated alphabetical
1507 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1508 be used in any item of the list in order to enforce a particular numbering.
1510 @emph{Description} list items are unordered list items, and contain the
1511 separator @samp{ :: } to distinguish the description @emph{term} from the
1515 Items belonging to the same list must have the same indentation on the first
1516 line. In particular, if an ordered list reaches number @samp{10.}, then the
1517 2--digit numbers must be written left-aligned with the other numbers in the
1518 list. An item ends before the next line that is less or equally indented
1519 than its bullet/number.
1521 @vindex org-list-ending-method
1522 @vindex org-list-end-regexp
1523 @vindex org-empty-line-terminates-plain-lists
1524 Two methods@footnote{To disable either of them, configure
1525 @code{org-list-ending-method}.} are provided to terminate lists. A list ends
1526 whenever every item has ended, which means before any line less or equally
1527 indented than items at top level. It also ends before two blank
1528 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
1529 that case, all items are closed. For finer control, you can end lists with
1530 any pattern set in @code{org-list-end-regexp}. Here is an example:
1534 ** Lord of the Rings
1535 My favorite scenes are (in this order)
1536 1. The attack of the Rohirrim
1537 2. Eowyn's fight with the witch king
1538 + this was already my favorite scene in the book
1539 + I really like Miranda Otto.
1540 3. Peter Jackson being shot by Legolas
1542 He makes a really funny face when it happens.
1543 But in the end, no individual scenes matter but the film as a whole.
1544 Important actors in this film are:
1545 - @b{Elijah Wood} :: He plays Frodo
1546 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1547 him very well from his role as Mikey Walsh in @i{The Goonies}.
1551 Org supports these lists by tuning filling and wrapping commands to deal with
1552 them correctly@footnote{Org only changes the filling settings for Emacs. For
1553 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1554 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1555 properly (@pxref{Exporting}). Since indentation is what governs the
1556 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1557 blocks can be indented to signal that they belong to a particular item.
1559 @vindex org-list-demote-modify-bullet
1560 If you find that using a different bullet for a sub-list (than that used for
1561 the current list-level) improves readability, customize the variable
1562 @code{org-list-demote-modify-bullet}.
1564 @vindex org-list-automatic-rules
1565 The following commands act on items when the cursor is in the first line of
1566 an item (the line with the bullet or number). Some of them imply the
1567 application of automatic rules to keep list structure intact. If some of
1568 these actions get in your way, configure @code{org-list-automatic-rules}
1569 to disable them individually.
1572 @orgcmd{@key{TAB},org-cycle}
1573 @vindex org-cycle-include-plain-lists
1574 Items can be folded just like headline levels. Normally this works only if
1575 the cursor is on a plain list item. For more details, see the variable
1576 @code{org-cycle-include-plain-lists}. If this variable is set to
1577 @code{integrate}, plain list items will be treated like low-level
1578 headlines. The level of an item is then given by the
1579 indentation of the bullet/number. Items are always subordinate to real
1580 headlines, however; the hierarchies remain completely separated.
1581 @orgcmd{M-@key{RET},org-insert-heading}
1582 @vindex org-M-RET-may-split-line
1583 @vindex org-list-automatic-rules
1584 Insert new item at current level. With a prefix argument, force a new
1585 heading (@pxref{Structure editing}). If this command is used in the middle
1586 of an item, that item is @emph{split} in two, and the second part becomes the
1587 new item@footnote{If you do not want the item to be split, customize the
1588 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1589 @emph{before item's body}, the new item is created @emph{before} the current
1591 @kindex M-S-@key{RET}
1593 Insert a new item with a checkbox (@pxref{Checkboxes}).
1594 @orgcmd{@key{TAB},org-cycle}
1595 In a new item with no text yet, the first @key{TAB} demotes the item to
1596 become a child of the previous one. Subsequent @key{TAB}s move the item to
1597 meaningful levels in the list and eventually get it back to its initial
1599 @kindex S-@key{down}
1602 @cindex shift-selection-mode
1603 @vindex org-support-shift-select
1604 Jump to the previous/next item in the current list, but only if
1605 @code{org-support-shift-select} is off. If not, you can still use paragraph
1606 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1608 @kindex M-S-@key{up}
1609 @kindex M-S-@key{down}
1611 @itemx M-S-@key{down}
1612 Move the item including subitems up/down (swap with previous/next item
1613 of same indentation). If the list is ordered, renumbering is
1615 @kindex M-@key{left}
1616 @kindex M-@key{right}
1618 @itemx M-@key{right}
1619 Decrease/increase the indentation of an item, leaving children alone.
1620 @kindex M-S-@key{left}
1621 @kindex M-S-@key{right}
1622 @item M-S-@key{left}
1623 @itemx M-S-@key{right}
1624 Decrease/increase the indentation of the item, including subitems.
1625 Initially, the item tree is selected based on current indentation. When
1626 these commands are executed several times in direct succession, the initially
1627 selected region is used, even if the new indentation would imply a different
1628 hierarchy. To use the new hierarchy, break the command chain with a cursor
1631 As a special case, using this command on the very first item of a list will
1632 move the whole list. This behavior can be disabled by configuring
1633 @code{org-list-automatic-rules}. The global indentation of a list has no
1634 influence on the text @emph{after} the list.
1637 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1638 state of the checkbox. In any case, verify bullets and indentation
1639 consistency in the whole list.
1641 @vindex org-plain-list-ordered-item-terminator
1642 @vindex org-list-automatic-rules
1644 Cycle the entire list level through the different itemize/enumerate bullets
1645 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1646 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1647 and its position@footnote{See @code{bullet} rule in
1648 @code{org-list-automatic-rules} for more information.}. With a numeric
1649 prefix argument N, select the Nth bullet from this list. If there is an
1650 active region when calling this, selected text will be changed into an item.
1651 With a prefix argument, all lines will be converted to list items. If the
1652 first line already was a list item, any item marker will be removed from the
1653 list. Finally, even without an active region, a normal line will be
1654 converted into a list item.
1657 Turn a plain list item into a headline (so that it becomes a subheading at
1658 its location). @xref{Structure editing}, for a detailed explanation.
1661 Turn the whole plain list into a subtree of the current heading. Checkboxes
1662 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1664 @kindex S-@key{left}
1665 @kindex S-@key{right}
1666 @item S-@key{left}/@key{right}
1667 @vindex org-support-shift-select
1668 This command also cycles bullet styles when the cursor in on the bullet or
1669 anywhere in an item line, details depending on
1670 @code{org-support-shift-select}.
1673 Sort the plain list. You will be prompted for the sorting method:
1674 numerically, alphabetically, by time, or by custom function.
1677 @node Drawers, Blocks, Plain lists, Document Structure
1681 @cindex visibility cycling, drawers
1684 Sometimes you want to keep information associated with an entry, but you
1685 normally don't want to see it. For this, Org-mode has @emph{drawers}.
1686 Drawers need to be configured with the variable
1687 @code{org-drawers}@footnote{You can define drawers on a per-file basis
1688 with a line like @code{#+DRAWERS: HIDDEN PROPERTIES STATE}}. Drawers
1692 ** This is a headline
1693 Still outside the drawer
1695 This is inside the drawer.
1700 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1701 show the entry, but keep the drawer collapsed to a single line. In order to
1702 look inside the drawer, you need to move the cursor to the drawer line and
1703 press @key{TAB} there. Org-mode uses the @code{PROPERTIES} drawer for
1704 storing properties (@pxref{Properties and Columns}), and you can also arrange
1705 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1706 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1707 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1712 Add a time-stamped note to the LOGBOOK drawer.
1715 @node Blocks, Footnotes, Drawers, Document Structure
1718 @vindex org-hide-block-startup
1719 @cindex blocks, folding
1720 Org-mode uses begin...end blocks for various purposes from including source
1721 code examples (@pxref{Literal examples}) to capturing time logging
1722 information (@pxref{Clocking work time}). These blocks can be folded and
1723 unfolded by pressing TAB in the begin line. You can also get all blocks
1724 folded at startup by configuring the variable @code{org-hide-block-startup}
1725 or on a per-file basis by using
1727 @cindex @code{hideblocks}, STARTUP keyword
1728 @cindex @code{nohideblocks}, STARTUP keyword
1730 #+STARTUP: hideblocks
1731 #+STARTUP: nohideblocks
1734 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1738 Org-mode supports the creation of footnotes. In contrast to the
1739 @file{footnote.el} package, Org-mode's footnotes are designed for work on a
1740 larger document, not only for one-off documents like emails. The basic
1741 syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
1742 defined in a paragraph that is started by a footnote marker in square
1743 brackets in column 0, no indentation allowed. If you need a paragraph break
1744 inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
1745 is simply the marker in square brackets, inside text. For example:
1748 The Org homepage[fn:1] now looks a lot better than it used to.
1750 [fn:1] The link is: http://orgmode.org
1753 Org-mode extends the number-based syntax to @emph{named} footnotes and
1754 optional inline definition. Using plain numbers as markers (as
1755 @file{footnote.el} does) is supported for backward compatibility, but not
1756 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1757 LaTeX}). Here are the valid references:
1761 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1762 recommended because something like @samp{[1]} could easily be part of a code
1765 A named footnote reference, where @code{name} is a unique label word, or, for
1766 simplicity of automatic creation, a number.
1767 @item [fn:: This is the inline definition of this footnote]
1768 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1770 @item [fn:name: a definition]
1771 An inline definition of a footnote, which also specifies a name for the note.
1772 Since Org allows multiple references to the same note, you can then use
1773 @code{[fn:name]} to create additional references.
1776 @vindex org-footnote-auto-label
1777 Footnote labels can be created automatically, or you can create names yourself.
1778 This is handled by the variable @code{org-footnote-auto-label} and its
1779 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1782 @noindent The following command handles footnotes:
1787 The footnote action command.
1789 When the cursor is on a footnote reference, jump to the definition. When it
1790 is at a definition, jump to the (first) reference.
1792 @vindex org-footnote-define-inline
1793 @vindex org-footnote-section
1794 @vindex org-footnote-auto-adjust
1795 Otherwise, create a new footnote. Depending on the variable
1796 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1797 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1798 definition will be placed right into the text as part of the reference, or
1799 separately into the location determined by the variable
1800 @code{org-footnote-section}.
1802 When this command is called with a prefix argument, a menu of additional
1805 s @r{Sort the footnote definitions by reference sequence. During editing,}
1806 @r{Org makes no effort to sort footnote definitions into a particular}
1807 @r{sequence. If you want them sorted, use this command, which will}
1808 @r{also move entries according to @code{org-footnote-section}. Automatic}
1809 @r{sorting after each insertion/deletion can be configured using the}
1810 @r{variable @code{org-footnote-auto-adjust}.}
1811 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1812 @r{after each insertion/deletion can be configured using the variable}
1813 @r{@code{org-footnote-auto-adjust}.}
1814 S @r{Short for first @code{r}, then @code{s} action.}
1815 n @r{Normalize the footnotes by collecting all definitions (including}
1816 @r{inline definitions) into a special section, and then numbering them}
1817 @r{in sequence. The references will then also be numbers. This is}
1818 @r{meant to be the final step before finishing a document (e.g.@: sending}
1819 @r{off an email). The exporters do this automatically, and so could}
1820 @r{something like @code{message-send-hook}.}
1821 d @r{Delete the footnote at point, and all definitions of and references}
1824 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1825 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1826 renumbering and sorting footnotes can be automatic after each insertion or
1831 If the cursor is on a footnote reference, jump to the definition. If it is a
1832 the definition, jump back to the reference. When called at a footnote
1833 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1837 @item C-c C-o @r{or} mouse-1/2
1838 Footnote labels are also links to the corresponding definition/reference, and
1839 you can use the usual commands to follow these links.
1842 @node Orgstruct mode, , Footnotes, Document Structure
1843 @section The Orgstruct minor mode
1844 @cindex Orgstruct mode
1845 @cindex minor mode for structure editing
1847 If you like the intuitive way the Org-mode structure editing and list
1848 formatting works, you might want to use these commands in other modes like
1849 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1850 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1851 turn it on by default, for example in Message mode, with one of:
1854 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1855 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1858 When this mode is active and the cursor is on a line that looks to Org like a
1859 headline or the first line of a list item, most structure editing commands
1860 will work, even if the same keys normally have different functionality in the
1861 major mode you are using. If the cursor is not in one of those special
1862 lines, Orgstruct mode lurks silently in the shadows. When you use
1863 @code{orgstruct++-mode}, Org will also export indentation and autofill
1864 settings into that mode, and detect item context after the first line of an
1867 @node Tables, Hyperlinks, Document Structure, Top
1870 @cindex editing tables
1872 Org comes with a fast and intuitive table editor. Spreadsheet-like
1873 calculations are supported using the Emacs @file{calc} package
1875 (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}).
1878 (see the Emacs Calculator manual for more information about the Emacs
1883 * Built-in table editor:: Simple tables
1884 * Column width and alignment:: Overrule the automatic settings
1885 * Column groups:: Grouping to trigger vertical lines
1886 * Orgtbl mode:: The table editor as minor mode
1887 * The spreadsheet:: The table editor has spreadsheet capabilities
1888 * Org-Plot:: Plotting from org tables
1891 @node Built-in table editor, Column width and alignment, Tables, Tables
1892 @section The built-in table editor
1893 @cindex table editor, built-in
1895 Org makes it easy to format tables in plain ASCII. Any line with
1896 @samp{|} as the first non-whitespace character is considered part of a
1897 table. @samp{|} is also the column separator. A table might look like
1901 | Name | Phone | Age |
1902 |-------+-------+-----|
1903 | Peter | 1234 | 17 |
1904 | Anna | 4321 | 25 |
1907 A table is re-aligned automatically each time you press @key{TAB} or
1908 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
1909 the next field (@key{RET} to the next row) and creates new table rows
1910 at the end of the table or before horizontal lines. The indentation
1911 of the table is set by the first line. Any line starting with
1912 @samp{|-} is considered as a horizontal separator line and will be
1913 expanded on the next re-align to span the whole table width. So, to
1914 create the above table, you would only type
1921 @noindent and then press @key{TAB} to align the table and start filling in
1922 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
1923 @kbd{C-c @key{RET}}.
1925 @vindex org-enable-table-editor
1926 @vindex org-table-auto-blank-field
1927 When typing text into a field, Org treats @key{DEL},
1928 @key{Backspace}, and all character keys in a special way, so that
1929 inserting and deleting avoids shifting other fields. Also, when
1930 typing @emph{immediately after the cursor was moved into a new field
1931 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
1932 field is automatically made blank. If this behavior is too
1933 unpredictable for you, configure the variables
1934 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
1937 @tsubheading{Creation and conversion}
1938 @orgcmd{C-c |,org-table-create-or-convert-from-region}
1939 Convert the active region to table. If every line contains at least one
1940 TAB character, the function assumes that the material is tab separated.
1941 If every line contains a comma, comma-separated values (CSV) are assumed.
1942 If not, lines are split at whitespace into fields. You can use a prefix
1943 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
1944 C-u} forces TAB, and a numeric argument N indicates that at least N
1945 consecutive spaces, or alternatively a TAB will be the separator.
1947 If there is no active region, this command creates an empty Org
1948 table. But it's easier just to start typing, like
1949 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
1951 @tsubheading{Re-aligning and field motion}
1952 @orgcmd{C-c C-c,org-table-align}
1953 Re-align the table without moving the cursor.
1955 @orgcmd{<TAB>,org-table-next-field}
1956 Re-align the table, move to the next field. Creates a new row if
1959 @orgcmd{S-@key{TAB},org-table-previous-field}
1960 Re-align, move to previous field.
1962 @orgcmd{@key{RET},org-table-next-row}
1963 Re-align the table and move down to next row. Creates a new row if
1964 necessary. At the beginning or end of a line, @key{RET} still does
1965 NEWLINE, so it can be used to split a table.
1967 @orgcmd{M-a,org-table-beginning-of-field}
1968 Move to beginning of the current table field, or on to the previous field.
1969 @orgcmd{M-e,org-table-end-of-field}
1970 Move to end of the current table field, or on to the next field.
1972 @tsubheading{Column and row editing}
1973 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
1974 Move the current column left/right.
1976 @orgcmd{M-S-@key{left},org-table-delete-column}
1977 Kill the current column.
1979 @orgcmd{M-S-@key{right},org-table-insert-column}
1980 Insert a new column to the left of the cursor position.
1982 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
1983 Move the current row up/down.
1985 @orgcmd{M-S-@key{up},org-table-kill-row}
1986 Kill the current row or horizontal line.
1988 @orgcmd{M-S-@key{down},org-table-insert-row}
1989 Insert a new row above the current row. With a prefix argument, the line is
1990 created below the current one.
1992 @orgcmd{C-c -,org-table-insert-hline}
1993 Insert a horizontal line below current row. With a prefix argument, the line
1994 is created above the current line.
1996 @orgcmd{C-c @key{RET},org-table-hline-and-move}
1997 Insert a horizontal line below current row, and move the cursor into the row
2000 @orgcmd{C-c ^,org-table-sort-lines}
2001 Sort the table lines in the region. The position of point indicates the
2002 column to be used for sorting, and the range of lines is the range
2003 between the nearest horizontal separator lines, or the entire table. If
2004 point is before the first column, you will be prompted for the sorting
2005 column. If there is an active region, the mark specifies the first line
2006 and the sorting column, while point should be in the last line to be
2007 included into the sorting. The command prompts for the sorting type
2008 (alphabetically, numerically, or by time). When called with a prefix
2009 argument, alphabetic sorting will be case-sensitive.
2011 @tsubheading{Regions}
2012 @orgcmd{C-c C-x M-w,org-table-copy-region}
2013 Copy a rectangular region from a table to a special clipboard. Point and
2014 mark determine edge fields of the rectangle. If there is no active region,
2015 copy just the current field. The process ignores horizontal separator lines.
2017 @orgcmd{C-c C-x C-w,org-table-cut-region}
2018 Copy a rectangular region from a table to a special clipboard, and
2019 blank all fields in the rectangle. So this is the ``cut'' operation.
2021 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2022 Paste a rectangular region into a table.
2023 The upper left corner ends up in the current field. All involved fields
2024 will be overwritten. If the rectangle does not fit into the present table,
2025 the table is enlarged as needed. The process ignores horizontal separator
2028 @orgcmd{M-@key{RET},org-table-wrap-region}
2029 Split the current field at the cursor position and move the rest to the line
2030 below. If there is an active region, and both point and mark are in the same
2031 column, the text in the column is wrapped to minimum width for the given
2032 number of lines. A numeric prefix argument may be used to change the number
2033 of desired lines. If there is no region, but you specify a prefix argument,
2034 the current field is made blank, and the content is appended to the field
2037 @tsubheading{Calculations}
2038 @cindex formula, in tables
2039 @cindex calculations, in tables
2040 @cindex region, active
2041 @cindex active region
2042 @cindex transient mark mode
2043 @orgcmd{C-c +,org-table-sum}
2044 Sum the numbers in the current column, or in the rectangle defined by
2045 the active region. The result is shown in the echo area and can
2046 be inserted with @kbd{C-y}.
2048 @orgcmd{S-@key{RET},org-table-copy-down}
2049 @vindex org-table-copy-increment
2050 When current field is empty, copy from first non-empty field above. When not
2051 empty, copy current field down to next row and move cursor along with it.
2052 Depending on the variable @code{org-table-copy-increment}, integer field
2053 values will be incremented during copy. Integers that are too large will not
2054 be incremented. Also, a @code{0} prefix argument temporarily disables the
2055 increment. This key is also used by shift-selection and related modes
2056 (@pxref{Conflicts}).
2058 @tsubheading{Miscellaneous}
2059 @orgcmd{C-c `,org-table-edit-field}
2060 Edit the current field in a separate window. This is useful for fields that
2061 are not fully visible (@pxref{Column width and alignment}). When called with
2062 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2065 @item M-x org-table-import
2066 Import a file as a table. The table should be TAB or whitespace
2067 separated. Use, for example, to import a spreadsheet table or data
2068 from a database, because these programs generally can write
2069 TAB-separated text files. This command works by inserting the file into
2070 the buffer and then converting the region to a table. Any prefix
2071 argument is passed on to the converter, which uses it to determine the
2073 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2074 Tables can also be imported by pasting tabular text into the Org
2075 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2076 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2078 @item M-x org-table-export
2079 @findex org-table-export
2080 @vindex org-table-export-default-format
2081 Export the table, by default as a TAB-separated file. Use for data
2082 exchange with, for example, spreadsheet or database programs. The format
2083 used to export the file can be configured in the variable
2084 @code{org-table-export-default-format}. You may also use properties
2085 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2086 name and the format for table export in a subtree. Org supports quite
2087 general formats for exported tables. The exporter format is the same as the
2088 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2089 detailed description.
2092 If you don't like the automatic table editor because it gets in your
2093 way on lines which you would like to start with @samp{|}, you can turn
2097 (setq org-enable-table-editor nil)
2100 @noindent Then the only table command that still works is
2101 @kbd{C-c C-c} to do a manual re-align.
2103 @node Column width and alignment, Column groups, Built-in table editor, Tables
2104 @section Column width and alignment
2105 @cindex narrow columns in tables
2106 @cindex alignment in tables
2108 The width of columns is automatically determined by the table editor. And
2109 also the alignment of a column is determined automatically from the fraction
2110 of number-like versus non-number fields in the column.
2112 Sometimes a single field or a few fields need to carry more text, leading to
2113 inconveniently wide columns. Or maybe you want to make a table with several
2114 columns having a fixed width, regardless of content. To set@footnote{This
2115 feature does not work on XEmacs.} the width of a column, one field anywhere
2116 in the column may contain just the string @samp{<N>} where @samp{N} is an
2117 integer specifying the width of the column in characters. The next re-align
2118 will then set the width of this column to this value.
2122 |---+------------------------------| |---+--------|
2124 | 1 | one | | 1 | one |
2125 | 2 | two | ----\ | 2 | two |
2126 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2127 | 4 | four | | 4 | four |
2128 |---+------------------------------| |---+--------|
2133 Fields that are wider become clipped and end in the string @samp{=>}.
2134 Note that the full text is still in the buffer but is hidden.
2135 To see the full text, hold the mouse over the field---a tool-tip window
2136 will show the full content. To edit such a field, use the command
2137 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2138 open a new window with the full field. Edit it and finish with @kbd{C-c
2141 @vindex org-startup-align-all-tables
2142 When visiting a file containing a table with narrowed columns, the
2143 necessary character hiding has not yet happened, and the table needs to
2144 be aligned before it looks nice. Setting the option
2145 @code{org-startup-align-all-tables} will realign all tables in a file
2146 upon visiting, but also slow down startup. You can also set this option
2147 on a per-file basis with:
2154 If you would like to overrule the automatic alignment of number-rich columns
2155 to the right and of string-rich column to the left, you can use @samp{<r>},
2156 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2157 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2158 also combine alignment and field width like this: @samp{<l10>}.
2160 Lines which only contain these formatting cookies will be removed
2161 automatically when exporting the document.
2163 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2164 @section Column groups
2165 @cindex grouping columns in tables
2167 When Org exports tables, it does so by default without vertical
2168 lines because that is visually more satisfying in general. Occasionally
2169 however, vertical lines can be useful to structure a table into groups
2170 of columns, much like horizontal lines can do for groups of rows. In
2171 order to specify column groups, you can use a special row where the
2172 first field contains only @samp{/}. The further fields can either
2173 contain @samp{<} to indicate that this column should start a group,
2174 @samp{>} to indicate the end of a column, or @samp{<>} to make a column
2175 a group of its own. Boundaries between column groups will upon export be
2176 marked with vertical lines. Here is an example:
2179 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2180 |---+-----+-----+-----+---------+------------|
2181 | / | < | | > | < | > |
2182 | 1 | 1 | 1 | 1 | 1 | 1 |
2183 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2184 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2185 |---+-----+-----+-----+---------+------------|
2186 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2189 It is also sufficient to just insert the column group starters after
2190 every vertical line you would like to have:
2193 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2194 |----+-----+-----+-----+---------+------------|
2198 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2199 @section The Orgtbl minor mode
2201 @cindex minor mode for tables
2203 If you like the intuitive way the Org table editor works, you
2204 might also want to use it in other modes like Text mode or Mail mode.
2205 The minor mode Orgtbl mode makes this possible. You can always toggle
2206 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2207 example in Message mode, use
2210 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2213 Furthermore, with some special setup, it is possible to maintain tables
2214 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2215 construct @LaTeX{} tables with the underlying ease and power of
2216 Orgtbl mode, including spreadsheet capabilities. For details, see
2217 @ref{Tables in arbitrary syntax}.
2219 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2220 @section The spreadsheet
2221 @cindex calculations, in tables
2222 @cindex spreadsheet capabilities
2223 @cindex @file{calc} package
2225 The table editor makes use of the Emacs @file{calc} package to implement
2226 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2227 derive fields from other fields. While fully featured, Org's implementation
2228 is not identical to other spreadsheets. For example, Org knows the concept
2229 of a @emph{column formula} that will be applied to all non-header fields in a
2230 column without having to copy the formula to each relevant field. There is
2231 also a formula debugger, and a formula editor with features for highlighting
2232 fields in the table corresponding to the references at the point in the
2233 formula, moving these references by arrow keys
2236 * References:: How to refer to another field or range
2237 * Formula syntax for Calc:: Using Calc to compute stuff
2238 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2239 * Field and range formulas:: Formula for specific (ranges of) fields
2240 * Column formulas:: Formulas valid for an entire column
2241 * Editing and debugging formulas:: Fixing formulas
2242 * Updating the table:: Recomputing all dependent fields
2243 * Advanced features:: Field names, parameters and automatic recalc
2246 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2247 @subsection References
2250 To compute fields in the table from other fields, formulas must
2251 reference other fields or ranges. In Org, fields can be referenced
2252 by name, by absolute coordinates, and by relative coordinates. To find
2253 out what the coordinates of a field are, press @kbd{C-c ?} in that
2254 field, or press @kbd{C-c @}} to toggle the display of a grid.
2256 @subsubheading Field references
2257 @cindex field references
2258 @cindex references, to fields
2260 Formulas can reference the value of another field in two ways. Like in
2261 any other spreadsheet, you may reference fields with a letter/number
2262 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2265 @vindex org-table-use-standard-references
2266 Org prefers@footnote{Org will understand references typed by the user as
2267 @samp{B4}, but it will not use this syntax when offering a formula for
2268 editing. You can customize this behavior using the variable
2269 @code{org-table-use-standard-references}.} to use another, more general
2270 operator that looks like this:
2272 @@@var{row}$@var{column}
2276 and allows relative references, i.e. references relative to the
2277 row/column of the field whose value is being computed. These relative
2278 references make it possible to store a formula only once and use it in many
2279 fields without copying and modifying it.
2281 Column references can be absolute like @samp{1}, @samp{2},...@samp{@var{N}},
2282 or relative to the current column like @samp{+1} or @samp{-2}. @code{$>}
2283 references the last column in the table, and you can use offsets like
2284 @code{$>-2}, meaning the third column from the right.
2286 The row specification only counts data lines and ignores horizontal separator
2287 lines (hlines). Like with columns, you can use absolute row numbers
2288 @samp{1}...@samp{@var{N}}, and row numbers relative to the current row like
2289 @samp{+3} or @samp{-1}, and @code{@@>} references the last row in the
2290 table@footnote{For backward compatibility you can also use special names like
2291 @samp{$LR5} and @samp{$LR12} to refer in a stable way to the 5th and 12th
2292 field in the last row of the table. However, this syntax is deprecated, it
2293 should not be used for new documents.}. You may also specify the row
2294 relative to one of the hlines: @samp{I} refers to the first
2295 hline@footnote{Note that only hlines are counted that @emph{separate} table
2296 lines. If the table starts with a hline above the header, it does not
2297 count.}, @samp{II} to the second, etc@. @samp{-I} refers to the first such
2298 line above the current line, @samp{+I} to the first such line below the
2299 current line. You can also write @samp{III+2} which is the second data line
2300 after the third hline in the table.
2302 @samp{0} refers to the current row and column. Also, if you omit
2303 either the column or the row part of the reference, the current
2304 row/column is implied.
2306 Org's references with @emph{unsigned} numbers are fixed references
2307 in the sense that if you use the same reference in the formula for two
2308 different fields, the same field will be referenced each time.
2309 Org's references with @emph{signed} numbers are floating
2310 references because the same reference operator can reference different
2311 fields depending on the field being calculated by the formula.
2314 Here are a few examples:
2317 @@2$3 @r{2nd row, 3rd column}
2318 C2 @r{same as previous}
2319 $5 @r{column 5 in the current row}
2320 E& @r{same as previous}
2321 @@2 @r{current column, row 2}
2322 @@-1$-3 @r{the field one row up, three columns to the left}
2323 @@-I$2 @r{field just under hline above current row, column 2}
2326 @subsubheading Range references
2327 @cindex range references
2328 @cindex references, to ranges
2330 You may reference a rectangular range of fields by specifying two field
2331 references connected by two dots @samp{..}. If both fields are in the
2332 current row, you may simply use @samp{$2..$7}, but if at least one field
2333 is in a different row, you need to use the general @code{@@row$column}
2334 format at least for the first field (i.e the reference must start with
2335 @samp{@@} in order to be interpreted correctly). Examples:
2338 $1..$3 @r{First three fields in the current row}
2339 $P..$Q @r{Range, using column names (see under Advanced)}
2340 @@2$1..@@4$3 @r{6 fields between these two fields}
2341 A2..C4 @r{Same as above}
2342 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2343 @@I..II @r{Between first and second hline, short for @code{@@I..@@II}}
2346 @noindent Range references return a vector of values that can be fed
2347 into Calc vector functions. Empty fields in ranges are normally
2348 suppressed, so that the vector contains only the non-empty fields (but
2349 see the @samp{E} mode switch below). If there are no non-empty fields,
2350 @samp{[0]} is returned to avoid syntax errors in formulas.
2352 @subsubheading Field coordinates in formulas
2353 @cindex field coordinates
2354 @cindex coordinates, of field
2355 @cindex row, of field coordinates
2356 @cindex column, of field coordinates
2358 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2359 get the row or column number of the field where the formula result goes.
2360 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2361 and @code{org-table-current-column}. Examples:
2364 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2365 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2366 @r{column 3 of the current table}
2369 @noindent For the second example, table FOO must have at least as many rows
2370 as the current table. Note that this is inefficient@footnote{The computation time scales as
2371 O(N^2) because table FOO is parsed for each field to be copied.} for large
2374 @subsubheading Named references
2375 @cindex named references
2376 @cindex references, named
2377 @cindex name, of column or field
2378 @cindex constants, in calculations
2381 @vindex org-table-formula-constants
2382 @samp{$name} is interpreted as the name of a column, parameter or
2383 constant. Constants are defined globally through the variable
2384 @code{org-table-formula-constants}, and locally (for the file) through a
2388 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2392 @vindex constants-unit-system
2393 @pindex constants.el
2394 Also properties (@pxref{Properties and Columns}) can be used as
2395 constants in table formulas: for a property @samp{:Xyz:} use the name
2396 @samp{$PROP_Xyz}, and the property will be searched in the current
2397 outline entry and in the hierarchy above it. If you have the
2398 @file{constants.el} package, it will also be used to resolve constants,
2399 including natural constants like @samp{$h} for Planck's constant, and
2400 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2401 supply the values of constants in two different unit systems, @code{SI}
2402 and @code{cgs}. Which one is used depends on the value of the variable
2403 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2404 @code{constSI} and @code{constcgs} to set this value for the current
2405 buffer.}. Column names and parameters can be specified in special table
2406 lines. These are described below, see @ref{Advanced features}. All
2407 names must start with a letter, and further consist of letters and
2410 @subsubheading Remote references
2411 @cindex remote references
2412 @cindex references, remote
2413 @cindex references, to a different table
2414 @cindex name, of column or field
2415 @cindex constants, in calculations
2418 You may also reference constants, fields and ranges from a different table,
2419 either in the current file or even in a different file. The syntax is
2422 remote(NAME-OR-ID,REF)
2426 where NAME can be the name of a table in the current file as set by a
2427 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2428 entry, even in a different file, and the reference then refers to the first
2429 table in that entry. REF is an absolute field or range reference as
2430 described above for example @code{@@3$3} or @code{$somename}, valid in the
2433 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2434 @subsection Formula syntax for Calc
2435 @cindex formula syntax, Calc
2436 @cindex syntax, of formulas
2438 A formula can be any algebraic expression understood by the Emacs
2439 @file{Calc} package. @b{Note that @file{calc} has the
2440 non-standard convention that @samp{/} has lower precedence than
2441 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2442 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2443 Your Programs,calc-eval,Calling Calc from Your Lisp Programs,Calc,GNU
2444 Emacs Calc Manual}),
2445 @c FIXME: The link to the Calc manual in HTML does not work.
2446 variable substitution takes place according to the rules described above.
2447 @cindex vectors, in table calculations
2448 The range vectors can be directly fed into the Calc vector functions
2449 like @samp{vmean} and @samp{vsum}.
2451 @cindex format specifier
2452 @cindex mode, for @file{calc}
2453 @vindex org-calc-default-modes
2454 A formula can contain an optional mode string after a semicolon. This
2455 string consists of flags to influence Calc and other modes during
2456 execution. By default, Org uses the standard Calc modes (precision
2457 12, angular units degrees, fraction and symbolic modes off). The display
2458 format, however, has been changed to @code{(float 8)} to keep tables
2459 compact. The default settings can be configured using the variable
2460 @code{org-calc-default-modes}.
2463 p20 @r{set the internal Calc calculation precision to 20 digits}
2464 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2465 @r{format of the result of Calc passed back to Org.}
2466 @r{Calc formatting is unlimited in precision as}
2467 @r{long as the Calc calculation precision is greater.}
2468 D R @r{angle modes: degrees, radians}
2469 F S @r{fraction and symbolic modes}
2470 N @r{interpret all fields as numbers, use 0 for non-numbers}
2471 T @r{force text interpretation}
2472 E @r{keep empty fields in ranges}
2477 Unless you use large integer numbers or high-precision-calculation
2478 and -display for floating point numbers you may alternatively provide a
2479 @code{printf} format specifier to reformat the Calc result after it has been
2480 passed back to Org instead of letting Calc already do the
2481 formatting@footnote{The @code{printf} reformatting is limited in precision
2482 because the value passed to it is converted into an @code{integer} or
2483 @code{double}. The @code{integer} is limited in size by truncating the
2484 signed value to 32 bits. The @code{double} is limited in precision to 64
2485 bits overall which leaves approximately 16 significant decimal digits.}.
2489 $1+$2 @r{Sum of first and second field}
2490 $1+$2;%.2f @r{Same, format result to two decimals}
2491 exp($2)+exp($1) @r{Math functions can be used}
2492 $0;%.1f @r{Reformat current cell to 1 decimal}
2493 ($3-32)*5/9 @r{Degrees F -> C conversion}
2494 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2495 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2496 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2497 vmean($2..$7) @r{Compute column range mean, using vector function}
2498 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2499 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2502 Calc also contains a complete set of logical operations. For example
2505 if($1<20,teen,string("")) @r{``teen'' if age $1 less than 20, else empty}
2508 @node Formula syntax for Lisp, Field and range formulas, Formula syntax for Calc, The spreadsheet
2509 @subsection Emacs Lisp forms as formulas
2510 @cindex Lisp forms, as table formulas
2512 It is also possible to write a formula in Emacs Lisp; this can be useful for
2513 string manipulation and control structures, if Calc's functionality is not
2514 enough. If a formula starts with a single-quote followed by an opening
2515 parenthesis, then it is evaluated as a Lisp form. The evaluation should
2516 return either a string or a number. Just as with @file{calc} formulas, you
2517 can specify modes and a printf format after a semicolon. With Emacs Lisp
2518 forms, you need to be conscious about the way field references are
2519 interpolated into the form. By default, a reference will be interpolated as
2520 a Lisp string (in double-quotes) containing the field. If you provide the
2521 @samp{N} mode switch, all referenced elements will be numbers (non-number
2522 fields will be zero) and interpolated as Lisp numbers, without quotes. If
2523 you provide the @samp{L} flag, all fields will be interpolated literally,
2524 without quotes. i.e., if you want a reference to be interpreted as a string
2525 by the Lisp form, enclose the reference operator itself in double-quotes,
2526 like @code{"$3"}. Ranges are inserted as space-separated fields, so you can
2527 embed them in list or vector syntax. Here are a few examples---note how the
2528 @samp{N} mode is used when we do computations in Lisp:
2531 @r{Swap the first two characters of the content of column 1}
2532 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2533 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2535 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2536 '(apply '+ '($1..$4));N
2539 @node Field and range formulas, Column formulas, Formula syntax for Lisp, The spreadsheet
2540 @subsection Field and range formulas
2541 @cindex field formula
2542 @cindex range formula
2543 @cindex formula, for individual table field
2544 @cindex formula, for range of fields
2546 To assign a formula to a particular field, type it directly into the field,
2547 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2548 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2549 the formula will be stored as the formula for this field, evaluated, and the
2550 current field will be replaced with the result.
2553 Formulas are stored in a special line starting with @samp{#+TBLFM:}
2554 directly below the table. If you type the equation in the 4th field of
2555 the 3rd data line in the table, the formula will look like
2556 @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows
2557 with the appropriate commands, @i{absolute references} (but not relative
2558 ones) in stored formulas are modified in order to still reference the
2559 same field. Of course this is not true if you edit the table structure
2560 with normal editing commands---then you must fix the equations yourself.
2561 Instead of typing an equation into the field, you may also use the
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{@@L=} 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 represent the all checkboxes below the cookie, not just the 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. Or simply toggle any
4336 entry twice (checkboxes with @kbd{C-c C-c}).
4339 @node Tags, Properties and Columns, TODO Items, Top
4342 @cindex headline tagging
4343 @cindex matching, tags
4344 @cindex sparse tree, tag based
4346 An excellent way to implement labels and contexts for cross-correlating
4347 information is to assign @i{tags} to headlines. Org-mode has extensive
4350 @vindex org-tag-faces
4351 Every headline can contain a list of tags; they occur at the end of the
4352 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4353 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4354 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4355 Tags will by default be in bold face with the same color as the headline.
4356 You may specify special faces for specific tags using the variable
4357 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4358 (@pxref{Faces for TODO keywords}).
4361 * Tag inheritance:: Tags use the tree structure of the outline
4362 * Setting tags:: How to assign tags to a headline
4363 * Tag searches:: Searching for combinations of tags
4366 @node Tag inheritance, Setting tags, Tags, Tags
4367 @section Tag inheritance
4368 @cindex tag inheritance
4369 @cindex inheritance, of tags
4370 @cindex sublevels, inclusion into tags match
4372 @i{Tags} make use of the hierarchical structure of outline trees. If a
4373 heading has a certain tag, all subheadings will inherit the tag as
4374 well. For example, in the list
4377 * Meeting with the French group :work:
4378 ** Summary by Frank :boss:notes:
4379 *** TODO Prepare slides for him :action:
4383 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4384 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4385 explicitly marked with those tags. You can also set tags that all entries in
4386 a file should inherit just as if these tags were defined in a hypothetical
4387 level zero that surrounds the entire file. Use a line like this@footnote{As
4388 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4389 changes in the line.}:
4393 #+FILETAGS: :Peter:Boss:Secret:
4397 @vindex org-use-tag-inheritance
4398 @vindex org-tags-exclude-from-inheritance
4399 To limit tag inheritance to specific tags, or to turn it off entirely, use
4400 the variables @code{org-use-tag-inheritance} and
4401 @code{org-tags-exclude-from-inheritance}.
4403 @vindex org-tags-match-list-sublevels
4404 When a headline matches during a tags search while tag inheritance is turned
4405 on, all the sublevels in the same tree will (for a simple match form) match
4406 as well@footnote{This is only true if the search does not involve more
4407 complex tests including properties (@pxref{Property searches}).}. The list
4408 of matches may then become very long. If you only want to see the first tags
4409 match in a subtree, configure the variable
4410 @code{org-tags-match-list-sublevels} (not recommended).
4412 @node Setting tags, Tag searches, Tag inheritance, Tags
4413 @section Setting tags
4414 @cindex setting tags
4415 @cindex tags, setting
4418 Tags can simply be typed into the buffer at the end of a headline.
4419 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4420 also a special command for inserting tags:
4423 @orgcmd{C-c C-q,org-set-tags-command}
4424 @cindex completion, of tags
4425 @vindex org-tags-column
4426 Enter new tags for the current headline. Org-mode will either offer
4427 completion or a special single-key interface for setting tags, see
4428 below. After pressing @key{RET}, the tags will be inserted and aligned
4429 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4430 tags in the current buffer will be aligned to that column, just to make
4431 things look nice. TAGS are automatically realigned after promotion,
4432 demotion, and TODO state changes (@pxref{TODO basics}).
4433 @orgcmd{C-c C-c,org-set-tags-command}
4434 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4437 @vindex org-tag-alist
4438 Org will support tag insertion based on a @emph{list of tags}. By
4439 default this list is constructed dynamically, containing all tags
4440 currently used in the buffer. You may also globally specify a hard list
4441 of tags with the variable @code{org-tag-alist}. Finally you can set
4442 the default tags for a given file with lines like
4446 #+TAGS: @@work @@home @@tennisclub
4447 #+TAGS: laptop car pc sailboat
4450 If you have globally defined your preferred set of tags using the
4451 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4452 in a specific file, add an empty TAGS option line to that file:
4458 @vindex org-tag-persistent-alist
4459 If you have a preferred set of tags that you would like to use in every file,
4460 in addition to those defined on a per-file basis by TAGS option lines, then
4461 you may specify a list of tags with the variable
4462 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4463 by adding a STARTUP option line to that file:
4469 By default Org-mode uses the standard minibuffer completion facilities for
4470 entering tags. However, it also implements another, quicker, tag selection
4471 method called @emph{fast tag selection}. This allows you to select and
4472 deselect tags with just a single key press. For this to work well you should
4473 assign unique letters to most of your commonly used tags. You can do this
4474 globally by configuring the variable @code{org-tag-alist} in your
4475 @file{.emacs} file. For example, you may find the need to tag many items in
4476 different files with @samp{:@@home:}. In this case you can set something
4480 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4483 @noindent If the tag is only relevant to the file you are working on, then you
4484 can instead set the TAGS option line as:
4487 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4490 @noindent The tags interface will show the available tags in a splash
4491 window. If you want to start a new line after a specific tag, insert
4492 @samp{\n} into the tag list
4495 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4498 @noindent or write them in two lines:
4501 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4502 #+TAGS: laptop(l) pc(p)
4506 You can also group together tags that are mutually exclusive by using
4510 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4513 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4514 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4516 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4517 these lines to activate any changes.
4520 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4521 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4522 of the braces. Similarly, you can use @code{:newline} to indicate a line
4523 break. The previous example would be set globally by the following
4527 (setq org-tag-alist '((:startgroup . nil)
4528 ("@@work" . ?w) ("@@home" . ?h)
4529 ("@@tennisclub" . ?t)
4531 ("laptop" . ?l) ("pc" . ?p)))
4534 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4535 automatically present you with a special interface, listing inherited tags,
4536 the tags of the current headline, and a list of all valid tags with
4537 corresponding keys@footnote{Keys will automatically be assigned to tags which
4538 have no configured keys.}. In this interface, you can use the following
4543 Pressing keys assigned to tags will add or remove them from the list of
4544 tags in the current line. Selecting a tag in a group of mutually
4545 exclusive tags will turn off any other tags from that group.
4548 Enter a tag in the minibuffer, even if the tag is not in the predefined
4549 list. You will be able to complete on all tags present in the buffer.
4550 You can also add several tags: just separate them with a comma.
4554 Clear all tags for this line.
4557 Accept the modified set.
4559 Abort without installing changes.
4561 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4563 Turn off groups of mutually exclusive tags. Use this to (as an
4564 exception) assign several tags from such a group.
4566 Toggle auto-exit after the next change (see below).
4567 If you are using expert mode, the first @kbd{C-c} will display the
4572 This method lets you assign tags to a headline with very few keys. With
4573 the above setup, you could clear the current tags and set @samp{@@home},
4574 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4575 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4576 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4577 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4578 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4579 @key{RET} @key{RET}}.
4581 @vindex org-fast-tag-selection-single-key
4582 If you find that most of the time you need only a single key press to
4583 modify your list of tags, set the variable
4584 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4585 press @key{RET} to exit fast tag selection---it will immediately exit
4586 after the first change. If you then occasionally need more keys, press
4587 @kbd{C-c} to turn off auto-exit for the current tag selection process
4588 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4589 C-c}). If you set the variable to the value @code{expert}, the special
4590 window is not even shown for single-key tag selection, it comes up only
4591 when you press an extra @kbd{C-c}.
4593 @node Tag searches, , Setting tags, Tags
4594 @section Tag searches
4595 @cindex tag searches
4596 @cindex searching for tags
4598 Once a system of tags has been set up, it can be used to collect related
4599 information into special lists.
4602 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
4603 Create a sparse tree with all headlines matching a tags search. With a
4604 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4605 @orgcmd{C-c a m,org-tags-view}
4606 Create a global list of tag matches from all agenda files.
4607 @xref{Matching tags and properties}.
4608 @orgcmd{C-c a M,org-tags-view}
4609 @vindex org-tags-match-list-sublevels
4610 Create a global list of tag matches from all agenda files, but check
4611 only TODO items and force checking subitems (see variable
4612 @code{org-tags-match-list-sublevels}).
4615 These commands all prompt for a match string which allows basic Boolean logic
4616 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4617 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4618 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4619 string is rich and allows also matching against TODO keywords, entry levels
4620 and properties. For a complete description with many examples, see
4621 @ref{Matching tags and properties}.
4624 @node Properties and Columns, Dates and Times, Tags, Top
4625 @chapter Properties and columns
4628 Properties are a set of key-value pairs associated with an entry. There
4629 are two main applications for properties in Org-mode. First, properties
4630 are like tags, but with a value. Second, you can use properties to
4631 implement (very basic) database capabilities in an Org buffer. For
4632 an example of the first application, imagine maintaining a file where
4633 you document bugs and plan releases for a piece of software. Instead of
4634 using tags like @code{:release_1:}, @code{:release_2:}, one can use a
4635 property, say @code{:Release:}, that in different subtrees has different
4636 values, such as @code{1.0} or @code{2.0}. For an example of the second
4637 application of properties, imagine keeping track of your music CDs,
4638 where properties could be things such as the album, artist, date of
4639 release, number of tracks, and so on.
4641 Properties can be conveniently edited and viewed in column view
4642 (@pxref{Column view}).
4645 * Property syntax:: How properties are spelled out
4646 * Special properties:: Access to other Org-mode features
4647 * Property searches:: Matching property values
4648 * Property inheritance:: Passing values down the tree
4649 * Column view:: Tabular viewing and editing
4650 * Property API:: Properties for Lisp programmers
4653 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4654 @section Property syntax
4655 @cindex property syntax
4656 @cindex drawer, for properties
4658 Properties are key-value pairs. They need to be inserted into a special
4659 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4660 is specified on a single line, with the key (surrounded by colons)
4661 first, and the value after it. Here is an example:
4666 *** Goldberg Variations
4668 :Title: Goldberg Variations
4669 :Composer: J.S. Bach
4671 :Publisher: Deutsche Grammophon
4676 You may define the allowed values for a particular property @samp{:Xyz:}
4677 by setting a property @samp{:Xyz_ALL:}. This special property is
4678 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4679 the entire tree. When allowed values are defined, setting the
4680 corresponding property becomes easier and is less prone to typing
4681 errors. For the example with the CD collection, we can predefine
4682 publishers and the number of disks in a box like this:
4687 :NDisks_ALL: 1 2 3 4
4688 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4692 If you want to set properties that can be inherited by any entry in a
4693 file, use a line like
4694 @cindex property, _ALL
4697 #+PROPERTY: NDisks_ALL 1 2 3 4
4700 @vindex org-global-properties
4701 Property values set with the global variable
4702 @code{org-global-properties} can be inherited by all entries in all
4706 The following commands help to work with properties:
4709 @orgcmd{M-@key{TAB},pcomplete}
4710 After an initial colon in a line, complete property keys. All keys used
4711 in the current file will be offered as possible completions.
4712 @orgcmd{C-c C-x p,org-set-property}
4713 Set a property. This prompts for a property name and a value. If
4714 necessary, the property drawer is created as well.
4715 @item M-x org-insert-property-drawer
4716 @findex org-insert-property-drawer
4717 Insert a property drawer into the current entry. The drawer will be
4718 inserted early in the entry, but after the lines with planning
4719 information like deadlines.
4720 @orgcmd{C-c C-c,org-property-action}
4721 With the cursor in a property drawer, this executes property commands.
4722 @orgcmd{C-c C-c s,org-set-property}
4723 Set a property in the current entry. Both the property and the value
4724 can be inserted using completion.
4725 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4726 Switch property at point to the next/previous allowed value.
4727 @orgcmd{C-c C-c d,org-delete-property}
4728 Remove a property from the current entry.
4729 @orgcmd{C-c C-c D,org-delete-property-globally}
4730 Globally remove a property, from all entries in the current file.
4731 @orgcmd{C-c C-c c,org-compute-property-at-point}
4732 Compute the property at point, using the operator and scope from the
4733 nearest column format definition.
4736 @node Special properties, Property searches, Property syntax, Properties and Columns
4737 @section Special properties
4738 @cindex properties, special
4740 Special properties provide an alternative access method to Org-mode features,
4741 like the TODO state or the priority of an entry, discussed in the previous
4742 chapters. This interface exists so that you can include these states in a
4743 column view (@pxref{Column view}), or to use them in queries. The following
4744 property names are special and (except for @code{:CATEGORY:}) should not be
4745 used as keys in the properties drawer:
4747 @cindex property, special, TODO
4748 @cindex property, special, TAGS
4749 @cindex property, special, ALLTAGS
4750 @cindex property, special, CATEGORY
4751 @cindex property, special, PRIORITY
4752 @cindex property, special, DEADLINE
4753 @cindex property, special, SCHEDULED
4754 @cindex property, special, CLOSED
4755 @cindex property, special, TIMESTAMP
4756 @cindex property, special, TIMESTAMP_IA
4757 @cindex property, special, CLOCKSUM
4758 @cindex property, special, BLOCKED
4759 @c guessing that ITEM is needed in this area; also, should this list be sorted?
4760 @cindex property, special, ITEM
4761 @cindex property, special, FILE
4763 TODO @r{The TODO keyword of the entry.}
4764 TAGS @r{The tags defined directly in the headline.}
4765 ALLTAGS @r{All tags, including inherited ones.}
4766 CATEGORY @r{The category of an entry.}
4767 PRIORITY @r{The priority of the entry, a string with a single letter.}
4768 DEADLINE @r{The deadline time string, without the angular brackets.}
4769 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
4770 CLOSED @r{When was this entry closed?}
4771 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
4772 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
4773 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
4774 @r{must be run first to compute the values.}
4775 BLOCKED @r{"t" if task is currently blocked by children or siblings}
4776 ITEM @r{The content of the entry.}
4777 FILE @r{The filename the entry is located in.}
4780 @node Property searches, Property inheritance, Special properties, Properties and Columns
4781 @section Property searches
4782 @cindex properties, searching
4783 @cindex searching, of properties
4785 To create sparse trees and special lists with selection based on properties,
4786 the same commands are used as for tag searches (@pxref{Tag searches}).
4788 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
4789 Create a sparse tree with all matching entries. With a
4790 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4791 @orgcmd{C-c a m,org-tags-view}
4792 Create a global list of tag/property matches from all agenda files.
4793 @xref{Matching tags and properties}.
4794 @orgcmd{C-c a M,org-tags-view}
4795 @vindex org-tags-match-list-sublevels
4796 Create a global list of tag matches from all agenda files, but check
4797 only TODO items and force checking of subitems (see variable
4798 @code{org-tags-match-list-sublevels}).
4801 The syntax for the search string is described in @ref{Matching tags and
4804 There is also a special command for creating sparse trees based on a
4809 Create a sparse tree based on the value of a property. This first
4810 prompts for the name of a property, and then for a value. A sparse tree
4811 is created with all entries that define this property with the given
4812 value. If you enclose the value in curly braces, it is interpreted as
4813 a regular expression and matched against the property values.
4816 @node Property inheritance, Column view, Property searches, Properties and Columns
4817 @section Property Inheritance
4818 @cindex properties, inheritance
4819 @cindex inheritance, of properties
4821 @vindex org-use-property-inheritance
4822 The outline structure of Org-mode documents lends itself to an
4823 inheritance model of properties: if the parent in a tree has a certain
4824 property, the children can inherit this property. Org-mode does not
4825 turn this on by default, because it can slow down property searches
4826 significantly and is often not needed. However, if you find inheritance
4827 useful, you can turn it on by setting the variable
4828 @code{org-use-property-inheritance}. It may be set to @code{t} to make
4829 all properties inherited from the parent, to a list of properties
4830 that should be inherited, or to a regular expression that matches
4831 inherited properties. If a property has the value @samp{nil}, this is
4832 interpreted as an explicit undefine of the property, so that inheritance
4833 search will stop at this value and return @code{nil}.
4835 Org-mode has a few properties for which inheritance is hard-coded, at
4836 least for the special applications for which they are used:
4838 @cindex property, COLUMNS
4841 The @code{:COLUMNS:} property defines the format of column view
4842 (@pxref{Column view}). It is inherited in the sense that the level
4843 where a @code{:COLUMNS:} property is defined is used as the starting
4844 point for a column view table, independently of the location in the
4845 subtree from where columns view is turned on.
4847 @cindex property, CATEGORY
4848 For agenda view, a category set through a @code{:CATEGORY:} property
4849 applies to the entire subtree.
4851 @cindex property, ARCHIVE
4852 For archiving, the @code{:ARCHIVE:} property may define the archive
4853 location for the entire subtree (@pxref{Moving subtrees}).
4855 @cindex property, LOGGING
4856 The LOGGING property may define logging settings for an entry or a
4857 subtree (@pxref{Tracking TODO state changes}).
4860 @node Column view, Property API, Property inheritance, Properties and Columns
4861 @section Column view
4863 A great way to view and edit properties in an outline tree is
4864 @emph{column view}. In column view, each outline node is turned into a
4865 table row. Columns in this table provide access to properties of the
4866 entries. Org-mode implements columns by overlaying a tabular structure
4867 over the headline of each item. While the headlines have been turned
4868 into a table row, you can still change the visibility of the outline
4869 tree. For example, you get a compact table by switching to CONTENTS
4870 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
4871 is active), but you can still open, read, and edit the entry below each
4872 headline. Or, you can switch to column view after executing a sparse
4873 tree command and in this way get a table only for the selected items.
4874 Column view also works in agenda buffers (@pxref{Agenda Views}) where
4875 queries have collected selected items, possibly from a number of files.
4878 * Defining columns:: The COLUMNS format property
4879 * Using column view:: How to create and use column view
4880 * Capturing column view:: A dynamic block for column view
4883 @node Defining columns, Using column view, Column view, Column view
4884 @subsection Defining columns
4885 @cindex column view, for properties
4886 @cindex properties, column view
4888 Setting up a column view first requires defining the columns. This is
4889 done by defining a column format line.
4892 * Scope of column definitions:: Where defined, where valid?
4893 * Column attributes:: Appearance and content of a column
4896 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
4897 @subsubsection Scope of column definitions
4899 To define a column format for an entire file, use a line like
4903 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4906 To specify a format that only applies to a specific tree, add a
4907 @code{:COLUMNS:} property to the top node of that tree, for example:
4910 ** Top node for columns view
4912 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
4916 If a @code{:COLUMNS:} property is present in an entry, it defines columns
4917 for the entry itself, and for the entire subtree below it. Since the
4918 column definition is part of the hierarchical structure of the document,
4919 you can define columns on level 1 that are general enough for all
4920 sublevels, and more specific columns further down, when you edit a
4921 deeper part of the tree.
4923 @node Column attributes, , Scope of column definitions, Defining columns
4924 @subsubsection Column attributes
4925 A column definition sets the attributes of a column. The general
4926 definition looks like this:
4929 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
4933 Except for the percent sign and the property name, all items are
4934 optional. The individual parts have the following meaning:
4937 @var{width} @r{An integer specifying the width of the column in characters.}
4938 @r{If omitted, the width will be determined automatically.}
4939 @var{property} @r{The property that should be edited in this column.}
4940 @r{Special properties representing meta data are allowed here}
4941 @r{as well (@pxref{Special properties})}
4942 @var{title} @r{The header text for the column. If omitted, the property}
4944 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
4945 @r{parent nodes are computed from the children.}
4946 @r{Supported summary types are:}
4947 @{+@} @r{Sum numbers in this column.}
4948 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
4949 @{$@} @r{Currency, short for @samp{+;%.2f}.}
4950 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
4951 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
4952 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
4953 @{X%@} @r{Checkbox status, @samp{[n%]}.}
4954 @{min@} @r{Smallest number in column.}
4955 @{max@} @r{Largest number.}
4956 @{mean@} @r{Arithmetic mean of numbers.}
4957 @{:min@} @r{Smallest time value in column.}
4958 @{:max@} @r{Largest time value.}
4959 @{:mean@} @r{Arithmetic mean of time values.}
4960 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
4961 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
4962 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
4963 @{est+@} @r{Add low-high estimates.}
4967 Be aware that you can only have one summary type for any property you
4968 include. Subsequent columns referencing the same property will all display the
4969 same summary information.
4971 The @code{est+} summary type requires further explanation. It is used for
4972 combining estimates, expressed as low-high ranges. For example, instead
4973 of estimating a particular task will take 5 days, you might estimate it as
4974 5-6 days if you're fairly confident you know how much work is required, or
4975 1-10 days if you don't really know what needs to be done. Both ranges
4976 average at 5.5 days, but the first represents a more predictable delivery.
4978 When combining a set of such estimates, simply adding the lows and highs
4979 produces an unrealistically wide result. Instead, @code{est+} adds the
4980 statistical mean and variance of the sub-tasks, generating a final estimate
4981 from the sum. For example, suppose you had ten tasks, each of which was
4982 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
4983 of 5 to 20 days, representing what to expect if everything goes either
4984 extremely well or extremely poorly. In contrast, @code{est+} estimates the
4985 full job more realistically, at 10-15 days.
4987 Here is an example for a complete columns definition, along with allowed
4991 :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.}
4992 %10Time_Estimate@{:@} %CLOCKSUM
4993 :Owner_ALL: Tammy Mark Karl Lisa Don
4994 :Status_ALL: "In progress" "Not started yet" "Finished" ""
4995 :Approved_ALL: "[ ]" "[X]"
4999 The first column, @samp{%25ITEM}, means the first 25 characters of the
5000 item itself, i.e.@: of the headline. You probably always should start the
5001 column definition with the @samp{ITEM} specifier. The other specifiers
5002 create columns @samp{Owner} with a list of names as allowed values, for
5003 @samp{Status} with four different possible values, and for a checkbox
5004 field @samp{Approved}. When no width is given after the @samp{%}
5005 character, the column will be exactly as wide as it needs to be in order
5006 to fully display all values. The @samp{Approved} column does have a
5007 modified title (@samp{Approved?}, with a question mark). Summaries will
5008 be created for the @samp{Time_Estimate} column by adding time duration
5009 expressions like HH:MM, and for the @samp{Approved} column, by providing
5010 an @samp{[X]} status if all children have been checked. The
5011 @samp{CLOCKSUM} column is special, it lists the sum of CLOCK intervals
5014 @node Using column view, Capturing column view, Defining columns, Column view
5015 @subsection Using column view
5018 @tsubheading{Turning column view on and off}
5019 @orgcmd{C-c C-x C-c,org-columns}
5020 @vindex org-columns-default-format
5021 Turn on column view. If the cursor is before the first headline in the file,
5022 column view is turned on for the entire file, using the @code{#+COLUMNS}
5023 definition. If the cursor is somewhere inside the outline, this command
5024 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5025 defines a format. When one is found, the column view table is established
5026 for the tree starting at the entry that contains the @code{:COLUMNS:}
5027 property. If no such property is found, the format is taken from the
5028 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5029 and column view is established for the current entry and its subtree.
5030 @orgcmd{r,org-columns-redo}
5031 Recreate the column view, to include recent changes made in the buffer.
5032 @orgcmd{g,org-columns-redo}
5034 @orgcmd{q,org-columns-quit}
5036 @tsubheading{Editing values}
5037 @item @key{left} @key{right} @key{up} @key{down}
5038 Move through the column view from field to field.
5039 @kindex S-@key{left}
5040 @kindex S-@key{right}
5041 @item S-@key{left}/@key{right}
5042 Switch to the next/previous allowed value of the field. For this, you
5043 have to have specified allowed values for a property.
5045 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5046 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5047 Same as @kbd{S-@key{left}/@key{right}}
5048 @orgcmd{e,org-columns-edit-value}
5049 Edit the property at point. For the special properties, this will
5050 invoke the same interface that you normally use to change that
5051 property. For example, when editing a TAGS property, the tag completion
5052 or fast selection interface will pop up.
5053 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5054 When there is a checkbox at point, toggle it.
5055 @orgcmd{v,org-columns-show-value}
5056 View the full value of this property. This is useful if the width of
5057 the column is smaller than that of the value.
5058 @orgcmd{a,org-columns-edit-allowed}
5059 Edit the list of allowed values for this property. If the list is found
5060 in the hierarchy, the modified values is stored there. If no list is
5061 found, the new value is stored in the first entry that is part of the
5062 current column view.
5063 @tsubheading{Modifying the table structure}
5064 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5065 Make the column narrower/wider by one character.
5066 @orgcmd{S-M-@key{right},org-columns-new}
5067 Insert a new column, to the left of the current column.
5068 @orgcmd{S-M-@key{left},org-columns-delete}
5069 Delete the current column.
5072 @node Capturing column view, , Using column view, Column view
5073 @subsection Capturing column view
5075 Since column view is just an overlay over a buffer, it cannot be
5076 exported or printed directly. If you want to capture a column view, use
5077 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5078 of this block looks like this:
5080 @cindex #+BEGIN, columnview
5083 #+BEGIN: columnview :hlines 1 :id "label"
5088 @noindent This dynamic block has the following parameters:
5092 This is the most important parameter. Column view is a feature that is
5093 often localized to a certain (sub)tree, and the capture block might be
5094 at a different location in the file. To identify the tree whose view to
5095 capture, you can use 4 values:
5096 @cindex property, ID
5098 local @r{use the tree in which the capture block is located}
5099 global @r{make a global view, including all headings in the file}
5100 "file:@var{path-to-file}"
5101 @r{run column view at the top of this file}
5102 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5103 @r{property with the value @i{label}. You can use}
5104 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5105 @r{the current entry and copy it to the kill-ring.}
5108 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5109 an hline before each headline with level @code{<= @var{N}}.
5111 When set to @code{t}, force column groups to get vertical lines.
5113 When set to a number, don't capture entries below this level.
5114 @item :skip-empty-rows
5115 When set to @code{t}, skip rows where the only non-empty specifier of the
5116 column view is @code{ITEM}.
5121 The following commands insert or update the dynamic block:
5124 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5125 Insert a dynamic block capturing a column view. You will be prompted
5126 for the scope or ID of the view.
5127 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5128 Update dynamic block at point. The cursor needs to be in the
5129 @code{#+BEGIN} line of the dynamic block.
5130 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5131 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5132 you have several clock table blocks, column-capturing blocks or other dynamic
5136 You can add formulas to the column view table and you may add plotting
5137 instructions in front of the table---these will survive an update of the
5138 block. If there is a @code{#+TBLFM:} after the table, the table will
5139 actually be recalculated automatically after an update.
5141 An alternative way to capture and process property values into a table is
5142 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5143 package@footnote{Contributed packages are not part of Emacs, but are
5144 distributed with the main distribution of Org (visit
5145 @uref{http://orgmode.org}).}. It provides a general API to collect
5146 properties from entries in a certain scope, and arbitrary Lisp expressions to
5147 process these values before inserting them into a table or a dynamic block.
5149 @node Property API, , Column view, Properties and Columns
5150 @section The Property API
5151 @cindex properties, API
5152 @cindex API, for properties
5154 There is a full API for accessing and changing properties. This API can
5155 be used by Emacs Lisp programs to work with properties and to implement
5156 features based on them. For more information see @ref{Using the
5159 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5160 @chapter Dates and times
5166 To assist project planning, TODO items can be labeled with a date and/or
5167 a time. The specially formatted string carrying the date and time
5168 information is called a @emph{timestamp} in Org-mode. This may be a
5169 little confusing because timestamp is often used as indicating when
5170 something was created or last changed. However, in Org-mode this term
5171 is used in a much wider sense.
5174 * Timestamps:: Assigning a time to a tree entry
5175 * Creating timestamps:: Commands which insert timestamps
5176 * Deadlines and scheduling:: Planning your work
5177 * Clocking work time:: Tracking how long you spend on a task
5178 * Effort estimates:: Planning work effort in advance
5179 * Relative timer:: Notes with a running timer
5180 * Countdown timer:: Starting a countdown timer for a task
5184 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5185 @section Timestamps, deadlines, and scheduling
5187 @cindex ranges, time
5192 A timestamp is a specification of a date (possibly with a time or a range of
5193 times) in a special format, either @samp{<2003-09-16 Tue>} or
5194 @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16 Tue
5195 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601 date/time
5196 format. To use an alternative format, see @ref{Custom time format}.}. A
5197 timestamp can appear anywhere in the headline or body of an Org tree entry.
5198 Its presence causes entries to be shown on specific dates in the agenda
5199 (@pxref{Weekly/daily agenda}). We distinguish:
5202 @item Plain timestamp; Event; Appointment
5204 A simple timestamp just assigns a date/time to an item. This is just
5205 like writing down an appointment or event in a paper agenda. In the
5206 timeline and agenda displays, the headline of an entry associated with a
5207 plain timestamp will be shown exactly on that date.
5210 * Meet Peter at the movies <2006-11-01 Wed 19:15>
5211 * Discussion on climate change <2006-11-02 Thu 20:00-22:00>
5214 @item Timestamp with repeater interval
5215 @cindex timestamp, with repeater interval
5216 A timestamp may contain a @emph{repeater interval}, indicating that it
5217 applies not only on the given date, but again and again after a certain
5218 interval of N days (d), weeks (w), months (m), or years (y). The
5219 following will show up in the agenda every Wednesday:
5222 * Pick up Sam at school <2007-05-16 Wed 12:30 +1w>
5225 @item Diary-style sexp entries
5226 For more complex date specifications, Org-mode supports using the
5227 special sexp diary entries implemented in the Emacs calendar/diary
5228 package. For example
5231 * The nerd meeting on every 2nd Thursday of the month
5232 <%%(diary-float t 4 2)>
5235 @item Time/Date range
5238 Two timestamps connected by @samp{--} denote a range. The headline
5239 will be shown on the first and last day of the range, and on any dates
5240 that are displayed and fall in the range. Here is an example:
5243 ** Meeting in Amsterdam
5244 <2004-08-23 Mon>--<2004-08-26 Thu>
5247 @item Inactive timestamp
5248 @cindex timestamp, inactive
5249 @cindex inactive timestamp
5250 Just like a plain timestamp, but with square brackets instead of
5251 angular ones. These timestamps are inactive in the sense that they do
5252 @emph{not} trigger an entry to show up in the agenda.
5255 * Gillian comes late for the fifth time [2006-11-01 Wed]
5260 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5261 @section Creating timestamps
5262 @cindex creating timestamps
5263 @cindex timestamps, creating
5265 For Org-mode to recognize timestamps, they need to be in the specific
5266 format. All commands listed below produce timestamps in the correct
5270 @orgcmd{C-c .,org-time-stamp}
5271 Prompt for a date and insert a corresponding timestamp. When the cursor is
5272 at an existing timestamp in the buffer, the command is used to modify this
5273 timestamp instead of inserting a new one. When this command is used twice in
5274 succession, a time range is inserted.
5276 @orgcmd{C-c !,org-time-stamp-inactive}
5277 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5284 @vindex org-time-stamp-rounding-minutes
5285 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5286 contains date and time. The default time can be rounded to multiples of 5
5287 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5289 @orgcmd{C-c <,org-date-from-calendar}
5290 Insert a timestamp corresponding to the cursor date in the Calendar.
5292 @orgcmd{C-c >,org-goto-calendar}
5293 Access the Emacs calendar for the current date. If there is a
5294 timestamp in the current line, go to the corresponding date
5297 @orgcmd{C-c C-o,org-open-at-point}
5298 Access the agenda for the date given by the timestamp or -range at
5299 point (@pxref{Weekly/daily agenda}).
5301 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5302 Change date at cursor by one day. These key bindings conflict with
5303 shift-selection and related modes (@pxref{Conflicts}).
5305 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5306 Change the item under the cursor in a timestamp. The cursor can be on a
5307 year, month, day, hour or minute. When the timestamp contains a time range
5308 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5309 shifting the time block with constant length. To change the length, modify
5310 the second time. Note that if the cursor is in a headline and not at a
5311 timestamp, these same keys modify the priority of an item.
5312 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5313 related modes (@pxref{Conflicts}).
5315 @orgcmd{C-c C-y,org-evaluate-time-range}
5316 @cindex evaluate time range
5317 Evaluate a time range by computing the difference between start and end.
5318 With a prefix argument, insert result after the time range (in a table: into
5319 the following column).
5324 * The date/time prompt:: How Org-mode helps you entering date and time
5325 * Custom time format:: Making dates look different
5328 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5329 @subsection The date/time prompt
5330 @cindex date, reading in minibuffer
5331 @cindex time, reading in minibuffer
5333 @vindex org-read-date-prefer-future
5334 When Org-mode prompts for a date/time, the default is shown in default
5335 date/time format, and the prompt therefore seems to ask for a specific
5336 format. But it will in fact accept any string containing some date and/or
5337 time information, and it is really smart about interpreting your input. You
5338 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5339 copied from an email message. Org-mode will find whatever information is in
5340 there and derive anything you have not specified from the @emph{default date
5341 and time}. The default is usually the current date and time, but when
5342 modifying an existing timestamp, or when entering the second stamp of a
5343 range, it is taken from the stamp in the buffer. When filling in
5344 information, Org-mode assumes that most of the time you will want to enter a
5345 date in the future: if you omit the month/year and the given day/month is
5346 @i{before} today, it will assume that you mean a future date@footnote{See the
5347 variable @code{org-read-date-prefer-future}. You may set that variable to
5348 the symbol @code{time} to even make a time before now shift the date to
5349 tomorrow.}. If the date has been automatically shifted into the future, the
5350 time prompt will show this with @samp{(=>F).}
5352 For example, let's assume that today is @b{June 13, 2006}. Here is how
5353 various inputs will be interpreted, the items filled in by Org-mode are
5357 3-2-5 @result{} 2003-02-05
5358 2/5/3 @result{} 2003-02-05
5359 14 @result{} @b{2006}-@b{06}-14
5360 12 @result{} @b{2006}-@b{07}-12
5361 2/5 @result{} @b{2007}-02-05
5362 Fri @result{} nearest Friday (default date or later)
5363 sep 15 @result{} @b{2006}-09-15
5364 feb 15 @result{} @b{2007}-02-15
5365 sep 12 9 @result{} 2009-09-12
5366 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5367 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5368 w4 @result{} ISO week for of the current year @b{2006}
5369 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5370 2012-w04-5 @result{} Same as above
5373 Furthermore you can specify a relative date by giving, as the
5374 @emph{first} thing in the input: a plus/minus sign, a number and a
5375 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5376 single plus or minus, the date is always relative to today. With a
5377 double plus or minus, it is relative to the default date. If instead of
5378 a single letter, you use the abbreviation of day name, the date will be
5379 the Nth such day. e.g.@:
5384 +4d @result{} four days from today
5385 +4 @result{} same as above
5386 +2w @result{} two weeks from today
5387 ++5 @result{} five days from default date
5388 +2tue @result{} second Tuesday from now.
5391 @vindex parse-time-months
5392 @vindex parse-time-weekdays
5393 The function understands English month and weekday abbreviations. If
5394 you want to use unabbreviated names and/or other languages, configure
5395 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5397 You can specify a time range by giving start and end times or by giving a
5398 start time and a duration (in HH:MM format). Use `-' or `-@{@}-' as the separator
5399 in the former case and use '+' as the separator in the latter case. E.g.@:
5402 11am-1:15pm @result{} 11:00-13:15
5403 11am--1:15pm @result{} same as above
5404 11am+2:15 @result{} same as above
5407 @cindex calendar, for selecting date
5408 @vindex org-popup-calendar-for-date-prompt
5409 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5410 you don't need/want the calendar, configure the variable
5411 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5412 prompt, either by clicking on a date in the calendar, or by pressing
5413 @key{RET}, the date selected in the calendar will be combined with the
5414 information entered at the prompt. You can control the calendar fully
5415 from the minibuffer:
5422 @kindex S-@key{right}
5423 @kindex S-@key{left}
5424 @kindex S-@key{down}
5426 @kindex M-S-@key{right}
5427 @kindex M-S-@key{left}
5430 @key{RET} @r{Choose date at cursor in calendar.}
5431 mouse-1 @r{Select date by clicking on it.}
5432 S-@key{right}/@key{left} @r{One day forward/backward.}
5433 S-@key{down}/@key{up} @r{One week forward/backward.}
5434 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5435 > / < @r{Scroll calendar forward/backward by one month.}
5436 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5439 @vindex org-read-date-display-live
5440 The actions of the date/time prompt may seem complex, but I assure you they
5441 will grow on you, and you will start getting annoyed by pretty much any other
5442 way of entering a date/time out there. To help you understand what is going
5443 on, the current interpretation of your input will be displayed live in the
5444 minibuffer@footnote{If you find this distracting, turn the display of with
5445 @code{org-read-date-display-live}.}.
5447 @node Custom time format, , The date/time prompt, Creating timestamps
5448 @subsection Custom time format
5449 @cindex custom date/time format
5450 @cindex time format, custom
5451 @cindex date format, custom
5453 @vindex org-display-custom-times
5454 @vindex org-time-stamp-custom-formats
5455 Org-mode uses the standard ISO notation for dates and times as it is
5456 defined in ISO 8601. If you cannot get used to this and require another
5457 representation of date and time to keep you happy, you can get it by
5458 customizing the variables @code{org-display-custom-times} and
5459 @code{org-time-stamp-custom-formats}.
5462 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5463 Toggle the display of custom formats for dates and times.
5467 Org-mode needs the default format for scanning, so the custom date/time
5468 format does not @emph{replace} the default format---instead it is put
5469 @emph{over} the default format using text properties. This has the
5470 following consequences:
5473 You cannot place the cursor onto a timestamp anymore, only before or
5476 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5477 each component of a timestamp. If the cursor is at the beginning of
5478 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5479 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5480 time will be changed by one minute.
5482 If the timestamp contains a range of clock times or a repeater, these
5483 will not be overlaid, but remain in the buffer as they were.
5485 When you delete a timestamp character-by-character, it will only
5486 disappear from the buffer after @emph{all} (invisible) characters
5487 belonging to the ISO timestamp have been removed.
5489 If the custom timestamp format is longer than the default and you are
5490 using dates in tables, table alignment will be messed up. If the custom
5491 format is shorter, things do work as expected.
5495 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5496 @section Deadlines and scheduling
5498 A timestamp may be preceded by special keywords to facilitate planning:
5502 @cindex DEADLINE keyword
5504 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5505 to be finished on that date.
5507 @vindex org-deadline-warning-days
5508 On the deadline date, the task will be listed in the agenda. In
5509 addition, the agenda for @emph{today} will carry a warning about the
5510 approaching or missed deadline, starting
5511 @code{org-deadline-warning-days} before the due date, and continuing
5512 until the entry is marked DONE. An example:
5515 *** TODO write article about the Earth for the Guide
5516 The editor in charge is [[bbdb:Ford Prefect]]
5517 DEADLINE: <2004-02-29 Sun>
5520 You can specify a different lead time for warnings for a specific
5521 deadlines using the following syntax. Here is an example with a warning
5522 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5525 @cindex SCHEDULED keyword
5527 Meaning: you are planning to start working on that task on the given
5530 @vindex org-agenda-skip-scheduled-if-done
5531 The headline will be listed under the given date@footnote{It will still
5532 be listed on that date after it has been marked DONE. If you don't like
5533 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5534 addition, a reminder that the scheduled date has passed will be present
5535 in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
5536 the task will automatically be forwarded until completed.
5539 *** TODO Call Trillian for a date on New Years Eve.
5540 SCHEDULED: <2004-12-25 Sat>
5544 @b{Important:} Scheduling an item in Org-mode should @i{not} be
5545 understood in the same way that we understand @i{scheduling a meeting}.
5546 Setting a date for a meeting is just a simple appointment, you should
5547 mark this entry with a simple plain timestamp, to get this item shown
5548 on the date where it applies. This is a frequent misunderstanding by
5549 Org users. In Org-mode, @i{scheduling} means setting a date when you
5550 want to start working on an action item.
5553 You may use timestamps with repeaters in scheduling and deadline
5554 entries. Org-mode will issue early and late warnings based on the
5555 assumption that the timestamp represents the @i{nearest instance} of
5556 the repeater. However, the use of diary sexp entries like
5558 @code{<%%(diary-float t 42)>}
5560 in scheduling and deadline timestamps is limited. Org-mode does not
5561 know enough about the internals of each sexp function to issue early and
5562 late warnings. However, it will show the item on each day where the
5566 * Inserting deadline/schedule:: Planning items
5567 * Repeated tasks:: Items that show up again and again
5570 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5571 @subsection Inserting deadlines or schedules
5573 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
5574 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
5575 any text between this line and the headline.} a deadline or to schedule
5580 @orgcmd{C-c C-d,org-deadline}
5581 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5582 in the line directly following the headline. When called with a prefix arg,
5583 an existing deadline will be removed from the entry. Depending on the
5584 variable @code{org-log-redeadline}@footnote{with corresponding
5585 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5586 and @code{nologredeadline}}, a note will be taken when changing an existing
5588 @c FIXME Any CLOSED timestamp will be removed.????????
5590 @orgcmd{C-c C-s,org-schedule}
5591 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5592 happen in the line directly following the headline. Any CLOSED timestamp
5593 will be removed. When called with a prefix argument, remove the scheduling
5594 date from the entry. Depending on the variable
5595 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5596 keywords @code{logreschedule}, @code{lognotereschedule}, and
5597 @code{nologreschedule}}, a note will be taken when changing an existing
5600 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5603 Mark the current entry for agenda action. After you have marked the entry
5604 like this, you can open the agenda or the calendar to find an appropriate
5605 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5606 schedule the marked item.
5608 @orgcmd{C-c / d,org-check-deadlines}
5609 @cindex sparse tree, for deadlines
5610 @vindex org-deadline-warning-days
5611 Create a sparse tree with all deadlines that are either past-due, or
5612 which will become due within @code{org-deadline-warning-days}.
5613 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5614 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5615 all deadlines due tomorrow.
5617 @orgcmd{C-c / b,org-check-before-date}
5618 Sparse tree for deadlines and scheduled items before a given date.
5620 @orgcmd{C-c / a,org-check-after-date}
5621 Sparse tree for deadlines and scheduled items after a given date.
5624 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5625 @subsection Repeated tasks
5626 @cindex tasks, repeated
5627 @cindex repeated tasks
5629 Some tasks need to be repeated again and again. Org-mode helps to
5630 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5631 or plain timestamp. In the following example
5633 ** TODO Pay the rent
5634 DEADLINE: <2005-10-01 Sat +1m>
5637 the @code{+1m} is a repeater; the intended interpretation is that the task
5638 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5639 from that time. If you need both a repeater and a special warning period in
5640 a deadline entry, the repeater should come first and the warning period last:
5641 @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5643 @vindex org-todo-repeat-to-state
5644 Deadlines and scheduled items produce entries in the agenda when they are
5645 over-due, so it is important to be able to mark such an entry as completed
5646 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5647 keyword DONE, it will no longer produce entries in the agenda. The problem
5648 with this is, however, that then also the @emph{next} instance of the
5649 repeated entry will not be active. Org-mode deals with this in the following
5650 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5651 shift the base date of the repeating timestamp by the repeater interval, and
5652 immediately set the entry state back to TODO@footnote{In fact, the target
5653 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5654 the variable @code{org-todo-repeat-to-state}. If neither of these is
5655 specified, the target state defaults to the first state of the TODO state
5656 sequence.}. In the example above, setting the state to DONE would actually
5657 switch the date like this:
5660 ** TODO Pay the rent
5661 DEADLINE: <2005-11-01 Tue +1m>
5664 @vindex org-log-repeat
5665 A timestamp@footnote{You can change this using the option
5666 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5667 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5668 will also be prompted for a note.} will be added under the deadline, to keep
5669 a record that you actually acted on the previous instance of this deadline.
5671 As a consequence of shifting the base date, this entry will no longer be
5672 visible in the agenda when checking past dates, but all future instances
5675 With the @samp{+1m} cookie, the date shift will always be exactly one
5676 month. So if you have not paid the rent for three months, marking this
5677 entry DONE will still keep it as an overdue deadline. Depending on the
5678 task, this may not be the best way to handle it. For example, if you
5679 forgot to call your father for 3 weeks, it does not make sense to call
5680 him 3 times in a single day to make up for it. Finally, there are tasks
5681 like changing batteries which should always repeat a certain time
5682 @i{after} the last time you did it. For these tasks, Org-mode has
5683 special repeaters @samp{++} and @samp{.+}. For example:
5687 DEADLINE: <2008-02-10 Sun ++1w>
5688 Marking this DONE will shift the date by at least one week,
5689 but also by as many weeks as it takes to get this date into
5690 the future. However, it stays on a Sunday, even if you called
5691 and marked it done on Saturday.
5692 ** TODO Check the batteries in the smoke detectors
5693 DEADLINE: <2005-11-01 Tue .+1m>
5694 Marking this DONE will shift the date to one month after
5698 You may have both scheduling and deadline information for a specific
5699 task---just make sure that the repeater intervals on both are the same.
5701 An alternative to using a repeater is to create a number of copies of a task
5702 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5703 created for this purpose, it is described in @ref{Structure editing}.
5706 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5707 @section Clocking work time
5708 @cindex clocking time
5709 @cindex time clocking
5711 Org-mode allows you to clock the time you spend on specific tasks in a
5712 project. When you start working on an item, you can start the clock.
5713 When you stop working on that task, or when you mark the task done, the
5714 clock is stopped and the corresponding time interval is recorded. It
5715 also computes the total time spent on each subtree of a project. And it
5716 remembers a history or tasks recently clocked, to that you can jump quickly
5717 between a number of tasks absorbing your time.
5719 To save the clock history across Emacs sessions, use
5721 (setq org-clock-persist 'history)
5722 (org-clock-persistence-insinuate)
5724 When you clock into a new task after resuming Emacs, the incomplete
5725 clock@footnote{To resume the clock under the assumption that you have worked
5726 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
5727 will be found (@pxref{Resolving idle time}) and you will be prompted about
5731 * Clocking commands:: Starting and stopping a clock
5732 * The clock table:: Detailed reports
5733 * Resolving idle time:: Resolving time when you've been idle
5736 @node Clocking commands, The clock table, Clocking work time, Clocking work time
5737 @subsection Clocking commands
5740 @orgcmd{C-c C-x C-i,org-clock-in}
5741 @vindex org-clock-into-drawer
5742 Start the clock on the current item (clock-in). This inserts the CLOCK
5743 keyword together with a timestamp. If this is not the first clocking of
5744 this item, the multiple CLOCK lines will be wrapped into a
5745 @code{:LOGBOOK:} drawer (see also the variable
5746 @code{org-clock-into-drawer}). When called with a @kbd{C-u} prefix argument,
5747 select the task from a list of recently clocked tasks. With two @kbd{C-u
5748 C-u} prefixes, clock into the task at point and mark it as the default task.
5749 The default task will always be available when selecting a clocking task,
5750 with letter @kbd{d}.@*
5751 @cindex property: CLOCK_MODELINE_TOTAL
5752 @cindex property: LAST_REPEAT
5753 @vindex org-clock-modeline-total
5754 While the clock is running, the current clocking time is shown in the mode
5755 line, along with the title of the task. The clock time shown will be all
5756 time ever clocked for this task and its children. If the task has an effort
5757 estimate (@pxref{Effort estimates}), the mode line displays the current
5758 clocking time against it@footnote{To add an effort estimate ``on the fly'',
5759 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
5760 is a repeating one (@pxref{Repeated tasks}), only the time since the last
5761 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
5762 will be shown. More control over what time is shown can be exercised with
5763 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
5764 @code{current} to show only the current clocking instance, @code{today} to
5765 show all time clocked on this tasks today (see also the variable
5766 @code{org-extend-today-until}), @code{all} to include all time, or
5767 @code{auto} which is the default@footnote{See also the variable
5768 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
5769 mode line entry will pop up a menu with clocking options.
5771 @orgcmd{C-c C-x C-o,org-clock-out}
5772 @vindex org-log-note-clock-out
5773 Stop the clock (clock-out). This inserts another timestamp at the same
5774 location where the clock was last started. It also directly computes
5775 the resulting time in inserts it after the time range as @samp{=>
5776 HH:MM}. See the variable @code{org-log-note-clock-out} for the
5777 possibility to record an additional note together with the clock-out
5778 timestamp@footnote{The corresponding in-buffer setting is:
5779 @code{#+STARTUP: lognoteclock-out}}.
5780 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
5781 Update the effort estimate for the current clock task.
5784 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
5785 Recompute the time interval after changing one of the timestamps. This
5786 is only necessary if you edit the timestamps directly. If you change
5787 them with @kbd{S-@key{cursor}} keys, the update is automatic.
5788 @orgcmd{C-c C-t,org-todo}
5789 Changing the TODO state of an item to DONE automatically stops the clock
5790 if it is running in this same item.
5791 @orgcmd{C-c C-x C-x,org-clock-cancel}
5792 Cancel the current clock. This is useful if a clock was started by
5793 mistake, or if you ended up working on something else.
5794 @orgcmd{C-c C-x C-j,org-clock-goto}
5795 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
5796 prefix arg, select the target task from a list of recently clocked tasks.
5797 @orgcmd{C-c C-x C-d,org-clock-display}
5798 @vindex org-remove-highlights-with-change
5799 Display time summaries for each subtree in the current buffer. This
5800 puts overlays at the end of each headline, showing the total time
5801 recorded under that heading, including the time of any subheadings. You
5802 can use visibility cycling to study the tree, but the overlays disappear
5803 when you change the buffer (see variable
5804 @code{org-remove-highlights-with-change}) or press @kbd{C-c C-c}.
5807 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
5808 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
5809 worked on or closed during a day.
5811 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
5812 @subsection The clock table
5813 @cindex clocktable, dynamic block
5814 @cindex report, of clocked time
5816 Org mode can produce quite complex reports based on the time clocking
5817 information. Such a report is called a @emph{clock table}, because it is
5818 formatted as one or several Org tables.
5821 @orgcmd{C-c C-x C-r,org-clock-report}
5822 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
5823 report as an Org-mode table into the current file. When the cursor is
5824 at an existing clock table, just update it. When called with a prefix
5825 argument, jump to the first clock report in the current document and
5827 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5828 Update dynamic block at point. The cursor needs to be in the
5829 @code{#+BEGIN} line of the dynamic block.
5830 @orgkey{C-u C-c C-x C-u}
5831 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5832 you have several clock table blocks in a buffer.
5833 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
5834 Shift the current @code{:block} interval and update the table. The cursor
5835 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
5836 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
5840 Here is an example of the frame for a clock table as it is inserted into the
5841 buffer with the @kbd{C-c C-x C-r} command:
5843 @cindex #+BEGIN, clocktable
5845 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
5849 @vindex org-clocktable-defaults
5850 The @samp{BEGIN} line and specify a number of options to define the scope,
5851 structure, and formatting of the report. Defaults for all these options can
5852 be configured in the variable @code{org-clocktable-defaults}.
5854 @noindent First there are options that determine which clock entries are to
5857 :maxlevel @r{Maximum level depth to which times are listed in the table.}
5858 @r{Clocks at deeper levels will be summed into the upper level.}
5859 :scope @r{The scope to consider. This can be any of the following:}
5860 nil @r{the current buffer or narrowed region}
5861 file @r{the full current buffer}
5862 subtree @r{the subtree where the clocktable is located}
5863 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
5864 tree @r{the surrounding level 1 tree}
5865 agenda @r{all agenda files}
5866 ("file"..) @r{scan these files}
5867 file-with-archives @r{current file and its archives}
5868 agenda-with-archives @r{all agenda files, including archives}
5869 :block @r{The time block to consider. This block is specified either}
5870 @r{absolute, or relative to the current time and may be any of}
5872 2007-12-31 @r{New year eve 2007}
5873 2007-12 @r{December 2007}
5874 2007-W50 @r{ISO-week 50 in 2007}
5875 2007-Q2 @r{2nd quarter in 2007}
5876 2007 @r{the year 2007}
5877 today, yesterday, today-@var{N} @r{a relative day}
5878 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
5879 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
5880 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
5881 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
5882 :tstart @r{A time string specifying when to start considering times.}
5883 :tend @r{A time string specifying when to stop considering times.}
5884 :step @r{@code{week} or @code{day}, to split the table into chunks.}
5885 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
5886 :stepskip0 @r{Do not show steps that have zero time.}
5887 :fileskip0 @r{Do not show table sections from files which did not contribute.}
5888 :tags @r{A tags match to select entries that should contribute}.
5891 Then there are options which determine the formatting of the table. There
5892 options are interpreted by the function @code{org-clocktable-write-default},
5893 but you can specify your own function using the @code{:formatter} parameter.
5895 :emphasize @r{When @code{t}, emphasize level one and level two items.}
5896 :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".}
5897 :link @r{Link the item headlines in the table to their origins.}
5898 :narrow @r{An integer to limit the width of the headline column in}
5899 @r{the org table. If you write it like @samp{50!}, then the}
5900 @r{headline will also be shortened in export.}
5901 :indent @r{Indent each headline field according to its level.}
5902 :tcolumns @r{Number of columns to be used for times. If this is smaller}
5903 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
5904 :level @r{Should a level number column be included?}
5905 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
5906 @r{All are overwritten except if there is an explicit @code{:narrow}}
5907 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
5908 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
5909 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
5910 @r{As a special case, @samp{:formula %} adds a column with % time.}
5911 @r{If you do not specify a formula here, any existing formula}
5912 @r{below the clock table will survive updates and be evaluated.}
5913 :formatter @r{A function to format clock data and insert it into the buffer.}
5915 To get a clock summary of the current level 1 tree, for the current
5916 day, you could write
5918 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
5922 and to use a specific time range you could write@footnote{Note that all
5923 parameters must be specified in a single line---the line is broken here
5924 only to fit it into the manual.}
5926 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
5927 :tend "<2006-08-10 Thu 12:00>"
5930 A summary of the current subtree with % times would be
5932 #+BEGIN: clocktable :scope subtree :link t :formula %
5935 A horizontally compact representation of everything clocked during last week
5938 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
5942 @node Resolving idle time, , The clock table, Clocking work time
5943 @subsection Resolving idle time
5944 @cindex resolve idle time
5946 @cindex idle, resolve, dangling
5947 If you clock in on a work item, and then walk away from your
5948 computer---perhaps to take a phone call---you often need to ``resolve'' the
5949 time you were away by either subtracting it from the current clock, or
5950 applying it to another one.
5952 @vindex org-clock-idle-time
5953 By customizing the variable @code{org-clock-idle-time} to some integer, such
5954 as 10 or 15, Emacs can alert you when you get back to your computer after
5955 being idle for that many minutes@footnote{On computers using Mac OS X,
5956 idleness is based on actual user idleness, not just Emacs' idle time. For
5957 X11, you can install a utility program @file{x11idle.c}, available in the
5958 UTILITIES directory of the Org git distribution, to get the same general
5959 treatment of idleness. On other systems, idle time refers to Emacs idle time
5960 only.}, and ask what you want to do with the idle time. There will be a
5961 question waiting for you when you get back, indicating how much idle time has
5962 passed (constantly updated with the current amount), as well as a set of
5963 choices to correct the discrepancy:
5967 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
5968 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
5969 effectively changing nothing, or enter a number to keep that many minutes.
5971 If you use the shift key and press @kbd{K}, it will keep however many minutes
5972 you request and then immediately clock out of that task. If you keep all of
5973 the minutes, this is the same as just clocking out of the current task.
5975 To keep none of the minutes, use @kbd{s} to subtract all the away time from
5976 the clock, and then check back in from the moment you returned.
5978 To keep none of the minutes and just clock out at the start of the away time,
5979 use the shift key and press @kbd{S}. Remember that using shift will always
5980 leave you clocked out, no matter which option you choose.
5982 To cancel the clock altogether, use @kbd{C}. Note that if instead of
5983 canceling you subtract the away time, and the resulting clock amount is less
5984 than a minute, the clock will still be canceled rather than clutter up the
5985 log with an empty entry.
5988 What if you subtracted those away minutes from the current clock, and now
5989 want to apply them to a new clock? Simply clock in to any task immediately
5990 after the subtraction. Org will notice that you have subtracted time ``on
5991 the books'', so to speak, and will ask if you want to apply those minutes to
5992 the next task you clock in on.
5994 There is one other instance when this clock resolution magic occurs. Say you
5995 were clocked in and hacking away, and suddenly your cat chased a mouse who
5996 scared a hamster that crashed into your UPS's power button! You suddenly
5997 lose all your buffers, but thanks to auto-save you still have your recent Org
5998 mode changes, including your last clock in.
6000 If you restart Emacs and clock into any task, Org will notice that you have a
6001 dangling clock which was never clocked out from your last session. Using
6002 that clock's starting time as the beginning of the unaccounted-for period,
6003 Org will ask how you want to resolve that time. The logic and behavior is
6004 identical to dealing with away time due to idleness; it's just happening due
6005 to a recovery event rather than a set amount of idle time.
6007 You can also check all the files visited by your Org agenda for dangling
6008 clocks at any time using @kbd{M-x org-resolve-clocks}.
6010 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6011 @section Effort estimates
6012 @cindex effort estimates
6014 @cindex property, Effort
6015 @vindex org-effort-property
6016 If you want to plan your work in a very detailed way, or if you need to
6017 produce offers with quotations of the estimated work effort, you may want to
6018 assign effort estimates to entries. If you are also clocking your work, you
6019 may later want to compare the planned effort with the actual working time, a
6020 great way to improve planning estimates. Effort estimates are stored in a
6021 special property @samp{Effort}@footnote{You may change the property being
6022 used with the variable @code{org-effort-property}.}. You can set the effort
6023 for an entry with the following commands:
6026 @orgcmd{C-c C-x e,org-set-effort}
6027 Set the effort estimate for the current entry. With a numeric prefix
6028 argument, set it to the Nth allowed value (see below). This command is also
6029 accessible from the agenda with the @kbd{e} key.
6030 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6031 Modify the effort estimate of the item currently being clocked.
6034 Clearly the best way to work with effort estimates is through column view
6035 (@pxref{Column view}). You should start by setting up discrete values for
6036 effort estimates, and a @code{COLUMNS} format that displays these values
6037 together with clock sums (if you want to clock your time). For a specific
6041 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00
6042 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6046 @vindex org-global-properties
6047 @vindex org-columns-default-format
6048 or, even better, you can set up these values globally by customizing the
6049 variables @code{org-global-properties} and @code{org-columns-default-format}.
6050 In particular if you want to use this setup also in the agenda, a global
6051 setup may be advised.
6053 The way to assign estimates to individual items is then to switch to column
6054 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6055 value. The values you enter will immediately be summed up in the hierarchy.
6056 In the column next to it, any clocked time will be displayed.
6058 @vindex org-agenda-columns-add-appointments-to-effort-sum
6059 If you switch to column view in the daily/weekly agenda, the effort column
6060 will summarize the estimated work effort for each day@footnote{Please note
6061 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6062 column view}).}, and you can use this to find space in your schedule. To get
6063 an overview of the entire part of the day that is committed, you can set the
6064 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6065 appointments on a day that take place over a specified time interval will
6066 then also be added to the load estimate of the day.
6068 Effort estimates can be used in secondary agenda filtering that is triggered
6069 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6070 these estimates defined consistently, two or three key presses will narrow
6071 down the list to stuff that fits into an available time slot.
6073 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6074 @section Taking notes with a relative timer
6075 @cindex relative timer
6077 When taking notes during, for example, a meeting or a video viewing, it can
6078 be useful to have access to times relative to a starting time. Org provides
6079 such a relative timer and make it easy to create timed notes.
6082 @orgcmd{C-c C-x .,org-timer}
6083 Insert a relative time into the buffer. The first time you use this, the
6084 timer will be started. When called with a prefix argument, the timer is
6086 @orgcmd{C-c C-x -,org-timer-item}
6087 Insert a description list item with the current relative time. With a prefix
6088 argument, first reset the timer to 0.
6089 @orgcmd{M-@key{RET},org-insert-heading}
6090 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6092 @c for key sequences with a comma, command name macros fail :(
6095 Pause the timer, or continue it if it is already paused
6096 (@command{org-timer-pause-or-continue}).
6097 @c removed the sentence because it is redundant to the following item
6098 @kindex C-u C-c C-x ,
6100 Stop the timer. After this, you can only start a new timer, not continue the
6101 old one. This command also removes the timer from the mode line.
6102 @orgcmd{C-c C-x 0,org-timer-start}
6103 Reset the timer without inserting anything into the buffer. By default, the
6104 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6105 specific starting offset. The user is prompted for the offset, with a
6106 default taken from a timer string at point, if any, So this can be used to
6107 restart taking notes after a break in the process. When called with a double
6108 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6109 by a certain amount. This can be used to fix timer strings if the timer was
6110 not started at exactly the right moment.
6113 @node Countdown timer, , Relative timer, Dates and Times
6114 @section Countdown timer
6115 @cindex Countdown timer
6119 Calling @code{org-timer-set-timer} from an Org-mode buffer runs a countdown
6120 timer. Use @key{;} from agenda buffers, @key{C-c C-x ;} everwhere else.
6122 @code{org-timer-set-timer} prompts the user for a duration and displays a
6123 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6124 default countdown value. Giving a prefix numeric argument overrides this
6127 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6128 @chapter Capture - Refile - Archive
6131 An important part of any organization system is the ability to quickly
6132 capture new ideas and tasks, and to associate reference material with them.
6133 Org does this using a process called @i{capture}. It also can store files
6134 related to a task (@i{attachments}) in a special directory. Once in the
6135 system, tasks and projects need to be moved around. Moving completed project
6136 trees to an archive file keeps the system compact and fast.
6139 * Capture:: Capturing new stuff
6140 * Attachments:: Add files to tasks
6141 * RSS Feeds:: Getting input from RSS feeds
6142 * Protocols:: External (e.g.@: Browser) access to Emacs and Org
6143 * Refiling notes:: Moving a tree from one place to another
6144 * Archiving:: What to do with finished projects
6147 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6151 Org's method for capturing new items is heavily inspired by John Wiegley
6152 excellent remember package. Up to version 6.36 Org used a special setup
6153 for @file{remember.el}. @file{org-remember.el} is still part of Org-mode for
6154 backward compatibility with existing setups. You can find the documentation
6155 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6157 The new capturing setup described here is preferred and should be used by new
6158 users. To convert your @code{org-remember-templates}, run the command
6160 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6162 @noindent and then customize the new variable with @kbd{M-x
6163 customize-variable org-capture-templates}, check the result, and save the
6164 customization. You can then use both remember and capture until
6165 you are familiar with the new mechanism.
6167 Capture lets you quickly store notes with little interruption of your work
6168 flow. The basic process of capturing is very similar to remember, but Org
6169 does enhance it with templates and more.
6172 * Setting up capture:: Where notes will be stored
6173 * Using capture:: Commands to invoke and terminate capture
6174 * Capture templates:: Define the outline of different note types
6177 @node Setting up capture, Using capture, Capture, Capture
6178 @subsection Setting up capture
6180 The following customization sets a default target file for notes, and defines
6181 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6182 suggestion.} for capturing new material.
6184 @vindex org-default-notes-file
6186 (setq org-default-notes-file (concat org-directory "/notes.org"))
6187 (define-key global-map "\C-cc" 'org-capture)
6190 @node Using capture, Capture templates, Setting up capture, Capture
6191 @subsection Using capture
6194 @orgcmd{C-c c,org-capture}
6195 Call the command @code{org-capture}. Note that this keybinding is global and
6196 not active by default - you need to install it. If you have templates
6198 defined @pxref{Capture templates}, it will offer these templates for
6199 selection or use a new Org outline node as the default template. It will
6200 insert the template into the target file and switch to an indirect buffer
6201 narrowed to this new node. You may then insert the information you want.
6203 @orgcmd{C-c C-c,org-capture-finalize}
6204 Once you have finished entering information into the capture buffer, @kbd{C-c
6205 C-c} will return you to the window configuration before the capture process,
6206 so that you can resume your work without further distraction. When called
6207 with a prefix arg, finalize and then jump to the captured item.
6209 @orgcmd{C-c C-w,org-capture-refile}
6210 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6211 a different place. Please realize that this is a normal refiling command
6212 that will be executed---so the cursor position at the moment you run this
6213 command is important. If you have inserted a tree with a parent and
6214 children, first move the cursor back to the parent. Any prefix argument
6215 given to this command will be passed on to the @code{org-refile} command.
6217 @orgcmd{C-c C-k,org-capture-kill}
6218 Abort the capture process and return to the previous state.
6222 You can also call @code{org-capture} in a special way from the agenda, using
6223 the @kbd{k c} key combination. With this access, any timestamps inserted by
6224 the selected capture template will default to the cursor date in the agenda,
6225 rather than to the current date.
6227 To find the locations of the last stored capture, use @code{org-capture} with
6232 Visit the target location of a cpature template. You get to select the
6233 template in the usual way.
6234 @orgkey{C-u C-u C-c c}
6235 Visit the last stored capture item in its buffer.
6238 @node Capture templates, , Using capture, Capture
6239 @subsection Capture templates
6240 @cindex templates, for Capture
6242 You can use templates for different types of capture items, and
6243 for different target locations. The easiest way to create such templates is
6244 through the customize interface.
6248 Customize the variable @code{org-capture-templates}.
6251 Before we give the formal description of template definitions, let's look at
6252 an example. Say you would like to use one template to create general TODO
6253 entries, and you want to put these entries under the heading @samp{Tasks} in
6254 your file @file{~/org/gtd.org}. Also, a date tree in the file
6255 @file{journal.org} should capture journal entries. A possible configuration
6259 (setq org-capture-templates
6260 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6261 "* TODO %?\n %i\n %a")
6262 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6263 "* %?\nEntered on %U\n %i\n %a")))
6266 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6270 [[file:@var{link to where you initiated capture}]]
6274 During expansion of the template, @code{%a} has been replaced by a link to
6275 the location from where you called the capture command. This can be
6276 extremely useful for deriving tasks from emails, for example. You fill in
6277 the task definition, press @code{C-c C-c} and Org returns you to the same
6278 place where you started the capture process.
6280 To define special keys to capture to a particular template without going
6281 through the interactive template selection, you can create your key binding
6285 (define-key global-map "\C-cx"
6286 (lambda () (interactive) (org-capture nil "x")))
6290 * Template elements:: What is needed for a complete template entry
6291 * Template expansion:: Filling in information about time and context
6294 @node Template elements, Template expansion, Capture templates, Capture templates
6295 @subsubsection Template elements
6297 Now lets look at the elements of a template definition. Each entry in
6298 @code{org-capture-templates} is a list with the following items:
6302 The keys that will select the template, as a string, characters
6303 only, for example @code{"a"} for a template to be selected with a
6304 single key, or @code{"bt"} for selection with two keys. When using
6305 several keys, keys using the same prefix key must be sequential
6306 in the list and preceded by a 2-element entry explaining the
6307 prefix key, for example
6309 ("b" "Templates for marking stuff to buy")
6311 @noindent If you do not define a template for the @kbd{C} key, this key will
6312 be used to open the customize buffer for this complex variable.
6315 A short string describing the template, which will be shown during
6319 The type of entry, a symbol. Valid values are:
6322 An Org-mode node, with a headline. Will be filed as the child of the
6323 target entry or as a top-level entry. The target file should be an Org-mode
6326 A plain list item, placed in the first plain list at the target
6327 location. Again the target file should be an Org file.
6329 A checkbox item. This only differs from the plain list item by the
6332 a new line in the first table at the target location. Where exactly the
6333 line will be inserted depends on the properties @code{:prepend} and
6334 @code{:table-line-pos} (see below).
6336 Text to be inserted as it is.
6340 @vindex org-default-notes-file
6341 Specification of where the captured item should be placed. In Org-mode
6342 files, targets usually define a node. Entries will become children of this
6343 node. Other types will be added to the table or list in the body of this
6344 node. Most target specifications contain a file name. If that file name is
6345 the empty string, it defaults to @code{org-default-notes-file}. A file can
6346 also be given as a variable, function, or Emacs Lisp form.
6350 @item (file "path/to/file")
6351 Text will be placed at the beginning or end of that file.
6353 @item (id "id of existing org entry")
6354 Filing as child of this entry, or in the body of the entry.
6356 @item (file+headline "path/to/file" "node headline")
6357 Fast configuration if the target heading is unique in the file.
6359 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6360 For non-unique headings, the full path is safer.
6362 @item (file+regexp "path/to/file" "regexp to find location")
6363 Use a regular expression to position the cursor.
6365 @item (file+datetree "path/to/file")
6366 Will create a heading in a date tree for today's date.
6368 @item (file+datetree+prompt "path/to/file")
6369 Will create a heading in a date tree, but will prompt for the date.
6371 @item (file+function "path/to/file" function-finding-location)
6372 A function to find the right location in the file.
6375 File to the entry that is currently being clocked.
6377 @item (function function-finding-location)
6378 Most general way, write your own function to find both
6383 The template for creating the capture item. If you leave this empty, an
6384 appropriate default template will be used. Otherwise this is a string with
6385 escape codes, which will be replaced depending on time and context of the
6386 capture call. The string with escapes may be loaded from a template file,
6387 using the special syntax @code{(file "path/to/template")}. See below for
6391 The rest of the entry is a property list of additional options.
6392 Recognized properties are:
6395 Normally new captured information will be appended at
6396 the target location (last child, last table line, last list item...).
6397 Setting this property will change that.
6399 @item :immediate-finish
6400 When set, do not offer to edit the information, just
6401 file it away immediately. This makes sense if the template only needs
6402 information that can be added automatically.
6405 Set this to the number of lines to insert
6406 before and after the new item. Default 0, only common other value is 1.
6409 Start the clock in this item.
6412 Keep the clock running when filing the captured entry.
6415 If starting the capture interrupted a clock, restart that clock when finished
6416 with the capture. Note that @code{:clock-keep} has precedence over
6417 @code{:clock-resume}. When setting both to @code{t}, the current clock will
6418 run and the previous one will not be resumed.
6421 Do not narrow the target buffer, simply show the full buffer. Default is to
6422 narrow it so that you only see the new material.
6425 If the target file was not yet visited when capture was invoked, kill the
6426 buffer again after capture is completed.
6430 @node Template expansion, , Template elements, Capture templates
6431 @subsubsection Template expansion
6433 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6434 these sequences literally, escape the @kbd{%} with a backslash.} allow
6435 dynamic insertion of content:
6437 @comment SJE: should these sentences terminate in period?
6439 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6440 @r{You may specify a default value and a completion table with}
6441 @r{%^@{prompt|default|completion2|completion3...@}}
6442 @r{The arrow keys access a prompt-specific history.}
6443 %a @r{annotation, normally the link created with @code{org-store-link}}
6444 %A @r{like @code{%a}, but prompt for the description part}
6445 %i @r{initial content, the region when capture is called while the}
6446 @r{region is active.}
6447 @r{The entire text will be indented like @code{%i} itself.}
6448 %t @r{timestamp, date only}
6449 %T @r{timestamp with date and time}
6450 %u, %U @r{like the above, but inactive timestamps}
6451 %^t @r{like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}}
6452 @r{You may define a prompt like @code{%^@{Birthday@}t}}
6453 %n @r{user name (taken from @code{user-full-name})}
6454 %c @r{Current kill ring head.}
6455 %x @r{Content of the X clipboard.}
6456 %^C @r{Interactive selection of which kill or clip to use.}
6457 %^L @r{Like @code{%^C}, but insert as link.}
6458 %k @r{title of the currently clocked task}
6459 %K @r{link to the currently clocked task}
6460 %f @r{file visited by current buffer when org-capture was called}
6461 %F @r{like @code{%f}, but include full path}
6462 %^g @r{prompt for tags, with completion on tags in target file.}
6463 %^G @r{prompt for tags, with completion all tags in all agenda files.}
6464 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}}
6465 %:keyword @r{specific information for certain link types, see below}
6466 %[@var{file}] @r{insert the contents of the file given by @var{file}}
6467 %(@var{sexp}) @r{evaluate Elisp @var{sexp} and replace with the result}
6471 For specific link types, the following keywords will be
6472 defined@footnote{If you define your own link types (@pxref{Adding
6473 hyperlink types}), any property you store with
6474 @code{org-store-link-props} can be accessed in capture templates in a
6477 @vindex org-from-is-user-regexp
6479 Link type | Available keywords
6480 -------------------+----------------------------------------------
6481 bbdb | %:name %:company
6482 irc | %:server %:port %:nick
6483 vm, wl, mh, mew, rmail | %:type %:subject %:message-id
6484 | %:from %:fromname %:fromaddress
6485 | %:to %:toname %:toaddress
6486 | %:date @r{(message date header field)}
6487 | %:date-timestamp @r{(date as active timestamp)}
6488 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6489 | %: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}.}}
6490 gnus | %:group, @r{for messages also all email fields}
6492 info | %:file %:node
6497 To place the cursor after template expansion use:
6500 %? @r{After completing the template, position cursor here.}
6504 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6505 @section Attachments
6508 @vindex org-attach-directory
6509 It is often useful to associate reference material with an outline node/task.
6510 Small chunks of plain text can simply be stored in the subtree of a project.
6511 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6512 files that live elsewhere on your computer or in the cloud, like emails or
6513 source code files belonging to a project. Another method is @i{attachments},
6514 which are files located in a directory belonging to an outline node. Org
6515 uses directories named by the unique ID of each entry. These directories are
6516 located in the @file{data} directory which lives in the same directory where
6517 your Org file lives@footnote{If you move entries or Org files from one
6518 directory to another, you may want to configure @code{org-attach-directory}
6519 to contain an absolute path.}. If you initialize this directory with
6520 @code{git init}, Org will automatically commit changes when it sees them.
6521 The attachment system has been contributed to Org by John Wiegley.
6523 In cases where it seems better to do so, you can also attach a directory of your
6524 choice to an entry. You can also make children inherit the attachment
6525 directory from a parent, so that an entire subtree uses the same attached
6528 @noindent The following commands deal with attachments:
6532 @orgcmd{C-c C-a,org-attach}
6533 The dispatcher for commands related to the attachment system. After these
6534 keys, a list of commands is displayed and you must press an additional key
6535 to select a command:
6538 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6539 @vindex org-attach-method
6540 Select a file and move it into the task's attachment directory. The file
6541 will be copied, moved, or linked, depending on @code{org-attach-method}.
6542 Note that hard links are not supported on all systems.
6548 Attach a file using the copy/move/link method.
6549 Note that hard links are not supported on all systems.
6551 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6552 Create a new attachment as an Emacs buffer.
6554 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6555 Synchronize the current task with its attachment directory, in case you added
6556 attachments yourself.
6558 @orgcmdtkc{o,C-c C-a o,org-attach-open}
6559 @vindex org-file-apps
6560 Open current task's attachment. If there is more than one, prompt for a
6561 file name first. Opening will follow the rules set by @code{org-file-apps}.
6562 For more details, see the information on following hyperlinks
6563 (@pxref{Handling links}).
6565 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6566 Also open the attachment, but force opening the file in Emacs.
6568 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6569 Open the current task's attachment directory.
6571 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6572 Also open the directory, but force using @command{dired} in Emacs.
6574 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6575 Select and delete a single attachment.
6577 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6578 Delete all of a task's attachments. A safer way is to open the directory in
6579 @command{dired} and delete from there.
6581 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6582 @cindex property, ATTACH_DIR
6583 Set a specific directory as the entry's attachment directory. This works by
6584 putting the directory path into the @code{ATTACH_DIR} property.
6586 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6587 @cindex property, ATTACH_DIR_INHERIT
6588 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6589 same directory for attachments as the parent does.
6593 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6598 Org can add and change entries based on information found in RSS feeds and
6599 Atom feeds. You could use this to make a task out of each new podcast in a
6600 podcast feed. Or you could use a phone-based note-creating service on the
6601 web to import tasks into Org. To access feeds, configure the variable
6602 @code{org-feed-alist}. The docstring of this variable has detailed
6603 information. Here is just an example:
6606 (setq org-feed-alist
6608 "http://rss.slashdot.org/Slashdot/slashdot"
6609 "~/txt/org/feeds.org" "Slashdot Entries")))
6613 will configure that new items from the feed provided by
6614 @code{rss.slashdot.org} will result in new entries in the file
6615 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6616 the following command is used:
6619 @orgcmd{C-c C-x g,org-feed-update-all}
6621 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6623 @orgcmd{C-c C-x G,org-feed-goto-inbox}
6624 Prompt for a feed name and go to the inbox configured for this feed.
6627 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
6628 it will store information about the status of items in the feed, to avoid
6629 adding the same item several times. You should add @samp{FEEDSTATUS} to the
6630 list of drawers in that file:
6633 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
6636 For more information, including how to read atom feeds, see
6637 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
6639 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
6640 @section Protocols for external access
6641 @cindex protocols, for external access
6644 You can set up Org for handling protocol calls from outside applications that
6645 are passed to Emacs through the @file{emacsserver}. For example, you can
6646 configure bookmarks in your web browser to send a link to the current page to
6647 Org and create a note from it using capture (@pxref{Capture}). Or you
6648 could create a bookmark that will tell Emacs to open the local source file of
6649 a remote website you are looking at with the browser. See
6650 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
6651 documentation and setup instructions.
6653 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
6654 @section Refiling notes
6655 @cindex refiling notes
6657 When reviewing the captured data, you may want to refile some of the entries
6658 into a different list, for example into a project. Cutting, finding the
6659 right location, and then pasting the note is cumbersome. To simplify this
6660 process, you can use the following special command:
6663 @orgcmd{C-c C-w,org-refile}
6664 @vindex org-reverse-note-order
6665 @vindex org-refile-targets
6666 @vindex org-refile-use-outline-path
6667 @vindex org-outline-path-complete-in-steps
6668 @vindex org-refile-allow-creating-parent-nodes
6669 @vindex org-log-refile
6670 @vindex org-refile-use-cache
6671 Refile the entry or region at point. This command offers possible locations
6672 for refiling the entry and lets you select one with completion. The item (or
6673 all items in the region) is filed below the target heading as a subitem.
6674 Depending on @code{org-reverse-note-order}, it will be either the first or
6676 By default, all level 1 headlines in the current buffer are considered to be
6677 targets, but you can have more complex definitions across a number of files.
6678 See the variable @code{org-refile-targets} for details. If you would like to
6679 select a location via a file-path-like completion along the outline path, see
6680 the variables @code{org-refile-use-outline-path} and
6681 @code{org-outline-path-complete-in-steps}. If you would like to be able to
6682 create new nodes as new parents for refiling on the fly, check the
6683 variable @code{org-refile-allow-creating-parent-nodes}.
6684 When the variable @code{org-log-refile}@footnote{with corresponding
6685 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
6686 and @code{nologrefile}} is set, a timestamp or a note will be
6687 recorded when an entry has been refiled.
6688 @orgkey{C-u C-c C-w}
6689 Use the refile interface to jump to a heading.
6690 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
6691 Jump to the location where @code{org-refile} last moved a tree to.
6693 Refile as the child of the item currently being clocked.
6694 @item C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w
6696 @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}
6698 Clear the target cache. Caching of refile targets can be turned on by
6699 setting @code{org-refile-use-cache}. To make the command see new possible
6700 targets, you have to clear the cache with this command.
6703 @node Archiving, , Refiling notes, Capture - Refile - Archive
6707 When a project represented by a (sub)tree is finished, you may want
6708 to move the tree out of the way and to stop it from contributing to the
6709 agenda. Archiving is important to keep your working files compact and global
6710 searches like the construction of agenda views fast.
6713 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
6714 @vindex org-archive-default-command
6715 Archive the current entry using the command specified in the variable
6716 @code{org-archive-default-command}.
6720 * Moving subtrees:: Moving a tree to an archive file
6721 * Internal archiving:: Switch off a tree but keep it in the file
6724 @node Moving subtrees, Internal archiving, Archiving, Archiving
6725 @subsection Moving a tree to the archive file
6726 @cindex external archiving
6728 The most common archiving action is to move a project tree to another file,
6732 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
6733 @vindex org-archive-location
6734 Archive the subtree starting at the cursor position to the location
6735 given by @code{org-archive-location}.
6736 @orgkey{C-u C-c C-x C-s}
6737 Check if any direct children of the current headline could be moved to
6738 the archive. To do this, each subtree is checked for open TODO entries.
6739 If none are found, the command offers to move it to the archive
6740 location. If the cursor is @emph{not} on a headline when this command
6741 is invoked, the level 1 trees will be checked.
6744 @cindex archive locations
6745 The default archive location is a file in the same directory as the
6746 current file, with the name derived by appending @file{_archive} to the
6747 current file name. For information and examples on how to change this,
6748 see the documentation string of the variable
6749 @code{org-archive-location}. There is also an in-buffer option for
6750 setting this variable, for example@footnote{For backward compatibility,
6751 the following also works: If there are several such lines in a file,
6752 each specifies the archive location for the text below it. The first
6753 such line also applies to any text before its definition. However,
6754 using this method is @emph{strongly} deprecated as it is incompatible
6755 with the outline structure of the document. The correct method for
6756 setting multiple archive locations in a buffer is using properties.}:
6760 #+ARCHIVE: %s_done::
6763 @cindex property, ARCHIVE
6765 If you would like to have a special ARCHIVE location for a single entry
6766 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
6767 location as the value (@pxref{Properties and Columns}).
6769 @vindex org-archive-save-context-info
6770 When a subtree is moved, it receives a number of special properties that
6771 record context information like the file from where the entry came, its
6772 outline path the archiving time etc. Configure the variable
6773 @code{org-archive-save-context-info} to adjust the amount of information
6777 @node Internal archiving, , Moving subtrees, Archiving
6778 @subsection Internal archiving
6780 If you want to just switch off (for agenda views) certain subtrees without
6781 moving them to a different file, you can use the @code{ARCHIVE tag}.
6783 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
6784 its location in the outline tree, but behaves in the following way:
6787 @vindex org-cycle-open-archived-trees
6788 It does not open when you attempt to do so with a visibility cycling
6789 command (@pxref{Visibility cycling}). You can force cycling archived
6790 subtrees with @kbd{C-@key{TAB}}, or by setting the option
6791 @code{org-cycle-open-archived-trees}. Also normal outline commands like
6792 @code{show-all} will open archived subtrees.
6794 @vindex org-sparse-tree-open-archived-trees
6795 During sparse tree construction (@pxref{Sparse trees}), matches in
6796 archived subtrees are not exposed, unless you configure the option
6797 @code{org-sparse-tree-open-archived-trees}.
6799 @vindex org-agenda-skip-archived-trees
6800 During agenda view construction (@pxref{Agenda Views}), the content of
6801 archived trees is ignored unless you configure the option
6802 @code{org-agenda-skip-archived-trees}, in which case these trees will always
6803 be included. In the agenda you can press @kbd{v a} to get archives
6804 temporarily included.
6806 @vindex org-export-with-archived-trees
6807 Archived trees are not exported (@pxref{Exporting}), only the headline
6808 is. Configure the details using the variable
6809 @code{org-export-with-archived-trees}.
6811 @vindex org-columns-skip-archived-trees
6812 Archived trees are excluded from column view unless the variable
6813 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
6816 The following commands help manage the ARCHIVE tag:
6819 @orgcmd{C-c C-x a,org-toggle-archive-tag}
6820 Toggle the ARCHIVE tag for the current headline. When the tag is set,
6821 the headline changes to a shadowed face, and the subtree below it is
6823 @orgkey{C-u C-c C-x a}
6824 Check if any direct children of the current headline should be archived.
6825 To do this, each subtree is checked for open TODO entries. If none are
6826 found, the command offers to set the ARCHIVE tag for the child. If the
6827 cursor is @emph{not} on a headline when this command is invoked, the
6828 level 1 trees will be checked.
6829 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
6830 Cycle a tree even if it is tagged with ARCHIVE.
6831 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
6832 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
6833 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
6834 entry becomes a child of that sibling and in this way retains a lot of its
6835 original context, including inherited tags and approximate position in the
6840 @node Agenda Views, Markup, Capture - Refile - Archive, Top
6841 @chapter Agenda views
6842 @cindex agenda views
6844 Due to the way Org works, TODO items, time-stamped items, and
6845 tagged headlines can be scattered throughout a file or even a number of
6846 files. To get an overview of open action items, or of events that are
6847 important for a particular date, this information must be collected,
6848 sorted and displayed in an organized way.
6850 Org can select items based on various criteria and display them
6851 in a separate buffer. Seven different view types are provided:
6855 an @emph{agenda} that is like a calendar and shows information
6858 a @emph{TODO list} that covers all unfinished
6861 a @emph{match view}, showings headlines based on the tags, properties, and
6862 TODO state associated with them,
6864 a @emph{timeline view} that shows all events in a single Org file,
6865 in time-sorted view,
6867 a @emph{text search view} that shows all entries from multiple files
6868 that contain specified keywords,
6870 a @emph{stuck projects view} showing projects that currently don't move
6873 @emph{custom views} that are special searches and combinations of different
6878 The extracted information is displayed in a special @emph{agenda
6879 buffer}. This buffer is read-only, but provides commands to visit the
6880 corresponding locations in the original Org files, and even to
6881 edit these files remotely.
6883 @vindex org-agenda-window-setup
6884 @vindex org-agenda-restore-windows-after-quit
6885 Two variables control how the agenda buffer is displayed and whether the
6886 window configuration is restored when the agenda exits:
6887 @code{org-agenda-window-setup} and
6888 @code{org-agenda-restore-windows-after-quit}.
6891 * Agenda files:: Files being searched for agenda information
6892 * Agenda dispatcher:: Keyboard access to agenda views
6893 * Built-in agenda views:: What is available out of the box?
6894 * Presentation and sorting:: How agenda items are prepared for display
6895 * Agenda commands:: Remote editing of Org trees
6896 * Custom agenda views:: Defining special searches and views
6897 * Exporting Agenda Views:: Writing a view to a file
6898 * Agenda column view:: Using column view for collected entries
6901 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
6902 @section Agenda files
6903 @cindex agenda files
6904 @cindex files for agenda
6906 @vindex org-agenda-files
6907 The information to be shown is normally collected from all @emph{agenda
6908 files}, the files listed in the variable
6909 @code{org-agenda-files}@footnote{If the value of that variable is not a
6910 list, but a single file name, then the list of agenda files will be
6911 maintained in that external file.}. If a directory is part of this list,
6912 all files with the extension @file{.org} in this directory will be part
6915 Thus, even if you only work with a single Org file, that file should
6916 be put into the list@footnote{When using the dispatcher, pressing
6917 @kbd{<} before selecting a command will actually limit the command to
6918 the current file, and ignore @code{org-agenda-files} until the next
6919 dispatcher command.}. You can customize @code{org-agenda-files}, but
6920 the easiest way to maintain it is through the following commands
6922 @cindex files, adding to agenda list
6924 @orgcmd{C-c [,org-agenda-file-to-front}
6925 Add current file to the list of agenda files. The file is added to
6926 the front of the list. If it was already in the list, it is moved to
6927 the front. With a prefix argument, file is added/moved to the end.
6928 @orgcmd{C-c ],org-remove-file}
6929 Remove current file from the list of agenda files.
6931 @orgcmd{C-',org-cycle-agenda-files}
6933 Cycle through agenda file list, visiting one file after the other.
6934 @kindex M-x org-iswitchb
6935 @item M-x org-iswitchb
6936 Command to use an @code{iswitchb}-like interface to switch to and between Org
6941 The Org menu contains the current list of files and can be used
6942 to visit any of them.
6944 If you would like to focus the agenda temporarily on a file not in
6945 this list, or on just one file in the list, or even on only a subtree in a
6946 file, then this can be done in different ways. For a single agenda command,
6947 you may press @kbd{<} once or several times in the dispatcher
6948 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
6949 extended period, use the following commands:
6952 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
6953 Permanently restrict the agenda to the current subtree. When with a
6954 prefix argument, or with the cursor before the first headline in a file,
6955 the agenda scope is set to the entire file. This restriction remains in
6956 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
6957 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
6958 agenda view, the new restriction takes effect immediately.
6959 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
6960 Remove the permanent restriction created by @kbd{C-c C-x <}.
6964 When working with @file{speedbar.el}, you can use the following commands in
6967 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
6968 Permanently restrict the agenda to the item---either an Org file or a subtree
6969 in such a file---at the cursor in the Speedbar frame.
6970 If there is a window displaying an agenda view, the new restriction takes
6972 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
6973 Lift the restriction.
6976 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
6977 @section The agenda dispatcher
6978 @cindex agenda dispatcher
6979 @cindex dispatching agenda commands
6980 The views are created through a dispatcher, which should be bound to a
6981 global key---for example @kbd{C-c a} (@pxref{Installation}). In the
6982 following we will assume that @kbd{C-c a} is indeed how the dispatcher
6983 is accessed and list keyboard access to commands accordingly. After
6984 pressing @kbd{C-c a}, an additional letter is required to execute a
6985 command. The dispatcher offers the following default commands:
6988 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
6990 Create a list of all TODO items (@pxref{Global TODO list}).
6992 Create a list of headlines matching a TAGS expression (@pxref{Matching
6993 tags and properties}).
6995 Create the timeline view for the current buffer (@pxref{Timeline}).
6997 Create a list of entries selected by a boolean expression of keywords
6998 and/or regular expressions that must or must not occur in the entry.
7000 @vindex org-agenda-text-search-extra-files
7001 Search for a regular expression in all agenda files and additionally in
7002 the files listed in @code{org-agenda-text-search-extra-files}. This
7003 uses the Emacs command @code{multi-occur}. A prefix argument can be
7004 used to specify the number of context lines for each match, default is
7007 Create a list of stuck projects (@pxref{Stuck projects}).
7009 Restrict an agenda command to the current buffer@footnote{For backward
7010 compatibility, you can also press @kbd{1} to restrict to the current
7011 buffer.}. After pressing @kbd{<}, you still need to press the character
7012 selecting the command.
7014 If there is an active region, restrict the following agenda command to
7015 the region. Otherwise, restrict it to the current subtree@footnote{For
7016 backward compatibility, you can also press @kbd{0} to restrict to the
7017 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7018 character selecting the command.
7021 You can also define custom commands that will be accessible through the
7022 dispatcher, just like the default commands. This includes the
7023 possibility to create extended agenda buffers that contain several
7024 blocks together, for example the weekly agenda, the global TODO list and
7025 a number of special tags matches. @xref{Custom agenda views}.
7027 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7028 @section The built-in agenda views
7030 In this section we describe the built-in views.
7033 * Weekly/daily agenda:: The calendar page with current tasks
7034 * Global TODO list:: All unfinished action items
7035 * Matching tags and properties:: Structured information with fine-tuned search
7036 * Timeline:: Time-sorted view for single file
7037 * Search view:: Find entries by searching for text
7038 * Stuck projects:: Find projects you need to review
7041 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7042 @subsection The weekly/daily agenda
7044 @cindex weekly agenda
7045 @cindex daily agenda
7047 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7048 paper agenda, showing all the tasks for the current week or day.
7051 @cindex org-agenda, command
7052 @orgcmd{C-c a a,org-agenda-list}
7053 Compile an agenda for the current week from a list of Org files. The agenda
7054 shows the entries for each day. With a numeric prefix@footnote{For backward
7055 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7056 listed before the agenda. This feature is deprecated, use the dedicated TODO
7057 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7058 C-c a a}) you may set the number of days to be displayed.
7061 @vindex org-agenda-span
7062 @vindex org-agenda-ndays
7063 The default number of days displayed in the agenda is set by the variable
7064 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7065 variable can be set to any number of days you want to see by default in the
7066 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7069 Remote editing from the agenda buffer means, for example, that you can
7070 change the dates of deadlines and appointments from the agenda buffer.
7071 The commands available in the Agenda buffer are listed in @ref{Agenda
7074 @subsubheading Calendar/Diary integration
7075 @cindex calendar integration
7076 @cindex diary integration
7078 Emacs contains the calendar and diary by Edward M. Reingold. The
7079 calendar displays a three-month calendar with holidays from different
7080 countries and cultures. The diary allows you to keep track of
7081 anniversaries, lunar phases, sunrise/set, recurrent appointments
7082 (weekly, monthly) and more. In this way, it is quite complementary to
7083 Org. It can be very useful to combine output from Org with
7086 In order to include entries from the Emacs diary into Org-mode's
7087 agenda, you only need to customize the variable
7090 (setq org-agenda-include-diary t)
7093 @noindent After that, everything will happen automatically. All diary
7094 entries including holidays, anniversaries, etc., will be included in the
7095 agenda buffer created by Org-mode. @key{SPC}, @key{TAB}, and
7096 @key{RET} can be used from the agenda buffer to jump to the diary
7097 file in order to edit existing diary entries. The @kbd{i} command to
7098 insert new entries for the current date works in the agenda buffer, as
7099 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7100 Sunrise/Sunset times, show lunar phases and to convert to other
7101 calendars, respectively. @kbd{c} can be used to switch back and forth
7102 between calendar and agenda.
7104 If you are using the diary only for sexp entries and holidays, it is
7105 faster to not use the above setting, but instead to copy or even move
7106 the entries into an Org file. Org-mode evaluates diary-style sexp
7107 entries, and does it faster because there is no overhead for first
7108 creating the diary display. Note that the sexp entries must start at
7109 the left margin, no whitespace is allowed before them. For example,
7110 the following segment of an Org file will be processed and entries
7111 will be made in the agenda:
7114 * Birthdays and similar stuff
7116 %%(org-calendar-holiday) ; special function for holiday names
7118 %%(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
7119 %%(diary-anniversary 10 2 1869) Mahatma Gandhi would be %d years old
7122 @subsubheading Anniversaries from BBDB
7123 @cindex BBDB, anniversaries
7124 @cindex anniversaries, from BBDB
7126 If you are using the Big Brothers Database to store your contacts, you will
7127 very likely prefer to store anniversaries in BBDB rather than in a
7128 separate Org or diary file. Org supports this and will show BBDB
7129 anniversaries as part of the agenda. All you need to do is to add the
7130 following to one your your agenda files:
7137 %%(org-bbdb-anniversaries)
7140 You can then go ahead and define anniversaries for a BBDB record. Basically,
7141 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7142 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7143 followed by a space and the class of the anniversary (@samp{birthday} or
7144 @samp{wedding}, or a format string). If you omit the class, it will default to
7145 @samp{birthday}. Here are a few examples, the header for the file
7146 @file{org-bbdb.el} contains more detailed information.
7152 2008-04-14 %s released version 6.01 of org-mode, %d years ago
7155 After a change to BBDB, or for the first agenda display during an Emacs
7156 session, the agenda display will suffer a short delay as Org updates its
7157 hash with anniversaries. However, from then on things will be very fast---much
7158 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7159 in an Org or Diary file.
7161 @subsubheading Appointment reminders
7162 @cindex @file{appt.el}
7163 @cindex appointment reminders
7165 Org can interact with Emacs appointments notification facility. To add all
7166 the appointments of your agenda files, use the command
7167 @code{org-agenda-to-appt}. This command also lets you filter through the
7168 list of your appointments and add only those belonging to a specific category
7169 or matching a regular expression. See the docstring for details.
7171 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7172 @subsection The global TODO list
7173 @cindex global TODO list
7174 @cindex TODO list, global
7176 The global TODO list contains all unfinished TODO items formatted and
7177 collected into a single place.
7180 @orgcmd{C-c a t,org-todo-list}
7181 Show the global TODO list. This collects the TODO items from all agenda
7182 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7183 items with a state the is not a DONE state. The buffer is in
7184 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7185 entries directly from that buffer (@pxref{Agenda commands}).
7186 @orgcmd{C-c a T,org-todo-list}
7187 @cindex TODO keyword matching
7188 @vindex org-todo-keywords
7189 Like the above, but allows selection of a specific TODO keyword. You can
7190 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7191 prompted for a keyword, and you may also specify several keywords by
7192 separating them with @samp{|} as the boolean OR operator. With a numeric
7193 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7195 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7196 a prefix argument to this command to change the selected TODO keyword,
7197 for example @kbd{3 r}. If you often need a search for a specific
7198 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7199 Matching specific TODO keywords can also be done as part of a tags
7200 search (@pxref{Tag searches}).
7203 Remote editing of TODO items means that you can change the state of a
7204 TODO entry with a single key press. The commands available in the
7205 TODO list are described in @ref{Agenda commands}.
7207 @cindex sublevels, inclusion into TODO list
7208 Normally the global TODO list simply shows all headlines with TODO
7209 keywords. This list can become very long. There are two ways to keep
7213 @vindex org-agenda-todo-ignore-scheduled
7214 @vindex org-agenda-todo-ignore-deadlines
7215 @vindex org-agenda-todo-ignore-timestamp
7216 @vindex org-agenda-todo-ignore-with-date
7217 Some people view a TODO item that has been @emph{scheduled} for execution or
7218 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7219 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7220 @code{org-agenda-todo-ignore-deadlines},
7221 @code{org-agenda-todo-ignore-timestamp} and/or
7222 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7225 @vindex org-agenda-todo-list-sublevels
7226 TODO items may have sublevels to break up the task into subtasks. In
7227 such cases it may be enough to list only the highest level TODO headline
7228 and omit the sublevels from the global list. Configure the variable
7229 @code{org-agenda-todo-list-sublevels} to get this behavior.
7232 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7233 @subsection Matching tags and properties
7234 @cindex matching, of tags
7235 @cindex matching, of properties
7239 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7240 or have properties (@pxref{Properties and Columns}), you can select headlines
7241 based on this metadata and collect them into an agenda buffer. The match
7242 syntax described here also applies when creating sparse trees with @kbd{C-c /
7246 @orgcmd{C-c a m,org-tags-view}
7247 Produce a list of all headlines that match a given set of tags. The
7248 command prompts for a selection criterion, which is a boolean logic
7249 expression with tags, like @samp{+work+urgent-withboss} or
7250 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7251 define a custom command for it (@pxref{Agenda dispatcher}).
7252 @orgcmd{C-c a M,org-tags-view}
7253 @vindex org-tags-match-list-sublevels
7254 @vindex org-agenda-tags-todo-honor-ignore-options
7255 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7256 not-DONE state and force checking subitems (see variable
7257 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7258 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7259 specific TODO keywords together with a tags match is also possible, see
7263 The commands available in the tags list are described in @ref{Agenda
7266 @subsubheading Match syntax
7268 @cindex Boolean logic, for tag/property searches
7269 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7270 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7271 not implemented. Each element in the search is either a tag, a regular
7272 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7273 VALUE} with a comparison operator, accessing a property value. Each element
7274 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7275 sugar for positive selection. The AND operator @samp{&} is optional when
7276 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7280 Select headlines tagged @samp{:work:}, but discard those also tagged
7283 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7284 @item work|laptop+night
7285 Like before, but require the @samp{:laptop:} lines to be tagged also
7289 @cindex regular expressions, with tags search
7290 Instead of a tag, you may also specify a regular expression enclosed in curly
7291 braces. For example,
7292 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7293 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7295 @cindex TODO keyword matching, with tags search
7296 @cindex level, require for tags/property match
7297 @cindex category, require for tags/property match
7298 @vindex org-odd-levels-only
7299 You may also test for properties (@pxref{Properties and Columns}) at the same
7300 time as matching tags. The properties may be real properties, or special
7301 properties that represent other metadata (@pxref{Special properties}). For
7302 example, the ``property'' @code{TODO} represents the TODO keyword of the
7303 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7304 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7305 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7306 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7307 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7309 Here are more examples:
7311 @item work+TODO="WAITING"
7312 Select @samp{:work:}-tagged TODO lines with the specific TODO
7313 keyword @samp{WAITING}.
7314 @item work+TODO="WAITING"|home+TODO="WAITING"
7315 Waiting tasks both at work and at home.
7318 When matching properties, a number of different operators can be used to test
7319 the value of a property. Here is a complex example:
7322 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7323 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7327 The type of comparison will depend on how the comparison value is written:
7330 If the comparison value is a plain number, a numerical comparison is done,
7331 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7332 @samp{>=}, and @samp{<>}.
7334 If the comparison value is enclosed in double-quotes,
7335 a string comparison is done, and the same operators are allowed.
7337 If the comparison value is enclosed in double-quotes @emph{and} angular
7338 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7339 assumed to be date/time specifications in the standard Org way, and the
7340 comparison will be done accordingly. Special values that will be recognized
7341 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7342 @code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
7343 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7344 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7345 respectively, can be used.
7347 If the comparison value is enclosed
7348 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7349 regexp matches the property value, and @samp{<>} meaning that it does not
7353 So the search string in the example finds entries tagged @samp{:work:} but
7354 not @samp{:boss:}, which also have a priority value @samp{A}, a
7355 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7356 property that is numerically smaller than 2, a @samp{:With:} property that is
7357 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7358 on or after October 11, 2008.
7360 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7361 other properties will slow down the search. However, once you have paid the
7362 price by accessing one property, testing additional properties is cheap
7365 You can configure Org-mode to use property inheritance during a search, but
7366 beware that this can slow down searches considerably. See @ref{Property
7367 inheritance}, for details.
7369 For backward compatibility, and also for typing speed, there is also a
7370 different way to test TODO states in a search. For this, terminate the
7371 tags/property part of the search string (which may include several terms
7372 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7373 expression just for TODO keywords. The syntax is then similar to that for
7374 tags, but should be applied with care: for example, a positive selection on
7375 several TODO keywords cannot meaningfully be combined with boolean AND.
7376 However, @emph{negative selection} combined with AND can be meaningful. To
7377 make sure that only lines are checked that actually have any TODO keyword
7378 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7379 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7380 not match TODO keywords in a DONE state. Examples:
7384 Same as @samp{work+TODO="WAITING"}
7385 @item work/!-WAITING-NEXT
7386 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7388 @item work/!+WAITING|+NEXT
7389 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7393 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7394 @subsection Timeline for a single file
7395 @cindex timeline, single file
7396 @cindex time-sorted view
7398 The timeline summarizes all time-stamped items from a single Org-mode
7399 file in a @emph{time-sorted view}. The main purpose of this command is
7400 to give an overview over events in a project.
7403 @orgcmd{C-c a L,org-timeline}
7404 Show a time-sorted view of the Org file, with all time-stamped items.
7405 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7406 (scheduled or not) are also listed under the current date.
7410 The commands available in the timeline buffer are listed in
7411 @ref{Agenda commands}.
7413 @node Search view, Stuck projects, Timeline, Built-in agenda views
7414 @subsection Search view
7417 @cindex searching, for text
7419 This agenda view is a general text search facility for Org-mode entries.
7420 It is particularly useful to find notes.
7423 @orgcmd{C-c a s,org-search-view}
7424 This is a special search that lets you select entries by matching a substring
7425 or specific words using a boolean logic.
7427 For example, the search string @samp{computer equipment} will find entries
7428 that contain @samp{computer equipment} as a substring. If the two words are
7429 separated by more space or a line break, the search will still match.
7430 Search view can also search for specific keywords in the entry, using Boolean
7431 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7432 will search for note entries that contain the keywords @code{computer}
7433 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7434 not matched by the regular expression @code{8\.11[bg]}, meaning to
7435 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7436 word search, other @samp{+} characters are optional. For more details, see
7437 the docstring of the command @code{org-search-view}.
7439 @vindex org-agenda-text-search-extra-files
7440 Note that in addition to the agenda files, this command will also search
7441 the files listed in @code{org-agenda-text-search-extra-files}.
7443 @node Stuck projects, , Search view, Built-in agenda views
7444 @subsection Stuck projects
7445 @pindex GTD, Getting Things Done
7447 If you are following a system like David Allen's GTD to organize your
7448 work, one of the ``duties'' you have is a regular review to make sure
7449 that all projects move along. A @emph{stuck} project is a project that
7450 has no defined next actions, so it will never show up in the TODO lists
7451 Org-mode produces. During the review, you need to identify such
7452 projects and define next actions for them.
7455 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7456 List projects that are stuck.
7459 @vindex org-stuck-projects
7460 Customize the variable @code{org-stuck-projects} to define what a stuck
7461 project is and how to find it.
7464 You almost certainly will have to configure this view before it will
7465 work for you. The built-in default assumes that all your projects are
7466 level-2 headlines, and that a project is not stuck if it has at least
7467 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7469 Let's assume that you, in your own way of using Org-mode, identify
7470 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7471 indicate a project that should not be considered yet. Let's further
7472 assume that the TODO keyword DONE marks finished projects, and that NEXT
7473 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7474 is a next action even without the NEXT tag. Finally, if the project
7475 contains the special word IGNORE anywhere, it should not be listed
7476 either. In this case you would start by identifying eligible projects
7477 with a tags/todo match@footnote{@xref{Tag searches}.}
7478 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7479 IGNORE in the subtree to identify projects that are not stuck. The
7480 correct customization for this is
7483 (setq org-stuck-projects
7484 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7488 Note that if a project is identified as non-stuck, the subtree of this entry
7489 will still be searched for stuck projects.
7491 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7492 @section Presentation and sorting
7493 @cindex presentation, of agenda items
7495 @vindex org-agenda-prefix-format
7496 @vindex org-agenda-tags-column
7497 Before displaying items in an agenda view, Org-mode visually prepares the
7498 items and sorts them. Each item occupies a single line. The line starts
7499 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
7500 of the item and other important information. You can customize in which
7501 column tags will be displayed through @code{org-agenda-tags-column}. You can
7502 also customize the prefix using the option @code{org-agenda-prefix-format}.
7503 This prefix is followed by a cleaned-up version of the outline headline
7504 associated with the item.
7507 * Categories:: Not all tasks are equal
7508 * Time-of-day specifications:: How the agenda knows the time
7509 * Sorting of agenda items:: The order of things
7512 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7513 @subsection Categories
7517 The category is a broad label assigned to each agenda item. By default,
7518 the category is simply derived from the file name, but you can also
7519 specify it with a special line in the buffer, like this@footnote{For
7520 backward compatibility, the following also works: if there are several
7521 such lines in a file, each specifies the category for the text below it.
7522 The first category also applies to any text before the first CATEGORY
7523 line. However, using this method is @emph{strongly} deprecated as it is
7524 incompatible with the outline structure of the document. The correct
7525 method for setting multiple categories in a buffer is using a
7533 @cindex property, CATEGORY
7534 If you would like to have a special CATEGORY for a single entry or a
7535 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7536 special category you want to apply as the value.
7539 The display in the agenda buffer looks best if the category is not
7540 longer than 10 characters.
7543 You can set up icons for category by customizing the
7544 @code{org-agenda-category-icon-alist} variable.
7546 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7547 @subsection Time-of-day specifications
7548 @cindex time-of-day specification
7550 Org-mode checks each agenda item for a time-of-day specification. The
7551 time can be part of the timestamp that triggered inclusion into the
7552 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7553 ranges can be specified with two timestamps, like
7555 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7557 In the headline of the entry itself, a time(range) may also appear as
7558 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7559 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7560 specifications in diary entries are recognized as well.
7562 For agenda display, Org-mode extracts the time and displays it in a
7563 standard 24 hour format as part of the prefix. The example times in
7564 the previous paragraphs would end up in the agenda like this:
7567 8:30-13:00 Arthur Dent lies in front of the bulldozer
7568 12:45...... Ford Prefect arrives and takes Arthur to the pub
7569 19:00...... The Vogon reads his poem
7570 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7574 If the agenda is in single-day mode, or for the display of today, the
7575 timed entries are embedded in a time grid, like
7578 8:00...... ------------------
7579 8:30-13:00 Arthur Dent lies in front of the bulldozer
7580 10:00...... ------------------
7581 12:00...... ------------------
7582 12:45...... Ford Prefect arrives and takes Arthur to the pub
7583 14:00...... ------------------
7584 16:00...... ------------------
7585 18:00...... ------------------
7586 19:00...... The Vogon reads his poem
7587 20:00...... ------------------
7588 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7591 @vindex org-agenda-use-time-grid
7592 @vindex org-agenda-time-grid
7593 The time grid can be turned on and off with the variable
7594 @code{org-agenda-use-time-grid}, and can be configured with
7595 @code{org-agenda-time-grid}.
7597 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7598 @subsection Sorting of agenda items
7599 @cindex sorting, of agenda items
7600 @cindex priorities, of agenda items
7601 Before being inserted into a view, the items are sorted. How this is
7602 done depends on the type of view.
7605 @vindex org-agenda-files
7606 For the daily/weekly agenda, the items for each day are sorted. The
7607 default order is to first collect all items containing an explicit
7608 time-of-day specification. These entries will be shown at the beginning
7609 of the list, as a @emph{schedule} for the day. After that, items remain
7610 grouped in categories, in the sequence given by @code{org-agenda-files}.
7611 Within each category, items are sorted by priority (@pxref{Priorities}),
7612 which is composed of the base priority (2000 for priority @samp{A}, 1000
7613 for @samp{B}, and 0 for @samp{C}), plus additional increments for
7614 overdue scheduled or deadline items.
7616 For the TODO list, items remain in the order of categories, but within
7617 each category, sorting takes place according to priority
7618 (@pxref{Priorities}). The priority used for sorting derives from the
7619 priority cookie, with additions depending on how close an item is to its due
7622 For tags matches, items are not sorted at all, but just appear in the
7623 sequence in which they are found in the agenda files.
7626 @vindex org-agenda-sorting-strategy
7627 Sorting can be customized using the variable
7628 @code{org-agenda-sorting-strategy}, and may also include criteria based on
7629 the estimated effort of an entry (@pxref{Effort estimates}).
7631 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
7632 @section Commands in the agenda buffer
7633 @cindex commands, in agenda buffer
7635 Entries in the agenda buffer are linked back to the Org file or diary
7636 file where they originate. You are not allowed to edit the agenda
7637 buffer itself, but commands are provided to show and jump to the
7638 original entry location, and to edit the Org files ``remotely'' from
7639 the agenda buffer. In this way, all information is stored only once,
7640 removing the risk that your agenda and note files may diverge.
7642 Some commands can be executed with mouse clicks on agenda lines. For
7643 the other commands, the cursor needs to be in the desired line.
7646 @tsubheading{Motion}
7647 @cindex motion commands in agenda
7648 @orgcmd{n,org-agenda-next-line}
7649 Next line (same as @key{up} and @kbd{C-p}).
7650 @orgcmd{p,org-agenda-previous-line}
7651 Previous line (same as @key{down} and @kbd{C-n}).
7652 @tsubheading{View/Go to Org file}
7653 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
7654 Display the original location of the item in another window.
7655 With prefix arg, make sure that the entire entry is made visible in the
7656 outline, not only the heading.
7658 @orgcmd{L,org-agenda-recenter}
7659 Display original location and recenter that window.
7661 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
7662 Go to the original location of the item in another window.
7664 @orgcmd{@key{RET},org-agenda-switch-to}
7665 Go to the original location of the item and delete other windows.
7667 @orgcmd{F,org-agenda-follow-mode}
7668 @vindex org-agenda-start-with-follow-mode
7669 Toggle Follow mode. In Follow mode, as you move the cursor through
7670 the agenda buffer, the other window always shows the corresponding
7671 location in the Org file. The initial setting for this mode in new
7672 agenda buffers can be set with the variable
7673 @code{org-agenda-start-with-follow-mode}.
7675 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
7676 Display the entire subtree of the current item in an indirect buffer. With a
7677 numeric prefix argument N, go up to level N and then take that tree. If N is
7678 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
7679 previously used indirect buffer.
7681 @orgcmd{C-c C-o,org-agenda-open-link}
7682 Follow a link in the entry. This will offer a selection of any links in the
7683 text belonging to the referenced Org node. If there is only one link, it
7684 will be followed without a selection prompt.
7686 @tsubheading{Change display}
7687 @cindex display changing, in agenda
7690 Delete other windows.
7692 @orgcmdkskc{v d,d,org-aganda-day-view}
7693 @xorgcmdkskc{v w,w,org-aganda-day-view}
7694 @xorgcmd{v m,org-agenda-month-view}
7695 @xorgcmd{v y,org-agenda-month-year}
7696 @xorgcmd{v SPC,org-agenda-reset-view}
7697 @vindex org-agenda-span
7698 Switch to day/week/month/year view. When switching to day or week view, this
7699 setting becomes the default for subsequent agenda refreshes. Since month and
7700 year views are slow to create, they do not become the default. A numeric
7701 prefix argument may be used to jump directly to a specific day of the year,
7702 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
7703 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
7704 month view, a year may be encoded in the prefix argument as well. For
7705 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
7706 specification has only one or two digits, it will be mapped to the interval
7707 1938-2037. @kbd{v @key{SPC}} will reset to what is set in
7708 @code{org-agenda-span}.
7710 @orgcmd{f,org-agenda-later}
7711 Go forward in time to display the following @code{org-agenda-current-span} days.
7712 For example, if the display covers a week, switch to the following week.
7713 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
7715 @orgcmd{b,org-agenda-earlier}
7716 Go backward in time to display earlier dates.
7718 @orgcmd{.,org-agenda-goto-today}
7721 @orgcmd{j,org-agenda-goto-date}
7722 Prompt for a date and go there.
7724 @orgcmd{J,org-agenda-clock-goto}
7725 Go to the currently clocked-in task @i{in the agenda buffer}.
7727 @orgcmd{D,org-agenda-toggle-diary}
7728 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
7730 @orgcmdkskc{v l,l,org-agenda-log-mode}
7732 @vindex org-log-done
7733 @vindex org-agenda-log-mode-items
7734 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
7735 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
7736 entries that have been clocked on that day. You can configure the entry
7737 types that should be included in log mode using the variable
7738 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
7739 all possible logbook entries, including state changes. When called with two
7740 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
7741 @kbd{v L} is equivalent to @kbd{C-u v l}.
7743 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
7744 Include inactive timestamps into the current view. Only for weekly/daily
7745 agenda and timeline views.
7747 @orgcmd{v a,org-agenda-archives-mode}
7748 @xorgcmd{v A,org-agenda-archives-mode 'files}
7749 Toggle Archives mode. In Archives mode, trees that are marked
7750 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
7751 capital @kbd{A}, even all archive files are included. To exit archives mode,
7752 press @kbd{v a} again.
7754 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
7755 @vindex org-agenda-start-with-clockreport-mode
7756 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
7757 always show a table with the clocked times for the timespan and file scope
7758 covered by the current agenda view. The initial setting for this mode in new
7759 agenda buffers can be set with the variable
7760 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
7761 when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
7762 contributions from entries that are hidden by agenda filtering@footnote{Only
7763 tags filtering will be respected here, effort filtering is ignored.}.
7765 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
7766 @vindex org-agenda-start-with-entry-text-mode
7767 @vindex org-agenda-entry-text-maxlines
7768 Toggle entry text mode. In entry text mode, a number of lines from the Org
7769 outline node referenced by an agenda line will be displayed below the line.
7770 The maximum number of lines is given by the variable
7771 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
7772 prefix argument will temporarily modify that number to the prefix value.
7774 @orgcmd{G,org-agenda-toggle-time-grid}
7775 @vindex org-agenda-use-time-grid
7776 @vindex org-agenda-time-grid
7777 Toggle the time grid on and off. See also the variables
7778 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
7780 @orgcmd{r,org-agenda-rodo}
7781 Recreate the agenda buffer, for example to reflect the changes after
7782 modification of the timestamps of items with @kbd{S-@key{left}} and
7783 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
7784 argument is interpreted to create a selective list for a specific TODO
7786 @orgcmd{g,org-agenda-rodo}
7789 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
7790 Save all Org buffers in the current Emacs session, and also the locations of
7793 @orgcmd{C-c C-x C-c,org-agenda-columns}
7794 @vindex org-columns-default-format
7795 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
7796 view format is taken from the entry at point, or (if there is no entry at
7797 point), from the first entry in the agenda view. So whatever the format for
7798 that entry would be in the original buffer (taken from a property, from a
7799 @code{#+COLUMNS} line, or from the default variable
7800 @code{org-columns-default-format}), will be used in the agenda.
7802 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7803 Remove the restriction lock on the agenda, if it is currently restricted to a
7804 file or subtree (@pxref{Agenda files}).
7806 @tsubheading{Secondary filtering and query editing}
7807 @cindex filtering, by tag and effort, in agenda
7808 @cindex tag filtering, in agenda
7809 @cindex effort filtering, in agenda
7810 @cindex query editing, in agenda
7812 @orgcmd{/,org-agenda-filter-by-tag}
7813 @vindex org-agenda-filter-preset
7814 Filter the current agenda view with respect to a tag and/or effort estimates.
7815 The difference between this and a custom agenda command is that filtering is
7816 very fast, so that you can switch quickly between different filters without
7817 having to recreate the agenda.@footnote{Custom commands can preset a filter by
7818 binding the variable @code{org-agenda-filter-preset} as an option. This
7819 filter will then be applied to the view and persist as a basic filter through
7820 refreshes and more secondary filtering. The filter is a global property of
7821 the entire agenda view---in a block agenda, you should only set this in the
7822 global options section, not in the section of an individual block.}
7824 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
7825 all. Pressing @key{TAB} at that prompt will offer use completion to select a
7826 tag (including any tags that do not have a selection character). The command
7827 then hides all entries that do not contain or inherit this tag. When called
7828 with prefix arg, remove the entries that @emph{do} have the tag. A second
7829 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
7830 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
7831 will be narrowed by requiring or forbidding the selected additional tag.
7832 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
7833 immediately use the @kbd{\} command.
7835 @vindex org-sort-agenda-noeffort-is-high
7836 In order to filter for effort estimates, you should set up allowed
7837 efforts globally, for example
7839 (setq org-global-properties
7840 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
7842 You can then filter for an effort by first typing an operator, one of
7843 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
7844 estimate in your array of allowed values, where @kbd{0} means the 10th value.
7845 The filter will then restrict to entries with effort smaller-or-equal, equal,
7846 or larger-or-equal than the selected value. If the digits 0-9 are not used
7847 as fast access keys to tags, you can also simply press the index digit
7848 directly without an operator. In this case, @kbd{<} will be assumed. For
7849 application of the operator, entries without a defined effort will be treated
7850 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
7851 for tasks without effort definition, press @kbd{?} as the operator.
7853 Org also supports automatic, context-aware tag filtering. If the variable
7854 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
7855 that function can decide which tags should be excluded from the agenda
7856 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
7857 as a sub-option key and runs the auto exclusion logic. For example, let's
7858 say you use a @code{Net} tag to identify tasks which need network access, an
7859 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
7860 calls. You could auto-exclude these tags based on the availability of the
7861 Internet, and outside of business hours, with something like this:
7865 (defun org-my-auto-exclude-function (tag)
7867 ((string= tag "Net")
7868 (/= 0 (call-process "/sbin/ping" nil nil nil
7869 "-c1" "-q" "-t1" "mail.gnu.org")))
7870 ((or (string= tag "Errand") (string= tag "Call"))
7871 (let ((hour (nth 2 (decode-time))))
7872 (or (< hour 8) (> hour 21)))))
7875 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
7879 @orgcmd{\,org-agenda-filter-by-tag-refine}
7880 Narrow the current agenda filter by an additional condition. When called with
7881 prefix arg, remove the entries that @emph{do} have the tag, or that do match
7882 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
7883 @kbd{-} as the first key after the @kbd{/} command.
7892 @item @r{in} search view
7893 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
7894 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
7895 add a positive search term prefixed by @samp{+}, indicating that this search
7896 term @i{must} occur/match in the entry. The closing bracket/brace will add a
7897 negative search term which @i{must not} occur/match in the entry for it to be
7901 @tsubheading{Remote editing}
7902 @cindex remote editing, from agenda
7907 @cindex undoing remote-editing events
7908 @cindex remote editing, undo
7909 @orgcmd{C-_,org-agenda-undo}
7910 Undo a change due to a remote editing command. The change is undone
7911 both in the agenda buffer and in the remote buffer.
7913 @orgcmd{t,org-agenda-todo}
7914 Change the TODO state of the item, both in the agenda and in the
7917 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
7918 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
7919 Switch to the next/previous set of TODO keywords.
7921 @orgcmd{C-k,org-agenda-kill}
7922 @vindex org-agenda-confirm-kill
7923 Delete the current agenda item along with the entire subtree belonging
7924 to it in the original Org file. If the text to be deleted remotely
7925 is longer than one line, the kill needs to be confirmed by the user. See
7926 variable @code{org-agenda-confirm-kill}.
7928 @orgcmd{C-c C-w,org-agenda-refile}
7929 Refile the entry at point.
7931 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
7932 @vindex org-archive-default-command
7933 Archive the subtree corresponding to the entry at point using the default
7934 archiving command set in @code{org-archive-default-command}. When using the
7935 @code{a} key, confirmation will be required.
7937 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
7938 Toggle the ARCHIVE tag for the current headline.
7940 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
7941 Move the subtree corresponding to the current entry to its @emph{archive
7944 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
7945 Archive the subtree corresponding to the current headline. This means the
7946 entry will be moved to the configured archive location, most likely a
7949 @orgcmd{T,org-agenda-show-tags}
7950 @vindex org-agenda-show-inherited-tags
7951 Show all tags associated with the current item. This is useful if you have
7952 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
7953 tags of a headline occasionally.
7955 @orgcmd{:,org-agenda-set-tags}
7956 Set tags for the current headline. If there is an active region in the
7957 agenda, change a tag for all headings in the region.
7961 Set the priority for the current item (@command{org-agenda-priority}).
7962 Org-mode prompts for the priority character. If you reply with @key{SPC}, the
7963 priority cookie is removed from the entry.
7965 @orgcmd{P,org-agenda-show-priority}
7966 Display weighted priority of current item.
7968 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
7969 Increase the priority of the current item. The priority is changed in
7970 the original buffer, but the agenda is not resorted. Use the @kbd{r}
7973 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
7974 Decrease the priority of the current item.
7976 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
7977 @vindex org-log-into-drawer
7978 Add a note to the entry. This note will be recorded, and then filed to the
7979 same location where state change notes are put. Depending on
7980 @code{org-log-into-drawer}, this may be inside a drawer.
7982 @orgcmd{C-c C-a,org-attach}
7983 Dispatcher for all command related to attachments.
7985 @orgcmd{C-c C-s,org-agenda-schedule}
7986 Schedule this item. With prefix arg remove the scheduling timestamp
7988 @orgcmd{C-c C-d,org-agenda-deadline}
7989 Set a deadline for this item. With prefix arg remove the deadline.
7991 @orgcmd{k,org-agenda-action}
7992 Agenda actions, to set dates for selected items to the cursor date.
7993 This command also works in the calendar! The command prompts for an
7996 m @r{Mark the entry at point for action. You can also make entries}
7997 @r{in Org files with @kbd{C-c C-x C-k}.}
7998 d @r{Set the deadline of the marked entry to the date at point.}
7999 s @r{Schedule the marked entry at the date at point.}
8000 r @r{Call @code{org-capture} with the cursor date as default date.}
8003 Press @kbd{r} afterward to refresh the agenda and see the effect of the
8006 @orgcmd{S-@key{right},org-agenda-do-date-later}
8007 Change the timestamp associated with the current line by one day into the
8008 future. With a numeric prefix argument, change it by that many days. For
8009 example, @kbd{3 6 5 S-@key{right}} will change it by a year. With a
8010 @kbd{C-u} prefix, change the time by one hour. If you immediately repeat the
8011 command, it will continue to change hours even without the prefix arg. With
8012 a double @kbd{C-u C-u} prefix, do the same for changing minutes. The stamp
8013 is changed in the original Org file, but the change is not directly reflected
8014 in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8016 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8017 Change the timestamp associated with the current line by one day
8020 @orgcmd{>,org-agenda-date-prompt}
8021 Change the timestamp associated with the current line. The key @kbd{>} has
8022 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8024 @orgcmd{I,org-agenda-clock-in}
8025 Start the clock on the current item. If a clock is running already, it
8028 @orgcmd{O,org-agenda-clock-out}
8029 Stop the previously started clock.
8031 @orgcmd{X,org-agenda-clock-cancel}
8032 Cancel the currently running clock.
8034 @orgcmd{J,org-agenda-clock-goto}
8035 Jump to the running clock in another window.
8037 @tsubheading{Bulk remote editing selected entries}
8038 @cindex remote editing, bulk, from agenda
8040 @orgcmd{m,org-agenda-bulk-mark}
8041 Mark the entry at point for bulk action. With prefix arg, mark that many
8044 @orgcmd{u,org-agenda-bulk-unmark}
8045 Unmark entry for bulk action.
8047 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8048 Unmark all marked entries for bulk action.
8050 @orgcmd{B,org-agenda-bulk-action}
8051 Bulk action: act on all marked entries in the agenda. This will prompt for
8052 another key to select the action to be applied. The prefix arg to @kbd{B}
8053 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8054 these special timestamps.
8056 r @r{Prompt for a single refile target and move all entries. The entries}
8057 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8058 $ @r{Archive all selected entries.}
8059 A @r{Archive entries by moving them to their respective archive siblings.}
8060 t @r{Change TODO state. This prompts for a single TODO keyword and}
8061 @r{changes the state of all selected entries, bypassing blocking and}
8062 @r{suppressing logging notes (but not timestamps).}
8063 + @r{Add a tag to all selected entries.}
8064 - @r{Remove a tag from all selected entries.}
8065 s @r{Schedule all items to a new date. To shift existing schedule dates}
8066 @r{by a fixed number of days, use something starting with double plus}
8067 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8068 S @r{Reschedule randomly by N days. N will be prompted for. With prefix}
8069 @r{arg (@kbd{C-u B S}), scatter only accross weekdays.}
8070 d @r{Set deadline to a specific date.}
8074 @tsubheading{Calendar commands}
8075 @cindex calendar commands, from agenda
8077 @orgcmd{c,org-agenda-goto-calendar}
8078 Open the Emacs calendar and move to the date at the agenda cursor.
8080 @orgcmd{c,org-calendar-goto-agenda}
8081 When in the calendar, compute and show the Org-mode agenda for the
8084 @cindex diary entries, creating from agenda
8085 @orgcmd{i,org-agenda-diary-entry}
8086 @vindex org-agenda-diary-file
8087 Insert a new entry into the diary, using the date at the cursor and (for
8088 block entries) the date at the mark. This will add to the Emacs diary
8089 file@footnote{This file is parsed for the agenda when
8090 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8091 command in the calendar. The diary file will pop up in another window, where
8092 you can add the entry.
8094 If you configure @code{org-agenda-diary-file} to point to an Org-mode file,
8095 Org will create entries (in org-mode syntax) in that file instead. Most
8096 entries will be stored in a date-based outline tree that will later make it
8097 easy to archive appointments from previous months/years. The tree will be
8098 built under an entry with a @code{DATE_TREE} property, or else with years as
8099 top-level entries. Emacs will prompt you for the entry text---if you specify
8100 it, the entry will be created in @code{org-agenda-diary-file} without further
8101 interaction. If you directly press @key{RET} at the prompt without typing
8102 text, the target file will be shown in another window for you to finish the
8103 entry there. See also the @kbd{k r} command.
8105 @orgcmd{M,org-agenda-phases-of-moon}
8106 Show the phases of the moon for the three months around current date.
8108 @orgcmd{S,org-agenda-sunrise-sunset}
8109 Show sunrise and sunset times. The geographical location must be set
8110 with calendar variables, see the documentation for the Emacs calendar.
8112 @orgcmd{C,org-agenda-convert-date}
8113 Convert the date at cursor into many other cultural and historic
8116 @orgcmd{H,org-agenda-holidays}
8117 Show holidays for three months around the cursor date.
8119 @item M-x org-export-icalendar-combine-agenda-files
8120 Export a single iCalendar file containing entries from all agenda files.
8121 This is a globally available command, and also available in the agenda menu.
8123 @tsubheading{Exporting to a file}
8124 @orgcmd{C-x C-w,org-write-agenda}
8125 @cindex exporting agenda views
8126 @cindex agenda views, exporting
8127 @vindex org-agenda-exporter-settings
8128 Write the agenda view to a file. Depending on the extension of the selected
8129 file name, the view will be exported as HTML (extension @file{.html} or
8130 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8131 and plain text (any other extension). When called with a @kbd{C-u} prefix
8132 argument, immediately open the newly created file. Use the variable
8133 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8134 for @file{htmlize} to be used during export.
8136 @tsubheading{Quit and Exit}
8137 @orgcmd{q,org-agenda-quit}
8138 Quit agenda, remove the agenda buffer.
8140 @cindex agenda files, removing buffers
8141 @orgcmd{x,org-agenda-exit}
8142 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8143 for the compilation of the agenda. Buffers created by the user to
8144 visit Org files will not be removed.
8148 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8149 @section Custom agenda views
8150 @cindex custom agenda views
8151 @cindex agenda views, custom
8153 Custom agenda commands serve two purposes: to store and quickly access
8154 frequently used TODO and tags searches, and to create special composite
8155 agenda buffers. Custom agenda commands will be accessible through the
8156 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8159 * Storing searches:: Type once, use often
8160 * Block agenda:: All the stuff you need in a single buffer
8161 * Setting Options:: Changing the rules
8164 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8165 @subsection Storing searches
8167 The first application of custom searches is the definition of keyboard
8168 shortcuts for frequently used searches, either creating an agenda
8169 buffer, or a sparse tree (the latter covering of course only the current
8172 @vindex org-agenda-custom-commands
8173 Custom commands are configured in the variable
8174 @code{org-agenda-custom-commands}. You can customize this variable, for
8175 example by pressing @kbd{C-c a C}. You can also directly set it with
8176 Emacs Lisp in @file{.emacs}. The following example contains all valid
8181 (setq org-agenda-custom-commands
8182 '(("w" todo "WAITING")
8183 ("W" todo-tree "WAITING")
8184 ("u" tags "+boss-urgent")
8185 ("v" tags-todo "+boss-urgent")
8186 ("U" tags-tree "+boss-urgent")
8187 ("f" occur-tree "\\<FIXME\\>")
8188 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8189 ("hl" tags "+home+Lisa")
8190 ("hp" tags "+home+Peter")
8191 ("hk" tags "+home+Kim")))
8196 The initial string in each entry defines the keys you have to press
8197 after the dispatcher command @kbd{C-c a} in order to access the command.
8198 Usually this will be just a single character, but if you have many
8199 similar commands, you can also define two-letter combinations where the
8200 first character is the same in several combinations and serves as a
8201 prefix key@footnote{You can provide a description for a prefix key by
8202 inserting a cons cell with the prefix and the description.}. The second
8203 parameter is the search type, followed by the string or regular
8204 expression to be used for the matching. The example above will
8209 as a global search for TODO entries with @samp{WAITING} as the TODO
8212 as the same search, but only in the current buffer and displaying the
8213 results as a sparse tree
8215 as a global tags search for headlines marked @samp{:boss:} but not
8218 as the same search as @kbd{C-c a u}, but limiting the search to
8219 headlines that are also TODO items
8221 as the same search as @kbd{C-c a u}, but only in the current buffer and
8222 displaying the result as a sparse tree
8224 to create a sparse tree (again: current buffer only) with all entries
8225 containing the word @samp{FIXME}
8227 as a prefix command for a HOME tags search where you have to press an
8228 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8229 Peter, or Kim) as additional tag to match.
8232 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8233 @subsection Block agenda
8234 @cindex block agenda
8235 @cindex agenda, with block views
8237 Another possibility is the construction of agenda views that comprise
8238 the results of @emph{several} commands, each of which creates a block in
8239 the agenda buffer. The available commands include @code{agenda} for the
8240 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8241 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8242 matching commands discussed above: @code{todo}, @code{tags}, and
8243 @code{tags-todo}. Here are two examples:
8247 (setq org-agenda-custom-commands
8248 '(("h" "Agenda and Home-related tasks"
8252 ("o" "Agenda and Office-related tasks"
8260 This will define @kbd{C-c a h} to create a multi-block view for stuff
8261 you need to attend to at home. The resulting agenda buffer will contain
8262 your agenda for the current week, all TODO items that carry the tag
8263 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8264 command @kbd{C-c a o} provides a similar view for office tasks.
8266 @node Setting Options, , Block agenda, Custom agenda views
8267 @subsection Setting options for custom commands
8268 @cindex options, for custom agenda views
8270 @vindex org-agenda-custom-commands
8271 Org-mode contains a number of variables regulating agenda construction
8272 and display. The global variables define the behavior for all agenda
8273 commands, including the custom commands. However, if you want to change
8274 some settings just for a single custom view, you can do so. Setting
8275 options requires inserting a list of variable names and values at the
8276 right spot in @code{org-agenda-custom-commands}. For example:
8280 (setq org-agenda-custom-commands
8281 '(("w" todo "WAITING"
8282 ((org-agenda-sorting-strategy '(priority-down))
8283 (org-agenda-prefix-format " Mixed: ")))
8284 ("U" tags-tree "+boss-urgent"
8285 ((org-show-following-heading nil)
8286 (org-show-hierarchy-above nil)))
8288 ((org-agenda-files '("~org/notes.org"))
8289 (org-agenda-text-search-extra-files nil)))))
8294 Now the @kbd{C-c a w} command will sort the collected entries only by
8295 priority, and the prefix format is modified to just say @samp{ Mixed: }
8296 instead of giving the category of the entry. The sparse tags tree of
8297 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8298 headline hierarchy above the match, nor the headline following the match
8299 will be shown. The command @kbd{C-c a N} will do a text search limited
8300 to only a single file.
8302 @vindex org-agenda-custom-commands
8303 For command sets creating a block agenda,
8304 @code{org-agenda-custom-commands} has two separate spots for setting
8305 options. You can add options that should be valid for just a single
8306 command in the set, and options that should be valid for all commands in
8307 the set. The former are just added to the command entry; the latter
8308 must come after the list of command entries. Going back to the block
8309 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8310 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8311 the results for GARDEN tags query in the opposite order,
8312 @code{priority-up}. This would look like this:
8316 (setq org-agenda-custom-commands
8317 '(("h" "Agenda and Home-related tasks"
8321 ((org-agenda-sorting-strategy '(priority-up)))))
8322 ((org-agenda-sorting-strategy '(priority-down))))
8323 ("o" "Agenda and Office-related tasks"
8330 As you see, the values and parentheses setting is a little complex.
8331 When in doubt, use the customize interface to set this variable---it
8332 fully supports its structure. Just one caveat: when setting options in
8333 this interface, the @emph{values} are just Lisp expressions. So if the
8334 value is a string, you need to add the double-quotes around the value
8338 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8339 @section Exporting Agenda Views
8340 @cindex agenda views, exporting
8342 If you are away from your computer, it can be very useful to have a printed
8343 version of some agenda views to carry around. Org-mode can export custom
8344 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8345 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8346 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8347 a PDF file with also create the postscript file.}, and iCalendar files. If
8348 you want to do this only occasionally, use the command
8351 @orgcmd{C-x C-w,org-write-agenda}
8352 @cindex exporting agenda views
8353 @cindex agenda views, exporting
8354 @vindex org-agenda-exporter-settings
8355 Write the agenda view to a file. Depending on the extension of the selected
8356 file name, the view will be exported as HTML (extension @file{.html} or
8357 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8358 @file{.ics}), or plain text (any other extension). Use the variable
8359 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8360 for @file{htmlize} to be used during export, for example
8362 @vindex org-agenda-add-entry-text-maxlines
8363 @vindex htmlize-output-type
8364 @vindex ps-number-of-columns
8365 @vindex ps-landscape-mode
8367 (setq org-agenda-exporter-settings
8368 '((ps-number-of-columns 2)
8369 (ps-landscape-mode t)
8370 (org-agenda-add-entry-text-maxlines 5)
8371 (htmlize-output-type 'css)))
8375 If you need to export certain agenda views frequently, you can associate
8376 any custom agenda command with a list of output file names
8377 @footnote{If you want to store standard views like the weekly agenda
8378 or the global TODO list as well, you need to define custom commands for
8379 them in order to be able to specify file names.}. Here is an example
8380 that first defines custom commands for the agenda and the global
8381 TODO list, together with a number of files to which to export them.
8382 Then we define two block agenda commands and specify file names for them
8383 as well. File names can be relative to the current working directory,
8388 (setq org-agenda-custom-commands
8389 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8390 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8391 ("h" "Agenda and Home-related tasks"
8396 ("~/views/home.html"))
8397 ("o" "Agenda and Office-related tasks"
8402 ("~/views/office.ps" "~/calendars/office.ics"))))
8406 The extension of the file name determines the type of export. If it is
8407 @file{.html}, Org-mode will use the @file{htmlize.el} package to convert
8408 the buffer to HTML and save it to this file name. If the extension is
8409 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8410 Postscript output. If the extension is @file{.ics}, iCalendar export is
8411 run export over all files that were used to construct the agenda, and
8412 limit the export to entries listed in the agenda. Any other
8413 extension produces a plain ASCII file.
8415 The export files are @emph{not} created when you use one of those
8416 commands interactively because this might use too much overhead.
8417 Instead, there is a special command to produce @emph{all} specified
8421 @orgcmd{C-c a e,org-store-agenda-views}
8422 Export all agenda views that have export file names associated with
8426 You can use the options section of the custom agenda commands to also
8427 set options for the export commands. For example:
8430 (setq org-agenda-custom-commands
8432 ((ps-number-of-columns 2)
8433 (ps-landscape-mode t)
8434 (org-agenda-prefix-format " [ ] ")
8435 (org-agenda-with-colors nil)
8436 (org-agenda-remove-tags t))
8441 This command sets two options for the Postscript exporter, to make it
8442 print in two columns in landscape format---the resulting page can be cut
8443 in two and then used in a paper agenda. The remaining settings modify
8444 the agenda prefix to omit category and scheduling information, and
8445 instead include a checkbox to check off items. We also remove the tags
8446 to make the lines compact, and we don't want to use colors for the
8447 black-and-white printer. Settings specified in
8448 @code{org-agenda-exporter-settings} will also apply, but the settings
8449 in @code{org-agenda-custom-commands} take precedence.
8452 From the command line you may also use
8454 emacs -f org-batch-store-agenda-views -kill
8457 or, if you need to modify some parameters@footnote{Quoting depends on the
8458 system you use, please check the FAQ for examples.}
8460 emacs -eval '(org-batch-store-agenda-views \
8461 org-agenda-span month \
8462 org-agenda-start-day "2007-11-01" \
8463 org-agenda-include-diary nil \
8464 org-agenda-files (quote ("~/org/project.org")))' \
8468 which will create the agenda views restricted to the file
8469 @file{~/org/project.org}, without diary entries and with a 30-day
8472 You can also extract agenda information in a way that allows further
8473 processing by other programs. See @ref{Extracting agenda information}, for
8477 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8478 @section Using column view in the agenda
8479 @cindex column view, in agenda
8480 @cindex agenda, column view
8482 Column view (@pxref{Column view}) is normally used to view and edit
8483 properties embedded in the hierarchical structure of an Org file. It can be
8484 quite useful to use column view also from the agenda, where entries are
8485 collected by certain criteria.
8488 @orgcmd{C-c C-x C-c,org-agenda-columns}
8489 Turn on column view in the agenda.
8492 To understand how to use this properly, it is important to realize that the
8493 entries in the agenda are no longer in their proper outline environment.
8494 This causes the following issues:
8498 @vindex org-columns-default-format
8499 @vindex org-overriding-columns-format
8500 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8501 entries in the agenda are collected from different files, and different files
8502 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8503 Org first checks if the variable @code{org-overriding-columns-format} is
8504 currently set, and if so, takes the format from there. Otherwise it takes
8505 the format associated with the first item in the agenda, or, if that item
8506 does not have a specific format (defined in a property, or in its file), it
8507 uses @code{org-columns-default-format}.
8509 @cindex property, special, CLOCKSUM
8510 If any of the columns has a summary type defined (@pxref{Column attributes}),
8511 turning on column view in the agenda will visit all relevant agenda files and
8512 make sure that the computations of this property are up to date. This is
8513 also true for the special @code{CLOCKSUM} property. Org will then sum the
8514 values displayed in the agenda. In the daily/weekly agenda, the sums will
8515 cover a single day; in all other views they cover the entire block. It is
8516 vital to realize that the agenda may show the same entry @emph{twice} (for
8517 example as scheduled and as a deadline), and it may show two entries from the
8518 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8519 cases, the summation in the agenda will lead to incorrect results because
8520 some values will count double.
8522 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8523 the entire clocked time for this item. So even in the daily/weekly agenda,
8524 the clocksum listed in column view may originate from times outside the
8525 current view. This has the advantage that you can compare these values with
8526 a column listing the planned total effort for a task---one of the major
8527 applications for column view in the agenda. If you want information about
8528 clocked time in the displayed period use clock table mode (press @kbd{R} in
8533 @node Markup, Exporting, Agenda Views, Top
8534 @chapter Markup for rich export
8536 When exporting Org-mode documents, the exporter tries to reflect the
8537 structure of the document as accurately as possible in the backend. Since
8538 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
8539 Org-mode has rules on how to prepare text for rich export. This section
8540 summarizes the markup rules used in an Org-mode buffer.
8543 * Structural markup elements:: The basic structure as seen by the exporter
8544 * Images and tables:: Tables and Images will be included
8545 * Literal examples:: Source code examples with special formatting
8546 * Include files:: Include additional files into a document
8547 * Index entries:: Making an index
8548 * Macro replacement:: Use macros to create complex output
8549 * Embedded LaTeX:: LaTeX can be freely used inside Org documents
8552 @node Structural markup elements, Images and tables, Markup, Markup
8553 @section Structural markup elements
8556 * Document title:: Where the title is taken from
8557 * Headings and sections:: The document structure as seen by the exporter
8558 * Table of contents:: The if and where of the table of contents
8559 * Initial text:: Text before the first heading?
8561 * Paragraphs:: Paragraphs
8562 * Footnote markup:: Footnotes
8563 * Emphasis and monospace:: Bold, italic, etc.
8564 * Horizontal rules:: Make a line
8565 * Comment lines:: What will *not* be exported
8568 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
8569 @subheading Document title
8570 @cindex document title, markup rules
8573 The title of the exported document is taken from the special line
8577 #+TITLE: This is the title of the document
8581 If this line does not exist, the title is derived from the first non-empty,
8582 non-comment line in the buffer. If no such line exists, or if you have
8583 turned off exporting of the text before the first headline (see below), the
8584 title will be the file name without extension.
8586 @cindex property, EXPORT_TITLE
8587 If you are exporting only a subtree by marking is as the region, the heading
8588 of the subtree will become the title of the document. If the subtree has a
8589 property @code{EXPORT_TITLE}, that will take precedence.
8591 @node Headings and sections, Table of contents, Document title, Structural markup elements
8592 @subheading Headings and sections
8593 @cindex headings and sections, markup rules
8595 @vindex org-export-headline-levels
8596 The outline structure of the document as described in @ref{Document
8597 Structure}, forms the basis for defining sections of the exported document.
8598 However, since the outline structure is also used for (for example) lists of
8599 tasks, only the first three outline levels will be used as headings. Deeper
8600 levels will become itemized lists. You can change the location of this
8601 switch globally by setting the variable @code{org-export-headline-levels}, or on a
8602 per-file basis with a line
8609 @node Table of contents, Initial text, Headings and sections, Structural markup elements
8610 @subheading Table of contents
8611 @cindex table of contents, markup rules
8613 @vindex org-export-with-toc
8614 The table of contents is normally inserted directly before the first headline
8615 of the file. If you would like to get it to a different location, insert the
8616 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
8617 location. The depth of the table of contents is by default the same as the
8618 number of headline levels, but you can choose a smaller number, or turn off
8619 the table of contents entirely, by configuring the variable
8620 @code{org-export-with-toc}, or on a per-file basis with a line like
8623 #+OPTIONS: toc:2 (only to two levels in TOC)
8624 #+OPTIONS: toc:nil (no TOC at all)
8627 @node Initial text, Lists, Table of contents, Structural markup elements
8628 @subheading Text before the first headline
8629 @cindex text before first headline, markup rules
8632 Org-mode normally exports the text before the first headline, and even uses
8633 the first line as the document title. The text will be fully marked up. If
8634 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
8635 constructs described below in the sections for the individual exporters.
8637 @vindex org-export-skip-text-before-1st-heading
8638 Some people like to use the space before the first headline for setup and
8639 internal links and therefore would like to control the exported text before
8640 the first headline in a different way. You can do so by setting the variable
8641 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
8642 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
8645 If you still want to have some text before the first headline, use the
8646 @code{#+TEXT} construct:
8650 #+TEXT: This text will go before the *first* headline.
8651 #+TEXT: [TABLE-OF-CONTENTS]
8652 #+TEXT: This goes between the table of contents and the first headline
8655 @node Lists, Paragraphs, Initial text, Structural markup elements
8657 @cindex lists, markup rules
8659 Plain lists as described in @ref{Plain lists}, are translated to the backend's
8660 syntax for such lists. Most backends support unordered, ordered, and
8663 @node Paragraphs, Footnote markup, Lists, Structural markup elements
8664 @subheading Paragraphs, line breaks, and quoting
8665 @cindex paragraphs, markup rules
8667 Paragraphs are separated by at least one empty line. If you need to enforce
8668 a line break within a paragraph, use @samp{\\} at the end of a line.
8670 To keep the line breaks in a region, but otherwise use normal formatting, you
8671 can use this construct, which can also be used to format poetry.
8673 @cindex #+BEGIN_VERSE
8676 Great clouds overhead
8677 Tiny black birds rise and fall
8684 When quoting a passage from another document, it is customary to format this
8685 as a paragraph that is indented on both the left and the right margin. You
8686 can include quotations in Org-mode documents like this:
8688 @cindex #+BEGIN_QUOTE
8691 Everything should be made as simple as possible,
8692 but not any simpler -- Albert Einstein
8696 If you would like to center some text, do it like this:
8697 @cindex #+BEGIN_CENTER
8700 Everything should be made as simple as possible, \\
8706 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
8707 @subheading Footnote markup
8708 @cindex footnotes, markup rules
8709 @cindex @file{footnote.el}
8711 Footnotes defined in the way described in @ref{Footnotes}, will be exported by
8712 all backends. Org allows multiple references to the same note, and
8713 different backends support this to varying degrees.
8715 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
8716 @subheading Emphasis and monospace
8718 @cindex underlined text, markup rules
8719 @cindex bold text, markup rules
8720 @cindex italic text, markup rules
8721 @cindex verbatim text, markup rules
8722 @cindex code text, markup rules
8723 @cindex strike-through text, markup rules
8724 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
8725 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
8726 in the code and verbatim string is not processed for Org-mode specific
8727 syntax; it is exported verbatim.
8729 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
8730 @subheading Horizontal rules
8731 @cindex horizontal rules, markup rules
8732 A line consisting of only dashes, and at least 5 of them, will be exported as
8733 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
8735 @node Comment lines, , Horizontal rules, Structural markup elements
8736 @subheading Comment lines
8737 @cindex comment lines
8738 @cindex exporting, not
8739 @cindex #+BEGIN_COMMENT
8741 Lines starting with @samp{#} in column zero are treated as comments and will
8742 never be exported. If you want an indented line to be treated as a comment,
8743 start it with @samp{#+ }. Also entire subtrees starting with the word
8744 @samp{COMMENT} will never be exported. Finally, regions surrounded by
8745 @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will not be exported.
8750 Toggle the COMMENT keyword at the beginning of an entry.
8754 @node Images and tables, Literal examples, Structural markup elements, Markup
8755 @section Images and Tables
8757 @cindex tables, markup rules
8760 Both the native Org-mode tables (@pxref{Tables}) and tables formatted with
8761 the @file{table.el} package will be exported properly. For Org-mode tables,
8762 the lines before the first horizontal separator line will become table header
8763 lines. You can use the following lines somewhere before the table to assign
8764 a caption and a label for cross references, and in the text you can refer to
8765 the object with @code{\ref@{tab:basic-data@}}:
8768 #+CAPTION: This is the caption for the next table (or link)
8769 #+LABEL: tbl:basic-data
8774 @cindex inlined images, markup rules
8775 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
8776 images into the exported document. Org does this, if a link to an image
8777 files does not have a description part, for example @code{[[./img/a.jpg]]}.
8778 If you wish to define a caption for the image and maybe a label for internal
8779 cross references, make sure that the link is on a line by itself and precede
8780 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
8783 #+CAPTION: This is the caption for the next figure link (or table)
8784 #+LABEL: fig:SED-HR4049
8788 You may also define additional attributes for the figure. As this is
8789 backend-specific, see the sections about the individual backends for more
8792 @xref{Handling links,the discussion of image links}.
8794 @node Literal examples, Include files, Images and tables, Markup
8795 @section Literal examples
8796 @cindex literal examples, markup rules
8797 @cindex code line references, markup rules
8799 You can include literal examples that should not be subjected to
8800 markup. Such examples will be typeset in monospace, so this is well suited
8801 for source code and similar examples.
8802 @cindex #+BEGIN_EXAMPLE
8806 Some example from a text file.
8810 Note that such blocks may be @i{indented} in order to align nicely with
8811 indented text and in particular with plain list structure (@pxref{Plain
8812 lists}). For simplicity when using small examples, you can also start the
8813 example lines with a colon followed by a space. There may also be additional
8814 whitespace before the colon:
8818 : Some example from a text file.
8821 @cindex formatting source code, markup rules
8822 If the example is source code from a programming language, or any other text
8823 that can be marked up by font-lock in Emacs, you can ask for the example to
8824 look like the fontified Emacs buffer@footnote{This works automatically for
8825 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
8826 which is distributed with Org). Fontified code chunks in LaTeX can be
8827 achieved using either the listings or the
8828 @url{http://code.google.com/p/minted, minted,} package. To use listings, turn
8829 on the variable @code{org-export-latex-listings} and ensure that the listings
8830 package is included by the LaTeX header (e.g.@: by configuring
8831 @code{org-export-latex-packages-alist}). See the listings documentation for
8832 configuration options, including obtaining colored output. For minted it is
8833 necessary to install the program @url{http://pygments.org, pygments}, in
8834 addition to setting @code{org-export-latex-minted}, ensuring that the minted
8835 package is included by the LaTeX header, and ensuring that the
8836 @code{-shell-escape} option is passed to @file{pdflatex} (see
8837 @code{org-latex-to-pdf-process}). See the documentation of the variables
8838 @code{org-export-latex-listings} and @code{org-export-latex-minted} for
8839 further details.}. This is done with the @samp{src} block, where you also
8840 need to specify the name of the major mode that should be used to fontify the
8845 #+BEGIN_SRC emacs-lisp
8846 (defun org-xor (a b)
8852 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
8853 switch to the end of the @code{BEGIN} line, to get the lines of the example
8854 numbered. If you use a @code{+n} switch, the numbering from the previous
8855 numbered snippet will be continued in the current one. In literal examples,
8856 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
8857 targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
8858 enclosed in single parenthesis). In HTML, hovering the mouse over such a
8859 link will remote-highlight the corresponding code line, which is kind of
8862 You can also add a @code{-r} switch which @i{removes} the labels from the
8863 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
8864 labels in the source code while using line numbers for the links, which might
8865 be useful to explain those in an org-mode example code.}. With the @code{-n}
8866 switch, links to these references will be labeled by the line numbers from
8867 the code listing, otherwise links will use the labels with no parentheses.
8871 #+BEGIN_SRC emacs-lisp -n -r
8872 (save-excursion (ref:sc)
8873 (goto-char (point-min)) (ref:jump)
8875 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
8879 @vindex org-coderef-label-format
8880 If the syntax for the label format conflicts with the language syntax, use a
8881 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
8882 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
8884 HTML export also allows examples to be published as text areas, @xref{Text
8885 areas in HTML export}.
8890 Edit the source code example at point in its native mode. This works by
8891 switching to a temporary buffer with the source code. You need to exit by
8892 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
8893 or @samp{#} will get a comma prepended, to keep them from being interpreted
8894 by Org as outline nodes or special comments. These commas will be stripped
8895 for editing with @kbd{C-c '}, and also for export.}. The edited version will
8896 then replace the old version in the Org buffer. Fixed-width regions
8897 (where each line starts with a colon followed by a space) will be edited
8898 using @code{artist-mode}@footnote{You may select a different-mode with the
8899 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
8900 drawings easily. Using this command in an empty line will create a new
8904 Calling @code{org-store-link} while editing a source code example in a
8905 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
8906 that it is unique in the current buffer, and insert it with the proper
8907 formatting like @samp{(ref:label)} at the end of the current line. Then the
8908 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
8912 @node Include files, Index entries, Literal examples, Markup
8913 @section Include files
8914 @cindex include files, markup rules
8916 During export, you can include the content of another file. For example, to
8917 include your @file{.emacs} file, you could use:
8921 #+INCLUDE: "~/.emacs" src emacs-lisp
8924 The optional second and third parameter are the markup (e.g.@: @samp{quote},
8925 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
8926 language for formatting the contents. The markup is optional; if it is not
8927 given, the text will be assumed to be in Org-mode format and will be
8928 processed normally. The include line will also allow additional keyword
8929 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
8930 first line and for each following line, @code{:minlevel} in order to get
8931 org-mode content demoted to a specified level, as well as any options
8932 accepted by the selected markup. For example, to include a file as an item,
8936 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
8939 You can also include a portion of a file by specifying a lines range using
8940 the @code{:lines} parameter. The line at the upper end of the range will not
8941 be included. The start and/or the end of the range may be omitted to use the
8945 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
8946 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
8947 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
8953 Visit the include file at point.
8956 @node Index entries, Macro replacement, Include files, Markup
8957 @section Index entries
8958 @cindex index entries, for publishing
8960 You can specify entries that will be used for generating an index during
8961 publishing. This is done by lines starting with @code{#+INDEX}. An entry
8962 the contains an exclamation mark will create a sub item. See @ref{Generating
8963 an index} for more information.
8968 #+INDEX: Application!CV
8974 @node Macro replacement, Embedded LaTeX, Index entries, Markup
8975 @section Macro replacement
8976 @cindex macro replacement, during export
8979 You can define text snippets with
8982 #+MACRO: name replacement text $1, $2 are arguments
8985 @noindent which can be referenced anywhere in the document (even in
8986 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
8987 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
8988 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
8989 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
8990 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
8991 and to the modification time of the file being exported, respectively.
8992 @var{FORMAT} should be a format string understood by
8993 @code{format-time-string}.
8995 Macro expansion takes place during export, and some people use it to
8996 construct complex HTML code.
8999 @node Embedded LaTeX, , Macro replacement, Markup
9000 @section Embedded @LaTeX{}
9001 @cindex @TeX{} interpretation
9002 @cindex @LaTeX{} interpretation
9004 Plain ASCII is normally sufficient for almost all note taking. Exceptions
9005 include scientific notes, which often require mathematical symbols and the
9006 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9007 Donald E. Knuth's @TeX{} system. Many of the features described here as
9008 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9009 distinction.} is widely used to typeset scientific documents. Org-mode
9010 supports embedding @LaTeX{} code into its files, because many academics are
9011 used to writing and reading @LaTeX{} source code, and because it can be
9012 readily processed to produce pretty output for a number of export backends.
9015 * Special symbols:: Greek letters and other symbols
9016 * Subscripts and superscripts:: Simple syntax for raising/lowering text
9017 * LaTeX fragments:: Complex formulas made easy
9018 * Previewing LaTeX fragments:: What will this snippet look like?
9019 * CDLaTeX mode:: Speed up entering of formulas
9022 @node Special symbols, Subscripts and superscripts, Embedded LaTeX, Embedded LaTeX
9023 @subsection Special symbols
9024 @cindex math symbols
9025 @cindex special symbols
9026 @cindex @TeX{} macros
9027 @cindex @LaTeX{} fragments, markup rules
9028 @cindex HTML entities
9029 @cindex @LaTeX{} entities
9031 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
9032 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
9033 for these macros is available, just type @samp{\} and maybe a few letters,
9034 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
9035 code, Org-mode allows these macros to be present without surrounding math
9036 delimiters, for example:
9039 Angles are written as Greek letters \alpha, \beta and \gamma.
9042 @vindex org-entities
9043 During export, these symbols will be transformed into the native format of
9044 the exporter backend. Strings like @code{\alpha} will be exported as
9045 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9046 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
9047 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
9048 like this: @samp{\Aacute@{@}stor}.
9050 A large number of entities is provided, with names taken from both HTML and
9051 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9052 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9053 @samp{...} are all converted into special commands creating hyphens of
9054 different lengths or a compact set of dots.
9056 If you would like to see entities displayed as UTF8 characters, use the
9057 following command@footnote{You can turn this on by default by setting the
9058 variable @code{org-pretty-entities}, or on a per-file base with the
9059 @code{#+STARTUP} option @code{entitiespretty}.}:
9064 Toggle display of entities as UTF-8 characters. This does not change the
9065 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9066 for display purposes only.
9069 @node Subscripts and superscripts, LaTeX fragments, Special symbols, Embedded LaTeX
9070 @subsection Subscripts and superscripts
9074 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9075 and subscripts. Again, these can be used without embedding them in
9076 math-mode delimiters. To increase the readability of ASCII text, it is
9077 not necessary (but OK) to surround multi-character sub- and superscripts
9078 with curly braces. For example
9081 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9082 the sun is R_@{sun@} = 6.96 x 10^8 m.
9085 @vindex org-export-with-sub-superscripts
9086 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9087 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9088 where the underscore is often used in a different context, Org's convention
9089 to always interpret these as subscripts can get in your way. Configure the
9090 variable @code{org-export-with-sub-superscripts} to globally change this
9091 convention, or use, on a per-file basis:
9097 @noindent With this setting, @samp{a_b} will not be interpreted as a
9098 subscript, but @samp{a_@{b@}} will.
9103 In addition to showing entities as UTF-8 characters, this command will also
9104 format sub- and superscripts in a WYSIWYM way.
9107 @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX
9108 @subsection @LaTeX{} fragments
9109 @cindex @LaTeX{} fragments
9111 @vindex org-format-latex-header
9112 Going beyond symbols and sub- and superscripts, a full formula language is
9113 needed. Org-mode can contain @LaTeX{} math fragments, and it supports ways
9114 to process these for several export backends. When exporting to @LaTeX{},
9115 the code is obviously left as it is. When exporting to HTML, Org invokes the
9116 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9117 HTML export}) to process and display the math@footnote{If you plan to use
9118 this regularly or on pages with significant page views, you should install
9119 @file{MathJax} on your own
9120 server in order to limit the load of our server.}. Finally, it can also
9121 process the mathematical expressions into images@footnote{For this to work
9122 you need to be on a system with a working @LaTeX{} installation. You also
9123 need the @file{dvipng} program, available at
9124 @url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will
9125 be used when processing a fragment can be configured with the variable
9126 @code{org-format-latex-header}.} that can be displayed in a browser or in
9129 @LaTeX{} fragments don't need any special marking at all. The following
9130 snippets will be identified as @LaTeX{} source code:
9133 Environments of any kind@footnote{When @file{MathJax} is used, only the
9134 environment recognized by @file{MathJax} will be processed. When
9135 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9136 handled.}. The only requirement is that the @code{\begin} statement appears
9137 on a new line, preceded by only whitespace.
9139 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9140 currency specifications, single @samp{$} characters are only recognized as
9141 math delimiters if the enclosed text contains at most two line breaks, is
9142 directly attached to the @samp{$} characters with no whitespace in between,
9143 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9144 For the other delimiters, there is no such restriction, so when in doubt, use
9145 @samp{\(...\)} as inline math delimiters.
9148 @noindent For example:
9151 \begin@{equation@} % arbitrary environments,
9152 x=\sqrt@{b@} % even tables, figures
9153 \end@{equation@} % etc
9155 If $a^2=b$ and \( b=2 \), then the solution must be
9156 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9160 @vindex org-format-latex-options
9161 If you need any of the delimiter ASCII sequences for other purposes, you
9162 can configure the option @code{org-format-latex-options} to deselect the
9163 ones you do not wish to have interpreted by the @LaTeX{} converter.
9165 @vindex org-export-with-LaTeX-fragments
9166 LaTeX processing can be configured with the variable
9167 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9168 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9169 LaTeX backends. You can also set this variable on a per-file basis using one
9173 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9174 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9175 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9176 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9179 @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX
9180 @subsection Previewing LaTeX fragments
9181 @cindex LaTeX fragments, preview
9183 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9184 produce preview images of the typeset expressions:
9189 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9190 over the source code. If there is no fragment at point, process all
9191 fragments in the current entry (between two headlines). When called
9192 with a prefix argument, process the entire subtree. When called with
9193 two prefix arguments, or when the cursor is before the first headline,
9194 process the entire buffer.
9197 Remove the overlay preview images.
9200 @vindex org-format-latex-options
9201 You can customize the variable @code{org-format-latex-options} to influence
9202 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9203 export, @code{:html-scale}) property can be used to adjust the size of the
9206 @node CDLaTeX mode, , Previewing LaTeX fragments, Embedded LaTeX
9207 @subsection Using CDLa@TeX{} to enter math
9210 CDLa@TeX{} mode is a minor mode that is normally used in combination with a
9211 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9212 environments and math templates. Inside Org-mode, you can make use of
9213 some of the features of CDLa@TeX{} mode. You need to install
9214 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9215 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9216 Don't use CDLa@TeX{} mode itself under Org-mode, but use the light
9217 version @code{org-cdlatex-mode} that comes as part of Org-mode. Turn it
9218 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9222 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9225 When this mode is enabled, the following features are present (for more
9226 details see the documentation of CDLa@TeX{} mode):
9230 Environment templates can be inserted with @kbd{C-c @{}.
9233 The @key{TAB} key will do template expansion if the cursor is inside a
9234 @LaTeX{} fragment@footnote{Org-mode has a method to test if the cursor is
9235 inside such a fragment, see the documentation of the function
9236 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9237 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9238 correctly inside the first brace. Another @key{TAB} will get you into
9239 the second brace. Even outside fragments, @key{TAB} will expand
9240 environment abbreviations at the beginning of a line. For example, if
9241 you write @samp{equ} at the beginning of a line and press @key{TAB},
9242 this abbreviation will be expanded to an @code{equation} environment.
9243 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9247 @vindex cdlatex-simplify-sub-super-scripts
9248 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9249 characters together with a pair of braces. If you use @key{TAB} to move
9250 out of the braces, and if the braces surround only a single character or
9251 macro, they are removed again (depending on the variable
9252 @code{cdlatex-simplify-sub-super-scripts}).
9255 Pressing the backquote @kbd{`} followed by a character inserts math
9256 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9257 after the backquote, a help window will pop up.
9260 Pressing the single-quote @kbd{'} followed by another character modifies
9261 the symbol before point with an accent or a font. If you wait more than
9262 1.5 seconds after the single-quote, a help window will pop up. Character
9263 modification will work only inside @LaTeX{} fragments; outside the quote
9267 @node Exporting, Publishing, Markup, Top
9271 Org-mode documents can be exported into a variety of other formats. For
9272 printing and sharing of notes, ASCII export produces a readable and simple
9273 version of an Org file. HTML export allows you to publish a notes file on
9274 the web, while the XOXO format provides a solid base for exchange with a
9275 broad range of other applications. @LaTeX{} export lets you use Org-mode and
9276 its structured editing functions to easily create @LaTeX{} files. DocBook
9277 export makes it possible to convert Org files to many other formats using
9278 DocBook tools. For project management you can create gantt and resource
9279 charts by using TaskJuggler export. To incorporate entries with associated
9280 times like deadlines or appointments into a desktop calendar program like
9281 iCal, Org-mode can also produce extracts in the iCalendar format. Currently
9282 Org-mode only supports export, not import of these different formats.
9284 Org supports export of selected regions when @code{transient-mark-mode} is
9285 enabled (default in Emacs 23).
9288 * Selective export:: Using tags to select and exclude trees
9289 * Export options:: Per-file export settings
9290 * The export dispatcher:: How to access exporter commands
9291 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9292 * HTML export:: Exporting to HTML
9293 * LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9294 * DocBook export:: Exporting to DocBook
9295 * TaskJuggler export:: Exporting to TaskJuggler
9296 * Freemind export:: Exporting to Freemind mind maps
9297 * XOXO export:: Exporting to XOXO
9298 * iCalendar export:: Exporting in iCalendar format
9301 @node Selective export, Export options, Exporting, Exporting
9302 @section Selective export
9303 @cindex export, selective by tags
9305 @vindex org-export-select-tags
9306 @vindex org-export-exclude-tags
9307 You may use tags to select the parts of a document that should be exported,
9308 or to exclude parts from export. This behavior is governed by two variables:
9309 @code{org-export-select-tags} and @code{org-export-exclude-tags}.
9311 Org first checks if any of the @emph{select} tags is present in the buffer.
9312 If yes, all trees that do not carry one of these tags will be excluded. If a
9313 selected tree is a subtree, the heading hierarchy above it will also be
9314 selected for export, but not the text below those headings.
9317 If none of the select tags is found, the whole buffer will be selected for
9321 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9322 be removed from the export buffer.
9324 @node Export options, The export dispatcher, Selective export, Exporting
9325 @section Export options
9326 @cindex options, for export
9328 @cindex completion, of option keywords
9329 The exporter recognizes special lines in the buffer which provide
9330 additional information. These lines may be put anywhere in the file.
9331 The whole set of lines can be inserted into the buffer with @kbd{C-c
9332 C-e t}. For individual lines, a good way to make sure the keyword is
9333 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9334 (@pxref{Completion}). For a summary of other in-buffer settings not
9335 specifically related to export, see @ref{In-buffer settings}.
9336 In particular, note that you can place commonly-used (export) options in
9337 a separate file which can be included using @code{#+SETUPFILE}.
9340 @orgcmd{C-c C-e t,org-insert-export-options-template}
9341 Insert template with export options, see example below.
9348 @cindex #+DESCRIPTION
9356 @cindex #+EXPORT_SELECT_TAGS
9357 @cindex #+EXPORT_EXCLUDE_TAGS
9359 @cindex #+LATEX_HEADER
9360 @vindex user-full-name
9361 @vindex user-mail-address
9362 @vindex org-export-default-language
9364 #+TITLE: the title to be shown (default is the buffer name)
9365 #+AUTHOR: the author (default taken from @code{user-full-name})
9366 #+DATE: a date, fixed, or a format string for @code{format-time-string}
9367 #+EMAIL: his/her email address (default from @code{user-mail-address})
9368 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
9369 #+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
9370 #+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
9371 #+TEXT: Some descriptive text to be inserted at the beginning.
9372 #+TEXT: Several lines may be given.
9373 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9374 #+BIND: lisp-var lisp-val, e.g.@:: org-export-latex-low-levels itemize
9375 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9376 #+LINK_UP: the ``up'' link of an exported page
9377 #+LINK_HOME: the ``home'' link of an exported page
9378 #+LATEX_HEADER: extra line(s) for the LaTeX header, like \usepackage@{xyz@}
9379 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9380 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9381 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9385 The OPTIONS line is a compact@footnote{If you want to configure many options
9386 this way, you can use several OPTIONS lines.} form to specify export
9387 settings. Here you can:
9388 @cindex headline levels
9389 @cindex section-numbers
9390 @cindex table of contents
9391 @cindex line-break preservation
9392 @cindex quoted HTML tags
9393 @cindex fixed-width sections
9395 @cindex @TeX{}-like syntax for sub- and superscripts
9397 @cindex special strings
9398 @cindex emphasized text
9399 @cindex @TeX{} macros
9400 @cindex @LaTeX{} fragments
9401 @cindex author info, in export
9402 @cindex time info, in export
9404 H: @r{set the number of headline levels for export}
9405 num: @r{turn on/off section-numbers}
9406 toc: @r{turn on/off table of contents, or set level limit (integer)}
9407 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9408 @@: @r{turn on/off quoted HTML tags}
9409 :: @r{turn on/off fixed-width sections}
9410 |: @r{turn on/off tables}
9411 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9412 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9413 @r{the simple @code{a_b} will be left as it is.}
9414 -: @r{turn on/off conversion of special strings.}
9415 f: @r{turn on/off footnotes like this[1].}
9416 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9417 pri: @r{turn on/off priority cookies}
9418 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9419 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9420 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9421 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9422 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
9423 skip: @r{turn on/off skipping the text before the first heading}
9424 author: @r{turn on/off inclusion of author name/email into exported file}
9425 email: @r{turn on/off inclusion of author email into exported file}
9426 creator: @r{turn on/off inclusion of creator info into exported file}
9427 timestamp: @r{turn on/off inclusion creation time into exported file}
9428 d: @r{turn on/off inclusion of drawers}
9431 These options take effect in both the HTML and @LaTeX{} export, except for
9432 @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
9433 @code{nil} for the @LaTeX{} export.
9435 Setting @code{org-export-html-pre/postamble} to @code{t} will override the
9436 values of the @code{author}, @code{email} and @code{creator} options in HTML
9437 export: it will use @code{org-export-html-pre/postamble-format} instead.
9439 The default values for these and many other options are given by a set of
9440 variables. For a list of such variables, the corresponding OPTIONS keys and
9441 also the publishing keys (@pxref{Project alist}), see the constant
9442 @code{org-export-plist-vars}.
9444 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9445 calling an export command, the subtree can overrule some of the file's export
9446 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9447 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9448 @code{EXPORT_OPTIONS}.
9450 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9451 @section The export dispatcher
9452 @cindex dispatcher, for export commands
9454 All export commands can be reached using the export dispatcher, which is a
9455 prefix key that prompts for an additional key specifying the command.
9456 Normally the entire file is exported, but if there is an active region that
9457 contains one outline tree, the first heading is used as document title and
9458 the subtrees are exported.
9461 @orgcmd{C-c C-e,org-export}
9462 @vindex org-export-run-in-background
9463 Dispatcher for export and publishing commands. Displays a help-window
9464 listing the additional key(s) needed to launch an export or publishing
9465 command. The prefix arg is passed through to the exporter. A double prefix
9466 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9467 separate Emacs process@footnote{To make this behavior the default, customize
9468 the variable @code{org-export-run-in-background}.}.
9469 @orgcmd{C-c C-e v,org-export-visible}
9470 Like @kbd{C-c C-e}, but only export the text that is currently visible
9471 (i.e.@: not hidden by outline visibility).
9472 @orgcmd{C-u C-u C-c C-e,org-export}
9473 @vindex org-export-run-in-background
9474 Call the exporter, but reverse the setting of
9475 @code{org-export-run-in-background}, i.e.@: request background processing if
9476 not set, or force processing in the current Emacs process if set.
9479 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9480 @section ASCII/Latin-1/UTF-8 export
9481 @cindex ASCII export
9482 @cindex Latin-1 export
9483 @cindex UTF-8 export
9485 ASCII export produces a simple and very readable version of an Org-mode
9486 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9487 with special characters and symbols available in these encodings.
9489 @cindex region, active
9490 @cindex active region
9491 @cindex transient-mark-mode
9493 @orgcmd{C-c C-e a,org-export-as-ascii}
9494 @cindex property, EXPORT_FILE_NAME
9495 Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9496 will be @file{myfile.txt}. The file will be overwritten without
9497 warning. If there is an active region@footnote{This requires
9498 @code{transient-mark-mode} be turned on.}, only the region will be
9499 exported. If the selected region is a single tree@footnote{To select the
9500 current subtree, use @kbd{C-c @@}.}, the tree head will
9501 become the document title. If the tree head entry has or inherits an
9502 @code{EXPORT_FILE_NAME} property, that name will be used for the
9504 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9505 Export to a temporary buffer. Do not create a file.
9506 @orgcmd{C-c C-e n,org-export-as-latin1}
9507 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
9508 Like the above commands, but use Latin-1 encoding.
9509 @orgcmd{C-c C-e u,org-export-as-utf8}
9510 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
9511 Like the above commands, but use UTF-8 encoding.
9512 @item C-c C-e v a/n/u
9513 Export only the visible part of the document.
9516 @cindex headline levels, for exporting
9517 In the exported version, the first 3 outline levels will become
9518 headlines, defining a general document structure. Additional levels
9519 will be exported as itemized lists. If you want that transition to occur
9520 at a different level, specify it with a prefix argument. For example,
9527 creates only top level headlines and does the rest as items. When
9528 headlines are converted to items, the indentation of the text following
9529 the headline is changed to fit nicely under the item. This is done with
9530 the assumption that the first body line indicates the base indentation of
9531 the body text. Any indentation larger than this is adjusted to preserve
9532 the layout relative to the first line. Should there be lines with less
9533 indentation than the first, these are left alone.
9535 @vindex org-export-ascii-links-to-notes
9536 Links will be exported in a footnote-like style, with the descriptive part in
9537 the text and the link in a note before the next heading. See the variable
9538 @code{org-export-ascii-links-to-notes} for details and other options.
9540 @node HTML export, LaTeX and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
9541 @section HTML export
9544 Org-mode contains an HTML (XHTML 1.0 strict) exporter with extensive
9545 HTML formatting, in ways similar to John Gruber's @emph{markdown}
9546 language, but with additional support for tables.
9549 * HTML Export commands:: How to invoke HTML export
9550 * Quoting HTML tags:: Using direct HTML in Org-mode
9551 * Links in HTML export:: How links will be interpreted and formatted
9552 * Tables in HTML export:: How to modify the formatting of tables
9553 * Images in HTML export:: How to insert figures into HTML output
9554 * Math formatting in HTML export:: Beautiful math also on the web
9555 * Text areas in HTML export:: An alternative way to show an example
9556 * CSS support:: Changing the appearance of the output
9557 * JavaScript support:: Info and Folding in a web browser
9560 @node HTML Export commands, Quoting HTML tags, HTML export, HTML export
9561 @subsection HTML export commands
9563 @cindex region, active
9564 @cindex active region
9565 @cindex transient-mark-mode
9567 @orgcmd{C-c C-e h,org-export-as-html}
9568 @cindex property, EXPORT_FILE_NAME
9569 Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
9570 the ASCII file will be @file{myfile.html}. The file will be overwritten
9571 without warning. If there is an active region@footnote{This requires
9572 @code{transient-mark-mode} be turned on.}, only the region will be
9573 exported. If the selected region is a single tree@footnote{To select the
9574 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9575 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
9576 property, that name will be used for the export.
9577 @orgcmd{C-c C-e b,org-export-as-html-and-open}
9578 Export as HTML file and immediately open it with a browser.
9579 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
9580 Export to a temporary buffer. Do not create a file.
9581 @orgcmd{C-c C-e R,org-export-region-as-html}
9582 Export the active region to a temporary buffer. With a prefix argument, do
9583 not produce the file header and footer, but just the plain HTML section for
9584 the region. This is good for cut-and-paste operations.
9585 @item C-c C-e v h/b/H/R
9586 Export only the visible part of the document.
9587 @item M-x org-export-region-as-html
9588 Convert the region to HTML under the assumption that it was Org-mode
9589 syntax before. This is a global command that can be invoked in any
9591 @item M-x org-replace-region-by-HTML
9592 Replace the active region (assumed to be in Org-mode syntax) by HTML
9596 @cindex headline levels, for exporting
9597 In the exported version, the first 3 outline levels will become headlines,
9598 defining a general document structure. Additional levels will be exported as
9599 itemized lists. If you want that transition to occur at a different level,
9600 specify it with a numeric prefix argument. For example,
9607 creates two levels of headings and does the rest as items.
9609 @node Quoting HTML tags, Links in HTML export, HTML Export commands, HTML export
9610 @subsection Quoting HTML tags
9612 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
9613 @samp{>} in HTML export. If you want to include simple HTML tags
9614 which should be interpreted as such, mark them with @samp{@@} as in
9615 @samp{@@<b>bold text@@</b>}. Note that this really works only for
9616 simple tags. For more extensive HTML that should be copied verbatim to
9617 the exported file use either
9620 @cindex #+BEGIN_HTML
9622 #+HTML: Literal HTML code for export
9626 @cindex #+BEGIN_HTML
9630 All lines between these markers are exported literally
9635 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
9636 @subsection Links in HTML export
9638 @cindex links, in HTML export
9639 @cindex internal links, in HTML export
9640 @cindex external links, in HTML export
9641 Internal links (@pxref{Internal links}) will continue to work in HTML. This
9642 includes automatic links created by radio targets (@pxref{Radio
9643 targets}). Links to external files will still work if the target file is on
9644 the same @i{relative} path as the published Org file. Links to other
9645 @file{.org} files will be translated into HTML links under the assumption
9646 that an HTML version also exists of the linked file, at the same relative
9647 path. @samp{id:} links can then be used to jump to specific entries across
9648 files. For information related to linking files while publishing them to a
9649 publishing directory see @ref{Publishing links}.
9651 If you want to specify attributes for links, you can do so using a special
9652 @code{#+ATTR_HTML} line to define attributes that will be added to the
9653 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
9654 and @code{style} attributes for a link:
9658 #+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
9659 [[http://orgmode.org]]
9662 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
9664 @cindex tables, in HTML
9665 @vindex org-export-html-table-tag
9667 Org-mode tables are exported to HTML using the table tag defined in
9668 @code{org-export-html-table-tag}. The default setting makes tables without
9669 cell borders and frame. If you would like to change this for individual
9670 tables, place something like the following before the table:
9675 #+CAPTION: This is a table with lines around and between cells
9676 #+ATTR_HTML: border="2" rules="all" frame="all"
9679 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
9680 @subsection Images in HTML export
9682 @cindex images, inline in HTML
9683 @cindex inlining images in HTML
9684 @vindex org-export-html-inline-images
9685 HTML export can inline images given as links in the Org file, and
9686 it can make an image the clickable part of a link. By
9687 default@footnote{But see the variable
9688 @code{org-export-html-inline-images}.}, images are inlined if a link does
9689 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
9690 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
9691 @samp{the image} that points to the image. If the description part
9692 itself is a @code{file:} link or a @code{http:} URL pointing to an
9693 image, this image will be inlined and activated so that clicking on the
9694 image will activate the link. For example, to include a thumbnail that
9695 will link to a high resolution version of the image, you could use:
9698 [[file:highres.jpg][file:thumb.jpg]]
9701 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
9702 In the example below we specify the @code{alt} and @code{title} attributes to
9703 support text viewers and accessibility, and align it to the right.
9708 #+CAPTION: A black cat stalking a spider
9709 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
9714 and you could use @code{http} addresses just as well.
9716 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
9717 @subsection Math formatting in HTML export
9721 @LaTeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two
9722 different ways on HTML pages. The default is to use the
9723 @uref{http://www.mathjax.org, MathJax system} which should work out of the
9724 box with Org mode installation because @code{http://orgmode.org} serves
9725 @file{MathJax} for Org-mode users for small applications and for testing
9726 purposes. @b{If you plan to use this regularly or on pages with significant
9727 page views, you should install@footnote{Installation instructions can be
9728 found on the MathJax website, see
9729 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
9730 your own server in order to limit the load of our server.} To configure
9731 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
9732 insert something like the following into the buffer:
9735 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
9738 @noindent See the docstring of the variable
9739 @code{org-export-html-mathjax-options} for the meaning of the parameters in
9742 If you prefer, you can also request that @LaTeX{} fragments are processed
9743 into small images that will be inserted into the browser page. Before the
9744 availability of MathJax, this was the default method for Org files. This
9745 method requires that the @file{dvipng} program is available on your system.
9746 You can still get this processing with
9749 #+OPTIONS: LaTeX:dvipng
9752 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
9753 @subsection Text areas in HTML export
9755 @cindex text areas, in HTML
9756 An alternative way to publish literal code examples in HTML is to use text
9757 areas, where the example can even be edited before pasting it into an
9758 application. It is triggered by a @code{-t} switch at an @code{example} or
9759 @code{src} block. Using this switch disables any options for syntax and
9760 label highlighting, and line numbering, which may be present. You may also
9761 use @code{-h} and @code{-w} switches to specify the height and width of the
9762 text area, which default to the number of lines in the example, and 80,
9763 respectively. For example
9766 #+BEGIN_EXAMPLE -t -w 40
9767 (defun org-xor (a b)
9774 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
9775 @subsection CSS support
9776 @cindex CSS, for HTML export
9777 @cindex HTML export, CSS
9779 @vindex org-export-html-todo-kwd-class-prefix
9780 @vindex org-export-html-tag-class-prefix
9781 You can also give style information for the exported file. The HTML exporter
9782 assigns the following special CSS classes@footnote{If the classes on TODO
9783 keywords and tags lead to conflicts, use the variables
9784 @code{org-export-html-todo-kwd-class-prefix} and
9785 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
9786 parts of the document---your style specifications may change these, in
9787 addition to any of the standard classes like for headlines, tables, etc.
9789 p.author @r{author information, including email}
9790 p.date @r{publishing date}
9791 p.creator @r{creator info, about org-mode version}
9792 .title @r{document title}
9793 .todo @r{TODO keywords, all not-done states}
9794 .done @r{the DONE keywords, all states that count as done}
9795 .WAITING @r{each TODO keyword also uses a class named after itself}
9796 .timestamp @r{timestamp}
9797 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
9798 .timestamp-wrapper @r{span around keyword plus timestamp}
9799 .tag @r{tag in a headline}
9800 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
9801 .target @r{target for links}
9802 .linenr @r{the line number in a code example}
9803 .code-highlighted @r{for highlighting referenced code lines}
9804 div.outline-N @r{div for outline level N (headline plus text))}
9805 div.outline-text-N @r{extra div for text at outline level N}
9806 .section-number-N @r{section number in headlines, different for each level}
9807 div.figure @r{how to format an inlined image}
9808 pre.src @r{formatted source code}
9809 pre.example @r{normal example}
9810 p.verse @r{verse paragraph}
9811 div.footnotes @r{footnote section headline}
9812 p.footnote @r{footnote definition paragraph, containing a footnote}
9813 .footref @r{a footnote reference number (always a <sup>)}
9814 .footnum @r{footnote number in footnote definition (always <sup>)}
9817 @vindex org-export-html-style-default
9818 @vindex org-export-html-style-include-default
9819 @vindex org-export-html-style
9820 @vindex org-export-html-extra
9821 @vindex org-export-html-style-default
9822 Each exported file contains a compact default style that defines these
9823 classes in a basic way@footnote{This style is defined in the constant
9824 @code{org-export-html-style-default}, which you should not modify. To turn
9825 inclusion of these defaults off, customize
9826 @code{org-export-html-style-include-default}}. You may overwrite these
9827 settings, or add to them by using the variables @code{org-export-html-style}
9828 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
9829 fine-grained settings, like file-local settings). To set the latter variable
9830 individually for each file, you can use
9834 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
9838 For longer style definitions, you can use several such lines. You could also
9839 directly write a @code{<style>} @code{</style>} section in this way, without
9840 referring to an external file.
9842 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
9843 property to assign a class to the tree. In order to specify CSS styles for a
9844 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
9847 @c FIXME: More about header and footer styles
9848 @c FIXME: Talk about links and targets.
9850 @node JavaScript support, , CSS support, HTML export
9851 @subsection JavaScript supported display of web pages
9853 @cindex Rose, Sebastian
9854 Sebastian Rose has written a JavaScript program especially designed to
9855 enhance the web viewing experience of HTML files created with Org. This
9856 program allows you to view large files in two different ways. The first one
9857 is an @emph{Info}-like mode where each section is displayed separately and
9858 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
9859 as well, press @kbd{?} for an overview of the available keys). The second
9860 view type is a @emph{folding} view much like Org provides inside Emacs. The
9861 script is available at @url{http://orgmode.org/org-info.js} and you can find
9862 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
9863 We host the script at our site, but if you use it a lot, you might
9864 not want to be dependent on @url{orgmode.org} and prefer to install a local
9865 copy on your own web server.
9867 To use the script, you need to make sure that the @file{org-jsinfo.el} module
9868 gets loaded. It should be loaded by default, but you can try @kbd{M-x
9869 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
9870 this is indeed the case. All it then takes to make use of the program is
9871 adding a single line to the Org file:
9873 @cindex #+INFOJS_OPT
9875 #+INFOJS_OPT: view:info toc:nil
9879 If this line is found, the HTML header will automatically contain the code
9880 needed to invoke the script. Using the line above, you can set the following
9884 path: @r{The path to the script. The default is to grab the script from}
9885 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
9886 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
9887 view: @r{Initial view when website is first shown. Possible values are:}
9888 info @r{Info-like interface with one section per page.}
9889 overview @r{Folding interface, initially showing only top-level.}
9890 content @r{Folding interface, starting with all headlines visible.}
9891 showall @r{Folding interface, all headlines and text visible.}
9892 sdepth: @r{Maximum headline level that will still become an independent}
9893 @r{section for info and folding modes. The default is taken from}
9894 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
9895 @r{If this is smaller than in @code{org-export-headline-levels}, each}
9896 @r{info/folding section can still contain child headlines.}
9897 toc: @r{Should the table of contents @emph{initially} be visible?}
9898 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
9899 tdepth: @r{The depth of the table of contents. The defaults are taken from}
9900 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
9901 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
9902 @r{If yes, the toc will never be displayed as a section.}
9903 ltoc: @r{Should there be short contents (children) in each section?}
9904 @r{Make this @code{above} if the section should be above initial text.}
9905 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
9906 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
9907 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
9908 @r{default), only one such button will be present.}
9911 @vindex org-infojs-options
9912 @vindex org-export-html-use-infojs
9913 You can choose default values for these options by customizing the variable
9914 @code{org-infojs-options}. If you always want to apply the script to your
9915 pages, configure the variable @code{org-export-html-use-infojs}.
9917 @node LaTeX and PDF export, DocBook export, HTML export, Exporting
9918 @section @LaTeX{} and PDF export
9919 @cindex @LaTeX{} export
9921 @cindex Guerry, Bastien
9923 Org-mode contains a @LaTeX{} exporter written by Bastien Guerry. With
9924 further processing@footnote{The default LaTeX output is designed for
9925 processing with pdftex or latex. It includes packages that are not
9926 compatible with xetex and possibly luatex. See the variables
9927 @code{org-export-latex-default-packages-alist} and
9928 @code{org-export-latex-packages-alist}.}, this backend is also used to
9929 produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
9930 implement links and cross references, the PDF output file will be fully
9931 linked. Beware of the fact that your @code{org} file has to be properly
9932 structured in order to be correctly exported: respect the hierarchy of
9936 * LaTeX/PDF export commands:: Which key invokes which commands
9937 * Header and sectioning:: Setting up the export file structure
9938 * Quoting LaTeX code:: Incorporating literal @LaTeX{} code
9939 * Tables in LaTeX export:: Options for exporting tables to @LaTeX{}
9940 * Images in LaTeX export:: How to insert figures into @LaTeX{} output
9941 * Beamer class export:: Turning the file into a presentation
9944 @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export
9945 @subsection @LaTeX{} export commands
9947 @cindex region, active
9948 @cindex active region
9949 @cindex transient-mark-mode
9951 @orgcmd{C-c C-e l,org-export-as-latex}
9952 @cindex property EXPORT_FILE_NAME
9953 Export as @LaTeX{} file @file{myfile.tex}. For an Org file
9954 @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
9955 be overwritten without warning. If there is an active region@footnote{This
9956 requires @code{transient-mark-mode} be turned on.}, only the region will be
9957 exported. If the selected region is a single tree@footnote{To select the
9958 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
9959 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
9960 property, that name will be used for the export.
9961 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
9962 Export to a temporary buffer. Do not create a file.
9964 Export only the visible part of the document.
9965 @item M-x org-export-region-as-latex
9966 Convert the region to @LaTeX{} under the assumption that it was Org-mode
9967 syntax before. This is a global command that can be invoked in any
9969 @item M-x org-replace-region-by-latex
9970 Replace the active region (assumed to be in Org-mode syntax) by @LaTeX{}
9972 @orgcmd{C-c C-e p,org-export-as-pdf}
9973 Export as @LaTeX{} and then process to PDF.
9974 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
9975 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
9978 @cindex headline levels, for exporting
9979 @vindex org-latex-low-levels
9980 In the exported version, the first 3 outline levels will become
9981 headlines, defining a general document structure. Additional levels
9982 will be exported as description lists. The exporter can ignore them or
9983 convert them to a custom string depending on
9984 @code{org-latex-low-levels}.
9986 If you want that transition to occur at a different level, specify it
9987 with a numeric prefix argument. For example,
9994 creates two levels of headings and does the rest as items.
9996 @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export
9997 @subsection Header and sectioning structure
9998 @cindex @LaTeX{} class
9999 @cindex @LaTeX{} sectioning structure
10000 @cindex @LaTeX{} header
10001 @cindex header, for LaTeX files
10002 @cindex sectioning structure, for LaTeX export
10004 By default, the @LaTeX{} output uses the class @code{article}.
10006 @vindex org-export-latex-default-class
10007 @vindex org-export-latex-classes
10008 @vindex org-export-latex-default-packages-alist
10009 @vindex org-export-latex-packages-alist
10010 @cindex #+LATEX_HEADER
10011 @cindex #+LATEX_CLASS
10012 @cindex #+LATEX_CLASS_OPTIONS
10013 @cindex property, LATEX_CLASS
10014 @cindex property, LATEX_CLASS_OPTIONS
10015 You can change this globally by setting a different value for
10016 @code{org-export-latex-default-class} or locally by adding an option like
10017 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
10018 property that applies when exporting a region containing only this (sub)tree.
10019 The class must be listed in @code{org-export-latex-classes}. This variable
10020 defines a header template for each class@footnote{Into which the values of
10021 @code{org-export-latex-default-packages-alist} and
10022 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
10023 define the sectioning structure for each class. You can also define your own
10024 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{LaTeX_CLASS_OPTIONS}
10025 property can specify the options for the @code{\documentclass} macro. You
10026 can also use @code{#+LATEX_HEADER: \usepackage@{xyz@}} to add lines to the
10027 header. See the docstring of @code{org-export-latex-classes} for more
10030 @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export
10031 @subsection Quoting @LaTeX{} code
10033 Embedded @LaTeX{} as described in @ref{Embedded LaTeX}, will be correctly
10034 inserted into the @LaTeX{} file. This includes simple macros like
10035 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
10036 you can add special code that should only be present in @LaTeX{} export with
10037 the following constructs:
10040 @cindex #+BEGIN_LaTeX
10042 #+LaTeX: Literal LaTeX code for export
10046 @cindex #+BEGIN_LaTeX
10050 All lines between these markers are exported literally
10055 @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export
10056 @subsection Tables in @LaTeX{} export
10057 @cindex tables, in @LaTeX{} export
10059 For @LaTeX{} export of a table, you can specify a label and a caption
10060 (@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to
10061 request a @code{longtable} environment for the table, so that it may span
10062 several pages, or to change the default table environment from @code{table}
10063 to @code{table*} or to change the default inner tabular environment to
10064 @code{tabularx} or @code{tabulary}. Finally, you can set the alignment
10065 string, and (with @code{tabularx} or @code{tabulary}) the width:
10069 @cindex #+ATTR_LaTeX
10071 #+CAPTION: A long table
10073 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10078 or to specify a multicolumn table with @code{tabulary}
10082 @cindex #+ATTR_LaTeX
10084 #+CAPTION: A wide table with tabulary
10086 #+ATTR_LaTeX: table* tabulary width=\textwidth
10091 @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export
10092 @subsection Images in @LaTeX{} export
10093 @cindex images, inline in @LaTeX{}
10094 @cindex inlining images in @LaTeX{}
10096 Images that are linked to without a description part in the link, like
10097 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10098 output file resulting from @LaTeX{} processing. Org will use an
10099 @code{\includegraphics} macro to insert the image. If you have specified a
10100 caption and/or a label as described in @ref{Images and tables}, the figure
10101 will be wrapped into a @code{figure} environment and thus become a floating
10102 element. You can use an @code{#+ATTR_LaTeX:} line to specify the various
10103 options that can be used in the optional argument of the
10104 @code{\includegraphics} macro. To modify the placement option of the
10105 @code{figure} environment, add something like @samp{placement=[h!]} to the
10108 If you would like to let text flow around the image, add the word @samp{wrap}
10109 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10110 half of the page. To fine-tune, the @code{placement} field will be the set
10111 of additional arguments needed by the @code{wrapfigure} environment. Note
10112 that if you change the size of the image, you need to use compatible settings
10113 for @code{\includegraphics} and @code{wrapfigure}.
10117 @cindex #+ATTR_LaTeX
10119 #+CAPTION: The black-body emission of the disk around HR 4049
10120 #+LABEL: fig:SED-HR4049
10121 #+ATTR_LaTeX: width=5cm,angle=90
10122 [[./img/sed-hr4049.pdf]]
10124 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10128 If you need references to a label created in this way, write
10129 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10131 @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export
10132 @subsection Beamer class export
10134 The LaTeX class @file{beamer} allows production of high quality presentations
10135 using LaTeX and pdf processing. Org-mode has special support for turning an
10136 Org-mode file or tree into a @file{beamer} presentation.
10138 When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS:
10139 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10140 @code{beamer}, a special export mode will turn the file or tree into a beamer
10141 presentation. Any tree with not-too-deep level nesting should in principle be
10142 exportable as a beamer presentation. By default, the top-level entries (or
10143 the first level below the selected subtree heading) will be turned into
10144 frames, and the outline structure below this level will become itemize lists.
10145 You can also configure the variable @code{org-beamer-frame-level} to a
10146 different level---then the hierarchy above frames will produce the sectioning
10147 structure of the presentation.
10149 A template for useful in-buffer settings or properties can be inserted into
10150 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10151 things, this will install a column view format which is very handy for
10152 editing special properties used by beamer.
10154 You can influence the structure of the presentation using the following
10159 The environment that should be used to format this entry. Valid environments
10160 are defined in the constant @code{org-beamer-environments-default}, and you
10161 can define more in @code{org-beamer-environments-extra}. If this property is
10162 set, the entry will also get a @code{:B_environment:} tag to make this
10163 visible. This tag has no semantic meaning, it is only a visual aid.
10164 @item BEAMER_envargs
10165 The beamer-special arguments that should be used for the environment, like
10166 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10167 property is also set, something like @code{C[t]} can be added here as well to
10168 set an options argument for the implied @code{columns} environment.
10169 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10172 The width of a column that should start with this entry. If this property is
10173 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10174 Also this tag is only a visual aid. When this is a plain number, it will be
10175 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10176 that you have specified the units, like @samp{3cm}. The first such property
10177 in a frame will start a @code{columns} environment to surround the columns.
10178 This environment is closed when an entry has a @code{BEAMER_col} property
10179 with value 0 or 1, or automatically at the end of the frame.
10181 Additional commands that should be inserted after the environment has been
10182 opened. For example, when creating a frame, this can be used to specify
10186 Frames will automatically receive a @code{fragile} option if they contain
10187 source code that uses the verbatim environment. Special @file{beamer}
10188 specific code can be inserted using @code{#+BEAMER:} and
10189 @code{#+BEGIN_beamer...#+end_beamer} constructs, similar to other export
10190 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10191 in the presentation as well.
10193 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10194 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10195 into @code{\note@{...@}}. The former will include the heading as part of the
10196 note text, the latter will ignore the heading of that node. To simplify note
10197 generation, it is actually enough to mark the note with a @emph{tag} (either
10198 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10199 @code{BEAMER_env} property.
10201 You can turn on a special minor mode @code{org-beamer-mode} for editing
10209 @orgcmd{C-c C-b,org-beamer-select-environment}
10210 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10211 environment or the @code{BEAMER_col} property.
10214 Column view provides a great way to set the environment of a node and other
10215 important parameters. Make sure you are using a COLUMN format that is geared
10216 toward this special purpose. The command @kbd{M-x
10217 org-insert-beamer-options-template} defines such a format.
10219 Here is a simple example Org document that is intended for beamer export.
10222 #+LaTeX_CLASS: beamer
10223 #+TITLE: Example Presentation
10224 #+AUTHOR: Carsten Dominik
10225 #+LaTeX_CLASS_OPTIONS: [presentation]
10226 #+BEAMER_FRAME_LEVEL: 2
10227 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10228 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10230 * This is the first structural section
10232 ** Frame 1 \\ with a subtitle
10233 *** Thanks to Eric Fraga :BMCOL:B_block:
10236 :BEAMER_envargs: C[t]
10239 for the first viable beamer setup in Org
10240 *** Thanks to everyone else :BMCOL:B_block:
10244 :BEAMER_envargs: <2->
10246 for contributing to the discussion
10247 **** This will be formatted as a beamer note :B_note:
10248 ** Frame 2 \\ where we will not use columns
10249 *** Request :B_block:
10250 Please test this stuff!
10256 For more information, see the documentation on Worg.
10258 @node DocBook export, TaskJuggler export, LaTeX and PDF export, Exporting
10259 @section DocBook export
10260 @cindex DocBook export
10262 @cindex Cui, Baoqiu
10264 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10265 exported to DocBook format, it can be further processed to produce other
10266 formats, including PDF, HTML, man pages, etc., using many available DocBook
10267 tools and stylesheets.
10269 Currently DocBook exporter only supports DocBook V5.0.
10272 * DocBook export commands:: How to invoke DocBook export
10273 * Quoting DocBook code:: Incorporating DocBook code in Org files
10274 * Recursive sections:: Recursive sections in DocBook
10275 * Tables in DocBook export:: Tables are exported as HTML tables
10276 * Images in DocBook export:: How to insert figures into DocBook output
10277 * Special characters:: How to handle special characters
10280 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10281 @subsection DocBook export commands
10283 @cindex region, active
10284 @cindex active region
10285 @cindex transient-mark-mode
10287 @orgcmd{C-c C-e D,org-export-as-docbook}
10288 @cindex property EXPORT_FILE_NAME
10289 Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10290 file will be @file{myfile.xml}. The file will be overwritten without
10291 warning. If there is an active region@footnote{This requires
10292 @code{transient-mark-mode} to be turned on}, only the region will be
10293 exported. If the selected region is a single tree@footnote{To select the
10294 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10295 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10296 property, that name will be used for the export.
10297 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10298 Export as DocBook file, process to PDF, then open the resulting PDF file.
10300 @vindex org-export-docbook-xslt-proc-command
10301 @vindex org-export-docbook-xsl-fo-proc-command
10302 Note that, in order to produce PDF output based on exported DocBook file, you
10303 need to have XSLT processor and XSL-FO processor software installed on your
10304 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10305 @code{org-export-docbook-xsl-fo-proc-command}.
10307 @vindex org-export-docbook-xslt-stylesheet
10308 The stylesheet argument @code{%s} in variable
10309 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10310 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10311 the user. You can also overrule this global setting on a per-file basis by
10312 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10314 @orgkey{C-c C-e v D}
10315 Export only the visible part of the document.
10318 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10319 @subsection Quoting DocBook code
10321 You can quote DocBook code in Org files and copy it verbatim into exported
10322 DocBook file with the following constructs:
10325 @cindex #+BEGIN_DOCBOOK
10327 #+DOCBOOK: Literal DocBook code for export
10331 @cindex #+BEGIN_DOCBOOK
10335 All lines between these markers are exported by DocBook exporter
10340 For example, you can use the following lines to include a DocBook warning
10341 admonition. As to what this warning says, you should pay attention to the
10342 document context when quoting DocBook code in Org files. You may make
10343 exported DocBook XML files invalid by not quoting DocBook code correctly.
10348 <para>You should know what you are doing when quoting DocBook XML code
10349 in your Org file. Invalid DocBook XML may be generated by
10350 DocBook exporter if you are not careful!</para>
10355 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10356 @subsection Recursive sections
10357 @cindex DocBook recursive sections
10359 DocBook exporter exports Org files as articles using the @code{article}
10360 element in DocBook. Recursive sections, i.e.@: @code{section} elements, are
10361 used in exported articles. Top level headlines in Org files are exported as
10362 top level sections, and lower level headlines are exported as nested
10363 sections. The entire structure of Org files will be exported completely, no
10364 matter how many nested levels of headlines there are.
10366 Using recursive sections makes it easy to port and reuse exported DocBook
10367 code in other DocBook document types like @code{book} or @code{set}.
10369 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10370 @subsection Tables in DocBook export
10371 @cindex tables, in DocBook export
10373 Tables in Org files are exported as HTML tables, which have been supported since
10376 If a table does not have a caption, an informal table is generated using the
10377 @code{informaltable} element; otherwise, a formal table will be generated
10378 using the @code{table} element.
10380 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10381 @subsection Images in DocBook export
10382 @cindex images, inline in DocBook
10383 @cindex inlining images in DocBook
10385 Images that are linked to without a description part in the link, like
10386 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10387 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10388 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10389 specified a caption for an image as described in @ref{Images and tables}, a
10390 @code{caption} element will be added in @code{mediaobject}. If a label is
10391 also specified, it will be exported as an @code{xml:id} attribute of the
10392 @code{mediaobject} element.
10394 @vindex org-export-docbook-default-image-attributes
10395 Image attributes supported by the @code{imagedata} element, like @code{align}
10396 or @code{width}, can be specified in two ways: you can either customize
10397 variable @code{org-export-docbook-default-image-attributes} or use the
10398 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10399 @code{org-export-docbook-default-image-attributes} are applied to all inline
10400 images in the Org file to be exported (unless they are overridden by image
10401 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10403 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10404 attributes or override default image attributes for individual images. If
10405 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10406 variable @code{org-export-docbook-default-image-attributes}, the former
10407 takes precedence. Here is an example about how image attributes can be
10412 @cindex #+ATTR_DOCBOOK
10414 #+CAPTION: The logo of Org-mode
10415 #+LABEL: unicorn-svg
10416 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10417 [[./img/org-mode-unicorn.svg]]
10420 @vindex org-export-docbook-inline-image-extensions
10421 By default, DocBook exporter recognizes the following image file types:
10422 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10423 customize variable @code{org-export-docbook-inline-image-extensions} to add
10424 more types to this list as long as DocBook supports them.
10426 @node Special characters, , Images in DocBook export, DocBook export
10427 @subsection Special characters in DocBook export
10428 @cindex Special characters in DocBook export
10430 @vindex org-export-docbook-doctype
10431 @vindex org-entities
10432 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10433 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10434 characters are rewritten to XML entities, like @code{α},
10435 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10436 @code{org-entities}. As long as the generated DocBook file includes the
10437 corresponding entities, these special characters are recognized.
10439 You can customize variable @code{org-export-docbook-doctype} to include the
10440 entities you need. For example, you can set variable
10441 @code{org-export-docbook-doctype} to the following value to recognize all
10442 special characters included in XHTML entities:
10445 "<!DOCTYPE article [
10446 <!ENTITY % xhtml1-symbol PUBLIC
10447 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
10448 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
10455 @node TaskJuggler export, Freemind export, DocBook export, Exporting
10456 @section TaskJuggler export
10457 @cindex TaskJuggler export
10458 @cindex Project management
10460 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
10461 It provides an optimizing scheduler that computes your project time lines and
10462 resource assignments based on the project outline and the constraints that
10465 The TaskJuggler exporter is a bit different from other exporters, such as the
10466 HTML and LaTeX exporters for example, in that it does not export all the
10467 nodes of a document or strictly follow the order of the nodes in the
10470 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
10471 a optionally tree that defines the resources for this project. It then
10472 creates a TaskJuggler file based on these trees and the attributes defined in
10475 @subsection TaskJuggler export commands
10478 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
10479 Export as TaskJuggler file.
10481 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
10482 Export as TaskJuggler file and then open the file with TaskJugglerUI.
10487 @vindex org-export-taskjuggler-project-tag
10488 Create your tasks as you usually do with Org-mode. Assign efforts to each
10489 task using properties (it's easiest to do this in the column view). You
10490 should end up with something similar to the example by Peter Jones in
10491 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
10492 Now mark the top node of your tasks with a tag named
10493 @code{:taskjuggler_project:} (or whatever you customized
10494 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
10495 the project plan with @kbd{C-c C-e J} which will export the project plan and
10496 open a gantt chart in TaskJugglerUI.
10498 @subsection Resources
10500 @vindex org-export-taskjuggler-resource-tag
10501 Next you can define resources and assign those to work on specific tasks. You
10502 can group your resources hierarchically. Tag the top node of the resources
10503 with @code{:taskjuggler_resource:} (or whatever you customized
10504 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
10505 identifier (named @samp{resource_id}) to the resources (using the standard
10506 Org properties commands, @pxref{Property syntax}) or you can let the exporter
10507 generate identifiers automatically (the exporter picks the first word of the
10508 headline as the identifier as long as it is unique---see the documentation of
10509 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
10510 allocate resources to tasks. This is again done with the @samp{allocate}
10511 property on the tasks. Do this in column view or when on the task type
10512 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
10514 Once the allocations are done you can again export to TaskJuggler and check
10515 in the Resource Allocation Graph which person is working on what task at what
10518 @subsection Export of properties
10520 The exporter also takes TODO state information into consideration, i.e.@: if a
10521 task is marked as done it will have the corresponding attribute in
10522 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
10523 resource or resource node which is known to TaskJuggler, such as
10524 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
10525 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
10526 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
10527 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
10528 @samp{scheduling}, etc for tasks.
10530 @subsection Dependencies
10532 The exporter will handle dependencies that are defined in the tasks either
10533 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
10534 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
10535 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
10536 attribute can be either @samp{previous-sibling} or a reference to an
10537 identifier (named @samp{task_id}) which is defined for another task in the
10538 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
10539 dependencies separated by either space or comma. You can also specify
10540 optional attributes on the dependency by simply appending it. The following
10541 examples should illustrate this:
10546 :task_id: preparation
10549 * Training material
10551 :task_id: training_material
10554 ** Markup Guidelines
10558 ** Workflow Guidelines
10565 :BLOCKER: training_material @{ gapduration 1d @} preparation
10569 @subsection Reports
10571 @vindex org-export-taskjuggler-default-reports
10572 TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
10573 allocation, etc). The user defines what kind of reports should be generated
10574 for a project in the TaskJuggler file. The exporter will automatically insert
10575 some default reports in the file. These defaults are defined in
10576 @code{org-export-taskjuggler-default-reports}. They can be modified using
10577 customize along with a number of other options. For a more complete list, see
10578 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
10580 For more information and examples see the Org-taskjuggler tutorial at
10581 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
10583 @node Freemind export, XOXO export, TaskJuggler export, Exporting
10584 @section Freemind export
10585 @cindex Freemind export
10588 The Freemind exporter was written by Lennart Borgman.
10591 @orgcmd{C-c C-e m,org-export-as-freemind}
10592 Export as Freemind mind map @file{myfile.mm}.
10595 @node XOXO export, iCalendar export, Freemind export, Exporting
10596 @section XOXO export
10597 @cindex XOXO export
10599 Org-mode contains an exporter that produces XOXO-style output.
10600 Currently, this exporter only handles the general outline structure and
10601 does not interpret any additional Org-mode features.
10604 @orgcmd{C-c C-e x,org-export-as-xoxo}
10605 Export as XOXO file @file{myfile.html}.
10606 @orgkey{C-c C-e v x}
10607 Export only the visible part of the document.
10610 @node iCalendar export, , XOXO export, Exporting
10611 @section iCalendar export
10612 @cindex iCalendar export
10614 @vindex org-icalendar-include-todo
10615 @vindex org-icalendar-use-deadline
10616 @vindex org-icalendar-use-scheduled
10617 @vindex org-icalendar-categories
10618 @vindex org-icalendar-alarm-time
10619 Some people use Org-mode for keeping track of projects, but still prefer a
10620 standard calendar application for anniversaries and appointments. In this
10621 case it can be useful to show deadlines and other time-stamped items in Org
10622 files in the calendar application. Org-mode can export calendar information
10623 in the standard iCalendar format. If you also want to have TODO entries
10624 included in the export, configure the variable
10625 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
10626 and TODO items as VTODO. It will also create events from deadlines that are
10627 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
10628 to set the start and due dates for the TODO entry@footnote{See the variables
10629 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
10630 As categories, it will use the tags locally defined in the heading, and the
10631 file/tree category@footnote{To add inherited tags or the TODO state,
10632 configure the variable @code{org-icalendar-categories}.}. See the variable
10633 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
10636 @vindex org-icalendar-store-UID
10637 @cindex property, ID
10638 The iCalendar standard requires each entry to have a globally unique
10639 identifier (UID). Org creates these identifiers during export. If you set
10640 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
10641 @code{:ID:} property of the entry and re-used next time you report this
10642 entry. Since a single entry can give rise to multiple iCalendar entries (as
10643 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
10644 prefixes to the UID, depending on what triggered the inclusion of the entry.
10645 In this way the UID remains unique, but a synchronization program can still
10646 figure out from which entry all the different instances originate.
10649 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
10650 Create iCalendar entries for the current file and store them in the same
10651 directory, using a file extension @file{.ics}.
10652 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
10653 @vindex org-agenda-files
10654 Like @kbd{C-c C-e i}, but do this for all files in
10655 @code{org-agenda-files}. For each of these files, a separate iCalendar
10656 file will be written.
10657 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
10658 @vindex org-combined-agenda-icalendar-file
10659 Create a single large iCalendar file from all files in
10660 @code{org-agenda-files} and write it to the file given by
10661 @code{org-combined-agenda-icalendar-file}.
10664 @vindex org-use-property-inheritance
10665 @vindex org-icalendar-include-body
10666 @cindex property, SUMMARY
10667 @cindex property, DESCRIPTION
10668 @cindex property, LOCATION
10669 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
10670 property can be inherited from higher in the hierarchy if you configure
10671 @code{org-use-property-inheritance} accordingly.} properties if the selected
10672 entries have them. If not, the summary will be derived from the headline,
10673 and the description from the body (limited to
10674 @code{org-icalendar-include-body} characters).
10676 How this calendar is best read and updated, depends on the application
10677 you are using. The FAQ covers this issue.
10679 @node Publishing, Working With Source Code, Exporting, Top
10680 @chapter Publishing
10683 Org includes a publishing management system that allows you to configure
10684 automatic HTML conversion of @emph{projects} composed of interlinked org
10685 files. You can also configure Org to automatically upload your exported HTML
10686 pages and related attachments, such as images and source code files, to a web
10689 You can also use Org to convert files into PDF, or even combine HTML and PDF
10690 conversion so that files are available in both formats on the server.
10692 Publishing has been contributed to Org by David O'Toole.
10695 * Configuration:: Defining projects
10696 * Uploading files:: How to get files up on the server
10697 * Sample configuration:: Example projects
10698 * Triggering publication:: Publication commands
10701 @node Configuration, Uploading files, Publishing, Publishing
10702 @section Configuration
10704 Publishing needs significant configuration to specify files, destination
10705 and many other properties of a project.
10708 * Project alist:: The central configuration variable
10709 * Sources and destinations:: From here to there
10710 * Selecting files:: What files are part of the project?
10711 * Publishing action:: Setting the function doing the publishing
10712 * Publishing options:: Tweaking HTML/@LaTeX{} export
10713 * Publishing links:: Which links keep working after publishing?
10714 * Sitemap:: Generating a list of all pages
10715 * Generating an index:: An index that reaches across pages
10718 @node Project alist, Sources and destinations, Configuration, Configuration
10719 @subsection The variable @code{org-publish-project-alist}
10720 @cindex org-publish-project-alist
10721 @cindex projects, for publishing
10723 @vindex org-publish-project-alist
10724 Publishing is configured almost entirely through setting the value of one
10725 variable, called @code{org-publish-project-alist}. Each element of the list
10726 configures one project, and may be in one of the two following forms:
10729 ("project-name" :property value :property value ...)
10730 @r{i.e.@: a well-formed property list with alternating keys and values}
10732 ("project-name" :components ("project-name" "project-name" ...))
10736 In both cases, projects are configured by specifying property values. A
10737 project defines the set of files that will be published, as well as the
10738 publishing configuration to use when publishing those files. When a project
10739 takes the second form listed above, the individual members of the
10740 @code{:components} property are taken to be sub-projects, which group
10741 together files requiring different publishing options. When you publish such
10742 a ``meta-project'', all the components will also be published, in the
10745 @node Sources and destinations, Selecting files, Project alist, Configuration
10746 @subsection Sources and destinations for files
10747 @cindex directories, for publishing
10749 Most properties are optional, but some should always be set. In
10750 particular, Org needs to know where to look for source files,
10751 and where to put published files.
10753 @multitable @columnfractions 0.3 0.7
10754 @item @code{:base-directory}
10755 @tab Directory containing publishing source files
10756 @item @code{:publishing-directory}
10757 @tab Directory where output files will be published. You can directly
10758 publish to a webserver using a file name syntax appropriate for
10759 the Emacs @file{tramp} package. Or you can publish to a local directory and
10760 use external tools to upload your website (@pxref{Uploading files}).
10761 @item @code{:preparation-function}
10762 @tab Function or list of functions to be called before starting the
10763 publishing process, for example, to run @code{make} for updating files to be
10764 published. The project property list is scoped into this call as the
10765 variable @code{project-plist}.
10766 @item @code{:completion-function}
10767 @tab Function or list of functions called after finishing the publishing
10768 process, for example, to change permissions of the resulting files. The
10769 project property list is scoped into this call as the variable
10770 @code{project-plist}.
10774 @node Selecting files, Publishing action, Sources and destinations, Configuration
10775 @subsection Selecting files
10776 @cindex files, selecting for publishing
10778 By default, all files with extension @file{.org} in the base directory
10779 are considered part of the project. This can be modified by setting the
10781 @multitable @columnfractions 0.25 0.75
10782 @item @code{:base-extension}
10783 @tab Extension (without the dot!) of source files. This actually is a
10784 regular expression. Set this to the symbol @code{any} if you want to get all
10785 files in @code{:base-directory}, even without extension.
10787 @item @code{:exclude}
10788 @tab Regular expression to match file names that should not be
10789 published, even though they have been selected on the basis of their
10792 @item @code{:include}
10793 @tab List of files to be included regardless of @code{:base-extension}
10794 and @code{:exclude}.
10796 @item @code{:recursive}
10797 @tab Non-nil means, check base-directory recursively for files to publish.
10800 @node Publishing action, Publishing options, Selecting files, Configuration
10801 @subsection Publishing action
10802 @cindex action, for publishing
10804 Publishing means that a file is copied to the destination directory and
10805 possibly transformed in the process. The default transformation is to export
10806 Org files as HTML files, and this is done by the function
10807 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
10808 export}). But you also can publish your content as PDF files using
10809 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
10810 @code{utf8} encoded files using the corresponding functions. If you want to
10811 publish the Org file itself, but with @i{archived}, @i{commented}, and
10812 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
10813 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
10814 produce @file{file.org} and @file{file.org.html} in the publishing
10815 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
10816 source and publishing directories are equal. Note that with this kind of
10817 setup, you need to add @code{:exclude "-source\\.org"} to the project
10818 definition in @code{org-publish-project-alist} to prevent the published
10819 source files from being considered as new org files the next time the project
10820 is published.}. Other files like images only need to be copied to the
10821 publishing destination; for this you may use @code{org-publish-attachment}.
10822 For non-Org files, you always need to specify the publishing function:
10824 @multitable @columnfractions 0.3 0.7
10825 @item @code{:publishing-function}
10826 @tab Function executing the publication of a file. This may also be a
10827 list of functions, which will all be called in turn.
10828 @item @code{:plain-source}
10829 @tab Non-nil means, publish plain source.
10830 @item @code{:htmlized-source}
10831 @tab Non-nil means, publish htmlized source.
10834 The function must accept three arguments: a property list containing at least
10835 a @code{:publishing-directory} property, the name of the file to be
10836 published, and the path to the publishing directory of the output file. It
10837 should take the specified file, make the necessary transformation (if any)
10838 and place the result into the destination folder.
10840 @node Publishing options, Publishing links, Publishing action, Configuration
10841 @subsection Options for the HTML/@LaTeX{} exporters
10842 @cindex options, for publishing
10844 The property list can be used to set many export options for the HTML
10845 and @LaTeX{} exporters. In most cases, these properties correspond to user
10846 variables in Org. The table below lists these properties along
10847 with the variable they belong to. See the documentation string for the
10848 respective variable for details.
10850 @vindex org-export-html-link-up
10851 @vindex org-export-html-link-home
10852 @vindex org-export-default-language
10853 @vindex org-display-custom-times
10854 @vindex org-export-headline-levels
10855 @vindex org-export-with-section-numbers
10856 @vindex org-export-section-number-format
10857 @vindex org-export-with-toc
10858 @vindex org-export-preserve-breaks
10859 @vindex org-export-with-archived-trees
10860 @vindex org-export-with-emphasize
10861 @vindex org-export-with-sub-superscripts
10862 @vindex org-export-with-special-strings
10863 @vindex org-export-with-footnotes
10864 @vindex org-export-with-drawers
10865 @vindex org-export-with-tags
10866 @vindex org-export-with-todo-keywords
10867 @vindex org-export-with-priority
10868 @vindex org-export-with-TeX-macros
10869 @vindex org-export-with-LaTeX-fragments
10870 @vindex org-export-skip-text-before-1st-heading
10871 @vindex org-export-with-fixed-width
10872 @vindex org-export-with-timestamps
10873 @vindex org-export-author-info
10874 @vindex org-export-email
10875 @vindex org-export-creator-info
10876 @vindex org-export-with-tables
10877 @vindex org-export-highlight-first-table-line
10878 @vindex org-export-html-style-include-default
10879 @vindex org-export-html-style-include-scripts
10880 @vindex org-export-html-style
10881 @vindex org-export-html-style-extra
10882 @vindex org-export-html-link-org-files-as-html
10883 @vindex org-export-html-inline-images
10884 @vindex org-export-html-extension
10885 @vindex org-export-html-table-tag
10886 @vindex org-export-html-expand
10887 @vindex org-export-html-with-timestamp
10888 @vindex org-export-publishing-directory
10889 @vindex org-export-html-preamble
10890 @vindex org-export-html-postamble
10891 @vindex user-full-name
10892 @vindex user-mail-address
10893 @vindex org-export-select-tags
10894 @vindex org-export-exclude-tags
10896 @multitable @columnfractions 0.32 0.68
10897 @item @code{:link-up} @tab @code{org-export-html-link-up}
10898 @item @code{:link-home} @tab @code{org-export-html-link-home}
10899 @item @code{:language} @tab @code{org-export-default-language}
10900 @item @code{:customtime} @tab @code{org-display-custom-times}
10901 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
10902 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
10903 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
10904 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
10905 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
10906 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
10907 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
10908 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
10909 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
10910 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
10911 @item @code{:drawers} @tab @code{org-export-with-drawers}
10912 @item @code{:tags} @tab @code{org-export-with-tags}
10913 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
10914 @item @code{:priority} @tab @code{org-export-with-priority}
10915 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
10916 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
10917 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
10918 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
10919 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
10920 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
10921 @item @code{:author} @tab @code{user-full-name}
10922 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
10923 @item @code{:author-info} @tab @code{org-export-author-info}
10924 @item @code{:email-info} @tab @code{org-export-email-info}
10925 @item @code{:creator-info} @tab @code{org-export-creator-info}
10926 @item @code{:tables} @tab @code{org-export-with-tables}
10927 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
10928 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
10929 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
10930 @item @code{:style} @tab @code{org-export-html-style}
10931 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
10932 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
10933 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
10934 @item @code{:html-extension} @tab @code{org-export-html-extension}
10935 @item @code{:html-preamble} @tab @code{org-export-html-preamble}
10936 @item @code{:html-postamble} @tab @code{org-export-html-postamble}
10937 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
10938 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
10939 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
10940 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
10941 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
10942 @item @code{:select-tags} @tab @code{org-export-select-tags}
10943 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
10944 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
10947 Most of the @code{org-export-with-*} variables have the same effect in
10948 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
10949 @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
10950 @LaTeX{} export. See @code{org-export-plist-vars} to check this list of
10955 @vindex org-publish-project-alist
10956 When a property is given a value in @code{org-publish-project-alist},
10957 its setting overrides the value of the corresponding user variable (if
10958 any) during publishing. Options set within a file (@pxref{Export
10959 options}), however, override everything.
10961 @node Publishing links, Sitemap, Publishing options, Configuration
10962 @subsection Links between published files
10963 @cindex links, publishing
10965 To create a link from one Org file to another, you would use
10966 something like @samp{[[file:foo.org][The foo]]} or simply
10967 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
10968 becomes a link to @file{foo.html}. In this way, you can interlink the
10969 pages of your "org web" project and the links will work as expected when
10970 you publish them to HTML. If you also publish the Org source file and want
10971 to link to that, use an @code{http:} link instead of a @code{file:} link,
10972 because @code{file:} links are converted to link to the corresponding
10975 You may also link to related files, such as images. Provided you are careful
10976 with relative file names, and provided you have also configured Org to upload
10977 the related files, these links will work too. See @ref{Complex example}, for
10978 an example of this usage.
10980 Sometimes an Org file to be published may contain links that are
10981 only valid in your production environment, but not in the publishing
10982 location. In this case, use the property
10984 @multitable @columnfractions 0.4 0.6
10985 @item @code{:link-validation-function}
10986 @tab Function to validate links
10990 to define a function for checking link validity. This function must
10991 accept two arguments, the file name and a directory relative to which
10992 the file name is interpreted in the production environment. If this
10993 function returns @code{nil}, then the HTML generator will only insert a
10994 description into the HTML file, but no link. One option for this
10995 function is @code{org-publish-validate-link} which checks if the given
10996 file is part of any project in @code{org-publish-project-alist}.
10998 @node Sitemap, Generating an index, Publishing links, Configuration
10999 @subsection Generating a sitemap
11000 @cindex sitemap, of published pages
11002 The following properties may be used to control publishing of
11003 a map of files for a given project.
11005 @multitable @columnfractions 0.35 0.65
11006 @item @code{:auto-sitemap}
11007 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
11008 or @code{org-publish-all}.
11010 @item @code{:sitemap-filename}
11011 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
11012 becomes @file{sitemap.html}).
11014 @item @code{:sitemap-title}
11015 @tab Title of sitemap page. Defaults to name of file.
11017 @item @code{:sitemap-function}
11018 @tab Plug-in function to use for generation of the sitemap.
11019 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
11020 of links to all files in the project.
11022 @item @code{:sitemap-sort-folders}
11023 @tab Where folders should appear in the sitemap. Set this to @code{first}
11024 (default) or @code{last} to display folders first or last,
11025 respectively. Any other value will mix files and folders.
11027 @item @code{:sitemap-sort-files}
11028 @tab How the files are sorted in the site map. Set this to
11029 @code{alphabetically} (default), @code{chronologically} or
11030 @code{anti-chronologically}. @code{chronologically} sorts the files with
11031 older date first while @code{anti-chronologically} sorts the files with newer
11032 date first. @code{alphabetically} sorts the files alphabetically. The date of
11033 a file is retrieved with @code{org-publish-find-date}.
11035 @item @code{:sitemap-ignore-case}
11036 @tab Should sorting be case-sensitive? Default @code{nil}.
11038 @item @code{:sitemap-file-entry-format}
11039 @tab With this option one can tell how a sitemap's entry is formated in the
11040 sitemap. This is a format string with some escape sequences: @code{%t} stands
11041 for the title of the file, @code{%a} stands for the author of the file and
11042 @code{%d} stands for the date of the file. The date is retrieved with the
11043 @code{org-publish-find-date} function and formated with
11044 @code{org-publish-sitemap-date-format}. Default @code{%t}.
11046 @item @code{:sitemap-date-format}
11047 @tab Format string for the @code{format-time-string} function that tells how
11048 a sitemap entry's date is to be formated. This property bypasses
11049 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
11053 @node Generating an index, , Sitemap, Configuration
11054 @subsection Generating an index
11055 @cindex index, in a publishing project
11057 Org-mode can generate an index across the files of a publishing project.
11059 @multitable @columnfractions 0.25 0.75
11060 @item @code{:makeindex}
11061 @tab When non-nil, generate in index in the file @file{theindex.org} and
11062 publish it as @file{theindex.html}.
11065 The file will be created when first publishing a project with the
11066 @code{:makeindex} set. The file only contains a statement @code{#+include:
11067 "theindex.inc"}. You can then build around this include statement by adding
11068 a title, style information, etc.
11070 @node Uploading files, Sample configuration, Configuration, Publishing
11071 @section Uploading files
11075 For those people already utilizing third party sync tools such as
11076 @command{rsync} or @command{unison}, it might be preferable not to use the built in
11077 @i{remote} publishing facilities of Org-mode which rely heavily on
11078 Tramp. Tramp, while very useful and powerful, tends not to be
11079 so efficient for multiple file transfer and has been known to cause problems
11082 Specialized synchronization utilities offer several advantages. In addition
11083 to timestamp comparison, they also do content and permissions/attribute
11084 checks. For this reason you might prefer to publish your web to a local
11085 directory (possibly even @i{in place} with your Org files) and then use
11086 @file{unison} or @file{rsync} to do the synchronization with the remote host.
11088 Since Unison (for example) can be configured as to which files to transfer to
11089 a certain remote destination, it can greatly simplify the project publishing
11090 definition. Simply keep all files in the correct location, process your Org
11091 files with @code{org-publish} and let the synchronization tool do the rest.
11092 You do not need, in this scenario, to include attachments such as @file{jpg},
11093 @file{css} or @file{gif} files in the project definition since the 3rd party
11096 Publishing to a local directory is also much faster than to a remote one, so
11097 that you can afford more easily to republish entire projects. If you set
11098 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
11099 benefit of re-including any changed external files such as source example
11100 files you might include with @code{#+INCLUDE}. The timestamp mechanism in
11101 Org is not smart enough to detect if included files have been modified.
11103 @node Sample configuration, Triggering publication, Uploading files, Publishing
11104 @section Sample configuration
11106 Below we provide two example configurations. The first one is a simple
11107 project publishing only a set of Org files. The second example is
11108 more complex, with a multi-component project.
11111 * Simple example:: One-component publishing
11112 * Complex example:: A multi-component publishing example
11115 @node Simple example, Complex example, Sample configuration, Sample configuration
11116 @subsection Example: simple publishing configuration
11118 This example publishes a set of Org files to the @file{public_html}
11119 directory on the local machine.
11122 (setq org-publish-project-alist
11124 :base-directory "~/org/"
11125 :publishing-directory "~/public_html"
11126 :section-numbers nil
11127 :table-of-contents nil
11128 :style "<link rel=\"stylesheet\"
11129 href=\"../other/mystyle.css\"
11130 type=\"text/css\"/>")))
11133 @node Complex example, , Simple example, Sample configuration
11134 @subsection Example: complex publishing configuration
11136 This more complicated example publishes an entire website, including
11137 Org files converted to HTML, image files, Emacs Lisp source code, and
11138 style sheets. The publishing directory is remote and private files are
11141 To ensure that links are preserved, care should be taken to replicate
11142 your directory structure on the web server, and to use relative file
11143 paths. For example, if your Org files are kept in @file{~/org} and your
11144 publishable images in @file{~/images}, you would link to an image with
11147 file:../images/myimage.png
11150 On the web server, the relative path to the image should be the
11151 same. You can accomplish this by setting up an "images" folder in the
11152 right place on the web server, and publishing images to it.
11155 (setq org-publish-project-alist
11157 :base-directory "~/org/"
11158 :base-extension "org"
11159 :publishing-directory "/ssh:user@@host:~/html/notebook/"
11160 :publishing-function org-publish-org-to-html
11161 :exclude "PrivatePage.org" ;; regexp
11163 :section-numbers nil
11164 :table-of-contents nil
11165 :style "<link rel=\"stylesheet\"
11166 href=\"../other/mystyle.css\" type=\"text/css\"/>"
11170 :base-directory "~/images/"
11171 :base-extension "jpg\\|gif\\|png"
11172 :publishing-directory "/ssh:user@@host:~/html/images/"
11173 :publishing-function org-publish-attachment)
11176 :base-directory "~/other/"
11177 :base-extension "css\\|el"
11178 :publishing-directory "/ssh:user@@host:~/html/other/"
11179 :publishing-function org-publish-attachment)
11180 ("website" :components ("orgfiles" "images" "other"))))
11183 @node Triggering publication, , Sample configuration, Publishing
11184 @section Triggering publication
11186 Once properly configured, Org can publish with the following commands:
11189 @orgcmd{C-c C-e X,org-publish}
11190 Prompt for a specific project and publish all files that belong to it.
11191 @orgcmd{C-c C-e P,org-publish-current-project}
11192 Publish the project containing the current file.
11193 @orgcmd{C-c C-e F,org-publish-current-file}
11194 Publish only the current file.
11195 @orgcmd{C-c C-e E,org-publish-all}
11196 Publish every project.
11199 @vindex org-publish-use-timestamps-flag
11200 Org uses timestamps to track when a file has changed. The above functions
11201 normally only publish changed files. You can override this and force
11202 publishing of all files by giving a prefix argument to any of the commands
11203 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
11204 This may be necessary in particular if files include other files via
11205 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
11207 @comment node-name, next, previous, up
11208 @comment Working With Source Code, Miscellaneous, Publishing, Top
11210 @node Working With Source Code, Miscellaneous, Publishing, Top
11211 @chapter Working with source code
11212 @cindex Schulte, Eric
11213 @cindex Davison, Dan
11214 @cindex source code, working with
11216 Source code can be included in Org-mode documents using a @samp{src} block,
11220 #+BEGIN_SRC emacs-lisp
11221 (defun org-xor (a b)
11227 Org-mode provides a number of features for working with live source code,
11228 including editing of code blocks in their native major-mode, evaluation of
11229 code blocks, converting code blocks into source files (known as @dfn{tangling}
11230 in literate programming), and exporting code blocks and their
11231 results in several formats. This functionality was contributed by Eric
11232 Schulte and Dan Davison, and was originally named Org-babel.
11234 The following sections describe Org-mode's code block handling facilities.
11237 * Structure of code blocks:: Code block syntax described
11238 * Editing source code:: Language major-mode editing
11239 * Exporting code blocks:: Export contents and/or results
11240 * Extracting source code:: Create pure source code files
11241 * Evaluating code blocks:: Place results of evaluation in the Org-mode buffer
11242 * Library of Babel:: Use and contribute to a library of useful code blocks
11243 * Languages:: List of supported code block languages
11244 * Header arguments:: Configure code block functionality
11245 * Results of evaluation:: How evaluation results are handled
11246 * Noweb reference syntax:: Literate programming in Org-mode
11247 * Key bindings and useful functions:: Work quickly with code blocks
11248 * Batch execution:: Call functions from the command line
11251 @comment node-name, next, previous, up
11252 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11254 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
11255 @section Structure of code blocks
11256 @cindex code block, structure
11257 @cindex source code, block structure
11259 The structure of code blocks is as follows:
11263 #+begin_src <language> <switches> <header arguments>
11268 Switches and header arguments are optional. Code can also be embedded in text
11272 src_<language>@{<body>@}
11278 src_<language>[<header arguments>]@{<body>@}
11283 This name is associated with the code block. This is similar to the
11284 @samp{#+tblname} lines that can be used to name tables in Org-mode files.
11285 Referencing the name of a code block makes it possible to evaluate the
11286 block from other places in the file, other files, or from Org-mode table
11287 formulas (see @ref{The spreadsheet}).
11289 The language of the code in the block.
11291 Optional switches controlling exportation of the code block (see switches discussion in
11292 @ref{Literal examples})
11293 @item <header arguments>
11294 Optional header arguments control many aspects of evaluation, export and
11295 tangling of code blocks. See the @ref{Header arguments}
11296 section. Header arguments can also be set on a per-buffer or per-subtree
11297 basis using properties.
11302 @comment node-name, next, previous, up
11303 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11305 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
11306 @section Editing source code
11307 @cindex code block, editing
11308 @cindex source code, editing
11311 Use @kbd{C-c '} to edit the current code block. This brings up
11312 a language major-mode edit buffer containing the body of the code
11313 block. Saving this buffer will write the new contents back to the Org
11314 buffer. Use @kbd{C-c '} again to exit.
11316 The @code{org-src-mode} minor mode will be active in the edit buffer. The
11317 following variables can be used to configure the behavior of the edit
11318 buffer. See also the customization group @code{org-edit-structure} for
11319 further configuration options.
11322 @item org-src-lang-modes
11323 If an Emacs major-mode named @code{<lang>-mode} exists, where
11324 @code{<lang>} is the language named in the header line of the code block,
11325 then the edit buffer will be placed in that major-mode. This variable
11326 can be used to map arbitrary language names to existing major modes.
11327 @item org-src-window-setup
11328 Controls the way Emacs windows are rearranged when the edit buffer is created.
11329 @item org-src-preserve-indentation
11330 This variable is especially useful for tangling languages such as
11331 Python, in which whitespace indentation in the output is critical.
11332 @item org-src-ask-before-returning-to-edit-buffer
11333 By default, Org will ask before returning to an open edit buffer. Set
11334 this variable to nil to switch without asking.
11337 To turn on native code fontification in the @emph{Org} buffer, configure the
11338 variable @code{org-src-fontify-natively}.
11340 @comment node-name, next, previous, up
11341 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11343 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
11344 @section Exporting code blocks
11345 @cindex code block, exporting
11346 @cindex source code, exporting
11348 It is possible to export the @emph{contents} of code blocks, the
11349 @emph{results} of code block evaluation, @emph{neither}, or @emph{both}. For
11350 most languages, the default exports the contents of code blocks. However, for
11351 some languages (e.g.@: @code{ditaa}) the default exports the results of code
11352 block evaluation. For information on exporting code block bodies, see
11353 @ref{Literal examples}.
11355 The @code{:exports} header argument can be used to specify export
11358 @subsubheading Header arguments:
11360 @item :exports code
11361 The default in most languages. The body of the code block is exported, as
11362 described in @ref{Literal examples}.
11363 @item :exports results
11364 The code block will be evaluated and the results will be placed in the
11365 Org-mode buffer for export, either updating previous results of the code
11366 block located anywhere in the buffer or, if no previous results exist,
11367 placing the results immediately after the code block. The body of the code
11368 block will not be exported.
11369 @item :exports both
11370 Both the code block and its results will be exported.
11371 @item :exports none
11372 Neither the code block nor its results will be exported.
11375 It is possible to inhibit the evaluation of code blocks during export.
11376 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
11377 ensure that no code blocks are evaluated as part of the export process. This
11378 can be useful in situations where potentially untrusted Org-mode files are
11379 exported in an automated fashion, for example when Org-mode is used as the
11380 markup language for a wiki.
11382 @comment node-name, next, previous, up
11383 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11384 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
11385 @section Extracting source code
11387 @cindex source code, extracting
11388 @cindex code block, extracting source code
11390 Creating pure source code files by extracting code from source blocks is
11391 referred to as ``tangling''---a term adopted from the literate programming
11392 community. During ``tangling'' of code blocks their bodies are expanded
11393 using @code{org-babel-expand-src-block} which can expand both variable and
11394 ``noweb'' style references (see @ref{Noweb reference syntax}).
11396 @subsubheading Header arguments
11399 The default. The code block is not included in the tangled output.
11401 Include the code block in the tangled output. The output file name is the
11402 name of the org file with the extension @samp{.org} replaced by the extension
11403 for the block language.
11404 @item :tangle filename
11405 Include the code block in the tangled output to file @samp{filename}.
11409 @subsubheading Functions
11411 @item org-babel-tangle
11412 Tangle the current file. Bound to @kbd{C-c C-v t}.
11413 @item org-babel-tangle-file
11414 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
11417 @subsubheading Hooks
11419 @item org-babel-post-tangle-hook
11420 This hook is run from within code files tangled by @code{org-babel-tangle}.
11421 Example applications could include post-processing, compilation or evaluation
11422 of tangled code files.
11425 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
11426 @section Evaluating code blocks
11427 @cindex code block, evaluating
11428 @cindex source code, evaluating
11430 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
11431 potential for that code to do harm. Org-mode provides a number of safeguards
11432 to ensure that it only evaluates code with explicit confirmation from the
11433 user. For information on these safeguards (and on how to disable them) see
11434 @ref{Code evaluation security}.} and the results placed in the Org-mode
11435 buffer. By default, evaluation is only turned on for @code{emacs-lisp} code
11436 blocks, however support exists for evaluating blocks in many languages. See
11437 @ref{Languages} for a list of supported languages. See @ref{Structure of
11438 code blocks} for information on the syntax used to define a code block.
11441 There are a number of ways to evaluate code blocks. The simplest is to press
11442 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
11443 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
11444 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
11445 @code{org-babel-execute-src-block} function to evaluate the block and insert
11446 its results into the Org-mode buffer.
11448 It is also possible to evaluate named code blocks from anywhere in an
11449 Org-mode buffer or an Org-mode table. @code{#+call} (or synonymously
11450 @code{#+function} or @code{#+lob}) lines can be used to remotely execute code
11451 blocks located in the current Org-mode buffer or in the ``Library of Babel''
11452 (see @ref{Library of Babel}). These lines use the following syntax.
11455 #+call: <name>(<arguments>) <header arguments>
11456 #+function: <name>(<arguments>) <header arguments>
11457 #+lob: <name>(<arguments>) <header arguments>
11462 The name of the code block to be evaluated.
11464 Arguments specified in this section will be passed to the code block. These
11465 arguments should relate to @code{:var} header arguments in the called code
11466 block expressed using standard function call syntax. For example if the
11467 original code block named @code{double} has the header argument @code{:var
11468 n=2}, then the call line passing the number four to that block would be
11469 written as @code{#+call: double(n=2)}.
11470 @item <header arguments>
11471 Header arguments can be placed after the function invocation. See
11472 @ref{Header arguments} for more information on header arguments.
11475 All header arguments placed in the @code{<header arguments>} section
11476 described above will be applied to the evaluation of the @code{#+call:} line,
11477 however it is sometimes desirable to specify header arguments to be passed to
11478 the code block being evaluated.
11480 This is possible through the use of the following optional extended syntax.
11483 #+call: <name>[<block header arguments>](<arguments>) <header arguments>
11486 Any header argument placed between the square brackets in the @code{<block
11487 header arguments>} section will be applied to the evaluation of the named
11488 code block. For more examples of passing header arguments to @code{#+call:}
11489 lines see @ref{Header arguments in function calls}.
11491 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
11492 @section Library of Babel
11493 @cindex babel, library of
11494 @cindex source code, library
11495 @cindex code block, library
11497 The ``Library of Babel'' is a library of code blocks
11498 that can be called from any Org-mode file. The library is housed in an
11499 Org-mode file located in the @samp{contrib} directory of Org-mode.
11500 Org-mode users can deposit functions they believe to be generally
11501 useful in the library.
11503 Code blocks defined in the ``Library of Babel'' can be called remotely as if
11504 they were in the current Org-mode buffer (see @ref{Evaluating code blocks}
11505 for information on the syntax of remote code block evaluation).
11508 Code blocks located in any Org-mode file can be loaded into the ``Library of
11509 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
11512 @node Languages, Header arguments, Library of Babel, Working With Source Code
11514 @cindex babel, languages
11515 @cindex source code, languages
11516 @cindex code block, languages
11518 Code blocks in the following languages are supported.
11520 @multitable @columnfractions 0.28 0.3 0.22 0.2
11521 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
11522 @item Asymptote @tab asymptote @tab Emacs Calc @tab calc
11523 @item C @tab C @tab C++ @tab C++
11524 @item Clojure @tab clojure @tab CSS @tab css
11525 @item ditaa @tab ditaa @tab Graphviz @tab dot
11526 @item Emacs Lisp @tab emacs-lisp @tab gnuplot @tab gnuplot
11527 @item Haskell @tab haskell @tab Javascript @tab js
11528 @item LaTeX @tab latex @tab Ledger @tab ledger
11529 @item Lisp @tab lisp @tab MATLAB @tab matlab
11530 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
11531 @item Octave @tab octave @tab Org-mode @tab org
11532 @item Oz @tab oz @tab Perl @tab perl
11533 @item Plantuml @tab plantuml @tab Python @tab python
11534 @item R @tab R @tab Ruby @tab ruby
11535 @item Sass @tab sass @tab Scheme @tab scheme
11536 @item GNU Screen @tab screen @tab shell @tab sh
11537 @item SQL @tab sql @tab SQLite @tab sqlite
11540 Language-specific documentation is available for some languages. If
11541 available, it can be found at
11542 @uref{http://orgmode.org/worg/org-contrib/babel/languages}.
11544 The @code{org-babel-load-languages} controls which languages are enabled for
11545 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
11546 be set using the customization interface or by adding code like the following
11547 to your emacs configuration.
11550 The following disables @code{emacs-lisp} evaluation and enables evaluation of
11551 @code{R} code blocks.
11555 (org-babel-do-load-languages
11556 'org-babel-load-languages
11557 '((emacs-lisp . nil)
11561 It is also possible to enable support for a language by loading the related
11562 elisp file with @code{require}.
11565 The following adds support for evaluating @code{clojure} code blocks.
11569 (require 'ob-clojure)
11572 @node Header arguments, Results of evaluation, Languages, Working With Source Code
11573 @section Header arguments
11574 @cindex code block, header arguments
11575 @cindex source code, block header arguments
11577 Code block functionality can be configured with header arguments. This
11578 section provides an overview of the use of header arguments, and then
11579 describes each header argument in detail.
11582 * Using header arguments:: Different ways to set header arguments
11583 * Specific header arguments:: List of header arguments
11586 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
11587 @subsection Using header arguments
11589 The values of header arguments can be set in six different ways, each more
11590 specific (and having higher priority) than the last.
11592 * System-wide header arguments:: Set global default values
11593 * Language-specific header arguments:: Set default values by language
11594 * Buffer-wide header arguments:: Set default values for a specific buffer
11595 * Header arguments in Org-mode properties:: Set default values for a buffer or heading
11596 * Code block specific header arguments:: The most common way to set values
11597 * Header arguments in function calls:: The most specific level
11601 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
11602 @subsubheading System-wide header arguments
11603 @vindex org-babel-default-header-args
11604 System-wide values of header arguments can be specified by customizing the
11605 @code{org-babel-default-header-args} variable:
11609 :results => "replace"
11616 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
11618 @c ((:session . "none")
11619 @c (:results . "replace")
11620 @c (:exports . "code")
11622 @c (:noweb . "no"))
11626 @c Default arguments to use when evaluating a code block.
11629 For example, the following example could be used to set the default value of
11630 @code{:noweb} header arguments to @code{yes}. This would have the effect of
11631 expanding @code{:noweb} references by default when evaluating source code
11635 (setq org-babel-default-header-args
11636 (cons '(:noweb . "yes")
11637 (assq-delete-all :noweb org-babel-default-header-args)))
11640 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
11641 @subsubheading Language-specific header arguments
11642 Each language can define its own set of default header arguments. See the
11643 language-specific documentation available online at
11644 @uref{http://orgmode.org/worg/org-contrib/babel}.
11646 @node Buffer-wide header arguments, Header arguments in Org-mode properties, Language-specific header arguments, Using header arguments
11647 @subsubheading Buffer-wide header arguments
11648 Buffer-wide header arguments may be specified through the use of a special
11649 line placed anywhere in an Org-mode file. The line consists of the
11650 @code{#+BABEL:} keyword followed by a series of header arguments which may be
11651 specified using the standard header argument syntax.
11653 For example the following would set @code{session} to @code{*R*}, and
11654 @code{results} to @code{silent} for every code block in the buffer, ensuring
11655 that all execution took place in the same session, and no results would be
11656 inserted into the buffer.
11659 #+BABEL: :session *R* :results silent
11662 @node Header arguments in Org-mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
11663 @subsubheading Header arguments in Org-mode properties
11665 Header arguments are also read from Org-mode properties (see @ref{Property
11666 syntax}), which can be set on a buffer-wide or per-heading basis. An example
11667 of setting a header argument for all code blocks in a buffer is
11670 #+property: tangle yes
11673 When properties are used to set default header arguments, they are looked up
11674 with inheritance, so the value of the @code{:cache} header argument will default
11675 to @code{yes} in all code blocks in the subtree rooted at the following
11686 @vindex org-babel-default-header-args
11687 Properties defined in this way override the properties set in
11688 @code{org-babel-default-header-args}. It is convenient to use the
11689 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
11690 in Org-mode documents.
11692 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org-mode properties, Using header arguments
11693 @subsubheading Code block specific header arguments
11695 The most common way to assign values to header arguments is at the
11696 code block level. This can be done by listing a sequence of header
11697 arguments and their values as part of the @code{#+begin_src} line.
11698 Properties set in this way override both the values of
11699 @code{org-babel-default-header-args} and header arguments specified as
11700 properties. In the following example, the @code{:results} header argument
11701 is set to @code{silent}, meaning the results of execution will not be
11702 inserted in the buffer, and the @code{:exports} header argument is set to
11703 @code{code}, meaning only the body of the code block will be
11704 preserved on export to HTML or LaTeX.
11707 #+source: factorial
11708 #+begin_src haskell :results silent :exports code :var n=0
11710 fac n = n * fac (n-1)
11713 Similarly, it is possible to set header arguments for inline code blocks:
11716 src_haskell[:exports both]@{fac 5@}
11719 Code block header arguments can span multiple lines using =#+header:= or
11720 =#+headers:= lines preceding a code block or nested in between the name and
11721 body of a named code block.
11723 Multi-line header arguments on an un-named code block:
11725 #+headers: :var data1=1
11726 #+begin_src emacs-lisp :var data2=2
11727 (message "data1:%S, data2:%S" data1 data2)
11734 Multi-line header arguments on a named code block:
11736 #+source: named-block
11737 #+header: :var data=2
11738 #+begin_src emacs-lisp
11739 (message "data:%S" data)
11742 #+results: named-block
11746 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
11747 @comment node-name, next, previous, up
11748 @subsubheading Header arguments in function calls
11750 At the most specific level, header arguments for ``Library of Babel'' or
11751 function call lines can be set as shown in the two examples below. For more
11752 information on the structure of @code{#+call:} lines see @ref{Evaluating code
11755 The following will apply the @code{:exports results} header argument to the
11756 evaluation of the @code{#+call:} line.
11758 #+call: factorial(n=5) :exports results
11761 The following will apply the @code{:session special} header argument to the
11762 evaluation of the @code{factorial} code block.
11764 #+call: factorial[:session special](n=5)
11767 @node Specific header arguments, , Using header arguments, Header arguments
11768 @subsection Specific header arguments
11769 The following header arguments are defined:
11772 * var:: Pass arguments to code blocks
11773 * results:: Specify the type of results and how they will
11774 be collected and handled
11775 * file:: Specify a path for file output
11776 * dir:: Specify the default (possibly remote)
11777 directory for code block execution
11778 * exports:: Export code and/or results
11779 * tangle:: Toggle tangling and specify file name
11780 * mkdirp:: Toggle creation of parent directories of target
11781 files during tangling
11782 * comments:: Toggle insertion of comments in tangled
11784 * no-expand:: Turn off variable assignment and noweb
11785 expansion during tangling
11786 * session:: Preserve the state of code evaluation
11787 * noweb:: Toggle expansion of noweb references
11788 * cache:: Avoid re-evaluating unchanged code blocks
11789 * sep:: Delimiter for writing tabular results outside Org
11790 * hlines:: Handle horizontal lines in tables
11791 * colnames:: Handle column names in tables
11792 * rownames:: Handle row names in tables
11793 * shebang:: Make tangled files executable
11794 * eval:: Limit evaluation of specific code blocks
11797 @node var, results, Specific header arguments, Specific header arguments
11798 @subsubsection @code{:var}
11799 The @code{:var} header argument is used to pass arguments to code blocks.
11800 The specifics of how arguments are included in a code block vary by language;
11801 these are addressed in the language-specific documentation. However, the
11802 syntax used to specify arguments is the same across all languages. The
11803 values passed to arguments can be literal values, values from org-mode tables
11804 and literal example blocks, the results of other code blocks, or Emacs Lisp
11805 code---see the ``Emacs Lisp evaluation of variables'' heading below.
11807 These values can be indexed in a manner similar to arrays---see the
11808 ``indexable variable values'' heading below.
11810 The following syntax is used to pass arguments to code blocks using the
11811 @code{:var} header argument.
11817 where @code{assign} can take one of the following forms
11820 @item literal value
11821 either a string @code{"string"} or a number @code{9}.
11826 #+tblname: example-table
11832 #+source: table-length
11833 #+begin_src emacs-lisp :var table=example-table
11837 #+results: table-length
11841 a code block name, as assigned by @code{#+srcname:}, followed by
11845 #+begin_src emacs-lisp :var length=table-length()
11853 In addition, an argument can be passed to the code block referenced
11854 by @code{:var}. The argument is passed within the parentheses following the
11859 #+begin_src emacs-lisp :var input=8
11867 #+begin_src emacs-lisp :var input=double(input=1)
11876 @subsubheading Alternate argument syntax
11877 It is also possible to specify arguments in a potentially more natural way
11878 using the @code{#+source:} line of a code block. As in the following
11879 example arguments can be packed inside of parenthesis, separated by commas,
11880 following the source name.
11883 #+source: double(input=0, x=2)
11884 #+begin_src emacs-lisp
11889 @subsubheading Indexable variable values
11890 It is possible to reference portions of variable values by ``indexing'' into
11891 the variables. Indexes are 0 based with negative values counting back from
11892 the end. If an index is separated by @code{,}s then each subsequent section
11893 will index into the next deepest nesting or dimension of the value. Note
11894 that this indexing occurs @emph{before} other table related header arguments
11895 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
11896 following example assigns the last cell of the first row the table
11897 @code{example-table} to the variable @code{data}:
11900 #+results: example-table
11906 #+begin_src emacs-lisp :var data=example-table[0,-1]
11914 Ranges of variable values can be referenced using two integers separated by a
11915 @code{:}, in which case the entire inclusive range is referenced. For
11916 example the following assigns the middle three rows of @code{example-table}
11920 #+results: example-table
11927 #+begin_src emacs-lisp :var data=example-table[1:3]
11937 Additionally, an empty index, or the single character @code{*}, are both
11938 interpreted to mean the entire range and as such are equivalent to
11939 @code{0:-1}, as shown in the following example in which the entire first
11940 column is referenced.
11943 #+results: example-table
11949 #+begin_src emacs-lisp :var data=example-table[,0]
11957 It is possible to index into the results of code blocks as well as tables.
11958 Any number of dimensions can be indexed. Dimensions are separated from one
11959 another by commas, as shown in the following example.
11963 #+begin_src emacs-lisp
11964 '(((1 2 3) (4 5 6) (7 8 9))
11965 ((10 11 12) (13 14 15) (16 17 18))
11966 ((19 20 21) (22 23 24) (25 26 27)))
11969 #+begin_src emacs-lisp :var data=3D[1,,1]
11977 @subsubheading Emacs Lisp evaluation of variables
11979 Emacs lisp code can be used to initialize variable values. When a variable
11980 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be evaluated as
11981 Emacs Lisp and the result of the evaluation will be assigned as the variable
11982 value. The following example demonstrates use of this evaluation to reliably
11983 pass the file-name of the org-mode buffer to a code block---note that
11984 evaluation of header arguments is guaranteed to take place in the original
11985 org-mode file, while there is no such guarantee for evaluation of the code
11989 #+begin_src sh :var file-name=(buffer-file-name) :exports both
11994 Note that values read from tables and lists will not be evaluated as
11995 Emacs Lisp, as shown in the following example.
12001 #+headers: :var data=table[0,0]
12010 @node results, file, var, Specific header arguments
12011 @subsubsection @code{:results}
12013 There are three classes of @code{:results} header argument. Only one option
12014 per class may be supplied per code block.
12018 @b{collection} header arguments specify how the results should be collected
12019 from the code block
12021 @b{type} header arguments specify what type of result the code block will
12022 return---which has implications for how they will be inserted into the
12025 @b{handling} header arguments specify how the results of evaluating the code
12026 block should be handled.
12029 @subsubheading Collection
12030 The following options are mutually exclusive, and specify how the results
12031 should be collected from the code block.
12035 This is the default. The result is the value of the last statement in the
12036 code block. This header argument places the evaluation in functional
12037 mode. Note that in some languages, e.g., Python, use of this result type
12038 requires that a @code{return} statement be included in the body of the source
12039 code block. E.g., @code{:results value}.
12040 @item @code{output}
12041 The result is the collection of everything printed to STDOUT during the
12042 execution of the code block. This header argument places the
12043 evaluation in scripting mode. E.g., @code{:results output}.
12046 @subsubheading Type
12048 The following options are mutually exclusive and specify what type of results
12049 the code block will return. By default, results are inserted as either a
12050 table or scalar depending on their value.
12053 @item @code{table}, @code{vector}
12054 The results should be interpreted as an Org-mode table. If a single value is
12055 returned, it will be converted into a table with one row and one column.
12056 E.g., @code{:results value table}.
12058 The results should be interpreted as an Org-mode list. If a single scalar
12059 value is returned it will be converted into a list with only one element.
12060 @item @code{scalar}, @code{verbatim}
12061 The results should be interpreted literally---they will not be
12062 converted into a table. The results will be inserted into the Org-mode
12063 buffer as quoted text. E.g., @code{:results value verbatim}.
12065 The results will be interpreted as the path to a file, and will be inserted
12066 into the Org-mode buffer as a file link. E.g., @code{:results value file}.
12067 @item @code{raw}, @code{org}
12068 The results are interpreted as raw Org-mode code and are inserted directly
12069 into the buffer. If the results look like a table they will be aligned as
12070 such by Org-mode. E.g., @code{:results value raw}.
12072 Results are assumed to be HTML and will be enclosed in a @code{begin_html}
12073 block. E.g., @code{:results value html}.
12075 Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block.
12076 E.g., @code{:results value latex}.
12078 Result are assumed to be parseable code and are enclosed in a code block.
12079 E.g., @code{:results value code}.
12081 The result is converted to pretty-printed code and is enclosed in a code
12082 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
12083 @code{:results value pp}.
12085 The result is wrapped in a @code{begin_result} block. This can be useful for
12086 inserting @code{raw} or @code{org} syntax results in such a way that their
12087 extend is known and they can be automatically removed or replaced.
12090 @subsubheading Handling
12091 The following results options indicate what happens with the
12092 results once they are collected.
12095 @item @code{silent}
12096 The results will be echoed in the minibuffer but will not be inserted into
12097 the Org-mode buffer. E.g., @code{:results output silent}.
12098 @item @code{replace}
12099 The default value. Any existing results will be removed, and the new results
12100 will be inserted into the Org-mode buffer in their place. E.g.,
12101 @code{:results output replace}.
12102 @item @code{append}
12103 If there are pre-existing results of the code block then the new results will
12104 be appended to the existing results. Otherwise the new results will be
12105 inserted as with @code{replace}.
12106 @item @code{prepend}
12107 If there are pre-existing results of the code block then the new results will
12108 be prepended to the existing results. Otherwise the new results will be
12109 inserted as with @code{replace}.
12112 @node file, dir, results, Specific header arguments
12113 @subsubsection @code{:file}
12115 The header argument @code{:file} is used to specify an external file in which
12116 to save code block results. After code block evaluation an Org-mode style
12117 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
12118 into the Org-mode buffer. Some languages including R, gnuplot, dot, and
12119 ditaa provide special handling of the @code{:file} header argument
12120 automatically wrapping the code block body in the boilerplate code required
12121 to save output to the specified file. This is often useful for saving
12122 graphical output of a code block to the specified file.
12124 The argument to @code{:file} should be either a string specifying the path to
12125 a file, or a list of two strings in which case the first element of the list
12126 should be the path to a file and the second a description for the link.
12128 @node dir, exports, file, Specific header arguments
12129 @subsubsection @code{:dir} and remote execution
12131 While the @code{:file} header argument can be used to specify the path to the
12132 output file, @code{:dir} specifies the default directory during code block
12133 execution. If it is absent, then the directory associated with the current
12134 buffer is used. In other words, supplying @code{:dir path} temporarily has
12135 the same effect as changing the current directory with @kbd{M-x cd path}, and
12136 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
12137 the value of the Emacs variable @code{default-directory}.
12139 When using @code{:dir}, you should supply a relative path for file output
12140 (e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
12141 case that path will be interpreted relative to the default directory.
12143 In other words, if you want your plot to go into a folder called @file{Work}
12144 in your home directory, you could use
12147 #+begin_src R :file myplot.png :dir ~/Work
12148 matplot(matrix(rnorm(100), 10), type="l")
12152 @subsubheading Remote execution
12153 A directory on a remote machine can be specified using tramp file syntax, in
12154 which case the code will be evaluated on the remote machine. An example is
12157 #+begin_src R :file plot.png :dir /dand@@yakuba.princeton.edu:
12158 plot(1:10, main=system("hostname", intern=TRUE))
12162 Text results will be returned to the local Org-mode buffer as usual, and file
12163 output will be created on the remote machine with relative paths interpreted
12164 relative to the remote directory. An Org-mode link to the remote file will be
12167 So, in the above example a plot will be created on the remote machine,
12168 and a link of the following form will be inserted in the org buffer:
12171 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
12174 Most of this functionality follows immediately from the fact that @code{:dir}
12175 sets the value of the Emacs variable @code{default-directory}, thanks to
12176 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
12177 install tramp separately in order for these features to work correctly.
12179 @subsubheading Further points
12183 If @code{:dir} is used in conjunction with @code{:session}, although it will
12184 determine the starting directory for a new session as expected, no attempt is
12185 currently made to alter the directory associated with an existing session.
12187 @code{:dir} should typically not be used to create files during export with
12188 @code{:exports results} or @code{:exports both}. The reason is that, in order
12189 to retain portability of exported material between machines, during export
12190 links inserted into the buffer will *not* be expanded against @code{default
12191 directory}. Therefore, if @code{default-directory} is altered using
12192 @code{:dir}, it is probable that the file will be created in a location to
12193 which the link does not point.
12196 @node exports, tangle, dir, Specific header arguments
12197 @subsubsection @code{:exports}
12199 The @code{:exports} header argument specifies what should be included in HTML
12200 or LaTeX exports of the Org-mode file.
12204 The default. The body of code is included into the exported file. E.g.,
12205 @code{:exports code}.
12206 @item @code{results}
12207 The result of evaluating the code is included in the exported file. E.g.,
12208 @code{:exports results}.
12210 Both the code and results are included in the exported file. E.g.,
12211 @code{:exports both}.
12213 Nothing is included in the exported file. E.g., @code{:exports none}.
12216 @node tangle, mkdirp, exports, Specific header arguments
12217 @subsubsection @code{:tangle}
12219 The @code{:tangle} header argument specifies whether or not the code
12220 block should be included in tangled extraction of source code files.
12223 @item @code{tangle}
12224 The code block is exported to a source code file named after the
12225 basename (name w/o extension) of the Org-mode file. E.g., @code{:tangle
12228 The default. The code block is not exported to a source code file.
12229 E.g., @code{:tangle no}.
12231 Any other string passed to the @code{:tangle} header argument is interpreted
12232 as a file basename to which the block will be exported. E.g., @code{:tangle
12236 @node mkdirp, comments, tangle, Specific header arguments
12237 @subsubsection @code{:mkdirp}
12239 The @code{:mkdirp} header argument can be used to create parent directories
12240 of tangled files when missing. This can be set to @code{yes} to enable
12241 directory creation or to @code{no} to inhibit directory creation.
12243 @node comments, no-expand, mkdirp, Specific header arguments
12244 @subsubsection @code{:comments}
12245 By default code blocks are tangled to source-code files without any insertion
12246 of comments beyond those which may already exist in the body of the code
12247 block. The @code{:comments} header argument can be set as follows to control
12248 the insertion of extra comments into the tangled code file.
12252 The default. No extra comments are inserted during tangling.
12254 The code block is wrapped in comments which contain pointers back to the
12255 original Org file from which the code was tangled.
12257 A synonym for ``link'' to maintain backwards compatibility.
12259 Include text from the org-mode file as a comment.
12261 The text is picked from the leading context of the tangled code and is
12262 limited by the nearest headline or source block as the case may be.
12264 Turns on both the ``link'' and ``org'' comment options.
12266 Turns on the ``link'' comment option, and additionally wraps expanded noweb
12267 references in the code block body in link comments.
12270 @node no-expand, session, comments, Specific header arguments
12271 @subsubsection @code{:no-expand}
12273 By default, code blocks are expanded with @code{org-babel-expand-src-block}
12274 during tangling. This has the effect of assigning values to variables
12275 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
12276 references (see @ref{Noweb reference syntax}) with their targets. The
12277 @code{:no-expand} header argument can be used to turn off this behavior.
12279 @node session, noweb, no-expand, Specific header arguments
12280 @subsubsection @code{:session}
12282 The @code{:session} header argument starts a session for an interpreted
12283 language where state is preserved.
12285 By default, a session is not started.
12287 A string passed to the @code{:session} header argument will give the session
12288 a name. This makes it possible to run concurrent sessions for each
12289 interpreted language.
12291 @node noweb, cache, session, Specific header arguments
12292 @subsubsection @code{:noweb}
12294 The @code{:noweb} header argument controls expansion of ``noweb'' style (see
12295 @ref{Noweb reference syntax}) references in a code block. This header
12296 argument can have one of three values: @code{yes} @code{no} or @code{tangle}.
12300 All ``noweb'' syntax references in the body of the code block will be
12301 expanded before the block is evaluated, tangled or exported.
12303 The default. No ``noweb'' syntax specific action is taken on evaluating
12304 code blocks, However, noweb references will still be expanded during
12306 @item @code{tangle}
12307 All ``noweb'' syntax references in the body of the code block will be
12308 expanded before the block is tangled, however ``noweb'' references will not
12309 be expanded when the block is evaluated or exported.
12312 @subsubheading Noweb prefix lines
12313 Noweb insertions are now placed behind the line prefix of the
12314 @code{<<reference>>}.
12315 This behavior is illustrated in the following example. Because the
12316 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
12317 each line of the expanded noweb reference will be commented.
12330 -- multi-line body of example
12333 Note that noweb replacement text that does not contain any newlines will not
12334 be affected by this change, so it is still possible to use inline noweb
12337 @node cache, sep, noweb, Specific header arguments
12338 @subsubsection @code{:cache}
12340 The @code{:cache} header argument controls the use of in-buffer caching of
12341 the results of evaluating code blocks. It can be used to avoid re-evaluating
12342 unchanged code blocks. This header argument can have one of two
12343 values: @code{yes} or @code{no}.
12347 The default. No caching takes place, and the code block will be evaluated
12348 every time it is called.
12350 Every time the code block is run a SHA1 hash of the code and arguments
12351 passed to the block will be generated. This hash is packed into the
12352 @code{#+results:} line and will be checked on subsequent
12353 executions of the code block. If the code block has not
12354 changed since the last time it was evaluated, it will not be re-evaluated.
12357 Code block caches notice if the value of a variable argument
12358 to the code block has changed. If this is the case, the cache is
12359 invalidated and the code block is re-run. In the following example,
12360 @code{caller} will not be re-run unless the results of @code{random} have
12361 changed since it was last run.
12365 #+begin_src R :cache yes
12369 #+results[a2a72cd647ad44515fab62e144796432793d68e1]: random
12373 #+begin_src emacs-lisp :var x=random :cache yes
12377 #+results[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
12381 @node sep, hlines, cache, Specific header arguments
12382 @subsubsection @code{:sep}
12384 The @code{:sep} header argument can be used to control the delimiter used
12385 when writing tabular results out to files external to Org-mode. This is used
12386 either when opening tabular results of a code block by calling the
12387 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
12388 or when writing code block results to an external file (see @ref{file})
12391 By default, when @code{:sep} is not specified output tables are tab
12394 @node hlines, colnames, sep, Specific header arguments
12395 @subsubsection @code{:hlines}
12397 Tables are frequently represented with one or more horizontal lines, or
12398 hlines. The @code{:hlines} argument to a code block accepts the
12399 values @code{yes} or @code{no}, with a default value of @code{no}.
12403 Strips horizontal lines from the input table. In most languages this is the
12404 desired effect because an @code{hline} symbol is interpreted as an unbound
12405 variable and raises an error. Setting @code{:hlines no} or relying on the
12406 default value yields the following results.
12409 #+tblname: many-cols
12416 #+source: echo-table
12417 #+begin_src python :var tab=many-cols
12421 #+results: echo-table
12428 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
12431 #+tblname: many-cols
12438 #+source: echo-table
12439 #+begin_src python :var tab=many-cols :hlines yes
12443 #+results: echo-table
12452 @node colnames, rownames, hlines, Specific header arguments
12453 @subsubsection @code{:colnames}
12455 The @code{:colnames} header argument accepts the values @code{yes},
12456 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
12460 If an input table looks like it has column names
12461 (because its second row is an hline), then the column
12462 names will be removed from the table before
12463 processing, then reapplied to the results.
12466 #+tblname: less-cols
12472 #+srcname: echo-table-again
12473 #+begin_src python :var tab=less-cols
12474 return [[val + '*' for val in row] for row in tab]
12477 #+results: echo-table-again
12484 Please note that column names are not removed before the table is indexed
12485 using variable indexing @xref{var, Indexable variable values}.
12488 No column name pre-processing takes place
12491 Column names are removed and reapplied as with @code{nil} even if the table
12492 does not ``look like'' it has column names (i.e.@: the second row is not an
12496 @node rownames, shebang, colnames, Specific header arguments
12497 @subsubsection @code{:rownames}
12499 The @code{:rownames} header argument can take on the values @code{yes}
12500 or @code{no}, with a default value of @code{no}.
12504 No row name pre-processing will take place.
12507 The first column of the table is removed from the table before processing,
12508 and is then reapplied to the results.
12511 #+tblname: with-rownames
12512 | one | 1 | 2 | 3 | 4 | 5 |
12513 | two | 6 | 7 | 8 | 9 | 10 |
12515 #+srcname: echo-table-once-again
12516 #+begin_src python :var tab=with-rownames :rownames yes
12517 return [[val + 10 for val in row] for row in tab]
12520 #+results: echo-table-once-again
12521 | one | 11 | 12 | 13 | 14 | 15 |
12522 | two | 16 | 17 | 18 | 19 | 20 |
12525 Please note that row names are not removed before the table is indexed using
12526 variable indexing @xref{var, Indexable variable values}.
12530 @node shebang, eval, rownames, Specific header arguments
12531 @subsubsection @code{:shebang}
12533 Setting the @code{:shebang} header argument to a string value
12534 (e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
12535 first line of any tangled file holding the code block, and the file
12536 permissions of the tangled file are set to make it executable.
12538 @node eval, , shebang, Specific header arguments
12539 @subsubsection @code{:eval}
12540 The @code{:eval} header argument can be used to limit the evaluation of
12541 specific code blocks. @code{:eval} accepts two arguments ``never'' and
12542 ``query''. @code{:eval never} will ensure that a code block is never
12543 evaluated, this can be useful for protecting against the evaluation of
12544 dangerous code blocks. @code{:eval query} will require a query for every
12545 execution of a code block regardless of the value of the
12546 @code{org-confirm-babel-evaluate} variable.
12548 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
12549 @section Results of evaluation
12550 @cindex code block, results of evaluation
12551 @cindex source code, results of evaluation
12553 The way in which results are handled depends on whether a session is invoked,
12554 as well as on whether @code{:results value} or @code{:results output} is
12555 used. The following table shows the table possibilities. For a full listing
12556 of the possible results header arguments see @ref{results}.
12558 @multitable @columnfractions 0.26 0.33 0.41
12559 @item @tab @b{Non-session} @tab @b{Session}
12560 @item @code{:results value} @tab value of last expression @tab value of last expression
12561 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
12564 Note: With @code{:results value}, the result in both @code{:session} and
12565 non-session is returned to Org-mode as a table (a one- or two-dimensional
12566 vector of strings or numbers) when appropriate.
12568 @subsection Non-session
12569 @subsubsection @code{:results value}
12570 This is the default. Internally, the value is obtained by wrapping the code
12571 in a function definition in the external language, and evaluating that
12572 function. Therefore, code should be written as if it were the body of such a
12573 function. In particular, note that Python does not automatically return a
12574 value from a function unless a @code{return} statement is present, and so a
12575 @samp{return} statement will usually be required in Python.
12577 This is the only one of the four evaluation contexts in which the code is
12578 automatically wrapped in a function definition.
12580 @subsubsection @code{:results output}
12581 The code is passed to the interpreter as an external process, and the
12582 contents of the standard output stream are returned as text. (In certain
12583 languages this also contains the error output stream; this is an area for
12586 @subsection Session
12587 @subsubsection @code{:results value}
12588 The code is passed to the interpreter running as an interactive Emacs
12589 inferior process. The result returned is the result of the last evaluation
12590 performed by the interpreter. (This is obtained in a language-specific
12591 manner: the value of the variable @code{_} in Python and Ruby, and the value
12592 of @code{.Last.value} in R).
12594 @subsubsection @code{:results output}
12595 The code is passed to the interpreter running as an interactive Emacs
12596 inferior process. The result returned is the concatenation of the sequence of
12597 (text) output from the interactive interpreter. Notice that this is not
12598 necessarily the same as what would be sent to @code{STDOUT} if the same code
12599 were passed to a non-interactive interpreter running as an external
12600 process. For example, compare the following two blocks:
12603 #+begin_src python :results output
12614 In non-session mode, the `2' is not printed and does not appear.
12616 #+begin_src python :results output :session
12628 But in @code{:session} mode, the interactive interpreter receives input `2'
12629 and prints out its value, `2'. (Indeed, the other print statements are
12632 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
12633 @section Noweb reference syntax
12634 @cindex code block, noweb reference
12635 @cindex syntax, noweb
12636 @cindex source code, noweb reference
12638 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
12639 Programming system allows named blocks of code to be referenced by using the
12640 familiar Noweb syntax:
12643 <<code-block-name>>
12646 When a code block is tangled or evaluated, whether or not ``noweb''
12647 references are expanded depends upon the value of the @code{:noweb} header
12648 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
12649 evaluation. If @code{:noweb no}, the default, then the reference is not
12650 expanded before evaluation.
12652 Note: the default value, @code{:noweb no}, was chosen to ensure that
12653 correct code is not broken in a language, such as Ruby, where
12654 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
12655 syntactically valid in languages that you use, then please consider setting
12658 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
12659 @section Key bindings and useful functions
12660 @cindex code block, key bindings
12662 Many common Org-mode key sequences are re-bound depending on
12665 Within a code block, the following key bindings
12668 @multitable @columnfractions 0.25 0.75
12670 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
12672 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
12674 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
12676 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
12679 In an Org-mode buffer, the following key bindings are active:
12681 @multitable @columnfractions 0.45 0.55
12683 @kindex C-c C-v C-a
12684 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
12686 @kindex C-c C-v C-b
12687 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
12689 @kindex C-c C-v C-f
12690 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
12692 @item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block}
12694 @item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings}
12696 @kindex C-c C-v C-l
12697 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
12699 @kindex C-c C-v C-p
12700 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
12702 @kindex C-c C-v C-s
12703 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
12705 @kindex C-c C-v C-t
12706 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
12708 @kindex C-c C-v C-z
12709 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
12712 @c When possible these keybindings were extended to work when the control key is
12713 @c kept pressed, resulting in the following additional keybindings.
12715 @c @multitable @columnfractions 0.25 0.75
12716 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
12717 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
12718 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
12719 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
12720 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
12721 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
12722 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
12723 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
12726 @node Batch execution, , Key bindings and useful functions, Working With Source Code
12727 @section Batch execution
12728 @cindex code block, batch execution
12729 @cindex source code, batch execution
12731 It is possible to call functions from the command line. This shell
12732 script calls @code{org-babel-tangle} on every one of its arguments.
12734 Be sure to adjust the paths to fit your system.
12738 # -*- mode: shell-script -*-
12740 # tangle files with org-mode
12744 ORGINSTALL="~/src/org/lisp/org-install.el"
12746 # wrap each argument in the code required to call tangle on it
12748 FILES="$FILES \"$i\""
12751 emacs -Q --batch -l $ORGINSTALL \
12753 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
12754 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
12755 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
12756 (mapc (lambda (file)
12757 (find-file (expand-file-name file \"$DIR\"))
12759 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
12762 @node Miscellaneous, Hacking, Working With Source Code, Top
12763 @chapter Miscellaneous
12766 * Completion:: M-TAB knows what you need
12767 * Easy Templates:: Quick insertion of structural elements
12768 * Speed keys:: Electric commands at the beginning of a headline
12769 * Code evaluation security:: Org mode files evaluate inline code
12770 * Customization:: Adapting Org to your taste
12771 * In-buffer settings:: Overview of the #+KEYWORDS
12772 * The very busy C-c C-c key:: When in doubt, press C-c C-c
12773 * Clean view:: Getting rid of leading stars in the outline
12774 * TTY keys:: Using Org on a tty
12775 * Interaction:: Other Emacs packages
12779 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
12780 @section Completion
12781 @cindex completion, of @TeX{} symbols
12782 @cindex completion, of TODO keywords
12783 @cindex completion, of dictionary words
12784 @cindex completion, of option keywords
12785 @cindex completion, of tags
12786 @cindex completion, of property keys
12787 @cindex completion, of link abbreviations
12788 @cindex @TeX{} symbol completion
12789 @cindex TODO keywords completion
12790 @cindex dictionary word completion
12791 @cindex option keyword completion
12792 @cindex tag completion
12793 @cindex link abbreviations, completion of
12795 Emacs would not be Emacs without completion, and Org-mode uses it whenever it
12796 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
12797 some of the completion prompts, you can specify your preference by setting at
12798 most one of the variables @code{org-completion-use-iswitchb}
12799 @code{org-completion-use-ido}.
12801 Org supports in-buffer completion. This type of completion does
12802 not make use of the minibuffer. You simply type a few letters into
12803 the buffer and use the key to complete text right there.
12806 @kindex M-@key{TAB}
12808 Complete word at point
12811 At the beginning of a headline, complete TODO keywords.
12813 After @samp{\}, complete @TeX{} symbols supported by the exporter.
12815 After @samp{*}, complete headlines in the current buffer so that they
12816 can be used in search links like @samp{[[*find this headline]]}.
12818 After @samp{:} in a headline, complete tags. The list of tags is taken
12819 from the variable @code{org-tag-alist} (possibly set through the
12820 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
12821 dynamically from all tags used in the current buffer.
12823 After @samp{:} and not in a headline, complete property keys. The list
12824 of keys is constructed dynamically from all keys used in the current
12827 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
12829 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
12830 @samp{OPTIONS} which set file-specific options for Org-mode. When the
12831 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
12832 will insert example settings for this keyword.
12834 In the line after @samp{#+STARTUP: }, complete startup keywords,
12835 i.e.@: valid keys for this line.
12837 Elsewhere, complete dictionary words using Ispell.
12841 @node Easy Templates, Speed keys, Completion, Miscellaneous
12842 @section Easy Templates
12843 @cindex template insertion
12844 @cindex insertion, of templates
12846 Org-mode supports insertion of empty structural elements (like
12847 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
12848 strokes. This is achieved through a native template expansion mechanism.
12849 Note that Emacs has several other template mechanisms which could be used in
12850 a similar way, for example @file{yasnippet}.
12852 To insert a structural element, type a @samp{<}, followed by a template
12853 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
12854 keystrokes are typed on a line by itself.
12856 The following template selectors are currently supported.
12858 @multitable @columnfractions 0.1 0.9
12859 @item @kbd{s} @tab @code{#+begin_src ... #+end_src}
12860 @item @kbd{e} @tab @code{#+begin_example ... #+end_example}
12861 @item @kbd{q} @tab @code{#+begin_quote ... #+end_quote}
12862 @item @kbd{v} @tab @code{#+begin_verse ... #+end_verse}
12863 @item @kbd{c} @tab @code{#+begin_center ... #+end_center}
12864 @item @kbd{l} @tab @code{#+begin_latex ... #+end_latex}
12865 @item @kbd{L} @tab @code{#+latex:}
12866 @item @kbd{h} @tab @code{#+begin_html ... #+end_html}
12867 @item @kbd{H} @tab @code{#+html:}
12868 @item @kbd{a} @tab @code{#+begin_ascii ... #+end_ascii}
12869 @item @kbd{A} @tab @code{#+ascii:}
12870 @item @kbd{i} @tab @code{#+include:} line
12873 For example, on an empty line, typing "<e" and then pressing TAB, will expand
12874 into a complete EXAMPLE template.
12876 You can install additional templates by customizing the variable
12877 @code{org-structure-template-alist}. See the docstring of the variable for
12878 additional details.
12880 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
12881 @section Speed keys
12883 @vindex org-use-speed-commands
12884 @vindex org-speed-commands-user
12886 Single keys can be made to execute commands when the cursor is at the
12887 beginning of a headline, i.e.@: before the first star. Configure the variable
12888 @code{org-use-speed-commands} to activate this feature. There is a
12889 pre-defined list of commands, and you can add more such commands using the
12890 variable @code{org-speed-commands-user}. Speed keys do not only speed up
12891 navigation and other commands, but they also provide an alternative way to
12892 execute commands bound to keys that are not or not easily available on a TTY,
12893 or on a small mobile device with a limited keyboard.
12895 To see which commands are available, activate the feature and press @kbd{?}
12896 with the cursor at the beginning of a headline.
12898 @node Code evaluation security, Customization, Speed keys, Miscellaneous
12899 @section Code evaluation and security issues
12901 Org provides tools to work with the code snippets, including evaluating them.
12903 Running code on your machine always comes with a security risk. Badly
12904 written or malicious code can be executed on purpose or by accident. Org has
12905 default settings which will only evaluate such code if you give explicit
12906 permission to do so, and as a casual user of these features you should leave
12907 these precautions intact.
12909 For people who regularly work with such code, the confirmation prompts can
12910 become annoying, and you might want to turn them off. This can be done, but
12911 you must be aware of the risks that are involved.
12913 Code evaluation can happen under the following circumstances:
12916 @item Source code blocks
12917 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
12918 C-c} in the block. The most important thing to realize here is that Org mode
12919 files which contain code snippets are, in a certain sense, like executable
12920 files. So you should accept them and load them into Emacs only from trusted
12921 sources---just like you would do with a program you install on your computer.
12923 Make sure you know what you are doing before customizing the variables
12924 which take off the default security brakes.
12926 @defopt org-confirm-babel-evaluate
12927 When t (the default), the user is asked before every code block evaluation.
12928 When nil, the user is not asked. When set to a function, it is called with
12929 two arguments (language and body of the code block) and should return t to
12930 ask and nil not to ask.
12933 For example, here is how to execute "ditaa" code (which is considered safe)
12936 (defun my-org-confirm-babel-evaluate (lang body)
12937 (not (string= lang "ditaa"))) ; don't ask for ditaa
12938 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
12941 @item Following @code{shell} and @code{elisp} links
12942 Org has two link types that can directly evaluate code (@pxref{External
12943 links}). These links can be problematic because the code to be evaluated is
12946 @defopt org-confirm-shell-link-function
12947 Function to queries user about shell link execution.
12949 @defopt org-confirm-elisp-link-function
12950 Functions to query user for Emacs Lisp link execution.
12953 @item Formulas in tables
12954 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
12955 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
12958 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
12959 @section Customization
12960 @cindex customization
12961 @cindex options, for customization
12962 @cindex variables, for customization
12964 There are more than 180 variables that can be used to customize
12965 Org. For the sake of compactness of the manual, I am not
12966 describing the variables here. A structured overview of customization
12967 variables is available with @kbd{M-x org-customize}. Or select
12968 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
12969 settings can also be activated on a per-file basis, by putting special
12970 lines into the buffer (@pxref{In-buffer settings}).
12972 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
12973 @section Summary of in-buffer settings
12974 @cindex in-buffer settings
12975 @cindex special keywords
12977 Org-mode uses special lines in the buffer to define settings on a
12978 per-file basis. These lines start with a @samp{#+} followed by a
12979 keyword, a colon, and then individual words defining a setting. Several
12980 setting words can be in the same line, but you can also have multiple
12981 lines for the keyword. While these settings are described throughout
12982 the manual, here is a summary. After changing any of those lines in the
12983 buffer, press @kbd{C-c C-c} with the cursor still in the line to
12984 activate the changes immediately. Otherwise they become effective only
12985 when the file is visited again in a new Emacs session.
12987 @vindex org-archive-location
12989 @item #+ARCHIVE: %s_done::
12990 This line sets the archive location for the agenda file. It applies for
12991 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
12992 of the file. The first such line also applies to any entries before it.
12993 The corresponding variable is @code{org-archive-location}.
12995 This line sets the category for the agenda file. The category applies
12996 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
12997 end of the file. The first such line also applies to any entries before it.
12998 @item #+COLUMNS: %25ITEM .....
12999 @cindex property, COLUMNS
13000 Set the default format for columns view. This format applies when
13001 columns view is invoked in locations where no @code{COLUMNS} property
13003 @item #+CONSTANTS: name1=value1 ...
13004 @vindex org-table-formula-constants
13005 @vindex org-table-formula
13006 Set file-local values for constants to be used in table formulas. This
13007 line sets the local variable @code{org-table-formula-constants-local}.
13008 The global version of this variable is
13009 @code{org-table-formula-constants}.
13010 @item #+FILETAGS: :tag1:tag2:tag3:
13011 Set tags that can be inherited by any entry in the file, including the
13013 @item #+DRAWERS: NAME1 .....
13014 @vindex org-drawers
13015 Set the file-local set of drawers. The corresponding global variable is
13016 @code{org-drawers}.
13017 @item #+LINK: linkword replace
13018 @vindex org-link-abbrev-alist
13019 These lines (several are allowed) specify link abbreviations.
13020 @xref{Link abbreviations}. The corresponding variable is
13021 @code{org-link-abbrev-alist}.
13022 @item #+PRIORITIES: highest lowest default
13023 @vindex org-highest-priority
13024 @vindex org-lowest-priority
13025 @vindex org-default-priority
13026 This line sets the limits and the default for the priorities. All three
13027 must be either letters A-Z or numbers 0-9. The highest priority must
13028 have a lower ASCII number than the lowest priority.
13029 @item #+PROPERTY: Property_Name Value
13030 This line sets a default inheritance value for entries in the current
13031 buffer, most useful for specifying the allowed values of a property.
13032 @cindex #+SETUPFILE
13033 @item #+SETUPFILE: file
13034 This line defines a file that holds more in-buffer setup. Normally this is
13035 entirely ignored. Only when the buffer is parsed for option-setting lines
13036 (i.e.@: when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a
13037 settings line, or when exporting), then the contents of this file are parsed
13038 as if they had been included in the buffer. In particular, the file can be
13039 any other Org-mode file with internal setup. You can visit the file the
13040 cursor is in the line with @kbd{C-c '}.
13043 This line sets options to be used at startup of Org-mode, when an
13044 Org file is being visited.
13046 The first set of options deals with the initial visibility of the outline
13047 tree. The corresponding variable for global default settings is
13048 @code{org-startup-folded}, with a default value @code{t}, which means
13050 @vindex org-startup-folded
13051 @cindex @code{overview}, STARTUP keyword
13052 @cindex @code{content}, STARTUP keyword
13053 @cindex @code{showall}, STARTUP keyword
13054 @cindex @code{showeverything}, STARTUP keyword
13056 overview @r{top-level headlines only}
13057 content @r{all headlines}
13058 showall @r{no folding of any entries}
13059 showeverything @r{show even drawer contents}
13062 @vindex org-startup-indented
13063 @cindex @code{indent}, STARTUP keyword
13064 @cindex @code{noindent}, STARTUP keyword
13065 Dynamic virtual indentation is controlled by the variable
13066 @code{org-startup-indented}@footnote{Emacs 23 and Org-mode 6.29 are required}
13068 indent @r{start with @code{org-indent-mode} turned on}
13069 noindent @r{start with @code{org-indent-mode} turned off}
13072 @vindex org-startup-align-all-tables
13073 Then there are options for aligning tables upon visiting a file. This
13074 is useful in files containing narrowed table columns. The corresponding
13075 variable is @code{org-startup-align-all-tables}, with a default value
13077 @cindex @code{align}, STARTUP keyword
13078 @cindex @code{noalign}, STARTUP keyword
13080 align @r{align all tables}
13081 noalign @r{don't align tables on startup}
13084 @vindex org-startup-with-inline-images
13085 When visiting a file, inline images can be automatically displayed. The
13086 corresponding variable is @code{org-startup-with-inline-images}, with a
13087 default value @code{nil} to avoid delays when visiting a file.
13088 @cindex @code{inlineimages}, STARTUP keyword
13089 @cindex @code{noinlineimages}, STARTUP keyword
13091 inlineimages @r{show inline images}
13092 noinlineimages @r{don't show inline images on startup}
13095 @vindex org-log-done
13096 @vindex org-log-note-clock-out
13097 @vindex org-log-repeat
13098 Logging the closing and reopening of TODO items and clock intervals can be
13099 configured using these options (see variables @code{org-log-done},
13100 @code{org-log-note-clock-out} and @code{org-log-repeat})
13101 @cindex @code{logdone}, STARTUP keyword
13102 @cindex @code{lognotedone}, STARTUP keyword
13103 @cindex @code{nologdone}, STARTUP keyword
13104 @cindex @code{lognoteclock-out}, STARTUP keyword
13105 @cindex @code{nolognoteclock-out}, STARTUP keyword
13106 @cindex @code{logrepeat}, STARTUP keyword
13107 @cindex @code{lognoterepeat}, STARTUP keyword
13108 @cindex @code{nologrepeat}, STARTUP keyword
13109 @cindex @code{logreschedule}, STARTUP keyword
13110 @cindex @code{lognotereschedule}, STARTUP keyword
13111 @cindex @code{nologreschedule}, STARTUP keyword
13112 @cindex @code{logredeadline}, STARTUP keyword
13113 @cindex @code{lognoteredeadline}, STARTUP keyword
13114 @cindex @code{nologredeadline}, STARTUP keyword
13115 @cindex @code{logrefile}, STARTUP keyword
13116 @cindex @code{lognoterefile}, STARTUP keyword
13117 @cindex @code{nologrefile}, STARTUP keyword
13119 logdone @r{record a timestamp when an item is marked DONE}
13120 lognotedone @r{record timestamp and a note when DONE}
13121 nologdone @r{don't record when items are marked DONE}
13122 logrepeat @r{record a time when reinstating a repeating item}
13123 lognoterepeat @r{record a note when reinstating a repeating item}
13124 nologrepeat @r{do not record when reinstating repeating item}
13125 lognoteclock-out @r{record a note when clocking out}
13126 nolognoteclock-out @r{don't record a note when clocking out}
13127 logreschedule @r{record a timestamp when scheduling time changes}
13128 lognotereschedule @r{record a note when scheduling time changes}
13129 nologreschedule @r{do not record when a scheduling date changes}
13130 logredeadline @r{record a timestamp when deadline changes}
13131 lognoteredeadline @r{record a note when deadline changes}
13132 nologredeadline @r{do not record when a deadline date changes}
13133 logrefile @r{record a timestamp when refiling}
13134 lognoterefile @r{record a note when refiling}
13135 nologrefile @r{do not record when refiling}
13137 @vindex org-hide-leading-stars
13138 @vindex org-odd-levels-only
13139 Here are the options for hiding leading stars in outline headings, and for
13140 indenting outlines. The corresponding variables are
13141 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
13142 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
13143 @cindex @code{hidestars}, STARTUP keyword
13144 @cindex @code{showstars}, STARTUP keyword
13145 @cindex @code{odd}, STARTUP keyword
13146 @cindex @code{even}, STARTUP keyword
13148 hidestars @r{make all but one of the stars starting a headline invisible.}
13149 showstars @r{show all stars starting a headline}
13150 indent @r{virtual indentation according to outline level}
13151 noindent @r{no virtual indentation according to outline level}
13152 odd @r{allow only odd outline levels (1,3,...)}
13153 oddeven @r{allow all outline levels}
13155 @vindex org-put-time-stamp-overlays
13156 @vindex org-time-stamp-overlay-formats
13157 To turn on custom format overlays over timestamps (variables
13158 @code{org-put-time-stamp-overlays} and
13159 @code{org-time-stamp-overlay-formats}), use
13160 @cindex @code{customtime}, STARTUP keyword
13162 customtime @r{overlay custom time format}
13164 @vindex constants-unit-system
13165 The following options influence the table spreadsheet (variable
13166 @code{constants-unit-system}).
13167 @cindex @code{constcgs}, STARTUP keyword
13168 @cindex @code{constSI}, STARTUP keyword
13170 constcgs @r{@file{constants.el} should use the c-g-s unit system}
13171 constSI @r{@file{constants.el} should use the SI unit system}
13173 @vindex org-footnote-define-inline
13174 @vindex org-footnote-auto-label
13175 @vindex org-footnote-auto-adjust
13176 To influence footnote settings, use the following keywords. The
13177 corresponding variables are @code{org-footnote-define-inline},
13178 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
13179 @cindex @code{fninline}, STARTUP keyword
13180 @cindex @code{nofninline}, STARTUP keyword
13181 @cindex @code{fnlocal}, STARTUP keyword
13182 @cindex @code{fnprompt}, STARTUP keyword
13183 @cindex @code{fnauto}, STARTUP keyword
13184 @cindex @code{fnconfirm}, STARTUP keyword
13185 @cindex @code{fnplain}, STARTUP keyword
13186 @cindex @code{fnadjust}, STARTUP keyword
13187 @cindex @code{nofnadjust}, STARTUP keyword
13189 fninline @r{define footnotes inline}
13190 fnnoinline @r{define footnotes in separate section}
13191 fnlocal @r{define footnotes near first reference, but not inline}
13192 fnprompt @r{prompt for footnote labels}
13193 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
13194 fnconfirm @r{offer automatic label for editing or confirmation}
13195 fnplain @r{create @code{[1]}-like labels automatically}
13196 fnadjust @r{automatically renumber and sort footnotes}
13197 nofnadjust @r{do not renumber and sort automatically}
13199 @cindex org-hide-block-startup
13200 To hide blocks on startup, use these keywords. The corresponding variable is
13201 @code{org-hide-block-startup}.
13202 @cindex @code{hideblocks}, STARTUP keyword
13203 @cindex @code{nohideblocks}, STARTUP keyword
13205 hideblocks @r{Hide all begin/end blocks on startup}
13206 nohideblocks @r{Do not hide blocks on startup}
13208 @cindex org-pretty-entities
13209 The display of entities as UTF-8 characters is governed by the variable
13210 @code{org-pretty-entities} and the keywords
13211 @cindex @code{entitiespretty}, STARTUP keyword
13212 @cindex @code{entitiesplain}, STARTUP keyword
13214 entitiespretty @r{Show entities as UTF-8 characters where possible}
13215 entitiesplain @r{Leave entities plain}
13217 @item #+TAGS: TAG1(c1) TAG2(c2)
13218 @vindex org-tag-alist
13219 These lines (several such lines are allowed) specify the valid tags in
13220 this file, and (potentially) the corresponding @emph{fast tag selection}
13221 keys. The corresponding variable is @code{org-tag-alist}.
13223 This line contains the formulas for the table directly above the line.
13224 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
13225 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
13226 @itemx #+DESCRIPTION:, #+KEYWORDS:,
13227 @itemx #+LATEX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
13228 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
13229 These lines provide settings for exporting files. For more details see
13230 @ref{Export options}.
13231 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
13232 @vindex org-todo-keywords
13233 These lines set the TODO keywords and their interpretation in the
13234 current file. The corresponding variable is @code{org-todo-keywords}.
13237 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
13238 @section The very busy C-c C-c key
13240 @cindex C-c C-c, overview
13242 The key @kbd{C-c C-c} has many purposes in Org, which are all
13243 mentioned scattered throughout this manual. One specific function of
13244 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
13245 other circumstances it means something like @emph{``Hey Org, look
13246 here and update according to what you see here''}. Here is a summary of
13247 what this means in different contexts.
13251 If there are highlights in the buffer from the creation of a sparse
13252 tree, or from clock display, remove these highlights.
13254 If the cursor is in one of the special @code{#+KEYWORD} lines, this
13255 triggers scanning the buffer for these lines and updating the
13258 If the cursor is inside a table, realign the table. This command
13259 works even if the automatic table editor has been turned off.
13261 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
13264 If the current buffer is a capture buffer, close the note and file it.
13265 With a prefix argument, file it, without further interaction, to the
13268 If the cursor is on a @code{<<<target>>>}, update radio targets and
13269 corresponding links in this buffer.
13271 If the cursor is in a property line or at the start or end of a property
13272 drawer, offer property commands.
13274 If the cursor is at a footnote reference, go to the corresponding
13275 definition, and vice versa.
13277 If the cursor is on a statistics cookie, update it.
13279 If the cursor is in a plain list item with a checkbox, toggle the status
13282 If the cursor is on a numbered item in a plain list, renumber the
13285 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
13289 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
13290 @section A cleaner outline view
13291 @cindex hiding leading stars
13292 @cindex dynamic indentation
13293 @cindex odd-levels-only outlines
13294 @cindex clean outline view
13296 Some people find it noisy and distracting that the Org headlines start with a
13297 potentially large number of stars, and that text below the headlines is not
13298 indented. While this is no problem when writing a @emph{book-like} document
13299 where the outline headings are really section headings, in a more
13300 @emph{list-oriented} outline, indented structure is a lot cleaner:
13304 * Top level headline | * Top level headline
13305 ** Second level | * Second level
13306 *** 3rd level | * 3rd level
13307 some text | some text
13308 *** 3rd level | * 3rd level
13309 more text | more text
13310 * Another top level headline | * Another top level headline
13316 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
13317 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
13318 be achieved dynamically at display time using @code{org-indent-mode}. In
13319 this minor mode, all lines are prefixed for display with the necessary amount
13320 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
13321 property, such that @code{visual-line-mode} (or purely setting
13322 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
13323 }. Also headlines are prefixed with additional stars, so that the amount of
13324 indentation shifts by two@footnote{See the variable
13325 @code{org-indent-indentation-per-level}.} spaces per level. All headline
13326 stars but the last one are made invisible using the @code{org-hide}
13327 face@footnote{Turning on @code{org-indent-mode} sets
13328 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
13329 @code{nil}.} - see below under @samp{2.} for more information on how this
13330 works. You can turn on @code{org-indent-mode} for all files by customizing
13331 the variable @code{org-startup-indented}, or you can turn it on for
13332 individual files using
13338 If you want a similar effect in an earlier version of Emacs and/or Org, or if
13339 you want the indentation to be hard space characters so that the plain text
13340 file looks as similar as possible to the Emacs display, Org supports you in
13345 @emph{Indentation of text below headlines}@*
13346 You may indent text below each headline to make the left boundary line up
13347 with the headline, like
13351 more text, now indented
13354 @vindex org-adapt-indentation
13355 Org supports this with paragraph filling, line wrapping, and structure
13356 editing@footnote{See also the variable @code{org-adapt-indentation}.},
13357 preserving or adapting the indentation as appropriate.
13360 @vindex org-hide-leading-stars
13361 @emph{Hiding leading stars}@* You can modify the display in such a way that
13362 all leading stars become invisible. To do this in a global way, configure
13363 the variable @code{org-hide-leading-stars} or change this on a per-file basis
13367 #+STARTUP: hidestars
13368 #+STARTUP: showstars
13371 With hidden stars, the tree becomes:
13375 * Top level headline
13383 @vindex org-hide @r{(face)}
13384 The leading stars are not truly replaced by whitespace, they are only
13385 fontified with the face @code{org-hide} that uses the background color as
13386 font color. If you are not using either white or black background, you may
13387 have to customize this face to get the wanted effect. Another possibility is
13388 to set this font such that the extra stars are @i{almost} invisible, for
13389 example using the color @code{grey90} on a white background.
13392 @vindex org-odd-levels-only
13393 Things become cleaner still if you skip all the even levels and use only odd
13394 levels 1, 3, 5..., effectively adding two stars to go from one outline level
13395 to the next@footnote{When you need to specify a level for a property search
13396 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
13397 way we get the outline view shown at the beginning of this section. In order
13398 to make the structure editing and export commands handle this convention
13399 correctly, configure the variable @code{org-odd-levels-only}, or set this on
13400 a per-file basis with one of the following lines:
13407 You can convert an Org file from single-star-per-level to the
13408 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
13409 RET} in that file. The reverse operation is @kbd{M-x
13410 org-convert-to-oddeven-levels}.
13413 @node TTY keys, Interaction, Clean view, Miscellaneous
13414 @section Using Org on a tty
13415 @cindex tty key bindings
13417 Because Org contains a large number of commands, by default many of
13418 Org's core commands are bound to keys that are generally not
13419 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
13420 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
13421 together with modifiers like @key{Meta} and/or @key{Shift}. To access
13422 these commands on a tty when special keys are unavailable, the following
13423 alternative bindings can be used. The tty bindings below will likely be
13424 more cumbersome; you may find for some of the bindings below that a
13425 customized workaround suits you better. For example, changing a timestamp
13426 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
13427 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
13429 @multitable @columnfractions 0.15 0.2 0.1 0.2
13430 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
13431 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
13432 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
13433 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
13434 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
13435 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
13436 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
13437 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
13438 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
13439 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
13440 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
13441 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
13442 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
13443 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
13444 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
13445 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
13446 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
13447 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
13448 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
13452 @node Interaction, , TTY keys, Miscellaneous
13453 @section Interaction with other packages
13454 @cindex packages, interaction with other
13455 Org lives in the world of GNU Emacs and interacts in various ways
13456 with other code out there.
13459 * Cooperation:: Packages Org cooperates with
13460 * Conflicts:: Packages that lead to conflicts
13463 @node Cooperation, Conflicts, Interaction, Interaction
13464 @subsection Packages that Org cooperates with
13467 @cindex @file{calc.el}
13468 @cindex Gillespie, Dave
13469 @item @file{calc.el} by Dave Gillespie
13470 Org uses the Calc package for implementing spreadsheet
13471 functionality in its tables (@pxref{The spreadsheet}). Org
13472 checks for the availability of Calc by looking for the function
13473 @code{calc-eval} which will have been autoloaded during setup if Calc has
13474 been installed properly. As of Emacs 22, Calc is part of the Emacs
13475 distribution. Another possibility for interaction between the two
13476 packages is using Calc for embedded calculations. @xref{Embedded Mode,
13477 , Embedded Mode, Calc, GNU Emacs Calc Manual}.
13478 @item @file{constants.el} by Carsten Dominik
13479 @cindex @file{constants.el}
13480 @cindex Dominik, Carsten
13481 @vindex org-table-formula-constants
13482 In a table formula (@pxref{The spreadsheet}), it is possible to use
13483 names for natural constants or units. Instead of defining your own
13484 constants in the variable @code{org-table-formula-constants}, install
13485 the @file{constants} package which defines a large number of constants
13486 and units, and lets you use unit prefixes like @samp{M} for
13487 @samp{Mega}, etc@. You will need version 2.0 of this package, available
13488 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
13489 the function @code{constants-get}, which has to be autoloaded in your
13490 setup. See the installation instructions in the file
13491 @file{constants.el}.
13492 @item @file{cdlatex.el} by Carsten Dominik
13493 @cindex @file{cdlatex.el}
13494 @cindex Dominik, Carsten
13495 Org-mode can make use of the CDLa@TeX{} package to efficiently enter
13496 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
13497 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
13498 @cindex @file{imenu.el}
13499 Imenu allows menu access to an index of items in a file. Org-mode
13500 supports Imenu---all you need to do to get the index is the following:
13502 (add-hook 'org-mode-hook
13503 (lambda () (imenu-add-to-menubar "Imenu")))
13505 @vindex org-imenu-depth
13506 By default the index is two levels deep---you can modify the depth using
13507 the option @code{org-imenu-depth}.
13508 @item @file{remember.el} by John Wiegley
13509 @cindex @file{remember.el}
13510 @cindex Wiegley, John
13511 Org used to use this package for capture, but no longer does.
13512 @item @file{speedbar.el} by Eric M. Ludlam
13513 @cindex @file{speedbar.el}
13514 @cindex Ludlam, Eric M.
13515 Speedbar is a package that creates a special frame displaying files and
13516 index items in files. Org-mode supports Speedbar and allows you to
13517 drill into Org files directly from the Speedbar. It also allows you to
13518 restrict the scope of agenda commands to a file or a subtree by using
13519 the command @kbd{<} in the Speedbar frame.
13520 @cindex @file{table.el}
13521 @item @file{table.el} by Takaaki Ota
13523 @cindex table editor, @file{table.el}
13524 @cindex @file{table.el}
13525 @cindex Ota, Takaaki
13527 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
13528 and alignment can be created using the Emacs table package by Takaaki Ota
13529 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
13530 Org-mode will recognize these tables and export them properly. Because of
13531 interference with other Org-mode functionality, you unfortunately cannot edit
13532 these tables directly in the buffer. Instead, you need to use the command
13533 @kbd{C-c '} to edit them, similar to source code snippets.
13536 @orgcmd{C-c ',org-edit-special}
13537 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
13539 @orgcmd{C-c ~,org-table-create-with-table.el}
13540 Insert a @file{table.el} table. If there is already a table at point, this
13541 command converts it between the @file{table.el} format and the Org-mode
13542 format. See the documentation string of the command
13543 @code{org-convert-table} for the restrictions under which this is
13546 @file{table.el} is part of Emacs since Emacs 22.
13547 @item @file{footnote.el} by Steven L. Baur
13548 @cindex @file{footnote.el}
13549 @cindex Baur, Steven L.
13550 Org-mode recognizes numerical footnotes as provided by this package.
13551 However, Org-mode also has its own footnote support (@pxref{Footnotes}),
13552 which makes using @file{footnote.el} unnecessary.
13555 @node Conflicts, , Cooperation, Interaction
13556 @subsection Packages that lead to conflicts with Org-mode
13560 @cindex @code{shift-selection-mode}
13561 @vindex org-support-shift-select
13562 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
13563 cursor motions combined with the shift key should start or enlarge regions.
13564 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
13565 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
13566 at such a location. By default, @kbd{S-@key{cursor}} commands outside
13567 special contexts don't do anything, but you can customize the variable
13568 @code{org-support-shift-select}. Org-mode then tries to accommodate shift
13569 selection by (i) using it outside of the special contexts where special
13570 commands apply, and by (ii) extending an existing active region even if the
13571 cursor moves across a special context.
13573 @item @file{CUA.el} by Kim. F. Storm
13574 @cindex @file{CUA.el}
13575 @cindex Storm, Kim. F.
13576 @vindex org-replace-disputed-keys
13577 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
13578 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
13579 region. In fact, Emacs 23 has this built-in in the form of
13580 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
13581 23, you probably don't want to use another package for this purpose. However,
13582 if you prefer to leave these keys to a different package while working in
13583 Org-mode, configure the variable @code{org-replace-disputed-keys}. When set,
13584 Org will move the following key bindings in Org files, and in the agenda
13585 buffer (but not during date selection).
13588 S-UP @result{} M-p S-DOWN @result{} M-n
13589 S-LEFT @result{} M-- S-RIGHT @result{} M-+
13590 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
13593 @vindex org-disputed-keys
13594 Yes, these are unfortunately more difficult to remember. If you want
13595 to have other replacement keys, look at the variable
13596 @code{org-disputed-keys}.
13598 @item @file{yasnippet.el}
13599 @cindex @file{yasnippet.el}
13600 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
13601 @code{"\t"}) overrules YASnippet's access to this key. The following code
13602 fixed this problem:
13605 (add-hook 'org-mode-hook
13607 (org-set-local 'yas/trigger-key [tab])
13608 (define-key yas/keymap [tab] 'yas/next-field-group)))
13611 The latest version of yasnippet doesn't play well with Org mode. If the
13612 above code does not fix the conflict, start by defining the following
13616 (defun yas/org-very-safe-expand ()
13617 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
13620 Then, tell Org mode what to do with the new function:
13623 (add-hook 'org-mode-hook
13625 (make-variable-buffer-local 'yas/trigger-key)
13626 (setq yas/trigger-key [tab])
13627 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
13628 (define-key yas/keymap [tab] 'yas/next-field)))
13631 @item @file{windmove.el} by Hovav Shacham
13632 @cindex @file{windmove.el}
13633 This package also uses the @kbd{S-<cursor>} keys, so everything written
13634 in the paragraph above about CUA mode also applies here. If you want make
13635 the windmove function active in locations where Org-mode does not have
13636 special functionality on @kbd{S-@key{cursor}}, add this to your
13640 ;; Make windmove work in org-mode:
13641 (add-hook 'org-shiftup-final-hook 'windmove-up)
13642 (add-hook 'org-shiftleft-final-hook 'windmove-left)
13643 (add-hook 'org-shiftdown-final-hook 'windmove-down)
13644 (add-hook 'org-shiftright-final-hook 'windmove-right)
13647 @item @file{viper.el} by Michael Kifer
13648 @cindex @file{viper.el}
13650 Viper uses @kbd{C-c /} and therefore makes this key not access the
13651 corresponding Org-mode command @code{org-sparse-tree}. You need to find
13652 another key for this command, or override the key in
13653 @code{viper-vi-global-user-map} with
13656 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
13662 @node Hacking, MobileOrg, Miscellaneous, Top
13666 This appendix covers some aspects where users can extend the functionality of
13670 * Hooks:: Who to reach into Org's internals
13671 * Add-on packages:: Available extensions
13672 * Adding hyperlink types:: New custom link types
13673 * Context-sensitive commands:: How to add functionality to such commands
13674 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
13675 * Dynamic blocks:: Automatically filled blocks
13676 * Special agenda views:: Customized views
13677 * Extracting agenda information:: Postprocessing of agenda information
13678 * Using the property API:: Writing programs that use entry properties
13679 * Using the mapping API:: Mapping over all or selected entries
13682 @node Hooks, Add-on packages, Hacking, Hacking
13686 Org has a large number of hook variables that can be used to add
13687 functionality. This appendix about hacking is going to illustrate the
13688 use of some of them. A complete list of all hooks with documentation is
13689 maintained by the Worg project and can be found at
13690 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
13692 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
13693 @section Add-on packages
13694 @cindex add-on packages
13696 A large number of add-on packages have been written by various authors.
13697 These packages are not part of Emacs, but they are distributed as contributed
13698 packages with the separate release available at the Org-mode home page at
13699 @uref{http://orgmode.org}. The list of contributed packages, along with
13700 documentation about each package, is maintained by the Worg project at
13701 @uref{http://orgmode.org/worg/org-contrib/}.
13705 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
13706 @section Adding hyperlink types
13707 @cindex hyperlinks, adding new types
13709 Org has a large number of hyperlink types built-in
13710 (@pxref{Hyperlinks}). If you would like to add new link types, Org
13711 provides an interface for doing so. Let's look at an example file,
13712 @file{org-man.el}, that will add support for creating links like
13713 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
13717 ;;; org-man.el - Support for links to manpages in Org
13721 (org-add-link-type "man" 'org-man-open)
13722 (add-hook 'org-store-link-functions 'org-man-store-link)
13724 (defcustom org-man-command 'man
13725 "The Emacs command to be used to display a man page."
13727 :type '(choice (const man) (const woman)))
13729 (defun org-man-open (path)
13730 "Visit the manpage on PATH.
13731 PATH should be a topic that can be thrown at the man command."
13732 (funcall org-man-command path))
13734 (defun org-man-store-link ()
13735 "Store a link to a manpage."
13736 (when (memq major-mode '(Man-mode woman-mode))
13737 ;; This is a man page, we do make this link
13738 (let* ((page (org-man-get-page-name))
13739 (link (concat "man:" page))
13740 (description (format "Manpage for %s" page)))
13741 (org-store-link-props
13744 :description description))))
13746 (defun org-man-get-page-name ()
13747 "Extract the page name from the buffer name."
13748 ;; This works for both `Man-mode' and `woman-mode'.
13749 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
13750 (match-string 1 (buffer-name))
13751 (error "Cannot create link to this man page")))
13755 ;;; org-man.el ends here
13759 You would activate this new link type in @file{.emacs} with
13766 Let's go through the file and see what it does.
13769 It does @code{(require 'org)} to make sure that @file{org.el} has been
13772 The next line calls @code{org-add-link-type} to define a new link type
13773 with prefix @samp{man}. The call also contains the name of a function
13774 that will be called to follow such a link.
13776 @vindex org-store-link-functions
13777 The next line adds a function to @code{org-store-link-functions}, in
13778 order to allow the command @kbd{C-c l} to record a useful link in a
13779 buffer displaying a man page.
13782 The rest of the file defines the necessary variables and functions.
13783 First there is a customization variable that determines which Emacs
13784 command should be used to display man pages. There are two options,
13785 @code{man} and @code{woman}. Then the function to follow a link is
13786 defined. It gets the link path as an argument---in this case the link
13787 path is just a topic for the manual command. The function calls the
13788 value of @code{org-man-command} to display the man page.
13790 Finally the function @code{org-man-store-link} is defined. When you try
13791 to store a link with @kbd{C-c l}, this function will be called to
13792 try to make a link. The function must first decide if it is supposed to
13793 create the link for this buffer type; we do this by checking the value
13794 of the variable @code{major-mode}. If not, the function must exit and
13795 return the value @code{nil}. If yes, the link is created by getting the
13796 manual topic from the buffer name and prefixing it with the string
13797 @samp{man:}. Then it must call the command @code{org-store-link-props}
13798 and set the @code{:type} and @code{:link} properties. Optionally you
13799 can also set the @code{:description} property to provide a default for
13800 the link description when the link is later inserted into an Org
13801 buffer with @kbd{C-c C-l}.
13803 When it makes sense for your new link type, you may also define a function
13804 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
13805 support for inserting such a link with @kbd{C-c C-l}. Such a function should
13806 not accept any arguments, and return the full link with prefix.
13808 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
13809 @section Context-sensitive commands
13810 @cindex context-sensitive commands, hooks
13811 @cindex add-ons, context-sensitive commands
13812 @vindex org-ctrl-c-ctrl-c-hook
13814 Org has several commands that act differently depending on context. The most
13815 important example it the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
13816 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
13818 Add-ons can tap into this functionality by providing a function that detects
13819 special context for that add-on and executes functionality appropriate for
13820 the context. Here is an example from Dan Davison's @file{org-R.el} which
13821 allows you to evaluate commands based on the @file{R} programming language
13822 @footnote{@file{org-R.el} has been replaced by the org-mode functionality
13823 described in @ref{Working With Source Code} and is now obsolete.}. For this
13824 package, special contexts are lines that start with @code{#+R:} or
13828 (defun org-R-apply-maybe ()
13829 "Detect if this is context for org-R and execute R commands."
13830 (if (save-excursion
13831 (beginning-of-line 1)
13832 (looking-at "#\\+RR?:"))
13833 (progn (call-interactively 'org-R-apply)
13834 t) ;; to signal that we took action
13835 nil)) ;; to signal that we did not
13837 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
13840 The function first checks if the cursor is in such a line. If that is the
13841 case, @code{org-R-apply} is called and the function returns @code{t} to
13842 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
13843 contexts. If the function finds it should do nothing locally, it returns @code{nil} so that other, similar functions can have a try.
13846 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
13847 @section Tables and lists in arbitrary syntax
13848 @cindex tables, in other modes
13849 @cindex lists, in other modes
13850 @cindex Orgtbl mode
13852 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
13853 frequent feature request has been to make it work with native tables in
13854 specific languages, for example @LaTeX{}. However, this is extremely
13855 hard to do in a general way, would lead to a customization nightmare,
13856 and would take away much of the simplicity of the Orgtbl-mode table
13859 This appendix describes a different approach. We keep the Orgtbl mode
13860 table in its native format (the @i{source table}), and use a custom
13861 function to @i{translate} the table to the correct syntax, and to
13862 @i{install} it in the right location (the @i{target table}). This puts
13863 the burden of writing conversion functions on the user, but it allows
13864 for a very flexible system.
13866 Bastien added the ability to do the same with lists, in Orgstruct mode. You
13867 can use Org's facilities to edit and structure lists by turning
13868 @code{orgstruct-mode} on, then locally exporting such lists in another format
13869 (HTML, @LaTeX{} or Texinfo.)
13873 * Radio tables:: Sending and receiving radio tables
13874 * A LaTeX example:: Step by step, almost a tutorial
13875 * Translator functions:: Copy and modify
13876 * Radio lists:: Doing the same for lists
13879 @node Radio tables, A LaTeX example, Tables in arbitrary syntax, Tables in arbitrary syntax
13880 @subsection Radio tables
13881 @cindex radio tables
13883 To define the location of the target table, you first need to create two
13884 lines that are comments in the current mode, but contain magic words for
13885 Orgtbl mode to find. Orgtbl mode will insert the translated table
13886 between these lines, replacing whatever was there before. For example:
13889 /* BEGIN RECEIVE ORGTBL table_name */
13890 /* END RECEIVE ORGTBL table_name */
13894 Just above the source table, we put a special line that tells
13895 Orgtbl mode how to translate this table and where to install it. For
13899 #+ORGTBL: SEND table_name translation_function arguments....
13903 @code{table_name} is the reference name for the table that is also used
13904 in the receiver lines. @code{translation_function} is the Lisp function
13905 that does the translation. Furthermore, the line can contain a list of
13906 arguments (alternating key and value) at the end. The arguments will be
13907 passed as a property list to the translation function for
13908 interpretation. A few standard parameters are already recognized and
13909 acted upon before the translation function is called:
13913 Skip the first N lines of the table. Hlines do count as separate lines for
13916 @item :skipcols (n1 n2 ...)
13917 List of columns that should be skipped. If the table has a column with
13918 calculation marks, that column is automatically discarded as well.
13919 Please note that the translator function sees the table @emph{after} the
13920 removal of these columns, the function never knows that there have been
13921 additional columns.
13925 The one problem remaining is how to keep the source table in the buffer
13926 without disturbing the normal workings of the file, for example during
13927 compilation of a C file or processing of a @LaTeX{} file. There are a
13928 number of different solutions:
13932 The table could be placed in a block comment if that is supported by the
13933 language. For example, in C mode you could wrap the table between
13934 @samp{/*} and @samp{*/} lines.
13936 Sometimes it is possible to put the table after some kind of @i{END}
13937 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
13940 You can just comment the table line-by-line whenever you want to process
13941 the file, and uncomment it whenever you need to edit the table. This
13942 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
13943 makes this comment-toggling very easy, in particular if you bind it to a
13947 @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax
13948 @subsection A @LaTeX{} example of radio tables
13949 @cindex @LaTeX{}, and Orgtbl mode
13951 The best way to wrap the source table in @LaTeX{} is to use the
13952 @code{comment} environment provided by @file{comment.sty}. It has to be
13953 activated by placing @code{\usepackage@{comment@}} into the document
13954 header. Orgtbl mode can insert a radio table skeleton@footnote{By
13955 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
13956 variable @code{orgtbl-radio-tables} to install templates for other
13957 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
13958 be prompted for a table name, let's say we use @samp{salesfigures}. You
13959 will then get the following template:
13961 @cindex #+ORGTBL, SEND
13963 % BEGIN RECEIVE ORGTBL salesfigures
13964 % END RECEIVE ORGTBL salesfigures
13966 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13972 @vindex @LaTeX{}-verbatim-environments
13973 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
13974 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
13975 into the receiver location with name @code{salesfigures}. You may now
13976 fill in the table---feel free to use the spreadsheet features@footnote{If
13977 the @samp{#+TBLFM} line contains an odd number of dollar characters,
13978 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
13979 example you can fix this by adding an extra line inside the
13980 @code{comment} environment that is used to balance the dollar
13981 expressions. If you are using AUC@TeX{} with the font-latex library, a
13982 much better solution is to add the @code{comment} environment to the
13983 variable @code{LaTeX-verbatim-environments}.}:
13986 % BEGIN RECEIVE ORGTBL salesfigures
13987 % END RECEIVE ORGTBL salesfigures
13989 #+ORGTBL: SEND salesfigures orgtbl-to-latex
13990 | Month | Days | Nr sold | per day |
13991 |-------+------+---------+---------|
13992 | Jan | 23 | 55 | 2.4 |
13993 | Feb | 21 | 16 | 0.8 |
13994 | March | 22 | 278 | 12.6 |
13995 #+TBLFM: $4=$3/$2;%.1f
13996 % $ (optional extra dollar to keep font-lock happy, see footnote)
14001 When you are done, press @kbd{C-c C-c} in the table to get the converted
14002 table inserted between the two marker lines.
14004 Now let's assume you want to make the table header by hand, because you
14005 want to control how columns are aligned, etc@. In this case we make sure
14006 that the table translator skips the first 2 lines of the source
14007 table, and tell the command to work as a @i{splice}, i.e.@: to not produce
14008 header and footer commands of the target table:
14011 \begin@{tabular@}@{lrrr@}
14012 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
14013 % BEGIN RECEIVE ORGTBL salesfigures
14014 % END RECEIVE ORGTBL salesfigures
14018 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
14019 | Month | Days | Nr sold | per day |
14020 |-------+------+---------+---------|
14021 | Jan | 23 | 55 | 2.4 |
14022 | Feb | 21 | 16 | 0.8 |
14023 | March | 22 | 278 | 12.6 |
14024 #+TBLFM: $4=$3/$2;%.1f
14028 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
14029 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
14030 and marks horizontal lines with @code{\hline}. Furthermore, it
14031 interprets the following parameters (see also @pxref{Translator functions}):
14034 @item :splice nil/t
14035 When set to t, return only table body lines, don't wrap them into a
14036 tabular environment. Default is nil.
14039 A format to be used to wrap each field, it should contain @code{%s} for the
14040 original field value. For example, to wrap each field value in dollars,
14041 you could use @code{:fmt "$%s$"}. This may also be a property list with
14042 column numbers and formats. for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
14043 A function of one argument can be used in place of the strings; the
14044 function must return a formatted string.
14047 Use this format to print numbers with exponentials. The format should
14048 have @code{%s} twice for inserting mantissa and exponent, for example
14049 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
14050 may also be a property list with column numbers and formats, for example
14051 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
14052 @code{efmt} has been applied to a value, @code{fmt} will also be
14053 applied. Similar to @code{fmt}, functions of two arguments can be
14054 supplied instead of strings.
14057 @node Translator functions, Radio lists, A LaTeX example, Tables in arbitrary syntax
14058 @subsection Translator functions
14059 @cindex HTML, and Orgtbl mode
14060 @cindex translator function
14062 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
14063 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
14064 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
14065 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
14066 code that produces tables during HTML export.}, these all use a generic
14067 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
14068 itself is a very short function that computes the column definitions for the
14069 @code{tabular} environment, defines a few field and line separators and then
14070 hands processing over to the generic translator. Here is the entire code:
14074 (defun orgtbl-to-latex (table params)
14075 "Convert the Orgtbl mode TABLE to LaTeX."
14076 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
14077 org-table-last-alignment ""))
14080 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
14081 :tend "\\end@{tabular@}"
14082 :lstart "" :lend " \\\\" :sep " & "
14083 :efmt "%s\\,(%s)" :hline "\\hline")))
14084 (orgtbl-to-generic table (org-combine-plists params2 params))))
14088 As you can see, the properties passed into the function (variable
14089 @var{PARAMS}) are combined with the ones newly defined in the function
14090 (variable @var{PARAMS2}). The ones passed into the function (i.e.@: the
14091 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
14092 would like to use the @LaTeX{} translator, but wanted the line endings to
14093 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
14094 overrule the default with
14097 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
14100 For a new language, you can either write your own converter function in
14101 analogy with the @LaTeX{} translator, or you can use the generic function
14102 directly. For example, if you have a language where a table is started
14103 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
14104 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
14105 separator is a TAB, you could call the generic translator like this (on
14109 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
14110 :lstart "!BL! " :lend " !EL!" :sep "\t"
14114 Please check the documentation string of the function
14115 @code{orgtbl-to-generic} for a full list of parameters understood by
14116 that function, and remember that you can pass each of them into
14117 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
14118 using the generic function.
14120 Of course you can also write a completely new function doing complicated
14121 things the generic translator cannot do. A translator function takes
14122 two arguments. The first argument is the table, a list of lines, each
14123 line either the symbol @code{hline} or a list of fields. The second
14124 argument is the property list containing all parameters specified in the
14125 @samp{#+ORGTBL: SEND} line. The function must return a single string
14126 containing the formatted table. If you write a generally useful
14127 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
14128 others can benefit from your work.
14130 @node Radio lists, , Translator functions, Tables in arbitrary syntax
14131 @subsection Radio lists
14132 @cindex radio lists
14133 @cindex org-list-insert-radio-list
14135 Sending and receiving radio lists works exactly the same way as sending and
14136 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
14137 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
14138 @code{org-list-insert-radio-list}.
14140 Here are the differences with radio tables:
14144 Orgstruct mode must be active.
14146 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
14148 The available translation functions for radio lists don't take
14151 @kbd{C-c C-c} will work when pressed on the first item of the list.
14154 Here is a @LaTeX{} example. Let's say that you have this in your
14159 % BEGIN RECEIVE ORGLST to-buy
14160 % END RECEIVE ORGLST to-buy
14162 #+ORGLST: SEND to-buy org-list-to-latex
14171 Pressing `C-c C-c' on @code{a new house} and will insert the converted
14172 @LaTeX{} list between the two marker lines.
14174 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
14175 @section Dynamic blocks
14176 @cindex dynamic blocks
14178 Org documents can contain @emph{dynamic blocks}. These are
14179 specially marked regions that are updated by some user-written function.
14180 A good example for such a block is the clock table inserted by the
14181 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
14183 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
14184 to the block and can also specify parameters for the function producing
14185 the content of the block.
14187 @cindex #+BEGIN:dynamic block
14189 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
14194 Dynamic blocks are updated with the following commands
14197 @orgcmd{C-c C-x C-u,org-dblock-update}
14198 Update dynamic block at point.
14199 @orgkey{C-u C-c C-x C-u}
14200 Update all dynamic blocks in the current file.
14203 Updating a dynamic block means to remove all the text between BEGIN and
14204 END, parse the BEGIN line for parameters and then call the specific
14205 writer function for this block to insert the new content. If you want
14206 to use the original content in the writer function, you can use the
14207 extra parameter @code{:content}.
14209 For a block with name @code{myblock}, the writer function is
14210 @code{org-dblock-write:myblock} with as only parameter a property list
14211 with the parameters given in the begin line. Here is a trivial example
14212 of a block that keeps track of when the block update function was last
14216 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
14222 The corresponding block writer function could look like this:
14225 (defun org-dblock-write:block-update-time (params)
14226 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
14227 (insert "Last block update at: "
14228 (format-time-string fmt (current-time)))))
14231 If you want to make sure that all dynamic blocks are always up-to-date,
14232 you could add the function @code{org-update-all-dblocks} to a hook, for
14233 example @code{before-save-hook}. @code{org-update-all-dblocks} is
14234 written in a way such that it does nothing in buffers that are not in
14237 You can narrow the current buffer to the current dynamic block (like any
14238 other block) with @code{org-narrow-to-block}.
14240 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
14241 @section Special agenda views
14242 @cindex agenda views, user-defined
14244 @vindex org-agenda-skip-function
14245 @vindex org-agenda-skip-function-global
14246 Org provides a special hook that can be used to narrow down the selection
14247 made by these agenda views: @code{todo}, @code{alltodo}, @code{tags},
14248 @code{tags-todo}, @code{tags-tree}. You may specify a function that is used
14249 at each match to verify if the match should indeed be part of the agenda
14250 view, and if not, how much should be skipped. You can specify a global
14251 condition that will be applied to all agenda views, this condition would be
14252 stored in the variable @code{org-agenda-skip-function-global}. More
14253 commonly, such a definition is applied only to specific custom searches,
14254 using @code{org-agenda-skip-function}.
14256 Let's say you want to produce a list of projects that contain a WAITING
14257 tag anywhere in the project tree. Let's further assume that you have
14258 marked all tree headings that define a project with the TODO keyword
14259 PROJECT. In this case you would run a TODO search for the keyword
14260 PROJECT, but skip the match unless there is a WAITING tag anywhere in
14261 the subtree belonging to the project line.
14263 To achieve this, you must write a function that searches the subtree for
14264 the tag. If the tag is found, the function must return @code{nil} to
14265 indicate that this match should not be skipped. If there is no such
14266 tag, return the location of the end of the subtree, to indicate that
14267 search should continue from there.
14270 (defun my-skip-unless-waiting ()
14271 "Skip trees that are not waiting"
14272 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
14273 (if (re-search-forward ":waiting:" subtree-end t)
14274 nil ; tag found, do not skip
14275 subtree-end))) ; tag not found, continue after end of subtree
14278 Now you may use this function in an agenda custom command, for example
14282 (org-add-agenda-custom-command
14283 '("b" todo "PROJECT"
14284 ((org-agenda-skip-function 'my-skip-unless-waiting)
14285 (org-agenda-overriding-header "Projects waiting for something: "))))
14288 @vindex org-agenda-overriding-header
14289 Note that this also binds @code{org-agenda-overriding-header} to get a
14290 meaningful header in the agenda view.
14292 @vindex org-odd-levels-only
14293 @vindex org-agenda-skip-function
14294 A general way to create custom searches is to base them on a search for
14295 entries with a certain level limit. If you want to study all entries with
14296 your custom search function, simply do a search for
14297 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
14298 level number corresponds to order in the hierarchy, not to the number of
14299 stars.}, and then use @code{org-agenda-skip-function} to select the entries
14300 you really want to have.
14302 You may also put a Lisp form into @code{org-agenda-skip-function}. In
14303 particular, you may use the functions @code{org-agenda-skip-entry-if}
14304 and @code{org-agenda-skip-subtree-if} in this form, for example:
14307 @item '(org-agenda-skip-entry-if 'scheduled)
14308 Skip current entry if it has been scheduled.
14309 @item '(org-agenda-skip-entry-if 'notscheduled)
14310 Skip current entry if it has not been scheduled.
14311 @item '(org-agenda-skip-entry-if 'deadline)
14312 Skip current entry if it has a deadline.
14313 @item '(org-agenda-skip-entry-if 'scheduled 'deadline)
14314 Skip current entry if it has a deadline, or if it is scheduled.
14315 @item '(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
14316 Skip current entry if the TODO keyword is TODO or WAITING.
14317 @item '(org-agenda-skip-entry-if 'todo 'done)
14318 Skip current entry if the TODO keyword marks a DONE state.
14319 @item '(org-agenda-skip-entry-if 'timestamp)
14320 Skip current entry if it has any timestamp, may also be deadline or scheduled.
14321 @item '(org-agenda-skip-entry 'regexp "regular expression")
14322 Skip current entry if the regular expression matches in the entry.
14323 @item '(org-agenda-skip-entry 'notregexp "regular expression")
14324 Skip current entry unless the regular expression matches.
14325 @item '(org-agenda-skip-subtree-if 'regexp "regular expression")
14326 Same as above, but check and skip the entire subtree.
14329 Therefore we could also have written the search for WAITING projects
14330 like this, even without defining a special function:
14333 (org-add-agenda-custom-command
14334 '("b" todo "PROJECT"
14335 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
14336 'regexp ":waiting:"))
14337 (org-agenda-overriding-header "Projects waiting for something: "))))
14340 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
14341 @section Extracting agenda information
14342 @cindex agenda, pipe
14343 @cindex Scripts, for agenda processing
14345 @vindex org-agenda-custom-commands
14346 Org provides commands to access agenda information for the command
14347 line in Emacs batch mode. This extracted information can be sent
14348 directly to a printer, or it can be read by a program that does further
14349 processing of the data. The first of these commands is the function
14350 @code{org-batch-agenda}, that produces an agenda view and sends it as
14351 ASCII text to STDOUT. The command takes a single string as parameter.
14352 If the string has length 1, it is used as a key to one of the commands
14353 you have configured in @code{org-agenda-custom-commands}, basically any
14354 key you can use after @kbd{C-c a}. For example, to directly print the
14355 current TODO list, you could use
14358 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
14361 If the parameter is a string with 2 or more characters, it is used as a
14362 tags/TODO match string. For example, to print your local shopping list
14363 (all items with the tag @samp{shop}, but excluding the tag
14364 @samp{NewYork}), you could use
14367 emacs -batch -l ~/.emacs \
14368 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
14372 You may also modify parameters on the fly like this:
14375 emacs -batch -l ~/.emacs \
14376 -eval '(org-batch-agenda "a" \
14377 org-agenda-span month \
14378 org-agenda-include-diary nil \
14379 org-agenda-files (quote ("~/org/project.org")))' \
14384 which will produce a 30-day agenda, fully restricted to the Org file
14385 @file{~/org/projects.org}, not even including the diary.
14387 If you want to process the agenda data in more sophisticated ways, you
14388 can use the command @code{org-batch-agenda-csv} to get a comma-separated
14389 list of values for each agenda item. Each line in the output will
14390 contain a number of fields separated by commas. The fields in a line
14394 category @r{The category of the item}
14395 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
14396 type @r{The type of the agenda entry, can be}
14397 todo @r{selected in TODO match}
14398 tagsmatch @r{selected in tags match}
14399 diary @r{imported from diary}
14400 deadline @r{a deadline}
14401 scheduled @r{scheduled}
14402 timestamp @r{appointment, selected by timestamp}
14403 closed @r{entry was closed on date}
14404 upcoming-deadline @r{warning about nearing deadline}
14405 past-scheduled @r{forwarded scheduled item}
14406 block @r{entry has date block including date}
14407 todo @r{The TODO keyword, if any}
14408 tags @r{All tags including inherited ones, separated by colons}
14409 date @r{The relevant date, like 2007-2-14}
14410 time @r{The time, like 15:00-16:50}
14411 extra @r{String with extra planning info}
14412 priority-l @r{The priority letter if any was given}
14413 priority-n @r{The computed numerical priority}
14417 Time and date will only be given if a timestamp (or deadline/scheduled)
14418 led to the selection of the item.
14420 A CSV list like this is very easy to use in a post-processing script.
14421 For example, here is a Perl program that gets the TODO list from
14422 Emacs/Org and prints all the items, preceded by a checkbox:
14427 # define the Emacs command to run
14428 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
14430 # run it and capture the output
14431 $agenda = qx@{$cmd 2>/dev/null@};
14433 # loop over all lines
14434 foreach $line (split(/\n/,$agenda)) @{
14435 # get the individual values
14436 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
14437 $priority_l,$priority_n) = split(/,/,$line);
14438 # process and print
14439 print "[ ] $head\n";
14443 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
14444 @section Using the property API
14445 @cindex API, for properties
14446 @cindex properties, API
14448 Here is a description of the functions that can be used to work with
14451 @defun org-entry-properties &optional pom which
14452 Get all properties of the entry at point-or-marker POM.@*
14453 This includes the TODO keyword, the tags, time strings for deadline,
14454 scheduled, and clocking, and any additional properties defined in the
14455 entry. The return value is an alist. Keys may occur multiple times
14456 if the property key was used several times.@*
14457 POM may also be nil, in which case the current entry is used.
14458 If WHICH is nil or `all', get all properties. If WHICH is
14459 `special' or `standard', only get that subclass.
14461 @vindex org-use-property-inheritance
14462 @defun org-entry-get pom property &optional inherit
14463 Get value of PROPERTY for entry at point-or-marker POM. By default,
14464 this only looks at properties defined locally in the entry. If INHERIT
14465 is non-nil and the entry does not have the property, then also check
14466 higher levels of the hierarchy. If INHERIT is the symbol
14467 @code{selective}, use inheritance if and only if the setting of
14468 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
14471 @defun org-entry-delete pom property
14472 Delete the property PROPERTY from entry at point-or-marker POM.
14475 @defun org-entry-put pom property value
14476 Set PROPERTY to VALUE for entry at point-or-marker POM.
14479 @defun org-buffer-property-keys &optional include-specials
14480 Get all property keys in the current buffer.
14483 @defun org-insert-property-drawer
14484 Insert a property drawer at point.
14487 @defun org-entry-put-multivalued-property pom property &rest values
14488 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
14489 strings. They will be concatenated, with spaces as separators.
14492 @defun org-entry-get-multivalued-property pom property
14493 Treat the value of the property PROPERTY as a whitespace-separated list of
14494 values and return the values as a list of strings.
14497 @defun org-entry-add-to-multivalued-property pom property value
14498 Treat the value of the property PROPERTY as a whitespace-separated list of
14499 values and make sure that VALUE is in this list.
14502 @defun org-entry-remove-from-multivalued-property pom property value
14503 Treat the value of the property PROPERTY as a whitespace-separated list of
14504 values and make sure that VALUE is @emph{not} in this list.
14507 @defun org-entry-member-in-multivalued-property pom property value
14508 Treat the value of the property PROPERTY as a whitespace-separated list of
14509 values and check if VALUE is in this list.
14512 @defopt org-property-allowed-value-functions
14513 Hook for functions supplying allowed values for a specific property.
14514 The functions must take a single argument, the name of the property, and
14515 return a flat list of allowed values. If @samp{:ETC} is one of
14516 the values, use the values as completion help, but allow also other values
14517 to be entered. The functions must return @code{nil} if they are not
14518 responsible for this property.
14521 @node Using the mapping API, , Using the property API, Hacking
14522 @section Using the mapping API
14523 @cindex API, for mapping
14524 @cindex mapping entries, API
14526 Org has sophisticated mapping capabilities to find all entries satisfying
14527 certain criteria. Internally, this functionality is used to produce agenda
14528 views, but there is also an API that can be used to execute arbitrary
14529 functions for each or selected entries. The main entry point for this API
14532 @defun org-map-entries func &optional match scope &rest skip
14533 Call FUNC at each headline selected by MATCH in SCOPE.
14535 FUNC is a function or a Lisp form. The function will be called without
14536 arguments, with the cursor positioned at the beginning of the headline.
14537 The return values of all calls to the function will be collected and
14538 returned as a list.
14540 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14541 does not need to preserve point. After evaluation, the cursor will be
14542 moved to the end of the line (presumably of the headline of the
14543 processed entry) and search continues from there. Under some
14544 circumstances, this may not produce the wanted results. For example,
14545 if you have removed (e.g.@: archived) the current (sub)tree it could
14546 mean that the next entry will be skipped entirely. In such cases, you
14547 can specify the position from where search should continue by making
14548 FUNC set the variable `org-map-continue-from' to the desired buffer
14551 MATCH is a tags/property/todo match as it is used in the agenda match view.
14552 Only headlines that are matched by this query will be considered during
14553 the iteration. When MATCH is nil or t, all headlines will be
14554 visited by the iteration.
14556 SCOPE determines the scope of this command. It can be any of:
14559 nil @r{the current buffer, respecting the restriction if any}
14560 tree @r{the subtree started with the entry at point}
14561 file @r{the current buffer, without restriction}
14563 @r{the current buffer, and any archives associated with it}
14564 agenda @r{all agenda files}
14565 agenda-with-archives
14566 @r{all agenda files with any archive files associated with them}
14568 @r{if this is a list, all files in the list will be scanned}
14571 The remaining args are treated as settings for the skipping facilities of
14572 the scanner. The following items can be given here:
14574 @vindex org-agenda-skip-function
14576 archive @r{skip trees with the archive tag}
14577 comment @r{skip trees with the COMMENT keyword}
14578 function or Lisp form
14579 @r{will be used as value for @code{org-agenda-skip-function},}
14580 @r{so whenever the function returns t, FUNC}
14581 @r{will not be called for that entry and search will}
14582 @r{continue from the point where the function leaves it}
14586 The function given to that mapping routine can really do anything you like.
14587 It can use the property API (@pxref{Using the property API}) to gather more
14588 information about the entry, or in order to change metadata in the entry.
14589 Here are a couple of functions that might be handy:
14591 @defun org-todo &optional arg
14592 Change the TODO state of the entry. See the docstring of the functions for
14593 the many possible values for the argument ARG.
14596 @defun org-priority &optional action
14597 Change the priority of the entry. See the docstring of this function for the
14598 possible values for ACTION.
14601 @defun org-toggle-tag tag &optional onoff
14602 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
14603 or @code{off} will not toggle tag, but ensure that it is either on or off.
14607 Promote the current entry.
14611 Demote the current entry.
14614 Here is a simple example that will turn all entries in the current file with
14615 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
14616 Entries in comment trees and in archive trees will be ignored.
14620 '(org-todo "UPCOMING")
14621 "+TOMORROW" 'file 'archive 'comment)
14624 The following example counts the number of entries with TODO keyword
14625 @code{WAITING}, in all agenda files.
14628 (length (org-map-entries t "/+WAITING" 'agenda))
14631 @node MobileOrg, History and Acknowledgments, Hacking, Top
14632 @appendix MobileOrg
14636 @uref{http://mobileorg.ncogni.to/, MobileOrg} is an application for the
14637 @i{iPhone/iPod Touch} series of devices, developed by Richard Moreland.
14638 @i{MobileOrg} offers offline viewing and capture support for an Org-mode
14639 system rooted on a ``real'' computer. It does also allow you to record
14640 changes to existing entries. Android users should check out
14641 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
14644 This appendix describes the support Org has for creating agenda views in a
14645 format that can be displayed by @i{MobileOrg}, and for integrating notes
14646 captured and changes made by @i{MobileOrg} into the main system.
14648 For changing tags and TODO states in MobileOrg, you should have set up the
14649 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
14650 cover all important tags and TODO keywords, even if individual files use only
14651 part of these. MobileOrg will also offer you states and tags set up with
14652 in-buffer settings, but it will understand the logistics of TODO state
14653 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
14654 (@pxref{Setting tags}) only for those set in these variables.
14657 * Setting up the staging area:: Where to interact with the mobile device
14658 * Pushing to MobileOrg:: Uploading Org files and agendas
14659 * Pulling from MobileOrg:: Integrating captured and flagged items
14662 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
14663 @section Setting up the staging area
14665 MobileOrg needs to interact with Emacs through a directory on a server. If you
14666 are using a public server, you should consider to encrypt the files that are
14667 uploaded to the server. This can be done with Org-mode 7.02 and with
14668 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
14669 installation on your system. To turn on encryption, set a password in
14670 @i{MobileOrg} and, on the Emacs side, configure the variable
14671 @code{org-mobile-use-encryption}@footnote{If you can safely store the
14672 password in your Emacs setup, you might also want to configure
14673 @code{org-mobile-encryption-password}. Please read the docstring of that
14674 variable. Note that encryption will apply only to the contents of the
14675 @file{.org} files. The file names themselves will remain visible.}.
14677 The easiest way to create that directory is to use a free
14678 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
14679 Dropbox, or if your version of MobileOrg does not support it, you can use a
14680 webdav server. For more information, check out the documentation of MobileOrg and also this
14681 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
14682 When MobileOrg first connects to your Dropbox, it will create a directory
14683 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
14687 (setq org-mobile-directory "~/Dropbox/MobileOrg")
14690 Org-mode has commands to put files for @i{MobileOrg} into that directory,
14691 and to read captured notes from there.
14693 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
14694 @section Pushing to MobileOrg
14696 This operation copies all files currently listed in @code{org-mobile-files}
14697 to the directory @code{org-mobile-directory}. By default this list contains
14698 all agenda files (as listed in @code{org-agenda-files}), but additional files
14699 can be included by customizing @code{org-mobiles-files}. File names will be
14700 staged with paths relative to @code{org-directory}, so all files should be
14701 inside this directory. The push operation also creates a special Org file
14702 @file{agendas.org} with all custom agenda view defined by the
14703 user@footnote{While creating the agendas, Org-mode will force ID properties
14704 on all referenced entries, so that these entries can be uniquely identified
14705 if @i{MobileOrg} flags them for further action. If you do not want to get
14706 these properties in so many entries, you can set the variable
14707 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
14708 rely on outline paths, in the hope that these will be unique enough.}.
14709 Finally, Org writes the file @file{index.org}, containing links to all other
14710 files. @i{MobileOrg} first reads this file from the server, and then
14711 downloads all agendas and Org files listed in it. To speed up the download,
14712 MobileOrg will only read files whose checksums@footnote{stored automatically
14713 in the file @file{checksums.dat}} have changed.
14715 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
14716 @section Pulling from MobileOrg
14718 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
14719 files for viewing. It also appends captured entries and pointers to flagged
14720 and changed entries to the file @file{mobileorg.org} on the server. Org has
14721 a @emph{pull} operation that integrates this information into an inbox file
14722 and operates on the pointers to flagged entries. Here is how it works:
14726 Org moves all entries found in
14727 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
14728 operation.} and appends them to the file pointed to by the variable
14729 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
14730 will be a top-level entry in the inbox file.
14732 After moving the entries, Org will attempt to implement the changes made in
14733 @i{MobileOrg}. Some changes are applied directly and without user
14734 interaction. Examples are all changes to tags, TODO state, headline and body
14735 text that can be cleanly applied. Entries that have been flagged for further
14736 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
14737 again. When there is a problem finding an entry or applying the change, the
14738 pointer entry will remain in the inbox and will be marked with an error
14739 message. You need to later resolve these issues by hand.
14741 Org will then generate an agenda view with all flagged entries. The user
14742 should then go through these entries and do whatever actions are necessary.
14743 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
14744 will be displayed in the echo area when the cursor is on the corresponding
14749 Pressing @kbd{?} in that special agenda will display the full flagging note in
14750 another window and also push it onto the kill ring. So you could use @kbd{?
14751 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
14752 Pressing @kbd{?} twice in succession will offer to remove the
14753 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
14754 in a property). In this way you indicate that the intended processing for
14755 this flagged entry is finished.
14760 If you are not able to process all flagged entries directly, you can always
14761 return to this agenda view@footnote{Note, however, that there is a subtle
14762 difference. The view created automatically by @kbd{M-x org-mobile-pull
14763 @key{RET}} is guaranteed to search all files that have been addressed by the
14764 last pull. This might include a file that is not currently in your list of
14765 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
14766 the current agenda files will be searched.} using @kbd{C-c a ?}.
14768 @node History and Acknowledgments, Main Index, MobileOrg, Top
14769 @appendix History and acknowledgments
14770 @cindex acknowledgments
14774 Org was born in 2003, out of frustration over the user interface of the Emacs
14775 Outline mode. I was trying to organize my notes and projects, and using
14776 Emacs seemed to be the natural way to go. However, having to remember eleven
14777 different commands with two or three keys per command, only to hide and show
14778 parts of the outline tree, that seemed entirely unacceptable to me. Also,
14779 when using outlines to take notes, I constantly wanted to restructure the
14780 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
14781 cycling} and @emph{structure editing} were originally implemented in the
14782 package @file{outline-magic.el}, but quickly moved to the more general
14783 @file{org.el}. As this environment became comfortable for project planning,
14784 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
14785 @emph{table support}. These areas highlighted the two main goals that Org
14786 still has today: to be a new, outline-based, plain text mode with innovative
14787 and intuitive editing features, and to incorporate project planning
14788 functionality directly into a notes file.
14790 Since the first release, literally thousands of emails to me or to
14791 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
14792 reports, feedback, new ideas, and sometimes patches and add-on code.
14793 Many thanks to everyone who has helped to improve this package. I am
14794 trying to keep here a list of the people who had significant influence
14795 in shaping one or more aspects of Org. The list may not be
14796 complete, if I have forgotten someone, please accept my apologies and
14799 Before I get to this list, a few special mentions are in order:
14802 @item Bastien Guerry
14803 Bastien has written a large number of extensions to Org (most of them
14804 integrated into the core by now), including the LaTeX exporter and the plain
14805 list parser. His support during the early days, when he basically acted as
14806 co-maintainer, was central to the success of this project. Bastien also
14807 invented Worg, helped establishing the Web presence of Org, and sponsors
14808 hosting costs for the orgmode.org website.
14809 @item Eric Schulte and Dan Davison
14810 Eric and Dan are jointly responsible for the Org-babel system, which turns
14811 Org into a multi-language environment for evaluating code and doing literate
14812 programming and reproducible research.
14814 John has contributed a number of great ideas and patches directly to Org,
14815 including the attachment system (@file{org-attach.el}), integration with
14816 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
14817 items, habit tracking (@file{org-habits.el}), and encryption
14818 (@file{org-crypt.el}). Also, the capture system is really an extended copy
14819 of his great @file{remember.el}.
14820 @item Sebastian Rose
14821 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
14822 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
14823 higher level. He also wrote @file{org-info.js}, a Java script for displaying
14824 webpages derived from Org using an Info-like or a folding interface with
14825 single-key navigation.
14828 @noindent OK, now to the full list of contributions! Again, please let me
14829 know what I am missing here!
14834 @i{Russel Adams} came up with the idea for drawers.
14836 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
14838 @i{Christophe Bataillon} created the great unicorn logo that we use on the
14841 @i{Alex Bochannek} provided a patch for rounding timestamps.
14843 @i{Jan Böcker} wrote @file{org-docview.el}.
14845 @i{Brad Bozarth} showed how to pull RSS feed data into Org-mode files.
14847 @i{Tom Breton} wrote @file{org-choose.el}.
14849 @i{Charles Cave}'s suggestion sparked the implementation of templates
14850 for Remember, which are now templates for capture.
14852 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
14855 @i{Gregory Chernov} patched support for Lisp forms into table
14856 calculations and improved XEmacs compatibility, in particular by porting
14857 @file{nouline.el} to XEmacs.
14859 @i{Sacha Chua} suggested copying some linking code from Planner.
14861 @i{Baoqiu Cui} contributed the DocBook exporter.
14863 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
14864 came up with the idea of properties, and that there should be an API for
14867 @i{Nick Dokos} tracked down several nasty bugs.
14869 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
14870 inspired some of the early development, including HTML export. He also
14871 asked for a way to narrow wide table columns.
14873 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
14874 the Org-Babel documentation into the manual.
14876 @i{Christian Egli} converted the documentation into Texinfo format, inspired
14877 the agenda, patched CSS formatting into the HTML exporter, and wrote
14878 @file{org-taskjuggler.el}.
14880 @i{David Emery} provided a patch for custom CSS support in exported
14883 @i{Nic Ferrier} contributed mailcap and XOXO support.
14885 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
14887 @i{John Foerch} figured out how to make incremental search show context
14888 around a match in a hidden outline tree.
14890 @i{Raimar Finken} wrote @file{org-git-line.el}.
14892 @i{Mikael Fornius} works as a mailing list moderator.
14894 @i{Austin Frank} works as a mailing list moderator.
14896 @i{Eric Fraga} drove the development of BEAMER export with ideas and
14899 @i{Barry Gidden} did proofreading the manual in preparation for the book
14900 publication through Network Theory Ltd.
14902 @i{Niels Giesen} had the idea to automatically archive DONE trees.
14904 @i{Nicolas Goaziou} rewrote much of the plain list code.
14906 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
14908 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
14911 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
14912 task state change logging, and the clocktable. His clear explanations have
14913 been critical when we started to adopt the Git version control system.
14915 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
14918 @i{Phil Jackson} wrote @file{org-irc.el}.
14920 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
14921 folded entries, and column view for properties.
14923 @i{Matt Jones} wrote @i{MobileOrg Android}.
14925 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
14927 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
14928 provided frequent feedback and some patches.
14930 @i{Matt Lundin} has proposed last-row references for table formulas and named
14931 invisible anchors. He has also worked a lot on the FAQ.
14933 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
14934 and is a prolific contributor on the mailing list with competent replies,
14935 small fixes and patches.
14937 @i{Jason F. McBrayer} suggested agenda export to CSV format.
14939 @i{Max Mikhanosha} came up with the idea of refiling.
14941 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
14944 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
14947 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
14949 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
14950 and being able to quickly restrict the agenda to a subtree.
14952 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
14954 @i{Greg Newman} refreshed the unicorn logo into its current form.
14956 @i{Tim O'Callaghan} suggested in-file links, search options for general
14957 file links, and TAGS.
14959 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
14960 version of the reference card.
14962 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
14965 @i{Oliver Oppitz} suggested multi-state TODO items.
14967 @i{Scott Otterson} sparked the introduction of descriptive text for
14968 links, among other things.
14970 @i{Pete Phillips} helped during the development of the TAGS feature, and
14971 provided frequent feedback.
14973 @i{Martin Pohlack} provided the code snippet to bundle character insertion
14974 into bundles of 20 for undo.
14976 @i{T.V. Raman} reported bugs and suggested improvements.
14978 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
14981 @i{Paul Rivier} provided the basic implementation of named footnotes. He
14982 also acted as mailing list moderator for some time.
14984 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
14986 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
14987 conflict with @file{allout.el}.
14989 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
14992 @i{Philip Rooke} created the Org reference card, provided lots
14993 of feedback, developed and applied standards to the Org documentation.
14995 @i{Christian Schlauer} proposed angular brackets around links, among
14998 @i{Paul Sexton} wrote @file{org-ctags.el}.
15000 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
15001 @file{organizer-mode.el}.
15003 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
15004 examples, and remote highlighting for referenced code lines.
15006 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
15007 now packaged into Org's @file{contrib} directory.
15009 @i{Daniel Sinder} came up with the idea of internal archiving by locking
15012 @i{Dale Smith} proposed link abbreviations.
15014 @i{James TD Smith} has contributed a large number of patches for useful
15015 tweaks and features.
15017 @i{Adam Spiers} asked for global linking commands, inspired the link
15018 extension system, added support for mairix, and proposed the mapping API.
15020 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
15021 LaTeX, UTF-8, Latin-1 and ASCII.
15023 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
15024 with links transformation to Org syntax.
15026 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
15027 chapter about publishing.
15029 @i{Sebastien Vauban} reported many issues with LaTeX and BEAMER export and
15030 enabled source code highlighling in Gnus.
15032 @i{Stefan Vollmar} organized a video-recorded talk at the
15033 Max-Planck-Institute for Neurology. He also inspired the creation of a
15034 concept index for HTML export.
15036 @i{J@"urgen Vollmer} contributed code generating the table of contents
15039 @i{Samuel Wales} has provided important feedback and bug reports.
15041 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
15044 @i{David Wainberg} suggested archiving, and improvements to the linking
15047 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
15050 @i{Roland Winkler} requested additional key bindings to make Org
15053 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
15054 and contributed various ideas and code snippets.
15058 @node Main Index, Key Index, History and Acknowledgments, Top
15059 @unnumbered Concept index
15063 @node Key Index, Command and Function Index, Main Index, Top
15064 @unnumbered Key index
15068 @node Command and Function Index, Variable Index, Key Index, Top
15069 @unnumbered Command and function index
15073 @node Variable Index, , Command and Function Index, Top
15074 @unnumbered Variable index
15076 This is not a complete index of variables and faces, only the ones that are
15077 mentioned in the manual. For a more complete list, use @kbd{M-x
15078 org-customize @key{RET}} and then click yourself through the tree.
15085 arch-tag: 7893d1Fe-cc57-4d13-b5e5-f494a1CBC7ac
15088 @c Local variables:
15090 @c indent-tabs-mode: nil
15091 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
15092 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
15096 @c LocalWords: webdavhost pre