3 @setfilename ../../info/org
4 @settitle The Org Manual
6 @include org-version.inc
8 @c Use proper quote and backtick for code sections in PDF output
9 @c Cf. Texinfo manual 14.2
10 @set txicodequoteundirected
11 @set txicodequotebacktick
13 @c Version and Contact Info
14 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
15 @set AUTHOR Carsten Dominik
16 @set MAINTAINER Carsten Dominik
17 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
18 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
23 @c -----------------------------------------------------------------------------
25 @c Macro definitions for commands and keys
26 @c =======================================
28 @c The behavior of the key/command macros will depend on the flag cmdnames
29 @c When set, commands names are shown. When clear, they are not shown.
33 @c Below we define the following macros for Org key tables:
35 @c orgkey{key} A key item
36 @c orgcmd{key,cmd} Key with command name
37 @c xorgcmd{key,cmd} Key with command name as @itemx
38 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
39 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
40 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
41 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
42 @c different functions, so format as @itemx
43 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
44 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
45 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
47 @c a key but no command
59 @c one key with a command
60 @c Inserts: @item KEY COMMAND
61 @macro orgcmd{key,command}
66 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
69 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
78 @c One key with one command, formatted using @itemx
79 @c Inserts: @itemx KEY COMMAND
80 @macro xorgcmd{key,command}
85 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
88 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
97 @c one key with a command, bit do not index the key
98 @c Inserts: @item KEY COMMAND
99 @macro orgcmdnki{key,command}
103 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
106 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
114 @c one key with a command, and special text to replace key in item
115 @c Inserts: @item TEXT COMMAND
116 @macro orgcmdtkc{text,key,command}
121 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
124 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
133 @c two keys with one command
134 @c Inserts: @item KEY1 or KEY2 COMMAND
135 @macro orgcmdkkc{key1,key2,command}
141 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
144 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
150 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
154 @c Two keys with one command name, but different functions, so format as
156 @c Inserts: @item KEY1
157 @c @itemx KEY2 COMMAND
158 @macro orgcmdkxkc{key1,key2,command}
165 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
169 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
180 @c Same as previous, but use "or short"
181 @c Inserts: @item KEY1 or short KEY2 COMMAND
182 @macro orgcmdkskc{key1,key2,command}
188 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
191 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
197 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
201 @c Same as previous, but use @itemx
202 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
203 @macro xorgcmdkskc{key1,key2,command}
209 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
212 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
218 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
222 @c two keys with two commands
223 @c Inserts: @item KEY1 COMMAND1
224 @c @itemx KEY2 COMMAND2
225 @macro orgcmdkkcc{key1,key2,command1,command2}
232 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
233 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
236 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
237 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
247 @c -----------------------------------------------------------------------------
250 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
253 @c Subheadings inside a table.
254 @macro tsubheading{text}
256 @subsubheading \text\
264 This manual is for Org version @value{VERSION}.
266 Copyright @copyright{} 2004-2012 Free Software Foundation, Inc.
269 Permission is granted to copy, distribute and/or modify this document
270 under the terms of the GNU Free Documentation License, Version 1.3 or
271 any later version published by the Free Software Foundation; with no
272 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
273 and with the Back-Cover Texts as in (a) below. A copy of the license
274 is included in the section entitled ``GNU Free Documentation License.''
276 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
277 modify this GNU manual. Buying copies from the FSF supports it in
278 developing GNU and promoting software freedom.''
280 This document is part of a collection distributed under the GNU Free
281 Documentation License. If you want to distribute this document
282 separately from the collection, you can do so by adding a copy of the
283 license to the document, as described in section 6 of the license.
287 @dircategory Emacs editing modes
289 * Org Mode: (org). Outline-based notes management and organizer
293 @title The Org Manual
295 @subtitle Release @value{VERSION}
296 @author by Carsten Dominik
297 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, Thomas Dye and Jambunathan K.
299 @c The following two commands start the copyright page.
301 @vskip 0pt plus 1filll
305 @c Output the table of contents at the beginning.
309 @node Top, Introduction, (dir), (dir)
316 * Introduction:: Getting started
317 * Document Structure:: A tree works like your brain
318 * Tables:: Pure magic for quick formatting
319 * Hyperlinks:: Notes in context
320 * TODO Items:: Every tree branch can be a TODO item
321 * Tags:: Tagging headlines and matching sets of tags
322 * Properties and Columns:: Storing information about an entry
323 * Dates and Times:: Making items useful for planning
324 * Capture - Refile - Archive:: The ins and outs for projects
325 * Agenda Views:: Collecting information into views
326 * Markup:: Prepare text for rich export
327 * Exporting:: Sharing and publishing of notes
328 * Publishing:: Create a web site of linked Org files
329 * Working With Source Code:: Export, evaluate, and tangle code blocks
330 * Miscellaneous:: All the rest which did not fit elsewhere
331 * Hacking:: How to hack your way around
332 * MobileOrg:: Viewing and capture on a mobile device
333 * History and Acknowledgments:: How Org came into being
334 * Main Index:: An index of Org's concepts and features
335 * Key Index:: Key bindings and where they are described
336 * Command and Function Index:: Command names and some internal functions
337 * Variable Index:: Variables mentioned in the manual
340 --- The Detailed Node Listing ---
344 * Summary:: Brief summary of what Org does
345 * Installation:: How to install a downloaded version of Org
346 * Activation:: How to activate Org for certain buffers
347 * Feedback:: Bug reports, ideas, patches etc.
348 * Conventions:: Typesetting conventions in the manual
352 * Outlines:: Org is based on Outline mode
353 * Headlines:: How to typeset Org tree headlines
354 * Visibility cycling:: Show and hide, much simplified
355 * Motion:: Jumping to other headlines
356 * Structure editing:: Changing sequence and level of headlines
357 * Sparse trees:: Matches embedded in context
358 * Plain lists:: Additional structure within an entry
359 * Drawers:: Tucking stuff away
360 * Blocks:: Folding blocks
361 * Footnotes:: How footnotes are defined in Org's syntax
362 * Orgstruct mode:: Structure editing outside Org
366 * Built-in table editor:: Simple tables
367 * Column width and alignment:: Overrule the automatic settings
368 * Column groups:: Grouping to trigger vertical lines
369 * Orgtbl mode:: The table editor as minor mode
370 * The spreadsheet:: The table editor has spreadsheet capabilities
371 * Org-Plot:: Plotting from org tables
375 * References:: How to refer to another field or range
376 * Formula syntax for Calc:: Using Calc to compute stuff
377 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
378 * Durations and time values:: How to compute durations and time values
379 * Field and range formulas:: Formula for specific (ranges of) fields
380 * Column formulas:: Formulas valid for an entire column
381 * Editing and debugging formulas:: Fixing formulas
382 * Updating the table:: Recomputing all dependent fields
383 * Advanced features:: Field and column names, parameters and automatic recalc
387 * Link format:: How links in Org are formatted
388 * Internal links:: Links to other places in the current file
389 * External links:: URL-like links to the world
390 * Handling links:: Creating, inserting and following
391 * Using links outside Org:: Linking from my C source code?
392 * Link abbreviations:: Shortcuts for writing complex links
393 * Search options:: Linking to a specific location
394 * Custom searches:: When the default search is not enough
398 * Radio targets:: Make targets trigger links in plain text
402 * TODO basics:: Marking and displaying TODO entries
403 * TODO extensions:: Workflow and assignments
404 * Progress logging:: Dates and notes for progress
405 * Priorities:: Some things are more important than others
406 * Breaking down tasks:: Splitting a task into manageable pieces
407 * Checkboxes:: Tick-off lists
409 Extended use of TODO keywords
411 * Workflow states:: From TODO to DONE in steps
412 * TODO types:: I do this, Fred does the rest
413 * Multiple sets in one file:: Mixing it all, and still finding your way
414 * Fast access to TODO states:: Single letter selection of a state
415 * Per-file keywords:: Different files, different requirements
416 * Faces for TODO keywords:: Highlighting states
417 * TODO dependencies:: When one task needs to wait for others
421 * Closing items:: When was this entry marked DONE?
422 * Tracking TODO state changes:: When did the status change?
423 * Tracking your habits:: How consistent have you been?
427 * Tag inheritance:: Tags use the tree structure of the outline
428 * Setting tags:: How to assign tags to a headline
429 * Tag searches:: Searching for combinations of tags
431 Properties and columns
433 * Property syntax:: How properties are spelled out
434 * Special properties:: Access to other Org mode features
435 * Property searches:: Matching property values
436 * Property inheritance:: Passing values down the tree
437 * Column view:: Tabular viewing and editing
438 * Property API:: Properties for Lisp programmers
442 * Defining columns:: The COLUMNS format property
443 * Using column view:: How to create and use column view
444 * Capturing column view:: A dynamic block for column view
448 * Scope of column definitions:: Where defined, where valid?
449 * Column attributes:: Appearance and content of a column
453 * Timestamps:: Assigning a time to a tree entry
454 * Creating timestamps:: Commands which insert timestamps
455 * Deadlines and scheduling:: Planning your work
456 * Clocking work time:: Tracking how long you spend on a task
457 * Effort estimates:: Planning work effort in advance
458 * Relative timer:: Notes with a running timer
459 * Countdown timer:: Starting a countdown timer for a task
463 * The date/time prompt:: How Org mode helps you entering date and time
464 * Custom time format:: Making dates look different
466 Deadlines and scheduling
468 * Inserting deadline/schedule:: Planning items
469 * Repeated tasks:: Items that show up again and again
473 * Clocking commands:: Starting and stopping a clock
474 * The clock table:: Detailed reports
475 * Resolving idle time:: Resolving time when you've been idle
477 Capture - Refile - Archive
479 * Capture:: Capturing new stuff
480 * Attachments:: Add files to tasks
481 * RSS Feeds:: Getting input from RSS feeds
482 * Protocols:: External (e.g.@: Browser) access to Emacs and Org
483 * Refiling notes:: Moving a tree from one place to another
484 * Archiving:: What to do with finished projects
488 * Setting up capture:: Where notes will be stored
489 * Using capture:: Commands to invoke and terminate capture
490 * Capture templates:: Define the outline of different note types
494 * Template elements:: What is needed for a complete template entry
495 * Template expansion:: Filling in information about time and context
496 * Templates in contexts:: Only show a template in a specific context
500 * Moving subtrees:: Moving a tree to an archive file
501 * Internal archiving:: Switch off a tree but keep it in the file
505 * Agenda files:: Files being searched for agenda information
506 * Agenda dispatcher:: Keyboard access to agenda views
507 * Built-in agenda views:: What is available out of the box?
508 * Presentation and sorting:: How agenda items are prepared for display
509 * Agenda commands:: Remote editing of Org trees
510 * Custom agenda views:: Defining special searches and views
511 * Exporting Agenda Views:: Writing a view to a file
512 * Agenda column view:: Using column view for collected entries
514 The built-in agenda views
516 * Weekly/daily agenda:: The calendar page with current tasks
517 * Global TODO list:: All unfinished action items
518 * Matching tags and properties:: Structured information with fine-tuned search
519 * Timeline:: Time-sorted view for single file
520 * Search view:: Find entries by searching for text
521 * Stuck projects:: Find projects you need to review
523 Presentation and sorting
525 * Categories:: Not all tasks are equal
526 * Time-of-day specifications:: How the agenda knows the time
527 * Sorting of agenda items:: The order of things
531 * Storing searches:: Type once, use often
532 * Block agenda:: All the stuff you need in a single buffer
533 * Setting Options:: Changing the rules
535 Markup for rich export
537 * Structural markup elements:: The basic structure as seen by the exporter
538 * Images and tables:: Tables and Images will be included
539 * Literal examples:: Source code examples with special formatting
540 * Include files:: Include additional files into a document
541 * Index entries:: Making an index
542 * Macro replacement:: Use macros to create complex output
543 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
545 Structural markup elements
547 * Document title:: Where the title is taken from
548 * Headings and sections:: The document structure as seen by the exporter
549 * Table of contents:: The if and where of the table of contents
550 * Initial text:: Text before the first heading?
552 * Paragraphs:: Paragraphs
553 * Footnote markup:: Footnotes
554 * Emphasis and monospace:: Bold, italic, etc.
555 * Horizontal rules:: Make a line
556 * Comment lines:: What will *not* be exported
560 * Special symbols:: Greek letters and other symbols
561 * Subscripts and superscripts:: Simple syntax for raising/lowering text
562 * @LaTeX{} fragments:: Complex formulas made easy
563 * Previewing @LaTeX{} fragments:: What will this snippet look like?
564 * CDLaTeX mode:: Speed up entering of formulas
568 * Selective export:: Using tags to select and exclude trees
569 * Export options:: Per-file export settings
570 * The export dispatcher:: How to access exporter commands
571 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
572 * HTML export:: Exporting to HTML
573 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
574 * DocBook export:: Exporting to DocBook
575 * OpenDocument Text export:: Exporting to OpenDocument Text
576 * TaskJuggler export:: Exporting to TaskJuggler
577 * Freemind export:: Exporting to Freemind mind maps
578 * XOXO export:: Exporting to XOXO
579 * iCalendar export:: Exporting in iCalendar format
583 * HTML Export commands:: How to invoke HTML export
584 * HTML preamble and postamble:: How to insert a preamble and a postamble
585 * Quoting HTML tags:: Using direct HTML in Org mode
586 * Links in HTML export:: How links will be interpreted and formatted
587 * Tables in HTML export:: How to modify the formatting of tables
588 * Images in HTML export:: How to insert figures into HTML output
589 * Math formatting in HTML export:: Beautiful math also on the web
590 * Text areas in HTML export:: An alternative way to show an example
591 * CSS support:: Changing the appearance of the output
592 * JavaScript support:: Info and Folding in a web browser
594 @LaTeX{} and PDF export
596 * @LaTeX{}/PDF export commands::
597 * Header and sectioning:: Setting up the export file structure
598 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
599 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
600 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
601 * Beamer class export:: Turning the file into a presentation
605 * DocBook export commands:: How to invoke DocBook export
606 * Quoting DocBook code:: Incorporating DocBook code in Org files
607 * Recursive sections:: Recursive sections in DocBook
608 * Tables in DocBook export:: Tables are exported as HTML tables
609 * Images in DocBook export:: How to insert figures into DocBook output
610 * Special characters:: How to handle special characters
612 OpenDocument Text export
614 * Pre-requisites for ODT export:: What packages ODT exporter relies on
615 * ODT export commands:: How to invoke ODT export
616 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
617 * Applying custom styles:: How to apply custom styles to the output
618 * Links in ODT export:: How links will be interpreted and formatted
619 * Tables in ODT export:: How Tables are exported
620 * Images in ODT export:: How to insert images
621 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
622 * Labels and captions in ODT export:: How captions are rendered
623 * Literal examples in ODT export:: How source and example blocks are formatted
624 * Advanced topics in ODT export:: Read this if you are a power user
626 Math formatting in ODT export
628 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
629 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
631 Advanced topics in ODT export
633 * Configuring a document converter:: How to register a document converter
634 * Working with OpenDocument style files:: Explore the internals
635 * Creating one-off styles:: How to produce custom highlighting etc
636 * Customizing tables in ODT export:: How to define and use Table templates
637 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
641 * Configuration:: Defining projects
642 * Uploading files:: How to get files up on the server
643 * Sample configuration:: Example projects
644 * Triggering publication:: Publication commands
648 * Project alist:: The central configuration variable
649 * Sources and destinations:: From here to there
650 * Selecting files:: What files are part of the project?
651 * Publishing action:: Setting the function doing the publishing
652 * Publishing options:: Tweaking HTML/@LaTeX{} export
653 * Publishing links:: Which links keep working after publishing?
654 * Sitemap:: Generating a list of all pages
655 * Generating an index:: An index that reaches across pages
659 * Simple example:: One-component publishing
660 * Complex example:: A multi-component publishing example
662 Working with source code
664 * Structure of code blocks:: Code block syntax described
665 * Editing source code:: Language major-mode editing
666 * Exporting code blocks:: Export contents and/or results
667 * Extracting source code:: Create pure source code files
668 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
669 * Library of Babel:: Use and contribute to a library of useful code blocks
670 * Languages:: List of supported code block languages
671 * Header arguments:: Configure code block functionality
672 * Results of evaluation:: How evaluation results are handled
673 * Noweb reference syntax:: Literate programming in Org mode
674 * Key bindings and useful functions:: Work quickly with code blocks
675 * Batch execution:: Call functions from the command line
679 * Using header arguments:: Different ways to set header arguments
680 * Specific header arguments:: List of header arguments
682 Using header arguments
684 * System-wide header arguments:: Set global default values
685 * Language-specific header arguments:: Set default values by language
686 * Buffer-wide header arguments:: Set default values for a specific buffer
687 * Header arguments in Org mode properties:: Set default values for a buffer or heading
688 * Code block specific header arguments:: The most common way to set values
689 * Header arguments in function calls:: The most specific level
691 Specific header arguments
693 * var:: Pass arguments to code blocks
694 * results:: Specify the type of results and how they will
695 be collected and handled
696 * file:: Specify a path for file output
697 * file-desc:: Specify a description for file results
698 * dir:: Specify the default (possibly remote)
699 directory for code block execution
700 * exports:: Export code and/or results
701 * tangle:: Toggle tangling and specify file name
702 * mkdirp:: Toggle creation of parent directories of target
703 files during tangling
704 * comments:: Toggle insertion of comments in tangled
706 * padline:: Control insertion of padding lines in tangled
708 * no-expand:: Turn off variable assignment and noweb
709 expansion during tangling
710 * session:: Preserve the state of code evaluation
711 * noweb:: Toggle expansion of noweb references
712 * noweb-ref:: Specify block's noweb reference resolution target
713 * noweb-sep:: String used to separate noweb references
714 * cache:: Avoid re-evaluating unchanged code blocks
715 * sep:: Delimiter for writing tabular results outside Org
716 * hlines:: Handle horizontal lines in tables
717 * colnames:: Handle column names in tables
718 * rownames:: Handle row names in tables
719 * shebang:: Make tangled files executable
720 * eval:: Limit evaluation of specific code blocks
721 * wrap:: Mark source block evaluation results
725 * Completion:: M-TAB knows what you need
726 * Easy Templates:: Quick insertion of structural elements
727 * Speed keys:: Electric commands at the beginning of a headline
728 * Code evaluation security:: Org mode files evaluate inline code
729 * Customization:: Adapting Org to your taste
730 * In-buffer settings:: Overview of the #+KEYWORDS
731 * The very busy C-c C-c key:: When in doubt, press C-c C-c
732 * Clean view:: Getting rid of leading stars in the outline
733 * TTY keys:: Using Org on a tty
734 * Interaction:: Other Emacs packages
735 * org-crypt.el:: Encrypting Org files
737 Interaction with other packages
739 * Cooperation:: Packages Org cooperates with
740 * Conflicts:: Packages that lead to conflicts
744 * Hooks:: How to reach into Org's internals
745 * Add-on packages:: Available extensions
746 * Adding hyperlink types:: New custom link types
747 * Context-sensitive commands:: How to add functionality to such commands
748 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
749 * Dynamic blocks:: Automatically filled blocks
750 * Special agenda views:: Customized views
751 * Extracting agenda information:: Postprocessing of agenda information
752 * Using the property API:: Writing programs that use entry properties
753 * Using the mapping API:: Mapping over all or selected entries
755 Tables and lists in arbitrary syntax
757 * Radio tables:: Sending and receiving radio tables
758 * A @LaTeX{} example:: Step by step, almost a tutorial
759 * Translator functions:: Copy and modify
760 * Radio lists:: Doing the same for lists
764 * Setting up the staging area:: Where to interact with the mobile device
765 * Pushing to MobileOrg:: Uploading Org files and agendas
766 * Pulling from MobileOrg:: Integrating captured and flagged items
771 @node Introduction, Document Structure, Top, Top
772 @chapter Introduction
776 * Summary:: Brief summary of what Org does
777 * Installation:: How to install a downloaded version of Org
778 * Activation:: How to activate Org for certain buffers
779 * Feedback:: Bug reports, ideas, patches etc.
780 * Conventions:: Typesetting conventions in the manual
783 @node Summary, Installation, Introduction, Introduction
787 Org is a mode for keeping notes, maintaining TODO lists, and doing
788 project planning with a fast and effective plain-text system.
790 Org develops organizational tasks around NOTES files that contain
791 lists or information about projects as plain text. Org is
792 implemented on top of Outline mode, which makes it possible to keep the
793 content of large files well structured. Visibility cycling and
794 structure editing help to work with the tree. Tables are easily created
795 with a built-in table editor. Org supports TODO items, deadlines,
796 timestamps, and scheduling. It dynamically compiles entries into an
797 agenda that utilizes and smoothly integrates much of the Emacs calendar
798 and diary. Plain text URL-like links connect to websites, emails,
799 Usenet messages, BBDB entries, and any files related to the projects.
800 For printing and sharing of notes, an Org file can be exported as a
801 structured ASCII file, as HTML, or (TODO and agenda items only) as an
802 iCalendar file. It can also serve as a publishing tool for a set of
805 As a project planning environment, Org works by adding metadata to outline
806 nodes. Based on this data, specific entries can be extracted in queries and
807 create dynamic @i{agenda views}.
809 Org mode contains the Org Babel environment which allows you to work with
810 embedded source code blocks in a file, to facilitate code evaluation,
811 documentation, and literate programming techniques.
813 Org's automatic, context-sensitive table editor with spreadsheet
814 capabilities can be integrated into any major mode by activating the
815 minor Orgtbl mode. Using a translation step, it can be used to maintain
816 tables in arbitrary file types, for example in @LaTeX{}. The structure
817 editing and list creation capabilities can be used outside Org with
818 the minor Orgstruct mode.
820 Org keeps simple things simple. When first fired up, it should
821 feel like a straightforward, easy to use outliner. Complexity is not
822 imposed, but a large amount of functionality is available when you need
823 it. Org is a toolbox and can be used in different ways and for different
827 @r{@bullet{} an outline extension with visibility cycling and structure editing}
828 @r{@bullet{} an ASCII system and table editor for taking structured notes}
829 @r{@bullet{} a TODO list editor}
830 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
831 @pindex GTD, Getting Things Done
832 @r{@bullet{} an environment in which to implement David Allen's GTD system}
833 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
834 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
835 @r{@bullet{} an environment for literate programming}
840 There is a website for Org which provides links to the newest
841 version of Org, as well as additional information, frequently asked
842 questions (FAQ), links to tutorials, etc@. This page is located at
843 @uref{http://orgmode.org}.
845 @cindex print edition
846 The version 7.3 of this manual is available as a
847 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
853 @node Installation, Activation, Summary, Introduction
854 @section Installation
858 @b{Important:} @i{If you are using a version of Org that is part of the Emacs
859 distribution, GNU ELPA or an XEmacs package, please skip this section and go
860 directly to @ref{Activation}. To see what version of Org (if any) is part of
861 your Emacs distribution, type @kbd{M-x org-version} (if your Emacs
862 distribution does not come with Org, this function will not be defined).}
864 If you have downloaded Org from the Web as a distribution @file{.zip} or
865 @file{.tar} archive, you must take the following steps to install it:
868 @item Unpack the distribution archive.
869 @item Change into (@code{cd}) the Org directory.
870 @item Run @code{make help}
871 and then check and edit the file @file{local.mk}. You must set the name of
872 the Emacs binary (likely either @file{emacs} or @file{xemacs}), and the paths
873 to the directories where local Lisp and Info files will be installed.
874 @item Run @code{make config}
875 to check the configuration.
876 @item Run @code{make install} or @code{sudo make install}
877 to build and install Org mode on your system. If you use a local Git
878 repository, preferrably us @code{make update2} or, if you want to run the
879 complete test suite before installation, @code{make up2}.
882 If you use a cloned Git repository, then the procedure is slightly different:
885 @item Change into (@code{cd}) the Org repository.
886 @item Run @code{git checkout master}
887 to switch to the @code{master} branch of the Org repository.
888 @item Run @code{make help}
889 and then check and edit the file @file{local.mk}. You must set the name of
890 the Emacs binary (likely either @file{emacs} or @file{xemacs}), and the paths
891 to the directories where local Lisp and Info files will be installed.
892 @item Run @code{make config}
893 to check the configuration.
894 @item Run @code{make update2} or @code{make up2}
895 to update the Git repository and build and install Org mode. The latter
896 invocation runs the complete test suite before installation and installs only
897 if the build passes all tests.
900 If you don't have access to the system-wide directories and you don't want to
901 install somewhere into your home directory, you can run Org directly from the
902 distribution directory or Org repository by compiling Org mode in place:
905 @item Change into (@code{cd}) the Org repository.
906 @item Run @code{git checkout master}
907 to switch to the @code{master} branch of the Org repository.
908 @item Run @code{make compile}
911 Last but not least you can also run Org mode directly from an Org repository
912 without any compilation. Simply replace the last step in the recipe above
913 with @code{make uncompiled}.
915 Then add the following line to @file{.emacs}:
918 (add-to-list 'load-path "~/path/to/orgdir/lisp")
922 If you plan to use code from the @file{contrib} subdirectory, do a similar
923 step for this directory:
926 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp")
929 Installing Info files is system dependent, because of differences in the
930 @file{install-info} program. The Info documentation is installed together
931 with the rest of Org mode. If you don't install Org mode, it is possible to
932 install the Info documentation seperately (you need to have
933 install-info@footnote{The output from install-info (if any) is system
934 dependent. In particular Debian and its derivatives use two different
935 versions of install-info and you may see the message:
938 This is not dpkg install-info anymore, but GNU install-info
939 See the man page for ginstall-info for command line arguments
942 @noindent which can be safely ignored.}
949 Then add the following line to @file{.emacs}. It is needed so that
950 Emacs can autoload functions that are located in files not immediately loaded
951 when Org mode starts.
953 (require 'org-install)
956 Do not forget to activate Org as described in the following section.
959 @node Activation, Feedback, Installation, Introduction
963 @cindex global key bindings
964 @cindex key bindings, global
967 @findex org-store-link
970 To make sure files with extension @file{.org} use Org mode, add the following
971 line to your @file{.emacs} file.
973 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
975 @noindent Org mode buffers need font-lock to be turned on - this is the
976 default in Emacs@footnote{If you don't use font-lock globally, turn it on in
977 Org buffer with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
979 The four Org commands @command{org-store-link}, @command{org-capture},
980 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
981 global keys (i.e.@: anywhere in Emacs, not just in Org buffers). Here are
982 suggested bindings for these keys, please modify the keys to your own
985 (global-set-key "\C-cl" 'org-store-link)
986 (global-set-key "\C-cc" 'org-capture)
987 (global-set-key "\C-ca" 'org-agenda)
988 (global-set-key "\C-cb" 'org-iswitchb)
991 @cindex Org mode, turning on
992 With this setup, all files with extension @samp{.org} will be put
993 into Org mode. As an alternative, make the first line of a file look
997 MY PROJECTS -*- mode: org; -*-
1000 @vindex org-insert-mode-line-in-empty-file
1001 @noindent which will select Org mode for this buffer no matter what
1002 the file's name is. See also the variable
1003 @code{org-insert-mode-line-in-empty-file}.
1005 Many commands in Org work on the region if the region is @i{active}. To make
1006 use of this, you need to have @code{transient-mark-mode}
1007 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
1008 in Emacs 22 you need to do this yourself with
1010 (transient-mark-mode 1)
1012 @noindent If you do not like @code{transient-mark-mode}, you can create an
1013 active region by using the mouse to select a region, or pressing
1014 @kbd{C-@key{SPC}} twice before moving the cursor.
1016 @node Feedback, Conventions, Activation, Introduction
1023 If you find problems with Org, or if you have questions, remarks, or ideas
1024 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1025 If you are not a member of the mailing list, your mail will be passed to the
1026 list after a moderator has approved it@footnote{Please consider subscribing
1027 to the mailing list, in order to minimize the work the mailing list
1028 moderators have to do.}.
1030 For bug reports, please first try to reproduce the bug with the latest
1031 version of Org available---if you are running an outdated version, it is
1032 quite possible that the bug has been fixed already. If the bug persists,
1033 prepare a report and provide as much information as possible, including the
1034 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1035 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
1036 @file{.emacs}. The easiest way to do this is to use the command
1038 @kbd{M-x org-submit-bug-report}
1040 @noindent which will put all this information into an Emacs mail buffer so
1041 that you only need to add your description. If you re not sending the Email
1042 from within Emacs, please copy and paste the content into your Email program.
1044 Sometimes you might face a problem due to an error in your Emacs or Org mode
1045 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1046 customizations and reproduce the problem. Doing so often helps you determine
1047 if the problem is with your customization or with Org mode itself. You can
1048 start a typical minimal session with a command like the example below.
1051 $ emacs -Q -l /path/to/minimal-org.el
1054 However if you are using Org mode as distributed with Emacs, a minimal setup
1055 is not necessary. In that case it is sufficient to start Emacs as @code{emacs
1056 -Q}. The @code{minimal-org.el} setup file can have contents as shown below.
1059 ;;; Minimal setup to load latest `org-mode'
1061 ;; activate debugging
1062 (setq debug-on-error t
1066 ;; add latest org-mode to load path
1067 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1068 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp"))
1071 (require 'org-install)
1074 If an error occurs, a backtrace can be very useful (see below on how to
1075 create one). Often a small example file helps, along with clear information
1079 @item What exactly did you do?
1080 @item What did you expect to happen?
1081 @item What happened instead?
1083 @noindent Thank you for helping to improve this program.
1085 @subsubheading How to create a useful backtrace
1087 @cindex backtrace of an error
1088 If working with Org produces an error with a message you don't
1089 understand, you may have hit a bug. The best way to report this is by
1090 providing, in addition to what was mentioned above, a @emph{backtrace}.
1091 This is information from the built-in debugger about where and how the
1092 error occurred. Here is how to produce a useful backtrace:
1096 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1097 contains much more information if it is produced with uncompiled code.
1100 C-u M-x org-reload RET
1103 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1106 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1107 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1109 Do whatever you have to do to hit the error. Don't forget to
1110 document the steps you take.
1112 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1113 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1114 attach it to your bug report.
1117 @node Conventions, , Feedback, Introduction
1118 @section Typesetting conventions used in this manual
1120 @subsubheading TODO keywords, tags, properties, etc.
1122 Org mainly uses three types of keywords: TODO keywords, tags and property
1123 names. In this manual we use the following conventions:
1128 TODO keywords are written with all capitals, even if they are
1132 User-defined tags are written in lowercase; built-in tags with special
1133 meaning are written with all capitals.
1136 User-defined properties are capitalized; built-in properties with
1137 special meaning are written with all capitals.
1140 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1141 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1142 environment). They are written in uppercase in the manual to enhance its
1143 readability, but you can use lowercase in your Org files@footnote{Easy
1144 templates insert lowercase keywords and Babel dynamically inserts
1147 @subsubheading Keybindings and commands
1153 The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda}
1154 and @kbd{C-c c} for @code{org-capture}. These are only suggestions, but the
1155 rest of the manual assumes that you are using these keybindings.
1157 Also, the manual lists both the keys and the corresponding commands for
1158 accessing a functionality. Org mode often uses the same key for different
1159 functions, depending on context. The command that is bound to such keys has
1160 a generic name, like @code{org-metaright}. In the manual we will, wherever
1161 possible, give the function that is internally called by the generic command.
1162 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1163 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1164 will be listed to call @code{org-table-move-column-right}. If you prefer,
1165 you can compile the manual without the command names by unsetting the flag
1166 @code{cmdnames} in @file{org.texi}.
1168 @node Document Structure, Tables, Introduction, Top
1169 @chapter Document structure
1170 @cindex document structure
1171 @cindex structure of document
1173 Org is based on Outline mode and provides flexible commands to
1174 edit the structure of the document.
1177 * Outlines:: Org is based on Outline mode
1178 * Headlines:: How to typeset Org tree headlines
1179 * Visibility cycling:: Show and hide, much simplified
1180 * Motion:: Jumping to other headlines
1181 * Structure editing:: Changing sequence and level of headlines
1182 * Sparse trees:: Matches embedded in context
1183 * Plain lists:: Additional structure within an entry
1184 * Drawers:: Tucking stuff away
1185 * Blocks:: Folding blocks
1186 * Footnotes:: How footnotes are defined in Org's syntax
1187 * Orgstruct mode:: Structure editing outside Org
1190 @node Outlines, Headlines, Document Structure, Document Structure
1193 @cindex Outline mode
1195 Org is implemented on top of Outline mode. Outlines allow a
1196 document to be organized in a hierarchical structure, which (at least
1197 for me) is the best representation of notes and thoughts. An overview
1198 of this structure is achieved by folding (hiding) large parts of the
1199 document to show only the general document structure and the parts
1200 currently being worked on. Org greatly simplifies the use of
1201 outlines by compressing the entire show/hide functionality into a single
1202 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1204 @node Headlines, Visibility cycling, Outlines, Document Structure
1207 @cindex outline tree
1208 @vindex org-special-ctrl-a/e
1209 @vindex org-special-ctrl-k
1210 @vindex org-ctrl-k-protect-subtree
1212 Headlines define the structure of an outline tree. The headlines in Org
1213 start with one or more stars, on the left margin@footnote{See the variables
1214 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1215 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1216 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1217 headings indented less then 30 stars.}. For example:
1220 * Top level headline
1227 * Another top level headline
1230 @noindent Some people find the many stars too noisy and would prefer an
1231 outline that has whitespace followed by a single star as headline
1232 starters. @ref{Clean view}, describes a setup to realize this.
1234 @vindex org-cycle-separator-lines
1235 An empty line after the end of a subtree is considered part of it and
1236 will be hidden when the subtree is folded. However, if you leave at
1237 least two empty lines, one empty line will remain visible after folding
1238 the subtree, in order to structure the collapsed view. See the
1239 variable @code{org-cycle-separator-lines} to modify this behavior.
1241 @node Visibility cycling, Motion, Headlines, Document Structure
1242 @section Visibility cycling
1243 @cindex cycling, visibility
1244 @cindex visibility cycling
1245 @cindex trees, visibility
1246 @cindex show hidden text
1249 Outlines make it possible to hide parts of the text in the buffer.
1250 Org uses just two commands, bound to @key{TAB} and
1251 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1253 @cindex subtree visibility states
1254 @cindex subtree cycling
1255 @cindex folded, subtree visibility state
1256 @cindex children, subtree visibility state
1257 @cindex subtree, subtree visibility state
1259 @orgcmd{@key{TAB},org-cycle}
1260 @emph{Subtree cycling}: Rotate current subtree among the states
1263 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1264 '-----------------------------------'
1267 @vindex org-cycle-emulate-tab
1268 @vindex org-cycle-global-at-bob
1269 The cursor must be on a headline for this to work@footnote{see, however,
1270 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1271 beginning of the buffer and the first line is not a headline, then
1272 @key{TAB} actually runs global cycling (see below)@footnote{see the
1273 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1274 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1276 @cindex global visibility states
1277 @cindex global cycling
1278 @cindex overview, global visibility state
1279 @cindex contents, global visibility state
1280 @cindex show all, global visibility state
1281 @orgcmd{S-@key{TAB},org-global-cycle}
1282 @itemx C-u @key{TAB}
1283 @emph{Global cycling}: Rotate the entire buffer among the states
1286 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1287 '--------------------------------------'
1290 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1291 CONTENTS view up to headlines of level N will be shown. Note that inside
1292 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1294 @cindex show all, command
1295 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1296 Show all, including drawers.
1297 @cindex revealing context
1298 @orgcmd{C-c C-r,org-reveal}
1299 Reveal context around point, showing the current entry, the following heading
1300 and the hierarchy above. Useful for working near a location that has been
1301 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1302 (@pxref{Agenda commands}). With a prefix argument show, on each
1303 level, all sibling headings. With a double prefix argument, also show the
1304 entire subtree of the parent.
1305 @cindex show branches, command
1306 @orgcmd{C-c C-k,show-branches}
1307 Expose all the headings of the subtree, CONTENT view for just one subtree.
1308 @cindex show children, command
1309 @orgcmd{C-c @key{TAB},show-children}
1310 Expose all direct children of the subtree. With a numeric prefix argument N,
1311 expose all children down to level N.
1312 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1313 Show the current subtree in an indirect buffer@footnote{The indirect
1316 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1319 (see the Emacs manual for more information about indirect buffers)
1321 will contain the entire buffer, but will be narrowed to the current
1322 tree. Editing the indirect buffer will also change the original buffer,
1323 but without affecting visibility in that buffer.}. With a numeric
1324 prefix argument N, go up to level N and then take that tree. If N is
1325 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1326 the previously used indirect buffer.
1327 @orgcmd{C-c C-x v,org-copy-visible}
1328 Copy the @i{visible} text in the region into the kill ring.
1331 @vindex org-startup-folded
1332 @cindex @code{overview}, STARTUP keyword
1333 @cindex @code{content}, STARTUP keyword
1334 @cindex @code{showall}, STARTUP keyword
1335 @cindex @code{showeverything}, STARTUP keyword
1337 When Emacs first visits an Org file, the global state is set to
1338 OVERVIEW, i.e.@: only the top level headlines are visible. This can be
1339 configured through the variable @code{org-startup-folded}, or on a
1340 per-file basis by adding one of the following lines anywhere in the
1347 #+STARTUP: showeverything
1350 @cindex property, VISIBILITY
1352 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1353 and Columns}) will get their visibility adapted accordingly. Allowed values
1354 for this property are @code{folded}, @code{children}, @code{content}, and
1357 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1358 Switch back to the startup visibility of the buffer, i.e.@: whatever is
1359 requested by startup options and @samp{VISIBILITY} properties in individual
1363 @node Motion, Structure editing, Visibility cycling, Document Structure
1365 @cindex motion, between headlines
1366 @cindex jumping, to headlines
1367 @cindex headline navigation
1368 The following commands jump to other headlines in the buffer.
1371 @orgcmd{C-c C-n,outline-next-visible-heading}
1373 @orgcmd{C-c C-p,outline-previous-visible-heading}
1375 @orgcmd{C-c C-f,org-forward-same-level}
1376 Next heading same level.
1377 @orgcmd{C-c C-b,org-backward-same-level}
1378 Previous heading same level.
1379 @orgcmd{C-c C-u,outline-up-heading}
1380 Backward to higher level heading.
1381 @orgcmd{C-c C-j,org-goto}
1382 Jump to a different place without changing the current outline
1383 visibility. Shows the document structure in a temporary buffer, where
1384 you can use the following keys to find your destination:
1385 @vindex org-goto-auto-isearch
1387 @key{TAB} @r{Cycle visibility.}
1388 @key{down} / @key{up} @r{Next/previous visible headline.}
1389 @key{RET} @r{Select this location.}
1390 @kbd{/} @r{Do a Sparse-tree search}
1391 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1392 n / p @r{Next/previous visible headline.}
1393 f / b @r{Next/previous headline same level.}
1395 0-9 @r{Digit argument.}
1398 @vindex org-goto-interface
1400 See also the variable @code{org-goto-interface}.
1403 @node Structure editing, Sparse trees, Motion, Document Structure
1404 @section Structure editing
1405 @cindex structure editing
1406 @cindex headline, promotion and demotion
1407 @cindex promotion, of subtrees
1408 @cindex demotion, of subtrees
1409 @cindex subtree, cut and paste
1410 @cindex pasting, of subtrees
1411 @cindex cutting, of subtrees
1412 @cindex copying, of subtrees
1413 @cindex sorting, of subtrees
1414 @cindex subtrees, cut and paste
1417 @orgcmd{M-@key{RET},org-insert-heading}
1418 @vindex org-M-RET-may-split-line
1419 Insert new heading with same level as current. If the cursor is in a plain
1420 list item, a new item is created (@pxref{Plain lists}). To force creation of
1421 a new headline, use a prefix argument. When this command is used in the
1422 middle of a line, the line is split and the rest of the line becomes the new
1423 headline@footnote{If you do not want the line to be split, customize the
1424 variable @code{org-M-RET-may-split-line}.}. If the command is used at the
1425 beginning of a headline, the new headline is created before the current line.
1426 If at the beginning of any other line, the content of that line is made the
1427 new heading. If the command is used at the end of a folded subtree (i.e.@:
1428 behind the ellipses at the end of a headline), then a headline like the
1429 current one will be inserted after the end of the subtree.
1430 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1431 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1432 current heading, the new heading is placed after the body instead of before
1433 it. This command works from anywhere in the entry.
1434 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1435 @vindex org-treat-insert-todo-heading-as-state-change
1436 Insert new TODO entry with same level as current heading. See also the
1437 variable @code{org-treat-insert-todo-heading-as-state-change}.
1438 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1439 Insert new TODO entry with same level as current heading. Like
1440 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1442 @orgcmd{@key{TAB},org-cycle}
1443 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1444 become a child of the previous one. The next @key{TAB} makes it a parent,
1445 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1446 to the initial level.
1447 @orgcmd{M-@key{left},org-do-promote}
1448 Promote current heading by one level.
1449 @orgcmd{M-@key{right},org-do-demote}
1450 Demote current heading by one level.
1451 @orgcmd{M-S-@key{left},org-promote-subtree}
1452 Promote the current subtree by one level.
1453 @orgcmd{M-S-@key{right},org-demote-subtree}
1454 Demote the current subtree by one level.
1455 @orgcmd{M-S-@key{up},org-move-subtree-up}
1456 Move subtree up (swap with previous subtree of same
1458 @orgcmd{M-S-@key{down},org-move-subtree-down}
1459 Move subtree down (swap with next subtree of same level).
1460 @orgcmd{C-c C-x C-w,org-cut-subtree}
1461 Kill subtree, i.e.@: remove it from buffer but save in kill ring.
1462 With a numeric prefix argument N, kill N sequential subtrees.
1463 @orgcmd{C-c C-x M-w,org-copy-subtree}
1464 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1465 sequential subtrees.
1466 @orgcmd{C-c C-x C-y,org-paste-subtree}
1467 Yank subtree from kill ring. This does modify the level of the subtree to
1468 make sure the tree fits in nicely at the yank position. The yank level can
1469 also be specified with a numeric prefix argument, or by yanking after a
1470 headline marker like @samp{****}.
1471 @orgcmd{C-y,org-yank}
1472 @vindex org-yank-adjusted-subtrees
1473 @vindex org-yank-folded-subtrees
1474 Depending on the variables @code{org-yank-adjusted-subtrees} and
1475 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1476 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1477 C-x C-y}. With the default settings, no level adjustment will take place,
1478 but the yanked tree will be folded unless doing so would swallow text
1479 previously visible. Any prefix argument to this command will force a normal
1480 @code{yank} to be executed, with the prefix passed along. A good way to
1481 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1482 yank, it will yank previous kill items plainly, without adjustment and
1484 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1485 Clone a subtree by making a number of sibling copies of it. You will be
1486 prompted for the number of copies to make, and you can also specify if any
1487 timestamps in the entry should be shifted. This can be useful, for example,
1488 to create a number of tasks related to a series of lectures to prepare. For
1489 more details, see the docstring of the command
1490 @code{org-clone-subtree-with-time-shift}.
1491 @orgcmd{C-c C-w,org-refile}
1492 Refile entry or region to a different location. @xref{Refiling notes}.
1493 @orgcmd{C-c ^,org-sort}
1494 Sort same-level entries. When there is an active region, all entries in the
1495 region will be sorted. Otherwise the children of the current headline are
1496 sorted. The command prompts for the sorting method, which can be
1497 alphabetically, numerically, by time (first timestamp with active preferred,
1498 creation time, scheduled time, deadline time), by priority, by TODO keyword
1499 (in the sequence the keywords have been defined in the setup) or by the value
1500 of a property. Reverse sorting is possible as well. You can also supply
1501 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1502 sorting will be case-sensitive.
1503 @orgcmd{C-x n s,org-narrow-to-subtree}
1504 Narrow buffer to current subtree.
1505 @orgcmd{C-x n b,org-narrow-to-block}
1506 Narrow buffer to current block.
1507 @orgcmd{C-x n w,widen}
1508 Widen buffer to remove narrowing.
1509 @orgcmd{C-c *,org-toggle-heading}
1510 Turn a normal line or plain list item into a headline (so that it becomes a
1511 subheading at its location). Also turn a headline into a normal line by
1512 removing the stars. If there is an active region, turn all lines in the
1513 region into headlines. If the first line in the region was an item, turn
1514 only the item lines into headlines. Finally, if the first line is a
1515 headline, remove the stars from all headlines in the region.
1518 @cindex region, active
1519 @cindex active region
1520 @cindex transient mark mode
1521 When there is an active region (Transient Mark mode), promotion and
1522 demotion work on all headlines in the region. To select a region of
1523 headlines, it is best to place both point and mark at the beginning of a
1524 line, mark at the beginning of the first headline, and point at the line
1525 just after the last headline to change. Note that when the cursor is
1526 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1530 @node Sparse trees, Plain lists, Structure editing, Document Structure
1531 @section Sparse trees
1532 @cindex sparse trees
1533 @cindex trees, sparse
1534 @cindex folding, sparse trees
1535 @cindex occur, command
1537 @vindex org-show-hierarchy-above
1538 @vindex org-show-following-heading
1539 @vindex org-show-siblings
1540 @vindex org-show-entry-below
1541 An important feature of Org mode is the ability to construct @emph{sparse
1542 trees} for selected information in an outline tree, so that the entire
1543 document is folded as much as possible, but the selected information is made
1544 visible along with the headline structure above it@footnote{See also the
1545 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1546 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1547 control on how much context is shown around each match.}. Just try it out
1548 and you will see immediately how it works.
1550 Org mode contains several commands creating such trees, all these
1551 commands can be accessed through a dispatcher:
1554 @orgcmd{C-c /,org-sparse-tree}
1555 This prompts for an extra key to select a sparse-tree creating command.
1556 @orgcmd{C-c / r,org-occur}
1557 @vindex org-remove-highlights-with-change
1558 Prompts for a regexp and shows a sparse tree with all matches. If
1559 the match is in a headline, the headline is made visible. If the match is in
1560 the body of an entry, headline and body are made visible. In order to
1561 provide minimal context, also the full hierarchy of headlines above the match
1562 is shown, as well as the headline following the match. Each match is also
1563 highlighted; the highlights disappear when the buffer is changed by an
1564 editing command@footnote{This depends on the option
1565 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1566 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1567 so several calls to this command can be stacked.
1568 @orgcmdkkc{M-g n,M-g M-n,next-error}
1569 Jump to the next sparse tree match in this buffer.
1570 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1571 Jump to the previous sparse tree match in this buffer.
1576 @vindex org-agenda-custom-commands
1577 For frequently used sparse trees of specific search strings, you can
1578 use the variable @code{org-agenda-custom-commands} to define fast
1579 keyboard access to specific sparse trees. These commands will then be
1580 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1584 (setq org-agenda-custom-commands
1585 '(("f" occur-tree "FIXME")))
1588 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1589 a sparse tree matching the string @samp{FIXME}.
1591 The other sparse tree commands select headings based on TODO keywords,
1592 tags, or properties and will be discussed later in this manual.
1595 @cindex printing sparse trees
1596 @cindex visible text, printing
1597 To print a sparse tree, you can use the Emacs command
1598 @code{ps-print-buffer-with-faces} which does not print invisible parts
1599 of the document @footnote{This does not work under XEmacs, because
1600 XEmacs uses selective display for outlining, not text properties.}.
1601 Or you can use the command @kbd{C-c C-e v} to export only the visible
1602 part of the document and print the resulting file.
1604 @node Plain lists, Drawers, Sparse trees, Document Structure
1605 @section Plain lists
1607 @cindex lists, plain
1608 @cindex lists, ordered
1609 @cindex ordered lists
1611 Within an entry of the outline tree, hand-formatted lists can provide
1612 additional structure. They also provide a way to create lists of checkboxes
1613 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1614 (@pxref{Exporting}) can parse and format them.
1616 Org knows ordered lists, unordered lists, and description lists.
1619 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1620 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1621 they will be seen as top-level headlines. Also, when you are hiding leading
1622 stars to get a clean outline view, plain list items starting with a star may
1623 be hard to distinguish from true headlines. In short: even though @samp{*}
1624 is supported, it may be better to not use it for plain list items.} as
1627 @vindex org-plain-list-ordered-item-terminator
1628 @vindex org-alphabetical-lists
1629 @emph{Ordered} list items start with a numeral followed by either a period or
1630 a right parenthesis@footnote{You can filter out any of them by configuring
1631 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1632 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1633 @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
1634 confusion with normal text, those are limited to one character only. Beyond
1635 that limit, bullets will automatically fallback to numbers.}. If you want a
1636 list to start with a different value (e.g.@: 20), start the text of the item
1637 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1638 must be put @emph{before} the checkbox. If you have activated alphabetical
1639 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1640 be used in any item of the list in order to enforce a particular numbering.
1642 @emph{Description} list items are unordered list items, and contain the
1643 separator @samp{ :: } to distinguish the description @emph{term} from the
1647 Items belonging to the same list must have the same indentation on the first
1648 line. In particular, if an ordered list reaches number @samp{10.}, then the
1649 2--digit numbers must be written left-aligned with the other numbers in the
1650 list. An item ends before the next line that is less or equally indented
1651 than its bullet/number.
1653 @vindex org-empty-line-terminates-plain-lists
1654 A list ends whenever every item has ended, which means before any line less
1655 or equally indented than items at top level. It also ends before two blank
1656 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
1657 that case, all items are closed. Here is an example:
1661 ** Lord of the Rings
1662 My favorite scenes are (in this order)
1663 1. The attack of the Rohirrim
1664 2. Eowyn's fight with the witch king
1665 + this was already my favorite scene in the book
1666 + I really like Miranda Otto.
1667 3. Peter Jackson being shot by Legolas
1669 He makes a really funny face when it happens.
1670 But in the end, no individual scenes matter but the film as a whole.
1671 Important actors in this film are:
1672 - @b{Elijah Wood} :: He plays Frodo
1673 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1674 him very well from his role as Mikey Walsh in @i{The Goonies}.
1678 Org supports these lists by tuning filling and wrapping commands to deal with
1679 them correctly@footnote{Org only changes the filling settings for Emacs. For
1680 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1681 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1682 properly (@pxref{Exporting}). Since indentation is what governs the
1683 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1684 blocks can be indented to signal that they belong to a particular item.
1686 @vindex org-list-demote-modify-bullet
1687 @vindex org-list-indent-offset
1688 If you find that using a different bullet for a sub-list (than that used for
1689 the current list-level) improves readability, customize the variable
1690 @code{org-list-demote-modify-bullet}. To get a greater difference of
1691 indentation between items and theirs sub-items, customize
1692 @code{org-list-indent-offset}.
1694 @vindex org-list-automatic-rules
1695 The following commands act on items when the cursor is in the first line of
1696 an item (the line with the bullet or number). Some of them imply the
1697 application of automatic rules to keep list structure intact. If some of
1698 these actions get in your way, configure @code{org-list-automatic-rules}
1699 to disable them individually.
1702 @orgcmd{@key{TAB},org-cycle}
1703 @cindex cycling, in plain lists
1704 @vindex org-cycle-include-plain-lists
1705 Items can be folded just like headline levels. Normally this works only if
1706 the cursor is on a plain list item. For more details, see the variable
1707 @code{org-cycle-include-plain-lists}. If this variable is set to
1708 @code{integrate}, plain list items will be treated like low-level
1709 headlines. The level of an item is then given by the indentation of the
1710 bullet/number. Items are always subordinate to real headlines, however; the
1711 hierarchies remain completely separated. In a new item with no text yet, the
1712 first @key{TAB} demotes the item to become a child of the previous
1713 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1714 and eventually get it back to its initial position.
1715 @orgcmd{M-@key{RET},org-insert-heading}
1716 @vindex org-M-RET-may-split-line
1717 @vindex org-list-automatic-rules
1718 Insert new item at current level. With a prefix argument, force a new
1719 heading (@pxref{Structure editing}). If this command is used in the middle
1720 of an item, that item is @emph{split} in two, and the second part becomes the
1721 new item@footnote{If you do not want the item to be split, customize the
1722 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1723 @emph{before item's body}, the new item is created @emph{before} the current
1728 @kindex M-S-@key{RET}
1730 Insert a new item with a checkbox (@pxref{Checkboxes}).
1731 @kindex S-@key{down}
1734 @cindex shift-selection-mode
1735 @vindex org-support-shift-select
1736 @vindex org-list-use-circular-motion
1737 Jump to the previous/next item in the current list@footnote{If you want to
1738 cycle around items that way, you may customize
1739 @code{org-list-use-circular-motion}.}, but only if
1740 @code{org-support-shift-select} is off. If not, you can still use paragraph
1741 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1744 @kindex M-@key{down}
1747 Move the item including subitems up/down@footnote{See
1748 @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
1749 previous/next item of same indentation). If the list is ordered, renumbering
1751 @kindex M-@key{left}
1752 @kindex M-@key{right}
1755 Decrease/increase the indentation of an item, leaving children alone.
1756 @kindex M-S-@key{left}
1757 @kindex M-S-@key{right}
1760 Decrease/increase the indentation of the item, including subitems.
1761 Initially, the item tree is selected based on current indentation. When
1762 these commands are executed several times in direct succession, the initially
1763 selected region is used, even if the new indentation would imply a different
1764 hierarchy. To use the new hierarchy, break the command chain with a cursor
1767 As a special case, using this command on the very first item of a list will
1768 move the whole list. This behavior can be disabled by configuring
1769 @code{org-list-automatic-rules}. The global indentation of a list has no
1770 influence on the text @emph{after} the list.
1773 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1774 state of the checkbox. In any case, verify bullets and indentation
1775 consistency in the whole list.
1777 @vindex org-plain-list-ordered-item-terminator
1779 Cycle the entire list level through the different itemize/enumerate bullets
1780 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1781 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1782 and its indentation. With a numeric prefix argument N, select the Nth bullet
1783 from this list. If there is an active region when calling this, selected
1784 text will be changed into an item. With a prefix argument, all lines will be
1785 converted to list items. If the first line already was a list item, any item
1786 marker will be removed from the list. Finally, even without an active
1787 region, a normal line will be converted into a list item.
1790 Turn a plain list item into a headline (so that it becomes a subheading at
1791 its location). @xref{Structure editing}, for a detailed explanation.
1794 Turn the whole plain list into a subtree of the current heading. Checkboxes
1795 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1797 @kindex S-@key{left}
1798 @kindex S-@key{right}
1800 @vindex org-support-shift-select
1801 This command also cycles bullet styles when the cursor in on the bullet or
1802 anywhere in an item line, details depending on
1803 @code{org-support-shift-select}.
1806 Sort the plain list. You will be prompted for the sorting method:
1807 numerically, alphabetically, by time, or by custom function.
1810 @node Drawers, Blocks, Plain lists, Document Structure
1814 @cindex visibility cycling, drawers
1817 @cindex org-insert-drawer
1819 Sometimes you want to keep information associated with an entry, but you
1820 normally don't want to see it. For this, Org mode has @emph{drawers}.
1821 Drawers need to be configured with the variable
1822 @code{org-drawers}@footnote{You can define additional drawers on a
1823 per-file basis with a line like @code{#+DRAWERS: HIDDEN STATE}}. Drawers
1827 ** This is a headline
1828 Still outside the drawer
1830 This is inside the drawer.
1835 You can interactively insert drawers at point by calling
1836 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1837 region, this command will put the region inside the drawer. With a prefix
1838 argument, this command calls @code{org-insert-property-drawer} and add a
1839 property drawer right below the current headline. Completion over drawer
1840 keywords is also possible using @key{M-TAB}.
1842 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1843 show the entry, but keep the drawer collapsed to a single line. In order to
1844 look inside the drawer, you need to move the cursor to the drawer line and
1845 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1846 storing properties (@pxref{Properties and Columns}), and you can also arrange
1847 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1848 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1849 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1854 Add a time-stamped note to the LOGBOOK drawer.
1857 @node Blocks, Footnotes, Drawers, Document Structure
1860 @vindex org-hide-block-startup
1861 @cindex blocks, folding
1862 Org mode uses begin...end blocks for various purposes from including source
1863 code examples (@pxref{Literal examples}) to capturing time logging
1864 information (@pxref{Clocking work time}). These blocks can be folded and
1865 unfolded by pressing TAB in the begin line. You can also get all blocks
1866 folded at startup by configuring the variable @code{org-hide-block-startup}
1867 or on a per-file basis by using
1869 @cindex @code{hideblocks}, STARTUP keyword
1870 @cindex @code{nohideblocks}, STARTUP keyword
1872 #+STARTUP: hideblocks
1873 #+STARTUP: nohideblocks
1876 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1880 Org mode supports the creation of footnotes. In contrast to the
1881 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1882 larger document, not only for one-off documents like emails. The basic
1883 syntax is similar to the one used by @file{footnote.el}, i.e.@: a footnote is
1884 defined in a paragraph that is started by a footnote marker in square
1885 brackets in column 0, no indentation allowed. If you need a paragraph break
1886 inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
1887 is simply the marker in square brackets, inside text. For example:
1890 The Org homepage[fn:1] now looks a lot better than it used to.
1892 [fn:1] The link is: http://orgmode.org
1895 Org mode extends the number-based syntax to @emph{named} footnotes and
1896 optional inline definition. Using plain numbers as markers (as
1897 @file{footnote.el} does) is supported for backward compatibility, but not
1898 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1899 @LaTeX{}}). Here are the valid references:
1903 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1904 recommended because something like @samp{[1]} could easily be part of a code
1907 A named footnote reference, where @code{name} is a unique label word, or, for
1908 simplicity of automatic creation, a number.
1909 @item [fn:: This is the inline definition of this footnote]
1910 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1912 @item [fn:name: a definition]
1913 An inline definition of a footnote, which also specifies a name for the note.
1914 Since Org allows multiple references to the same note, you can then use
1915 @code{[fn:name]} to create additional references.
1918 @vindex org-footnote-auto-label
1919 Footnote labels can be created automatically, or you can create names yourself.
1920 This is handled by the variable @code{org-footnote-auto-label} and its
1921 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1924 @noindent The following command handles footnotes:
1929 The footnote action command.
1931 When the cursor is on a footnote reference, jump to the definition. When it
1932 is at a definition, jump to the (first) reference.
1934 @vindex org-footnote-define-inline
1935 @vindex org-footnote-section
1936 @vindex org-footnote-auto-adjust
1937 Otherwise, create a new footnote. Depending on the variable
1938 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1939 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1940 definition will be placed right into the text as part of the reference, or
1941 separately into the location determined by the variable
1942 @code{org-footnote-section}.
1944 When this command is called with a prefix argument, a menu of additional
1947 s @r{Sort the footnote definitions by reference sequence. During editing,}
1948 @r{Org makes no effort to sort footnote definitions into a particular}
1949 @r{sequence. If you want them sorted, use this command, which will}
1950 @r{also move entries according to @code{org-footnote-section}. Automatic}
1951 @r{sorting after each insertion/deletion can be configured using the}
1952 @r{variable @code{org-footnote-auto-adjust}.}
1953 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1954 @r{after each insertion/deletion can be configured using the variable}
1955 @r{@code{org-footnote-auto-adjust}.}
1956 S @r{Short for first @code{r}, then @code{s} action.}
1957 n @r{Normalize the footnotes by collecting all definitions (including}
1958 @r{inline definitions) into a special section, and then numbering them}
1959 @r{in sequence. The references will then also be numbers. This is}
1960 @r{meant to be the final step before finishing a document (e.g.@: sending}
1961 @r{off an email). The exporters do this automatically, and so could}
1962 @r{something like @code{message-send-hook}.}
1963 d @r{Delete the footnote at point, and all definitions of and references}
1966 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1967 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1968 renumbering and sorting footnotes can be automatic after each insertion or
1973 If the cursor is on a footnote reference, jump to the definition. If it is a
1974 the definition, jump back to the reference. When called at a footnote
1975 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1979 @item C-c C-o @r{or} mouse-1/2
1980 Footnote labels are also links to the corresponding definition/reference, and
1981 you can use the usual commands to follow these links.
1984 @node Orgstruct mode, , Footnotes, Document Structure
1985 @section The Orgstruct minor mode
1986 @cindex Orgstruct mode
1987 @cindex minor mode for structure editing
1989 If you like the intuitive way the Org mode structure editing and list
1990 formatting works, you might want to use these commands in other modes like
1991 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1992 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1993 turn it on by default, for example in Message mode, with one of:
1996 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1997 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2000 When this mode is active and the cursor is on a line that looks to Org like a
2001 headline or the first line of a list item, most structure editing commands
2002 will work, even if the same keys normally have different functionality in the
2003 major mode you are using. If the cursor is not in one of those special
2004 lines, Orgstruct mode lurks silently in the shadows. When you use
2005 @code{orgstruct++-mode}, Org will also export indentation and autofill
2006 settings into that mode, and detect item context after the first line of an
2009 @node Tables, Hyperlinks, Document Structure, Top
2012 @cindex editing tables
2014 Org comes with a fast and intuitive table editor. Spreadsheet-like
2015 calculations are supported using the Emacs @file{calc} package
2016 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2019 * Built-in table editor:: Simple tables
2020 * Column width and alignment:: Overrule the automatic settings
2021 * Column groups:: Grouping to trigger vertical lines
2022 * Orgtbl mode:: The table editor as minor mode
2023 * The spreadsheet:: The table editor has spreadsheet capabilities
2024 * Org-Plot:: Plotting from org tables
2027 @node Built-in table editor, Column width and alignment, Tables, Tables
2028 @section The built-in table editor
2029 @cindex table editor, built-in
2031 Org makes it easy to format tables in plain ASCII. Any line with @samp{|} as
2032 the first non-whitespace character is considered part of a table. @samp{|}
2033 is also the column separator@footnote{To insert a vertical bar into a table
2034 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2035 might look like this:
2038 | Name | Phone | Age |
2039 |-------+-------+-----|
2040 | Peter | 1234 | 17 |
2041 | Anna | 4321 | 25 |
2044 A table is re-aligned automatically each time you press @key{TAB} or
2045 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2046 the next field (@key{RET} to the next row) and creates new table rows
2047 at the end of the table or before horizontal lines. The indentation
2048 of the table is set by the first line. Any line starting with
2049 @samp{|-} is considered as a horizontal separator line and will be
2050 expanded on the next re-align to span the whole table width. So, to
2051 create the above table, you would only type
2058 @noindent and then press @key{TAB} to align the table and start filling in
2059 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2060 @kbd{C-c @key{RET}}.
2062 @vindex org-enable-table-editor
2063 @vindex org-table-auto-blank-field
2064 When typing text into a field, Org treats @key{DEL},
2065 @key{Backspace}, and all character keys in a special way, so that
2066 inserting and deleting avoids shifting other fields. Also, when
2067 typing @emph{immediately after the cursor was moved into a new field
2068 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2069 field is automatically made blank. If this behavior is too
2070 unpredictable for you, configure the variables
2071 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2074 @tsubheading{Creation and conversion}
2075 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2076 Convert the active region to table. If every line contains at least one
2077 TAB character, the function assumes that the material is tab separated.
2078 If every line contains a comma, comma-separated values (CSV) are assumed.
2079 If not, lines are split at whitespace into fields. You can use a prefix
2080 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2081 C-u} forces TAB, and a numeric argument N indicates that at least N
2082 consecutive spaces, or alternatively a TAB will be the separator.
2084 If there is no active region, this command creates an empty Org
2085 table. But it is easier just to start typing, like
2086 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2088 @tsubheading{Re-aligning and field motion}
2089 @orgcmd{C-c C-c,org-table-align}
2090 Re-align the table without moving the cursor.
2092 @orgcmd{<TAB>,org-table-next-field}
2093 Re-align the table, move to the next field. Creates a new row if
2096 @orgcmd{S-@key{TAB},org-table-previous-field}
2097 Re-align, move to previous field.
2099 @orgcmd{@key{RET},org-table-next-row}
2100 Re-align the table and move down to next row. Creates a new row if
2101 necessary. At the beginning or end of a line, @key{RET} still does
2102 NEWLINE, so it can be used to split a table.
2104 @orgcmd{M-a,org-table-beginning-of-field}
2105 Move to beginning of the current table field, or on to the previous field.
2106 @orgcmd{M-e,org-table-end-of-field}
2107 Move to end of the current table field, or on to the next field.
2109 @tsubheading{Column and row editing}
2110 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2111 Move the current column left/right.
2113 @orgcmd{M-S-@key{left},org-table-delete-column}
2114 Kill the current column.
2116 @orgcmd{M-S-@key{right},org-table-insert-column}
2117 Insert a new column to the left of the cursor position.
2119 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2120 Move the current row up/down.
2122 @orgcmd{M-S-@key{up},org-table-kill-row}
2123 Kill the current row or horizontal line.
2125 @orgcmd{M-S-@key{down},org-table-insert-row}
2126 Insert a new row above the current row. With a prefix argument, the line is
2127 created below the current one.
2129 @orgcmd{C-c -,org-table-insert-hline}
2130 Insert a horizontal line below current row. With a prefix argument, the line
2131 is created above the current line.
2133 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2134 Insert a horizontal line below current row, and move the cursor into the row
2137 @orgcmd{C-c ^,org-table-sort-lines}
2138 Sort the table lines in the region. The position of point indicates the
2139 column to be used for sorting, and the range of lines is the range
2140 between the nearest horizontal separator lines, or the entire table. If
2141 point is before the first column, you will be prompted for the sorting
2142 column. If there is an active region, the mark specifies the first line
2143 and the sorting column, while point should be in the last line to be
2144 included into the sorting. The command prompts for the sorting type
2145 (alphabetically, numerically, or by time). When called with a prefix
2146 argument, alphabetic sorting will be case-sensitive.
2148 @tsubheading{Regions}
2149 @orgcmd{C-c C-x M-w,org-table-copy-region}
2150 Copy a rectangular region from a table to a special clipboard. Point and
2151 mark determine edge fields of the rectangle. If there is no active region,
2152 copy just the current field. The process ignores horizontal separator lines.
2154 @orgcmd{C-c C-x C-w,org-table-cut-region}
2155 Copy a rectangular region from a table to a special clipboard, and
2156 blank all fields in the rectangle. So this is the ``cut'' operation.
2158 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2159 Paste a rectangular region into a table.
2160 The upper left corner ends up in the current field. All involved fields
2161 will be overwritten. If the rectangle does not fit into the present table,
2162 the table is enlarged as needed. The process ignores horizontal separator
2165 @orgcmd{M-@key{RET},org-table-wrap-region}
2166 Split the current field at the cursor position and move the rest to the line
2167 below. If there is an active region, and both point and mark are in the same
2168 column, the text in the column is wrapped to minimum width for the given
2169 number of lines. A numeric prefix argument may be used to change the number
2170 of desired lines. If there is no region, but you specify a prefix argument,
2171 the current field is made blank, and the content is appended to the field
2174 @tsubheading{Calculations}
2175 @cindex formula, in tables
2176 @cindex calculations, in tables
2177 @cindex region, active
2178 @cindex active region
2179 @cindex transient mark mode
2180 @orgcmd{C-c +,org-table-sum}
2181 Sum the numbers in the current column, or in the rectangle defined by
2182 the active region. The result is shown in the echo area and can
2183 be inserted with @kbd{C-y}.
2185 @orgcmd{S-@key{RET},org-table-copy-down}
2186 @vindex org-table-copy-increment
2187 When current field is empty, copy from first non-empty field above. When not
2188 empty, copy current field down to next row and move cursor along with it.
2189 Depending on the variable @code{org-table-copy-increment}, integer field
2190 values will be incremented during copy. Integers that are too large will not
2191 be incremented. Also, a @code{0} prefix argument temporarily disables the
2192 increment. This key is also used by shift-selection and related modes
2193 (@pxref{Conflicts}).
2195 @tsubheading{Miscellaneous}
2196 @orgcmd{C-c `,org-table-edit-field}
2197 Edit the current field in a separate window. This is useful for fields that
2198 are not fully visible (@pxref{Column width and alignment}). When called with
2199 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2200 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2201 window follow the cursor through the table and always show the current
2202 field. The follow mode exits automatically when the cursor leaves the table,
2203 or when you repeat this command with @kbd{C-u C-u C-c `}.
2205 @item M-x org-table-import
2206 Import a file as a table. The table should be TAB or whitespace
2207 separated. Use, for example, to import a spreadsheet table or data
2208 from a database, because these programs generally can write
2209 TAB-separated text files. This command works by inserting the file into
2210 the buffer and then converting the region to a table. Any prefix
2211 argument is passed on to the converter, which uses it to determine the
2213 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2214 Tables can also be imported by pasting tabular text into the Org
2215 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2216 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2218 @item M-x org-table-export
2219 @findex org-table-export
2220 @vindex org-table-export-default-format
2221 Export the table, by default as a TAB-separated file. Use for data
2222 exchange with, for example, spreadsheet or database programs. The format
2223 used to export the file can be configured in the variable
2224 @code{org-table-export-default-format}. You may also use properties
2225 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2226 name and the format for table export in a subtree. Org supports quite
2227 general formats for exported tables. The exporter format is the same as the
2228 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2229 detailed description.
2232 If you don't like the automatic table editor because it gets in your
2233 way on lines which you would like to start with @samp{|}, you can turn
2237 (setq org-enable-table-editor nil)
2240 @noindent Then the only table command that still works is
2241 @kbd{C-c C-c} to do a manual re-align.
2243 @node Column width and alignment, Column groups, Built-in table editor, Tables
2244 @section Column width and alignment
2245 @cindex narrow columns in tables
2246 @cindex alignment in tables
2248 The width of columns is automatically determined by the table editor. And
2249 also the alignment of a column is determined automatically from the fraction
2250 of number-like versus non-number fields in the column.
2252 Sometimes a single field or a few fields need to carry more text, leading to
2253 inconveniently wide columns. Or maybe you want to make a table with several
2254 columns having a fixed width, regardless of content. To set@footnote{This
2255 feature does not work on XEmacs.} the width of a column, one field anywhere
2256 in the column may contain just the string @samp{<N>} where @samp{N} is an
2257 integer specifying the width of the column in characters. The next re-align
2258 will then set the width of this column to this value.
2262 |---+------------------------------| |---+--------|
2264 | 1 | one | | 1 | one |
2265 | 2 | two | ----\ | 2 | two |
2266 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2267 | 4 | four | | 4 | four |
2268 |---+------------------------------| |---+--------|
2273 Fields that are wider become clipped and end in the string @samp{=>}.
2274 Note that the full text is still in the buffer but is hidden.
2275 To see the full text, hold the mouse over the field---a tool-tip window
2276 will show the full content. To edit such a field, use the command
2277 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2278 open a new window with the full field. Edit it and finish with @kbd{C-c
2281 @vindex org-startup-align-all-tables
2282 When visiting a file containing a table with narrowed columns, the
2283 necessary character hiding has not yet happened, and the table needs to
2284 be aligned before it looks nice. Setting the option
2285 @code{org-startup-align-all-tables} will realign all tables in a file
2286 upon visiting, but also slow down startup. You can also set this option
2287 on a per-file basis with:
2294 If you would like to overrule the automatic alignment of number-rich columns
2295 to the right and of string-rich column to the left, you can use @samp{<r>},
2296 @samp{c}@footnote{Centering does not work inside Emacs, but it does have an
2297 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2298 also combine alignment and field width like this: @samp{<l10>}.
2300 Lines which only contain these formatting cookies will be removed
2301 automatically when exporting the document.
2303 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2304 @section Column groups
2305 @cindex grouping columns in tables
2307 When Org exports tables, it does so by default without vertical
2308 lines because that is visually more satisfying in general. Occasionally
2309 however, vertical lines can be useful to structure a table into groups
2310 of columns, much like horizontal lines can do for groups of rows. In
2311 order to specify column groups, you can use a special row where the
2312 first field contains only @samp{/}. The further fields can either
2313 contain @samp{<} to indicate that this column should start a group,
2314 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2315 and @samp{>}) to make a column
2316 a group of its own. Boundaries between column groups will upon export be
2317 marked with vertical lines. Here is an example:
2320 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2321 |---+-----+-----+-----+---------+------------|
2322 | / | < | | > | < | > |
2323 | 1 | 1 | 1 | 1 | 1 | 1 |
2324 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2325 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2326 |---+-----+-----+-----+---------+------------|
2327 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2330 It is also sufficient to just insert the column group starters after
2331 every vertical line you would like to have:
2334 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2335 |----+-----+-----+-----+---------+------------|
2339 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2340 @section The Orgtbl minor mode
2342 @cindex minor mode for tables
2344 If you like the intuitive way the Org table editor works, you
2345 might also want to use it in other modes like Text mode or Mail mode.
2346 The minor mode Orgtbl mode makes this possible. You can always toggle
2347 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2348 example in Message mode, use
2351 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2354 Furthermore, with some special setup, it is possible to maintain tables
2355 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2356 construct @LaTeX{} tables with the underlying ease and power of
2357 Orgtbl mode, including spreadsheet capabilities. For details, see
2358 @ref{Tables in arbitrary syntax}.
2360 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2361 @section The spreadsheet
2362 @cindex calculations, in tables
2363 @cindex spreadsheet capabilities
2364 @cindex @file{calc} package
2366 The table editor makes use of the Emacs @file{calc} package to implement
2367 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2368 derive fields from other fields. While fully featured, Org's implementation
2369 is not identical to other spreadsheets. For example, Org knows the concept
2370 of a @emph{column formula} that will be applied to all non-header fields in a
2371 column without having to copy the formula to each relevant field. There is
2372 also a formula debugger, and a formula editor with features for highlighting
2373 fields in the table corresponding to the references at the point in the
2374 formula, moving these references by arrow keys
2377 * References:: How to refer to another field or range
2378 * Formula syntax for Calc:: Using Calc to compute stuff
2379 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2380 * Durations and time values:: How to compute durations and time values
2381 * Field and range formulas:: Formula for specific (ranges of) fields
2382 * Column formulas:: Formulas valid for an entire column
2383 * Editing and debugging formulas:: Fixing formulas
2384 * Updating the table:: Recomputing all dependent fields
2385 * Advanced features:: Field and column names, parameters and automatic recalc
2388 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2389 @subsection References
2392 To compute fields in the table from other fields, formulas must
2393 reference other fields or ranges. In Org, fields can be referenced
2394 by name, by absolute coordinates, and by relative coordinates. To find
2395 out what the coordinates of a field are, press @kbd{C-c ?} in that
2396 field, or press @kbd{C-c @}} to toggle the display of a grid.
2398 @subsubheading Field references
2399 @cindex field references
2400 @cindex references, to fields
2402 Formulas can reference the value of another field in two ways. Like in
2403 any other spreadsheet, you may reference fields with a letter/number
2404 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2405 @vindex org-table-use-standard-references
2406 However, Org prefers@footnote{Org will understand references typed by the
2407 user as @samp{B4}, but it will not use this syntax when offering a formula
2408 for editing. You can customize this behavior using the variable
2409 @code{org-table-use-standard-references}.} to use another, more general
2410 representation that looks like this:
2412 @@@var{row}$@var{column}
2415 Column specifications can be absolute like @code{$1},
2416 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e.@: the
2417 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2418 @code{$<} and @code{$>} are immutable references to the first and last
2419 column, respectively, and you can use @code{$>>>} to indicate the third
2420 column from the right.
2422 The row specification only counts data lines and ignores horizontal separator
2423 lines (hlines). Like with columns, you can use absolute row numbers
2424 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2425 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2426 immutable references the first and last@footnote{For backward compatibility
2427 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2428 a stable way to the 5th and 12th field in the last row of the table.
2429 However, this syntax is deprecated, it should not be used for new documents.
2430 Use @code{@@>$} instead.} row in the table, respectively. You may also
2431 specify the row relative to one of the hlines: @code{@@I} refers to the first
2432 hline, @code{@@II} to the second, etc@. @code{@@-I} refers to the first such
2433 line above the current line, @code{@@+I} to the first such line below the
2434 current line. You can also write @code{@@III+2} which is the second data line
2435 after the third hline in the table.
2437 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2438 i.e. to the row/column for the field being computed. Also, if you omit
2439 either the column or the row part of the reference, the current row/column is
2442 Org's references with @emph{unsigned} numbers are fixed references
2443 in the sense that if you use the same reference in the formula for two
2444 different fields, the same field will be referenced each time.
2445 Org's references with @emph{signed} numbers are floating
2446 references because the same reference operator can reference different
2447 fields depending on the field being calculated by the formula.
2449 Here are a few examples:
2452 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2453 $5 @r{column 5 in the current row (same as @code{E&})}
2454 @@2 @r{current column, row 2}
2455 @@-1$-3 @r{the field one row up, three columns to the left}
2456 @@-I$2 @r{field just under hline above current row, column 2}
2457 @@>$5 @r{field in the last row, in column 5}
2460 @subsubheading Range references
2461 @cindex range references
2462 @cindex references, to ranges
2464 You may reference a rectangular range of fields by specifying two field
2465 references connected by two dots @samp{..}. If both fields are in the
2466 current row, you may simply use @samp{$2..$7}, but if at least one field
2467 is in a different row, you need to use the general @code{@@row$column}
2468 format at least for the first field (i.e the reference must start with
2469 @samp{@@} in order to be interpreted correctly). Examples:
2472 $1..$3 @r{first three fields in the current row}
2473 $P..$Q @r{range, using column names (see under Advanced)}
2474 $<<<..$>> @r{start in third column, continue to the one but last}
2475 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2476 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2477 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2480 @noindent Range references return a vector of values that can be fed
2481 into Calc vector functions. Empty fields in ranges are normally
2482 suppressed, so that the vector contains only the non-empty fields (but
2483 see the @samp{E} mode switch below). If there are no non-empty fields,
2484 @samp{[0]} is returned to avoid syntax errors in formulas.
2486 @subsubheading Field coordinates in formulas
2487 @cindex field coordinates
2488 @cindex coordinates, of field
2489 @cindex row, of field coordinates
2490 @cindex column, of field coordinates
2492 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2493 get the row or column number of the field where the formula result goes.
2494 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2495 and @code{org-table-current-column}. Examples:
2498 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2499 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2500 @r{column 3 of the current table}
2503 @noindent For the second example, table FOO must have at least as many rows
2504 as the current table. Note that this is inefficient@footnote{The computation time scales as
2505 O(N^2) because table FOO is parsed for each field to be copied.} for large
2508 @subsubheading Named references
2509 @cindex named references
2510 @cindex references, named
2511 @cindex name, of column or field
2512 @cindex constants, in calculations
2515 @vindex org-table-formula-constants
2516 @samp{$name} is interpreted as the name of a column, parameter or
2517 constant. Constants are defined globally through the variable
2518 @code{org-table-formula-constants}, and locally (for the file) through a
2522 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2526 @vindex constants-unit-system
2527 @pindex constants.el
2528 Also properties (@pxref{Properties and Columns}) can be used as
2529 constants in table formulas: for a property @samp{:Xyz:} use the name
2530 @samp{$PROP_Xyz}, and the property will be searched in the current
2531 outline entry and in the hierarchy above it. If you have the
2532 @file{constants.el} package, it will also be used to resolve constants,
2533 including natural constants like @samp{$h} for Planck's constant, and
2534 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2535 supply the values of constants in two different unit systems, @code{SI}
2536 and @code{cgs}. Which one is used depends on the value of the variable
2537 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2538 @code{constSI} and @code{constcgs} to set this value for the current
2539 buffer.}. Column names and parameters can be specified in special table
2540 lines. These are described below, see @ref{Advanced features}. All
2541 names must start with a letter, and further consist of letters and
2544 @subsubheading Remote references
2545 @cindex remote references
2546 @cindex references, remote
2547 @cindex references, to a different table
2548 @cindex name, of column or field
2549 @cindex constants, in calculations
2552 You may also reference constants, fields and ranges from a different table,
2553 either in the current file or even in a different file. The syntax is
2556 remote(NAME-OR-ID,REF)
2560 where NAME can be the name of a table in the current file as set by a
2561 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2562 entry, even in a different file, and the reference then refers to the first
2563 table in that entry. REF is an absolute field or range reference as
2564 described above for example @code{@@3$3} or @code{$somename}, valid in the
2567 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2568 @subsection Formula syntax for Calc
2569 @cindex formula syntax, Calc
2570 @cindex syntax, of formulas
2572 A formula can be any algebraic expression understood by the Emacs
2573 @file{Calc} package. @b{Note that @file{calc} has the
2574 non-standard convention that @samp{/} has lower precedence than
2575 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2576 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2577 Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc, GNU
2578 Emacs Calc Manual}),
2579 variable substitution takes place according to the rules described above.
2580 @cindex vectors, in table calculations
2581 The range vectors can be directly fed into the Calc vector functions
2582 like @samp{vmean} and @samp{vsum}.
2584 @cindex format specifier
2585 @cindex mode, for @file{calc}
2586 @vindex org-calc-default-modes
2587 A formula can contain an optional mode string after a semicolon. This
2588 string consists of flags to influence Calc and other modes during
2589 execution. By default, Org uses the standard Calc modes (precision
2590 12, angular units degrees, fraction and symbolic modes off). The display
2591 format, however, has been changed to @code{(float 8)} to keep tables
2592 compact. The default settings can be configured using the variable
2593 @code{org-calc-default-modes}.
2596 p20 @r{set the internal Calc calculation precision to 20 digits}
2597 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2598 @r{format of the result of Calc passed back to Org.}
2599 @r{Calc formatting is unlimited in precision as}
2600 @r{long as the Calc calculation precision is greater.}
2601 D R @r{angle modes: degrees, radians}
2602 F S @r{fraction and symbolic modes}
2603 N @r{interpret all fields as numbers, use 0 for non-numbers}
2604 E @r{keep empty fields in ranges}
2609 Unless you use large integer numbers or high-precision-calculation
2610 and -display for floating point numbers you may alternatively provide a
2611 @code{printf} format specifier to reformat the Calc result after it has been
2612 passed back to Org instead of letting Calc already do the
2613 formatting@footnote{The @code{printf} reformatting is limited in precision
2614 because the value passed to it is converted into an @code{integer} or
2615 @code{double}. The @code{integer} is limited in size by truncating the
2616 signed value to 32 bits. The @code{double} is limited in precision to 64
2617 bits overall which leaves approximately 16 significant decimal digits.}.
2621 $1+$2 @r{Sum of first and second field}
2622 $1+$2;%.2f @r{Same, format result to two decimals}
2623 exp($2)+exp($1) @r{Math functions can be used}
2624 $0;%.1f @r{Reformat current cell to 1 decimal}
2625 ($3-32)*5/9 @r{Degrees F -> C conversion}
2626 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2627 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2628 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2629 vmean($2..$7) @r{Compute column range mean, using vector function}
2630 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2631 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2634 Calc also contains a complete set of logical operations. For example
2637 if($1<20,teen,string("")) @r{"teen" if age $1 less than 20, else empty}
2640 Note that you can also use two org-specific flags @code{T} and @code{t} for
2641 durations computations @ref{Durations and time values}.
2643 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2644 @subsection Emacs Lisp forms as formulas
2645 @cindex Lisp forms, as table formulas
2647 It is also possible to write a formula in Emacs Lisp. This can be useful
2648 for string manipulation and control structures, if Calc's functionality is
2651 If a formula starts with a single-quote followed by an opening parenthesis,
2652 then it is evaluated as a Lisp form. The evaluation should return either a
2653 string or a number. Just as with @file{calc} formulas, you can specify modes
2654 and a printf format after a semicolon.
2656 With Emacs Lisp forms, you need to be conscious about the way field
2657 references are interpolated into the form. By default, a reference will be
2658 interpolated as a Lisp string (in double-quotes) containing the field. If
2659 you provide the @samp{N} mode switch, all referenced elements will be numbers
2660 (non-number fields will be zero) and interpolated as Lisp numbers, without
2661 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2662 literally, without quotes. I.e., if you want a reference to be interpreted
2663 as a string by the Lisp form, enclose the reference operator itself in
2664 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2665 fields, so you can embed them in list or vector syntax.
2667 Here are a few examples---note how the @samp{N} mode is used when we do
2668 computations in Lisp:
2671 @r{Swap the first two characters of the content of column 1}
2672 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2673 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2675 @r{Compute the sum of columns 1-4, like Calc's @code{vsum($1..$4)}}
2676 '(apply '+ '($1..$4));N
2679 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2680 @subsection Durations and time values
2681 @cindex Duration, computing
2682 @cindex Time, computing
2683 @vindex org-table-duration-custom-format
2685 If you want to compute time values use the @code{T} flag, either in Calc
2686 formulas or Elisp formulas:
2690 | Task 1 | Task 2 | Total |
2691 |---------+----------+----------|
2692 | 2:12 | 1:47 | 03:59:00 |
2693 | 3:02:20 | -2:07:00 | 0.92 |
2694 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2698 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2699 are optional. With the @code{T} flag, computed durations will be displayed
2700 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2701 computed durations will be displayed according to the value of the variable
2702 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2703 will display the result as a fraction of hours (see the second formula in the
2706 Negative duration values can be manipulated as well, and integers will be
2707 considered as seconds in addition and subtraction.
2709 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2710 @subsection Field and range formulas
2711 @cindex field formula
2712 @cindex range formula
2713 @cindex formula, for individual table field
2714 @cindex formula, for range of fields
2716 To assign a formula to a particular field, type it directly into the field,
2717 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2718 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2719 the formula will be stored as the formula for this field, evaluated, and the
2720 current field will be replaced with the result.
2723 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2724 below the table. If you type the equation in the 4th field of the 3rd data
2725 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2726 inserting/deleting/swapping column and rows with the appropriate commands,
2727 @i{absolute references} (but not relative ones) in stored formulas are
2728 modified in order to still reference the same field. To avoid this from
2729 happening, in particular in range references, anchor ranges at the table
2730 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2731 using the @code{@@I} notation. Automatic adaptation of field references does
2732 of course not happen if you edit the table structure with normal editing
2733 commands---then you must fix the equations yourself.
2735 Instead of typing an equation into the field, you may also use the following
2739 @orgcmd{C-u C-c =,org-table-eval-formula}
2740 Install a new formula for the current field. The command prompts for a
2741 formula with default taken from the @samp{#+TBLFM:} line, applies
2742 it to the current field, and stores it.
2745 The left-hand side of a formula can also be a special expression in order to
2746 assign the formula to a number of different fields. There is no keyboard
2747 shortcut to enter such range formulas. To add them, use the formula editor
2748 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2753 Column formula, valid for the entire column. This is so common that Org
2754 treats these formulas in a special way, see @ref{Column formulas}.
2756 Row formula, applies to all fields in the specified row. @code{@@>=} means
2759 Range formula, applies to all fields in the given rectangular range. This
2760 can also be used to assign a formula to some but not all fields in a row.
2762 Named field, see @ref{Advanced features}.
2765 @node Column formulas, Editing and debugging formulas, Field and range formulas, The spreadsheet
2766 @subsection Column formulas
2767 @cindex column formula
2768 @cindex formula, for table column
2770 When you assign a formula to a simple column reference like @code{$3=}, the
2771 same formula will be used in all fields of that column, with the following
2772 very convenient exceptions: (i) If the table contains horizontal separator
2773 hlines, everything before the first such line is considered part of the table
2774 @emph{header} and will not be modified by column formulas. (ii) Fields that
2775 already get a value from a field/range formula will be left alone by column
2776 formulas. These conditions make column formulas very easy to use.
2778 To assign a formula to a column, type it directly into any field in the
2779 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2780 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2781 the formula will be stored as the formula for the current column, evaluated
2782 and the current field replaced with the result. If the field contains only
2783 @samp{=}, the previously stored formula for this column is used. For each
2784 column, Org will only remember the most recently used formula. In the
2785 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2786 left-hand side of a column formula can not be the name of column, it must be
2787 the numeric column reference or @code{$>}.
2789 Instead of typing an equation into the field, you may also use the
2793 @orgcmd{C-c =,org-table-eval-formula}
2794 Install a new formula for the current column and replace current field with
2795 the result of the formula. The command prompts for a formula, with default
2796 taken from the @samp{#+TBLFM} line, applies it to the current field and
2797 stores it. With a numeric prefix argument(e.g.@: @kbd{C-5 C-c =}) the command
2798 will apply it to that many consecutive fields in the current column.
2801 @node Editing and debugging formulas, Updating the table, Column formulas, The spreadsheet
2802 @subsection Editing and debugging formulas
2803 @cindex formula editing
2804 @cindex editing, of table formulas
2806 @vindex org-table-use-standard-references
2807 You can edit individual formulas in the minibuffer or directly in the
2808 field. Org can also prepare a special buffer with all active
2809 formulas of a table. When offering a formula for editing, Org
2810 converts references to the standard format (like @code{B3} or @code{D&})
2811 if possible. If you prefer to only work with the internal format (like
2812 @code{@@3$2} or @code{$4}), configure the variable
2813 @code{org-table-use-standard-references}.
2816 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2817 Edit the formula associated with the current column/field in the
2818 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2819 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2820 Re-insert the active formula (either a
2821 field formula, or a column formula) into the current field, so that you
2822 can edit it directly in the field. The advantage over editing in the
2823 minibuffer is that you can use the command @kbd{C-c ?}.
2824 @orgcmd{C-c ?,org-table-field-info}
2825 While editing a formula in a table field, highlight the field(s)
2826 referenced by the reference at the cursor position in the formula.
2828 @findex org-table-toggle-coordinate-overlays
2830 Toggle the display of row and column numbers for a table, using overlays
2831 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2832 time the table is aligned; you can force it with @kbd{C-c C-c}.
2834 @findex org-table-toggle-formula-debugger
2836 Toggle the formula debugger on and off
2837 (@command{org-table-toggle-formula-debugger}). See below.
2838 @orgcmd{C-c ',org-table-edit-formulas}
2839 Edit all formulas for the current table in a special buffer, where the
2840 formulas will be displayed one per line. If the current field has an
2841 active formula, the cursor in the formula editor will mark it.
2842 While inside the special buffer, Org will automatically highlight
2843 any field or range reference at the cursor position. You may edit,
2844 remove and add formulas, and use the following commands:
2846 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2847 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2848 prefix, also apply the new formulas to the entire table.
2849 @orgcmd{C-c C-q,org-table-fedit-abort}
2850 Exit the formula editor without installing changes.
2851 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2852 Toggle all references in the formula editor between standard (like
2853 @code{B3}) and internal (like @code{@@3$2}).
2854 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2855 Pretty-print or indent Lisp formula at point. When in a line containing
2856 a Lisp formula, format the formula according to Emacs Lisp rules.
2857 Another @key{TAB} collapses the formula back again. In the open
2858 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2859 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2860 Complete Lisp symbols, just like in Emacs Lisp mode.
2862 @kindex S-@key{down}
2863 @kindex S-@key{left}
2864 @kindex S-@key{right}
2865 @findex org-table-fedit-ref-up
2866 @findex org-table-fedit-ref-down
2867 @findex org-table-fedit-ref-left
2868 @findex org-table-fedit-ref-right
2869 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2870 Shift the reference at point. For example, if the reference is
2871 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2872 This also works for relative references and for hline references.
2873 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2874 Move the test line for column formulas in the Org buffer up and
2876 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2877 Scroll the window displaying the table.
2879 @findex org-table-toggle-coordinate-overlays
2881 Turn the coordinate grid in the table on and off.
2885 Making a table field blank does not remove the formula associated with
2886 the field, because that is stored in a different line (the @samp{#+TBLFM}
2887 line)---during the next recalculation the field will be filled again.
2888 To remove a formula from a field, you have to give an empty reply when
2889 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2892 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2893 equations with @kbd{C-c C-c} in that line or with the normal
2894 recalculation commands in the table.
2896 @subsubheading Debugging formulas
2897 @cindex formula debugging
2898 @cindex debugging, of table formulas
2899 When the evaluation of a formula leads to an error, the field content
2900 becomes the string @samp{#ERROR}. If you would like see what is going
2901 on during variable substitution and calculation in order to find a bug,
2902 turn on formula debugging in the @code{Tbl} menu and repeat the
2903 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2904 field. Detailed information will be displayed.
2906 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2907 @subsection Updating the table
2908 @cindex recomputing table fields
2909 @cindex updating, table
2911 Recalculation of a table is normally not automatic, but needs to be
2912 triggered by a command. See @ref{Advanced features}, for a way to make
2913 recalculation at least semi-automatic.
2915 In order to recalculate a line of a table or the entire table, use the
2919 @orgcmd{C-c *,org-table-recalculate}
2920 Recalculate the current row by first applying the stored column formulas
2921 from left to right, and all field/range formulas in the current row.
2927 Recompute the entire table, line by line. Any lines before the first
2928 hline are left alone, assuming that these are part of the table header.
2930 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2931 Iterate the table by recomputing it until no further changes occur.
2932 This may be necessary if some computed fields use the value of other
2933 fields that are computed @i{later} in the calculation sequence.
2934 @item M-x org-table-recalculate-buffer-tables
2935 @findex org-table-recalculate-buffer-tables
2936 Recompute all tables in the current buffer.
2937 @item M-x org-table-iterate-buffer-tables
2938 @findex org-table-iterate-buffer-tables
2939 Iterate all tables in the current buffer, in order to converge table-to-table
2943 @node Advanced features, , Updating the table, The spreadsheet
2944 @subsection Advanced features
2946 If you want the recalculation of fields to happen automatically, or if you
2947 want to be able to assign @i{names}@footnote{Such names must start by an
2948 alphabetic character and use only alphanumeric/underscore characters.} to
2949 fields and columns, you need to reserve the first column of the table for
2950 special marking characters.
2953 @orgcmd{C-#,org-table-rotate-recalc-marks}
2954 Rotate the calculation mark in first column through the states @samp{ },
2955 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2956 change all marks in the region.
2959 Here is an example of a table that collects exam results of students and
2960 makes use of these features:
2964 |---+---------+--------+--------+--------+-------+------|
2965 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2966 |---+---------+--------+--------+--------+-------+------|
2967 | ! | | P1 | P2 | P3 | Tot | |
2968 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2969 | ^ | | m1 | m2 | m3 | mt | |
2970 |---+---------+--------+--------+--------+-------+------|
2971 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
2972 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
2973 |---+---------+--------+--------+--------+-------+------|
2974 | | Average | | | | 25.0 | |
2975 | ^ | | | | | at | |
2976 | $ | max=50 | | | | | |
2977 |---+---------+--------+--------+--------+-------+------|
2978 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
2982 @noindent @b{Important}: please note that for these special tables,
2983 recalculating the table with @kbd{C-u C-c *} will only affect rows that
2984 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
2985 to the field itself. The column formulas are not applied in rows with
2988 @cindex marking characters, tables
2989 The marking characters have the following meaning:
2992 The fields in this line define names for the columns, so that you may
2993 refer to a column as @samp{$Tot} instead of @samp{$6}.
2995 This row defines names for the fields @emph{above} the row. With such
2996 a definition, any formula in the table may use @samp{$m1} to refer to
2997 the value @samp{10}. Also, if you assign a formula to a names field, it
2998 will be stored as @samp{$name=...}.
3000 Similar to @samp{^}, but defines names for the fields in the row
3003 Fields in this row can define @emph{parameters} for formulas. For
3004 example, if a field in a @samp{$} row contains @samp{max=50}, then
3005 formulas in this table can refer to the value 50 using @samp{$max}.
3006 Parameters work exactly like constants, only that they can be defined on
3009 Fields in this row are automatically recalculated when pressing
3010 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3011 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3012 lines will be left alone by this command.
3014 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3015 not for automatic recalculation. Use this when automatic
3016 recalculation slows down editing too much.
3018 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3019 All lines that should be recalculated should be marked with @samp{#}
3022 Do not export this line. Useful for lines that contain the narrowing
3023 @samp{<N>} markers or column group markers.
3026 Finally, just to whet your appetite for what can be done with the
3027 fantastic @file{calc.el} package, here is a table that computes the Taylor
3028 series of degree @code{n} at location @code{x} for a couple of
3033 |---+-------------+---+-----+--------------------------------------|
3034 | | Func | n | x | Result |
3035 |---+-------------+---+-----+--------------------------------------|
3036 | # | exp(x) | 1 | x | 1 + x |
3037 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3038 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3039 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3040 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3041 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3042 |---+-------------+---+-----+--------------------------------------|
3043 #+TBLFM: $5=taylor($2,$4,$3);n3
3047 @node Org-Plot, , The spreadsheet, Tables
3049 @cindex graph, in tables
3050 @cindex plot tables using Gnuplot
3053 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3054 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3055 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
3056 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
3057 on your system, then call @code{org-plot/gnuplot} on the following table.
3061 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3062 | Sede | Max cites | H-index |
3063 |-----------+-----------+---------|
3064 | Chile | 257.72 | 21.39 |
3065 | Leeds | 165.77 | 19.68 |
3066 | Sao Paolo | 71.00 | 11.50 |
3067 | Stockholm | 134.19 | 14.33 |
3068 | Morelia | 257.56 | 17.67 |
3072 Notice that Org Plot is smart enough to apply the table's headers as labels.
3073 Further control over the labels, type, content, and appearance of plots can
3074 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3075 for a complete list of Org-plot options. For more information and examples
3076 see the Org-plot tutorial at
3077 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3079 @subsubheading Plot Options
3083 Specify any @command{gnuplot} option to be set when graphing.
3086 Specify the title of the plot.
3089 Specify which column of the table to use as the @code{x} axis.
3092 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3093 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3094 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3098 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3101 Specify a @code{with} option to be inserted for every col being plotted
3102 (e.g.@: @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3103 Defaults to @code{lines}.
3106 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3109 List of labels to be used for the @code{deps} (defaults to the column headers
3113 Specify an entire line to be inserted in the Gnuplot script.
3116 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3117 flat mapping rather than a @code{3d} slope.
3120 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3121 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3124 If you want total control, you can specify a script file (place the file name
3125 between double-quotes) which will be used to plot. Before plotting, every
3126 instance of @code{$datafile} in the specified script will be replaced with
3127 the path to the generated data file. Note: even if you set this option, you
3128 may still want to specify the plot type, as that can impact the content of
3132 @node Hyperlinks, TODO Items, Tables, Top
3136 Like HTML, Org provides links inside a file, external links to
3137 other files, Usenet articles, emails, and much more.
3140 * Link format:: How links in Org are formatted
3141 * Internal links:: Links to other places in the current file
3142 * External links:: URL-like links to the world
3143 * Handling links:: Creating, inserting and following
3144 * Using links outside Org:: Linking from my C source code?
3145 * Link abbreviations:: Shortcuts for writing complex links
3146 * Search options:: Linking to a specific location
3147 * Custom searches:: When the default search is not enough
3150 @node Link format, Internal links, Hyperlinks, Hyperlinks
3151 @section Link format
3153 @cindex format, of links
3155 Org will recognize plain URL-like links and activate them as
3156 clickable links. The general link format, however, looks like this:
3159 [[link][description]] @r{or alternatively} [[link]]
3163 Once a link in the buffer is complete (all brackets present), Org
3164 will change the display so that @samp{description} is displayed instead
3165 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3166 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3167 which by default is an underlined face. You can directly edit the
3168 visible part of a link. Note that this can be either the @samp{link}
3169 part (if there is no description) or the @samp{description} part. To
3170 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3173 If you place the cursor at the beginning or just behind the end of the
3174 displayed text and press @key{BACKSPACE}, you will remove the
3175 (invisible) bracket at that location. This makes the link incomplete
3176 and the internals are again displayed as plain text. Inserting the
3177 missing bracket hides the link internals again. To show the
3178 internal structure of all links, use the menu entry
3179 @code{Org->Hyperlinks->Literal links}.
3181 @node Internal links, External links, Link format, Hyperlinks
3182 @section Internal links
3183 @cindex internal links
3184 @cindex links, internal
3185 @cindex targets, for links
3187 @cindex property, CUSTOM_ID
3188 If the link does not look like a URL, it is considered to be internal in the
3189 current file. The most important case is a link like
3190 @samp{[[#my-custom-id]]} which will link to the entry with the
3191 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
3192 for HTML export (@pxref{HTML export}) where they produce pretty section
3193 links. You are responsible yourself to make sure these custom IDs are unique
3196 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3197 lead to a text search in the current file.
3199 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3200 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3201 point to the corresponding headline. The preferred match for a text link is
3202 a @i{dedicated target}: the same string in double angular brackets. Targets
3203 may be located anywhere; sometimes it is convenient to put them into a
3204 comment line. For example
3210 @noindent In HTML export (@pxref{HTML export}), such targets will become
3211 named anchors for direct access through @samp{http} links@footnote{Note that
3212 text before the first headline is usually not exported, so the first such
3213 target should be after the first headline, or in the line directly before the
3216 If no dedicated target exists, Org will search for a headline that is exactly
3217 the link text but may also include a TODO keyword and tags@footnote{To insert
3218 a link targeting a headline, in-buffer completion can be used. Just type a
3219 star followed by a few optional letters into the buffer and press
3220 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3221 completions.}. In non-Org files, the search will look for the words in the
3222 link text. In the above example the search would be for @samp{my target}.
3224 Following a link pushes a mark onto Org's own mark ring. You can
3225 return to the previous position with @kbd{C-c &}. Using this command
3226 several times in direct succession goes back to positions recorded
3230 * Radio targets:: Make targets trigger links in plain text
3233 @node Radio targets, , Internal links, Internal links
3234 @subsection Radio targets
3235 @cindex radio targets
3236 @cindex targets, radio
3237 @cindex links, radio targets
3239 Org can automatically turn any occurrences of certain target names
3240 in normal text into a link. So without explicitly creating a link, the
3241 text connects to the target radioing its position. Radio targets are
3242 enclosed by triple angular brackets. For example, a target @samp{<<<My
3243 Target>>>} causes each occurrence of @samp{my target} in normal text to
3244 become activated as a link. The Org file is scanned automatically
3245 for radio targets only when the file is first loaded into Emacs. To
3246 update the target list during editing, press @kbd{C-c C-c} with the
3247 cursor on or at a target.
3249 @node External links, Handling links, Internal links, Hyperlinks
3250 @section External links
3251 @cindex links, external
3252 @cindex external links
3253 @cindex links, external
3261 @cindex WANDERLUST links
3263 @cindex USENET links
3268 Org supports links to files, websites, Usenet and email messages,
3269 BBDB database entries and links to both IRC conversations and their
3270 logs. External links are URL-like locators. They start with a short
3271 identifying string followed by a colon. There can be no space after
3272 the colon. The following list shows examples for each link type.
3275 http://www.astro.uva.nl/~dominik @r{on the web}
3276 doi:10.1000/182 @r{DOI for an electronic resource}
3277 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3278 /home/dominik/images/jupiter.jpg @r{same as above}
3279 file:papers/last.pdf @r{file, relative path}
3280 ./papers/last.pdf @r{same as above}
3281 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3282 /myself@@some.where:papers/last.pdf @r{same as above}
3283 file:sometextfile::NNN @r{file, jump to line number}
3284 file:projects.org @r{another Org file}
3285 file:projects.org::some words @r{text search in Org file}@footnote{
3286 The actual behavior of the search will depend on the value of
3287 the variable @code{org-link-search-must-match-exact-headline}. If its value
3288 is nil, then a fuzzy text search will be done. If it is t, then only the
3289 exact headline will be matched. If the value is @code{'query-to-create},
3290 then an exact headline will be searched; if it is not found, then the user
3291 will be queried to create it.}
3292 file:projects.org::*task title @r{heading search in Org file}
3293 file+sys:/path/to/file @r{open via OS, like double-click}
3294 file+emacs:/path/to/file @r{force opening by Emacs}
3295 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3296 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3297 news:comp.emacs @r{Usenet link}
3298 mailto:adent@@galaxy.net @r{Mail link}
3299 vm:folder @r{VM folder link}
3300 vm:folder#id @r{VM message link}
3301 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3302 vm-imap:account:folder @r{VM IMAP folder link}
3303 vm-imap:account:folder#id @r{VM IMAP message link}
3304 wl:folder @r{WANDERLUST folder link}
3305 wl:folder#id @r{WANDERLUST message link}
3306 mhe:folder @r{MH-E folder link}
3307 mhe:folder#id @r{MH-E message link}
3308 rmail:folder @r{RMAIL folder link}
3309 rmail:folder#id @r{RMAIL message link}
3310 gnus:group @r{Gnus group link}
3311 gnus:group#id @r{Gnus article link}
3312 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3313 irc:/irc.com/#emacs/bob @r{IRC link}
3314 info:org#External links @r{Info node link}
3315 shell:ls *.org @r{A shell command}
3316 elisp:org-agenda @r{Interactive Elisp command}
3317 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3320 For customizing Org to add new link types @ref{Adding hyperlink types}.
3322 A link should be enclosed in double brackets and may contain a
3323 descriptive text to be displayed instead of the URL (@pxref{Link
3324 format}), for example:
3327 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3331 If the description is a file name or URL that points to an image, HTML
3332 export (@pxref{HTML export}) will inline the image as a clickable
3333 button. If there is no description at all and the link points to an
3335 that image will be inlined into the exported HTML file.
3337 @cindex square brackets, around links
3338 @cindex plain text external links
3339 Org also finds external links in the normal text and activates them
3340 as links. If spaces must be part of the link (for example in
3341 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3342 about the end of the link, enclose them in square brackets.
3344 @node Handling links, Using links outside Org, External links, Hyperlinks
3345 @section Handling links
3346 @cindex links, handling
3348 Org provides methods to create a link in the correct syntax, to
3349 insert it into an Org file, and to follow the link.
3352 @orgcmd{C-c l,org-store-link}
3353 @cindex storing links
3354 Store a link to the current location. This is a @emph{global} command (you
3355 must create the key binding yourself) which can be used in any buffer to
3356 create a link. The link will be stored for later insertion into an Org
3357 buffer (see below). What kind of link will be created depends on the current
3360 @b{Org mode buffers}@*
3361 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3362 to the target. Otherwise it points to the current headline, which will also
3363 be the description@footnote{If the headline contains a timestamp, it will be
3364 removed from the link and result in a wrong link -- you should avoid putting
3365 timestamp in the headline.}.
3367 @vindex org-link-to-org-use-id
3368 @cindex property, CUSTOM_ID
3369 @cindex property, ID
3370 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3371 will be stored. In addition or alternatively (depending on the value of
3372 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3373 created and/or used to construct a link. So using this command in Org
3374 buffers will potentially create two links: a human-readable from the custom
3375 ID, and one that is globally unique and works even if the entry is moved from
3376 file to file. Later, when inserting the link, you need to decide which one
3379 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3380 Pretty much all Emacs mail clients are supported. The link will point to the
3381 current article, or, in some GNUS buffers, to the group. The description is
3382 constructed from the author and the subject.
3384 @b{Web browsers: W3 and W3M}@*
3385 Here the link will be the current URL, with the page title as description.
3387 @b{Contacts: BBDB}@*
3388 Links created in a BBDB buffer will point to the current entry.
3391 @vindex org-irc-link-to-logs
3392 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3393 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3394 the current conversation is created. Otherwise an @samp{irc:/} style link to
3395 the user/channel/server under the point will be stored.
3398 For any other files, the link will point to the file, with a search string
3399 (@pxref{Search options}) pointing to the contents of the current line. If
3400 there is an active region, the selected words will form the basis of the
3401 search string. If the automatically created link is not working correctly or
3402 accurately enough, you can write custom functions to select the search string
3403 and to do the search for particular file types---see @ref{Custom searches}.
3404 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3407 When the cursor is in an agenda view, the created link points to the
3408 entry referenced by the current line.
3411 @orgcmd{C-c C-l,org-insert-link}
3412 @cindex link completion
3413 @cindex completion, of links
3414 @cindex inserting links
3415 @vindex org-keep-stored-link-after-insertion
3416 Insert a link@footnote{ Note that you don't have to use this command to
3417 insert a link. Links in Org are plain text, and you can type or paste them
3418 straight into the buffer. By using this command, the links are automatically
3419 enclosed in double brackets, and you will be asked for the optional
3420 descriptive text.}. This prompts for a link to be inserted into the buffer.
3421 You can just type a link, using text for an internal link, or one of the link
3422 type prefixes mentioned in the examples above. The link will be inserted
3423 into the buffer@footnote{After insertion of a stored link, the link will be
3424 removed from the list of stored links. To keep it in the list later use, use
3425 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3426 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3427 If some text was selected when this command is called, the selected text
3428 becomes the default description.
3430 @b{Inserting stored links}@*
3431 All links stored during the
3432 current session are part of the history for this prompt, so you can access
3433 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3435 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3436 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3437 defined through link abbreviations (@pxref{Link abbreviations}). If you
3438 press @key{RET} after inserting only the @var{prefix}, Org will offer
3439 specific completion support for some link types@footnote{This works by
3440 calling a special function @code{org-PREFIX-complete-link}.} For
3441 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3442 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3443 @key{RET}} you can complete contact names.
3445 @cindex file name completion
3446 @cindex completion, of file names
3447 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3448 a file will be inserted and you may use file name completion to select
3449 the name of the file. The path to the file is inserted relative to the
3450 directory of the current Org file, if the linked file is in the current
3451 directory or in a sub-directory of it, or if the path is written relative
3452 to the current directory using @samp{../}. Otherwise an absolute path
3453 is used, if possible with @samp{~/} for your home directory. You can
3454 force an absolute path with two @kbd{C-u} prefixes.
3456 @item C-c C-l @ @r{(with cursor on existing link)}
3457 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3458 link and description parts of the link.
3460 @cindex following links
3461 @orgcmd{C-c C-o,org-open-at-point}
3462 @vindex org-file-apps
3463 @vindex org-link-frame-setup
3464 Open link at point. This will launch a web browser for URLs (using
3465 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3466 the corresponding links, and execute the command in a shell link. When the
3467 cursor is on an internal link, this command runs the corresponding search.
3468 When the cursor is on a TAG list in a headline, it creates the corresponding
3469 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3470 date. Furthermore, it will visit text and remote files in @samp{file:} links
3471 with Emacs and select a suitable application for local non-text files.
3472 Classification of files is based on file extension only. See option
3473 @code{org-file-apps}. If you want to override the default application and
3474 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3475 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3476 If the cursor is on a headline, but not on a link, offer all links in the
3477 headline and entry text. If you want to setup the frame configuration for
3478 following links, customize @code{org-link-frame-setup}.
3481 @vindex org-return-follows-link
3482 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3489 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3490 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3494 @vindex org-display-internal-link-with-indirect-buffer
3495 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3496 internal links to be displayed in another window@footnote{See the
3497 variable @code{org-display-internal-link-with-indirect-buffer}}.
3499 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3500 @cindex inlining images
3501 @cindex images, inlining
3502 @vindex org-startup-with-inline-images
3503 @cindex @code{inlineimages}, STARTUP keyword
3504 @cindex @code{noinlineimages}, STARTUP keyword
3505 Toggle the inline display of linked images. Normally this will only inline
3506 images that have no description part in the link, i.e.@: images that will also
3507 be inlined during export. When called with a prefix argument, also display
3508 images that do have a link description. You can ask for inline images to be
3509 displayed at startup by configuring the variable
3510 @code{org-startup-with-inline-images}@footnote{with corresponding
3511 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3512 @orgcmd{C-c %,org-mark-ring-push}
3514 Push the current position onto the mark ring, to be able to return
3515 easily. Commands following an internal link do this automatically.
3517 @orgcmd{C-c &,org-mark-ring-goto}
3518 @cindex links, returning to
3519 Jump back to a recorded position. A position is recorded by the
3520 commands following internal links, and by @kbd{C-c %}. Using this
3521 command several times in direct succession moves through a ring of
3522 previously recorded positions.
3524 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3525 @cindex links, finding next/previous
3526 Move forward/backward to the next link in the buffer. At the limit of
3527 the buffer, the search fails once, and then wraps around. The key
3528 bindings for this are really too long; you might want to bind this also
3529 to @kbd{C-n} and @kbd{C-p}
3531 (add-hook 'org-load-hook
3533 (define-key org-mode-map "\C-n" 'org-next-link)
3534 (define-key org-mode-map "\C-p" 'org-previous-link)))
3538 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3539 @section Using links outside Org
3541 You can insert and follow links that have Org syntax not only in
3542 Org, but in any Emacs buffer. For this, you should create two
3543 global commands, like this (please select suitable global keys
3547 (global-set-key "\C-c L" 'org-insert-link-global)
3548 (global-set-key "\C-c o" 'org-open-at-point-global)
3551 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3552 @section Link abbreviations
3553 @cindex link abbreviations
3554 @cindex abbreviation, links
3556 Long URLs can be cumbersome to type, and often many similar links are
3557 needed in a document. For this you can use link abbreviations. An
3558 abbreviated link looks like this
3561 [[linkword:tag][description]]
3565 @vindex org-link-abbrev-alist
3566 where the tag is optional.
3567 The @i{linkword} must be a word, starting with a letter, followed by
3568 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3569 according to the information in the variable @code{org-link-abbrev-alist}
3570 that relates the linkwords to replacement text. Here is an example:
3574 (setq org-link-abbrev-alist
3575 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3576 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3577 ("google" . "http://www.google.com/search?q=")
3578 ("gmap" . "http://maps.google.com/maps?q=%s")
3579 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3580 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3584 If the replacement text contains the string @samp{%s}, it will be
3585 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3586 url-encode the tag (see the example above, where we need to encode
3587 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3588 to a custom function, and replace it by the resulting string.
3590 If the replacement text don't contain any specifier, it will simply
3591 be appended to the string in order to create the link.
3593 Instead of a string, you may also specify a function that will be
3594 called with the tag as the only argument to create the link.
3596 With the above setting, you could link to a specific bug with
3597 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3598 @code{[[google:OrgMode]]}, show the map location of the Free Software
3599 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3600 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3601 what the Org author is doing besides Emacs hacking with
3602 @code{[[ads:Dominik,C]]}.
3604 If you need special abbreviations just for a single Org buffer, you
3605 can define them in the file with
3609 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3610 #+LINK: google http://www.google.com/search?q=%s
3614 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3615 complete link abbreviations. You may also define a function
3616 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
3617 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3618 not accept any arguments, and return the full link with prefix.
3620 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3621 @section Search options in file links
3622 @cindex search option in file links
3623 @cindex file links, searching
3625 File links can contain additional information to make Emacs jump to a
3626 particular location in the file when following a link. This can be a
3627 line number or a search option after a double@footnote{For backward
3628 compatibility, line numbers can also follow a single colon.} colon. For
3629 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3630 links}) to a file, it encodes the words in the current line as a search
3631 string that can be used to find this line back later when following the
3632 link with @kbd{C-c C-o}.
3634 Here is the syntax of the different ways to attach a search to a file
3635 link, together with an explanation:
3638 [[file:~/code/main.c::255]]
3639 [[file:~/xx.org::My Target]]
3640 [[file:~/xx.org::*My Target]]
3641 [[file:~/xx.org::#my-custom-id]]
3642 [[file:~/xx.org::/regexp/]]
3649 Search for a link target @samp{<<My Target>>}, or do a text search for
3650 @samp{my target}, similar to the search in internal links, see
3651 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3652 link will become a HTML reference to the corresponding named anchor in
3655 In an Org file, restrict search to headlines.
3657 Link to a heading with a @code{CUSTOM_ID} property
3659 Do a regular expression search for @code{regexp}. This uses the Emacs
3660 command @code{occur} to list all matches in a separate window. If the
3661 target file is in Org mode, @code{org-occur} is used to create a
3662 sparse tree with the matches.
3663 @c If the target file is a directory,
3664 @c @code{grep} will be used to search all files in the directory.
3667 As a degenerate case, a file link with an empty file name can be used
3668 to search the current file. For example, @code{[[file:::find me]]} does
3669 a search for @samp{find me} in the current file, just as
3670 @samp{[[find me]]} would.
3672 @node Custom searches, , Search options, Hyperlinks
3673 @section Custom Searches
3674 @cindex custom search strings
3675 @cindex search strings, custom
3677 The default mechanism for creating search strings and for doing the
3678 actual search related to a file link may not work correctly in all
3679 cases. For example, Bib@TeX{} database files have many entries like
3680 @samp{year="1993"} which would not result in good search strings,
3681 because the only unique identification for a Bib@TeX{} entry is the
3684 @vindex org-create-file-search-functions
3685 @vindex org-execute-file-search-functions
3686 If you come across such a problem, you can write custom functions to set
3687 the right search string for a particular file type, and to do the search
3688 for the string in the file. Using @code{add-hook}, these functions need
3689 to be added to the hook variables
3690 @code{org-create-file-search-functions} and
3691 @code{org-execute-file-search-functions}. See the docstring for these
3692 variables for more information. Org actually uses this mechanism
3693 for Bib@TeX{} database files, and you can use the corresponding code as
3694 an implementation example. See the file @file{org-bibtex.el}.
3696 @node TODO Items, Tags, Hyperlinks, Top
3700 Org mode does not maintain TODO lists as separate documents@footnote{Of
3701 course, you can make a document that contains only long lists of TODO items,
3702 but this is not required.}. Instead, TODO items are an integral part of the
3703 notes file, because TODO items usually come up while taking notes! With Org
3704 mode, simply mark any entry in a tree as being a TODO item. In this way,
3705 information is not duplicated, and the entire context from which the TODO
3706 item emerged is always present.
3708 Of course, this technique for managing TODO items scatters them
3709 throughout your notes file. Org mode compensates for this by providing
3710 methods to give you an overview of all the things that you have to do.
3713 * TODO basics:: Marking and displaying TODO entries
3714 * TODO extensions:: Workflow and assignments
3715 * Progress logging:: Dates and notes for progress
3716 * Priorities:: Some things are more important than others
3717 * Breaking down tasks:: Splitting a task into manageable pieces
3718 * Checkboxes:: Tick-off lists
3721 @node TODO basics, TODO extensions, TODO Items, TODO Items
3722 @section Basic TODO functionality
3724 Any headline becomes a TODO item when it starts with the word
3725 @samp{TODO}, for example:
3728 *** TODO Write letter to Sam Fortune
3732 The most important commands to work with TODO entries are:
3735 @orgcmd{C-c C-t,org-todo}
3736 @cindex cycling, of TODO states
3737 Rotate the TODO state of the current item among
3740 ,-> (unmarked) -> TODO -> DONE --.
3741 '--------------------------------'
3744 The same rotation can also be done ``remotely'' from the timeline and
3745 agenda buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3747 @orgkey{C-u C-c C-t}
3748 Select a specific keyword using completion or (if it has been set up)
3749 the fast selection interface. For the latter, you need to assign keys
3750 to TODO states, see @ref{Per-file keywords}, and @ref{Setting tags}, for
3753 @kindex S-@key{right}
3754 @kindex S-@key{left}
3755 @item S-@key{right} @ @r{/} @ S-@key{left}
3756 @vindex org-treat-S-cursor-todo-selection-as-state-change
3757 Select the following/preceding TODO state, similar to cycling. Useful
3758 mostly if more than two TODO states are possible (@pxref{TODO
3759 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3760 with @code{shift-selection-mode}. See also the variable
3761 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3762 @orgcmd{C-c / t,org-show-todo-key}
3763 @cindex sparse tree, for TODO
3764 @vindex org-todo-keywords
3765 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3766 entire buffer, but shows all TODO items (with not-DONE state) and the
3767 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3768 / T}), search for a specific TODO. You will be prompted for the keyword, and
3769 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3770 entries that match any one of these keywords. With a numeric prefix argument
3771 N, show the tree for the Nth keyword in the variable
3772 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3773 both un-done and done.
3774 @orgcmd{C-c a t,org-todo-list}
3775 Show the global TODO list. Collects the TODO items (with not-DONE states)
3776 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3777 buffer will be in @code{agenda-mode}, which provides commands to examine and
3778 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3779 @xref{Global TODO list}, for more information.
3780 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3781 Insert a new TODO entry below the current one.
3785 @vindex org-todo-state-tags-triggers
3786 Changing a TODO state can also trigger tag changes. See the docstring of the
3787 option @code{org-todo-state-tags-triggers} for details.
3789 @node TODO extensions, Progress logging, TODO basics, TODO Items
3790 @section Extended use of TODO keywords
3791 @cindex extended TODO keywords
3793 @vindex org-todo-keywords
3794 By default, marked TODO entries have one of only two states: TODO and
3795 DONE. Org mode allows you to classify TODO items in more complex ways
3796 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3797 special setup, the TODO keyword system can work differently in different
3800 Note that @i{tags} are another way to classify headlines in general and
3801 TODO items in particular (@pxref{Tags}).
3804 * Workflow states:: From TODO to DONE in steps
3805 * TODO types:: I do this, Fred does the rest
3806 * Multiple sets in one file:: Mixing it all, and still finding your way
3807 * Fast access to TODO states:: Single letter selection of a state
3808 * Per-file keywords:: Different files, different requirements
3809 * Faces for TODO keywords:: Highlighting states
3810 * TODO dependencies:: When one task needs to wait for others
3813 @node Workflow states, TODO types, TODO extensions, TODO extensions
3814 @subsection TODO keywords as workflow states
3815 @cindex TODO workflow
3816 @cindex workflow states as TODO keywords
3818 You can use TODO keywords to indicate different @emph{sequential} states
3819 in the process of working on an item, for example@footnote{Changing
3820 this variable only becomes effective after restarting Org mode in a
3824 (setq org-todo-keywords
3825 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3828 The vertical bar separates the TODO keywords (states that @emph{need
3829 action}) from the DONE states (which need @emph{no further action}). If
3830 you don't provide the separator bar, the last state is used as the DONE
3832 @cindex completion, of TODO keywords
3833 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3834 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED. You may
3835 also use a numeric prefix argument to quickly select a specific state. For
3836 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY.
3837 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3838 define many keywords, you can use in-buffer completion
3839 (@pxref{Completion}) or even a special one-key selection scheme
3840 (@pxref{Fast access to TODO states}) to insert these words into the
3841 buffer. Changing a TODO state can be logged with a timestamp, see
3842 @ref{Tracking TODO state changes}, for more information.
3844 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3845 @subsection TODO keywords as types
3847 @cindex names as TODO keywords
3848 @cindex types as TODO keywords
3850 The second possibility is to use TODO keywords to indicate different
3851 @emph{types} of action items. For example, you might want to indicate
3852 that items are for ``work'' or ``home''. Or, when you work with several
3853 people on a single project, you might want to assign action items
3854 directly to persons, by using their names as TODO keywords. This would
3855 be set up like this:
3858 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3861 In this case, different keywords do not indicate a sequence, but rather
3862 different types. So the normal work flow would be to assign a task to a
3863 person, and later to mark it DONE. Org mode supports this style by adapting
3864 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3865 @kbd{t} command in the timeline and agenda buffers.}. When used several
3866 times in succession, it will still cycle through all names, in order to first
3867 select the right type for a task. But when you return to the item after some
3868 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3869 to DONE. Use prefix arguments or completion to quickly select a specific
3870 name. You can also review the items of a specific TODO type in a sparse tree
3871 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3872 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3873 from all agenda files into a single buffer, you would use the numeric prefix
3874 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3876 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3877 @subsection Multiple keyword sets in one file
3878 @cindex TODO keyword sets
3880 Sometimes you may want to use different sets of TODO keywords in
3881 parallel. For example, you may want to have the basic
3882 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3883 separate state indicating that an item has been canceled (so it is not
3884 DONE, but also does not require action). Your setup would then look
3888 (setq org-todo-keywords
3889 '((sequence "TODO" "|" "DONE")
3890 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3891 (sequence "|" "CANCELED")))
3894 The keywords should all be different, this helps Org mode to keep track
3895 of which subsequence should be used for a given entry. In this setup,
3896 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3897 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3898 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3899 select the correct sequence. Besides the obvious ways like typing a
3900 keyword or using completion, you may also apply the following commands:
3903 @kindex C-S-@key{right}
3904 @kindex C-S-@key{left}
3905 @kindex C-u C-u C-c C-t
3906 @item C-u C-u C-c C-t
3907 @itemx C-S-@key{right}
3908 @itemx C-S-@key{left}
3909 These keys jump from one TODO subset to the next. In the above example,
3910 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3911 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3912 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3913 @code{shift-selection-mode} (@pxref{Conflicts}).
3914 @kindex S-@key{right}
3915 @kindex S-@key{left}
3918 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3919 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3920 from @code{DONE} to @code{REPORT} in the example above. See also
3921 @ref{Conflicts}, for a discussion of the interaction with
3922 @code{shift-selection-mode}.
3925 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3926 @subsection Fast access to TODO states
3928 If you would like to quickly change an entry to an arbitrary TODO state
3929 instead of cycling through the states, you can set up keys for single-letter
3930 access to the states. This is done by adding the selection character after
3931 each keyword, in parentheses@footnote{All characters are allowed except
3932 @code{@@^!}, which have a special meaning here.}. For example:
3935 (setq org-todo-keywords
3936 '((sequence "TODO(t)" "|" "DONE(d)")
3937 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3938 (sequence "|" "CANCELED(c)")))
3941 @vindex org-fast-tag-selection-include-todo
3942 If you then press @kbd{C-c C-t} followed by the selection key, the entry
3943 will be switched to this state. @kbd{SPC} can be used to remove any TODO
3944 keyword from an entry.@footnote{Check also the variable
3945 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3946 state through the tags interface (@pxref{Setting tags}), in case you like to
3947 mingle the two concepts. Note that this means you need to come up with
3948 unique keys across both sets of keywords.}
3950 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3951 @subsection Setting up keywords for individual files
3952 @cindex keyword options
3953 @cindex per-file keywords
3958 It can be very useful to use different aspects of the TODO mechanism in
3959 different files. For file-local settings, you need to add special lines
3960 to the file which set the keywords and interpretation for that file
3961 only. For example, to set one of the two examples discussed above, you
3962 need one of the following lines, starting in column zero anywhere in the
3966 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
3968 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
3969 interpretation, but it means the same as @code{#+TODO}), or
3971 #+TYP_TODO: Fred Sara Lucy Mike | DONE
3974 A setup for using several sets in parallel would be:
3978 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
3982 @cindex completion, of option keywords
3984 @noindent To make sure you are using the correct keyword, type
3985 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
3987 @cindex DONE, final TODO keyword
3988 Remember that the keywords after the vertical bar (or the last keyword
3989 if no bar is there) must always mean that the item is DONE (although you
3990 may use a different word). After changing one of these lines, use
3991 @kbd{C-c C-c} with the cursor still in the line to make the changes
3992 known to Org mode@footnote{Org mode parses these lines only when
3993 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
3994 cursor in a line starting with @samp{#+} is simply restarting Org mode
3995 for the current buffer.}.
3997 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
3998 @subsection Faces for TODO keywords
3999 @cindex faces, for TODO keywords
4001 @vindex org-todo @r{(face)}
4002 @vindex org-done @r{(face)}
4003 @vindex org-todo-keyword-faces
4004 Org mode highlights TODO keywords with special faces: @code{org-todo}
4005 for keywords indicating that an item still has to be acted upon, and
4006 @code{org-done} for keywords indicating that an item is finished. If
4007 you are using more than 2 different states, you might want to use
4008 special faces for some of them. This can be done using the variable
4009 @code{org-todo-keyword-faces}. For example:
4013 (setq org-todo-keyword-faces
4014 '(("TODO" . org-warning) ("STARTED" . "yellow")
4015 ("CANCELED" . (:foreground "blue" :weight bold))))
4019 While using a list with face properties as shown for CANCELED @emph{should}
4020 work, this does not always seem to be the case. If necessary, define a
4021 special face and use that. A string is interpreted as a color. The variable
4022 @code{org-faces-easy-properties} determines if that color is interpreted as a
4023 foreground or a background color.
4025 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
4026 @subsection TODO dependencies
4027 @cindex TODO dependencies
4028 @cindex dependencies, of TODO states
4030 @vindex org-enforce-todo-dependencies
4031 @cindex property, ORDERED
4032 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4033 dependencies. Usually, a parent TODO task should not be marked DONE until
4034 all subtasks (defined as children tasks) are marked as DONE. And sometimes
4035 there is a logical sequence to a number of (sub)tasks, so that one task
4036 cannot be acted upon before all siblings above it are done. If you customize
4037 the variable @code{org-enforce-todo-dependencies}, Org will block entries
4038 from changing state to DONE while they have children that are not DONE.
4039 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4040 will be blocked until all earlier siblings are marked DONE. Here is an
4044 * TODO Blocked until (two) is done
4053 ** TODO b, needs to wait for (a)
4054 ** TODO c, needs to wait for (a) and (b)
4058 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4059 @vindex org-track-ordered-property-with-tag
4060 @cindex property, ORDERED
4061 Toggle the @code{ORDERED} property of the current entry. A property is used
4062 for this behavior because this should be local to the current entry, not
4063 inherited like a tag. However, if you would like to @i{track} the value of
4064 this property with a tag for better visibility, customize the variable
4065 @code{org-track-ordered-property-with-tag}.
4066 @orgkey{C-u C-u C-u C-c C-t}
4067 Change TODO state, circumventing any state blocking.
4070 @vindex org-agenda-dim-blocked-tasks
4071 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
4072 that cannot be closed because of such dependencies will be shown in a dimmed
4073 font or even made invisible in agenda views (@pxref{Agenda Views}).
4075 @cindex checkboxes and TODO dependencies
4076 @vindex org-enforce-todo-dependencies
4077 You can also block changes of TODO states by looking at checkboxes
4078 (@pxref{Checkboxes}). If you set the variable
4079 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4080 checkboxes will be blocked from switching to DONE.
4082 If you need more complex dependency structures, for example dependencies
4083 between entries in different trees or files, check out the contributed
4084 module @file{org-depend.el}.
4087 @node Progress logging, Priorities, TODO extensions, TODO Items
4088 @section Progress logging
4089 @cindex progress logging
4090 @cindex logging, of progress
4092 Org mode can automatically record a timestamp and possibly a note when
4093 you mark a TODO item as DONE, or even each time you change the state of
4094 a TODO item. This system is highly configurable, settings can be on a
4095 per-keyword basis and can be localized to a file or even a subtree. For
4096 information on how to clock working time for a task, see @ref{Clocking
4100 * Closing items:: When was this entry marked DONE?
4101 * Tracking TODO state changes:: When did the status change?
4102 * Tracking your habits:: How consistent have you been?
4105 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4106 @subsection Closing items
4108 The most basic logging is to keep track of @emph{when} a certain TODO
4109 item was finished. This is achieved with@footnote{The corresponding
4110 in-buffer setting is: @code{#+STARTUP: logdone}}
4113 (setq org-log-done 'time)
4117 Then each time you turn an entry from a TODO (not-done) state into any
4118 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
4119 just after the headline. If you turn the entry back into a TODO item
4120 through further state cycling, that line will be removed again. If you
4121 want to record a note along with the timestamp, use@footnote{The
4122 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4125 (setq org-log-done 'note)
4129 You will then be prompted for a note, and that note will be stored below
4130 the entry with a @samp{Closing Note} heading.
4132 In the timeline (@pxref{Timeline}) and in the agenda
4133 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4134 display the TODO items with a @samp{CLOSED} timestamp on each day,
4135 giving you an overview of what has been done.
4137 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4138 @subsection Tracking TODO state changes
4139 @cindex drawer, for state change recording
4141 @vindex org-log-states-order-reversed
4142 @vindex org-log-into-drawer
4143 @cindex property, LOG_INTO_DRAWER
4144 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4145 might want to keep track of when a state change occurred and maybe take a
4146 note about this change. You can either record just a timestamp, or a
4147 time-stamped note for a change. These records will be inserted after the
4148 headline as an itemized list, newest first@footnote{See the variable
4149 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4150 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4151 Customize the variable @code{org-log-into-drawer} to get this behavior---the
4152 recommended drawer for this is called @code{LOGBOOK}@footnote{Note that the
4153 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4154 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4155 overrule the setting of this variable for a subtree by setting a
4156 @code{LOG_INTO_DRAWER} property.
4158 Since it is normally too much to record a note for every state, Org mode
4159 expects configuration on a per-keyword basis for this. This is achieved by
4160 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4161 with timestamp) in parentheses after each keyword. For example, with the
4165 (setq org-todo-keywords
4166 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4169 To record a timestamp without a note for TODO keywords configured with
4170 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4173 @vindex org-log-done
4174 you not only define global TODO keywords and fast access keys, but also
4175 request that a time is recorded when the entry is set to
4176 DONE@footnote{It is possible that Org mode will record two timestamps
4177 when you are using both @code{org-log-done} and state change logging.
4178 However, it will never prompt for two notes---if you have configured
4179 both, the state change recording note will take precedence and cancel
4180 the @samp{Closing Note}.}, and that a note is recorded when switching to
4181 WAIT or CANCELED. The setting for WAIT is even more special: the
4182 @samp{!} after the slash means that in addition to the note taken when
4183 entering the state, a timestamp should be recorded when @i{leaving} the
4184 WAIT state, if and only if the @i{target} state does not configure
4185 logging for entering it. So it has no effect when switching from WAIT
4186 to DONE, because DONE is configured to record a timestamp only. But
4187 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4188 setting now triggers a timestamp even though TODO has no logging
4191 You can use the exact same syntax for setting logging preferences local
4194 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4197 @cindex property, LOGGING
4198 In order to define logging settings that are local to a subtree or a
4199 single item, define a LOGGING property in this entry. Any non-empty
4200 LOGGING property resets all logging settings to nil. You may then turn
4201 on logging for this specific tree using STARTUP keywords like
4202 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4203 settings like @code{TODO(!)}. For example
4206 * TODO Log each state with only a time
4208 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4210 * TODO Only log when switching to WAIT, and when repeating
4212 :LOGGING: WAIT(@@) logrepeat
4214 * TODO No logging at all
4220 @node Tracking your habits, , Tracking TODO state changes, Progress logging
4221 @subsection Tracking your habits
4224 Org has the ability to track the consistency of a special category of TODOs,
4225 called ``habits''. A habit has the following properties:
4229 You have enabled the @code{habits} module by customizing the variable
4232 The habit is a TODO item, with a TODO keyword representing an open state.
4234 The property @code{STYLE} is set to the value @code{habit}.
4236 The TODO has a scheduled date, usually with a @code{.+} style repeat
4237 interval. A @code{++} style may be appropriate for habits with time
4238 constraints, e.g., must be done on weekends, or a @code{+} style for an
4239 unusual habit that can have a backlog, e.g., weekly reports.
4241 The TODO may also have minimum and maximum ranges specified by using the
4242 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4243 three days, but at most every two days.
4245 You must also have state logging for the @code{DONE} state enabled, in order
4246 for historical data to be represented in the consistency graph. If it is not
4247 enabled it is not an error, but the consistency graphs will be largely
4251 To give you an idea of what the above rules look like in action, here's an
4252 actual habit with some history:
4256 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4257 - State "DONE" from "TODO" [2009-10-15 Thu]
4258 - State "DONE" from "TODO" [2009-10-12 Mon]
4259 - State "DONE" from "TODO" [2009-10-10 Sat]
4260 - State "DONE" from "TODO" [2009-10-04 Sun]
4261 - State "DONE" from "TODO" [2009-10-02 Fri]
4262 - State "DONE" from "TODO" [2009-09-29 Tue]
4263 - State "DONE" from "TODO" [2009-09-25 Fri]
4264 - State "DONE" from "TODO" [2009-09-19 Sat]
4265 - State "DONE" from "TODO" [2009-09-16 Wed]
4266 - State "DONE" from "TODO" [2009-09-12 Sat]
4269 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4273 What this habit says is: I want to shave at most every 2 days (given by the
4274 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4275 today is the 15th, then the habit first appears in the agenda on Oct 17,
4276 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4277 after four days have elapsed.
4279 What's really useful about habits is that they are displayed along with a
4280 consistency graph, to show how consistent you've been at getting that task
4281 done in the past. This graph shows every day that the task was done over the
4282 past three weeks, with colors for each day. The colors used are:
4286 If the task wasn't to be done yet on that day.
4288 If the task could have been done on that day.
4290 If the task was going to be overdue the next day.
4292 If the task was overdue on that day.
4295 In addition to coloring each day, the day is also marked with an asterisk if
4296 the task was actually done that day, and an exclamation mark to show where
4297 the current day falls in the graph.
4299 There are several configuration variables that can be used to change the way
4300 habits are displayed in the agenda.
4303 @item org-habit-graph-column
4304 The buffer column at which the consistency graph should be drawn. This will
4305 overwrite any text in that column, so it is a good idea to keep your habits'
4306 titles brief and to the point.
4307 @item org-habit-preceding-days
4308 The amount of history, in days before today, to appear in consistency graphs.
4309 @item org-habit-following-days
4310 The number of days after today that will appear in consistency graphs.
4311 @item org-habit-show-habits-only-for-today
4312 If non-nil, only show habits in today's agenda view. This is set to true by
4316 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4317 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4318 bring them back. They are also subject to tag filtering, if you have habits
4319 which should only be done in certain contexts, for example.
4321 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4325 If you use Org mode extensively, you may end up with enough TODO items that
4326 it starts to make sense to prioritize them. Prioritizing can be done by
4327 placing a @emph{priority cookie} into the headline of a TODO item, like this
4330 *** TODO [#A] Write letter to Sam Fortune
4334 @vindex org-priority-faces
4335 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4336 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4337 treated just like priority @samp{B}. Priorities make a difference only for
4338 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4339 have no inherent meaning to Org mode. The cookies can be highlighted with
4340 special faces by customizing the variable @code{org-priority-faces}.
4342 Priorities can be attached to any outline node; they do not need to be TODO
4348 @findex org-priority
4349 Set the priority of the current headline (@command{org-priority}). The
4350 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4351 When you press @key{SPC} instead, the priority cookie is removed from the
4352 headline. The priorities can also be changed ``remotely'' from the timeline
4353 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4355 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4356 @vindex org-priority-start-cycle-with-default
4357 Increase/decrease priority of current headline@footnote{See also the option
4358 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4359 also used to modify timestamps (@pxref{Creating timestamps}). See also
4360 @ref{Conflicts}, for a discussion of the interaction with
4361 @code{shift-selection-mode}.
4364 @vindex org-highest-priority
4365 @vindex org-lowest-priority
4366 @vindex org-default-priority
4367 You can change the range of allowed priorities by setting the variables
4368 @code{org-highest-priority}, @code{org-lowest-priority}, and
4369 @code{org-default-priority}. For an individual buffer, you may set
4370 these values (highest, lowest, default) like this (please make sure that
4371 the highest priority is earlier in the alphabet than the lowest
4374 @cindex #+PRIORITIES
4379 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4380 @section Breaking tasks down into subtasks
4381 @cindex tasks, breaking down
4382 @cindex statistics, for TODO items
4384 @vindex org-agenda-todo-list-sublevels
4385 It is often advisable to break down large tasks into smaller, manageable
4386 subtasks. You can do this by creating an outline tree below a TODO item,
4387 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4388 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4389 the overview over the fraction of subtasks that are already completed, insert
4390 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4391 be updated each time the TODO status of a child changes, or when pressing
4392 @kbd{C-c C-c} on the cookie. For example:
4395 * Organize Party [33%]
4396 ** TODO Call people [1/2]
4400 ** DONE Talk to neighbor
4403 @cindex property, COOKIE_DATA
4404 If a heading has both checkboxes and TODO children below it, the meaning of
4405 the statistics cookie become ambiguous. Set the property
4406 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4409 @vindex org-hierarchical-todo-statistics
4410 If you would like to have the statistics cookie count any TODO entries in the
4411 subtree (not just direct children), configure the variable
4412 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4413 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4417 * Parent capturing statistics [2/20]
4419 :COOKIE_DATA: todo recursive
4423 If you would like a TODO entry to automatically change to DONE
4424 when all children are done, you can use the following setup:
4427 (defun org-summary-todo (n-done n-not-done)
4428 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4429 (let (org-log-done org-log-states) ; turn off logging
4430 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4432 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4436 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4437 large number of subtasks (@pxref{Checkboxes}).
4440 @node Checkboxes, , Breaking down tasks, TODO Items
4444 @vindex org-list-automatic-rules
4445 Every item in a plain list@footnote{With the exception of description
4446 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4447 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4448 it with the string @samp{[ ]}. This feature is similar to TODO items
4449 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4450 into the global TODO list, so they are often great to split a task into a
4451 number of simple steps. Or you can use them in a shopping list. To toggle a
4452 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4453 @file{org-mouse.el}).
4455 Here is an example of a checkbox list.
4458 * TODO Organize party [2/4]
4459 - [-] call people [1/3]
4464 - [ ] think about what music to play
4465 - [X] talk to the neighbors
4468 Checkboxes work hierarchically, so if a checkbox item has children that
4469 are checkboxes, toggling one of the children checkboxes will make the
4470 parent checkbox reflect if none, some, or all of the children are
4473 @cindex statistics, for checkboxes
4474 @cindex checkbox statistics
4475 @cindex property, COOKIE_DATA
4476 @vindex org-hierarchical-checkbox-statistics
4477 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4478 indicating how many checkboxes present in this entry have been checked off,
4479 and the total number of checkboxes present. This can give you an idea on how
4480 many checkboxes remain, even without opening a folded entry. The cookies can
4481 be placed into a headline or into (the first line of) a plain list item.
4482 Each cookie covers checkboxes of direct children structurally below the
4483 headline/item on which the cookie appears@footnote{Set the variable
4484 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4485 count all checkboxes below the cookie, not just those belonging to direct
4486 children.}. You have to insert the cookie yourself by typing either
4487 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4488 result, as in the examples above. With @samp{[%]} you get information about
4489 the percentage of checkboxes checked (in the above example, this would be
4490 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4491 count either checkboxes below the heading or TODO states of children, and it
4492 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4493 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4495 @cindex blocking, of checkboxes
4496 @cindex checkbox blocking
4497 @cindex property, ORDERED
4498 If the current outline node has an @code{ORDERED} property, checkboxes must
4499 be checked off in sequence, and an error will be thrown if you try to check
4500 off a box while there are unchecked boxes above it.
4502 @noindent The following commands work with checkboxes:
4505 @orgcmd{C-c C-c,org-toggle-checkbox}
4506 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4507 With a single prefix argument, add an empty checkbox or remove the current
4508 one@footnote{`C-u C-c C-c' on the @emph{first} item of a list with no checkbox
4509 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4510 considered to be an intermediate state.
4511 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4512 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4513 double prefix argument, set it to @samp{[-]}, which is considered to be an
4517 If there is an active region, toggle the first checkbox in the region
4518 and set all remaining boxes to the same status as the first. With a prefix
4519 arg, add or remove the checkbox for all items in the region.
4521 If the cursor is in a headline, toggle checkboxes in the region between
4522 this headline and the next (so @emph{not} the entire subtree).
4524 If there is no active region, just toggle the checkbox at point.
4526 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4527 Insert a new item with a checkbox. This works only if the cursor is already
4528 in a plain list item (@pxref{Plain lists}).
4529 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4530 @vindex org-track-ordered-property-with-tag
4531 @cindex property, ORDERED
4532 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4533 be checked off in sequence. A property is used for this behavior because
4534 this should be local to the current entry, not inherited like a tag.
4535 However, if you would like to @i{track} the value of this property with a tag
4536 for better visibility, customize the variable
4537 @code{org-track-ordered-property-with-tag}.
4538 @orgcmd{C-c #,org-update-statistics-cookies}
4539 Update the statistics cookie in the current outline entry. When called with
4540 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4541 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4542 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4543 changing TODO states. If you delete boxes/entries or add/change them by
4544 hand, use this command to get things back into sync.
4547 @node Tags, Properties and Columns, TODO Items, Top
4550 @cindex headline tagging
4551 @cindex matching, tags
4552 @cindex sparse tree, tag based
4554 An excellent way to implement labels and contexts for cross-correlating
4555 information is to assign @i{tags} to headlines. Org mode has extensive
4558 @vindex org-tag-faces
4559 Every headline can contain a list of tags; they occur at the end of the
4560 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4561 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4562 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4563 Tags will by default be in bold face with the same color as the headline.
4564 You may specify special faces for specific tags using the variable
4565 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4566 (@pxref{Faces for TODO keywords}).
4569 * Tag inheritance:: Tags use the tree structure of the outline
4570 * Setting tags:: How to assign tags to a headline
4571 * Tag searches:: Searching for combinations of tags
4574 @node Tag inheritance, Setting tags, Tags, Tags
4575 @section Tag inheritance
4576 @cindex tag inheritance
4577 @cindex inheritance, of tags
4578 @cindex sublevels, inclusion into tags match
4580 @i{Tags} make use of the hierarchical structure of outline trees. If a
4581 heading has a certain tag, all subheadings will inherit the tag as
4582 well. For example, in the list
4585 * Meeting with the French group :work:
4586 ** Summary by Frank :boss:notes:
4587 *** TODO Prepare slides for him :action:
4591 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4592 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4593 explicitly marked with those tags. You can also set tags that all entries in
4594 a file should inherit just as if these tags were defined in a hypothetical
4595 level zero that surrounds the entire file. Use a line like this@footnote{As
4596 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4597 changes in the line.}:
4601 #+FILETAGS: :Peter:Boss:Secret:
4605 @vindex org-use-tag-inheritance
4606 @vindex org-tags-exclude-from-inheritance
4607 To limit tag inheritance to specific tags, or to turn it off entirely, use
4608 the variables @code{org-use-tag-inheritance} and
4609 @code{org-tags-exclude-from-inheritance}.
4611 @vindex org-tags-match-list-sublevels
4612 When a headline matches during a tags search while tag inheritance is turned
4613 on, all the sublevels in the same tree will (for a simple match form) match
4614 as well@footnote{This is only true if the search does not involve more
4615 complex tests including properties (@pxref{Property searches}).}. The list
4616 of matches may then become very long. If you only want to see the first tags
4617 match in a subtree, configure the variable
4618 @code{org-tags-match-list-sublevels} (not recommended).
4620 @node Setting tags, Tag searches, Tag inheritance, Tags
4621 @section Setting tags
4622 @cindex setting tags
4623 @cindex tags, setting
4626 Tags can simply be typed into the buffer at the end of a headline.
4627 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4628 also a special command for inserting tags:
4631 @orgcmd{C-c C-q,org-set-tags-command}
4632 @cindex completion, of tags
4633 @vindex org-tags-column
4634 Enter new tags for the current headline. Org mode will either offer
4635 completion or a special single-key interface for setting tags, see
4636 below. After pressing @key{RET}, the tags will be inserted and aligned
4637 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4638 tags in the current buffer will be aligned to that column, just to make
4639 things look nice. TAGS are automatically realigned after promotion,
4640 demotion, and TODO state changes (@pxref{TODO basics}).
4641 @orgcmd{C-c C-c,org-set-tags-command}
4642 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4645 @vindex org-tag-alist
4646 Org supports tag insertion based on a @emph{list of tags}. By
4647 default this list is constructed dynamically, containing all tags
4648 currently used in the buffer. You may also globally specify a hard list
4649 of tags with the variable @code{org-tag-alist}. Finally you can set
4650 the default tags for a given file with lines like
4654 #+TAGS: @@work @@home @@tennisclub
4655 #+TAGS: laptop car pc sailboat
4658 If you have globally defined your preferred set of tags using the
4659 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4660 in a specific file, add an empty TAGS option line to that file:
4666 @vindex org-tag-persistent-alist
4667 If you have a preferred set of tags that you would like to use in every file,
4668 in addition to those defined on a per-file basis by TAGS option lines, then
4669 you may specify a list of tags with the variable
4670 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4671 by adding a STARTUP option line to that file:
4677 By default Org mode uses the standard minibuffer completion facilities for
4678 entering tags. However, it also implements another, quicker, tag selection
4679 method called @emph{fast tag selection}. This allows you to select and
4680 deselect tags with just a single key press. For this to work well you should
4681 assign unique letters to most of your commonly used tags. You can do this
4682 globally by configuring the variable @code{org-tag-alist} in your
4683 @file{.emacs} file. For example, you may find the need to tag many items in
4684 different files with @samp{:@@home:}. In this case you can set something
4688 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4691 @noindent If the tag is only relevant to the file you are working on, then you
4692 can instead set the TAGS option line as:
4695 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4698 @noindent The tags interface will show the available tags in a splash
4699 window. If you want to start a new line after a specific tag, insert
4700 @samp{\n} into the tag list
4703 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4706 @noindent or write them in two lines:
4709 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4710 #+TAGS: laptop(l) pc(p)
4714 You can also group together tags that are mutually exclusive by using
4718 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4721 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4722 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4724 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4725 these lines to activate any changes.
4728 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4729 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4730 of the braces. Similarly, you can use @code{:newline} to indicate a line
4731 break. The previous example would be set globally by the following
4735 (setq org-tag-alist '((:startgroup . nil)
4736 ("@@work" . ?w) ("@@home" . ?h)
4737 ("@@tennisclub" . ?t)
4739 ("laptop" . ?l) ("pc" . ?p)))
4742 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4743 automatically present you with a special interface, listing inherited tags,
4744 the tags of the current headline, and a list of all valid tags with
4745 corresponding keys@footnote{Keys will automatically be assigned to tags which
4746 have no configured keys.}. In this interface, you can use the following
4751 Pressing keys assigned to tags will add or remove them from the list of
4752 tags in the current line. Selecting a tag in a group of mutually
4753 exclusive tags will turn off any other tags from that group.
4756 Enter a tag in the minibuffer, even if the tag is not in the predefined
4757 list. You will be able to complete on all tags present in the buffer.
4758 You can also add several tags: just separate them with a comma.
4762 Clear all tags for this line.
4765 Accept the modified set.
4767 Abort without installing changes.
4769 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4771 Turn off groups of mutually exclusive tags. Use this to (as an
4772 exception) assign several tags from such a group.
4774 Toggle auto-exit after the next change (see below).
4775 If you are using expert mode, the first @kbd{C-c} will display the
4780 This method lets you assign tags to a headline with very few keys. With
4781 the above setup, you could clear the current tags and set @samp{@@home},
4782 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4783 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4784 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4785 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4786 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4787 @key{RET} @key{RET}}.
4789 @vindex org-fast-tag-selection-single-key
4790 If you find that most of the time you need only a single key press to
4791 modify your list of tags, set the variable
4792 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4793 press @key{RET} to exit fast tag selection---it will immediately exit
4794 after the first change. If you then occasionally need more keys, press
4795 @kbd{C-c} to turn off auto-exit for the current tag selection process
4796 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4797 C-c}). If you set the variable to the value @code{expert}, the special
4798 window is not even shown for single-key tag selection, it comes up only
4799 when you press an extra @kbd{C-c}.
4801 @node Tag searches, , Setting tags, Tags
4802 @section Tag searches
4803 @cindex tag searches
4804 @cindex searching for tags
4806 Once a system of tags has been set up, it can be used to collect related
4807 information into special lists.
4810 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
4811 Create a sparse tree with all headlines matching a tags search. With a
4812 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4813 @orgcmd{C-c a m,org-tags-view}
4814 Create a global list of tag matches from all agenda files.
4815 @xref{Matching tags and properties}.
4816 @orgcmd{C-c a M,org-tags-view}
4817 @vindex org-tags-match-list-sublevels
4818 Create a global list of tag matches from all agenda files, but check
4819 only TODO items and force checking subitems (see variable
4820 @code{org-tags-match-list-sublevels}).
4823 These commands all prompt for a match string which allows basic Boolean logic
4824 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4825 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4826 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4827 string is rich and allows also matching against TODO keywords, entry levels
4828 and properties. For a complete description with many examples, see
4829 @ref{Matching tags and properties}.
4832 @node Properties and Columns, Dates and Times, Tags, Top
4833 @chapter Properties and columns
4836 A property is a key-value pair associated with an entry. Properties can be
4837 set so they are associated with a single entry, with every entry in a tree,
4838 or with every entry in an Org mode file.
4840 There are two main applications for properties in Org mode. First,
4841 properties are like tags, but with a value. Imagine maintaining a file where
4842 you document bugs and plan releases for a piece of software. Instead of
4843 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
4844 property, say @code{:Release:}, that in different subtrees has different
4845 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
4846 implement (very basic) database capabilities in an Org buffer. Imagine
4847 keeping track of your music CDs, where properties could be things such as the
4848 album, artist, date of release, number of tracks, and so on.
4850 Properties can be conveniently edited and viewed in column view
4851 (@pxref{Column view}).
4854 * Property syntax:: How properties are spelled out
4855 * Special properties:: Access to other Org mode features
4856 * Property searches:: Matching property values
4857 * Property inheritance:: Passing values down the tree
4858 * Column view:: Tabular viewing and editing
4859 * Property API:: Properties for Lisp programmers
4862 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4863 @section Property syntax
4864 @cindex property syntax
4865 @cindex drawer, for properties
4867 Properties are key-value pairs. When they are associated with a single entry
4868 or with a tree they need to be inserted into a special
4869 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4870 is specified on a single line, with the key (surrounded by colons)
4871 first, and the value after it. Here is an example:
4876 *** Goldberg Variations
4878 :Title: Goldberg Variations
4879 :Composer: J.S. Bach
4881 :Publisher: Deutsche Grammophon
4886 Depending on the value of @code{org-use-property-inheritance}, a property set
4887 this way will either be associated with a single entry, or the sub-tree
4888 defined by the entry, see @ref{Property inheritance}.
4890 You may define the allowed values for a particular property @samp{:Xyz:}
4891 by setting a property @samp{:Xyz_ALL:}. This special property is
4892 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4893 the entire tree. When allowed values are defined, setting the
4894 corresponding property becomes easier and is less prone to typing
4895 errors. For the example with the CD collection, we can predefine
4896 publishers and the number of disks in a box like this:
4901 :NDisks_ALL: 1 2 3 4
4902 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4906 If you want to set properties that can be inherited by any entry in a
4907 file, use a line like
4908 @cindex property, _ALL
4911 #+PROPERTY: NDisks_ALL 1 2 3 4
4914 If you want to add to the value of an existing property, append a @code{+} to
4915 the property name. The following results in the property @code{var} having
4916 the value ``foo=1 bar=2''.
4919 #+PROPERTY: var foo=1
4920 #+PROPERTY: var+ bar=2
4923 It is also possible to add to the values of inherited properties. The
4924 following results in the @code{genres} property having the value ``Classic
4925 Baroque'' under the @code{Goldberg Variations} subtree.
4933 *** Goldberg Variations
4935 :Title: Goldberg Variations
4936 :Composer: J.S. Bach
4938 :Publisher: Deutsche Grammophon
4943 Note that a property can only have one entry per Drawer.
4945 @vindex org-global-properties
4946 Property values set with the global variable
4947 @code{org-global-properties} can be inherited by all entries in all
4951 The following commands help to work with properties:
4954 @orgcmd{M-@key{TAB},pcomplete}
4955 After an initial colon in a line, complete property keys. All keys used
4956 in the current file will be offered as possible completions.
4957 @orgcmd{C-c C-x p,org-set-property}
4958 Set a property. This prompts for a property name and a value. If
4959 necessary, the property drawer is created as well.
4960 @item C-u M-x org-insert-drawer
4961 @cindex org-insert-drawer
4962 Insert a property drawer into the current entry. The drawer will be
4963 inserted early in the entry, but after the lines with planning
4964 information like deadlines.
4965 @orgcmd{C-c C-c,org-property-action}
4966 With the cursor in a property drawer, this executes property commands.
4967 @orgcmd{C-c C-c s,org-set-property}
4968 Set a property in the current entry. Both the property and the value
4969 can be inserted using completion.
4970 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
4971 Switch property at point to the next/previous allowed value.
4972 @orgcmd{C-c C-c d,org-delete-property}
4973 Remove a property from the current entry.
4974 @orgcmd{C-c C-c D,org-delete-property-globally}
4975 Globally remove a property, from all entries in the current file.
4976 @orgcmd{C-c C-c c,org-compute-property-at-point}
4977 Compute the property at point, using the operator and scope from the
4978 nearest column format definition.
4981 @node Special properties, Property searches, Property syntax, Properties and Columns
4982 @section Special properties
4983 @cindex properties, special
4985 Special properties provide an alternative access method to Org mode features,
4986 like the TODO state or the priority of an entry, discussed in the previous
4987 chapters. This interface exists so that you can include these states in a
4988 column view (@pxref{Column view}), or to use them in queries. The following
4989 property names are special and (except for @code{:CATEGORY:}) should not be
4990 used as keys in the properties drawer:
4992 @cindex property, special, ID
4993 @cindex property, special, TODO
4994 @cindex property, special, TAGS
4995 @cindex property, special, ALLTAGS
4996 @cindex property, special, CATEGORY
4997 @cindex property, special, PRIORITY
4998 @cindex property, special, DEADLINE
4999 @cindex property, special, SCHEDULED
5000 @cindex property, special, CLOSED
5001 @cindex property, special, TIMESTAMP
5002 @cindex property, special, TIMESTAMP_IA
5003 @cindex property, special, CLOCKSUM
5004 @cindex property, special, CLOCKSUM_T
5005 @cindex property, special, BLOCKED
5006 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5007 @cindex property, special, ITEM
5008 @cindex property, special, FILE
5010 ID @r{A globally unique ID used for synchronization during}
5011 @r{iCalendar or MobileOrg export.}
5012 TODO @r{The TODO keyword of the entry.}
5013 TAGS @r{The tags defined directly in the headline.}
5014 ALLTAGS @r{All tags, including inherited ones.}
5015 CATEGORY @r{The category of an entry.}
5016 PRIORITY @r{The priority of the entry, a string with a single letter.}
5017 DEADLINE @r{The deadline time string, without the angular brackets.}
5018 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5019 CLOSED @r{When was this entry closed?}
5020 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5021 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5022 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5023 @r{must be run first to compute the values in the current buffer.}
5024 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5025 @r{@code{org-clock-sum-today} must be run first to compute the}
5026 @r{values in the current buffer.}
5027 BLOCKED @r{"t" if task is currently blocked by children or siblings}
5028 ITEM @r{The headline of the entry.}
5029 FILE @r{The filename the entry is located in.}
5032 @node Property searches, Property inheritance, Special properties, Properties and Columns
5033 @section Property searches
5034 @cindex properties, searching
5035 @cindex searching, of properties
5037 To create sparse trees and special lists with selection based on properties,
5038 the same commands are used as for tag searches (@pxref{Tag searches}).
5040 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
5041 Create a sparse tree with all matching entries. With a
5042 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5043 @orgcmd{C-c a m,org-tags-view}
5044 Create a global list of tag/property matches from all agenda files.
5045 @xref{Matching tags and properties}.
5046 @orgcmd{C-c a M,org-tags-view}
5047 @vindex org-tags-match-list-sublevels
5048 Create a global list of tag matches from all agenda files, but check
5049 only TODO items and force checking of subitems (see variable
5050 @code{org-tags-match-list-sublevels}).
5053 The syntax for the search string is described in @ref{Matching tags and
5056 There is also a special command for creating sparse trees based on a
5061 Create a sparse tree based on the value of a property. This first
5062 prompts for the name of a property, and then for a value. A sparse tree
5063 is created with all entries that define this property with the given
5064 value. If you enclose the value in curly braces, it is interpreted as
5065 a regular expression and matched against the property values.
5068 @node Property inheritance, Column view, Property searches, Properties and Columns
5069 @section Property Inheritance
5070 @cindex properties, inheritance
5071 @cindex inheritance, of properties
5073 @vindex org-use-property-inheritance
5074 The outline structure of Org mode documents lends itself to an
5075 inheritance model of properties: if the parent in a tree has a certain
5076 property, the children can inherit this property. Org mode does not
5077 turn this on by default, because it can slow down property searches
5078 significantly and is often not needed. However, if you find inheritance
5079 useful, you can turn it on by setting the variable
5080 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5081 all properties inherited from the parent, to a list of properties
5082 that should be inherited, or to a regular expression that matches
5083 inherited properties. If a property has the value @samp{nil}, this is
5084 interpreted as an explicit undefine of the property, so that inheritance
5085 search will stop at this value and return @code{nil}.
5087 Org mode has a few properties for which inheritance is hard-coded, at
5088 least for the special applications for which they are used:
5090 @cindex property, COLUMNS
5093 The @code{:COLUMNS:} property defines the format of column view
5094 (@pxref{Column view}). It is inherited in the sense that the level
5095 where a @code{:COLUMNS:} property is defined is used as the starting
5096 point for a column view table, independently of the location in the
5097 subtree from where columns view is turned on.
5099 @cindex property, CATEGORY
5100 For agenda view, a category set through a @code{:CATEGORY:} property
5101 applies to the entire subtree.
5103 @cindex property, ARCHIVE
5104 For archiving, the @code{:ARCHIVE:} property may define the archive
5105 location for the entire subtree (@pxref{Moving subtrees}).
5107 @cindex property, LOGGING
5108 The LOGGING property may define logging settings for an entry or a
5109 subtree (@pxref{Tracking TODO state changes}).
5112 @node Column view, Property API, Property inheritance, Properties and Columns
5113 @section Column view
5115 A great way to view and edit properties in an outline tree is
5116 @emph{column view}. In column view, each outline node is turned into a
5117 table row. Columns in this table provide access to properties of the
5118 entries. Org mode implements columns by overlaying a tabular structure
5119 over the headline of each item. While the headlines have been turned
5120 into a table row, you can still change the visibility of the outline
5121 tree. For example, you get a compact table by switching to CONTENTS
5122 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5123 is active), but you can still open, read, and edit the entry below each
5124 headline. Or, you can switch to column view after executing a sparse
5125 tree command and in this way get a table only for the selected items.
5126 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5127 queries have collected selected items, possibly from a number of files.
5130 * Defining columns:: The COLUMNS format property
5131 * Using column view:: How to create and use column view
5132 * Capturing column view:: A dynamic block for column view
5135 @node Defining columns, Using column view, Column view, Column view
5136 @subsection Defining columns
5137 @cindex column view, for properties
5138 @cindex properties, column view
5140 Setting up a column view first requires defining the columns. This is
5141 done by defining a column format line.
5144 * Scope of column definitions:: Where defined, where valid?
5145 * Column attributes:: Appearance and content of a column
5148 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5149 @subsubsection Scope of column definitions
5151 To define a column format for an entire file, use a line like
5155 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5158 To specify a format that only applies to a specific tree, add a
5159 @code{:COLUMNS:} property to the top node of that tree, for example:
5162 ** Top node for columns view
5164 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5168 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5169 for the entry itself, and for the entire subtree below it. Since the
5170 column definition is part of the hierarchical structure of the document,
5171 you can define columns on level 1 that are general enough for all
5172 sublevels, and more specific columns further down, when you edit a
5173 deeper part of the tree.
5175 @node Column attributes, , Scope of column definitions, Defining columns
5176 @subsubsection Column attributes
5177 A column definition sets the attributes of a column. The general
5178 definition looks like this:
5181 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5185 Except for the percent sign and the property name, all items are
5186 optional. The individual parts have the following meaning:
5189 @var{width} @r{An integer specifying the width of the column in characters.}
5190 @r{If omitted, the width will be determined automatically.}
5191 @var{property} @r{The property that should be edited in this column.}
5192 @r{Special properties representing meta data are allowed here}
5193 @r{as well (@pxref{Special properties})}
5194 @var{title} @r{The header text for the column. If omitted, the property}
5196 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5197 @r{parent nodes are computed from the children.}
5198 @r{Supported summary types are:}
5199 @{+@} @r{Sum numbers in this column.}
5200 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5201 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5202 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5203 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5204 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5205 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5206 @{min@} @r{Smallest number in column.}
5207 @{max@} @r{Largest number.}
5208 @{mean@} @r{Arithmetic mean of numbers.}
5209 @{:min@} @r{Smallest time value in column.}
5210 @{:max@} @r{Largest time value.}
5211 @{:mean@} @r{Arithmetic mean of time values.}
5212 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5213 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5214 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5215 @{est+@} @r{Add low-high estimates.}
5219 Be aware that you can only have one summary type for any property you
5220 include. Subsequent columns referencing the same property will all display the
5221 same summary information.
5223 The @code{est+} summary type requires further explanation. It is used for
5224 combining estimates, expressed as low-high ranges. For example, instead
5225 of estimating a particular task will take 5 days, you might estimate it as
5226 5-6 days if you're fairly confident you know how much work is required, or
5227 1-10 days if you don't really know what needs to be done. Both ranges
5228 average at 5.5 days, but the first represents a more predictable delivery.
5230 When combining a set of such estimates, simply adding the lows and highs
5231 produces an unrealistically wide result. Instead, @code{est+} adds the
5232 statistical mean and variance of the sub-tasks, generating a final estimate
5233 from the sum. For example, suppose you had ten tasks, each of which was
5234 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5235 of 5 to 20 days, representing what to expect if everything goes either
5236 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5237 full job more realistically, at 10-15 days.
5239 Here is an example for a complete columns definition, along with allowed
5243 :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.}
5244 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5245 :Owner_ALL: Tammy Mark Karl Lisa Don
5246 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5247 :Approved_ALL: "[ ]" "[X]"
5251 The first column, @samp{%25ITEM}, means the first 25 characters of the
5252 item itself, i.e.@: of the headline. You probably always should start the
5253 column definition with the @samp{ITEM} specifier. The other specifiers
5254 create columns @samp{Owner} with a list of names as allowed values, for
5255 @samp{Status} with four different possible values, and for a checkbox
5256 field @samp{Approved}. When no width is given after the @samp{%}
5257 character, the column will be exactly as wide as it needs to be in order
5258 to fully display all values. The @samp{Approved} column does have a
5259 modified title (@samp{Approved?}, with a question mark). Summaries will
5260 be created for the @samp{Time_Estimate} column by adding time duration
5261 expressions like HH:MM, and for the @samp{Approved} column, by providing
5262 an @samp{[X]} status if all children have been checked. The
5263 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5264 sums of CLOCK intervals in the subtree, either for all clocks or just for
5267 @node Using column view, Capturing column view, Defining columns, Column view
5268 @subsection Using column view
5271 @tsubheading{Turning column view on and off}
5272 @orgcmd{C-c C-x C-c,org-columns}
5273 @vindex org-columns-default-format
5274 Turn on column view. If the cursor is before the first headline in the file,
5275 column view is turned on for the entire file, using the @code{#+COLUMNS}
5276 definition. If the cursor is somewhere inside the outline, this command
5277 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5278 defines a format. When one is found, the column view table is established
5279 for the tree starting at the entry that contains the @code{:COLUMNS:}
5280 property. If no such property is found, the format is taken from the
5281 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5282 and column view is established for the current entry and its subtree.
5283 @orgcmd{r,org-columns-redo}
5284 Recreate the column view, to include recent changes made in the buffer.
5285 @orgcmd{g,org-columns-redo}
5287 @orgcmd{q,org-columns-quit}
5289 @tsubheading{Editing values}
5290 @item @key{left} @key{right} @key{up} @key{down}
5291 Move through the column view from field to field.
5292 @kindex S-@key{left}
5293 @kindex S-@key{right}
5294 @item S-@key{left}/@key{right}
5295 Switch to the next/previous allowed value of the field. For this, you
5296 have to have specified allowed values for a property.
5298 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5299 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5300 Same as @kbd{S-@key{left}/@key{right}}
5301 @orgcmd{e,org-columns-edit-value}
5302 Edit the property at point. For the special properties, this will
5303 invoke the same interface that you normally use to change that
5304 property. For example, when editing a TAGS property, the tag completion
5305 or fast selection interface will pop up.
5306 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5307 When there is a checkbox at point, toggle it.
5308 @orgcmd{v,org-columns-show-value}
5309 View the full value of this property. This is useful if the width of
5310 the column is smaller than that of the value.
5311 @orgcmd{a,org-columns-edit-allowed}
5312 Edit the list of allowed values for this property. If the list is found
5313 in the hierarchy, the modified values is stored there. If no list is
5314 found, the new value is stored in the first entry that is part of the
5315 current column view.
5316 @tsubheading{Modifying the table structure}
5317 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5318 Make the column narrower/wider by one character.
5319 @orgcmd{S-M-@key{right},org-columns-new}
5320 Insert a new column, to the left of the current column.
5321 @orgcmd{S-M-@key{left},org-columns-delete}
5322 Delete the current column.
5325 @node Capturing column view, , Using column view, Column view
5326 @subsection Capturing column view
5328 Since column view is just an overlay over a buffer, it cannot be
5329 exported or printed directly. If you want to capture a column view, use
5330 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5331 of this block looks like this:
5333 @cindex #+BEGIN, columnview
5336 #+BEGIN: columnview :hlines 1 :id "label"
5341 @noindent This dynamic block has the following parameters:
5345 This is the most important parameter. Column view is a feature that is
5346 often localized to a certain (sub)tree, and the capture block might be
5347 at a different location in the file. To identify the tree whose view to
5348 capture, you can use 4 values:
5349 @cindex property, ID
5351 local @r{use the tree in which the capture block is located}
5352 global @r{make a global view, including all headings in the file}
5353 "file:@var{path-to-file}"
5354 @r{run column view at the top of this file}
5355 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5356 @r{property with the value @i{label}. You can use}
5357 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5358 @r{the current entry and copy it to the kill-ring.}
5361 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5362 an hline before each headline with level @code{<= @var{N}}.
5364 When set to @code{t}, force column groups to get vertical lines.
5366 When set to a number, don't capture entries below this level.
5367 @item :skip-empty-rows
5368 When set to @code{t}, skip rows where the only non-empty specifier of the
5369 column view is @code{ITEM}.
5374 The following commands insert or update the dynamic block:
5377 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5378 Insert a dynamic block capturing a column view. You will be prompted
5379 for the scope or ID of the view.
5380 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5381 Update dynamic block at point. The cursor needs to be in the
5382 @code{#+BEGIN} line of the dynamic block.
5383 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5384 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5385 you have several clock table blocks, column-capturing blocks or other dynamic
5389 You can add formulas to the column view table and you may add plotting
5390 instructions in front of the table---these will survive an update of the
5391 block. If there is a @code{#+TBLFM:} after the table, the table will
5392 actually be recalculated automatically after an update.
5394 An alternative way to capture and process property values into a table is
5395 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5396 package@footnote{Contributed packages are not part of Emacs, but are
5397 distributed with the main distribution of Org (visit
5398 @uref{http://orgmode.org}).}. It provides a general API to collect
5399 properties from entries in a certain scope, and arbitrary Lisp expressions to
5400 process these values before inserting them into a table or a dynamic block.
5402 @node Property API, , Column view, Properties and Columns
5403 @section The Property API
5404 @cindex properties, API
5405 @cindex API, for properties
5407 There is a full API for accessing and changing properties. This API can
5408 be used by Emacs Lisp programs to work with properties and to implement
5409 features based on them. For more information see @ref{Using the
5412 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5413 @chapter Dates and times
5419 To assist project planning, TODO items can be labeled with a date and/or
5420 a time. The specially formatted string carrying the date and time
5421 information is called a @emph{timestamp} in Org mode. This may be a
5422 little confusing because timestamp is often used as indicating when
5423 something was created or last changed. However, in Org mode this term
5424 is used in a much wider sense.
5427 * Timestamps:: Assigning a time to a tree entry
5428 * Creating timestamps:: Commands which insert timestamps
5429 * Deadlines and scheduling:: Planning your work
5430 * Clocking work time:: Tracking how long you spend on a task
5431 * Effort estimates:: Planning work effort in advance
5432 * Relative timer:: Notes with a running timer
5433 * Countdown timer:: Starting a countdown timer for a task
5437 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5438 @section Timestamps, deadlines, and scheduling
5440 @cindex ranges, time
5445 A timestamp is a specification of a date (possibly with a time or a range of
5446 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5447 simplest form, the day name is optional when you type the date yourself.
5448 However, any dates inserted or modified by Org will add that day name, for
5449 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5450 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5451 date/time format. To use an alternative format, see @ref{Custom time
5452 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5453 tree entry. Its presence causes entries to be shown on specific dates in the
5454 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5457 @item Plain timestamp; Event; Appointment
5460 A simple timestamp just assigns a date/time to an item. This is just
5461 like writing down an appointment or event in a paper agenda. In the
5462 timeline and agenda displays, the headline of an entry associated with a
5463 plain timestamp will be shown exactly on that date.
5466 * Meet Peter at the movies
5467 <2006-11-01 Wed 19:15>
5468 * Discussion on climate change
5469 <2006-11-02 Thu 20:00-22:00>
5472 @item Timestamp with repeater interval
5473 @cindex timestamp, with repeater interval
5474 A timestamp may contain a @emph{repeater interval}, indicating that it
5475 applies not only on the given date, but again and again after a certain
5476 interval of N days (d), weeks (w), months (m), or years (y). The
5477 following will show up in the agenda every Wednesday:
5480 * Pick up Sam at school
5481 <2007-05-16 Wed 12:30 +1w>
5484 @item Diary-style sexp entries
5485 For more complex date specifications, Org mode supports using the special
5486 sexp diary entries implemented in the Emacs calendar/diary
5487 package@footnote{When working with the standard diary sexp functions, you
5488 need to be very careful with the order of the arguments. That order depend
5489 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5490 versions, @code{european-calendar-style}). For example, to specify a date
5491 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5492 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5493 the settings. This has been the source of much confusion. Org mode users
5494 can resort to special versions of these functions like @code{org-date} or
5495 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5496 functions, but with stable ISO order of arguments (year, month, day) wherever
5497 applicable, independent of the value of @code{calendar-date-style}.}. For
5498 example with optional time
5501 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5502 <%%(org-float t 4 2)>
5505 @item Time/Date range
5508 Two timestamps connected by @samp{--} denote a range. The headline
5509 will be shown on the first and last day of the range, and on any dates
5510 that are displayed and fall in the range. Here is an example:
5513 ** Meeting in Amsterdam
5514 <2004-08-23 Mon>--<2004-08-26 Thu>
5517 @item Inactive timestamp
5518 @cindex timestamp, inactive
5519 @cindex inactive timestamp
5520 Just like a plain timestamp, but with square brackets instead of
5521 angular ones. These timestamps are inactive in the sense that they do
5522 @emph{not} trigger an entry to show up in the agenda.
5525 * Gillian comes late for the fifth time
5531 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5532 @section Creating timestamps
5533 @cindex creating timestamps
5534 @cindex timestamps, creating
5536 For Org mode to recognize timestamps, they need to be in the specific
5537 format. All commands listed below produce timestamps in the correct
5541 @orgcmd{C-c .,org-time-stamp}
5542 Prompt for a date and insert a corresponding timestamp. When the cursor is
5543 at an existing timestamp in the buffer, the command is used to modify this
5544 timestamp instead of inserting a new one. When this command is used twice in
5545 succession, a time range is inserted.
5547 @orgcmd{C-c !,org-time-stamp-inactive}
5548 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5555 @vindex org-time-stamp-rounding-minutes
5556 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5557 contains date and time. The default time can be rounded to multiples of 5
5558 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5561 Normalize timestamp, insert/fix day name if missing or wrong.
5563 @orgcmd{C-c <,org-date-from-calendar}
5564 Insert a timestamp corresponding to the cursor date in the Calendar.
5566 @orgcmd{C-c >,org-goto-calendar}
5567 Access the Emacs calendar for the current date. If there is a
5568 timestamp in the current line, go to the corresponding date
5571 @orgcmd{C-c C-o,org-open-at-point}
5572 Access the agenda for the date given by the timestamp or -range at
5573 point (@pxref{Weekly/daily agenda}).
5575 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5576 Change date at cursor by one day. These key bindings conflict with
5577 shift-selection and related modes (@pxref{Conflicts}).
5579 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5580 Change the item under the cursor in a timestamp. The cursor can be on a
5581 year, month, day, hour or minute. When the timestamp contains a time range
5582 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5583 shifting the time block with constant length. To change the length, modify
5584 the second time. Note that if the cursor is in a headline and not at a
5585 timestamp, these same keys modify the priority of an item.
5586 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5587 related modes (@pxref{Conflicts}).
5589 @orgcmd{C-c C-y,org-evaluate-time-range}
5590 @cindex evaluate time range
5591 Evaluate a time range by computing the difference between start and end.
5592 With a prefix argument, insert result after the time range (in a table: into
5593 the following column).
5598 * The date/time prompt:: How Org mode helps you entering date and time
5599 * Custom time format:: Making dates look different
5602 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5603 @subsection The date/time prompt
5604 @cindex date, reading in minibuffer
5605 @cindex time, reading in minibuffer
5607 @vindex org-read-date-prefer-future
5608 When Org mode prompts for a date/time, the default is shown in default
5609 date/time format, and the prompt therefore seems to ask for a specific
5610 format. But it will in fact accept any string containing some date and/or
5611 time information, and it is really smart about interpreting your input. You
5612 can, for example, use @kbd{C-y} to paste a (possibly multi-line) string
5613 copied from an email message. Org mode will find whatever information is in
5614 there and derive anything you have not specified from the @emph{default date
5615 and time}. The default is usually the current date and time, but when
5616 modifying an existing timestamp, or when entering the second stamp of a
5617 range, it is taken from the stamp in the buffer. When filling in
5618 information, Org mode assumes that most of the time you will want to enter a
5619 date in the future: if you omit the month/year and the given day/month is
5620 @i{before} today, it will assume that you mean a future date@footnote{See the
5621 variable @code{org-read-date-prefer-future}. You may set that variable to
5622 the symbol @code{time} to even make a time before now shift the date to
5623 tomorrow.}. If the date has been automatically shifted into the future, the
5624 time prompt will show this with @samp{(=>F).}
5626 For example, let's assume that today is @b{June 13, 2006}. Here is how
5627 various inputs will be interpreted, the items filled in by Org mode are
5631 3-2-5 @result{} 2003-02-05
5632 2/5/3 @result{} 2003-02-05
5633 14 @result{} @b{2006}-@b{06}-14
5634 12 @result{} @b{2006}-@b{07}-12
5635 2/5 @result{} @b{2007}-02-05
5636 Fri @result{} nearest Friday (default date or later)
5637 sep 15 @result{} @b{2006}-09-15
5638 feb 15 @result{} @b{2007}-02-15
5639 sep 12 9 @result{} 2009-09-12
5640 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5641 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5642 w4 @result{} ISO week for of the current year @b{2006}
5643 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5644 2012-w04-5 @result{} Same as above
5647 Furthermore you can specify a relative date by giving, as the
5648 @emph{first} thing in the input: a plus/minus sign, a number and a
5649 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5650 single plus or minus, the date is always relative to today. With a
5651 double plus or minus, it is relative to the default date. If instead of
5652 a single letter, you use the abbreviation of day name, the date will be
5653 the Nth such day, e.g.@:
5658 +4d @result{} four days from today
5659 +4 @result{} same as above
5660 +2w @result{} two weeks from today
5661 ++5 @result{} five days from default date
5662 +2tue @result{} second Tuesday from now.
5665 @vindex parse-time-months
5666 @vindex parse-time-weekdays
5667 The function understands English month and weekday abbreviations. If
5668 you want to use unabbreviated names and/or other languages, configure
5669 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5671 @vindex org-read-date-force-compatible-dates
5672 Not all dates can be represented in a given Emacs implementation. By default
5673 Org mode forces dates into the compatibility range 1970--2037 which works on
5674 all Emacs implementations. If you want to use dates outside of this range,
5675 read the docstring of the variable
5676 @code{org-read-date-force-compatible-dates}.
5678 You can specify a time range by giving start and end times or by giving a
5679 start time and a duration (in HH:MM format). Use one or two dash(es) as the
5680 separator in the former case and use '+' as the separator in the latter
5684 11am-1:15pm @result{} 11:00-13:15
5685 11am--1:15pm @result{} same as above
5686 11am+2:15 @result{} same as above
5689 @cindex calendar, for selecting date
5690 @vindex org-popup-calendar-for-date-prompt
5691 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5692 you don't need/want the calendar, configure the variable
5693 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5694 prompt, either by clicking on a date in the calendar, or by pressing
5695 @key{RET}, the date selected in the calendar will be combined with the
5696 information entered at the prompt. You can control the calendar fully
5697 from the minibuffer:
5704 @kindex S-@key{right}
5705 @kindex S-@key{left}
5706 @kindex S-@key{down}
5708 @kindex M-S-@key{right}
5709 @kindex M-S-@key{left}
5712 @key{RET} @r{Choose date at cursor in calendar.}
5713 mouse-1 @r{Select date by clicking on it.}
5714 S-@key{right}/@key{left} @r{One day forward/backward.}
5715 S-@key{down}/@key{up} @r{One week forward/backward.}
5716 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5717 > / < @r{Scroll calendar forward/backward by one month.}
5718 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5721 @vindex org-read-date-display-live
5722 The actions of the date/time prompt may seem complex, but I assure you they
5723 will grow on you, and you will start getting annoyed by pretty much any other
5724 way of entering a date/time out there. To help you understand what is going
5725 on, the current interpretation of your input will be displayed live in the
5726 minibuffer@footnote{If you find this distracting, turn the display of with
5727 @code{org-read-date-display-live}.}.
5729 @node Custom time format, , The date/time prompt, Creating timestamps
5730 @subsection Custom time format
5731 @cindex custom date/time format
5732 @cindex time format, custom
5733 @cindex date format, custom
5735 @vindex org-display-custom-times
5736 @vindex org-time-stamp-custom-formats
5737 Org mode uses the standard ISO notation for dates and times as it is
5738 defined in ISO 8601. If you cannot get used to this and require another
5739 representation of date and time to keep you happy, you can get it by
5740 customizing the variables @code{org-display-custom-times} and
5741 @code{org-time-stamp-custom-formats}.
5744 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5745 Toggle the display of custom formats for dates and times.
5749 Org mode needs the default format for scanning, so the custom date/time
5750 format does not @emph{replace} the default format---instead it is put
5751 @emph{over} the default format using text properties. This has the
5752 following consequences:
5755 You cannot place the cursor onto a timestamp anymore, only before or
5758 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5759 each component of a timestamp. If the cursor is at the beginning of
5760 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5761 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5762 time will be changed by one minute.
5764 If the timestamp contains a range of clock times or a repeater, these
5765 will not be overlaid, but remain in the buffer as they were.
5767 When you delete a timestamp character-by-character, it will only
5768 disappear from the buffer after @emph{all} (invisible) characters
5769 belonging to the ISO timestamp have been removed.
5771 If the custom timestamp format is longer than the default and you are
5772 using dates in tables, table alignment will be messed up. If the custom
5773 format is shorter, things do work as expected.
5777 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5778 @section Deadlines and scheduling
5780 A timestamp may be preceded by special keywords to facilitate planning:
5784 @cindex DEADLINE keyword
5786 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5787 to be finished on that date.
5789 @vindex org-deadline-warning-days
5790 On the deadline date, the task will be listed in the agenda. In
5791 addition, the agenda for @emph{today} will carry a warning about the
5792 approaching or missed deadline, starting
5793 @code{org-deadline-warning-days} before the due date, and continuing
5794 until the entry is marked DONE. An example:
5797 *** TODO write article about the Earth for the Guide
5798 DEADLINE: <2004-02-29 Sun>
5799 The editor in charge is [[bbdb:Ford Prefect]]
5802 You can specify a different lead time for warnings for a specific
5803 deadlines using the following syntax. Here is an example with a warning
5804 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5807 @cindex SCHEDULED keyword
5809 Meaning: you are planning to start working on that task on the given
5812 @vindex org-agenda-skip-scheduled-if-done
5813 The headline will be listed under the given date@footnote{It will still
5814 be listed on that date after it has been marked DONE. If you don't like
5815 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5816 addition, a reminder that the scheduled date has passed will be present
5817 in the compilation for @emph{today}, until the entry is marked DONE, i.e.@:
5818 the task will automatically be forwarded until completed.
5821 *** TODO Call Trillian for a date on New Years Eve.
5822 SCHEDULED: <2004-12-25 Sat>
5826 @b{Important:} Scheduling an item in Org mode should @i{not} be
5827 understood in the same way that we understand @i{scheduling a meeting}.
5828 Setting a date for a meeting is just a simple appointment, you should
5829 mark this entry with a simple plain timestamp, to get this item shown
5830 on the date where it applies. This is a frequent misunderstanding by
5831 Org users. In Org mode, @i{scheduling} means setting a date when you
5832 want to start working on an action item.
5835 You may use timestamps with repeaters in scheduling and deadline
5836 entries. Org mode will issue early and late warnings based on the
5837 assumption that the timestamp represents the @i{nearest instance} of
5838 the repeater. However, the use of diary sexp entries like
5840 @code{<%%(org-float t 42)>}
5842 in scheduling and deadline timestamps is limited. Org mode does not
5843 know enough about the internals of each sexp function to issue early and
5844 late warnings. However, it will show the item on each day where the
5848 * Inserting deadline/schedule:: Planning items
5849 * Repeated tasks:: Items that show up again and again
5852 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5853 @subsection Inserting deadlines or schedules
5855 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
5856 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
5857 any text between this line and the headline.} a deadline or to schedule
5862 @orgcmd{C-c C-d,org-deadline}
5863 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5864 in the line directly following the headline. Any CLOSED timestamp will be
5865 removed. When called with a prefix arg, an existing deadline will be removed
5866 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
5867 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5868 and @code{nologredeadline}}, a note will be taken when changing an existing
5871 @orgcmd{C-c C-s,org-schedule}
5872 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5873 happen in the line directly following the headline. Any CLOSED timestamp
5874 will be removed. When called with a prefix argument, remove the scheduling
5875 date from the entry. Depending on the variable
5876 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5877 keywords @code{logreschedule}, @code{lognotereschedule}, and
5878 @code{nologreschedule}}, a note will be taken when changing an existing
5881 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5884 Mark the current entry for agenda action. After you have marked the entry
5885 like this, you can open the agenda or the calendar to find an appropriate
5886 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5887 schedule the marked item.
5889 @orgcmd{C-c / d,org-check-deadlines}
5890 @cindex sparse tree, for deadlines
5891 @vindex org-deadline-warning-days
5892 Create a sparse tree with all deadlines that are either past-due, or
5893 which will become due within @code{org-deadline-warning-days}.
5894 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5895 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5896 all deadlines due tomorrow.
5898 @orgcmd{C-c / b,org-check-before-date}
5899 Sparse tree for deadlines and scheduled items before a given date.
5901 @orgcmd{C-c / a,org-check-after-date}
5902 Sparse tree for deadlines and scheduled items after a given date.
5905 Note that @code{org-schedule} and @code{org-deadline} supports
5906 setting the date by indicating a relative time: e.g. +1d will set
5907 the date to the next day after today, and --1w will set the date
5908 to the previous week before any current timestamp.
5910 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5911 @subsection Repeated tasks
5912 @cindex tasks, repeated
5913 @cindex repeated tasks
5915 Some tasks need to be repeated again and again. Org mode helps to
5916 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5917 or plain timestamp. In the following example
5919 ** TODO Pay the rent
5920 DEADLINE: <2005-10-01 Sat +1m>
5923 the @code{+1m} is a repeater; the intended interpretation is that the task
5924 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5925 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
5926 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
5927 and a special warning period in a deadline entry, the repeater should come
5928 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5930 @vindex org-todo-repeat-to-state
5931 Deadlines and scheduled items produce entries in the agenda when they are
5932 over-due, so it is important to be able to mark such an entry as completed
5933 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5934 keyword DONE, it will no longer produce entries in the agenda. The problem
5935 with this is, however, that then also the @emph{next} instance of the
5936 repeated entry will not be active. Org mode deals with this in the following
5937 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
5938 shift the base date of the repeating timestamp by the repeater interval, and
5939 immediately set the entry state back to TODO@footnote{In fact, the target
5940 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
5941 the variable @code{org-todo-repeat-to-state}. If neither of these is
5942 specified, the target state defaults to the first state of the TODO state
5943 sequence.}. In the example above, setting the state to DONE would actually
5944 switch the date like this:
5947 ** TODO Pay the rent
5948 DEADLINE: <2005-11-01 Tue +1m>
5951 @vindex org-log-repeat
5952 A timestamp@footnote{You can change this using the option
5953 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
5954 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
5955 will also be prompted for a note.} will be added under the deadline, to keep
5956 a record that you actually acted on the previous instance of this deadline.
5958 As a consequence of shifting the base date, this entry will no longer be
5959 visible in the agenda when checking past dates, but all future instances
5962 With the @samp{+1m} cookie, the date shift will always be exactly one
5963 month. So if you have not paid the rent for three months, marking this
5964 entry DONE will still keep it as an overdue deadline. Depending on the
5965 task, this may not be the best way to handle it. For example, if you
5966 forgot to call your father for 3 weeks, it does not make sense to call
5967 him 3 times in a single day to make up for it. Finally, there are tasks
5968 like changing batteries which should always repeat a certain time
5969 @i{after} the last time you did it. For these tasks, Org mode has
5970 special repeaters @samp{++} and @samp{.+}. For example:
5974 DEADLINE: <2008-02-10 Sun ++1w>
5975 Marking this DONE will shift the date by at least one week,
5976 but also by as many weeks as it takes to get this date into
5977 the future. However, it stays on a Sunday, even if you called
5978 and marked it done on Saturday.
5979 ** TODO Check the batteries in the smoke detectors
5980 DEADLINE: <2005-11-01 Tue .+1m>
5981 Marking this DONE will shift the date to one month after
5985 You may have both scheduling and deadline information for a specific
5986 task---just make sure that the repeater intervals on both are the same.
5988 An alternative to using a repeater is to create a number of copies of a task
5989 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
5990 created for this purpose, it is described in @ref{Structure editing}.
5993 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
5994 @section Clocking work time
5995 @cindex clocking time
5996 @cindex time clocking
5998 Org mode allows you to clock the time you spend on specific tasks in a
5999 project. When you start working on an item, you can start the clock. When
6000 you stop working on that task, or when you mark the task done, the clock is
6001 stopped and the corresponding time interval is recorded. It also computes
6002 the total time spent on each subtree@footnote{Clocking only works if all
6003 headings are indented with less than 30 stars. This is a hardcoded
6004 limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
6005 history or tasks recently clocked, to that you can jump quickly between a
6006 number of tasks absorbing your time.
6008 To save the clock history across Emacs sessions, use
6010 (setq org-clock-persist 'history)
6011 (org-clock-persistence-insinuate)
6013 When you clock into a new task after resuming Emacs, the incomplete
6014 clock@footnote{To resume the clock under the assumption that you have worked
6015 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6016 will be found (@pxref{Resolving idle time}) and you will be prompted about
6020 * Clocking commands:: Starting and stopping a clock
6021 * The clock table:: Detailed reports
6022 * Resolving idle time:: Resolving time when you've been idle
6025 @node Clocking commands, The clock table, Clocking work time, Clocking work time
6026 @subsection Clocking commands
6029 @orgcmd{C-c C-x C-i,org-clock-in}
6030 @vindex org-clock-into-drawer
6031 @vindex org-clock-continuously
6032 @cindex property, LOG_INTO_DRAWER
6033 Start the clock on the current item (clock-in). This inserts the CLOCK
6034 keyword together with a timestamp. If this is not the first clocking of
6035 this item, the multiple CLOCK lines will be wrapped into a
6036 @code{:LOGBOOK:} drawer (see also the variable
6037 @code{org-clock-into-drawer}). You can also overrule
6038 the setting of this variable for a subtree by setting a
6039 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6040 When called with a @kbd{C-u} prefix argument,
6041 select the task from a list of recently clocked tasks. With two @kbd{C-u
6042 C-u} prefixes, clock into the task at point and mark it as the default task;
6043 the default task will then always be available with letter @kbd{d} when
6044 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6045 continuous clocking by starting the clock when the last clock stopped.@*
6046 @cindex property: CLOCK_MODELINE_TOTAL
6047 @cindex property: LAST_REPEAT
6048 @vindex org-clock-modeline-total
6049 While the clock is running, the current clocking time is shown in the mode
6050 line, along with the title of the task. The clock time shown will be all
6051 time ever clocked for this task and its children. If the task has an effort
6052 estimate (@pxref{Effort estimates}), the mode line displays the current
6053 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6054 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6055 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6056 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6057 will be shown. More control over what time is shown can be exercised with
6058 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6059 @code{current} to show only the current clocking instance, @code{today} to
6060 show all time clocked on this tasks today (see also the variable
6061 @code{org-extend-today-until}), @code{all} to include all time, or
6062 @code{auto} which is the default@footnote{See also the variable
6063 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6064 mode line entry will pop up a menu with clocking options.
6066 @orgcmd{C-c C-x C-o,org-clock-out}
6067 @vindex org-log-note-clock-out
6068 Stop the clock (clock-out). This inserts another timestamp at the same
6069 location where the clock was last started. It also directly computes
6070 the resulting time in inserts it after the time range as @samp{=>
6071 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6072 possibility to record an additional note together with the clock-out
6073 timestamp@footnote{The corresponding in-buffer setting is:
6074 @code{#+STARTUP: lognoteclock-out}}.
6075 @orgcmd{C-c C-x C-x,org-clock-in-last}
6076 @vindex org-clock-continuously
6077 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6078 select the task from the clock history. With two @kbd{C-u} prefixes,
6079 force continuous clocking by starting the clock when the last clock
6081 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6082 Update the effort estimate for the current clock task.
6085 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6086 Recompute the time interval after changing one of the timestamps. This
6087 is only necessary if you edit the timestamps directly. If you change
6088 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6089 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6090 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6091 clock duration keeps the same.
6092 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6093 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6094 the one of the previous (or the next clock) timestamp by the same duration.
6095 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6096 by five minutes, then the clocked-in timestamp of the next clock will be
6097 increased by five minutes.
6098 @orgcmd{C-c C-t,org-todo}
6099 Changing the TODO state of an item to DONE automatically stops the clock
6100 if it is running in this same item.
6101 @orgcmd{C-c C-x C-q,org-clock-cancel}
6102 Cancel the current clock. This is useful if a clock was started by
6103 mistake, or if you ended up working on something else.
6104 @orgcmd{C-c C-x C-j,org-clock-goto}
6105 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6106 prefix arg, select the target task from a list of recently clocked tasks.
6107 @orgcmd{C-c C-x C-d,org-clock-display}
6108 @vindex org-remove-highlights-with-change
6109 Display time summaries for each subtree in the current buffer. This puts
6110 overlays at the end of each headline, showing the total time recorded under
6111 that heading, including the time of any subheadings. You can use visibility
6112 cycling to study the tree, but the overlays disappear when you change the
6113 buffer (see variable @code{org-remove-highlights-with-change}) or press
6117 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6118 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6119 worked on or closed during a day.
6121 @strong{Important:} note that both @code{org-clock-out} and
6122 @code{org-clock-in-last} can have a global keybinding and will not
6123 modify the window disposition.
6125 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6126 @subsection The clock table
6127 @cindex clocktable, dynamic block
6128 @cindex report, of clocked time
6130 Org mode can produce quite complex reports based on the time clocking
6131 information. Such a report is called a @emph{clock table}, because it is
6132 formatted as one or several Org tables.
6135 @orgcmd{C-c C-x C-r,org-clock-report}
6136 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6137 report as an Org mode table into the current file. When the cursor is
6138 at an existing clock table, just update it. When called with a prefix
6139 argument, jump to the first clock report in the current document and
6140 update it. The clock table always includes also trees with
6141 @code{:ARCHIVE:} tag.
6142 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6143 Update dynamic block at point. The cursor needs to be in the
6144 @code{#+BEGIN} line of the dynamic block.
6145 @orgkey{C-u C-c C-x C-u}
6146 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6147 you have several clock table blocks in a buffer.
6148 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6149 Shift the current @code{:block} interval and update the table. The cursor
6150 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6151 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6155 Here is an example of the frame for a clock table as it is inserted into the
6156 buffer with the @kbd{C-c C-x C-r} command:
6158 @cindex #+BEGIN, clocktable
6160 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6164 @vindex org-clocktable-defaults
6165 The @samp{BEGIN} line and specify a number of options to define the scope,
6166 structure, and formatting of the report. Defaults for all these options can
6167 be configured in the variable @code{org-clocktable-defaults}.
6169 @noindent First there are options that determine which clock entries are to
6172 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6173 @r{Clocks at deeper levels will be summed into the upper level.}
6174 :scope @r{The scope to consider. This can be any of the following:}
6175 nil @r{the current buffer or narrowed region}
6176 file @r{the full current buffer}
6177 subtree @r{the subtree where the clocktable is located}
6178 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6179 tree @r{the surrounding level 1 tree}
6180 agenda @r{all agenda files}
6181 ("file"..) @r{scan these files}
6182 file-with-archives @r{current file and its archives}
6183 agenda-with-archives @r{all agenda files, including archives}
6184 :block @r{The time block to consider. This block is specified either}
6185 @r{absolute, or relative to the current time and may be any of}
6187 2007-12-31 @r{New year eve 2007}
6188 2007-12 @r{December 2007}
6189 2007-W50 @r{ISO-week 50 in 2007}
6190 2007-Q2 @r{2nd quarter in 2007}
6191 2007 @r{the year 2007}
6192 today, yesterday, today-@var{N} @r{a relative day}
6193 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6194 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6195 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6196 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6197 :tstart @r{A time string specifying when to start considering times.}
6198 :tend @r{A time string specifying when to stop considering times.}
6199 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6200 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6201 :stepskip0 @r{Do not show steps that have zero time.}
6202 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6203 :tags @r{A tags match to select entries that should contribute. See}
6204 @r{@ref{Matching tags and properties} for the match syntax.}
6207 Then there are options which determine the formatting of the table. There
6208 options are interpreted by the function @code{org-clocktable-write-default},
6209 but you can specify your own function using the @code{:formatter} parameter.
6211 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6212 :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".}
6213 :link @r{Link the item headlines in the table to their origins.}
6214 :narrow @r{An integer to limit the width of the headline column in}
6215 @r{the org table. If you write it like @samp{50!}, then the}
6216 @r{headline will also be shortened in export.}
6217 :indent @r{Indent each headline field according to its level.}
6218 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6219 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6220 :level @r{Should a level number column be included?}
6221 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6222 @r{All are overwritten except if there is an explicit @code{:narrow}}
6223 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6224 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6225 :properties @r{List of properties that should be shown in the table. Each}
6226 @r{property will get its own column.}
6227 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6228 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6229 @r{As a special case, @samp{:formula %} adds a column with % time.}
6230 @r{If you do not specify a formula here, any existing formula}
6231 @r{below the clock table will survive updates and be evaluated.}
6232 :formatter @r{A function to format clock data and insert it into the buffer.}
6234 To get a clock summary of the current level 1 tree, for the current
6235 day, you could write
6237 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6241 and to use a specific time range you could write@footnote{Note that all
6242 parameters must be specified in a single line---the line is broken here
6243 only to fit it into the manual.}
6245 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6246 :tend "<2006-08-10 Thu 12:00>"
6249 A summary of the current subtree with % times would be
6251 #+BEGIN: clocktable :scope subtree :link t :formula %
6254 A horizontally compact representation of everything clocked during last week
6257 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6261 @node Resolving idle time, , The clock table, Clocking work time
6262 @subsection Resolving idle time and continuous clocking
6264 @subsubheading Resolving idle time
6265 @cindex resolve idle time
6267 @cindex idle, resolve, dangling
6268 If you clock in on a work item, and then walk away from your
6269 computer---perhaps to take a phone call---you often need to ``resolve'' the
6270 time you were away by either subtracting it from the current clock, or
6271 applying it to another one.
6273 @vindex org-clock-idle-time
6274 By customizing the variable @code{org-clock-idle-time} to some integer, such
6275 as 10 or 15, Emacs can alert you when you get back to your computer after
6276 being idle for that many minutes@footnote{On computers using Mac OS X,
6277 idleness is based on actual user idleness, not just Emacs' idle time. For
6278 X11, you can install a utility program @file{x11idle.c}, available in the
6279 @code{utils} directory of the Org git distribution, to get the same general
6280 treatment of idleness. On other systems, idle time refers to Emacs idle time
6281 only.}, and ask what you want to do with the idle time. There will be a
6282 question waiting for you when you get back, indicating how much idle time has
6283 passed (constantly updated with the current amount), as well as a set of
6284 choices to correct the discrepancy:
6288 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6289 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6290 effectively changing nothing, or enter a number to keep that many minutes.
6292 If you use the shift key and press @kbd{K}, it will keep however many minutes
6293 you request and then immediately clock out of that task. If you keep all of
6294 the minutes, this is the same as just clocking out of the current task.
6296 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6297 the clock, and then check back in from the moment you returned.
6299 To keep none of the minutes and just clock out at the start of the away time,
6300 use the shift key and press @kbd{S}. Remember that using shift will always
6301 leave you clocked out, no matter which option you choose.
6303 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6304 canceling you subtract the away time, and the resulting clock amount is less
6305 than a minute, the clock will still be canceled rather than clutter up the
6306 log with an empty entry.
6309 What if you subtracted those away minutes from the current clock, and now
6310 want to apply them to a new clock? Simply clock in to any task immediately
6311 after the subtraction. Org will notice that you have subtracted time ``on
6312 the books'', so to speak, and will ask if you want to apply those minutes to
6313 the next task you clock in on.
6315 There is one other instance when this clock resolution magic occurs. Say you
6316 were clocked in and hacking away, and suddenly your cat chased a mouse who
6317 scared a hamster that crashed into your UPS's power button! You suddenly
6318 lose all your buffers, but thanks to auto-save you still have your recent Org
6319 mode changes, including your last clock in.
6321 If you restart Emacs and clock into any task, Org will notice that you have a
6322 dangling clock which was never clocked out from your last session. Using
6323 that clock's starting time as the beginning of the unaccounted-for period,
6324 Org will ask how you want to resolve that time. The logic and behavior is
6325 identical to dealing with away time due to idleness; it is just happening due
6326 to a recovery event rather than a set amount of idle time.
6328 You can also check all the files visited by your Org agenda for dangling
6329 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6331 @subsubheading Continuous clocking
6332 @cindex continuous clocking
6333 @vindex org-clock-continuously
6335 You may want to start clocking from the time when you clocked out the
6336 previous task. To enable this systematically, set @code{org-clock-continuously}
6337 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6338 last clocked entry for this session, and start the new clock from there.
6340 If you only want this from time to time, use three universal prefix arguments
6341 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6343 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6344 @section Effort estimates
6345 @cindex effort estimates
6347 @cindex property, Effort
6348 @vindex org-effort-property
6349 If you want to plan your work in a very detailed way, or if you need to
6350 produce offers with quotations of the estimated work effort, you may want to
6351 assign effort estimates to entries. If you are also clocking your work, you
6352 may later want to compare the planned effort with the actual working time, a
6353 great way to improve planning estimates. Effort estimates are stored in a
6354 special property @samp{Effort}@footnote{You may change the property being
6355 used with the variable @code{org-effort-property}.}. You can set the effort
6356 for an entry with the following commands:
6359 @orgcmd{C-c C-x e,org-set-effort}
6360 Set the effort estimate for the current entry. With a numeric prefix
6361 argument, set it to the Nth allowed value (see below). This command is also
6362 accessible from the agenda with the @kbd{e} key.
6363 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6364 Modify the effort estimate of the item currently being clocked.
6367 Clearly the best way to work with effort estimates is through column view
6368 (@pxref{Column view}). You should start by setting up discrete values for
6369 effort estimates, and a @code{COLUMNS} format that displays these values
6370 together with clock sums (if you want to clock your time). For a specific
6374 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6375 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6379 @vindex org-global-properties
6380 @vindex org-columns-default-format
6381 or, even better, you can set up these values globally by customizing the
6382 variables @code{org-global-properties} and @code{org-columns-default-format}.
6383 In particular if you want to use this setup also in the agenda, a global
6384 setup may be advised.
6386 The way to assign estimates to individual items is then to switch to column
6387 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6388 value. The values you enter will immediately be summed up in the hierarchy.
6389 In the column next to it, any clocked time will be displayed.
6391 @vindex org-agenda-columns-add-appointments-to-effort-sum
6392 If you switch to column view in the daily/weekly agenda, the effort column
6393 will summarize the estimated work effort for each day@footnote{Please note
6394 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6395 column view}).}, and you can use this to find space in your schedule. To get
6396 an overview of the entire part of the day that is committed, you can set the
6397 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6398 appointments on a day that take place over a specified time interval will
6399 then also be added to the load estimate of the day.
6401 Effort estimates can be used in secondary agenda filtering that is triggered
6402 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6403 these estimates defined consistently, two or three key presses will narrow
6404 down the list to stuff that fits into an available time slot.
6406 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6407 @section Taking notes with a relative timer
6408 @cindex relative timer
6410 When taking notes during, for example, a meeting or a video viewing, it can
6411 be useful to have access to times relative to a starting time. Org provides
6412 such a relative timer and make it easy to create timed notes.
6415 @orgcmd{C-c C-x .,org-timer}
6416 Insert a relative time into the buffer. The first time you use this, the
6417 timer will be started. When called with a prefix argument, the timer is
6419 @orgcmd{C-c C-x -,org-timer-item}
6420 Insert a description list item with the current relative time. With a prefix
6421 argument, first reset the timer to 0.
6422 @orgcmd{M-@key{RET},org-insert-heading}
6423 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6425 @c for key sequences with a comma, command name macros fail :(
6428 Pause the timer, or continue it if it is already paused
6429 (@command{org-timer-pause-or-continue}).
6430 @c removed the sentence because it is redundant to the following item
6431 @kindex C-u C-c C-x ,
6433 Stop the timer. After this, you can only start a new timer, not continue the
6434 old one. This command also removes the timer from the mode line.
6435 @orgcmd{C-c C-x 0,org-timer-start}
6436 Reset the timer without inserting anything into the buffer. By default, the
6437 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6438 specific starting offset. The user is prompted for the offset, with a
6439 default taken from a timer string at point, if any, So this can be used to
6440 restart taking notes after a break in the process. When called with a double
6441 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6442 by a certain amount. This can be used to fix timer strings if the timer was
6443 not started at exactly the right moment.
6446 @node Countdown timer, , Relative timer, Dates and Times
6447 @section Countdown timer
6448 @cindex Countdown timer
6452 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6453 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6455 @code{org-timer-set-timer} prompts the user for a duration and displays a
6456 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6457 default countdown value. Giving a prefix numeric argument overrides this
6460 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6461 @chapter Capture - Refile - Archive
6464 An important part of any organization system is the ability to quickly
6465 capture new ideas and tasks, and to associate reference material with them.
6466 Org does this using a process called @i{capture}. It also can store files
6467 related to a task (@i{attachments}) in a special directory. Once in the
6468 system, tasks and projects need to be moved around. Moving completed project
6469 trees to an archive file keeps the system compact and fast.
6472 * Capture:: Capturing new stuff
6473 * Attachments:: Add files to tasks
6474 * RSS Feeds:: Getting input from RSS feeds
6475 * Protocols:: External (e.g.@: Browser) access to Emacs and Org
6476 * Refiling notes:: Moving a tree from one place to another
6477 * Archiving:: What to do with finished projects
6480 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6484 Org's method for capturing new items is heavily inspired by John Wiegley
6485 excellent remember package. Up to version 6.36 Org used a special setup
6486 for @file{remember.el}. @file{org-remember.el} is still part of Org mode for
6487 backward compatibility with existing setups. You can find the documentation
6488 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6490 The new capturing setup described here is preferred and should be used by new
6491 users. To convert your @code{org-remember-templates}, run the command
6493 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6495 @noindent and then customize the new variable with @kbd{M-x
6496 customize-variable org-capture-templates}, check the result, and save the
6497 customization. You can then use both remember and capture until
6498 you are familiar with the new mechanism.
6500 Capture lets you quickly store notes with little interruption of your work
6501 flow. The basic process of capturing is very similar to remember, but Org
6502 does enhance it with templates and more.
6505 * Setting up capture:: Where notes will be stored
6506 * Using capture:: Commands to invoke and terminate capture
6507 * Capture templates:: Define the outline of different note types
6510 @node Setting up capture, Using capture, Capture, Capture
6511 @subsection Setting up capture
6513 The following customization sets a default target file for notes, and defines
6514 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6515 suggestion.} for capturing new material.
6517 @vindex org-default-notes-file
6519 (setq org-default-notes-file (concat org-directory "/notes.org"))
6520 (define-key global-map "\C-cc" 'org-capture)
6523 @node Using capture, Capture templates, Setting up capture, Capture
6524 @subsection Using capture
6527 @orgcmd{C-c c,org-capture}
6528 Call the command @code{org-capture}. Note that this keybinding is global and
6529 not active by default - you need to install it. If you have templates
6531 defined @pxref{Capture templates}, it will offer these templates for
6532 selection or use a new Org outline node as the default template. It will
6533 insert the template into the target file and switch to an indirect buffer
6534 narrowed to this new node. You may then insert the information you want.
6536 @orgcmd{C-c C-c,org-capture-finalize}
6537 Once you have finished entering information into the capture buffer, @kbd{C-c
6538 C-c} will return you to the window configuration before the capture process,
6539 so that you can resume your work without further distraction. When called
6540 with a prefix arg, finalize and then jump to the captured item.
6542 @orgcmd{C-c C-w,org-capture-refile}
6543 Finalize the capture process by refiling (@pxref{Refiling notes}) the note to
6544 a different place. Please realize that this is a normal refiling command
6545 that will be executed---so the cursor position at the moment you run this
6546 command is important. If you have inserted a tree with a parent and
6547 children, first move the cursor back to the parent. Any prefix argument
6548 given to this command will be passed on to the @code{org-refile} command.
6550 @orgcmd{C-c C-k,org-capture-kill}
6551 Abort the capture process and return to the previous state.
6555 You can also call @code{org-capture} in a special way from the agenda, using
6556 the @kbd{k c} key combination. With this access, any timestamps inserted by
6557 the selected capture template will default to the cursor date in the agenda,
6558 rather than to the current date.
6560 To find the locations of the last stored capture, use @code{org-capture} with
6565 Visit the target location of a capture template. You get to select the
6566 template in the usual way.
6567 @orgkey{C-u C-u C-c c}
6568 Visit the last stored capture item in its buffer.
6571 @vindex org-capture-bookmark
6572 @cindex org-capture-last-stored
6573 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6574 automatically be created unless you set @code{org-capture-bookmark} to
6577 To insert the capture at point in an Org buffer, call @code{org-capture} with
6578 a @code{C-0} prefix argument.
6580 @node Capture templates, , Using capture, Capture
6581 @subsection Capture templates
6582 @cindex templates, for Capture
6584 You can use templates for different types of capture items, and
6585 for different target locations. The easiest way to create such templates is
6586 through the customize interface.
6590 Customize the variable @code{org-capture-templates}.
6593 Before we give the formal description of template definitions, let's look at
6594 an example. Say you would like to use one template to create general TODO
6595 entries, and you want to put these entries under the heading @samp{Tasks} in
6596 your file @file{~/org/gtd.org}. Also, a date tree in the file
6597 @file{journal.org} should capture journal entries. A possible configuration
6601 (setq org-capture-templates
6602 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6603 "* TODO %?\n %i\n %a")
6604 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6605 "* %?\nEntered on %U\n %i\n %a")))
6608 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6612 [[file:@var{link to where you initiated capture}]]
6616 During expansion of the template, @code{%a} has been replaced by a link to
6617 the location from where you called the capture command. This can be
6618 extremely useful for deriving tasks from emails, for example. You fill in
6619 the task definition, press @code{C-c C-c} and Org returns you to the same
6620 place where you started the capture process.
6622 To define special keys to capture to a particular template without going
6623 through the interactive template selection, you can create your key binding
6627 (define-key global-map "\C-cx"
6628 (lambda () (interactive) (org-capture nil "x")))
6632 * Template elements:: What is needed for a complete template entry
6633 * Template expansion:: Filling in information about time and context
6634 * Templates in contexts:: Only show a template in a specific context
6637 @node Template elements, Template expansion, Capture templates, Capture templates
6638 @subsubsection Template elements
6640 Now lets look at the elements of a template definition. Each entry in
6641 @code{org-capture-templates} is a list with the following items:
6645 The keys that will select the template, as a string, characters
6646 only, for example @code{"a"} for a template to be selected with a
6647 single key, or @code{"bt"} for selection with two keys. When using
6648 several keys, keys using the same prefix key must be sequential
6649 in the list and preceded by a 2-element entry explaining the
6650 prefix key, for example
6652 ("b" "Templates for marking stuff to buy")
6654 @noindent If you do not define a template for the @kbd{C} key, this key will
6655 be used to open the customize buffer for this complex variable.
6658 A short string describing the template, which will be shown during
6662 The type of entry, a symbol. Valid values are:
6665 An Org mode node, with a headline. Will be filed as the child of the target
6666 entry or as a top-level entry. The target file should be an Org mode file.
6668 A plain list item, placed in the first plain list at the target
6669 location. Again the target file should be an Org file.
6671 A checkbox item. This only differs from the plain list item by the
6674 a new line in the first table at the target location. Where exactly the
6675 line will be inserted depends on the properties @code{:prepend} and
6676 @code{:table-line-pos} (see below).
6678 Text to be inserted as it is.
6682 @vindex org-default-notes-file
6683 Specification of where the captured item should be placed. In Org mode
6684 files, targets usually define a node. Entries will become children of this
6685 node. Other types will be added to the table or list in the body of this
6686 node. Most target specifications contain a file name. If that file name is
6687 the empty string, it defaults to @code{org-default-notes-file}. A file can
6688 also be given as a variable, function, or Emacs Lisp form.
6692 @item (file "path/to/file")
6693 Text will be placed at the beginning or end of that file.
6695 @item (id "id of existing org entry")
6696 Filing as child of this entry, or in the body of the entry.
6698 @item (file+headline "path/to/file" "node headline")
6699 Fast configuration if the target heading is unique in the file.
6701 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6702 For non-unique headings, the full path is safer.
6704 @item (file+regexp "path/to/file" "regexp to find location")
6705 Use a regular expression to position the cursor.
6707 @item (file+datetree "path/to/file")
6708 Will create a heading in a date tree for today's date.
6710 @item (file+datetree+prompt "path/to/file")
6711 Will create a heading in a date tree, but will prompt for the date.
6713 @item (file+function "path/to/file" function-finding-location)
6714 A function to find the right location in the file.
6717 File to the entry that is currently being clocked.
6719 @item (function function-finding-location)
6720 Most general way, write your own function to find both
6725 The template for creating the capture item. If you leave this empty, an
6726 appropriate default template will be used. Otherwise this is a string with
6727 escape codes, which will be replaced depending on time and context of the
6728 capture call. The string with escapes may be loaded from a template file,
6729 using the special syntax @code{(file "path/to/template")}. See below for
6733 The rest of the entry is a property list of additional options.
6734 Recognized properties are:
6737 Normally new captured information will be appended at
6738 the target location (last child, last table line, last list item...).
6739 Setting this property will change that.
6741 @item :immediate-finish
6742 When set, do not offer to edit the information, just
6743 file it away immediately. This makes sense if the template only needs
6744 information that can be added automatically.
6747 Set this to the number of lines to insert
6748 before and after the new item. Default 0, only common other value is 1.
6751 Start the clock in this item.
6754 Keep the clock running when filing the captured entry.
6757 If starting the capture interrupted a clock, restart that clock when finished
6758 with the capture. Note that @code{:clock-keep} has precedence over
6759 @code{:clock-resume}. When setting both to @code{t}, the current clock will
6760 run and the previous one will not be resumed.
6763 Do not narrow the target buffer, simply show the full buffer. Default is to
6764 narrow it so that you only see the new material.
6766 @item :table-line-pos
6767 Specification of the location in the table where the new line should be
6768 inserted. It should be a string like @code{"II-3"} meaning that the new
6769 line should become the third line before the second horizontal separator
6773 If the target file was not yet visited when capture was invoked, kill the
6774 buffer again after capture is completed.
6778 @node Template expansion, Templates in contexts, Template elements, Capture templates
6779 @subsubsection Template expansion
6781 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6782 these sequences literally, escape the @kbd{%} with a backslash.} allow
6783 dynamic insertion of content. The templates are expanded in the order given here:
6786 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
6787 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
6788 @r{The sexp must return a string.}
6789 %<...> @r{The result of format-time-string on the ... format specification.}
6790 %t @r{Timestamp, date only.}
6791 %T @r{Timestamp, with date and time.}
6792 %u, %U @r{Like the above, but inactive timestamps.}
6793 %i @r{Initial content, the region when capture is called while the}
6794 @r{region is active.}
6795 @r{The entire text will be indented like @code{%i} itself.}
6796 %a @r{Annotation, normally the link created with @code{org-store-link}.}
6797 %A @r{Like @code{%a}, but prompt for the description part.}
6798 %l @r{Like %a, but only insert the literal link.}
6799 %c @r{Current kill ring head.}
6800 %x @r{Content of the X clipboard.}
6801 %k @r{Title of the currently clocked task.}
6802 %K @r{Link to the currently clocked task.}
6803 %n @r{User name (taken from @code{user-full-name}).}
6804 %f @r{File visited by current buffer when org-capture was called.}
6805 %F @r{Full path of the file or directory visited by current buffer.}
6806 %:keyword @r{Specific information for certain link types, see below.}
6807 %^g @r{Prompt for tags, with completion on tags in target file.}
6808 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
6809 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
6810 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
6811 %^C @r{Interactive selection of which kill or clip to use.}
6812 %^L @r{Like @code{%^C}, but insert as link.}
6813 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
6814 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6815 @r{You may specify a default value and a completion table with}
6816 @r{%^@{prompt|default|completion2|completion3...@}.}
6817 @r{The arrow keys access a prompt-specific history.}
6818 %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
6819 @r{a number, starting from 1.}
6820 %? @r{After completing the template, position cursor here.}
6824 For specific link types, the following keywords will be
6825 defined@footnote{If you define your own link types (@pxref{Adding
6826 hyperlink types}), any property you store with
6827 @code{org-store-link-props} can be accessed in capture templates in a
6830 @vindex org-from-is-user-regexp
6832 Link type | Available keywords
6833 ---------------------------------+----------------------------------------------
6834 bbdb | %:name %:company
6835 irc | %:server %:port %:nick
6836 vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
6837 | %:from %:fromname %:fromaddress
6838 | %:to %:toname %:toaddress
6839 | %:date @r{(message date header field)}
6840 | %:date-timestamp @r{(date as active timestamp)}
6841 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6842 | %: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}.}}
6843 gnus | %:group, @r{for messages also all email fields}
6845 info | %:file %:node
6850 To place the cursor after template expansion use:
6853 %? @r{After completing the template, position cursor here.}
6856 @node Templates in contexts, , Template expansion, Capture templates
6857 @subsubsection Templates in contexts
6859 @vindex org-capture-templates-contexts
6860 To control whether a capture template should be accessible from a specific
6861 context, you can customize @var{org-capture-templates-contexts}. Let's say
6862 for example that you have a capture template @code{"p"} for storing Gnus
6863 emails containing patches. Then you would configure this option like this:
6866 (setq org-capture-templates-contexts
6867 '(("p" (in-mode . "message-mode"))))
6870 You can also tell that the command key @code{"p"} should refer to another
6871 template. In that case, add this command key like this:
6874 (setq org-capture-templates-contexts
6875 '(("p" "q" (in-mode . "message-mode"))))
6878 See the docstring of the variable for more information.
6880 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6881 @section Attachments
6884 @vindex org-attach-directory
6885 It is often useful to associate reference material with an outline node/task.
6886 Small chunks of plain text can simply be stored in the subtree of a project.
6887 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6888 files that live elsewhere on your computer or in the cloud, like emails or
6889 source code files belonging to a project. Another method is @i{attachments},
6890 which are files located in a directory belonging to an outline node. Org
6891 uses directories named by the unique ID of each entry. These directories are
6892 located in the @file{data} directory which lives in the same directory where
6893 your Org file lives@footnote{If you move entries or Org files from one
6894 directory to another, you may want to configure @code{org-attach-directory}
6895 to contain an absolute path.}. If you initialize this directory with
6896 @code{git init}, Org will automatically commit changes when it sees them.
6897 The attachment system has been contributed to Org by John Wiegley.
6899 In cases where it seems better to do so, you can also attach a directory of your
6900 choice to an entry. You can also make children inherit the attachment
6901 directory from a parent, so that an entire subtree uses the same attached
6904 @noindent The following commands deal with attachments:
6908 @orgcmd{C-c C-a,org-attach}
6909 The dispatcher for commands related to the attachment system. After these
6910 keys, a list of commands is displayed and you must press an additional key
6911 to select a command:
6914 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6915 @vindex org-attach-method
6916 Select a file and move it into the task's attachment directory. The file
6917 will be copied, moved, or linked, depending on @code{org-attach-method}.
6918 Note that hard links are not supported on all systems.
6924 Attach a file using the copy/move/link method.
6925 Note that hard links are not supported on all systems.
6927 @orgcmdtkc{n,C-c C-a n,org-attach-new}
6928 Create a new attachment as an Emacs buffer.
6930 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
6931 Synchronize the current task with its attachment directory, in case you added
6932 attachments yourself.
6934 @orgcmdtkc{o,C-c C-a o,org-attach-open}
6935 @vindex org-file-apps
6936 Open current task's attachment. If there is more than one, prompt for a
6937 file name first. Opening will follow the rules set by @code{org-file-apps}.
6938 For more details, see the information on following hyperlinks
6939 (@pxref{Handling links}).
6941 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
6942 Also open the attachment, but force opening the file in Emacs.
6944 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
6945 Open the current task's attachment directory.
6947 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
6948 Also open the directory, but force using @command{dired} in Emacs.
6950 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
6951 Select and delete a single attachment.
6953 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
6954 Delete all of a task's attachments. A safer way is to open the directory in
6955 @command{dired} and delete from there.
6957 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
6958 @cindex property, ATTACH_DIR
6959 Set a specific directory as the entry's attachment directory. This works by
6960 putting the directory path into the @code{ATTACH_DIR} property.
6962 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
6963 @cindex property, ATTACH_DIR_INHERIT
6964 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
6965 same directory for attachments as the parent does.
6969 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
6974 Org can add and change entries based on information found in RSS feeds and
6975 Atom feeds. You could use this to make a task out of each new podcast in a
6976 podcast feed. Or you could use a phone-based note-creating service on the
6977 web to import tasks into Org. To access feeds, configure the variable
6978 @code{org-feed-alist}. The docstring of this variable has detailed
6979 information. Here is just an example:
6982 (setq org-feed-alist
6984 "http://rss.slashdot.org/Slashdot/slashdot"
6985 "~/txt/org/feeds.org" "Slashdot Entries")))
6989 will configure that new items from the feed provided by
6990 @code{rss.slashdot.org} will result in new entries in the file
6991 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
6992 the following command is used:
6995 @orgcmd{C-c C-x g,org-feed-update-all}
6997 Collect items from the feeds configured in @code{org-feed-alist} and act upon
6999 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7000 Prompt for a feed name and go to the inbox configured for this feed.
7003 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7004 it will store information about the status of items in the feed, to avoid
7005 adding the same item several times. You should add @samp{FEEDSTATUS} to the
7006 list of drawers in that file:
7009 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
7012 For more information, including how to read atom feeds, see
7013 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7015 @node Protocols, Refiling notes, RSS Feeds, Capture - Refile - Archive
7016 @section Protocols for external access
7017 @cindex protocols, for external access
7020 You can set up Org for handling protocol calls from outside applications that
7021 are passed to Emacs through the @file{emacsserver}. For example, you can
7022 configure bookmarks in your web browser to send a link to the current page to
7023 Org and create a note from it using capture (@pxref{Capture}). Or you
7024 could create a bookmark that will tell Emacs to open the local source file of
7025 a remote website you are looking at with the browser. See
7026 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7027 documentation and setup instructions.
7029 @node Refiling notes, Archiving, Protocols, Capture - Refile - Archive
7030 @section Refiling notes
7031 @cindex refiling notes
7033 When reviewing the captured data, you may want to refile some of the entries
7034 into a different list, for example into a project. Cutting, finding the
7035 right location, and then pasting the note is cumbersome. To simplify this
7036 process, you can use the following special command:
7039 @orgcmd{C-c C-w,org-refile}
7040 @vindex org-reverse-note-order
7041 @vindex org-refile-targets
7042 @vindex org-refile-use-outline-path
7043 @vindex org-outline-path-complete-in-steps
7044 @vindex org-refile-allow-creating-parent-nodes
7045 @vindex org-log-refile
7046 @vindex org-refile-use-cache
7047 Refile the entry or region at point. This command offers possible locations
7048 for refiling the entry and lets you select one with completion. The item (or
7049 all items in the region) is filed below the target heading as a subitem.
7050 Depending on @code{org-reverse-note-order}, it will be either the first or
7052 By default, all level 1 headlines in the current buffer are considered to be
7053 targets, but you can have more complex definitions across a number of files.
7054 See the variable @code{org-refile-targets} for details. If you would like to
7055 select a location via a file-path-like completion along the outline path, see
7056 the variables @code{org-refile-use-outline-path} and
7057 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7058 create new nodes as new parents for refiling on the fly, check the
7059 variable @code{org-refile-allow-creating-parent-nodes}.
7060 When the variable @code{org-log-refile}@footnote{with corresponding
7061 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7062 and @code{nologrefile}} is set, a timestamp or a note will be
7063 recorded when an entry has been refiled.
7064 @orgkey{C-u C-c C-w}
7065 Use the refile interface to jump to a heading.
7066 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7067 Jump to the location where @code{org-refile} last moved a tree to.
7069 Refile as the child of the item currently being clocked.
7070 @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}
7071 Clear the target cache. Caching of refile targets can be turned on by
7072 setting @code{org-refile-use-cache}. To make the command see new possible
7073 targets, you have to clear the cache with this command.
7076 @node Archiving, , Refiling notes, Capture - Refile - Archive
7080 When a project represented by a (sub)tree is finished, you may want
7081 to move the tree out of the way and to stop it from contributing to the
7082 agenda. Archiving is important to keep your working files compact and global
7083 searches like the construction of agenda views fast.
7086 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7087 @vindex org-archive-default-command
7088 Archive the current entry using the command specified in the variable
7089 @code{org-archive-default-command}.
7093 * Moving subtrees:: Moving a tree to an archive file
7094 * Internal archiving:: Switch off a tree but keep it in the file
7097 @node Moving subtrees, Internal archiving, Archiving, Archiving
7098 @subsection Moving a tree to the archive file
7099 @cindex external archiving
7101 The most common archiving action is to move a project tree to another file,
7105 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7106 @vindex org-archive-location
7107 Archive the subtree starting at the cursor position to the location
7108 given by @code{org-archive-location}.
7109 @orgkey{C-u C-c C-x C-s}
7110 Check if any direct children of the current headline could be moved to
7111 the archive. To do this, each subtree is checked for open TODO entries.
7112 If none are found, the command offers to move it to the archive
7113 location. If the cursor is @emph{not} on a headline when this command
7114 is invoked, the level 1 trees will be checked.
7117 @cindex archive locations
7118 The default archive location is a file in the same directory as the
7119 current file, with the name derived by appending @file{_archive} to the
7120 current file name. You can also choose what heading to file archived
7121 items under, with the possibility to add them to a datetree in a file.
7122 For information and examples on how to specify the file and the heading,
7123 see the documentation string of the variable
7124 @code{org-archive-location}.
7126 There is also an in-buffer option for setting this variable, for
7127 example@footnote{For backward compatibility, the following also works:
7128 If there are several such lines in a file, each specifies the archive
7129 location for the text below it. The first such line also applies to any
7130 text before its definition. However, using this method is
7131 @emph{strongly} deprecated as it is incompatible with the outline
7132 structure of the document. The correct method for setting multiple
7133 archive locations in a buffer is using properties.}:
7137 #+ARCHIVE: %s_done::
7140 @cindex property, ARCHIVE
7142 If you would like to have a special ARCHIVE location for a single entry
7143 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7144 location as the value (@pxref{Properties and Columns}).
7146 @vindex org-archive-save-context-info
7147 When a subtree is moved, it receives a number of special properties that
7148 record context information like the file from where the entry came, its
7149 outline path the archiving time etc. Configure the variable
7150 @code{org-archive-save-context-info} to adjust the amount of information
7154 @node Internal archiving, , Moving subtrees, Archiving
7155 @subsection Internal archiving
7157 If you want to just switch off (for agenda views) certain subtrees without
7158 moving them to a different file, you can use the @code{ARCHIVE tag}.
7160 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7161 its location in the outline tree, but behaves in the following way:
7164 @vindex org-cycle-open-archived-trees
7165 It does not open when you attempt to do so with a visibility cycling
7166 command (@pxref{Visibility cycling}). You can force cycling archived
7167 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7168 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7169 @code{show-all} will open archived subtrees.
7171 @vindex org-sparse-tree-open-archived-trees
7172 During sparse tree construction (@pxref{Sparse trees}), matches in
7173 archived subtrees are not exposed, unless you configure the option
7174 @code{org-sparse-tree-open-archived-trees}.
7176 @vindex org-agenda-skip-archived-trees
7177 During agenda view construction (@pxref{Agenda Views}), the content of
7178 archived trees is ignored unless you configure the option
7179 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7180 be included. In the agenda you can press @kbd{v a} to get archives
7181 temporarily included.
7183 @vindex org-export-with-archived-trees
7184 Archived trees are not exported (@pxref{Exporting}), only the headline
7185 is. Configure the details using the variable
7186 @code{org-export-with-archived-trees}.
7188 @vindex org-columns-skip-archived-trees
7189 Archived trees are excluded from column view unless the variable
7190 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7193 The following commands help manage the ARCHIVE tag:
7196 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7197 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7198 the headline changes to a shadowed face, and the subtree below it is
7200 @orgkey{C-u C-c C-x a}
7201 Check if any direct children of the current headline should be archived.
7202 To do this, each subtree is checked for open TODO entries. If none are
7203 found, the command offers to set the ARCHIVE tag for the child. If the
7204 cursor is @emph{not} on a headline when this command is invoked, the
7205 level 1 trees will be checked.
7206 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7207 Cycle a tree even if it is tagged with ARCHIVE.
7208 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7209 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7210 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7211 entry becomes a child of that sibling and in this way retains a lot of its
7212 original context, including inherited tags and approximate position in the
7217 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7218 @chapter Agenda views
7219 @cindex agenda views
7221 Due to the way Org works, TODO items, time-stamped items, and
7222 tagged headlines can be scattered throughout a file or even a number of
7223 files. To get an overview of open action items, or of events that are
7224 important for a particular date, this information must be collected,
7225 sorted and displayed in an organized way.
7227 Org can select items based on various criteria and display them
7228 in a separate buffer. Seven different view types are provided:
7232 an @emph{agenda} that is like a calendar and shows information
7235 a @emph{TODO list} that covers all unfinished
7238 a @emph{match view}, showings headlines based on the tags, properties, and
7239 TODO state associated with them,
7241 a @emph{timeline view} that shows all events in a single Org file,
7242 in time-sorted view,
7244 a @emph{text search view} that shows all entries from multiple files
7245 that contain specified keywords,
7247 a @emph{stuck projects view} showing projects that currently don't move
7250 @emph{custom views} that are special searches and combinations of different
7255 The extracted information is displayed in a special @emph{agenda
7256 buffer}. This buffer is read-only, but provides commands to visit the
7257 corresponding locations in the original Org files, and even to
7258 edit these files remotely.
7260 @vindex org-agenda-window-setup
7261 @vindex org-agenda-restore-windows-after-quit
7262 Two variables control how the agenda buffer is displayed and whether the
7263 window configuration is restored when the agenda exits:
7264 @code{org-agenda-window-setup} and
7265 @code{org-agenda-restore-windows-after-quit}.
7268 * Agenda files:: Files being searched for agenda information
7269 * Agenda dispatcher:: Keyboard access to agenda views
7270 * Built-in agenda views:: What is available out of the box?
7271 * Presentation and sorting:: How agenda items are prepared for display
7272 * Agenda commands:: Remote editing of Org trees
7273 * Custom agenda views:: Defining special searches and views
7274 * Exporting Agenda Views:: Writing a view to a file
7275 * Agenda column view:: Using column view for collected entries
7278 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7279 @section Agenda files
7280 @cindex agenda files
7281 @cindex files for agenda
7283 @vindex org-agenda-files
7284 The information to be shown is normally collected from all @emph{agenda
7285 files}, the files listed in the variable
7286 @code{org-agenda-files}@footnote{If the value of that variable is not a
7287 list, but a single file name, then the list of agenda files will be
7288 maintained in that external file.}. If a directory is part of this list,
7289 all files with the extension @file{.org} in this directory will be part
7292 Thus, even if you only work with a single Org file, that file should
7293 be put into the list@footnote{When using the dispatcher, pressing
7294 @kbd{<} before selecting a command will actually limit the command to
7295 the current file, and ignore @code{org-agenda-files} until the next
7296 dispatcher command.}. You can customize @code{org-agenda-files}, but
7297 the easiest way to maintain it is through the following commands
7299 @cindex files, adding to agenda list
7301 @orgcmd{C-c [,org-agenda-file-to-front}
7302 Add current file to the list of agenda files. The file is added to
7303 the front of the list. If it was already in the list, it is moved to
7304 the front. With a prefix argument, file is added/moved to the end.
7305 @orgcmd{C-c ],org-remove-file}
7306 Remove current file from the list of agenda files.
7308 @cindex cycling, of agenda files
7309 @orgcmd{C-',org-cycle-agenda-files}
7311 Cycle through agenda file list, visiting one file after the other.
7312 @kindex M-x org-iswitchb
7313 @item M-x org-iswitchb
7314 Command to use an @code{iswitchb}-like interface to switch to and between Org
7319 The Org menu contains the current list of files and can be used
7320 to visit any of them.
7322 If you would like to focus the agenda temporarily on a file not in
7323 this list, or on just one file in the list, or even on only a subtree in a
7324 file, then this can be done in different ways. For a single agenda command,
7325 you may press @kbd{<} once or several times in the dispatcher
7326 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7327 extended period, use the following commands:
7330 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7331 Permanently restrict the agenda to the current subtree. When with a
7332 prefix argument, or with the cursor before the first headline in a file,
7333 the agenda scope is set to the entire file. This restriction remains in
7334 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7335 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7336 agenda view, the new restriction takes effect immediately.
7337 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7338 Remove the permanent restriction created by @kbd{C-c C-x <}.
7342 When working with @file{speedbar.el}, you can use the following commands in
7345 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7346 Permanently restrict the agenda to the item---either an Org file or a subtree
7347 in such a file---at the cursor in the Speedbar frame.
7348 If there is a window displaying an agenda view, the new restriction takes
7350 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7351 Lift the restriction.
7354 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7355 @section The agenda dispatcher
7356 @cindex agenda dispatcher
7357 @cindex dispatching agenda commands
7358 The views are created through a dispatcher, which should be bound to a
7359 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7360 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7361 is accessed and list keyboard access to commands accordingly. After
7362 pressing @kbd{C-c a}, an additional letter is required to execute a
7363 command. The dispatcher offers the following default commands:
7366 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7368 Create a list of all TODO items (@pxref{Global TODO list}).
7370 Create a list of headlines matching a TAGS expression (@pxref{Matching
7371 tags and properties}).
7373 Create the timeline view for the current buffer (@pxref{Timeline}).
7375 Create a list of entries selected by a boolean expression of keywords
7376 and/or regular expressions that must or must not occur in the entry.
7378 @vindex org-agenda-text-search-extra-files
7379 Search for a regular expression in all agenda files and additionally in
7380 the files listed in @code{org-agenda-text-search-extra-files}. This
7381 uses the Emacs command @code{multi-occur}. A prefix argument can be
7382 used to specify the number of context lines for each match, default is
7385 Create a list of stuck projects (@pxref{Stuck projects}).
7387 Restrict an agenda command to the current buffer@footnote{For backward
7388 compatibility, you can also press @kbd{1} to restrict to the current
7389 buffer.}. After pressing @kbd{<}, you still need to press the character
7390 selecting the command.
7392 If there is an active region, restrict the following agenda command to
7393 the region. Otherwise, restrict it to the current subtree@footnote{For
7394 backward compatibility, you can also press @kbd{0} to restrict to the
7395 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7396 character selecting the command.
7399 @vindex org-agenda-sticky
7400 Toggle sticky agenda views. By default, Org maintains only a single agenda
7401 buffer and rebuilds it each time you change the view, to make sure everything
7402 is always up to date. If you switch between views often and the build time
7403 bothers you, you can turn on sticky agenda buffers (make this the default by
7404 customizing the variable @code{org-agenda-sticky}). With sticky agendas, the
7405 dispatcher only switches to the selected view, you need to update it by hand
7406 with @kbd{r} or @kbd{g}.
7409 You can also define custom commands that will be accessible through the
7410 dispatcher, just like the default commands. This includes the
7411 possibility to create extended agenda buffers that contain several
7412 blocks together, for example the weekly agenda, the global TODO list and
7413 a number of special tags matches. @xref{Custom agenda views}.
7415 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7416 @section The built-in agenda views
7418 In this section we describe the built-in views.
7421 * Weekly/daily agenda:: The calendar page with current tasks
7422 * Global TODO list:: All unfinished action items
7423 * Matching tags and properties:: Structured information with fine-tuned search
7424 * Timeline:: Time-sorted view for single file
7425 * Search view:: Find entries by searching for text
7426 * Stuck projects:: Find projects you need to review
7429 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7430 @subsection The weekly/daily agenda
7432 @cindex weekly agenda
7433 @cindex daily agenda
7435 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7436 paper agenda, showing all the tasks for the current week or day.
7439 @cindex org-agenda, command
7440 @orgcmd{C-c a a,org-agenda-list}
7441 Compile an agenda for the current week from a list of Org files. The agenda
7442 shows the entries for each day. With a numeric prefix@footnote{For backward
7443 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7444 listed before the agenda. This feature is deprecated, use the dedicated TODO
7445 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7446 C-c a a}) you may set the number of days to be displayed.
7449 @vindex org-agenda-span
7450 @vindex org-agenda-ndays
7451 The default number of days displayed in the agenda is set by the variable
7452 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7453 variable can be set to any number of days you want to see by default in the
7454 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7457 Remote editing from the agenda buffer means, for example, that you can
7458 change the dates of deadlines and appointments from the agenda buffer.
7459 The commands available in the Agenda buffer are listed in @ref{Agenda
7462 @subsubheading Calendar/Diary integration
7463 @cindex calendar integration
7464 @cindex diary integration
7466 Emacs contains the calendar and diary by Edward M. Reingold. The
7467 calendar displays a three-month calendar with holidays from different
7468 countries and cultures. The diary allows you to keep track of
7469 anniversaries, lunar phases, sunrise/set, recurrent appointments
7470 (weekly, monthly) and more. In this way, it is quite complementary to
7471 Org. It can be very useful to combine output from Org with
7474 In order to include entries from the Emacs diary into Org mode's
7475 agenda, you only need to customize the variable
7478 (setq org-agenda-include-diary t)
7481 @noindent After that, everything will happen automatically. All diary
7482 entries including holidays, anniversaries, etc., will be included in the
7483 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7484 @key{RET} can be used from the agenda buffer to jump to the diary
7485 file in order to edit existing diary entries. The @kbd{i} command to
7486 insert new entries for the current date works in the agenda buffer, as
7487 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7488 Sunrise/Sunset times, show lunar phases and to convert to other
7489 calendars, respectively. @kbd{c} can be used to switch back and forth
7490 between calendar and agenda.
7492 If you are using the diary only for sexp entries and holidays, it is
7493 faster to not use the above setting, but instead to copy or even move
7494 the entries into an Org file. Org mode evaluates diary-style sexp
7495 entries, and does it faster because there is no overhead for first
7496 creating the diary display. Note that the sexp entries must start at
7497 the left margin, no whitespace is allowed before them. For example,
7498 the following segment of an Org file will be processed and entries
7499 will be made in the agenda:
7502 * Birthdays and similar stuff
7504 %%(org-calendar-holiday) ; special function for holiday names
7506 %%(org-anniversary 1956 5 14)@footnote{@code{org-anniversary} is just like @code{diary-anniversary}, but the argument order is always according to ISO and therefore independent of the value of @code{calendar-date-style}.} Arthur Dent is %d years old
7507 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7510 @subsubheading Anniversaries from BBDB
7511 @cindex BBDB, anniversaries
7512 @cindex anniversaries, from BBDB
7514 If you are using the Big Brothers Database to store your contacts, you will
7515 very likely prefer to store anniversaries in BBDB rather than in a
7516 separate Org or diary file. Org supports this and will show BBDB
7517 anniversaries as part of the agenda. All you need to do is to add the
7518 following to one of your agenda files:
7525 %%(org-bbdb-anniversaries)
7528 You can then go ahead and define anniversaries for a BBDB record. Basically,
7529 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7530 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7531 followed by a space and the class of the anniversary (@samp{birthday} or
7532 @samp{wedding}, or a format string). If you omit the class, it will default to
7533 @samp{birthday}. Here are a few examples, the header for the file
7534 @file{org-bbdb.el} contains more detailed information.
7540 2008-04-14 %s released version 6.01 of org mode, %d years ago
7543 After a change to BBDB, or for the first agenda display during an Emacs
7544 session, the agenda display will suffer a short delay as Org updates its
7545 hash with anniversaries. However, from then on things will be very fast---much
7546 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7547 in an Org or Diary file.
7549 @subsubheading Appointment reminders
7550 @cindex @file{appt.el}
7551 @cindex appointment reminders
7555 Org can interact with Emacs appointments notification facility. To add the
7556 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7557 This command lets you filter through the list of your appointments and add
7558 only those belonging to a specific category or matching a regular expression.
7559 It also reads a @code{APPT_WARNTIME} property which will then override the
7560 value of @code{appt-message-warning-time} for this appointment. See the
7561 docstring for details.
7563 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7564 @subsection The global TODO list
7565 @cindex global TODO list
7566 @cindex TODO list, global
7568 The global TODO list contains all unfinished TODO items formatted and
7569 collected into a single place.
7572 @orgcmd{C-c a t,org-todo-list}
7573 Show the global TODO list. This collects the TODO items from all agenda
7574 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7575 items with a state the is not a DONE state. The buffer is in
7576 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7577 entries directly from that buffer (@pxref{Agenda commands}).
7578 @orgcmd{C-c a T,org-todo-list}
7579 @cindex TODO keyword matching
7580 @vindex org-todo-keywords
7581 Like the above, but allows selection of a specific TODO keyword. You can
7582 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7583 prompted for a keyword, and you may also specify several keywords by
7584 separating them with @samp{|} as the boolean OR operator. With a numeric
7585 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7587 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7588 a prefix argument to this command to change the selected TODO keyword,
7589 for example @kbd{3 r}. If you often need a search for a specific
7590 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7591 Matching specific TODO keywords can also be done as part of a tags
7592 search (@pxref{Tag searches}).
7595 Remote editing of TODO items means that you can change the state of a
7596 TODO entry with a single key press. The commands available in the
7597 TODO list are described in @ref{Agenda commands}.
7599 @cindex sublevels, inclusion into TODO list
7600 Normally the global TODO list simply shows all headlines with TODO
7601 keywords. This list can become very long. There are two ways to keep
7605 @vindex org-agenda-todo-ignore-scheduled
7606 @vindex org-agenda-todo-ignore-deadlines
7607 @vindex org-agenda-todo-ignore-timestamp
7608 @vindex org-agenda-todo-ignore-with-date
7609 Some people view a TODO item that has been @emph{scheduled} for execution or
7610 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7611 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7612 @code{org-agenda-todo-ignore-deadlines},
7613 @code{org-agenda-todo-ignore-timestamp} and/or
7614 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7617 @vindex org-agenda-todo-list-sublevels
7618 TODO items may have sublevels to break up the task into subtasks. In
7619 such cases it may be enough to list only the highest level TODO headline
7620 and omit the sublevels from the global list. Configure the variable
7621 @code{org-agenda-todo-list-sublevels} to get this behavior.
7624 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7625 @subsection Matching tags and properties
7626 @cindex matching, of tags
7627 @cindex matching, of properties
7631 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7632 or have properties (@pxref{Properties and Columns}), you can select headlines
7633 based on this metadata and collect them into an agenda buffer. The match
7634 syntax described here also applies when creating sparse trees with @kbd{C-c /
7638 @orgcmd{C-c a m,org-tags-view}
7639 Produce a list of all headlines that match a given set of tags. The
7640 command prompts for a selection criterion, which is a boolean logic
7641 expression with tags, like @samp{+work+urgent-withboss} or
7642 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7643 define a custom command for it (@pxref{Agenda dispatcher}).
7644 @orgcmd{C-c a M,org-tags-view}
7645 @vindex org-tags-match-list-sublevels
7646 @vindex org-agenda-tags-todo-honor-ignore-options
7647 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7648 not-DONE state and force checking subitems (see variable
7649 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7650 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7651 specific TODO keywords together with a tags match is also possible, see
7655 The commands available in the tags list are described in @ref{Agenda
7658 @subsubheading Match syntax
7660 @cindex Boolean logic, for tag/property searches
7661 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7662 OR. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7663 not implemented. Each element in the search is either a tag, a regular
7664 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7665 VALUE} with a comparison operator, accessing a property value. Each element
7666 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7667 sugar for positive selection. The AND operator @samp{&} is optional when
7668 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7672 Select headlines tagged @samp{:work:}, but discard those also tagged
7675 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7676 @item work|laptop+night
7677 Like before, but require the @samp{:laptop:} lines to be tagged also
7681 @cindex regular expressions, with tags search
7682 Instead of a tag, you may also specify a regular expression enclosed in curly
7683 braces. For example,
7684 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7685 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7687 @cindex TODO keyword matching, with tags search
7688 @cindex level, require for tags/property match
7689 @cindex category, require for tags/property match
7690 @vindex org-odd-levels-only
7691 You may also test for properties (@pxref{Properties and Columns}) at the same
7692 time as matching tags. The properties may be real properties, or special
7693 properties that represent other metadata (@pxref{Special properties}). For
7694 example, the ``property'' @code{TODO} represents the TODO keyword of the
7695 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7696 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7697 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7698 DONE. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7699 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7700 The ITEM special property cannot currently be used in tags/property
7701 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
7702 ,skipping entries based on regexp}.}.
7704 Here are more examples:
7706 @item work+TODO="WAITING"
7707 Select @samp{:work:}-tagged TODO lines with the specific TODO
7708 keyword @samp{WAITING}.
7709 @item work+TODO="WAITING"|home+TODO="WAITING"
7710 Waiting tasks both at work and at home.
7713 When matching properties, a number of different operators can be used to test
7714 the value of a property. Here is a complex example:
7717 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7718 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7722 The type of comparison will depend on how the comparison value is written:
7725 If the comparison value is a plain number, a numerical comparison is done,
7726 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7727 @samp{>=}, and @samp{<>}.
7729 If the comparison value is enclosed in double-quotes,
7730 a string comparison is done, and the same operators are allowed.
7732 If the comparison value is enclosed in double-quotes @emph{and} angular
7733 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7734 assumed to be date/time specifications in the standard Org way, and the
7735 comparison will be done accordingly. Special values that will be recognized
7736 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7737 @code{"<tomorrow>"} for these days at 0:00 hours, i.e.@: without a time
7738 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7739 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7740 respectively, can be used.
7742 If the comparison value is enclosed
7743 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7744 regexp matches the property value, and @samp{<>} meaning that it does not
7748 So the search string in the example finds entries tagged @samp{:work:} but
7749 not @samp{:boss:}, which also have a priority value @samp{A}, a
7750 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7751 property that is numerically smaller than 2, a @samp{:With:} property that is
7752 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7753 on or after October 11, 2008.
7755 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7756 other properties will slow down the search. However, once you have paid the
7757 price by accessing one property, testing additional properties is cheap
7760 You can configure Org mode to use property inheritance during a search, but
7761 beware that this can slow down searches considerably. See @ref{Property
7762 inheritance}, for details.
7764 For backward compatibility, and also for typing speed, there is also a
7765 different way to test TODO states in a search. For this, terminate the
7766 tags/property part of the search string (which may include several terms
7767 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7768 expression just for TODO keywords. The syntax is then similar to that for
7769 tags, but should be applied with care: for example, a positive selection on
7770 several TODO keywords cannot meaningfully be combined with boolean AND.
7771 However, @emph{negative selection} combined with AND can be meaningful. To
7772 make sure that only lines are checked that actually have any TODO keyword
7773 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7774 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7775 not match TODO keywords in a DONE state. Examples:
7779 Same as @samp{work+TODO="WAITING"}
7780 @item work/!-WAITING-NEXT
7781 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7783 @item work/!+WAITING|+NEXT
7784 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7788 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7789 @subsection Timeline for a single file
7790 @cindex timeline, single file
7791 @cindex time-sorted view
7793 The timeline summarizes all time-stamped items from a single Org mode
7794 file in a @emph{time-sorted view}. The main purpose of this command is
7795 to give an overview over events in a project.
7798 @orgcmd{C-c a L,org-timeline}
7799 Show a time-sorted view of the Org file, with all time-stamped items.
7800 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7801 (scheduled or not) are also listed under the current date.
7805 The commands available in the timeline buffer are listed in
7806 @ref{Agenda commands}.
7808 @node Search view, Stuck projects, Timeline, Built-in agenda views
7809 @subsection Search view
7812 @cindex searching, for text
7814 This agenda view is a general text search facility for Org mode entries.
7815 It is particularly useful to find notes.
7818 @orgcmd{C-c a s,org-search-view}
7819 This is a special search that lets you select entries by matching a substring
7820 or specific words using a boolean logic.
7822 For example, the search string @samp{computer equipment} will find entries
7823 that contain @samp{computer equipment} as a substring. If the two words are
7824 separated by more space or a line break, the search will still match.
7825 Search view can also search for specific keywords in the entry, using Boolean
7826 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7827 will search for note entries that contain the keywords @code{computer}
7828 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7829 not matched by the regular expression @code{8\.11[bg]}, meaning to
7830 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7831 word search, other @samp{+} characters are optional. For more details, see
7832 the docstring of the command @code{org-search-view}.
7834 @vindex org-agenda-text-search-extra-files
7835 Note that in addition to the agenda files, this command will also search
7836 the files listed in @code{org-agenda-text-search-extra-files}.
7838 @node Stuck projects, , Search view, Built-in agenda views
7839 @subsection Stuck projects
7840 @pindex GTD, Getting Things Done
7842 If you are following a system like David Allen's GTD to organize your
7843 work, one of the ``duties'' you have is a regular review to make sure
7844 that all projects move along. A @emph{stuck} project is a project that
7845 has no defined next actions, so it will never show up in the TODO lists
7846 Org mode produces. During the review, you need to identify such
7847 projects and define next actions for them.
7850 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7851 List projects that are stuck.
7854 @vindex org-stuck-projects
7855 Customize the variable @code{org-stuck-projects} to define what a stuck
7856 project is and how to find it.
7859 You almost certainly will have to configure this view before it will
7860 work for you. The built-in default assumes that all your projects are
7861 level-2 headlines, and that a project is not stuck if it has at least
7862 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7864 Let's assume that you, in your own way of using Org mode, identify
7865 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7866 indicate a project that should not be considered yet. Let's further
7867 assume that the TODO keyword DONE marks finished projects, and that NEXT
7868 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7869 is a next action even without the NEXT tag. Finally, if the project
7870 contains the special word IGNORE anywhere, it should not be listed
7871 either. In this case you would start by identifying eligible projects
7872 with a tags/todo match@footnote{@xref{Tag searches}.}
7873 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7874 IGNORE in the subtree to identify projects that are not stuck. The
7875 correct customization for this is
7878 (setq org-stuck-projects
7879 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7883 Note that if a project is identified as non-stuck, the subtree of this entry
7884 will still be searched for stuck projects.
7886 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7887 @section Presentation and sorting
7888 @cindex presentation, of agenda items
7890 @vindex org-agenda-prefix-format
7891 @vindex org-agenda-tags-column
7892 Before displaying items in an agenda view, Org mode visually prepares the
7893 items and sorts them. Each item occupies a single line. The line starts
7894 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
7895 of the item and other important information. You can customize in which
7896 column tags will be displayed through @code{org-agenda-tags-column}. You can
7897 also customize the prefix using the option @code{org-agenda-prefix-format}.
7898 This prefix is followed by a cleaned-up version of the outline headline
7899 associated with the item.
7902 * Categories:: Not all tasks are equal
7903 * Time-of-day specifications:: How the agenda knows the time
7904 * Sorting of agenda items:: The order of things
7907 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7908 @subsection Categories
7912 The category is a broad label assigned to each agenda item. By default,
7913 the category is simply derived from the file name, but you can also
7914 specify it with a special line in the buffer, like this@footnote{For
7915 backward compatibility, the following also works: if there are several
7916 such lines in a file, each specifies the category for the text below it.
7917 The first category also applies to any text before the first CATEGORY
7918 line. However, using this method is @emph{strongly} deprecated as it is
7919 incompatible with the outline structure of the document. The correct
7920 method for setting multiple categories in a buffer is using a
7928 @cindex property, CATEGORY
7929 If you would like to have a special CATEGORY for a single entry or a
7930 (sub)tree, give the entry a @code{:CATEGORY:} property with the
7931 special category you want to apply as the value.
7934 The display in the agenda buffer looks best if the category is not
7935 longer than 10 characters.
7938 You can set up icons for category by customizing the
7939 @code{org-agenda-category-icon-alist} variable.
7941 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
7942 @subsection Time-of-day specifications
7943 @cindex time-of-day specification
7945 Org mode checks each agenda item for a time-of-day specification. The
7946 time can be part of the timestamp that triggered inclusion into the
7947 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
7948 ranges can be specified with two timestamps, like
7950 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
7952 In the headline of the entry itself, a time(range) may also appear as
7953 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
7954 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
7955 specifications in diary entries are recognized as well.
7957 For agenda display, Org mode extracts the time and displays it in a
7958 standard 24 hour format as part of the prefix. The example times in
7959 the previous paragraphs would end up in the agenda like this:
7962 8:30-13:00 Arthur Dent lies in front of the bulldozer
7963 12:45...... Ford Prefect arrives and takes Arthur to the pub
7964 19:00...... The Vogon reads his poem
7965 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7969 If the agenda is in single-day mode, or for the display of today, the
7970 timed entries are embedded in a time grid, like
7973 8:00...... ------------------
7974 8:30-13:00 Arthur Dent lies in front of the bulldozer
7975 10:00...... ------------------
7976 12:00...... ------------------
7977 12:45...... Ford Prefect arrives and takes Arthur to the pub
7978 14:00...... ------------------
7979 16:00...... ------------------
7980 18:00...... ------------------
7981 19:00...... The Vogon reads his poem
7982 20:00...... ------------------
7983 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
7986 @vindex org-agenda-use-time-grid
7987 @vindex org-agenda-time-grid
7988 The time grid can be turned on and off with the variable
7989 @code{org-agenda-use-time-grid}, and can be configured with
7990 @code{org-agenda-time-grid}.
7992 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
7993 @subsection Sorting of agenda items
7994 @cindex sorting, of agenda items
7995 @cindex priorities, of agenda items
7996 Before being inserted into a view, the items are sorted. How this is
7997 done depends on the type of view.
8000 @vindex org-agenda-files
8001 For the daily/weekly agenda, the items for each day are sorted. The
8002 default order is to first collect all items containing an explicit
8003 time-of-day specification. These entries will be shown at the beginning
8004 of the list, as a @emph{schedule} for the day. After that, items remain
8005 grouped in categories, in the sequence given by @code{org-agenda-files}.
8006 Within each category, items are sorted by priority (@pxref{Priorities}),
8007 which is composed of the base priority (2000 for priority @samp{A}, 1000
8008 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8009 overdue scheduled or deadline items.
8011 For the TODO list, items remain in the order of categories, but within
8012 each category, sorting takes place according to priority
8013 (@pxref{Priorities}). The priority used for sorting derives from the
8014 priority cookie, with additions depending on how close an item is to its due
8017 For tags matches, items are not sorted at all, but just appear in the
8018 sequence in which they are found in the agenda files.
8021 @vindex org-agenda-sorting-strategy
8022 Sorting can be customized using the variable
8023 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8024 the estimated effort of an entry (@pxref{Effort estimates}).
8026 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
8027 @section Commands in the agenda buffer
8028 @cindex commands, in agenda buffer
8030 Entries in the agenda buffer are linked back to the Org file or diary
8031 file where they originate. You are not allowed to edit the agenda
8032 buffer itself, but commands are provided to show and jump to the
8033 original entry location, and to edit the Org files ``remotely'' from
8034 the agenda buffer. In this way, all information is stored only once,
8035 removing the risk that your agenda and note files may diverge.
8037 Some commands can be executed with mouse clicks on agenda lines. For
8038 the other commands, the cursor needs to be in the desired line.
8041 @tsubheading{Motion}
8042 @cindex motion commands in agenda
8043 @orgcmd{n,org-agenda-next-line}
8044 Next line (same as @key{down} and @kbd{C-n}).
8045 @orgcmd{p,org-agenda-previous-line}
8046 Previous line (same as @key{up} and @kbd{C-p}).
8047 @tsubheading{View/Go to Org file}
8048 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8049 Display the original location of the item in another window.
8050 With prefix arg, make sure that the entire entry is made visible in the
8051 outline, not only the heading.
8053 @orgcmd{L,org-agenda-recenter}
8054 Display original location and recenter that window.
8056 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8057 Go to the original location of the item in another window.
8059 @orgcmd{@key{RET},org-agenda-switch-to}
8060 Go to the original location of the item and delete other windows.
8062 @orgcmd{F,org-agenda-follow-mode}
8063 @vindex org-agenda-start-with-follow-mode
8064 Toggle Follow mode. In Follow mode, as you move the cursor through
8065 the agenda buffer, the other window always shows the corresponding
8066 location in the Org file. The initial setting for this mode in new
8067 agenda buffers can be set with the variable
8068 @code{org-agenda-start-with-follow-mode}.
8070 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8071 Display the entire subtree of the current item in an indirect buffer. With a
8072 numeric prefix argument N, go up to level N and then take that tree. If N is
8073 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8074 previously used indirect buffer.
8076 @orgcmd{C-c C-o,org-agenda-open-link}
8077 Follow a link in the entry. This will offer a selection of any links in the
8078 text belonging to the referenced Org node. If there is only one link, it
8079 will be followed without a selection prompt.
8081 @tsubheading{Change display}
8082 @cindex display changing, in agenda
8085 Interactively select another agenda view and append it to the current view.
8089 Delete other windows.
8091 @orgcmdkskc{v d,d,org-agenda-day-view}
8092 @xorgcmdkskc{v w,w,org-agenda-week-view}
8093 @xorgcmd{v m,org-agenda-month-view}
8094 @xorgcmd{v y,org-agenda-year-view}
8095 @xorgcmd{v SPC,org-agenda-reset-view}
8096 @vindex org-agenda-span
8097 Switch to day/week/month/year view. When switching to day or week view, this
8098 setting becomes the default for subsequent agenda refreshes. Since month and
8099 year views are slow to create, they do not become the default. A numeric
8100 prefix argument may be used to jump directly to a specific day of the year,
8101 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8102 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8103 month view, a year may be encoded in the prefix argument as well. For
8104 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8105 specification has only one or two digits, it will be mapped to the interval
8106 1938-2037. @kbd{v @key{SPC}} will reset to what is set in
8107 @code{org-agenda-span}.
8109 @orgcmd{f,org-agenda-later}
8110 Go forward in time to display the following @code{org-agenda-current-span} days.
8111 For example, if the display covers a week, switch to the following week.
8112 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8114 @orgcmd{b,org-agenda-earlier}
8115 Go backward in time to display earlier dates.
8117 @orgcmd{.,org-agenda-goto-today}
8120 @orgcmd{j,org-agenda-goto-date}
8121 Prompt for a date and go there.
8123 @orgcmd{J,org-agenda-clock-goto}
8124 Go to the currently clocked-in task @i{in the agenda buffer}.
8126 @orgcmd{D,org-agenda-toggle-diary}
8127 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8129 @orgcmdkskc{v l,l,org-agenda-log-mode}
8131 @vindex org-log-done
8132 @vindex org-agenda-log-mode-items
8133 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8134 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8135 entries that have been clocked on that day. You can configure the entry
8136 types that should be included in log mode using the variable
8137 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8138 all possible logbook entries, including state changes. When called with two
8139 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
8140 @kbd{v L} is equivalent to @kbd{C-u v l}.
8142 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8143 Include inactive timestamps into the current view. Only for weekly/daily
8144 agenda and timeline views.
8146 @orgcmd{v a,org-agenda-archives-mode}
8147 @xorgcmd{v A,org-agenda-archives-mode 'files}
8148 Toggle Archives mode. In Archives mode, trees that are marked
8149 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8150 capital @kbd{A}, even all archive files are included. To exit archives mode,
8151 press @kbd{v a} again.
8153 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8154 @vindex org-agenda-start-with-clockreport-mode
8155 @vindex org-clock-report-include-clocking-task
8156 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8157 always show a table with the clocked times for the timespan and file scope
8158 covered by the current agenda view. The initial setting for this mode in new
8159 agenda buffers can be set with the variable
8160 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8161 when toggling this mode (i.e.@: @kbd{C-u R}), the clock table will not show
8162 contributions from entries that are hidden by agenda filtering@footnote{Only
8163 tags filtering will be respected here, effort filtering is ignored.}. See
8164 also the variable @code{org-clock-report-include-clocking-task}.
8167 @vindex org-agenda-clock-consistency-checks
8168 Show overlapping clock entries, clocking gaps, and other clocking problems in
8169 the current agenda range. You can then visit clocking lines and fix them
8170 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8171 information on how to customize the definition of what constituted a clocking
8172 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8175 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8176 @vindex org-agenda-start-with-entry-text-mode
8177 @vindex org-agenda-entry-text-maxlines
8178 Toggle entry text mode. In entry text mode, a number of lines from the Org
8179 outline node referenced by an agenda line will be displayed below the line.
8180 The maximum number of lines is given by the variable
8181 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8182 prefix argument will temporarily modify that number to the prefix value.
8184 @orgcmd{G,org-agenda-toggle-time-grid}
8185 @vindex org-agenda-use-time-grid
8186 @vindex org-agenda-time-grid
8187 Toggle the time grid on and off. See also the variables
8188 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8190 @orgcmd{r,org-agenda-redo}
8191 Recreate the agenda buffer, for example to reflect the changes after
8192 modification of the timestamps of items with @kbd{S-@key{left}} and
8193 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8194 argument is interpreted to create a selective list for a specific TODO
8196 @orgcmd{g,org-agenda-redo}
8199 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8200 Save all Org buffers in the current Emacs session, and also the locations of
8203 @orgcmd{C-c C-x C-c,org-agenda-columns}
8204 @vindex org-columns-default-format
8205 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8206 view format is taken from the entry at point, or (if there is no entry at
8207 point), from the first entry in the agenda view. So whatever the format for
8208 that entry would be in the original buffer (taken from a property, from a
8209 @code{#+COLUMNS} line, or from the default variable
8210 @code{org-columns-default-format}), will be used in the agenda.
8212 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8213 Remove the restriction lock on the agenda, if it is currently restricted to a
8214 file or subtree (@pxref{Agenda files}).
8216 @tsubheading{Secondary filtering and query editing}
8217 @cindex filtering, by tag category and effort, in agenda
8218 @cindex tag filtering, in agenda
8219 @cindex category filtering, in agenda
8220 @cindex effort filtering, in agenda
8221 @cindex query editing, in agenda
8223 @orgcmd{<,org-agenda-filter-by-category}
8224 @vindex org-agenda-category-filter-preset
8226 Filter the current agenda view with respect to the category of the item at
8227 point. Pressing @code{<} another time will remove this filter. You can add
8228 a filter preset through the option @code{org-agenda-category-filter-preset}
8231 @orgcmd{/,org-agenda-filter-by-tag}
8232 @vindex org-agenda-tag-filter-preset
8233 Filter the current agenda view with respect to a tag and/or effort estimates.
8234 The difference between this and a custom agenda command is that filtering is
8235 very fast, so that you can switch quickly between different filters without
8236 having to recreate the agenda.@footnote{Custom commands can preset a filter by
8237 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8238 filter will then be applied to the view and persist as a basic filter through
8239 refreshes and more secondary filtering. The filter is a global property of
8240 the entire agenda view---in a block agenda, you should only set this in the
8241 global options section, not in the section of an individual block.}
8243 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8244 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8245 tag (including any tags that do not have a selection character). The command
8246 then hides all entries that do not contain or inherit this tag. When called
8247 with prefix arg, remove the entries that @emph{do} have the tag. A second
8248 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8249 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8250 will be narrowed by requiring or forbidding the selected additional tag.
8251 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8252 immediately use the @kbd{\} command.
8254 @vindex org-sort-agenda-noeffort-is-high
8255 In order to filter for effort estimates, you should set up allowed
8256 efforts globally, for example
8258 (setq org-global-properties
8259 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8261 You can then filter for an effort by first typing an operator, one of
8262 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8263 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8264 The filter will then restrict to entries with effort smaller-or-equal, equal,
8265 or larger-or-equal than the selected value. If the digits 0-9 are not used
8266 as fast access keys to tags, you can also simply press the index digit
8267 directly without an operator. In this case, @kbd{<} will be assumed. For
8268 application of the operator, entries without a defined effort will be treated
8269 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
8270 for tasks without effort definition, press @kbd{?} as the operator.
8272 Org also supports automatic, context-aware tag filtering. If the variable
8273 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8274 that function can decide which tags should be excluded from the agenda
8275 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8276 as a sub-option key and runs the auto exclusion logic. For example, let's
8277 say you use a @code{Net} tag to identify tasks which need network access, an
8278 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8279 calls. You could auto-exclude these tags based on the availability of the
8280 Internet, and outside of business hours, with something like this:
8284 (defun org-my-auto-exclude-function (tag)
8286 ((string= tag "Net")
8287 (/= 0 (call-process "/sbin/ping" nil nil nil
8288 "-c1" "-q" "-t1" "mail.gnu.org")))
8289 ((or (string= tag "Errand") (string= tag "Call"))
8290 (let ((hour (nth 2 (decode-time))))
8291 (or (< hour 8) (> hour 21)))))
8294 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8298 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8299 Narrow the current agenda filter by an additional condition. When called with
8300 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8301 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8302 @kbd{-} as the first key after the @kbd{/} command.
8311 @item @r{in} search view
8312 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8313 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8314 add a positive search term prefixed by @samp{+}, indicating that this search
8315 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8316 negative search term which @i{must not} occur/match in the entry for it to be
8320 @tsubheading{Remote editing}
8321 @cindex remote editing, from agenda
8326 @cindex undoing remote-editing events
8327 @cindex remote editing, undo
8328 @orgcmd{C-_,org-agenda-undo}
8329 Undo a change due to a remote editing command. The change is undone
8330 both in the agenda buffer and in the remote buffer.
8332 @orgcmd{t,org-agenda-todo}
8333 Change the TODO state of the item, both in the agenda and in the
8336 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8337 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8338 Switch to the next/previous set of TODO keywords.
8340 @orgcmd{C-k,org-agenda-kill}
8341 @vindex org-agenda-confirm-kill
8342 Delete the current agenda item along with the entire subtree belonging
8343 to it in the original Org file. If the text to be deleted remotely
8344 is longer than one line, the kill needs to be confirmed by the user. See
8345 variable @code{org-agenda-confirm-kill}.
8347 @orgcmd{C-c C-w,org-agenda-refile}
8348 Refile the entry at point.
8350 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8351 @vindex org-archive-default-command
8352 Archive the subtree corresponding to the entry at point using the default
8353 archiving command set in @code{org-archive-default-command}. When using the
8354 @code{a} key, confirmation will be required.
8356 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8357 Toggle the ARCHIVE tag for the current headline.
8359 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8360 Move the subtree corresponding to the current entry to its @emph{archive
8363 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8364 Archive the subtree corresponding to the current headline. This means the
8365 entry will be moved to the configured archive location, most likely a
8368 @orgcmd{T,org-agenda-show-tags}
8369 @vindex org-agenda-show-inherited-tags
8370 Show all tags associated with the current item. This is useful if you have
8371 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8372 tags of a headline occasionally.
8374 @orgcmd{:,org-agenda-set-tags}
8375 Set tags for the current headline. If there is an active region in the
8376 agenda, change a tag for all headings in the region.
8380 Set the priority for the current item (@command{org-agenda-priority}).
8381 Org mode prompts for the priority character. If you reply with @key{SPC},
8382 the priority cookie is removed from the entry.
8384 @orgcmd{P,org-agenda-show-priority}
8385 Display weighted priority of current item.
8387 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8388 Increase the priority of the current item. The priority is changed in
8389 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8392 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8393 Decrease the priority of the current item.
8395 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8396 @vindex org-log-into-drawer
8397 Add a note to the entry. This note will be recorded, and then filed to the
8398 same location where state change notes are put. Depending on
8399 @code{org-log-into-drawer}, this may be inside a drawer.
8401 @orgcmd{C-c C-a,org-attach}
8402 Dispatcher for all command related to attachments.
8404 @orgcmd{C-c C-s,org-agenda-schedule}
8405 Schedule this item. With prefix arg remove the scheduling timestamp
8407 @orgcmd{C-c C-d,org-agenda-deadline}
8408 Set a deadline for this item. With prefix arg remove the deadline.
8410 @orgcmd{k,org-agenda-action}
8411 Agenda actions, to set dates for selected items to the cursor date.
8412 This command also works in the calendar! The command prompts for an
8415 m @r{Mark the entry at point for action. You can also make entries}
8416 @r{in Org files with @kbd{C-c C-x C-k}.}
8417 d @r{Set the deadline of the marked entry to the date at point.}
8418 s @r{Schedule the marked entry at the date at point.}
8419 r @r{Call @code{org-capture} with the cursor date as default date.}
8422 Press @kbd{r} afterward to refresh the agenda and see the effect of the
8425 @orgcmd{S-@key{right},org-agenda-do-date-later}
8426 Change the timestamp associated with the current line by one day into the
8427 future. If the date is in the past, the first call to this command will move
8429 With a numeric prefix argument, change it by that many days. For example,
8430 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8431 change the time by one hour. If you immediately repeat the command, it will
8432 continue to change hours even without the prefix arg. With a double @kbd{C-u
8433 C-u} prefix, do the same for changing minutes.@*
8434 The stamp is changed in the original Org file, but the change is not directly
8435 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8437 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8438 Change the timestamp associated with the current line by one day
8441 @orgcmd{>,org-agenda-date-prompt}
8442 Change the timestamp associated with the current line. The key @kbd{>} has
8443 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8445 @orgcmd{I,org-agenda-clock-in}
8446 Start the clock on the current item. If a clock is running already, it
8449 @orgcmd{O,org-agenda-clock-out}
8450 Stop the previously started clock.
8452 @orgcmd{X,org-agenda-clock-cancel}
8453 Cancel the currently running clock.
8455 @orgcmd{J,org-agenda-clock-goto}
8456 Jump to the running clock in another window.
8458 @tsubheading{Bulk remote editing selected entries}
8459 @cindex remote editing, bulk, from agenda
8460 @vindex org-agenda-bulk-persistent-marks
8461 @vindex org-agenda-bulk-custom-functions
8463 @orgcmd{m,org-agenda-bulk-mark}
8464 Mark the entry at point for bulk action. With prefix arg, mark that many
8467 @orgcmd{%,org-agenda-bulk-mark-regexp}
8468 Mark entries matching a regular expression for bulk action.
8470 @orgcmd{u,org-agenda-bulk-unmark}
8471 Unmark entry for bulk action.
8473 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8474 Unmark all marked entries for bulk action.
8476 @orgcmd{B,org-agenda-bulk-action}
8477 Bulk action: act on all marked entries in the agenda. This will prompt for
8478 another key to select the action to be applied. The prefix arg to @kbd{B}
8479 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8480 these special timestamps. By default, marks are removed after the bulk. If
8481 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
8482 @code{t} or hit @kbd{p} at the prompt.
8485 r @r{Prompt for a single refile target and move all entries. The entries}
8486 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8487 $ @r{Archive all selected entries.}
8488 A @r{Archive entries by moving them to their respective archive siblings.}
8489 t @r{Change TODO state. This prompts for a single TODO keyword and}
8490 @r{changes the state of all selected entries, bypassing blocking and}
8491 @r{suppressing logging notes (but not timestamps).}
8492 + @r{Add a tag to all selected entries.}
8493 - @r{Remove a tag from all selected entries.}
8494 s @r{Schedule all items to a new date. To shift existing schedule dates}
8495 @r{by a fixed number of days, use something starting with double plus}
8496 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8497 S @r{Reschedule randomly into the coming N days. N will be prompted for.}
8498 @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
8499 d @r{Set deadline to a specific date.}
8500 f @r{Apply a function@footnote{You can also create persistent custom functions through@code{org-agenda-bulk-custom-functions}.} to marked entries.}
8501 @r{For example, the function below sets the CATEGORY property of the}
8503 @r{(defun set-category ()}
8504 @r{ (interactive "P")}
8505 @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
8506 @r{ (org-agenda-error)))}
8507 @r{ (buffer (marker-buffer marker)))}
8508 @r{ (with-current-buffer buffer}
8509 @r{ (save-excursion}
8510 @r{ (save-restriction}
8512 @r{ (goto-char marker)}
8513 @r{ (org-back-to-heading t)}
8514 @r{ (org-set-property "CATEGORY" "web"))))))}
8518 @tsubheading{Calendar commands}
8519 @cindex calendar commands, from agenda
8521 @orgcmd{c,org-agenda-goto-calendar}
8522 Open the Emacs calendar and move to the date at the agenda cursor.
8524 @orgcmd{c,org-calendar-goto-agenda}
8525 When in the calendar, compute and show the Org mode agenda for the
8528 @cindex diary entries, creating from agenda
8529 @orgcmd{i,org-agenda-diary-entry}
8530 @vindex org-agenda-diary-file
8531 Insert a new entry into the diary, using the date at the cursor and (for
8532 block entries) the date at the mark. This will add to the Emacs diary
8533 file@footnote{This file is parsed for the agenda when
8534 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8535 command in the calendar. The diary file will pop up in another window, where
8536 you can add the entry.
8538 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
8539 Org will create entries (in Org mode syntax) in that file instead. Most
8540 entries will be stored in a date-based outline tree that will later make it
8541 easy to archive appointments from previous months/years. The tree will be
8542 built under an entry with a @code{DATE_TREE} property, or else with years as
8543 top-level entries. Emacs will prompt you for the entry text---if you specify
8544 it, the entry will be created in @code{org-agenda-diary-file} without further
8545 interaction. If you directly press @key{RET} at the prompt without typing
8546 text, the target file will be shown in another window for you to finish the
8547 entry there. See also the @kbd{k r} command.
8549 @orgcmd{M,org-agenda-phases-of-moon}
8550 Show the phases of the moon for the three months around current date.
8552 @orgcmd{S,org-agenda-sunrise-sunset}
8553 Show sunrise and sunset times. The geographical location must be set
8554 with calendar variables, see the documentation for the Emacs calendar.
8556 @orgcmd{C,org-agenda-convert-date}
8557 Convert the date at cursor into many other cultural and historic
8560 @orgcmd{H,org-agenda-holidays}
8561 Show holidays for three months around the cursor date.
8563 @item M-x org-export-icalendar-combine-agenda-files
8564 Export a single iCalendar file containing entries from all agenda files.
8565 This is a globally available command, and also available in the agenda menu.
8567 @tsubheading{Exporting to a file}
8568 @orgcmd{C-x C-w,org-write-agenda}
8569 @cindex exporting agenda views
8570 @cindex agenda views, exporting
8571 @vindex org-agenda-exporter-settings
8572 Write the agenda view to a file. Depending on the extension of the selected
8573 file name, the view will be exported as HTML (extension @file{.html} or
8574 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8575 and plain text (any other extension). When called with a @kbd{C-u} prefix
8576 argument, immediately open the newly created file. Use the variable
8577 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8578 for @file{htmlize} to be used during export.
8580 @tsubheading{Quit and Exit}
8581 @orgcmd{q,org-agenda-quit}
8582 Quit agenda, remove the agenda buffer.
8584 @cindex agenda files, removing buffers
8585 @orgcmd{x,org-agenda-exit}
8586 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8587 for the compilation of the agenda. Buffers created by the user to
8588 visit Org files will not be removed.
8592 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8593 @section Custom agenda views
8594 @cindex custom agenda views
8595 @cindex agenda views, custom
8597 Custom agenda commands serve two purposes: to store and quickly access
8598 frequently used TODO and tags searches, and to create special composite
8599 agenda buffers. Custom agenda commands will be accessible through the
8600 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8603 * Storing searches:: Type once, use often
8604 * Block agenda:: All the stuff you need in a single buffer
8605 * Setting Options:: Changing the rules
8608 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8609 @subsection Storing searches
8611 The first application of custom searches is the definition of keyboard
8612 shortcuts for frequently used searches, either creating an agenda
8613 buffer, or a sparse tree (the latter covering of course only the current
8616 @vindex org-agenda-custom-commands
8618 Custom commands are configured in the variable
8619 @code{org-agenda-custom-commands}. You can customize this variable, for
8620 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
8621 Lisp in @file{.emacs}. The following example contains all valid search
8626 (setq org-agenda-custom-commands
8627 '(("w" todo "WAITING")
8628 ("W" todo-tree "WAITING")
8629 ("u" tags "+boss-urgent")
8630 ("v" tags-todo "+boss-urgent")
8631 ("U" tags-tree "+boss-urgent")
8632 ("f" occur-tree "\\<FIXME\\>")
8633 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8634 ("hl" tags "+home+Lisa")
8635 ("hp" tags "+home+Peter")
8636 ("hk" tags "+home+Kim")))
8641 The initial string in each entry defines the keys you have to press
8642 after the dispatcher command @kbd{C-c a} in order to access the command.
8643 Usually this will be just a single character, but if you have many
8644 similar commands, you can also define two-letter combinations where the
8645 first character is the same in several combinations and serves as a
8646 prefix key@footnote{You can provide a description for a prefix key by
8647 inserting a cons cell with the prefix and the description.}. The second
8648 parameter is the search type, followed by the string or regular
8649 expression to be used for the matching. The example above will
8654 as a global search for TODO entries with @samp{WAITING} as the TODO
8657 as the same search, but only in the current buffer and displaying the
8658 results as a sparse tree
8660 as a global tags search for headlines marked @samp{:boss:} but not
8663 as the same search as @kbd{C-c a u}, but limiting the search to
8664 headlines that are also TODO items
8666 as the same search as @kbd{C-c a u}, but only in the current buffer and
8667 displaying the result as a sparse tree
8669 to create a sparse tree (again: current buffer only) with all entries
8670 containing the word @samp{FIXME}
8672 as a prefix command for a HOME tags search where you have to press an
8673 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8674 Peter, or Kim) as additional tag to match.
8677 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8678 @subsection Block agenda
8679 @cindex block agenda
8680 @cindex agenda, with block views
8682 Another possibility is the construction of agenda views that comprise
8683 the results of @emph{several} commands, each of which creates a block in
8684 the agenda buffer. The available commands include @code{agenda} for the
8685 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8686 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8687 matching commands discussed above: @code{todo}, @code{tags}, and
8688 @code{tags-todo}. Here are two examples:
8692 (setq org-agenda-custom-commands
8693 '(("h" "Agenda and Home-related tasks"
8697 ("o" "Agenda and Office-related tasks"
8705 This will define @kbd{C-c a h} to create a multi-block view for stuff
8706 you need to attend to at home. The resulting agenda buffer will contain
8707 your agenda for the current week, all TODO items that carry the tag
8708 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8709 command @kbd{C-c a o} provides a similar view for office tasks.
8711 @node Setting Options, , Block agenda, Custom agenda views
8712 @subsection Setting options for custom commands
8713 @cindex options, for custom agenda views
8715 @vindex org-agenda-custom-commands
8716 Org mode contains a number of variables regulating agenda construction
8717 and display. The global variables define the behavior for all agenda
8718 commands, including the custom commands. However, if you want to change
8719 some settings just for a single custom view, you can do so. Setting
8720 options requires inserting a list of variable names and values at the
8721 right spot in @code{org-agenda-custom-commands}. For example:
8725 (setq org-agenda-custom-commands
8726 '(("w" todo "WAITING"
8727 ((org-agenda-sorting-strategy '(priority-down))
8728 (org-agenda-prefix-format " Mixed: ")))
8729 ("U" tags-tree "+boss-urgent"
8730 ((org-show-following-heading nil)
8731 (org-show-hierarchy-above nil)))
8733 ((org-agenda-files '("~org/notes.org"))
8734 (org-agenda-text-search-extra-files nil)))))
8739 Now the @kbd{C-c a w} command will sort the collected entries only by
8740 priority, and the prefix format is modified to just say @samp{ Mixed: }
8741 instead of giving the category of the entry. The sparse tags tree of
8742 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8743 headline hierarchy above the match, nor the headline following the match
8744 will be shown. The command @kbd{C-c a N} will do a text search limited
8745 to only a single file.
8747 @vindex org-agenda-custom-commands
8748 For command sets creating a block agenda,
8749 @code{org-agenda-custom-commands} has two separate spots for setting
8750 options. You can add options that should be valid for just a single
8751 command in the set, and options that should be valid for all commands in
8752 the set. The former are just added to the command entry; the latter
8753 must come after the list of command entries. Going back to the block
8754 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8755 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8756 the results for GARDEN tags query in the opposite order,
8757 @code{priority-up}. This would look like this:
8761 (setq org-agenda-custom-commands
8762 '(("h" "Agenda and Home-related tasks"
8766 ((org-agenda-sorting-strategy '(priority-up)))))
8767 ((org-agenda-sorting-strategy '(priority-down))))
8768 ("o" "Agenda and Office-related tasks"
8775 As you see, the values and parentheses setting is a little complex.
8776 When in doubt, use the customize interface to set this variable---it
8777 fully supports its structure. Just one caveat: when setting options in
8778 this interface, the @emph{values} are just Lisp expressions. So if the
8779 value is a string, you need to add the double-quotes around the value
8782 @vindex org-agenda-custom-commands-contexts
8783 To control whether an agenda command should be accessible from a specific
8784 context, you can customize @var{org-agenda-custom-commands-contexts}. Let's
8785 say for example that you have an agenda commands @code{"o"} displaying a view
8786 that you only need when reading emails. Then you would configure this option
8790 (setq org-agenda-custom-commands-contexts
8791 '(("o" (in-mode . "message-mode"))))
8794 You can also tell that the command key @code{"o"} should refer to another
8795 command key @code{"r"}. In that case, add this command key like this:
8798 (setq org-agenda-custom-commands-contexts
8799 '(("o" "r" (in-mode . "message-mode"))))
8802 See the docstring of the variable for more information.
8804 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8805 @section Exporting Agenda Views
8806 @cindex agenda views, exporting
8808 If you are away from your computer, it can be very useful to have a printed
8809 version of some agenda views to carry around. Org mode can export custom
8810 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8811 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8812 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8813 a PDF file will also create the postscript file.}, and iCalendar files. If
8814 you want to do this only occasionally, use the command
8817 @orgcmd{C-x C-w,org-write-agenda}
8818 @cindex exporting agenda views
8819 @cindex agenda views, exporting
8820 @vindex org-agenda-exporter-settings
8821 Write the agenda view to a file. Depending on the extension of the selected
8822 file name, the view will be exported as HTML (extension @file{.html} or
8823 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8824 @file{.ics}), or plain text (any other extension). Use the variable
8825 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8826 for @file{htmlize} to be used during export, for example
8828 @vindex org-agenda-add-entry-text-maxlines
8829 @vindex htmlize-output-type
8830 @vindex ps-number-of-columns
8831 @vindex ps-landscape-mode
8833 (setq org-agenda-exporter-settings
8834 '((ps-number-of-columns 2)
8835 (ps-landscape-mode t)
8836 (org-agenda-add-entry-text-maxlines 5)
8837 (htmlize-output-type 'css)))
8841 If you need to export certain agenda views frequently, you can associate
8842 any custom agenda command with a list of output file names
8843 @footnote{If you want to store standard views like the weekly agenda
8844 or the global TODO list as well, you need to define custom commands for
8845 them in order to be able to specify file names.}. Here is an example
8846 that first defines custom commands for the agenda and the global
8847 TODO list, together with a number of files to which to export them.
8848 Then we define two block agenda commands and specify file names for them
8849 as well. File names can be relative to the current working directory,
8854 (setq org-agenda-custom-commands
8855 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8856 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8857 ("h" "Agenda and Home-related tasks"
8862 ("~/views/home.html"))
8863 ("o" "Agenda and Office-related tasks"
8868 ("~/views/office.ps" "~/calendars/office.ics"))))
8872 The extension of the file name determines the type of export. If it is
8873 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
8874 the buffer to HTML and save it to this file name. If the extension is
8875 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8876 Postscript output. If the extension is @file{.ics}, iCalendar export is
8877 run export over all files that were used to construct the agenda, and
8878 limit the export to entries listed in the agenda. Any other
8879 extension produces a plain ASCII file.
8881 The export files are @emph{not} created when you use one of those
8882 commands interactively because this might use too much overhead.
8883 Instead, there is a special command to produce @emph{all} specified
8887 @orgcmd{C-c a e,org-store-agenda-views}
8888 Export all agenda views that have export file names associated with
8892 You can use the options section of the custom agenda commands to also
8893 set options for the export commands. For example:
8896 (setq org-agenda-custom-commands
8898 ((ps-number-of-columns 2)
8899 (ps-landscape-mode t)
8900 (org-agenda-prefix-format " [ ] ")
8901 (org-agenda-with-colors nil)
8902 (org-agenda-remove-tags t))
8907 This command sets two options for the Postscript exporter, to make it
8908 print in two columns in landscape format---the resulting page can be cut
8909 in two and then used in a paper agenda. The remaining settings modify
8910 the agenda prefix to omit category and scheduling information, and
8911 instead include a checkbox to check off items. We also remove the tags
8912 to make the lines compact, and we don't want to use colors for the
8913 black-and-white printer. Settings specified in
8914 @code{org-agenda-exporter-settings} will also apply, but the settings
8915 in @code{org-agenda-custom-commands} take precedence.
8918 From the command line you may also use
8920 emacs -eval (org-batch-store-agenda-views) -kill
8923 or, if you need to modify some parameters@footnote{Quoting depends on the
8924 system you use, please check the FAQ for examples.}
8926 emacs -eval '(org-batch-store-agenda-views \
8927 org-agenda-span (quote month) \
8928 org-agenda-start-day "2007-11-01" \
8929 org-agenda-include-diary nil \
8930 org-agenda-files (quote ("~/org/project.org")))' \
8934 which will create the agenda views restricted to the file
8935 @file{~/org/project.org}, without diary entries and with a 30-day
8938 You can also extract agenda information in a way that allows further
8939 processing by other programs. See @ref{Extracting agenda information}, for
8943 @node Agenda column view, , Exporting Agenda Views, Agenda Views
8944 @section Using column view in the agenda
8945 @cindex column view, in agenda
8946 @cindex agenda, column view
8948 Column view (@pxref{Column view}) is normally used to view and edit
8949 properties embedded in the hierarchical structure of an Org file. It can be
8950 quite useful to use column view also from the agenda, where entries are
8951 collected by certain criteria.
8954 @orgcmd{C-c C-x C-c,org-agenda-columns}
8955 Turn on column view in the agenda.
8958 To understand how to use this properly, it is important to realize that the
8959 entries in the agenda are no longer in their proper outline environment.
8960 This causes the following issues:
8964 @vindex org-columns-default-format
8965 @vindex org-overriding-columns-format
8966 Org needs to make a decision which @code{COLUMNS} format to use. Since the
8967 entries in the agenda are collected from different files, and different files
8968 may have different @code{COLUMNS} formats, this is a non-trivial problem.
8969 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
8970 currently set, and if so, takes the format from there. Otherwise it takes
8971 the format associated with the first item in the agenda, or, if that item
8972 does not have a specific format (defined in a property, or in its file), it
8973 uses @code{org-columns-default-format}.
8975 @cindex property, special, CLOCKSUM
8976 If any of the columns has a summary type defined (@pxref{Column attributes}),
8977 turning on column view in the agenda will visit all relevant agenda files and
8978 make sure that the computations of this property are up to date. This is
8979 also true for the special @code{CLOCKSUM} property. Org will then sum the
8980 values displayed in the agenda. In the daily/weekly agenda, the sums will
8981 cover a single day; in all other views they cover the entire block. It is
8982 vital to realize that the agenda may show the same entry @emph{twice} (for
8983 example as scheduled and as a deadline), and it may show two entries from the
8984 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
8985 cases, the summation in the agenda will lead to incorrect results because
8986 some values will count double.
8988 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
8989 the entire clocked time for this item. So even in the daily/weekly agenda,
8990 the clocksum listed in column view may originate from times outside the
8991 current view. This has the advantage that you can compare these values with
8992 a column listing the planned total effort for a task---one of the major
8993 applications for column view in the agenda. If you want information about
8994 clocked time in the displayed period use clock table mode (press @kbd{R} in
8998 @cindex property, special, CLOCKSUM_T
8999 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9000 always today's clocked time for this item. So even in the weekly agenda,
9001 the clocksum listed in column view only originates from today. This lets
9002 you compare the time you spent on a task for today, with the time already
9003 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9007 @node Markup, Exporting, Agenda Views, Top
9008 @chapter Markup for rich export
9010 When exporting Org mode documents, the exporter tries to reflect the
9011 structure of the document as accurately as possible in the backend. Since
9012 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
9013 Org mode has rules on how to prepare text for rich export. This section
9014 summarizes the markup rules used in an Org mode buffer.
9017 * Structural markup elements:: The basic structure as seen by the exporter
9018 * Images and tables:: Tables and Images will be included
9019 * Literal examples:: Source code examples with special formatting
9020 * Include files:: Include additional files into a document
9021 * Index entries:: Making an index
9022 * Macro replacement:: Use macros to create complex output
9023 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9026 @node Structural markup elements, Images and tables, Markup, Markup
9027 @section Structural markup elements
9030 * Document title:: Where the title is taken from
9031 * Headings and sections:: The document structure as seen by the exporter
9032 * Table of contents:: The if and where of the table of contents
9033 * Initial text:: Text before the first heading?
9035 * Paragraphs:: Paragraphs
9036 * Footnote markup:: Footnotes
9037 * Emphasis and monospace:: Bold, italic, etc.
9038 * Horizontal rules:: Make a line
9039 * Comment lines:: What will *not* be exported
9042 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
9043 @subheading Document title
9044 @cindex document title, markup rules
9047 The title of the exported document is taken from the special line
9051 #+TITLE: This is the title of the document
9055 If this line does not exist, the title is derived from the first non-empty,
9056 non-comment line in the buffer. If no such line exists, or if you have
9057 turned off exporting of the text before the first headline (see below), the
9058 title will be the file name without extension.
9060 @cindex property, EXPORT_TITLE
9061 If you are exporting only a subtree by marking is as the region, the heading
9062 of the subtree will become the title of the document. If the subtree has a
9063 property @code{EXPORT_TITLE}, that will take precedence.
9065 @node Headings and sections, Table of contents, Document title, Structural markup elements
9066 @subheading Headings and sections
9067 @cindex headings and sections, markup rules
9069 @vindex org-export-headline-levels
9070 The outline structure of the document as described in @ref{Document
9071 Structure}, forms the basis for defining sections of the exported document.
9072 However, since the outline structure is also used for (for example) lists of
9073 tasks, only the first three outline levels will be used as headings. Deeper
9074 levels will become itemized lists. You can change the location of this
9075 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9076 per-file basis with a line
9083 @node Table of contents, Initial text, Headings and sections, Structural markup elements
9084 @subheading Table of contents
9085 @cindex table of contents, markup rules
9087 @vindex org-export-with-toc
9088 The table of contents is normally inserted directly before the first headline
9089 of the file. If you would like to get it to a different location, insert the
9090 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
9091 location. The depth of the table of contents is by default the same as the
9092 number of headline levels, but you can choose a smaller number, or turn off
9093 the table of contents entirely, by configuring the variable
9094 @code{org-export-with-toc}, or on a per-file basis with a line like
9097 #+OPTIONS: toc:2 (only to two levels in TOC)
9098 #+OPTIONS: toc:nil (no TOC at all)
9101 @node Initial text, Lists, Table of contents, Structural markup elements
9102 @subheading Text before the first headline
9103 @cindex text before first headline, markup rules
9106 Org mode normally exports the text before the first headline, and even uses
9107 the first line as the document title. The text will be fully marked up. If
9108 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
9109 constructs described below in the sections for the individual exporters.
9111 @vindex org-export-skip-text-before-1st-heading
9112 Some people like to use the space before the first headline for setup and
9113 internal links and therefore would like to control the exported text before
9114 the first headline in a different way. You can do so by setting the variable
9115 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
9116 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
9119 If you still want to have some text before the first headline, use the
9120 @code{#+TEXT} construct:
9124 #+TEXT: This text will go before the *first* headline.
9125 #+TEXT: [TABLE-OF-CONTENTS]
9126 #+TEXT: This goes between the table of contents and the *first* headline
9129 @node Lists, Paragraphs, Initial text, Structural markup elements
9131 @cindex lists, markup rules
9133 Plain lists as described in @ref{Plain lists}, are translated to the backend's
9134 syntax for such lists. Most backends support unordered, ordered, and
9137 @node Paragraphs, Footnote markup, Lists, Structural markup elements
9138 @subheading Paragraphs, line breaks, and quoting
9139 @cindex paragraphs, markup rules
9141 Paragraphs are separated by at least one empty line. If you need to enforce
9142 a line break within a paragraph, use @samp{\\} at the end of a line.
9144 To keep the line breaks in a region, but otherwise use normal formatting, you
9145 can use this construct, which can also be used to format poetry.
9147 @cindex #+BEGIN_VERSE
9150 Great clouds overhead
9151 Tiny black birds rise and fall
9158 When quoting a passage from another document, it is customary to format this
9159 as a paragraph that is indented on both the left and the right margin. You
9160 can include quotations in Org mode documents like this:
9162 @cindex #+BEGIN_QUOTE
9165 Everything should be made as simple as possible,
9166 but not any simpler -- Albert Einstein
9170 If you would like to center some text, do it like this:
9171 @cindex #+BEGIN_CENTER
9174 Everything should be made as simple as possible, \\
9180 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
9181 @subheading Footnote markup
9182 @cindex footnotes, markup rules
9183 @cindex @file{footnote.el}
9185 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9186 by all backends. Org allows multiple references to the same note, and
9187 multiple footnotes side by side.
9189 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
9190 @subheading Emphasis and monospace
9192 @cindex underlined text, markup rules
9193 @cindex bold text, markup rules
9194 @cindex italic text, markup rules
9195 @cindex verbatim text, markup rules
9196 @cindex code text, markup rules
9197 @cindex strike-through text, markup rules
9198 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
9199 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
9200 in the code and verbatim string is not processed for Org mode specific
9201 syntax; it is exported verbatim.
9203 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
9204 @subheading Horizontal rules
9205 @cindex horizontal rules, markup rules
9206 A line consisting of only dashes, and at least 5 of them, will be exported as
9207 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
9209 @node Comment lines, , Horizontal rules, Structural markup elements
9210 @subheading Comment lines
9211 @cindex comment lines
9212 @cindex exporting, not
9213 @cindex #+BEGIN_COMMENT
9215 Lines starting with zero or more whitespace characters followed by @samp{#}
9216 are treated as comments and will never be exported. Also entire subtrees
9217 starting with the word @samp{COMMENT} will never be exported. Finally,
9218 regions surrounded by @samp{#+BEGIN_COMMENT} ... @samp{#+END_COMMENT} will
9224 Toggle the COMMENT keyword at the beginning of an entry.
9228 @node Images and tables, Literal examples, Structural markup elements, Markup
9229 @section Images and Tables
9231 @cindex tables, markup rules
9234 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9235 the @file{table.el} package will be exported properly. For Org mode tables,
9236 the lines before the first horizontal separator line will become table header
9237 lines. You can use the following lines somewhere before the table to assign
9238 a caption and a label for cross references, and in the text you can refer to
9239 the object with @code{\ref@{tab:basic-data@}}:
9242 #+CAPTION: This is the caption for the next table (or link)
9243 #+LABEL: tab:basic-data
9248 Optionally, the caption can take the form:
9250 #+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
9253 @cindex inlined images, markup rules
9254 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
9255 images into the exported document. Org does this, if a link to an image
9256 files does not have a description part, for example @code{[[./img/a.jpg]]}.
9257 If you wish to define a caption for the image and maybe a label for internal
9258 cross references, make sure that the link is on a line by itself and precede
9259 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
9262 #+CAPTION: This is the caption for the next figure link (or table)
9263 #+LABEL: fig:SED-HR4049
9267 You may also define additional attributes for the figure. As this is
9268 backend-specific, see the sections about the individual backends for more
9271 @xref{Handling links,the discussion of image links}.
9273 @node Literal examples, Include files, Images and tables, Markup
9274 @section Literal examples
9275 @cindex literal examples, markup rules
9276 @cindex code line references, markup rules
9278 You can include literal examples that should not be subjected to
9279 markup. Such examples will be typeset in monospace, so this is well suited
9280 for source code and similar examples.
9281 @cindex #+BEGIN_EXAMPLE
9285 Some example from a text file.
9289 Note that such blocks may be @i{indented} in order to align nicely with
9290 indented text and in particular with plain list structure (@pxref{Plain
9291 lists}). For simplicity when using small examples, you can also start the
9292 example lines with a colon followed by a space. There may also be additional
9293 whitespace before the colon:
9297 : Some example from a text file.
9300 @cindex formatting source code, markup rules
9301 If the example is source code from a programming language, or any other text
9302 that can be marked up by font-lock in Emacs, you can ask for the example to
9303 look like the fontified Emacs buffer@footnote{This works automatically for
9304 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
9305 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9306 achieved using either the listings or the
9307 @url{http://code.google.com/p/minted, minted,} package. Refer to
9308 @code{org-export-latex-listings} documentation for details.}. This is done
9309 with the @samp{src} block, where you also need to specify the name of the
9310 major mode that should be used to fontify the example@footnote{Code in
9311 @samp{src} blocks may also be evaluated either interactively or on export.
9312 See @pxref{Working With Source Code} for more information on evaluating code
9313 blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code
9318 #+BEGIN_SRC emacs-lisp
9319 (defun org-xor (a b)
9325 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9326 switch to the end of the @code{BEGIN} line, to get the lines of the example
9327 numbered. If you use a @code{+n} switch, the numbering from the previous
9328 numbered snippet will be continued in the current one. In literal examples,
9329 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9330 targets for special hyperlinks like @code{[[(name)]]} (i.e.@: the reference name
9331 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9332 link will remote-highlight the corresponding code line, which is kind of
9335 You can also add a @code{-r} switch which @i{removes} the labels from the
9336 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9337 labels in the source code while using line numbers for the links, which might
9338 be useful to explain those in an Org mode example code.}. With the @code{-n}
9339 switch, links to these references will be labeled by the line numbers from
9340 the code listing, otherwise links will use the labels with no parentheses.
9344 #+BEGIN_SRC emacs-lisp -n -r
9345 (save-excursion (ref:sc)
9346 (goto-char (point-min)) (ref:jump)
9348 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9352 @vindex org-coderef-label-format
9353 If the syntax for the label format conflicts with the language syntax, use a
9354 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9355 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9357 HTML export also allows examples to be published as text areas (@pxref{Text
9358 areas in HTML export}).
9360 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9361 so often, shortcuts are provided using the Easy Templates facility
9362 (@pxref{Easy Templates}).
9367 Edit the source code example at point in its native mode. This works by
9368 switching to a temporary buffer with the source code. You need to exit by
9369 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*}
9370 or @samp{#} will get a comma prepended, to keep them from being interpreted
9371 by Org as outline nodes or special comments. These commas will be stripped
9372 for editing with @kbd{C-c '}, and also for export.}. The edited version will
9373 then replace the old version in the Org buffer. Fixed-width regions
9374 (where each line starts with a colon followed by a space) will be edited
9375 using @code{artist-mode}@footnote{You may select a different-mode with the
9376 variable @code{org-edit-fixed-width-region-mode}.} to allow creating ASCII
9377 drawings easily. Using this command in an empty line will create a new
9381 Calling @code{org-store-link} while editing a source code example in a
9382 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9383 that it is unique in the current buffer, and insert it with the proper
9384 formatting like @samp{(ref:label)} at the end of the current line. Then the
9385 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9389 @node Include files, Index entries, Literal examples, Markup
9390 @section Include files
9391 @cindex include files, markup rules
9393 During export, you can include the content of another file. For example, to
9394 include your @file{.emacs} file, you could use:
9398 #+INCLUDE: "~/.emacs" src emacs-lisp
9401 The optional second and third parameter are the markup (e.g.@: @samp{quote},
9402 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9403 language for formatting the contents. The markup is optional; if it is not
9404 given, the text will be assumed to be in Org mode format and will be
9405 processed normally. The include line will also allow additional keyword
9406 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
9407 first line and for each following line, @code{:minlevel} in order to get
9408 Org mode content demoted to a specified level, as well as any options
9409 accepted by the selected markup. For example, to include a file as an item,
9413 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
9416 You can also include a portion of a file by specifying a lines range using
9417 the @code{:lines} parameter. The line at the upper end of the range will not
9418 be included. The start and/or the end of the range may be omitted to use the
9422 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
9423 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
9424 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
9430 Visit the include file at point.
9433 @node Index entries, Macro replacement, Include files, Markup
9434 @section Index entries
9435 @cindex index entries, for publishing
9437 You can specify entries that will be used for generating an index during
9438 publishing. This is done by lines starting with @code{#+INDEX}. An entry
9439 the contains an exclamation mark will create a sub item. See @ref{Generating
9440 an index} for more information.
9445 #+INDEX: Application!CV
9451 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
9452 @section Macro replacement
9453 @cindex macro replacement, during export
9456 You can define text snippets with
9459 #+MACRO: name replacement text $1, $2 are arguments
9462 @noindent which can be referenced anywhere in the document (even in
9463 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
9464 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
9465 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
9466 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9467 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9468 and to the modification time of the file being exported, respectively.
9469 @var{FORMAT} should be a format string understood by
9470 @code{format-time-string}.
9472 Macro expansion takes place during export, and some people use it to
9473 construct complex HTML code.
9476 @node Embedded @LaTeX{}, , Macro replacement, Markup
9477 @section Embedded @LaTeX{}
9478 @cindex @TeX{} interpretation
9479 @cindex @LaTeX{} interpretation
9481 Plain ASCII is normally sufficient for almost all note taking. Exceptions
9482 include scientific notes, which often require mathematical symbols and the
9483 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9484 Donald E. Knuth's @TeX{} system. Many of the features described here as
9485 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9486 distinction.} is widely used to typeset scientific documents. Org mode
9487 supports embedding @LaTeX{} code into its files, because many academics are
9488 used to writing and reading @LaTeX{} source code, and because it can be
9489 readily processed to produce pretty output for a number of export backends.
9492 * Special symbols:: Greek letters and other symbols
9493 * Subscripts and superscripts:: Simple syntax for raising/lowering text
9494 * @LaTeX{} fragments:: Complex formulas made easy
9495 * Previewing @LaTeX{} fragments:: What will this snippet look like?
9496 * CDLaTeX mode:: Speed up entering of formulas
9499 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
9500 @subsection Special symbols
9501 @cindex math symbols
9502 @cindex special symbols
9503 @cindex @TeX{} macros
9504 @cindex @LaTeX{} fragments, markup rules
9505 @cindex HTML entities
9506 @cindex @LaTeX{} entities
9508 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
9509 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
9510 for these macros is available, just type @samp{\} and maybe a few letters,
9511 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
9512 code, Org mode allows these macros to be present without surrounding math
9513 delimiters, for example:
9516 Angles are written as Greek letters \alpha, \beta and \gamma.
9519 @vindex org-entities
9520 During export, these symbols will be transformed into the native format of
9521 the exporter backend. Strings like @code{\alpha} will be exported as
9522 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9523 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
9524 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
9525 like this: @samp{\Aacute@{@}stor}.
9527 A large number of entities is provided, with names taken from both HTML and
9528 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9529 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9530 @samp{...} are all converted into special commands creating hyphens of
9531 different lengths or a compact set of dots.
9533 If you would like to see entities displayed as UTF8 characters, use the
9534 following command@footnote{You can turn this on by default by setting the
9535 variable @code{org-pretty-entities}, or on a per-file base with the
9536 @code{#+STARTUP} option @code{entitiespretty}.}:
9541 Toggle display of entities as UTF-8 characters. This does not change the
9542 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9543 for display purposes only.
9546 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
9547 @subsection Subscripts and superscripts
9551 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9552 and subscripts. Again, these can be used without embedding them in
9553 math-mode delimiters. To increase the readability of ASCII text, it is
9554 not necessary (but OK) to surround multi-character sub- and superscripts
9555 with curly braces. For example
9558 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9559 the sun is R_@{sun@} = 6.96 x 10^8 m.
9562 @vindex org-export-with-sub-superscripts
9563 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9564 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9565 where the underscore is often used in a different context, Org's convention
9566 to always interpret these as subscripts can get in your way. Configure the
9567 variable @code{org-export-with-sub-superscripts} to globally change this
9568 convention, or use, on a per-file basis:
9574 @noindent With this setting, @samp{a_b} will not be interpreted as a
9575 subscript, but @samp{a_@{b@}} will.
9580 In addition to showing entities as UTF-8 characters, this command will also
9581 format sub- and superscripts in a WYSIWYM way.
9584 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
9585 @subsection @LaTeX{} fragments
9586 @cindex @LaTeX{} fragments
9588 @vindex org-format-latex-header
9589 Going beyond symbols and sub- and superscripts, a full formula language is
9590 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
9591 to process these for several export backends. When exporting to @LaTeX{},
9592 the code is obviously left as it is. When exporting to HTML, Org invokes the
9593 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9594 HTML export}) to process and display the math@footnote{If you plan to use
9595 this regularly or on pages with significant page views, you should install
9596 @file{MathJax} on your own
9597 server in order to limit the load of our server.}. Finally, it can also
9598 process the mathematical expressions into images@footnote{For this to work
9599 you need to be on a system with a working @LaTeX{} installation. You also
9600 need the @file{dvipng} program or the @file{convert}, respectively available
9601 at @url{http://sourceforge.net/projects/dvipng/} and from the
9602 @file{imagemagick} suite. The @LaTeX{} header that will be used when
9603 processing a fragment can be configured with the variable
9604 @code{org-format-latex-header}.} that can be displayed in a browser or in
9607 @LaTeX{} fragments don't need any special marking at all. The following
9608 snippets will be identified as @LaTeX{} source code:
9611 Environments of any kind@footnote{When @file{MathJax} is used, only the
9612 environment recognized by @file{MathJax} will be processed. When
9613 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9614 handled.}. The only requirement is that the @code{\begin} statement appears
9615 on a new line, preceded by only whitespace.
9617 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9618 currency specifications, single @samp{$} characters are only recognized as
9619 math delimiters if the enclosed text contains at most two line breaks, is
9620 directly attached to the @samp{$} characters with no whitespace in between,
9621 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9622 For the other delimiters, there is no such restriction, so when in doubt, use
9623 @samp{\(...\)} as inline math delimiters.
9626 @noindent For example:
9629 \begin@{equation@} % arbitrary environments,
9630 x=\sqrt@{b@} % even tables, figures
9631 \end@{equation@} % etc
9633 If $a^2=b$ and \( b=2 \), then the solution must be
9634 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9638 @vindex org-format-latex-options
9639 If you need any of the delimiter ASCII sequences for other purposes, you
9640 can configure the option @code{org-format-latex-options} to deselect the
9641 ones you do not wish to have interpreted by the @LaTeX{} converter.
9643 @vindex org-export-with-LaTeX-fragments
9644 @LaTeX{} processing can be configured with the variable
9645 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9646 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9647 @LaTeX{} backends. You can also set this variable on a per-file basis using one
9651 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9652 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9653 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9654 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9657 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
9658 @subsection Previewing @LaTeX{} fragments
9659 @cindex @LaTeX{} fragments, preview
9661 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9662 produce preview images of the typeset expressions:
9667 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9668 over the source code. If there is no fragment at point, process all
9669 fragments in the current entry (between two headlines). When called
9670 with a prefix argument, process the entire subtree. When called with
9671 two prefix arguments, or when the cursor is before the first headline,
9672 process the entire buffer.
9675 Remove the overlay preview images.
9678 @vindex org-format-latex-options
9679 You can customize the variable @code{org-format-latex-options} to influence
9680 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9681 export, @code{:html-scale}) property can be used to adjust the size of the
9684 @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
9685 @subsection Using CD@LaTeX{} to enter math
9688 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
9689 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9690 environments and math templates. Inside Org mode, you can make use of
9691 some of the features of CD@LaTeX{} mode. You need to install
9692 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9693 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9694 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
9695 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
9696 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9700 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9703 When this mode is enabled, the following features are present (for more
9704 details see the documentation of CD@LaTeX{} mode):
9708 Environment templates can be inserted with @kbd{C-c @{}.
9711 The @key{TAB} key will do template expansion if the cursor is inside a
9712 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
9713 inside such a fragment, see the documentation of the function
9714 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9715 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9716 correctly inside the first brace. Another @key{TAB} will get you into
9717 the second brace. Even outside fragments, @key{TAB} will expand
9718 environment abbreviations at the beginning of a line. For example, if
9719 you write @samp{equ} at the beginning of a line and press @key{TAB},
9720 this abbreviation will be expanded to an @code{equation} environment.
9721 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9725 @vindex cdlatex-simplify-sub-super-scripts
9726 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9727 characters together with a pair of braces. If you use @key{TAB} to move
9728 out of the braces, and if the braces surround only a single character or
9729 macro, they are removed again (depending on the variable
9730 @code{cdlatex-simplify-sub-super-scripts}).
9733 Pressing the backquote @kbd{`} followed by a character inserts math
9734 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9735 after the backquote, a help window will pop up.
9738 Pressing the single-quote @kbd{'} followed by another character modifies
9739 the symbol before point with an accent or a font. If you wait more than
9740 1.5 seconds after the single-quote, a help window will pop up. Character
9741 modification will work only inside @LaTeX{} fragments; outside the quote
9745 @node Exporting, Publishing, Markup, Top
9749 Org mode documents can be exported into a variety of other formats. For
9750 printing and sharing of notes, ASCII export produces a readable and simple
9751 version of an Org file. HTML export allows you to publish a notes file on
9752 the web, while the XOXO format provides a solid base for exchange with a
9753 broad range of other applications. @LaTeX{} export lets you use Org mode and
9754 its structured editing functions to easily create @LaTeX{} files. DocBook
9755 export makes it possible to convert Org files to many other formats using
9756 DocBook tools. OpenDocument Text (ODT) export allows seamless
9757 collaboration across organizational boundaries. For project management you
9758 can create gantt and resource charts by using TaskJuggler export. To
9759 incorporate entries with associated times like deadlines or appointments into
9760 a desktop calendar program like iCal, Org mode can also produce extracts in
9761 the iCalendar format. Currently, Org mode only supports export, not import of
9762 these different formats.
9764 Org supports export of selected regions when @code{transient-mark-mode} is
9765 enabled (default in Emacs 23).
9768 * Selective export:: Using tags to select and exclude trees
9769 * Export options:: Per-file export settings
9770 * The export dispatcher:: How to access exporter commands
9771 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9772 * HTML export:: Exporting to HTML
9773 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9774 * DocBook export:: Exporting to DocBook
9775 * OpenDocument Text export:: Exporting to OpenDocument Text
9776 * TaskJuggler export:: Exporting to TaskJuggler
9777 * Freemind export:: Exporting to Freemind mind maps
9778 * XOXO export:: Exporting to XOXO
9779 * iCalendar export:: Exporting in iCalendar format
9782 @node Selective export, Export options, Exporting, Exporting
9783 @section Selective export
9784 @cindex export, selective by tags or TODO keyword
9786 @vindex org-export-select-tags
9787 @vindex org-export-exclude-tags
9788 @cindex org-export-with-tasks
9789 You may use tags to select the parts of a document that should be exported,
9790 or to exclude parts from export. This behavior is governed by two variables:
9791 @code{org-export-select-tags} and @code{org-export-exclude-tags},
9792 respectively defaulting to @code{'(:export:)} and @code{'(:noexport:)}.
9796 Org first checks if any of the @emph{select} tags is present in the
9797 buffer. If yes, all trees that do not carry one of these tags will be
9798 excluded. If a selected tree is a subtree, the heading hierarchy above it
9799 will also be selected for export, but not the text below those headings.
9802 If none of the select tags is found, the whole buffer will be selected for
9806 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9807 be removed from the export buffer.
9810 The variable @code{org-export-with-tasks} can be configured to select which
9811 kind of tasks should be included for export. See the docstring of the
9812 variable for more information.
9814 @node Export options, The export dispatcher, Selective export, Exporting
9815 @section Export options
9816 @cindex options, for export
9818 @cindex completion, of option keywords
9819 The exporter recognizes special lines in the buffer which provide
9820 additional information. These lines may be put anywhere in the file.
9821 The whole set of lines can be inserted into the buffer with @kbd{C-c
9822 C-e t}. For individual lines, a good way to make sure the keyword is
9823 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9824 (@pxref{Completion}). For a summary of other in-buffer settings not
9825 specifically related to export, see @ref{In-buffer settings}.
9826 In particular, note that you can place commonly-used (export) options in
9827 a separate file which can be included using @code{#+SETUPFILE}.
9830 @orgcmd{C-c C-e t,org-insert-export-options-template}
9831 Insert template with export options, see example below.
9838 @cindex #+DESCRIPTION
9846 @cindex #+EXPORT_SELECT_TAGS
9847 @cindex #+EXPORT_EXCLUDE_TAGS
9849 @cindex #+LaTeX_HEADER
9850 @vindex user-full-name
9851 @vindex user-mail-address
9852 @vindex org-export-default-language
9853 @vindex org-export-date-timestamp-format
9855 #+TITLE: the title to be shown (default is the buffer name)
9856 #+AUTHOR: the author (default taken from @code{user-full-name})
9857 #+DATE: a date, an Org timestamp@footnote{@code{org-export-date-timestamp-format} defines how this timestamp will be exported.}, or a format string for @code{format-time-string}
9858 #+EMAIL: his/her email address (default from @code{user-mail-address})
9859 #+DESCRIPTION: the page description, e.g.@: for the XHTML meta tag
9860 #+KEYWORDS: the page keywords, e.g.@: for the XHTML meta tag
9861 #+LANGUAGE: language for HTML, e.g.@: @samp{en} (@code{org-export-default-language})
9862 #+TEXT: Some descriptive text to be inserted at the beginning.
9863 #+TEXT: Several lines may be given.
9864 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9865 #+BIND: lisp-var lisp-val, e.g.@:: @code{org-export-latex-low-levels itemize}
9866 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9867 #+LINK_UP: the ``up'' link of an exported page
9868 #+LINK_HOME: the ``home'' link of an exported page
9869 #+LaTeX_HEADER: extra line(s) for the @LaTeX{} header, like \usepackage@{xyz@}
9870 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9871 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9872 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9876 The @code{#+OPTIONS} line is a compact@footnote{If you want to configure many options
9877 this way, you can use several @code{#+OPTIONS} lines.} form to specify export
9878 settings. Here you can:
9879 @cindex headline levels
9880 @cindex section-numbers
9881 @cindex table of contents
9882 @cindex line-break preservation
9883 @cindex quoted HTML tags
9884 @cindex fixed-width sections
9886 @cindex @TeX{}-like syntax for sub- and superscripts
9888 @cindex special strings
9889 @cindex emphasized text
9890 @cindex @TeX{} macros
9891 @cindex @LaTeX{} fragments
9892 @cindex author info, in export
9893 @cindex time info, in export
9894 @vindex org-export-plist-vars
9895 @vindex org-export-author-info
9896 @vindex org-export-creator-info
9897 @vindex org-export-email-info
9898 @vindex org-export-time-stamp-file
9900 H: @r{set the number of headline levels for export}
9901 num: @r{turn on/off section-numbers}
9902 toc: @r{turn on/off table of contents, or set level limit (integer)}
9903 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
9904 @@: @r{turn on/off quoted HTML tags}
9905 :: @r{turn on/off fixed-width sections}
9906 |: @r{turn on/off tables}
9907 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
9908 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
9909 @r{the simple @code{a_b} will be left as it is.}
9910 -: @r{turn on/off conversion of special strings.}
9911 f: @r{turn on/off footnotes like this[1].}
9912 todo: @r{turn on/off inclusion of TODO keywords into exported text}
9913 tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
9914 @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
9915 pri: @r{turn on/off priority cookies}
9916 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
9917 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
9918 *: @r{turn on/off emphasized text (bold, italic, underlined)}
9919 TeX: @r{turn on/off simple @TeX{} macros in plain text}
9920 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
9921 skip: @r{turn on/off skipping the text before the first heading}
9922 author: @r{turn on/off inclusion of author name/email into exported file}
9923 email: @r{turn on/off inclusion of author email into exported file}
9924 creator: @r{turn on/off inclusion of creator info into exported file}
9925 timestamp: @r{turn on/off inclusion creation time into exported file}
9926 d: @r{turn on/off inclusion of drawers, or list drawers to include}
9929 These options take effect in both the HTML and @LaTeX{} export, except for
9930 @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
9931 @code{nil} for the @LaTeX{} export.
9933 The default values for these and many other options are given by a set of
9934 variables. For a list of such variables, the corresponding OPTIONS keys and
9935 also the publishing keys (@pxref{Project alist}), see the constant
9936 @code{org-export-plist-vars}.
9938 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
9939 calling an export command, the subtree can overrule some of the file's export
9940 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
9941 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
9942 @code{EXPORT_OPTIONS}.
9944 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
9945 @section The export dispatcher
9946 @cindex dispatcher, for export commands
9948 All export commands can be reached using the export dispatcher, which is a
9949 prefix key that prompts for an additional key specifying the command.
9950 Normally the entire file is exported, but if there is an active region that
9951 contains one outline tree, the first heading is used as document title and
9952 the subtrees are exported.
9955 @orgcmd{C-c C-e,org-export}
9956 @vindex org-export-run-in-background
9957 Dispatcher for export and publishing commands. Displays a help-window
9958 listing the additional key(s) needed to launch an export or publishing
9959 command. The prefix arg is passed through to the exporter. A double prefix
9960 @kbd{C-u C-u} causes most commands to be executed in the background, in a
9961 separate Emacs process@footnote{To make this behavior the default, customize
9962 the variable @code{org-export-run-in-background}.}.
9963 @orgcmd{C-c C-e v,org-export-visible}
9964 Like @kbd{C-c C-e}, but only export the text that is currently visible
9965 (i.e.@: not hidden by outline visibility).
9966 @orgcmd{C-u C-u C-c C-e,org-export}
9967 @vindex org-export-run-in-background
9968 Call the exporter, but reverse the setting of
9969 @code{org-export-run-in-background}, i.e.@: request background processing if
9970 not set, or force processing in the current Emacs process if set.
9973 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
9974 @section ASCII/Latin-1/UTF-8 export
9975 @cindex ASCII export
9976 @cindex Latin-1 export
9977 @cindex UTF-8 export
9979 ASCII export produces a simple and very readable version of an Org mode
9980 file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file
9981 with special characters and symbols available in these encodings.
9983 @cindex region, active
9984 @cindex active region
9985 @cindex transient-mark-mode
9987 @orgcmd{C-c C-e a,org-export-as-ascii}
9988 @cindex property, EXPORT_FILE_NAME
9989 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
9990 will be @file{myfile.txt}. The file will be overwritten without
9991 warning. If there is an active region@footnote{This requires
9992 @code{transient-mark-mode} be turned on.}, only the region will be
9993 exported. If the selected region is a single tree@footnote{To select the
9994 current subtree, use @kbd{C-c @@}.}, the tree head will
9995 become the document title. If the tree head entry has or inherits an
9996 @code{EXPORT_FILE_NAME} property, that name will be used for the
9998 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
9999 Export to a temporary buffer. Do not create a file.
10000 @orgcmd{C-c C-e n,org-export-as-latin1}
10001 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
10002 Like the above commands, but use Latin-1 encoding.
10003 @orgcmd{C-c C-e u,org-export-as-utf8}
10004 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
10005 Like the above commands, but use UTF-8 encoding.
10006 @item C-c C-e v a/n/u
10007 Export only the visible part of the document.
10010 @cindex headline levels, for exporting
10011 In the exported version, the first 3 outline levels will become
10012 headlines, defining a general document structure. Additional levels
10013 will be exported as itemized lists. If you want that transition to occur
10014 at a different level, specify it with a prefix argument. For example,
10017 @kbd{C-1 C-c C-e a}
10021 creates only top level headlines and exports the rest as items. When
10022 headlines are converted to items, the indentation of the text following
10023 the headline is changed to fit nicely under the item. This is done with
10024 the assumption that the first body line indicates the base indentation of
10025 the body text. Any indentation larger than this is adjusted to preserve
10026 the layout relative to the first line. Should there be lines with less
10027 indentation than the first one, these are left alone.
10029 @vindex org-export-ascii-links-to-notes
10030 Links will be exported in a footnote-like style, with the descriptive part in
10031 the text and the link in a note before the next heading. See the variable
10032 @code{org-export-ascii-links-to-notes} for details and other options.
10034 @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
10035 @section HTML export
10036 @cindex HTML export
10038 Org mode contains a HTML (XHTML 1.0 strict) exporter with extensive
10039 HTML formatting, in ways similar to John Gruber's @emph{markdown}
10040 language, but with additional support for tables.
10043 * HTML Export commands:: How to invoke HTML export
10044 * HTML preamble and postamble:: How to insert a preamble and a postamble
10045 * Quoting HTML tags:: Using direct HTML in Org mode
10046 * Links in HTML export:: How links will be interpreted and formatted
10047 * Tables in HTML export:: How to modify the formatting of tables
10048 * Images in HTML export:: How to insert figures into HTML output
10049 * Math formatting in HTML export:: Beautiful math also on the web
10050 * Text areas in HTML export:: An alternative way to show an example
10051 * CSS support:: Changing the appearance of the output
10052 * JavaScript support:: Info and Folding in a web browser
10055 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
10056 @subsection HTML export commands
10058 @cindex region, active
10059 @cindex active region
10060 @cindex transient-mark-mode
10062 @orgcmd{C-c C-e h,org-export-as-html}
10063 @cindex property, EXPORT_FILE_NAME
10064 Export as a HTML file. For an Org file @file{myfile.org},
10065 the HTML file will be @file{myfile.html}. The file will be overwritten
10066 without warning. If there is an active region@footnote{This requires
10067 @code{transient-mark-mode} be turned on.}, only the region will be
10068 exported. If the selected region is a single tree@footnote{To select the
10069 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10070 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10071 property, that name will be used for the export.
10072 @orgcmd{C-c C-e b,org-export-as-html-and-open}
10073 Export as a HTML file and immediately open it with a browser.
10074 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
10075 Export to a temporary buffer. Do not create a file.
10076 @orgcmd{C-c C-e R,org-export-region-as-html}
10077 Export the active region to a temporary buffer. With a prefix argument, do
10078 not produce the file header and footer, but just the plain HTML section for
10079 the region. This is good for cut-and-paste operations.
10080 @item C-c C-e v h/b/H/R
10081 Export only the visible part of the document.
10082 @item M-x org-export-region-as-html
10083 Convert the region to HTML under the assumption that it was in Org mode
10084 syntax before. This is a global command that can be invoked in any
10086 @item M-x org-replace-region-by-HTML
10087 Replace the active region (assumed to be in Org mode syntax) by HTML
10091 @cindex headline levels, for exporting
10092 In the exported version, the first 3 outline levels will become headlines,
10093 defining a general document structure. Additional levels will be exported as
10094 itemized lists. If you want that transition to occur at a different level,
10095 specify it with a numeric prefix argument. For example,
10098 @kbd{C-2 C-c C-e b}
10102 creates two levels of headings and does the rest as items.
10105 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
10106 @subsection HTML preamble and postamble
10107 @vindex org-export-html-preamble
10108 @vindex org-export-html-postamble
10109 @vindex org-export-html-preamble-format
10110 @vindex org-export-html-postamble-format
10111 @vindex org-export-html-validation-link
10112 @vindex org-export-author-info
10113 @vindex org-export-email-info
10114 @vindex org-export-creator-info
10115 @vindex org-export-time-stamp-file
10117 The HTML exporter lets you define a preamble and a postamble.
10119 The default value for @code{org-export-html-preamble} is @code{t}, which
10120 means that the preamble is inserted depending on the relevant format string
10121 in @code{org-export-html-preamble-format}.
10123 Setting @code{org-export-html-preamble} to a string will override the default
10124 format string. Setting it to a function, will insert the output of the
10125 function, which must be a string; such a function takes no argument but you
10126 can check against the value of @code{opt-plist}, which contains the list of
10127 publishing properties for the current file. Setting to @code{nil} will not
10128 insert any preamble.
10130 The default value for @code{org-export-html-postamble} is @code{'auto}, which
10131 means that the HTML exporter will look for the value of
10132 @code{org-export-author-info}, @code{org-export-email-info},
10133 @code{org-export-creator-info} and @code{org-export-time-stamp-file},
10134 @code{org-export-html-validation-link} and build the postamble from these
10135 values. Setting @code{org-export-html-postamble} to @code{t} will insert the
10136 postamble from the relevant format string found in
10137 @code{org-export-html-postamble-format}. Setting it to @code{nil} will not
10138 insert any postamble.
10140 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
10141 @subsection Quoting HTML tags
10143 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
10144 @samp{>} in HTML export. If you want to include simple HTML tags
10145 which should be interpreted as such, mark them with @samp{@@} as in
10146 @samp{@@<b>bold text@@</b>}. Note that this really works only for
10147 simple tags. For more extensive HTML that should be copied verbatim to
10148 the exported file use either
10151 @cindex #+BEGIN_HTML
10153 #+HTML: Literal HTML code for export
10157 @cindex #+BEGIN_HTML
10161 All lines between these markers are exported literally
10166 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
10167 @subsection Links in HTML export
10169 @cindex links, in HTML export
10170 @cindex internal links, in HTML export
10171 @cindex external links, in HTML export
10172 Internal links (@pxref{Internal links}) will continue to work in HTML. This
10173 includes automatic links created by radio targets (@pxref{Radio
10174 targets}). Links to external files will still work if the target file is on
10175 the same @i{relative} path as the published Org file. Links to other
10176 @file{.org} files will be translated into HTML links under the assumption
10177 that a HTML version also exists of the linked file, at the same relative
10178 path. @samp{id:} links can then be used to jump to specific entries across
10179 files. For information related to linking files while publishing them to a
10180 publishing directory see @ref{Publishing links}.
10182 If you want to specify attributes for links, you can do so using a special
10183 @code{#+ATTR_HTML} line to define attributes that will be added to the
10184 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
10185 and @code{style} attributes for a link:
10187 @cindex #+ATTR_HTML
10189 #+ATTR_HTML: title="The Org mode homepage" style="color:red;"
10190 [[http://orgmode.org]]
10193 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
10195 @cindex tables, in HTML
10196 @vindex org-export-html-table-tag
10198 Org mode tables are exported to HTML using the table tag defined in
10199 @code{org-export-html-table-tag}. The default setting makes tables without
10200 cell borders and frame. If you would like to change this for individual
10201 tables, place something like the following before the table:
10204 @cindex #+ATTR_HTML
10206 #+CAPTION: This is a table with lines around and between cells
10207 #+ATTR_HTML: border="2" rules="all" frame="border"
10210 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
10211 @subsection Images in HTML export
10213 @cindex images, inline in HTML
10214 @cindex inlining images in HTML
10215 @vindex org-export-html-inline-images
10216 HTML export can inline images given as links in the Org file, and
10217 it can make an image the clickable part of a link. By
10218 default@footnote{But see the variable
10219 @code{org-export-html-inline-images}.}, images are inlined if a link does
10220 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
10221 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
10222 @samp{the image} that points to the image. If the description part
10223 itself is a @code{file:} link or a @code{http:} URL pointing to an
10224 image, this image will be inlined and activated so that clicking on the
10225 image will activate the link. For example, to include a thumbnail that
10226 will link to a high resolution version of the image, you could use:
10229 [[file:highres.jpg][file:thumb.jpg]]
10232 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
10233 In the example below we specify the @code{alt} and @code{title} attributes to
10234 support text viewers and accessibility, and align it to the right.
10237 @cindex #+ATTR_HTML
10239 #+CAPTION: A black cat stalking a spider
10240 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
10245 You could use @code{http} addresses just as well.
10247 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
10248 @subsection Math formatting in HTML export
10252 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
10253 different ways on HTML pages. The default is to use the
10254 @uref{http://www.mathjax.org, MathJax system} which should work out of the
10255 box with Org mode installation because @code{http://orgmode.org} serves
10256 @file{MathJax} for Org mode users for small applications and for testing
10257 purposes. @b{If you plan to use this regularly or on pages with significant
10258 page views, you should install@footnote{Installation instructions can be
10259 found on the MathJax website, see
10260 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
10261 your own server in order to limit the load of our server.} To configure
10262 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
10263 insert something like the following into the buffer:
10266 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
10269 @noindent See the docstring of the variable
10270 @code{org-export-html-mathjax-options} for the meaning of the parameters in
10273 If you prefer, you can also request that @LaTeX{} fragments are processed
10274 into small images that will be inserted into the browser page. Before the
10275 availability of MathJax, this was the default method for Org files. This
10276 method requires that the @file{dvipng} program is available on your system.
10277 You can still get this processing with
10280 #+OPTIONS: LaTeX:dvipng
10283 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
10284 @subsection Text areas in HTML export
10286 @cindex text areas, in HTML
10287 An alternative way to publish literal code examples in HTML is to use text
10288 areas, where the example can even be edited before pasting it into an
10289 application. It is triggered by a @code{-t} switch at an @code{example} or
10290 @code{src} block. Using this switch disables any options for syntax and
10291 label highlighting, and line numbering, which may be present. You may also
10292 use @code{-h} and @code{-w} switches to specify the height and width of the
10293 text area, which default to the number of lines in the example, and 80,
10294 respectively. For example
10297 #+BEGIN_EXAMPLE -t -w 40
10298 (defun org-xor (a b)
10305 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
10306 @subsection CSS support
10307 @cindex CSS, for HTML export
10308 @cindex HTML export, CSS
10310 @vindex org-export-html-todo-kwd-class-prefix
10311 @vindex org-export-html-tag-class-prefix
10312 You can also give style information for the exported file. The HTML exporter
10313 assigns the following special CSS classes@footnote{If the classes on TODO
10314 keywords and tags lead to conflicts, use the variables
10315 @code{org-export-html-todo-kwd-class-prefix} and
10316 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
10317 parts of the document---your style specifications may change these, in
10318 addition to any of the standard classes like for headlines, tables, etc.
10320 p.author @r{author information, including email}
10321 p.date @r{publishing date}
10322 p.creator @r{creator info, about org mode version}
10323 .title @r{document title}
10324 .todo @r{TODO keywords, all not-done states}
10325 .done @r{the DONE keywords, all states that count as done}
10326 .WAITING @r{each TODO keyword also uses a class named after itself}
10327 .timestamp @r{timestamp}
10328 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
10329 .timestamp-wrapper @r{span around keyword plus timestamp}
10330 .tag @r{tag in a headline}
10331 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
10332 .target @r{target for links}
10333 .linenr @r{the line number in a code example}
10334 .code-highlighted @r{for highlighting referenced code lines}
10335 div.outline-N @r{div for outline level N (headline plus text))}
10336 div.outline-text-N @r{extra div for text at outline level N}
10337 .section-number-N @r{section number in headlines, different for each level}
10338 div.figure @r{how to format an inlined image}
10339 pre.src @r{formatted source code}
10340 pre.example @r{normal example}
10341 p.verse @r{verse paragraph}
10342 div.footnotes @r{footnote section headline}
10343 p.footnote @r{footnote definition paragraph, containing a footnote}
10344 .footref @r{a footnote reference number (always a <sup>)}
10345 .footnum @r{footnote number in footnote definition (always <sup>)}
10348 @vindex org-export-html-style-default
10349 @vindex org-export-html-style-include-default
10350 @vindex org-export-html-style
10351 @vindex org-export-html-extra
10352 @vindex org-export-html-style-default
10353 Each exported file contains a compact default style that defines these
10354 classes in a basic way@footnote{This style is defined in the constant
10355 @code{org-export-html-style-default}, which you should not modify. To turn
10356 inclusion of these defaults off, customize
10357 @code{org-export-html-style-include-default}}. You may overwrite these
10358 settings, or add to them by using the variables @code{org-export-html-style}
10359 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
10360 fine-grained settings, like file-local settings). To set the latter variable
10361 individually for each file, you can use
10365 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
10369 For longer style definitions, you can use several such lines. You could also
10370 directly write a @code{<style>} @code{</style>} section in this way, without
10371 referring to an external file.
10373 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
10374 property to assign a class to the tree. In order to specify CSS styles for a
10375 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
10378 @c FIXME: More about header and footer styles
10379 @c FIXME: Talk about links and targets.
10381 @node JavaScript support, , CSS support, HTML export
10382 @subsection JavaScript supported display of web pages
10384 @cindex Rose, Sebastian
10385 Sebastian Rose has written a JavaScript program especially designed to
10386 enhance the web viewing experience of HTML files created with Org. This
10387 program allows you to view large files in two different ways. The first one
10388 is an @emph{Info}-like mode where each section is displayed separately and
10389 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
10390 as well, press @kbd{?} for an overview of the available keys). The second
10391 view type is a @emph{folding} view much like Org provides inside Emacs. The
10392 script is available at @url{http://orgmode.org/org-info.js} and you can find
10393 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
10394 We host the script at our site, but if you use it a lot, you might
10395 not want to be dependent on @url{orgmode.org} and prefer to install a local
10396 copy on your own web server.
10398 To use the script, you need to make sure that the @file{org-jsinfo.el} module
10399 gets loaded. It should be loaded by default, but you can try @kbd{M-x
10400 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
10401 this is indeed the case. All it then takes to make use of the program is
10402 adding a single line to the Org file:
10404 @cindex #+INFOJS_OPT
10406 #+INFOJS_OPT: view:info toc:nil
10410 If this line is found, the HTML header will automatically contain the code
10411 needed to invoke the script. Using the line above, you can set the following
10415 path: @r{The path to the script. The default is to grab the script from}
10416 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
10417 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
10418 view: @r{Initial view when the website is first shown. Possible values are:}
10419 info @r{Info-like interface with one section per page.}
10420 overview @r{Folding interface, initially showing only top-level.}
10421 content @r{Folding interface, starting with all headlines visible.}
10422 showall @r{Folding interface, all headlines and text visible.}
10423 sdepth: @r{Maximum headline level that will still become an independent}
10424 @r{section for info and folding modes. The default is taken from}
10425 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
10426 @r{If this is smaller than in @code{org-export-headline-levels}, each}
10427 @r{info/folding section can still contain child headlines.}
10428 toc: @r{Should the table of contents @emph{initially} be visible?}
10429 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
10430 tdepth: @r{The depth of the table of contents. The defaults are taken from}
10431 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
10432 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
10433 @r{If yes, the toc will never be displayed as a section.}
10434 ltoc: @r{Should there be short contents (children) in each section?}
10435 @r{Make this @code{above} if the section should be above initial text.}
10436 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
10437 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
10438 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
10439 @r{default), only one such button will be present.}
10442 @vindex org-infojs-options
10443 @vindex org-export-html-use-infojs
10444 You can choose default values for these options by customizing the variable
10445 @code{org-infojs-options}. If you always want to apply the script to your
10446 pages, configure the variable @code{org-export-html-use-infojs}.
10448 @node @LaTeX{} and PDF export, DocBook export, HTML export, Exporting
10449 @section @LaTeX{} and PDF export
10450 @cindex @LaTeX{} export
10452 @cindex Guerry, Bastien
10454 Org mode contains a @LaTeX{} exporter written by Bastien Guerry. With
10455 further processing@footnote{The default @LaTeX{} output is designed for
10456 processing with @code{pdftex} or @LaTeX{}. It includes packages that are not
10457 compatible with @code{xetex} and possibly @code{luatex}. See the variables
10458 @code{org-export-latex-default-packages-alist} and
10459 @code{org-export-latex-packages-alist}.}, this backend is also used to
10460 produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
10461 implement links and cross references, the PDF output file will be fully
10462 linked. Beware of the fact that your @code{org} file has to be properly
10463 structured in order to be correctly exported: respect the hierarchy of
10467 * @LaTeX{}/PDF export commands::
10468 * Header and sectioning:: Setting up the export file structure
10469 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
10470 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
10471 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
10472 * Beamer class export:: Turning the file into a presentation
10475 @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
10476 @subsection @LaTeX{} export commands
10478 @cindex region, active
10479 @cindex active region
10480 @cindex transient-mark-mode
10482 @orgcmd{C-c C-e l,org-export-as-latex}
10483 @cindex property EXPORT_FILE_NAME
10484 Export as a @LaTeX{} file. For an Org file
10485 @file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will
10486 be overwritten without warning. If there is an active region@footnote{This
10487 requires @code{transient-mark-mode} be turned on.}, only the region will be
10488 exported. If the selected region is a single tree@footnote{To select the
10489 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10490 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
10491 property, that name will be used for the export.
10492 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
10493 Export to a temporary buffer. Do not create a file.
10494 @item C-c C-e v l/L
10495 Export only the visible part of the document.
10496 @item M-x org-export-region-as-latex
10497 Convert the region to @LaTeX{} under the assumption that it was in Org mode
10498 syntax before. This is a global command that can be invoked in any
10500 @item M-x org-replace-region-by-latex
10501 Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
10503 @orgcmd{C-c C-e p,org-export-as-pdf}
10504 Export as @LaTeX{} and then process to PDF.
10505 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
10506 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10509 @cindex headline levels, for exporting
10510 @vindex org-latex-low-levels
10511 In the exported version, the first 3 outline levels will become
10512 headlines, defining a general document structure. Additional levels
10513 will be exported as description lists. The exporter can ignore them or
10514 convert them to a custom string depending on
10515 @code{org-latex-low-levels}.
10517 If you want that transition to occur at a different level, specify it
10518 with a numeric prefix argument. For example,
10521 @kbd{C-2 C-c C-e l}
10525 creates two levels of headings and does the rest as items.
10527 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
10528 @subsection Header and sectioning structure
10529 @cindex @LaTeX{} class
10530 @cindex @LaTeX{} sectioning structure
10531 @cindex @LaTeX{} header
10532 @cindex header, for @LaTeX{} files
10533 @cindex sectioning structure, for @LaTeX{} export
10535 By default, the @LaTeX{} output uses the class @code{article}.
10537 @vindex org-export-latex-default-class
10538 @vindex org-export-latex-classes
10539 @vindex org-export-latex-default-packages-alist
10540 @vindex org-export-latex-packages-alist
10541 @cindex #+LaTeX_HEADER
10542 @cindex #+LaTeX_CLASS
10543 @cindex #+LaTeX_CLASS_OPTIONS
10544 @cindex property, LaTeX_CLASS
10545 @cindex property, LaTeX_CLASS_OPTIONS
10546 You can change this globally by setting a different value for
10547 @code{org-export-latex-default-class} or locally by adding an option like
10548 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
10549 property that applies when exporting a region containing only this (sub)tree.
10550 The class must be listed in @code{org-export-latex-classes}. This variable
10551 defines a header template for each class@footnote{Into which the values of
10552 @code{org-export-latex-default-packages-alist} and
10553 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
10554 define the sectioning structure for each class. You can also define your own
10555 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{:LaTeX_CLASS_OPTIONS:}
10556 property can specify the options for the @code{\documentclass} macro. The
10557 options to documentclass have to be provided, as expected by @LaTeX{}, within
10558 square brackets. You can also use @code{#+LaTeX_HEADER: \usepackage@{xyz@}}
10559 to add lines to the header. See the docstring of
10560 @code{org-export-latex-classes} for more information. An example is shown
10564 #+LaTeX_CLASS: article
10565 #+LaTeX_CLASS_OPTIONS: [a4paper]
10566 #+LaTeX_HEADER: \usepackage@{xyz@}
10572 @node Quoting @LaTeX{} code, Tables in @LaTeX{} export, Header and sectioning, @LaTeX{} and PDF export
10573 @subsection Quoting @LaTeX{} code
10575 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
10576 inserted into the @LaTeX{} file. This includes simple macros like
10577 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
10578 you can add special code that should only be present in @LaTeX{} export with
10579 the following constructs:
10582 @cindex #+BEGIN_LaTeX
10584 #+LaTeX: Literal @LaTeX{} code for export
10588 @cindex #+BEGIN_LaTeX
10592 All lines between these markers are exported literally
10597 @node Tables in @LaTeX{} export, Images in @LaTeX{} export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
10598 @subsection Tables in @LaTeX{} export
10599 @cindex tables, in @LaTeX{} export
10601 For @LaTeX{} export of a table, you can specify a label, a caption and
10602 placement options (@pxref{Images and tables}). You can also use the
10603 @code{ATTR_LaTeX} line to request a @code{longtable} environment for the
10604 table, so that it may span several pages, or to change the default table
10605 environment from @code{table} to @code{table*} or to change the default inner
10606 tabular environment to @code{tabularx} or @code{tabulary}. Finally, you can
10607 set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
10612 @cindex #+ATTR_LaTeX
10614 #+CAPTION: A long table
10616 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10621 or to specify a multicolumn table with @code{tabulary}
10625 @cindex #+ATTR_LaTeX
10627 #+CAPTION: A wide table with tabulary
10629 #+ATTR_LaTeX: table* tabulary width=\textwidth
10634 @node Images in @LaTeX{} export, Beamer class export, Tables in @LaTeX{} export, @LaTeX{} and PDF export
10635 @subsection Images in @LaTeX{} export
10636 @cindex images, inline in @LaTeX{}
10637 @cindex inlining images in @LaTeX{}
10639 Images that are linked to without a description part in the link, like
10640 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10641 output file resulting from @LaTeX{} processing. Org will use an
10642 @code{\includegraphics} macro to insert the image. If you have specified a
10643 caption and/or a label as described in @ref{Images and tables}, the figure
10644 will be wrapped into a @code{figure} environment and thus become a floating
10645 element. You can use an @code{#+ATTR_LaTeX:} line to specify various other
10646 options. You can ask org to export an image as a float without specifying
10647 a label or a caption by using the keyword @code{float} in this line. Various
10648 optional arguments to the @code{\includegraphics} macro can also be specified
10649 in this fashion. To modify the placement option of the floating environment,
10650 add something like @samp{placement=[h!]} to the attributes. It is to be noted
10651 this option can be used with tables as well@footnote{One can also take
10652 advantage of this option to pass other, unrelated options into the figure or
10653 table environment. For an example see the section ``Exporting org files'' in
10654 @url{http://orgmode.org/worg/org-hacks.html}}.
10656 If you would like to let text flow around the image, add the word @samp{wrap}
10657 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10658 half of the page. To fine-tune, the @code{placement} field will be the set
10659 of additional arguments needed by the @code{wrapfigure} environment. Note
10660 that if you change the size of the image, you need to use compatible settings
10661 for @code{\includegraphics} and @code{wrapfigure}.
10665 @cindex #+ATTR_LaTeX
10667 #+CAPTION: The black-body emission of the disk around HR 4049
10668 #+LABEL: fig:SED-HR4049
10669 #+ATTR_LaTeX: width=5cm,angle=90
10670 [[./img/sed-hr4049.pdf]]
10672 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10676 If you wish to include an image which spans multiple columns in a page, you
10677 can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line. This
10678 will export the image wrapped in a @code{figure*} environment.
10680 If you need references to a label created in this way, write
10681 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10683 @node Beamer class export, , Images in @LaTeX{} export, @LaTeX{} and PDF export
10684 @subsection Beamer class export
10686 The @LaTeX{} class @file{beamer} allows production of high quality presentations
10687 using @LaTeX{} and pdf processing. Org mode has special support for turning an
10688 Org mode file or tree into a @file{beamer} presentation.
10690 When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
10691 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10692 @code{beamer}, a special export mode will turn the file or tree into a beamer
10693 presentation. Any tree with not-too-deep level nesting should in principle be
10694 exportable as a beamer presentation. By default, the top-level entries (or
10695 the first level below the selected subtree heading) will be turned into
10696 frames, and the outline structure below this level will become itemize lists.
10697 You can also configure the variable @code{org-beamer-frame-level} to a
10698 different level---then the hierarchy above frames will produce the sectioning
10699 structure of the presentation.
10701 A template for useful in-buffer settings or properties can be inserted into
10702 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10703 things, this will install a column view format which is very handy for
10704 editing special properties used by beamer.
10706 You can influence the structure of the presentation using the following
10711 The environment that should be used to format this entry. Valid environments
10712 are defined in the constant @code{org-beamer-environments-default}, and you
10713 can define more in @code{org-beamer-environments-extra}. If this property is
10714 set, the entry will also get a @code{:B_environment:} tag to make this
10715 visible. This tag has no semantic meaning, it is only a visual aid.
10716 @item BEAMER_envargs
10717 The beamer-special arguments that should be used for the environment, like
10718 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10719 property is also set, something like @code{C[t]} can be added here as well to
10720 set an options argument for the implied @code{columns} environment.
10721 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10724 The width of a column that should start with this entry. If this property is
10725 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10726 Also this tag is only a visual aid. When this is a plain number, it will be
10727 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10728 that you have specified the units, like @samp{3cm}. The first such property
10729 in a frame will start a @code{columns} environment to surround the columns.
10730 This environment is closed when an entry has a @code{BEAMER_col} property
10731 with value 0 or 1, or automatically at the end of the frame.
10733 Additional commands that should be inserted after the environment has been
10734 opened. For example, when creating a frame, this can be used to specify
10738 Frames will automatically receive a @code{fragile} option if they contain
10739 source code that uses the verbatim environment. Special @file{beamer}
10740 specific code can be inserted using @code{#+BEAMER:} and
10741 @code{#+BEGIN_BEAMER...#+END_BEAMER} constructs, similar to other export
10742 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10743 in the presentation as well.
10745 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10746 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10747 into @code{\note@{...@}}. The former will include the heading as part of the
10748 note text, the latter will ignore the heading of that node. To simplify note
10749 generation, it is actually enough to mark the note with a @emph{tag} (either
10750 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10751 @code{BEAMER_env} property.
10753 You can turn on a special minor mode @code{org-beamer-mode} for editing
10761 @orgcmd{C-c C-b,org-beamer-select-environment}
10762 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10763 environment or the @code{BEAMER_col} property.
10766 Column view provides a great way to set the environment of a node and other
10767 important parameters. Make sure you are using a COLUMN format that is geared
10768 toward this special purpose. The command @kbd{M-x
10769 org-insert-beamer-options-template} defines such a format.
10771 Here is a simple example Org document that is intended for beamer export.
10774 #+LaTeX_CLASS: beamer
10775 #+TITLE: Example Presentation
10776 #+AUTHOR: Carsten Dominik
10777 #+LaTeX_CLASS_OPTIONS: [presentation]
10778 #+BEAMER_FRAME_LEVEL: 2
10779 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10780 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10782 * This is the first structural section
10784 ** Frame 1 \\ with a subtitle
10785 *** Thanks to Eric Fraga :BMCOL:B_block:
10788 :BEAMER_envargs: C[t]
10791 for the first viable beamer setup in Org
10792 *** Thanks to everyone else :BMCOL:B_block:
10796 :BEAMER_envargs: <2->
10798 for contributing to the discussion
10799 **** This will be formatted as a beamer note :B_note:
10800 ** Frame 2 \\ where we will not use columns
10801 *** Request :B_block:
10802 Please test this stuff!
10808 For more information, see the documentation on Worg.
10810 @node DocBook export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
10811 @section DocBook export
10812 @cindex DocBook export
10814 @cindex Cui, Baoqiu
10816 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10817 exported to DocBook format, it can be further processed to produce other
10818 formats, including PDF, HTML, man pages, etc., using many available DocBook
10819 tools and stylesheets.
10821 Currently DocBook exporter only supports DocBook V5.0.
10824 * DocBook export commands:: How to invoke DocBook export
10825 * Quoting DocBook code:: Incorporating DocBook code in Org files
10826 * Recursive sections:: Recursive sections in DocBook
10827 * Tables in DocBook export:: Tables are exported as HTML tables
10828 * Images in DocBook export:: How to insert figures into DocBook output
10829 * Special characters:: How to handle special characters
10832 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10833 @subsection DocBook export commands
10835 @cindex region, active
10836 @cindex active region
10837 @cindex transient-mark-mode
10839 @orgcmd{C-c C-e D,org-export-as-docbook}
10840 @cindex property EXPORT_FILE_NAME
10841 Export as a DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10842 file will be @file{myfile.xml}. The file will be overwritten without
10843 warning. If there is an active region@footnote{This requires
10844 @code{transient-mark-mode} to be turned on}, only the region will be
10845 exported. If the selected region is a single tree@footnote{To select the
10846 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10847 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10848 property, that name will be used for the export.
10849 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10850 Export as a DocBook file, process to PDF, then open the resulting PDF file.
10852 @vindex org-export-docbook-xslt-proc-command
10853 @vindex org-export-docbook-xsl-fo-proc-command
10854 Note that, in order to produce PDF output based on an exported DocBook file,
10855 you need to have XSLT processor and XSL-FO processor software installed on your
10856 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10857 @code{org-export-docbook-xsl-fo-proc-command}.
10859 @vindex org-export-docbook-xslt-stylesheet
10860 The stylesheet argument @code{%s} in variable
10861 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10862 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10863 the user. You can also overrule this global setting on a per-file basis by
10864 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10866 @orgkey{C-c C-e v D}
10867 Export only the visible part of the document.
10870 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10871 @subsection Quoting DocBook code
10873 You can quote DocBook code in Org files and copy it verbatim into exported
10874 DocBook file with the following constructs:
10877 @cindex #+BEGIN_DOCBOOK
10879 #+DOCBOOK: Literal DocBook code for export
10883 @cindex #+BEGIN_DOCBOOK
10887 All lines between these markers are exported by DocBook exporter
10892 For example, you can use the following lines to include a DocBook warning
10893 admonition. As to what this warning says, you should pay attention to the
10894 document context when quoting DocBook code in Org files. You may make
10895 exported DocBook XML files invalid by not quoting DocBook code correctly.
10900 <para>You should know what you are doing when quoting DocBook XML code
10901 in your Org file. Invalid DocBook XML may be generated by
10902 DocBook exporter if you are not careful!</para>
10907 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
10908 @subsection Recursive sections
10909 @cindex DocBook recursive sections
10911 DocBook exporter exports Org files as articles using the @code{article}
10912 element in DocBook. Recursive sections, i.e.@: @code{section} elements, are
10913 used in exported articles. Top level headlines in Org files are exported as
10914 top level sections, and lower level headlines are exported as nested
10915 sections. The entire structure of Org files will be exported completely, no
10916 matter how many nested levels of headlines there are.
10918 Using recursive sections makes it easy to port and reuse exported DocBook
10919 code in other DocBook document types like @code{book} or @code{set}.
10921 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
10922 @subsection Tables in DocBook export
10923 @cindex tables, in DocBook export
10925 Tables in Org files are exported as HTML tables, which have been supported since
10928 If a table does not have a caption, an informal table is generated using the
10929 @code{informaltable} element; otherwise, a formal table will be generated
10930 using the @code{table} element.
10932 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
10933 @subsection Images in DocBook export
10934 @cindex images, inline in DocBook
10935 @cindex inlining images in DocBook
10937 Images that are linked to without a description part in the link, like
10938 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
10939 using @code{mediaobject} elements. Each @code{mediaobject} element contains
10940 an @code{imageobject} that wraps an @code{imagedata} element. If you have
10941 specified a caption for an image as described in @ref{Images and tables}, a
10942 @code{caption} element will be added in @code{mediaobject}. If a label is
10943 also specified, it will be exported as an @code{xml:id} attribute of the
10944 @code{mediaobject} element.
10946 @vindex org-export-docbook-default-image-attributes
10947 Image attributes supported by the @code{imagedata} element, like @code{align}
10948 or @code{width}, can be specified in two ways: you can either customize
10949 variable @code{org-export-docbook-default-image-attributes} or use the
10950 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
10951 @code{org-export-docbook-default-image-attributes} are applied to all inline
10952 images in the Org file to be exported (unless they are overridden by image
10953 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
10955 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
10956 attributes or override default image attributes for individual images. If
10957 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
10958 variable @code{org-export-docbook-default-image-attributes}, the former
10959 takes precedence. Here is an example about how image attributes can be
10964 @cindex #+ATTR_DOCBOOK
10966 #+CAPTION: The logo of Org mode
10967 #+LABEL: unicorn-svg
10968 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
10969 [[./img/org-mode-unicorn.svg]]
10972 @vindex org-export-docbook-inline-image-extensions
10973 By default, DocBook exporter recognizes the following image file types:
10974 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
10975 customize variable @code{org-export-docbook-inline-image-extensions} to add
10976 more types to this list as long as DocBook supports them.
10978 @node Special characters, , Images in DocBook export, DocBook export
10979 @subsection Special characters in DocBook export
10980 @cindex Special characters in DocBook export
10982 @vindex org-export-docbook-doctype
10983 @vindex org-entities
10984 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
10985 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
10986 characters are rewritten to XML entities, like @code{α},
10987 @code{Γ}, and @code{Ζ}, based on the list saved in variable
10988 @code{org-entities}. As long as the generated DocBook file includes the
10989 corresponding entities, these special characters are recognized.
10991 You can customize variable @code{org-export-docbook-doctype} to include the
10992 entities you need. For example, you can set variable
10993 @code{org-export-docbook-doctype} to the following value to recognize all
10994 special characters included in XHTML entities:
10997 "<!DOCTYPE article [
10998 <!ENTITY % xhtml1-symbol PUBLIC
10999 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
11000 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
11007 @c begin opendocument
11009 @node OpenDocument Text export, TaskJuggler export, DocBook export, Exporting
11010 @section OpenDocument Text export
11011 @cindex K, Jambunathan
11013 @cindex OpenDocument
11014 @cindex export, OpenDocument
11015 @cindex LibreOffice
11017 @cindex org-modules
11019 Org Mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
11020 (ODT) format using the @file{org-odt.el} module. Documents created
11021 by this exporter use the @cite{OpenDocument-v1.2
11022 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11023 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
11024 are compatible with LibreOffice 3.4.
11027 * Pre-requisites for ODT export:: What packages ODT exporter relies on
11028 * ODT export commands:: How to invoke ODT export
11029 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
11030 * Applying custom styles:: How to apply custom styles to the output
11031 * Links in ODT export:: How links will be interpreted and formatted
11032 * Tables in ODT export:: How Tables are exported
11033 * Images in ODT export:: How to insert images
11034 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
11035 * Labels and captions in ODT export:: How captions are rendered
11036 * Literal examples in ODT export:: How source and example blocks are formatted
11037 * Advanced topics in ODT export:: Read this if you are a power user
11040 @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
11041 @subsection Pre-requisites for ODT export
11043 The ODT exporter relies on the @file{zip} program to create the final
11044 output. Check the availability of this program before proceeding further.
11046 @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
11047 @subsection ODT export commands
11049 @subsubheading Exporting to ODT
11050 @anchor{x-export-to-odt}
11052 @cindex region, active
11053 @cindex active region
11054 @cindex transient-mark-mode
11056 @orgcmd{C-c C-e o,org-export-as-odt}
11057 @cindex property EXPORT_FILE_NAME
11059 Export as OpenDocument Text file.
11061 @vindex org-export-odt-preferred-output-format
11062 If @code{org-export-odt-preferred-output-format} is specified, automatically
11063 convert the exported file to that format. @xref{x-export-to-other-formats, ,
11064 Automatically exporting to other formats}.
11066 For an Org file @file{myfile.org}, the ODT file will be
11067 @file{myfile.odt}. The file will be overwritten without warning. If there
11068 is an active region,@footnote{This requires @code{transient-mark-mode} to be
11069 turned on} only the region will be exported. If the selected region is a
11070 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
11071 tree head will become the document title. If the tree head entry has, or
11072 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
11075 @orgcmd{C-c C-e O,org-export-as-odt-and-open}
11076 Export as an OpenDocument Text file and open the resulting file.
11078 @vindex org-export-odt-preferred-output-format
11079 If @code{org-export-odt-preferred-output-format} is specified, open the
11080 converted file instead. @xref{x-export-to-other-formats, , Automatically
11081 exporting to other formats}.
11084 @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
11085 @subsection Extending ODT export
11087 The ODT exporter can interface with a variety of document
11088 converters and supports popular converters out of the box. As a result, you
11089 can use it to export to formats like @samp{doc} or convert a document from
11090 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
11092 @cindex @file{unoconv}
11093 @cindex LibreOffice
11094 If you have a working installation of LibreOffice, a document converter is
11095 pre-configured for you and you can use it right away. If you would like to
11096 use @file{unoconv} as your preferred converter, customize the variable
11097 @code{org-export-odt-convert-process} to point to @code{unoconv}. You can
11098 also use your own favorite converter or tweak the default settings of the
11099 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
11100 document converter}.
11102 @subsubsection Automatically exporting to other formats
11103 @anchor{x-export-to-other-formats}
11105 @vindex org-export-odt-preferred-output-format
11106 Very often, you will find yourself exporting to ODT format, only to
11107 immediately save the exported document to other formats like @samp{doc},
11108 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
11109 preferred output format by customizing the variable
11110 @code{org-export-odt-preferred-output-format}. This way, the export commands
11111 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
11112 format that is of immediate interest to you.
11114 @subsubsection Converting between document formats
11115 @anchor{x-convert-to-other-formats}
11117 There are many document converters in the wild which support conversion to
11118 and from various file formats, including, but not limited to the
11119 ODT format. LibreOffice converter, mentioned above, is one such
11120 converter. Once a converter is configured, you can interact with it using
11121 the following command.
11123 @vindex org-export-odt-convert
11126 @item M-x org-export-odt-convert
11127 Convert an existing document from one format to another. With a prefix
11128 argument, also open the newly produced file.
11131 @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
11132 @subsection Applying custom styles
11133 @cindex styles, custom
11134 @cindex template, custom
11136 The ODT exporter ships with a set of OpenDocument styles
11137 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
11138 output. These factory styles, however, may not cater to your specific
11139 tastes. To customize the output, you can either modify the above styles
11140 files directly, or generate the required styles using an application like
11141 LibreOffice. The latter method is suitable for expert and non-expert
11142 users alike, and is described here.
11144 @subsubsection Applying custom styles - the easy way
11148 Create a sample @file{example.org} file with the below settings and export it
11152 #+OPTIONS: H:10 num:t
11156 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
11157 to locate the target styles - these typically have the @samp{Org} prefix -
11158 and modify those to your taste. Save the modified file either as an
11159 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
11162 @cindex #+ODT_STYLES_FILE
11163 @vindex org-export-odt-styles-file
11164 Customize the variable @code{org-export-odt-styles-file} and point it to the
11165 newly created file. For additional configuration options
11166 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
11168 If you would like to choose a style on a per-file basis, you can use the
11169 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
11172 #+ODT_STYLES_FILE: "/path/to/example.ott"
11178 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
11183 @subsubsection Using third-party styles and templates
11185 You can use third-party styles and templates for customizing your output.
11186 This will produce the desired output only if the template provides all
11187 style names that the @samp{ODT} exporter relies on. Unless this condition is
11188 met, the output is going to be less than satisfactory. So it is highly
11189 recommended that you only work with templates that are directly derived from
11190 the factory settings.
11192 @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
11193 @subsection Links in ODT export
11194 @cindex tables, in DocBook export
11196 ODT exporter creates native cross-references for internal links. It creates
11197 Internet-style links for all other links.
11199 A link with no description and destined to a regular (un-itemized) outline
11200 heading is replaced with a cross-reference and section number of the heading.
11202 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
11203 with a cross-reference and sequence number of the labeled entity.
11204 @xref{Labels and captions in ODT export}.
11206 @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
11207 @subsection Tables in ODT export
11208 @cindex tables, in DocBook export
11210 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
11211 tables is supported. However, export of complex @file{table.el} tables -
11212 tables that have column or row spans - is not supported. Such tables are
11213 stripped from the exported document.
11215 By default, a table is exported with top and bottom frames and with rules
11216 separating row and column groups (@pxref{Column groups}). Furthermore, all
11217 tables are typeset to occupy the same width. If the table specifies
11218 alignment and relative width for its columns (@pxref{Column width and
11219 alignment}) then these are honored on export.@footnote{The column widths are
11220 interpreted as weighted ratios with the default weight being 1}
11223 You can control the width of the table by specifying @code{:rel-width}
11224 property using an @code{#+ATTR_ODT} line.
11226 For example, consider the following table which makes use of all the rules
11230 #+ATTR_ODT: :rel-width 50
11231 | Area/Month | Jan | Feb | Mar | Sum |
11232 |---------------+-------+-------+-------+-------|
11234 | <l13> | <r5> | <r5> | <r5> | <r6> |
11235 | North America | 1 | 21 | 926 | 948 |
11236 | Middle East | 6 | 75 | 844 | 925 |
11237 | Asia Pacific | 9 | 27 | 790 | 826 |
11238 |---------------+-------+-------+-------+-------|
11239 | Sum | 16 | 123 | 2560 | 2699 |
11242 On export, the table will occupy 50% of text area. The columns will be sized
11243 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
11244 and rest of the columns will be right-aligned. There will be vertical rules
11245 after separating the header and last columns from other columns. There will
11246 be horizontal rules separating the header and last rows from other rows.
11248 If you are not satisfied with the above formatting options, you can create
11249 custom table styles and associate them with a table using the
11250 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
11252 @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
11253 @subsection Images in ODT export
11254 @cindex images, embedding in ODT
11255 @cindex embedding images in ODT
11257 @subsubheading Embedding images
11258 You can embed images within the exported document by providing a link to the
11259 desired image file with no link description. For example, to embed
11260 @samp{img.png} do either of the following:
11270 @subsubheading Embedding clickable images
11271 You can create clickable images by providing a link whose description is a
11272 link to an image file. For example, to embed a image
11273 @file{org-mode-unicorn.png} which when clicked jumps to
11274 @uref{http://Orgmode.org} website, do the following
11277 [[http://orgmode.org][./org-mode-unicorn.png]]
11280 @subsubheading Sizing and scaling of embedded images
11283 You can control the size and scale of the embedded images using the
11284 @code{#+ATTR_ODT} attribute.
11286 @cindex identify, ImageMagick
11287 @vindex org-export-odt-pixels-per-inch
11288 The exporter specifies the desired size of the image in the final document in
11289 units of centimeters. In order to scale the embedded images, the exporter
11290 queries for pixel dimensions of the images using one of a) ImageMagick's
11291 @file{identify} program or b) Emacs `create-image' and `image-size'
11292 APIs.@footnote{Use of @file{ImageMagick} is only desirable. However, if you
11293 routinely produce documents that have large images or you export your Org
11294 files that has images using a Emacs batch script, then the use of
11295 @file{ImageMagick} is mandatory.} The pixel dimensions are subsequently
11296 converted in to units of centimeters using
11297 @code{org-export-odt-pixels-per-inch}. The default value of this variable is
11298 set to @code{display-pixels-per-inch}. You can tweak this variable to
11299 achieve the best results.
11301 The examples below illustrate the various possibilities.
11304 @item Explicitly size the image
11305 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
11308 #+ATTR_ODT: :width 10 :height 10
11312 @item Scale the image
11313 To embed @file{img.png} at half its size, do the following:
11316 #+ATTR_ODT: :scale 0.5
11320 @item Scale the image to a specific width
11321 To embed @file{img.png} with a width of 10 cm while retaining the original
11322 height:width ratio, do the following:
11325 #+ATTR_ODT: :width 10
11329 @item Scale the image to a specific height
11330 To embed @file{img.png} with a height of 10 cm while retaining the original
11331 height:width ratio, do the following
11334 #+ATTR_ODT: :height 10
11339 @subsubheading Anchoring of images
11342 You can control the manner in which an image is anchored by setting the
11343 @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
11344 of the the following three values for the @code{:anchor} property -
11345 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
11347 To create an image that is anchored to a page, do the following:
11349 #+ATTR_ODT: :anchor "page"
11353 @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
11354 @subsection Math formatting in ODT export
11356 The ODT exporter has special support for handling math.
11359 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
11360 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
11363 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
11364 @subsubsection Working with @LaTeX{} math snippets
11366 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
11367 document in one of the following ways:
11373 This option is activated on a per-file basis with
11379 With this option, @LaTeX{} fragments are first converted into MathML
11380 fragments using an external @LaTeX{}-to-MathML converter program. The
11381 resulting MathML fragments are then embedded as an OpenDocument Formula in
11382 the exported document.
11384 @vindex org-latex-to-mathml-convert-command
11385 @vindex org-latex-to-mathml-jar-file
11387 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
11388 @code{org-latex-to-mathml-convert-command} and
11389 @code{org-latex-to-mathml-jar-file}.
11391 If you prefer to use @file{MathToWeb}@footnote{See
11392 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
11393 converter, you can configure the above variables as shown below.
11396 (setq org-latex-to-mathml-convert-command
11397 "java -jar %j -unicode -force -df %o %I"
11398 org-latex-to-mathml-jar-file
11399 "/path/to/mathtoweb.jar")
11402 You can use the following commands to quickly verify the reliability of
11403 the @LaTeX{}-to-MathML converter.
11407 @item M-x org-export-as-odf
11408 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
11410 @item M-x org-export-as-odf-and-open
11411 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
11412 and open the formula file with the system-registered application.
11418 This option is activated on a per-file basis with
11421 #+OPTIONS: LaTeX:dvipng
11424 With this option, @LaTeX{} fragments are processed into PNG images and the
11425 resulting images are embedded in the exported document. This method requires
11426 that the @file{dvipng} program be available on your system.
11429 @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in ODT export
11430 @subsubsection Working with MathML or OpenDocument formula files
11432 For various reasons, you may find embedding @LaTeX{} math snippets in an
11433 ODT document less than reliable. In that case, you can embed a
11434 math equation by linking to its MathML (@file{.mml}) source or its
11435 OpenDocument formula (@file{.odf}) file as shown below:
11447 @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
11448 @subsection Labels and captions in ODT export
11450 You can label and caption various category of objects - an inline image, a
11451 table, a @LaTeX{} fragment or a Math formula - using @code{#+LABEL} and
11452 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
11453 each labeled or captioned object of a given category separately. As a
11454 result, each such object is assigned a sequence number based on order of it's
11455 appearance in the Org file.
11457 In the exported document, a user-provided caption is augmented with the
11458 category and sequence number. Consider the following inline image in an Org
11462 #+CAPTION: Bell curve
11463 #+LABEL: fig:SED-HR4049
11467 It could be rendered as shown below in the exported document.
11470 Figure 2: Bell curve
11473 @vindex org-export-odt-category-strings
11474 You can modify the category component of the caption by customizing the
11475 variable @code{org-export-odt-category-strings}. For example, to tag all
11476 embedded images with the string @samp{Illustration} (instead of the default
11477 @samp{Figure}) use the following setting.
11480 (setq org-export-odt-category-strings
11481 '(("en" "Table" "Illustration" "Equation" "Equation")))
11484 With this, previous image will be captioned as below in the exported
11488 Illustration 2: Bell curve
11491 @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
11492 @subsection Literal examples in ODT export
11494 Export of literal examples (@pxref{Literal examples}) with full fontification
11495 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
11496 generate all style definitions needed for a fancy listing.@footnote{Your
11497 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
11498 fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
11499 as prefix and inherit their color from the faces used by Emacs
11500 @code{font-lock} library for the source language.
11502 @vindex org-export-odt-fontify-srcblocks
11503 If you prefer to use your own custom styles for fontification, you can do so
11504 by customizing the variable
11505 @code{org-export-odt-create-custom-styles-for-srcblocks}.
11507 @vindex org-export-odt-create-custom-styles-for-srcblocks
11508 You can turn off fontification of literal examples by customizing the
11509 variable @code{org-export-odt-fontify-srcblocks}.
11511 @node Advanced topics in ODT export, , Literal examples in ODT export, OpenDocument Text export
11512 @subsection Advanced topics in ODT export
11514 If you rely heavily on ODT export, you may want to exploit the full
11515 set of features that the exporter offers. This section describes features
11516 that would be of interest to power users.
11519 * Configuring a document converter:: How to register a document converter
11520 * Working with OpenDocument style files:: Explore the internals
11521 * Creating one-off styles:: How to produce custom highlighting etc
11522 * Customizing tables in ODT export:: How to define and use Table templates
11523 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
11526 @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
11527 @subsubsection Configuring a document converter
11529 @cindex doc, docx, rtf
11532 The ODT exporter can work with popular converters with little or no
11533 extra configuration from your side. @xref{Extending ODT export}.
11534 If you are using a converter that is not supported by default or if you would
11535 like to tweak the default converter settings, proceed as below.
11538 @item Register the converter
11540 @vindex org-export-odt-convert-processes
11541 Name your converter and add it to the list of known converters by customizing
11542 the variable @code{org-export-odt-convert-processes}. Also specify how the
11543 converter can be invoked via command-line to effect the conversion.
11545 @item Configure its capabilities
11547 @vindex org-export-odt-convert-capabilities
11548 @anchor{x-odt-converter-capabilities}
11549 Specify the set of formats the converter can handle by customizing the
11550 variable @code{org-export-odt-convert-capabilities}. Use the default value
11551 for this variable as a guide for configuring your converter. As suggested by
11552 the default setting, you can specify the full set of formats supported by the
11553 converter and not limit yourself to specifying formats that are related to
11554 just the OpenDocument Text format.
11556 @item Choose the converter
11558 @vindex org-export-odt-convert-process
11559 Select the newly added converter as the preferred one by customizing the
11560 variable @code{org-export-odt-convert-process}.
11563 @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
11564 @subsubsection Working with OpenDocument style files
11565 @cindex styles, custom
11566 @cindex template, custom
11568 This section explores the internals of the ODT exporter and the
11569 means by which it produces styled documents. Read this section if you are
11570 interested in exploring the automatic and custom OpenDocument styles used by
11573 @anchor{x-factory-styles}
11574 @subsubheading Factory styles
11576 The ODT exporter relies on two files for generating its output.
11577 These files are bundled with the distribution under the directory pointed to
11578 by the variable @code{org-odt-styles-dir}. The two files are:
11581 @anchor{x-orgodtstyles-xml}
11583 @file{OrgOdtStyles.xml}
11585 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
11586 document. This file gets modified for the following purposes:
11590 To control outline numbering based on user settings.
11593 To add styles generated by @file{htmlfontify.el} for fontification of code
11597 @anchor{x-orgodtcontenttemplate-xml}
11599 @file{OrgOdtContentTemplate.xml}
11601 This file contributes to the @file{content.xml} file of the final @samp{ODT}
11602 document. The contents of the Org outline are inserted between the
11603 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
11605 Apart from serving as a template file for the final @file{content.xml}, the
11606 file serves the following purposes:
11610 It contains automatic styles for formatting of tables which are referenced by
11614 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
11615 elements that control how various entities - tables, images, equations etc -
11620 @anchor{x-overriding-factory-styles}
11621 @subsubheading Overriding factory styles
11622 The following two variables control the location from which the ODT
11623 exporter picks up the custom styles and content template files. You can
11624 customize these variables to override the factory styles used by the
11628 @anchor{x-org-export-odt-styles-file}
11630 @code{org-export-odt-styles-file}
11632 Use this variable to specify the @file{styles.xml} that will be used in the
11633 final output. You can specify one of the following values:
11636 @item A @file{styles.xml} file
11638 Use this file instead of the default @file{styles.xml}
11640 @item A @file{.odt} or @file{.ott} file
11642 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11645 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
11647 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11648 Template file. Additionally extract the specified member files and embed
11649 those within the final @samp{ODT} document.
11651 Use this option if the @file{styles.xml} file references additional files
11652 like header and footer images.
11656 Use the default @file{styles.xml}
11659 @anchor{x-org-export-odt-content-template-file}
11661 @code{org-export-odt-content-template-file}
11663 Use this variable to specify the blank @file{content.xml} that will be used
11664 in the final output.
11667 @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
11668 @subsubsection Creating one-off styles
11670 There are times when you would want one-off formatting in the exported
11671 document. You can achieve this by embedding raw OpenDocument XML in the Org
11672 file. The use of this feature is better illustrated with couple of examples.
11675 @item Embedding ODT tags as part of regular text
11677 You can include simple OpenDocument tags by prefixing them with
11678 @samp{@@}. For example, to highlight a region of text do the following:
11681 @@<text:span text:style-name="Highlight">This is a
11682 highlighted text@@</text:span>. But this is a
11686 @strong{Hint:} To see the above example in action, edit your
11687 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11688 custom @samp{Highlight} style as shown below.
11691 <style:style style:name="Highlight" style:family="text">
11692 <style:text-properties fo:background-color="#ff0000"/>
11696 @item Embedding a one-line OpenDocument XML
11698 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
11699 directive. For example, to force a page break do the following:
11702 #+ODT: <text:p text:style-name="PageBreak"/>
11705 @strong{Hint:} To see the above example in action, edit your
11706 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11707 custom @samp{PageBreak} style as shown below.
11710 <style:style style:name="PageBreak" style:family="paragraph"
11711 style:parent-style-name="Text_20_body">
11712 <style:paragraph-properties fo:break-before="page"/>
11716 @item Embedding a block of OpenDocument XML
11718 You can add a large block of OpenDocument XML using the
11719 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
11721 For example, to create a one-off paragraph that uses bold text, do the
11726 <text:p text:style-name="Text_20_body_20_bold">
11727 This paragraph is specially formatted and uses bold text.
11734 @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
11735 @subsubsection Customizing tables in ODT export
11736 @cindex tables, in ODT export
11739 You can override the default formatting of the table by specifying a custom
11740 table style with the @code{#+ATTR_ODT} line. For a discussion on default
11741 formatting of tables @pxref{Tables in ODT export}.
11743 This feature closely mimics the way table templates are defined in the
11745 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11746 OpenDocument-v1.2 Specification}}
11750 @subsubheading Custom table styles - an illustration
11752 To have a quick preview of this feature, install the below setting and export
11753 the table that follows.
11756 (setq org-export-odt-table-styles
11757 (append org-export-odt-table-styles
11758 '(("TableWithHeaderRowAndColumn" "Custom"
11759 ((use-first-row-styles . t)
11760 (use-first-column-styles . t)))
11761 ("TableWithFirstRowandLastRow" "Custom"
11762 ((use-first-row-styles . t)
11763 (use-last-row-styles . t))))))
11767 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
11768 | Name | Phone | Age |
11769 | Peter | 1234 | 17 |
11770 | Anna | 4321 | 25 |
11773 In the above example, you used a template named @samp{Custom} and installed
11774 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
11775 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
11776 styles needed for producing the above template have been pre-defined for you.
11777 These styles are available under the section marked @samp{Custom Table
11778 Template} in @file{OrgOdtContentTemplate.xml}
11779 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
11780 additional templates you have to define these styles yourselves.
11782 @subsubheading Custom table styles - the nitty-gritty
11783 To use this feature proceed as follows:
11787 Create a table template@footnote{See the @code{<table:table-template>}
11788 element of the OpenDocument-v1.2 specification}
11790 A table template is nothing but a set of @samp{table-cell} and
11791 @samp{paragraph} styles for each of the following table cell categories:
11805 The names for the above styles must be chosen based on the name of the table
11806 template using a well-defined convention.
11808 The naming convention is better illustrated with an example. For a table
11809 template with the name @samp{Custom}, the needed style names are listed in
11810 the following table.
11812 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
11813 @headitem Table cell type
11814 @tab @code{table-cell} style
11815 @tab @code{paragraph} style
11820 @tab @samp{CustomTableCell}
11821 @tab @samp{CustomTableParagraph}
11823 @tab @samp{CustomFirstColumnTableCell}
11824 @tab @samp{CustomFirstColumnTableParagraph}
11826 @tab @samp{CustomLastColumnTableCell}
11827 @tab @samp{CustomLastColumnTableParagraph}
11829 @tab @samp{CustomFirstRowTableCell}
11830 @tab @samp{CustomFirstRowTableParagraph}
11832 @tab @samp{CustomLastRowTableCell}
11833 @tab @samp{CustomLastRowTableParagraph}
11835 @tab @samp{CustomEvenRowTableCell}
11836 @tab @samp{CustomEvenRowTableParagraph}
11838 @tab @samp{CustomOddRowTableCell}
11839 @tab @samp{CustomOddRowTableParagraph}
11841 @tab @samp{CustomEvenColumnTableCell}
11842 @tab @samp{CustomEvenColumnTableParagraph}
11844 @tab @samp{CustomOddColumnTableCell}
11845 @tab @samp{CustomOddColumnTableParagraph}
11848 To create a table template with the name @samp{Custom}, define the above
11850 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
11851 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
11855 Define a table style@footnote{See the attributes @code{table:template-name},
11856 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
11857 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
11858 @code{table:use-banding-rows-styles}, and
11859 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
11860 the OpenDocument-v1.2 specification}
11862 @vindex org-export-odt-table-styles
11863 To define a table style, create an entry for the style in the variable
11864 @code{org-export-odt-table-styles} and specify the following:
11867 @item the name of the table template created in step (1)
11868 @item the set of cell styles in that template that are to be activated
11871 For example, the entry below defines two different table styles
11872 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
11873 based on the same template @samp{Custom}. The styles achieve their intended
11874 effect by selectively activating the individual cell styles in that template.
11877 (setq org-export-odt-table-styles
11878 (append org-export-odt-table-styles
11879 '(("TableWithHeaderRowAndColumn" "Custom"
11880 ((use-first-row-styles . t)
11881 (use-first-column-styles . t)))
11882 ("TableWithFirstRowandLastRow" "Custom"
11883 ((use-first-row-styles . t)
11884 (use-last-row-styles . t))))))
11888 Associate a table with the table style
11890 To do this, specify the table style created in step (2) as part of
11891 the @code{ATTR_ODT} line as shown below.
11894 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
11895 | Name | Phone | Age |
11896 | Peter | 1234 | 17 |
11897 | Anna | 4321 | 25 |
11901 @node Validating OpenDocument XML, , Customizing tables in ODT export, Advanced topics in ODT export
11902 @subsubsection Validating OpenDocument XML
11904 Occasionally, you will discover that the document created by the
11905 ODT exporter cannot be opened by your favorite application. One of
11906 the common reasons for this is that the @file{.odt} file is corrupt. In such
11907 cases, you may want to validate the document against the OpenDocument RELAX
11908 NG Compact Syntax (RNC) schema.
11910 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
11911 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
11912 general help with validation (and schema-sensitive editing) of XML files:
11913 @inforef{Introduction,,nxml-mode}.
11915 @vindex org-export-odt-schema-dir
11916 If you have ready access to OpenDocument @file{.rnc} files and the needed
11917 schema-locating rules in a single folder, you can customize the variable
11918 @code{org-export-odt-schema-dir} to point to that directory. The
11919 ODT exporter will take care of updating the
11920 @code{rng-schema-locating-files} for you.
11922 @c end opendocument
11924 @node TaskJuggler export, Freemind export, OpenDocument Text export, Exporting
11925 @section TaskJuggler export
11926 @cindex TaskJuggler export
11927 @cindex Project management
11929 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
11930 It provides an optimizing scheduler that computes your project time lines and
11931 resource assignments based on the project outline and the constraints that
11934 The TaskJuggler exporter is a bit different from other exporters, such as the
11935 @code{HTML} and @LaTeX{} exporters for example, in that it does not export all the
11936 nodes of a document or strictly follow the order of the nodes in the
11939 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
11940 a optionally tree that defines the resources for this project. It then
11941 creates a TaskJuggler file based on these trees and the attributes defined in
11944 @subsection TaskJuggler export commands
11947 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
11948 Export as a TaskJuggler file.
11950 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
11951 Export as a TaskJuggler file and then open the file with TaskJugglerUI.
11956 @vindex org-export-taskjuggler-project-tag
11957 Create your tasks as you usually do with Org mode. Assign efforts to each
11958 task using properties (it is easiest to do this in the column view). You
11959 should end up with something similar to the example by Peter Jones in
11960 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
11961 Now mark the top node of your tasks with a tag named
11962 @code{:taskjuggler_project:} (or whatever you customized
11963 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
11964 the project plan with @kbd{C-c C-e J} which will export the project plan and
11965 open a gantt chart in TaskJugglerUI.
11967 @subsection Resources
11969 @vindex org-export-taskjuggler-resource-tag
11970 Next you can define resources and assign those to work on specific tasks. You
11971 can group your resources hierarchically. Tag the top node of the resources
11972 with @code{:taskjuggler_resource:} (or whatever you customized
11973 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
11974 identifier (named @samp{resource_id}) to the resources (using the standard
11975 Org properties commands, @pxref{Property syntax}) or you can let the exporter
11976 generate identifiers automatically (the exporter picks the first word of the
11977 headline as the identifier as long as it is unique---see the documentation of
11978 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
11979 allocate resources to tasks. This is again done with the @samp{allocate}
11980 property on the tasks. Do this in column view or when on the task type
11981 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
11983 Once the allocations are done you can again export to TaskJuggler and check
11984 in the Resource Allocation Graph which person is working on what task at what
11987 @subsection Export of properties
11989 The exporter also takes TODO state information into consideration, i.e.@: if a
11990 task is marked as done it will have the corresponding attribute in
11991 TaskJuggler (@samp{complete 100}). Also it will export any property on a task
11992 resource or resource node which is known to TaskJuggler, such as
11993 @samp{limits}, @samp{vacation}, @samp{shift}, @samp{booking},
11994 @samp{efficiency}, @samp{journalentry}, @samp{rate} for resources or
11995 @samp{account}, @samp{start}, @samp{note}, @samp{duration}, @samp{end},
11996 @samp{journalentry}, @samp{milestone}, @samp{reference}, @samp{responsible},
11997 @samp{scheduling}, etc for tasks.
11999 @subsection Dependencies
12001 The exporter will handle dependencies that are defined in the tasks either
12002 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
12003 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
12004 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
12005 attribute can be either @samp{previous-sibling} or a reference to an
12006 identifier (named @samp{task_id}) which is defined for another task in the
12007 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
12008 dependencies separated by either space or comma. You can also specify
12009 optional attributes on the dependency by simply appending it. The following
12010 examples should illustrate this:
12015 :task_id: preparation
12018 * Training material
12020 :task_id: training_material
12023 ** Markup Guidelines
12027 ** Workflow Guidelines
12034 :BLOCKER: training_material @{ gapduration 1d @} preparation
12038 @subsection Reports
12040 @vindex org-export-taskjuggler-default-reports
12041 TaskJuggler can produce many kinds of reports (e.g.@: gantt chart, resource
12042 allocation, etc). The user defines what kind of reports should be generated
12043 for a project in the TaskJuggler file. The exporter will automatically insert
12044 some default reports in the file. These defaults are defined in
12045 @code{org-export-taskjuggler-default-reports}. They can be modified using
12046 customize along with a number of other options. For a more complete list, see
12047 @kbd{M-x customize-group @key{RET} org-export-taskjuggler @key{RET}}.
12049 For more information and examples see the Org-taskjuggler tutorial at
12050 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
12052 @node Freemind export, XOXO export, TaskJuggler export, Exporting
12053 @section Freemind export
12054 @cindex Freemind export
12057 The Freemind exporter was written by Lennart Borgman.
12060 @orgcmd{C-c C-e m,org-export-as-freemind}
12061 Export as a Freemind mind map. For an Org file @file{myfile.org}, the Freemind
12062 file will be @file{myfile.mm}.
12065 @node XOXO export, iCalendar export, Freemind export, Exporting
12066 @section XOXO export
12067 @cindex XOXO export
12069 Org mode contains an exporter that produces XOXO-style output.
12070 Currently, this exporter only handles the general outline structure and
12071 does not interpret any additional Org mode features.
12074 @orgcmd{C-c C-e x,org-export-as-xoxo}
12075 Export as an XOXO file. For an Org file @file{myfile.org}, the XOXO file will be
12076 @file{myfile.html}.
12077 @orgkey{C-c C-e v x}
12078 Export only the visible part of the document.
12081 @node iCalendar export, , XOXO export, Exporting
12082 @section iCalendar export
12083 @cindex iCalendar export
12085 @vindex org-icalendar-include-todo
12086 @vindex org-icalendar-use-deadline
12087 @vindex org-icalendar-use-scheduled
12088 @vindex org-icalendar-categories
12089 @vindex org-icalendar-alarm-time
12090 Some people use Org mode for keeping track of projects, but still prefer a
12091 standard calendar application for anniversaries and appointments. In this
12092 case it can be useful to show deadlines and other time-stamped items in Org
12093 files in the calendar application. Org mode can export calendar information
12094 in the standard iCalendar format. If you also want to have TODO entries
12095 included in the export, configure the variable
12096 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
12097 and TODO items as VTODO. It will also create events from deadlines that are
12098 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
12099 to set the start and due dates for the TODO entry@footnote{See the variables
12100 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
12101 As categories, it will use the tags locally defined in the heading, and the
12102 file/tree category@footnote{To add inherited tags or the TODO state,
12103 configure the variable @code{org-icalendar-categories}.}. See the variable
12104 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
12107 @vindex org-icalendar-store-UID
12108 @cindex property, ID
12109 The iCalendar standard requires each entry to have a globally unique
12110 identifier (UID). Org creates these identifiers during export. If you set
12111 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
12112 @code{:ID:} property of the entry and re-used next time you report this
12113 entry. Since a single entry can give rise to multiple iCalendar entries (as
12114 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
12115 prefixes to the UID, depending on what triggered the inclusion of the entry.
12116 In this way the UID remains unique, but a synchronization program can still
12117 figure out from which entry all the different instances originate.
12120 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
12121 Create iCalendar entries for the current file and store them in the same
12122 directory, using a file extension @file{.ics}.
12123 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
12124 @vindex org-agenda-files
12125 Like @kbd{C-c C-e i}, but do this for all files in
12126 @code{org-agenda-files}. For each of these files, a separate iCalendar
12127 file will be written.
12128 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
12129 @vindex org-combined-agenda-icalendar-file
12130 Create a single large iCalendar file from all files in
12131 @code{org-agenda-files} and write it to the file given by
12132 @code{org-combined-agenda-icalendar-file}.
12135 @vindex org-use-property-inheritance
12136 @vindex org-icalendar-include-body
12137 @cindex property, SUMMARY
12138 @cindex property, DESCRIPTION
12139 @cindex property, LOCATION
12140 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
12141 property can be inherited from higher in the hierarchy if you configure
12142 @code{org-use-property-inheritance} accordingly.} properties if the selected
12143 entries have them. If not, the summary will be derived from the headline,
12144 and the description from the body (limited to
12145 @code{org-icalendar-include-body} characters).
12147 How this calendar is best read and updated, depends on the application
12148 you are using. The FAQ covers this issue.
12150 @node Publishing, Working With Source Code, Exporting, Top
12151 @chapter Publishing
12154 Org includes a publishing management system that allows you to configure
12155 automatic HTML conversion of @emph{projects} composed of interlinked org
12156 files. You can also configure Org to automatically upload your exported HTML
12157 pages and related attachments, such as images and source code files, to a web
12160 You can also use Org to convert files into PDF, or even combine HTML and PDF
12161 conversion so that files are available in both formats on the server.
12163 Publishing has been contributed to Org by David O'Toole.
12166 * Configuration:: Defining projects
12167 * Uploading files:: How to get files up on the server
12168 * Sample configuration:: Example projects
12169 * Triggering publication:: Publication commands
12172 @node Configuration, Uploading files, Publishing, Publishing
12173 @section Configuration
12175 Publishing needs significant configuration to specify files, destination
12176 and many other properties of a project.
12179 * Project alist:: The central configuration variable
12180 * Sources and destinations:: From here to there
12181 * Selecting files:: What files are part of the project?
12182 * Publishing action:: Setting the function doing the publishing
12183 * Publishing options:: Tweaking HTML/@LaTeX{} export
12184 * Publishing links:: Which links keep working after publishing?
12185 * Sitemap:: Generating a list of all pages
12186 * Generating an index:: An index that reaches across pages
12189 @node Project alist, Sources and destinations, Configuration, Configuration
12190 @subsection The variable @code{org-publish-project-alist}
12191 @cindex org-publish-project-alist
12192 @cindex projects, for publishing
12194 @vindex org-publish-project-alist
12195 Publishing is configured almost entirely through setting the value of one
12196 variable, called @code{org-publish-project-alist}. Each element of the list
12197 configures one project, and may be in one of the two following forms:
12200 ("project-name" :property value :property value ...)
12201 @r{i.e.@: a well-formed property list with alternating keys and values}
12203 ("project-name" :components ("project-name" "project-name" ...))
12207 In both cases, projects are configured by specifying property values. A
12208 project defines the set of files that will be published, as well as the
12209 publishing configuration to use when publishing those files. When a project
12210 takes the second form listed above, the individual members of the
12211 @code{:components} property are taken to be sub-projects, which group
12212 together files requiring different publishing options. When you publish such
12213 a ``meta-project'', all the components will also be published, in the
12216 @node Sources and destinations, Selecting files, Project alist, Configuration
12217 @subsection Sources and destinations for files
12218 @cindex directories, for publishing
12220 Most properties are optional, but some should always be set. In
12221 particular, Org needs to know where to look for source files,
12222 and where to put published files.
12224 @multitable @columnfractions 0.3 0.7
12225 @item @code{:base-directory}
12226 @tab Directory containing publishing source files
12227 @item @code{:publishing-directory}
12228 @tab Directory where output files will be published. You can directly
12229 publish to a webserver using a file name syntax appropriate for
12230 the Emacs @file{tramp} package. Or you can publish to a local directory and
12231 use external tools to upload your website (@pxref{Uploading files}).
12232 @item @code{:preparation-function}
12233 @tab Function or list of functions to be called before starting the
12234 publishing process, for example, to run @code{make} for updating files to be
12235 published. The project property list is scoped into this call as the
12236 variable @code{project-plist}.
12237 @item @code{:completion-function}
12238 @tab Function or list of functions called after finishing the publishing
12239 process, for example, to change permissions of the resulting files. The
12240 project property list is scoped into this call as the variable
12241 @code{project-plist}.
12245 @node Selecting files, Publishing action, Sources and destinations, Configuration
12246 @subsection Selecting files
12247 @cindex files, selecting for publishing
12249 By default, all files with extension @file{.org} in the base directory
12250 are considered part of the project. This can be modified by setting the
12252 @multitable @columnfractions 0.25 0.75
12253 @item @code{:base-extension}
12254 @tab Extension (without the dot!) of source files. This actually is a
12255 regular expression. Set this to the symbol @code{any} if you want to get all
12256 files in @code{:base-directory}, even without extension.
12258 @item @code{:exclude}
12259 @tab Regular expression to match file names that should not be
12260 published, even though they have been selected on the basis of their
12263 @item @code{:include}
12264 @tab List of files to be included regardless of @code{:base-extension}
12265 and @code{:exclude}.
12267 @item @code{:recursive}
12268 @tab Non-nil means, check base-directory recursively for files to publish.
12271 @node Publishing action, Publishing options, Selecting files, Configuration
12272 @subsection Publishing action
12273 @cindex action, for publishing
12275 Publishing means that a file is copied to the destination directory and
12276 possibly transformed in the process. The default transformation is to export
12277 Org files as HTML files, and this is done by the function
12278 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
12279 export}). But you also can publish your content as PDF files using
12280 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
12281 @code{utf8} encoded files using the corresponding functions. If you want to
12282 publish the Org file itself, but with @i{archived}, @i{commented}, and
12283 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
12284 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
12285 produce @file{file.org} and @file{file.org.html} in the publishing
12286 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
12287 source and publishing directories are equal. Note that with this kind of
12288 setup, you need to add @code{:exclude "-source\\.org"} to the project
12289 definition in @code{org-publish-project-alist} to prevent the published
12290 source files from being considered as new org files the next time the project
12291 is published.}. Other files like images only need to be copied to the
12292 publishing destination; for this you may use @code{org-publish-attachment}.
12293 For non-Org files, you always need to specify the publishing function:
12295 @multitable @columnfractions 0.3 0.7
12296 @item @code{:publishing-function}
12297 @tab Function executing the publication of a file. This may also be a
12298 list of functions, which will all be called in turn.
12299 @item @code{:plain-source}
12300 @tab Non-nil means, publish plain source.
12301 @item @code{:htmlized-source}
12302 @tab Non-nil means, publish htmlized source.
12305 The function must accept three arguments: a property list containing at least
12306 a @code{:publishing-directory} property, the name of the file to be
12307 published, and the path to the publishing directory of the output file. It
12308 should take the specified file, make the necessary transformation (if any)
12309 and place the result into the destination folder.
12311 @node Publishing options, Publishing links, Publishing action, Configuration
12312 @subsection Options for the HTML/@LaTeX{} exporters
12313 @cindex options, for publishing
12315 The property list can be used to set many export options for the HTML
12316 and @LaTeX{} exporters. In most cases, these properties correspond to user
12317 variables in Org. The table below lists these properties along
12318 with the variable they belong to. See the documentation string for the
12319 respective variable for details.
12321 @vindex org-export-html-link-up
12322 @vindex org-export-html-link-home
12323 @vindex org-export-default-language
12324 @vindex org-display-custom-times
12325 @vindex org-export-headline-levels
12326 @vindex org-export-with-section-numbers
12327 @vindex org-export-section-number-format
12328 @vindex org-export-with-toc
12329 @vindex org-export-preserve-breaks
12330 @vindex org-export-with-archived-trees
12331 @vindex org-export-with-emphasize
12332 @vindex org-export-with-sub-superscripts
12333 @vindex org-export-with-special-strings
12334 @vindex org-export-with-footnotes
12335 @vindex org-export-with-drawers
12336 @vindex org-export-with-tags
12337 @vindex org-export-with-todo-keywords
12338 @vindex org-export-with-tasks
12339 @vindex org-export-with-done-tasks
12340 @vindex org-export-with-priority
12341 @vindex org-export-with-TeX-macros
12342 @vindex org-export-with-LaTeX-fragments
12343 @vindex org-export-skip-text-before-1st-heading
12344 @vindex org-export-with-fixed-width
12345 @vindex org-export-with-timestamps
12346 @vindex org-export-author-info
12347 @vindex org-export-email-info
12348 @vindex org-export-creator-info
12349 @vindex org-export-time-stamp-file
12350 @vindex org-export-with-tables
12351 @vindex org-export-highlight-first-table-line
12352 @vindex org-export-html-style-include-default
12353 @vindex org-export-html-style-include-scripts
12354 @vindex org-export-html-style
12355 @vindex org-export-html-style-extra
12356 @vindex org-export-html-link-org-files-as-html
12357 @vindex org-export-html-inline-images
12358 @vindex org-export-html-extension
12359 @vindex org-export-html-table-tag
12360 @vindex org-export-html-expand
12361 @vindex org-export-html-with-timestamp
12362 @vindex org-export-publishing-directory
12363 @vindex org-export-html-preamble
12364 @vindex org-export-html-postamble
12365 @vindex user-full-name
12366 @vindex user-mail-address
12367 @vindex org-export-select-tags
12368 @vindex org-export-exclude-tags
12370 @multitable @columnfractions 0.32 0.68
12371 @item @code{:link-up} @tab @code{org-export-html-link-up}
12372 @item @code{:link-home} @tab @code{org-export-html-link-home}
12373 @item @code{:language} @tab @code{org-export-default-language}
12374 @item @code{:customtime} @tab @code{org-display-custom-times}
12375 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
12376 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
12377 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
12378 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
12379 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
12380 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
12381 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
12382 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
12383 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
12384 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
12385 @item @code{:drawers} @tab @code{org-export-with-drawers}
12386 @item @code{:tags} @tab @code{org-export-with-tags}
12387 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
12388 @item @code{:tasks} @tab @code{org-export-with-tasks}
12389 @item @code{:priority} @tab @code{org-export-with-priority}
12390 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
12391 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
12392 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
12393 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
12394 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
12395 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
12396 @item @code{:author} @tab @code{user-full-name}
12397 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
12398 @item @code{:author-info} @tab @code{org-export-author-info}
12399 @item @code{:email-info} @tab @code{org-export-email-info}
12400 @item @code{:creator-info} @tab @code{org-export-creator-info}
12401 @item @code{:tables} @tab @code{org-export-with-tables}
12402 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
12403 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
12404 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
12405 @item @code{:style} @tab @code{org-export-html-style}
12406 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
12407 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
12408 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
12409 @item @code{:html-extension} @tab @code{org-export-html-extension}
12410 @item @code{:html-preamble} @tab @code{org-export-html-preamble}
12411 @item @code{:html-postamble} @tab @code{org-export-html-postamble}
12412 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
12413 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
12414 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
12415 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
12416 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
12417 @item @code{:select-tags} @tab @code{org-export-select-tags}
12418 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
12419 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
12422 Most of the @code{org-export-with-*} variables have the same effect in
12423 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
12424 @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
12425 @LaTeX{} export. See @code{org-export-plist-vars} to check this list of
12430 @vindex org-publish-project-alist
12431 When a property is given a value in @code{org-publish-project-alist},
12432 its setting overrides the value of the corresponding user variable (if
12433 any) during publishing. Options set within a file (@pxref{Export
12434 options}), however, override everything.
12436 @node Publishing links, Sitemap, Publishing options, Configuration
12437 @subsection Links between published files
12438 @cindex links, publishing
12440 To create a link from one Org file to another, you would use
12441 something like @samp{[[file:foo.org][The foo]]} or simply
12442 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
12443 becomes a link to @file{foo.html}. In this way, you can interlink the
12444 pages of your "org web" project and the links will work as expected when
12445 you publish them to HTML. If you also publish the Org source file and want
12446 to link to that, use an @code{http:} link instead of a @code{file:} link,
12447 because @code{file:} links are converted to link to the corresponding
12450 You may also link to related files, such as images. Provided you are careful
12451 with relative file names, and provided you have also configured Org to upload
12452 the related files, these links will work too. See @ref{Complex example}, for
12453 an example of this usage.
12455 Sometimes an Org file to be published may contain links that are
12456 only valid in your production environment, but not in the publishing
12457 location. In this case, use the property
12459 @multitable @columnfractions 0.4 0.6
12460 @item @code{:link-validation-function}
12461 @tab Function to validate links
12465 to define a function for checking link validity. This function must
12466 accept two arguments, the file name and a directory relative to which
12467 the file name is interpreted in the production environment. If this
12468 function returns @code{nil}, then the HTML generator will only insert a
12469 description into the HTML file, but no link. One option for this
12470 function is @code{org-publish-validate-link} which checks if the given
12471 file is part of any project in @code{org-publish-project-alist}.
12473 @node Sitemap, Generating an index, Publishing links, Configuration
12474 @subsection Generating a sitemap
12475 @cindex sitemap, of published pages
12477 The following properties may be used to control publishing of
12478 a map of files for a given project.
12480 @multitable @columnfractions 0.35 0.65
12481 @item @code{:auto-sitemap}
12482 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
12483 or @code{org-publish-all}.
12485 @item @code{:sitemap-filename}
12486 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
12487 becomes @file{sitemap.html}).
12489 @item @code{:sitemap-title}
12490 @tab Title of sitemap page. Defaults to name of file.
12492 @item @code{:sitemap-function}
12493 @tab Plug-in function to use for generation of the sitemap.
12494 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
12495 of links to all files in the project.
12497 @item @code{:sitemap-sort-folders}
12498 @tab Where folders should appear in the sitemap. Set this to @code{first}
12499 (default) or @code{last} to display folders first or last,
12500 respectively. Any other value will mix files and folders.
12502 @item @code{:sitemap-sort-files}
12503 @tab How the files are sorted in the site map. Set this to
12504 @code{alphabetically} (default), @code{chronologically} or
12505 @code{anti-chronologically}. @code{chronologically} sorts the files with
12506 older date first while @code{anti-chronologically} sorts the files with newer
12507 date first. @code{alphabetically} sorts the files alphabetically. The date of
12508 a file is retrieved with @code{org-publish-find-date}.
12510 @item @code{:sitemap-ignore-case}
12511 @tab Should sorting be case-sensitive? Default @code{nil}.
12513 @item @code{:sitemap-file-entry-format}
12514 @tab With this option one can tell how a sitemap's entry is formatted in the
12515 sitemap. This is a format string with some escape sequences: @code{%t} stands
12516 for the title of the file, @code{%a} stands for the author of the file and
12517 @code{%d} stands for the date of the file. The date is retrieved with the
12518 @code{org-publish-find-date} function and formatted with
12519 @code{org-publish-sitemap-date-format}. Default @code{%t}.
12521 @item @code{:sitemap-date-format}
12522 @tab Format string for the @code{format-time-string} function that tells how
12523 a sitemap entry's date is to be formatted. This property bypasses
12524 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
12526 @item @code{:sitemap-sans-extension}
12527 @tab When non-nil, remove filenames' extensions from the generated sitemap.
12528 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
12529 Defaults to @code{nil}.
12533 @node Generating an index, , Sitemap, Configuration
12534 @subsection Generating an index
12535 @cindex index, in a publishing project
12537 Org mode can generate an index across the files of a publishing project.
12539 @multitable @columnfractions 0.25 0.75
12540 @item @code{:makeindex}
12541 @tab When non-nil, generate in index in the file @file{theindex.org} and
12542 publish it as @file{theindex.html}.
12545 The file will be created when first publishing a project with the
12546 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
12547 "theindex.inc"}. You can then build around this include statement by adding
12548 a title, style information, etc.
12550 @node Uploading files, Sample configuration, Configuration, Publishing
12551 @section Uploading files
12555 For those people already utilizing third party sync tools such as
12556 @command{rsync} or @command{unison}, it might be preferable not to use the built in
12557 @i{remote} publishing facilities of Org mode which rely heavily on
12558 Tramp. Tramp, while very useful and powerful, tends not to be
12559 so efficient for multiple file transfer and has been known to cause problems
12562 Specialized synchronization utilities offer several advantages. In addition
12563 to timestamp comparison, they also do content and permissions/attribute
12564 checks. For this reason you might prefer to publish your web to a local
12565 directory (possibly even @i{in place} with your Org files) and then use
12566 @file{unison} or @file{rsync} to do the synchronization with the remote host.
12568 Since Unison (for example) can be configured as to which files to transfer to
12569 a certain remote destination, it can greatly simplify the project publishing
12570 definition. Simply keep all files in the correct location, process your Org
12571 files with @code{org-publish} and let the synchronization tool do the rest.
12572 You do not need, in this scenario, to include attachments such as @file{jpg},
12573 @file{css} or @file{gif} files in the project definition since the 3rd party
12576 Publishing to a local directory is also much faster than to a remote one, so
12577 that you can afford more easily to republish entire projects. If you set
12578 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
12579 benefit of re-including any changed external files such as source example
12580 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
12581 Org is not smart enough to detect if included files have been modified.
12583 @node Sample configuration, Triggering publication, Uploading files, Publishing
12584 @section Sample configuration
12586 Below we provide two example configurations. The first one is a simple
12587 project publishing only a set of Org files. The second example is
12588 more complex, with a multi-component project.
12591 * Simple example:: One-component publishing
12592 * Complex example:: A multi-component publishing example
12595 @node Simple example, Complex example, Sample configuration, Sample configuration
12596 @subsection Example: simple publishing configuration
12598 This example publishes a set of Org files to the @file{public_html}
12599 directory on the local machine.
12602 (setq org-publish-project-alist
12604 :base-directory "~/org/"
12605 :publishing-directory "~/public_html"
12606 :section-numbers nil
12607 :table-of-contents nil
12608 :style "<link rel=\"stylesheet\"
12609 href=\"../other/mystyle.css\"
12610 type=\"text/css\"/>")))
12613 @node Complex example, , Simple example, Sample configuration
12614 @subsection Example: complex publishing configuration
12616 This more complicated example publishes an entire website, including
12617 Org files converted to HTML, image files, Emacs Lisp source code, and
12618 style sheets. The publishing directory is remote and private files are
12621 To ensure that links are preserved, care should be taken to replicate
12622 your directory structure on the web server, and to use relative file
12623 paths. For example, if your Org files are kept in @file{~/org} and your
12624 publishable images in @file{~/images}, you would link to an image with
12627 file:../images/myimage.png
12630 On the web server, the relative path to the image should be the
12631 same. You can accomplish this by setting up an "images" folder in the
12632 right place on the web server, and publishing images to it.
12635 (setq org-publish-project-alist
12637 :base-directory "~/org/"
12638 :base-extension "org"
12639 :publishing-directory "/ssh:user@@host:~/html/notebook/"
12640 :publishing-function org-publish-org-to-html
12641 :exclude "PrivatePage.org" ;; regexp
12643 :section-numbers nil
12644 :table-of-contents nil
12645 :style "<link rel=\"stylesheet\"
12646 href=\"../other/mystyle.css\" type=\"text/css\"/>"
12650 :base-directory "~/images/"
12651 :base-extension "jpg\\|gif\\|png"
12652 :publishing-directory "/ssh:user@@host:~/html/images/"
12653 :publishing-function org-publish-attachment)
12656 :base-directory "~/other/"
12657 :base-extension "css\\|el"
12658 :publishing-directory "/ssh:user@@host:~/html/other/"
12659 :publishing-function org-publish-attachment)
12660 ("website" :components ("orgfiles" "images" "other"))))
12663 @node Triggering publication, , Sample configuration, Publishing
12664 @section Triggering publication
12666 Once properly configured, Org can publish with the following commands:
12669 @orgcmd{C-c C-e X,org-publish}
12670 Prompt for a specific project and publish all files that belong to it.
12671 @orgcmd{C-c C-e P,org-publish-current-project}
12672 Publish the project containing the current file.
12673 @orgcmd{C-c C-e F,org-publish-current-file}
12674 Publish only the current file.
12675 @orgcmd{C-c C-e E,org-publish-all}
12676 Publish every project.
12679 @vindex org-publish-use-timestamps-flag
12680 Org uses timestamps to track when a file has changed. The above functions
12681 normally only publish changed files. You can override this and force
12682 publishing of all files by giving a prefix argument to any of the commands
12683 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
12684 This may be necessary in particular if files include other files via
12685 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
12687 @comment node-name, next, previous, up
12688 @comment Working With Source Code, Miscellaneous, Publishing, Top
12690 @node Working With Source Code, Miscellaneous, Publishing, Top
12691 @chapter Working with source code
12692 @cindex Schulte, Eric
12693 @cindex Davison, Dan
12694 @cindex source code, working with
12696 Source code can be included in Org mode documents using a @samp{src} block,
12700 #+BEGIN_SRC emacs-lisp
12701 (defun org-xor (a b)
12707 Org mode provides a number of features for working with live source code,
12708 including editing of code blocks in their native major-mode, evaluation of
12709 code blocks, converting code blocks into source files (known as @dfn{tangling}
12710 in literate programming), and exporting code blocks and their
12711 results in several formats. This functionality was contributed by Eric
12712 Schulte and Dan Davison, and was originally named Org-babel.
12714 The following sections describe Org mode's code block handling facilities.
12717 * Structure of code blocks:: Code block syntax described
12718 * Editing source code:: Language major-mode editing
12719 * Exporting code blocks:: Export contents and/or results
12720 * Extracting source code:: Create pure source code files
12721 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
12722 * Library of Babel:: Use and contribute to a library of useful code blocks
12723 * Languages:: List of supported code block languages
12724 * Header arguments:: Configure code block functionality
12725 * Results of evaluation:: How evaluation results are handled
12726 * Noweb reference syntax:: Literate programming in Org mode
12727 * Key bindings and useful functions:: Work quickly with code blocks
12728 * Batch execution:: Call functions from the command line
12731 @comment node-name, next, previous, up
12732 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12734 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12735 @section Structure of code blocks
12736 @cindex code block, structure
12737 @cindex source code, block structure
12739 @cindex #+BEGIN_SRC
12741 Live code blocks can be specified with a @samp{src} block or
12742 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
12743 @ref{Easy Templates} system} The structure of a @samp{src} block is
12747 #+BEGIN_SRC <language> <switches> <header arguments>
12752 The @code{#+NAME:} line is optional, and can be used to name the code
12753 block. Live code blocks require that a language be specified on the
12754 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
12755 @cindex source code, inline
12757 Live code blocks can also be specified inline using
12760 src_<language>@{<body>@}
12766 src_<language>[<header arguments>]@{<body>@}
12770 @item <#+NAME: name>
12771 This line associates a name with the code block. This is similar to the
12772 @code{#+TBLNAME: NAME} lines that can be used to name tables in Org mode
12773 files. Referencing the name of a code block makes it possible to evaluate
12774 the block from other places in the file, from other files, or from Org mode
12775 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
12776 and the behavior of Org mode when two or more blocks share the same name is
12780 The language of the code in the block (see @ref{Languages}).
12781 @cindex source code, language
12783 Optional switches control code block export (see the discussion of switches in
12784 @ref{Literal examples})
12785 @cindex source code, switches
12786 @item <header arguments>
12787 Optional header arguments control many aspects of evaluation, export and
12788 tangling of code blocks (see @ref{Header arguments}).
12789 Header arguments can also be set on a per-buffer or per-subtree
12790 basis using properties.
12791 @item source code, header arguments
12793 Source code in the specified language.
12796 @comment node-name, next, previous, up
12797 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12799 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12800 @section Editing source code
12801 @cindex code block, editing
12802 @cindex source code, editing
12805 Use @kbd{C-c '} to edit the current code block. This brings up
12806 a language major-mode edit buffer containing the body of the code
12807 block. Saving this buffer will write the new contents back to the Org
12808 buffer. Use @kbd{C-c '} again to exit.
12810 The @code{org-src-mode} minor mode will be active in the edit buffer. The
12811 following variables can be used to configure the behavior of the edit
12812 buffer. See also the customization group @code{org-edit-structure} for
12813 further configuration options.
12816 @item org-src-lang-modes
12817 If an Emacs major-mode named @code{<lang>-mode} exists, where
12818 @code{<lang>} is the language named in the header line of the code block,
12819 then the edit buffer will be placed in that major-mode. This variable
12820 can be used to map arbitrary language names to existing major modes.
12821 @item org-src-window-setup
12822 Controls the way Emacs windows are rearranged when the edit buffer is created.
12823 @item org-src-preserve-indentation
12824 This variable is especially useful for tangling languages such as
12825 Python, in which whitespace indentation in the output is critical.
12826 @item org-src-ask-before-returning-to-edit-buffer
12827 By default, Org will ask before returning to an open edit buffer. Set this
12828 variable to nil to switch without asking.
12831 To turn on native code fontification in the @emph{Org} buffer, configure the
12832 variable @code{org-src-fontify-natively}.
12834 @comment node-name, next, previous, up
12835 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12837 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12838 @section Exporting code blocks
12839 @cindex code block, exporting
12840 @cindex source code, exporting
12842 It is possible to export the @emph{code} of code blocks, the @emph{results}
12843 of code block evaluation, @emph{both} the code and the results of code block
12844 evaluation, or @emph{none}. For most languages, the default exports code.
12845 However, for some languages (e.g.@: @code{ditaa}) the default exports the
12846 results of code block evaluation. For information on exporting code block
12847 bodies, see @ref{Literal examples}.
12849 The @code{:exports} header argument can be used to specify export
12852 @subsubheading Header arguments:
12854 @item :exports code
12855 The default in most languages. The body of the code block is exported, as
12856 described in @ref{Literal examples}.
12857 @item :exports results
12858 The code block will be evaluated and the results will be placed in the
12859 Org mode buffer for export, either updating previous results of the code
12860 block located anywhere in the buffer or, if no previous results exist,
12861 placing the results immediately after the code block. The body of the code
12862 block will not be exported.
12863 @item :exports both
12864 Both the code block and its results will be exported.
12865 @item :exports none
12866 Neither the code block nor its results will be exported.
12869 It is possible to inhibit the evaluation of code blocks during export.
12870 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
12871 ensure that no code blocks are evaluated as part of the export process. This
12872 can be useful in situations where potentially untrusted Org mode files are
12873 exported in an automated fashion, for example when Org mode is used as the
12874 markup language for a wiki.
12876 @comment node-name, next, previous, up
12877 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12878 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12879 @section Extracting source code
12881 @cindex source code, extracting
12882 @cindex code block, extracting source code
12884 Creating pure source code files by extracting code from source blocks is
12885 referred to as ``tangling''---a term adopted from the literate programming
12886 community. During ``tangling'' of code blocks their bodies are expanded
12887 using @code{org-babel-expand-src-block} which can expand both variable and
12888 ``noweb'' style references (see @ref{Noweb reference syntax}).
12890 @subsubheading Header arguments
12893 The default. The code block is not included in the tangled output.
12895 Include the code block in the tangled output. The output file name is the
12896 name of the org file with the extension @samp{.org} replaced by the extension
12897 for the block language.
12898 @item :tangle filename
12899 Include the code block in the tangled output to file @samp{filename}.
12903 @subsubheading Functions
12905 @item org-babel-tangle
12906 Tangle the current file. Bound to @kbd{C-c C-v t}.
12907 @item org-babel-tangle-file
12908 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
12911 @subsubheading Hooks
12913 @item org-babel-post-tangle-hook
12914 This hook is run from within code files tangled by @code{org-babel-tangle}.
12915 Example applications could include post-processing, compilation or evaluation
12916 of tangled code files.
12919 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
12920 @section Evaluating code blocks
12921 @cindex code block, evaluating
12922 @cindex source code, evaluating
12925 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
12926 potential for that code to do harm. Org mode provides safeguards to ensure
12927 that code is only evaluated after explicit confirmation from the user. For
12928 information on these safeguards (and on how to disable them) see @ref{Code
12929 evaluation security}.} and the results of evaluation optionally placed in the
12930 Org mode buffer. The results of evaluation are placed following a line that
12931 begins by default with @code{#+RESULTS} and optionally a cache identifier
12932 and/or the name of the evaluated code block. The default value of
12933 @code{#+RESULTS} can be changed with the customizable variable
12934 @code{org-babel-results-keyword}.
12936 By default, the evaluation facility is only enabled for Lisp code blocks
12937 specified as @code{emacs-lisp}. However, source code blocks in many languages
12938 can be evaluated within Org mode (see @ref{Languages} for a list of supported
12939 languages and @ref{Structure of code blocks} for information on the syntax
12940 used to define a code block).
12943 There are a number of ways to evaluate code blocks. The simplest is to press
12944 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
12945 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
12946 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
12947 @code{org-babel-execute-src-block} function to evaluate the block and insert
12948 its results into the Org mode buffer.
12951 It is also possible to evaluate named code blocks from anywhere in an Org
12952 mode buffer or an Org mode table. Live code blocks located in the current
12953 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
12954 can be executed. Named code blocks can be executed with a separate
12955 @code{#+CALL:} line or inline within a block of text.
12957 The syntax of the @code{#+CALL:} line is
12960 #+CALL: <name>(<arguments>)
12961 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
12964 The syntax for inline evaluation of named code blocks is
12967 ... call_<name>(<arguments>) ...
12968 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
12973 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
12975 Arguments specified in this section will be passed to the code block. These
12976 arguments use standard function call syntax, rather than
12977 header argument syntax. For example, a @code{#+CALL:} line that passes the
12978 number four to a code block named @code{double}, which declares the header
12979 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
12980 @item <inside header arguments>
12981 Inside header arguments are passed through and applied to the named code
12982 block. These arguments use header argument syntax rather than standard
12983 function call syntax. Inside header arguments affect how the code block is
12984 evaluated. For example, @code{[:results output]} will collect the results of
12985 everything printed to @code{STDOUT} during execution of the code block.
12986 @item <end header arguments>
12987 End header arguments are applied to the calling instance and do not affect
12988 evaluation of the named code block. They affect how the results are
12989 incorporated into the Org mode buffer and how the call line is exported. For
12990 example, @code{:results html} will insert the results of the call line
12991 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
12993 For more examples of passing header arguments to @code{#+CALL:} lines see
12994 @ref{Header arguments in function calls}.
12997 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
12998 @section Library of Babel
12999 @cindex babel, library of
13000 @cindex source code, library
13001 @cindex code block, library
13003 The ``Library of Babel'' consists of code blocks that can be called from any
13004 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
13005 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
13006 code blocks} for information on the syntax of remote code block evaluation).
13009 The central repository of code blocks in the ``Library of Babel'' is housed
13010 in an Org mode file located in the @samp{contrib} directory of Org mode.
13012 Users can add code blocks they believe to be generally useful to their
13013 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
13014 then loaded into the library with @code{org-babel-lob-ingest}.
13018 Code blocks located in any Org mode file can be loaded into the ``Library of
13019 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
13022 @node Languages, Header arguments, Library of Babel, Working With Source Code
13024 @cindex babel, languages
13025 @cindex source code, languages
13026 @cindex code block, languages
13028 Code blocks in the following languages are supported.
13030 @multitable @columnfractions 0.28 0.3 0.22 0.2
13031 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
13032 @item Asymptote @tab asymptote @tab Awk @tab awk
13033 @item Emacs Calc @tab calc @tab C @tab C
13034 @item C++ @tab C++ @tab Clojure @tab clojure
13035 @item CSS @tab css @tab ditaa @tab ditaa
13036 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
13037 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
13038 @item Java @tab java @tab @tab
13039 @item Javascript @tab js @tab LaTeX @tab latex
13040 @item Ledger @tab ledger @tab Lisp @tab lisp
13041 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
13042 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
13043 @item Octave @tab octave @tab Org mode @tab org
13044 @item Oz @tab oz @tab Perl @tab perl
13045 @item Plantuml @tab plantuml @tab Python @tab python
13046 @item R @tab R @tab Ruby @tab ruby
13047 @item Sass @tab sass @tab Scheme @tab scheme
13048 @item GNU Screen @tab screen @tab shell @tab sh
13049 @item SQL @tab sql @tab SQLite @tab sqlite
13052 Language-specific documentation is available for some languages. If
13053 available, it can be found at
13054 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
13056 The @code{org-babel-load-languages} controls which languages are enabled for
13057 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
13058 be set using the customization interface or by adding code like the following
13059 to your emacs configuration.
13062 The following disables @code{emacs-lisp} evaluation and enables evaluation of
13063 @code{R} code blocks.
13067 (org-babel-do-load-languages
13068 'org-babel-load-languages
13069 '((emacs-lisp . nil)
13073 It is also possible to enable support for a language by loading the related
13074 elisp file with @code{require}.
13077 The following adds support for evaluating @code{clojure} code blocks.
13081 (require 'ob-clojure)
13084 @node Header arguments, Results of evaluation, Languages, Working With Source Code
13085 @section Header arguments
13086 @cindex code block, header arguments
13087 @cindex source code, block header arguments
13089 Code block functionality can be configured with header arguments. This
13090 section provides an overview of the use of header arguments, and then
13091 describes each header argument in detail.
13094 * Using header arguments:: Different ways to set header arguments
13095 * Specific header arguments:: List of header arguments
13098 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
13099 @subsection Using header arguments
13101 The values of header arguments can be set in six different ways, each more
13102 specific (and having higher priority) than the last.
13104 * System-wide header arguments:: Set global default values
13105 * Language-specific header arguments:: Set default values by language
13106 * Buffer-wide header arguments:: Set default values for a specific buffer
13107 * Header arguments in Org mode properties:: Set default values for a buffer or heading
13108 * Code block specific header arguments:: The most common way to set values
13109 * Header arguments in function calls:: The most specific level
13113 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
13114 @subsubheading System-wide header arguments
13115 @vindex org-babel-default-header-args
13116 System-wide values of header arguments can be specified by customizing the
13117 @code{org-babel-default-header-args} variable:
13121 :results => "replace"
13128 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
13130 @c ((:session . "none")
13131 @c (:results . "replace")
13132 @c (:exports . "code")
13134 @c (:noweb . "no"))
13138 @c Default arguments to use when evaluating a code block.
13141 For example, the following example could be used to set the default value of
13142 @code{:noweb} header arguments to @code{yes}. This would have the effect of
13143 expanding @code{:noweb} references by default when evaluating source code
13147 (setq org-babel-default-header-args
13148 (cons '(:noweb . "yes")
13149 (assq-delete-all :noweb org-babel-default-header-args)))
13152 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
13153 @subsubheading Language-specific header arguments
13154 Each language can define its own set of default header arguments. See the
13155 language-specific documentation available online at
13156 @uref{http://orgmode.org/worg/org-contrib/babel}.
13158 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
13159 @subsubheading Buffer-wide header arguments
13160 Buffer-wide header arguments may be specified as properties through the use
13161 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
13162 @ref{Property syntax}).
13164 For example the following would set @code{session} to @code{*R*}, and
13165 @code{results} to @code{silent} for every code block in the buffer, ensuring
13166 that all execution took place in the same session, and no results would be
13167 inserted into the buffer.
13170 #+PROPERTY: session *R*
13171 #+PROPERTY: results silent
13174 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
13175 @subsubheading Header arguments in Org mode properties
13177 Header arguments are also read from Org mode properties (see @ref{Property
13178 syntax}), which can be set on a buffer-wide or per-heading basis. An example
13179 of setting a header argument for all code blocks in a buffer is
13182 #+PROPERTY: tangle yes
13185 @vindex org-use-property-inheritance
13186 When properties are used to set default header arguments, they are looked up
13187 with inheritance, regardless of the value of
13188 @code{org-use-property-inheritance}. In the following example the value of
13189 the @code{:cache} header argument will default to @code{yes} in all code
13190 blocks in the subtree rooted at the following heading:
13200 @vindex org-babel-default-header-args
13201 Properties defined in this way override the properties set in
13202 @code{org-babel-default-header-args}. It is convenient to use the
13203 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
13204 in Org mode documents.
13206 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
13207 @subsubheading Code block specific header arguments
13209 The most common way to assign values to header arguments is at the
13210 code block level. This can be done by listing a sequence of header
13211 arguments and their values as part of the @code{#+BEGIN_SRC} line.
13212 Properties set in this way override both the values of
13213 @code{org-babel-default-header-args} and header arguments specified as
13214 properties. In the following example, the @code{:results} header argument
13215 is set to @code{silent}, meaning the results of execution will not be
13216 inserted in the buffer, and the @code{:exports} header argument is set to
13217 @code{code}, meaning only the body of the code block will be
13218 preserved on export to HTML or @LaTeX{}.
13222 #+BEGIN_SRC haskell :results silent :exports code :var n=0
13224 fac n = n * fac (n-1)
13227 Similarly, it is possible to set header arguments for inline code blocks
13230 src_haskell[:exports both]@{fac 5@}
13233 Code block header arguments can span multiple lines using @code{#+HEADER:} or
13234 @code{#+HEADERS:} lines preceding a code block or nested between the
13235 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
13239 Multi-line header arguments on an un-named code block:
13241 #+HEADERS: :var data1=1
13242 #+BEGIN_SRC emacs-lisp :var data2=2
13243 (message "data1:%S, data2:%S" data1 data2)
13250 Multi-line header arguments on a named code block:
13252 #+NAME: named-block
13253 #+HEADER: :var data=2
13254 #+BEGIN_SRC emacs-lisp
13255 (message "data:%S" data)
13258 #+RESULTS: named-block
13262 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
13263 @comment node-name, next, previous, up
13264 @subsubheading Header arguments in function calls
13266 At the most specific level, header arguments for ``Library of Babel'' or
13267 @code{#+CALL:} lines can be set as shown in the two examples below. For more
13268 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
13271 The following will apply the @code{:exports results} header argument to the
13272 evaluation of the @code{#+CALL:} line.
13274 #+CALL: factorial(n=5) :exports results
13277 The following will apply the @code{:session special} header argument to the
13278 evaluation of the @code{factorial} code block.
13280 #+CALL: factorial[:session special](n=5)
13283 @node Specific header arguments, , Using header arguments, Header arguments
13284 @subsection Specific header arguments
13285 Header arguments consist of an initial colon followed by the name of the
13286 argument in lowercase letters. The following header arguments are defined:
13289 * var:: Pass arguments to code blocks
13290 * results:: Specify the type of results and how they will
13291 be collected and handled
13292 * file:: Specify a path for file output
13293 * file-desc:: Specify a description for file results
13294 * dir:: Specify the default (possibly remote)
13295 directory for code block execution
13296 * exports:: Export code and/or results
13297 * tangle:: Toggle tangling and specify file name
13298 * mkdirp:: Toggle creation of parent directories of target
13299 files during tangling
13300 * comments:: Toggle insertion of comments in tangled
13302 * padline:: Control insertion of padding lines in tangled
13304 * no-expand:: Turn off variable assignment and noweb
13305 expansion during tangling
13306 * session:: Preserve the state of code evaluation
13307 * noweb:: Toggle expansion of noweb references
13308 * noweb-ref:: Specify block's noweb reference resolution target
13309 * noweb-sep:: String used to separate noweb references
13310 * cache:: Avoid re-evaluating unchanged code blocks
13311 * sep:: Delimiter for writing tabular results outside Org
13312 * hlines:: Handle horizontal lines in tables
13313 * colnames:: Handle column names in tables
13314 * rownames:: Handle row names in tables
13315 * shebang:: Make tangled files executable
13316 * eval:: Limit evaluation of specific code blocks
13317 * wrap:: Mark source block evaluation results
13320 Additional header arguments are defined on a language-specific basis, see
13323 @node var, results, Specific header arguments, Specific header arguments
13324 @subsubsection @code{:var}
13325 The @code{:var} header argument is used to pass arguments to code blocks.
13326 The specifics of how arguments are included in a code block vary by language;
13327 these are addressed in the language-specific documentation. However, the
13328 syntax used to specify arguments is the same across all languages. In every
13329 case, variables require a default value when they are declared.
13331 The values passed to arguments can either be literal values, references, or
13332 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
13333 include anything in the Org mode file that takes a @code{#+NAME:},
13334 @code{#+TBLNAME:}, or @code{#+RESULTS:} line. This includes tables, lists,
13335 @code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
13338 Argument values can be indexed in a manner similar to arrays (see @ref{var,
13339 Indexable variable values}).
13341 The following syntax is used to pass arguments to code blocks using the
13342 @code{:var} header argument.
13348 The argument, @code{assign}, can either be a literal value, such as a string
13349 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
13350 literal example, another code block (with or without arguments), or the
13351 results of evaluating another code block.
13353 Here are examples of passing values by reference:
13358 an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
13360 #+TBLNAME: example-table
13366 #+NAME: table-length
13367 #+BEGIN_SRC emacs-lisp :var table=example-table
13371 #+RESULTS: table-length
13376 a simple list named with a @code{#+NAME:} line (note that nesting is not
13377 carried through to the source code block)
13380 #+NAME: example-list
13386 #+BEGIN_SRC emacs-lisp :var x=example-list
13394 @item code block without arguments
13395 a code block name (from the example above), as assigned by @code{#+NAME:},
13396 optionally followed by parentheses
13399 #+BEGIN_SRC emacs-lisp :var length=table-length()
13407 @item code block with arguments
13408 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
13409 optional arguments passed within the parentheses following the
13410 code block name using standard function call syntax
13414 #+BEGIN_SRC emacs-lisp :var input=8
13422 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
13430 @item literal example
13431 a literal example block named with a @code{#+NAME:} line
13434 #+NAME: literal-example
13440 #+NAME: read-literal-example
13441 #+BEGIN_SRC emacs-lisp :var x=literal-example
13442 (concatenate 'string x " for you.")
13445 #+RESULTS: read-literal-example
13446 : A literal example
13447 : on two lines for you.
13453 @subsubheading Alternate argument syntax
13454 It is also possible to specify arguments in a potentially more natural way
13455 using the @code{#+NAME:} line of a code block. As in the following
13456 example, arguments can be packed inside of parentheses, separated by commas,
13457 following the source name.
13460 #+NAME: double(input=0, x=2)
13461 #+BEGIN_SRC emacs-lisp
13466 @subsubheading Indexable variable values
13467 It is possible to reference portions of variable values by ``indexing'' into
13468 the variables. Indexes are 0 based with negative values counting back from
13469 the end. If an index is separated by @code{,}s then each subsequent section
13470 will index into the next deepest nesting or dimension of the value. Note
13471 that this indexing occurs @emph{before} other table related header arguments
13472 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
13473 following example assigns the last cell of the first row the table
13474 @code{example-table} to the variable @code{data}:
13477 #+NAME: example-table
13483 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
13491 Ranges of variable values can be referenced using two integers separated by a
13492 @code{:}, in which case the entire inclusive range is referenced. For
13493 example the following assigns the middle three rows of @code{example-table}
13497 #+NAME: example-table
13504 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
13514 Additionally, an empty index, or the single character @code{*}, are both
13515 interpreted to mean the entire range and as such are equivalent to
13516 @code{0:-1}, as shown in the following example in which the entire first
13517 column is referenced.
13520 #+NAME: example-table
13526 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
13534 It is possible to index into the results of code blocks as well as tables.
13535 Any number of dimensions can be indexed. Dimensions are separated from one
13536 another by commas, as shown in the following example.
13540 #+BEGIN_SRC emacs-lisp
13541 '(((1 2 3) (4 5 6) (7 8 9))
13542 ((10 11 12) (13 14 15) (16 17 18))
13543 ((19 20 21) (22 23 24) (25 26 27)))
13546 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
13554 @subsubheading Emacs Lisp evaluation of variables
13556 Emacs lisp code can be used to initialize variable values. When a variable
13557 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
13558 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
13559 the variable value. The following example demonstrates use of this
13560 evaluation to reliably pass the file-name of the Org mode buffer to a code
13561 block---note that evaluation of header arguments is guaranteed to take place
13562 in the original Org mode file, while there is no such guarantee for
13563 evaluation of the code block body.
13566 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
13571 Note that values read from tables and lists will not be evaluated as
13572 Emacs Lisp, as shown in the following example.
13578 #+HEADERS: :var data=table[0,0]
13587 @node results, file, var, Specific header arguments
13588 @subsubsection @code{:results}
13590 There are three classes of @code{:results} header argument. Only one option
13591 per class may be supplied per code block.
13595 @b{collection} header arguments specify how the results should be collected
13596 from the code block
13598 @b{type} header arguments specify what type of result the code block will
13599 return---which has implications for how they will be inserted into the
13602 @b{handling} header arguments specify how the results of evaluating the code
13603 block should be handled.
13606 @subsubheading Collection
13607 The following options are mutually exclusive, and specify how the results
13608 should be collected from the code block.
13612 This is the default. The result is the value of the last statement in the
13613 code block. This header argument places the evaluation in functional
13614 mode. Note that in some languages, e.g., Python, use of this result type
13615 requires that a @code{return} statement be included in the body of the source
13616 code block. E.g., @code{:results value}.
13617 @item @code{output}
13618 The result is the collection of everything printed to STDOUT during the
13619 execution of the code block. This header argument places the
13620 evaluation in scripting mode. E.g., @code{:results output}.
13623 @subsubheading Type
13625 The following options are mutually exclusive and specify what type of results
13626 the code block will return. By default, results are inserted as either a
13627 table or scalar depending on their value.
13630 @item @code{table}, @code{vector}
13631 The results should be interpreted as an Org mode table. If a single value is
13632 returned, it will be converted into a table with one row and one column.
13633 E.g., @code{:results value table}.
13635 The results should be interpreted as an Org mode list. If a single scalar
13636 value is returned it will be converted into a list with only one element.
13637 @item @code{scalar}, @code{verbatim}
13638 The results should be interpreted literally---they will not be
13639 converted into a table. The results will be inserted into the Org mode
13640 buffer as quoted text. E.g., @code{:results value verbatim}.
13642 The results will be interpreted as the path to a file, and will be inserted
13643 into the Org mode buffer as a file link. E.g., @code{:results value file}.
13644 @item @code{raw}, @code{org}
13645 The results are interpreted as raw Org mode code and are inserted directly
13646 into the buffer. If the results look like a table they will be aligned as
13647 such by Org mode. E.g., @code{:results value raw}.
13649 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
13650 block. E.g., @code{:results value html}.
13652 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
13653 E.g., @code{:results value latex}.
13655 Result are assumed to be parsable code and are enclosed in a code block.
13656 E.g., @code{:results value code}.
13658 The result is converted to pretty-printed code and is enclosed in a code
13659 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
13660 @code{:results value pp}.
13662 The result is wrapped in a RESULTS drawer. This can be useful for
13663 inserting @code{raw} or @code{org} syntax results in such a way that their
13664 extent is known and they can be automatically removed or replaced.
13667 @subsubheading Handling
13668 The following results options indicate what happens with the
13669 results once they are collected.
13672 @item @code{silent}
13673 The results will be echoed in the minibuffer but will not be inserted into
13674 the Org mode buffer. E.g., @code{:results output silent}.
13675 @item @code{replace}
13676 The default value. Any existing results will be removed, and the new results
13677 will be inserted into the Org mode buffer in their place. E.g.,
13678 @code{:results output replace}.
13679 @item @code{append}
13680 If there are pre-existing results of the code block then the new results will
13681 be appended to the existing results. Otherwise the new results will be
13682 inserted as with @code{replace}.
13683 @item @code{prepend}
13684 If there are pre-existing results of the code block then the new results will
13685 be prepended to the existing results. Otherwise the new results will be
13686 inserted as with @code{replace}.
13689 @node file, file-desc, results, Specific header arguments
13690 @subsubsection @code{:file}
13692 The header argument @code{:file} is used to specify an external file in which
13693 to save code block results. After code block evaluation an Org mode style
13694 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
13695 into the Org mode buffer. Some languages including R, gnuplot, dot, and
13696 ditaa provide special handling of the @code{:file} header argument
13697 automatically wrapping the code block body in the boilerplate code required
13698 to save output to the specified file. This is often useful for saving
13699 graphical output of a code block to the specified file.
13701 The argument to @code{:file} should be either a string specifying the path to
13702 a file, or a list of two strings in which case the first element of the list
13703 should be the path to a file and the second a description for the link.
13705 @node file-desc, dir, file, Specific header arguments
13706 @subsubsection @code{:file-desc}
13708 The value of the @code{:file-desc} header argument is used to provide a
13709 description for file code block results which are inserted as Org mode links
13710 (see @ref{Link format}). If the @code{:file-desc} header argument is given
13711 with no value the link path will be placed in both the ``link'' and the
13712 ``description'' portion of the Org mode link.
13714 @node dir, exports, file-desc, Specific header arguments
13715 @subsubsection @code{:dir} and remote execution
13717 While the @code{:file} header argument can be used to specify the path to the
13718 output file, @code{:dir} specifies the default directory during code block
13719 execution. If it is absent, then the directory associated with the current
13720 buffer is used. In other words, supplying @code{:dir path} temporarily has
13721 the same effect as changing the current directory with @kbd{M-x cd path}, and
13722 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
13723 the value of the Emacs variable @code{default-directory}.
13725 When using @code{:dir}, you should supply a relative path for file output
13726 (e.g.@: @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
13727 case that path will be interpreted relative to the default directory.
13729 In other words, if you want your plot to go into a folder called @file{Work}
13730 in your home directory, you could use
13733 #+BEGIN_SRC R :file myplot.png :dir ~/Work
13734 matplot(matrix(rnorm(100), 10), type="l")
13738 @subsubheading Remote execution
13739 A directory on a remote machine can be specified using tramp file syntax, in
13740 which case the code will be evaluated on the remote machine. An example is
13743 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
13744 plot(1:10, main=system("hostname", intern=TRUE))
13748 Text results will be returned to the local Org mode buffer as usual, and file
13749 output will be created on the remote machine with relative paths interpreted
13750 relative to the remote directory. An Org mode link to the remote file will be
13753 So, in the above example a plot will be created on the remote machine,
13754 and a link of the following form will be inserted in the org buffer:
13757 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
13760 Most of this functionality follows immediately from the fact that @code{:dir}
13761 sets the value of the Emacs variable @code{default-directory}, thanks to
13762 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
13763 install tramp separately in order for these features to work correctly.
13765 @subsubheading Further points
13769 If @code{:dir} is used in conjunction with @code{:session}, although it will
13770 determine the starting directory for a new session as expected, no attempt is
13771 currently made to alter the directory associated with an existing session.
13773 @code{:dir} should typically not be used to create files during export with
13774 @code{:exports results} or @code{:exports both}. The reason is that, in order
13775 to retain portability of exported material between machines, during export
13776 links inserted into the buffer will @emph{not} be expanded against @code{default
13777 directory}. Therefore, if @code{default-directory} is altered using
13778 @code{:dir}, it is probable that the file will be created in a location to
13779 which the link does not point.
13782 @node exports, tangle, dir, Specific header arguments
13783 @subsubsection @code{:exports}
13785 The @code{:exports} header argument specifies what should be included in HTML
13786 or @LaTeX{} exports of the Org mode file.
13790 The default. The body of code is included into the exported file. E.g.,
13791 @code{:exports code}.
13792 @item @code{results}
13793 The result of evaluating the code is included in the exported file. E.g.,
13794 @code{:exports results}.
13796 Both the code and results are included in the exported file. E.g.,
13797 @code{:exports both}.
13799 Nothing is included in the exported file. E.g., @code{:exports none}.
13802 @node tangle, mkdirp, exports, Specific header arguments
13803 @subsubsection @code{:tangle}
13805 The @code{:tangle} header argument specifies whether or not the code
13806 block should be included in tangled extraction of source code files.
13809 @item @code{tangle}
13810 The code block is exported to a source code file named after the full path
13811 (including the directory) and file name (w/o extension) of the Org mode file.
13812 E.g., @code{:tangle yes}.
13814 The default. The code block is not exported to a source code file.
13815 E.g., @code{:tangle no}.
13817 Any other string passed to the @code{:tangle} header argument is interpreted
13818 as a path (directory and file name relative to the directory of the Org mode
13819 file) to which the block will be exported. E.g., @code{:tangle path}.
13822 @node mkdirp, comments, tangle, Specific header arguments
13823 @subsubsection @code{:mkdirp}
13825 The @code{:mkdirp} header argument can be used to create parent directories
13826 of tangled files when missing. This can be set to @code{yes} to enable
13827 directory creation or to @code{no} to inhibit directory creation.
13829 @node comments, padline, mkdirp, Specific header arguments
13830 @subsubsection @code{:comments}
13831 By default code blocks are tangled to source-code files without any insertion
13832 of comments beyond those which may already exist in the body of the code
13833 block. The @code{:comments} header argument can be set as follows to control
13834 the insertion of extra comments into the tangled code file.
13838 The default. No extra comments are inserted during tangling.
13840 The code block is wrapped in comments which contain pointers back to the
13841 original Org file from which the code was tangled.
13843 A synonym for ``link'' to maintain backwards compatibility.
13845 Include text from the Org mode file as a comment.
13847 The text is picked from the leading context of the tangled code and is
13848 limited by the nearest headline or source block as the case may be.
13850 Turns on both the ``link'' and ``org'' comment options.
13852 Turns on the ``link'' comment option, and additionally wraps expanded noweb
13853 references in the code block body in link comments.
13856 @node padline, no-expand, comments, Specific header arguments
13857 @subsubsection @code{:padline}
13858 Control in insertion of padding lines around code block bodies in tangled
13859 code files. The default value is @code{yes} which results in insertion of
13860 newlines before and after each tangled code block. The following arguments
13865 Insert newlines before and after each code block body in tangled code files.
13867 Do not insert any newline padding in tangled output.
13870 @node no-expand, session, padline, Specific header arguments
13871 @subsubsection @code{:no-expand}
13873 By default, code blocks are expanded with @code{org-babel-expand-src-block}
13874 during tangling. This has the effect of assigning values to variables
13875 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
13876 references (see @ref{Noweb reference syntax}) with their targets. The
13877 @code{:no-expand} header argument can be used to turn off this behavior.
13879 @node session, noweb, no-expand, Specific header arguments
13880 @subsubsection @code{:session}
13882 The @code{:session} header argument starts a session for an interpreted
13883 language where state is preserved.
13885 By default, a session is not started.
13887 A string passed to the @code{:session} header argument will give the session
13888 a name. This makes it possible to run concurrent sessions for each
13889 interpreted language.
13891 @node noweb, noweb-ref, session, Specific header arguments
13892 @subsubsection @code{:noweb}
13894 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
13895 references (see @ref{Noweb reference syntax}) when the code block is
13896 evaluated, tangled, or exported. The @code{:noweb} header argument can have
13897 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
13898 @code{no-export} @code{strip-export}.
13902 The default. ``Noweb'' syntax references in the body of the code block will
13903 not be expanded before the code block is evaluated, tangled or exported.
13905 ``Noweb'' syntax references in the body of the code block will be
13906 expanded before the code block is evaluated, tangled or exported.
13907 @item @code{tangle}
13908 ``Noweb'' syntax references in the body of the code block will be expanded
13909 before the code block is tangled. However, ``noweb'' syntax references will
13910 not be expanded when the code block is evaluated or exported.
13911 @item @code{no-export}
13912 ``Noweb'' syntax references in the body of the code block will be expanded
13913 before the block is evaluated or tangled. However, ``noweb'' syntax
13914 references will not be expanded when the code block is exported.
13915 @item @code{strip-export}
13916 ``Noweb'' syntax references in the body of the code block will be expanded
13917 before the block is evaluated or tangled. However, ``noweb'' syntax
13918 references will not be removed when the code block is exported.
13920 ``Noweb'' syntax references in the body of the code block will only be
13921 expanded before the block is evaluated.
13924 @subsubheading Noweb prefix lines
13925 Noweb insertions are now placed behind the line prefix of the
13926 @code{<<reference>>}.
13927 This behavior is illustrated in the following example. Because the
13928 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
13929 each line of the expanded noweb reference will be commented.
13942 -- multi-line body of example
13945 Note that noweb replacement text that does not contain any newlines will not
13946 be affected by this change, so it is still possible to use inline noweb
13949 @node noweb-ref, noweb-sep, noweb, Specific header arguments
13950 @subsubsection @code{:noweb-ref}
13951 When expanding ``noweb'' style references the bodies of all code block with
13952 @emph{either} a block name matching the reference name @emph{or} a
13953 @code{:noweb-ref} header argument matching the reference name will be
13954 concatenated together to form the replacement text.
13956 By setting this header argument at the sub-tree or file level, simple code
13957 block concatenation may be achieved. For example, when tangling the
13958 following Org mode file, the bodies of code blocks will be concatenated into
13959 the resulting pure code file@footnote{(The example needs property inheritance
13960 to be turned on for the @code{noweb-ref} property, see @ref{Property
13964 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
13967 * the mount point of the fullest disk
13969 :noweb-ref: fullest-disk
13972 ** query all mounted disks
13977 ** strip the header row
13982 ** sort by the percent full
13984 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
13987 ** extract the mount point
13989 |awk '@{print $2@}'
13993 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
13994 used to separate accumulate noweb references like those above. By default a
13997 @node noweb-sep, cache, noweb-ref, Specific header arguments
13998 @subsubsection @code{:noweb-sep}
14000 The @code{:noweb-sep} header argument holds the string used to separate
14001 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
14004 @node cache, sep, noweb-sep, Specific header arguments
14005 @subsubsection @code{:cache}
14007 The @code{:cache} header argument controls the use of in-buffer caching of
14008 the results of evaluating code blocks. It can be used to avoid re-evaluating
14009 unchanged code blocks. Note that the @code{:cache} header argument will not
14010 attempt to cache results when the @code{:session} header argument is used,
14011 because the results of the code block execution may be stored in the session
14012 outside of the Org mode buffer. The @code{:cache} header argument can have
14013 one of two values: @code{yes} or @code{no}.
14017 The default. No caching takes place, and the code block will be evaluated
14018 every time it is called.
14020 Every time the code block is run a SHA1 hash of the code and arguments
14021 passed to the block will be generated. This hash is packed into the
14022 @code{#+RESULTS:} line and will be checked on subsequent
14023 executions of the code block. If the code block has not
14024 changed since the last time it was evaluated, it will not be re-evaluated.
14027 Code block caches notice if the value of a variable argument
14028 to the code block has changed. If this is the case, the cache is
14029 invalidated and the code block is re-run. In the following example,
14030 @code{caller} will not be re-run unless the results of @code{random} have
14031 changed since it was last run.
14035 #+BEGIN_SRC R :cache yes
14039 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
14043 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
14047 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
14051 @node sep, hlines, cache, Specific header arguments
14052 @subsubsection @code{:sep}
14054 The @code{:sep} header argument can be used to control the delimiter used
14055 when writing tabular results out to files external to Org mode. This is used
14056 either when opening tabular results of a code block by calling the
14057 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
14058 or when writing code block results to an external file (see @ref{file})
14061 By default, when @code{:sep} is not specified output tables are tab
14064 @node hlines, colnames, sep, Specific header arguments
14065 @subsubsection @code{:hlines}
14067 Tables are frequently represented with one or more horizontal lines, or
14068 hlines. The @code{:hlines} argument to a code block accepts the
14069 values @code{yes} or @code{no}, with a default value of @code{no}.
14073 Strips horizontal lines from the input table. In most languages this is the
14074 desired effect because an @code{hline} symbol is interpreted as an unbound
14075 variable and raises an error. Setting @code{:hlines no} or relying on the
14076 default value yields the following results.
14079 #+TBLNAME: many-cols
14087 #+BEGIN_SRC python :var tab=many-cols
14091 #+RESULTS: echo-table
14098 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
14101 #+TBLNAME: many-cols
14109 #+BEGIN_SRC python :var tab=many-cols :hlines yes
14113 #+RESULTS: echo-table
14122 @node colnames, rownames, hlines, Specific header arguments
14123 @subsubsection @code{:colnames}
14125 The @code{:colnames} header argument accepts the values @code{yes},
14126 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
14127 Note that the behavior of the @code{:colnames} header argument may differ
14128 across languages. For example Emacs Lisp code blocks ignore the
14129 @code{:colnames} header argument entirely given the ease with which tables
14130 with column names may be handled directly in Emacs Lisp.
14134 If an input table looks like it has column names
14135 (because its second row is an hline), then the column
14136 names will be removed from the table before
14137 processing, then reapplied to the results.
14140 #+TBLNAME: less-cols
14146 #+NAME: echo-table-again
14147 #+BEGIN_SRC python :var tab=less-cols
14148 return [[val + '*' for val in row] for row in tab]
14151 #+RESULTS: echo-table-again
14158 Please note that column names are not removed before the table is indexed
14159 using variable indexing @xref{var, Indexable variable values}.
14162 No column name pre-processing takes place
14165 Column names are removed and reapplied as with @code{nil} even if the table
14166 does not ``look like'' it has column names (i.e.@: the second row is not an
14170 @node rownames, shebang, colnames, Specific header arguments
14171 @subsubsection @code{:rownames}
14173 The @code{:rownames} header argument can take on the values @code{yes}
14174 or @code{no}, with a default value of @code{no}.
14178 No row name pre-processing will take place.
14181 The first column of the table is removed from the table before processing,
14182 and is then reapplied to the results.
14185 #+TBLNAME: with-rownames
14186 | one | 1 | 2 | 3 | 4 | 5 |
14187 | two | 6 | 7 | 8 | 9 | 10 |
14189 #+NAME: echo-table-once-again
14190 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
14191 return [[val + 10 for val in row] for row in tab]
14194 #+RESULTS: echo-table-once-again
14195 | one | 11 | 12 | 13 | 14 | 15 |
14196 | two | 16 | 17 | 18 | 19 | 20 |
14199 Please note that row names are not removed before the table is indexed using
14200 variable indexing @xref{var, Indexable variable values}.
14204 @node shebang, eval, rownames, Specific header arguments
14205 @subsubsection @code{:shebang}
14207 Setting the @code{:shebang} header argument to a string value
14208 (e.g.@: @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
14209 first line of any tangled file holding the code block, and the file
14210 permissions of the tangled file are set to make it executable.
14212 @node eval, wrap, shebang, Specific header arguments
14213 @subsubsection @code{:eval}
14214 The @code{:eval} header argument can be used to limit the evaluation of
14215 specific code blocks. The @code{:eval} header argument can be useful for
14216 protecting against the evaluation of dangerous code blocks or to ensure that
14217 evaluation will require a query regardless of the value of the
14218 @code{org-confirm-babel-evaluate} variable. The possible values of
14219 @code{:eval} and their effects are shown below.
14223 The code block will not be evaluated under any circumstances.
14225 Evaluation of the code block will require a query.
14226 @item never-export or no-export
14227 The code block will not be evaluated during export but may still be called
14230 Evaluation of the code block during export will require a query.
14233 If this header argument is not set then evaluation is determined by the value
14234 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
14237 @node wrap, , eval, Specific header arguments
14238 @subsubsection @code{:wrap}
14239 The @code{:wrap} header argument is used to mark the results of source block
14240 evaluation. The header argument can be passed a string that will be appended
14241 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
14242 results. If not string is specified then the results will be wrapped in a
14243 @code{#+BEGIN/END_RESULTS} block.
14245 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
14246 @section Results of evaluation
14247 @cindex code block, results of evaluation
14248 @cindex source code, results of evaluation
14250 The way in which results are handled depends on whether a session is invoked,
14251 as well as on whether @code{:results value} or @code{:results output} is
14252 used. The following table shows the table possibilities. For a full listing
14253 of the possible results header arguments see @ref{results}.
14255 @multitable @columnfractions 0.26 0.33 0.41
14256 @item @tab @b{Non-session} @tab @b{Session}
14257 @item @code{:results value} @tab value of last expression @tab value of last expression
14258 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
14261 Note: With @code{:results value}, the result in both @code{:session} and
14262 non-session is returned to Org mode as a table (a one- or two-dimensional
14263 vector of strings or numbers) when appropriate.
14265 @subsection Non-session
14266 @subsubsection @code{:results value}
14267 This is the default. Internally, the value is obtained by wrapping the code
14268 in a function definition in the external language, and evaluating that
14269 function. Therefore, code should be written as if it were the body of such a
14270 function. In particular, note that Python does not automatically return a
14271 value from a function unless a @code{return} statement is present, and so a
14272 @samp{return} statement will usually be required in Python.
14274 This is the only one of the four evaluation contexts in which the code is
14275 automatically wrapped in a function definition.
14277 @subsubsection @code{:results output}
14278 The code is passed to the interpreter as an external process, and the
14279 contents of the standard output stream are returned as text. (In certain
14280 languages this also contains the error output stream; this is an area for
14283 @subsection Session
14284 @subsubsection @code{:results value}
14285 The code is passed to an interpreter running as an interactive Emacs inferior
14286 process. Only languages which provide tools for interactive evaluation of
14287 code have session support, so some language (e.g., C and ditaa) do not
14288 support the @code{:session} header argument, and in other languages (e.g.,
14289 Python and Haskell) which have limitations on the code which may be entered
14290 into interactive sessions, those limitations apply to the code in code blocks
14291 using the @code{:session} header argument as well.
14293 Unless the @code{:results output} option is supplied (see below) the result
14294 returned is the result of the last evaluation performed by the
14295 interpreter. (This is obtained in a language-specific manner: the value of
14296 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
14299 @subsubsection @code{:results output}
14300 The code is passed to the interpreter running as an interactive Emacs
14301 inferior process. The result returned is the concatenation of the sequence of
14302 (text) output from the interactive interpreter. Notice that this is not
14303 necessarily the same as what would be sent to @code{STDOUT} if the same code
14304 were passed to a non-interactive interpreter running as an external
14305 process. For example, compare the following two blocks:
14308 #+BEGIN_SRC python :results output
14319 In non-session mode, the `2' is not printed and does not appear.
14321 #+BEGIN_SRC python :results output :session
14333 But in @code{:session} mode, the interactive interpreter receives input `2'
14334 and prints out its value, `2'. (Indeed, the other print statements are
14337 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
14338 @section Noweb reference syntax
14339 @cindex code block, noweb reference
14340 @cindex syntax, noweb
14341 @cindex source code, noweb reference
14343 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
14344 Programming system allows named blocks of code to be referenced by using the
14345 familiar Noweb syntax:
14348 <<code-block-name>>
14351 When a code block is tangled or evaluated, whether or not ``noweb''
14352 references are expanded depends upon the value of the @code{:noweb} header
14353 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
14354 evaluation. If @code{:noweb no}, the default, then the reference is not
14355 expanded before evaluation. See the @ref{noweb-ref} header argument for
14356 a more flexible way to resolve noweb references.
14358 It is possible to include the @emph{results} of a code block rather than the
14359 body. This is done by appending parenthesis to the code block name which may
14360 optionally contain arguments to the code block as shown below.
14363 <<code-block-name(optional arguments)>>
14366 Note: the default value, @code{:noweb no}, was chosen to ensure that
14367 correct code is not broken in a language, such as Ruby, where
14368 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
14369 syntactically valid in languages that you use, then please consider setting
14372 Note: if noweb tangling is slow in large Org mode files consider setting the
14373 @code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
14374 This will result in faster noweb reference resolution at the expense of not
14375 correctly resolving inherited values of the @code{:noweb-ref} header
14378 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
14379 @section Key bindings and useful functions
14380 @cindex code block, key bindings
14382 Many common Org mode key sequences are re-bound depending on
14385 Within a code block, the following key bindings
14388 @multitable @columnfractions 0.25 0.75
14390 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
14392 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
14394 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
14396 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
14399 In an Org mode buffer, the following key bindings are active:
14401 @multitable @columnfractions 0.45 0.55
14403 @kindex C-c C-v C-p
14404 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
14406 @kindex C-c C-v C-n
14407 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
14409 @kindex C-c C-v C-e
14410 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
14412 @kindex C-c C-v C-o
14413 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
14415 @kindex C-c C-v C-v
14416 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
14418 @kindex C-c C-v C-u
14419 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
14421 @kindex C-c C-v C-g
14422 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
14424 @kindex C-c C-v C-r
14425 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
14427 @kindex C-c C-v C-b
14428 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14430 @kindex C-c C-v C-s
14431 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14433 @kindex C-c C-v C-d
14434 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
14436 @kindex C-c C-v C-t
14437 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14439 @kindex C-c C-v C-f
14440 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14442 @kindex C-c C-v C-c
14443 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
14445 @kindex C-c C-v C-j
14446 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
14448 @kindex C-c C-v C-l
14449 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
14451 @kindex C-c C-v C-i
14452 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
14454 @kindex C-c C-v C-I
14455 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
14457 @kindex C-c C-v C-z
14458 @item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session-with-code}
14460 @kindex C-c C-v C-a
14461 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14463 @kindex C-c C-v C-h
14464 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
14466 @kindex C-c C-v C-x
14467 @item @kbd{C-c C-v x} @ @ @r{or} @ @ @kbd{C-c C-v C-x} @tab @code{org-babel-do-key-sequence-in-edit-buffer}
14470 @c When possible these keybindings were extended to work when the control key is
14471 @c kept pressed, resulting in the following additional keybindings.
14473 @c @multitable @columnfractions 0.25 0.75
14474 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14475 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14476 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14477 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14478 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14479 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14480 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14481 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14484 @node Batch execution, , Key bindings and useful functions, Working With Source Code
14485 @section Batch execution
14486 @cindex code block, batch execution
14487 @cindex source code, batch execution
14489 It is possible to call functions from the command line. This shell
14490 script calls @code{org-babel-tangle} on every one of its arguments.
14492 Be sure to adjust the paths to fit your system.
14496 # -*- mode: shell-script -*-
14498 # tangle files with org-mode
14502 ORGINSTALL="~/src/org/lisp/org-install.el"
14504 # wrap each argument in the code required to call tangle on it
14506 FILES="$FILES \"$i\""
14509 emacs -Q --batch -l $ORGINSTALL \
14511 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
14512 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\"))
14513 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
14514 (mapc (lambda (file)
14515 (find-file (expand-file-name file \"$DIR\"))
14517 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
14520 @node Miscellaneous, Hacking, Working With Source Code, Top
14521 @chapter Miscellaneous
14524 * Completion:: M-TAB knows what you need
14525 * Easy Templates:: Quick insertion of structural elements
14526 * Speed keys:: Electric commands at the beginning of a headline
14527 * Code evaluation security:: Org mode files evaluate inline code
14528 * Customization:: Adapting Org to your taste
14529 * In-buffer settings:: Overview of the #+KEYWORDS
14530 * The very busy C-c C-c key:: When in doubt, press C-c C-c
14531 * Clean view:: Getting rid of leading stars in the outline
14532 * TTY keys:: Using Org on a tty
14533 * Interaction:: Other Emacs packages
14534 * org-crypt.el:: Encrypting Org files
14538 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
14539 @section Completion
14540 @cindex completion, of @TeX{} symbols
14541 @cindex completion, of TODO keywords
14542 @cindex completion, of dictionary words
14543 @cindex completion, of option keywords
14544 @cindex completion, of tags
14545 @cindex completion, of property keys
14546 @cindex completion, of link abbreviations
14547 @cindex @TeX{} symbol completion
14548 @cindex TODO keywords completion
14549 @cindex dictionary word completion
14550 @cindex option keyword completion
14551 @cindex tag completion
14552 @cindex link abbreviations, completion of
14554 Emacs would not be Emacs without completion, and Org mode uses it whenever it
14555 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
14556 some of the completion prompts, you can specify your preference by setting at
14557 most one of the variables @code{org-completion-use-iswitchb}
14558 @code{org-completion-use-ido}.
14560 Org supports in-buffer completion. This type of completion does
14561 not make use of the minibuffer. You simply type a few letters into
14562 the buffer and use the key to complete text right there.
14565 @kindex M-@key{TAB}
14567 Complete word at point
14570 At the beginning of a headline, complete TODO keywords.
14572 After @samp{\}, complete @TeX{} symbols supported by the exporter.
14574 After @samp{*}, complete headlines in the current buffer so that they
14575 can be used in search links like @samp{[[*find this headline]]}.
14577 After @samp{:} in a headline, complete tags. The list of tags is taken
14578 from the variable @code{org-tag-alist} (possibly set through the
14579 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
14580 dynamically from all tags used in the current buffer.
14582 After @samp{:} and not in a headline, complete property keys. The list
14583 of keys is constructed dynamically from all keys used in the current
14586 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
14588 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
14589 @samp{OPTIONS} which set file-specific options for Org mode. When the
14590 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
14591 will insert example settings for this keyword.
14593 In the line after @samp{#+STARTUP: }, complete startup keywords,
14594 i.e.@: valid keys for this line.
14596 Elsewhere, complete dictionary words using Ispell.
14600 @node Easy Templates, Speed keys, Completion, Miscellaneous
14601 @section Easy Templates
14602 @cindex template insertion
14603 @cindex insertion, of templates
14605 Org mode supports insertion of empty structural elements (like
14606 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
14607 strokes. This is achieved through a native template expansion mechanism.
14608 Note that Emacs has several other template mechanisms which could be used in
14609 a similar way, for example @file{yasnippet}.
14611 To insert a structural element, type a @samp{<}, followed by a template
14612 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
14613 keystrokes are typed on a line by itself.
14615 The following template selectors are currently supported.
14617 @multitable @columnfractions 0.1 0.9
14618 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
14619 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
14620 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
14621 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
14622 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
14623 @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
14624 @item @kbd{L} @tab @code{#+LaTeX:}
14625 @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
14626 @item @kbd{H} @tab @code{#+HTML:}
14627 @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
14628 @item @kbd{A} @tab @code{#+ASCII:}
14629 @item @kbd{i} @tab @code{#+INDEX:} line
14630 @item @kbd{I} @tab @code{#+INCLUDE:} line
14633 For example, on an empty line, typing "<e" and then pressing TAB, will expand
14634 into a complete EXAMPLE template.
14636 You can install additional templates by customizing the variable
14637 @code{org-structure-template-alist}. See the docstring of the variable for
14638 additional details.
14640 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
14641 @section Speed keys
14643 @vindex org-use-speed-commands
14644 @vindex org-speed-commands-user
14646 Single keys can be made to execute commands when the cursor is at the
14647 beginning of a headline, i.e.@: before the first star. Configure the variable
14648 @code{org-use-speed-commands} to activate this feature. There is a
14649 pre-defined list of commands, and you can add more such commands using the
14650 variable @code{org-speed-commands-user}. Speed keys do not only speed up
14651 navigation and other commands, but they also provide an alternative way to
14652 execute commands bound to keys that are not or not easily available on a TTY,
14653 or on a small mobile device with a limited keyboard.
14655 To see which commands are available, activate the feature and press @kbd{?}
14656 with the cursor at the beginning of a headline.
14658 @node Code evaluation security, Customization, Speed keys, Miscellaneous
14659 @section Code evaluation and security issues
14661 Org provides tools to work with the code snippets, including evaluating them.
14663 Running code on your machine always comes with a security risk. Badly
14664 written or malicious code can be executed on purpose or by accident. Org has
14665 default settings which will only evaluate such code if you give explicit
14666 permission to do so, and as a casual user of these features you should leave
14667 these precautions intact.
14669 For people who regularly work with such code, the confirmation prompts can
14670 become annoying, and you might want to turn them off. This can be done, but
14671 you must be aware of the risks that are involved.
14673 Code evaluation can happen under the following circumstances:
14676 @item Source code blocks
14677 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
14678 C-c} in the block. The most important thing to realize here is that Org mode
14679 files which contain code snippets are, in a certain sense, like executable
14680 files. So you should accept them and load them into Emacs only from trusted
14681 sources---just like you would do with a program you install on your computer.
14683 Make sure you know what you are doing before customizing the variables
14684 which take off the default security brakes.
14686 @defopt org-confirm-babel-evaluate
14687 When t (the default), the user is asked before every code block evaluation.
14688 When nil, the user is not asked. When set to a function, it is called with
14689 two arguments (language and body of the code block) and should return t to
14690 ask and nil not to ask.
14693 For example, here is how to execute "ditaa" code (which is considered safe)
14696 (defun my-org-confirm-babel-evaluate (lang body)
14697 (not (string= lang "ditaa"))) ; don't ask for ditaa
14698 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
14701 @item Following @code{shell} and @code{elisp} links
14702 Org has two link types that can directly evaluate code (@pxref{External
14703 links}). These links can be problematic because the code to be evaluated is
14706 @defopt org-confirm-shell-link-function
14707 Function to queries user about shell link execution.
14709 @defopt org-confirm-elisp-link-function
14710 Functions to query user for Emacs Lisp link execution.
14713 @item Formulas in tables
14714 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
14715 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
14718 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
14719 @section Customization
14720 @cindex customization
14721 @cindex options, for customization
14722 @cindex variables, for customization
14724 There are more than 500 variables that can be used to customize
14725 Org. For the sake of compactness of the manual, I am not
14726 describing the variables here. A structured overview of customization
14727 variables is available with @kbd{M-x org-customize}. Or select
14728 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
14729 settings can also be activated on a per-file basis, by putting special
14730 lines into the buffer (@pxref{In-buffer settings}).
14732 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
14733 @section Summary of in-buffer settings
14734 @cindex in-buffer settings
14735 @cindex special keywords
14737 Org mode uses special lines in the buffer to define settings on a
14738 per-file basis. These lines start with a @samp{#+} followed by a
14739 keyword, a colon, and then individual words defining a setting. Several
14740 setting words can be in the same line, but you can also have multiple
14741 lines for the keyword. While these settings are described throughout
14742 the manual, here is a summary. After changing any of those lines in the
14743 buffer, press @kbd{C-c C-c} with the cursor still in the line to
14744 activate the changes immediately. Otherwise they become effective only
14745 when the file is visited again in a new Emacs session.
14747 @vindex org-archive-location
14749 @item #+ARCHIVE: %s_done::
14750 This line sets the archive location for the agenda file. It applies for
14751 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
14752 of the file. The first such line also applies to any entries before it.
14753 The corresponding variable is @code{org-archive-location}.
14755 This line sets the category for the agenda file. The category applies
14756 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
14757 end of the file. The first such line also applies to any entries before it.
14758 @item #+COLUMNS: %25ITEM .....
14759 @cindex property, COLUMNS
14760 Set the default format for columns view. This format applies when
14761 columns view is invoked in locations where no @code{COLUMNS} property
14763 @item #+CONSTANTS: name1=value1 ...
14764 @vindex org-table-formula-constants
14765 @vindex org-table-formula
14766 Set file-local values for constants to be used in table formulas. This
14767 line sets the local variable @code{org-table-formula-constants-local}.
14768 The global version of this variable is
14769 @code{org-table-formula-constants}.
14770 @item #+FILETAGS: :tag1:tag2:tag3:
14771 Set tags that can be inherited by any entry in the file, including the
14773 @item #+DRAWERS: NAME1 .....
14774 @vindex org-drawers
14775 Set the file-local set of additional drawers. The corresponding global
14776 variable is @code{org-drawers}.
14777 @item #+LINK: linkword replace
14778 @vindex org-link-abbrev-alist
14779 These lines (several are allowed) specify link abbreviations.
14780 @xref{Link abbreviations}. The corresponding variable is
14781 @code{org-link-abbrev-alist}.
14782 @item #+PRIORITIES: highest lowest default
14783 @vindex org-highest-priority
14784 @vindex org-lowest-priority
14785 @vindex org-default-priority
14786 This line sets the limits and the default for the priorities. All three
14787 must be either letters A-Z or numbers 0-9. The highest priority must
14788 have a lower ASCII number than the lowest priority.
14789 @item #+PROPERTY: Property_Name Value
14790 This line sets a default inheritance value for entries in the current
14791 buffer, most useful for specifying the allowed values of a property.
14792 @cindex #+SETUPFILE
14793 @item #+SETUPFILE: file
14794 This line defines a file that holds more in-buffer setup. Normally this is
14795 entirely ignored. Only when the buffer is parsed for option-setting lines
14796 (i.e.@: when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
14797 settings line, or when exporting), then the contents of this file are parsed
14798 as if they had been included in the buffer. In particular, the file can be
14799 any other Org mode file with internal setup. You can visit the file the
14800 cursor is in the line with @kbd{C-c '}.
14803 This line sets options to be used at startup of Org mode, when an
14804 Org file is being visited.
14806 The first set of options deals with the initial visibility of the outline
14807 tree. The corresponding variable for global default settings is
14808 @code{org-startup-folded}, with a default value @code{t}, which means
14810 @vindex org-startup-folded
14811 @cindex @code{overview}, STARTUP keyword
14812 @cindex @code{content}, STARTUP keyword
14813 @cindex @code{showall}, STARTUP keyword
14814 @cindex @code{showeverything}, STARTUP keyword
14816 overview @r{top-level headlines only}
14817 content @r{all headlines}
14818 showall @r{no folding of any entries}
14819 showeverything @r{show even drawer contents}
14822 @vindex org-startup-indented
14823 @cindex @code{indent}, STARTUP keyword
14824 @cindex @code{noindent}, STARTUP keyword
14825 Dynamic virtual indentation is controlled by the variable
14826 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
14828 indent @r{start with @code{org-indent-mode} turned on}
14829 noindent @r{start with @code{org-indent-mode} turned off}
14832 @vindex org-startup-align-all-tables
14833 Then there are options for aligning tables upon visiting a file. This
14834 is useful in files containing narrowed table columns. The corresponding
14835 variable is @code{org-startup-align-all-tables}, with a default value
14837 @cindex @code{align}, STARTUP keyword
14838 @cindex @code{noalign}, STARTUP keyword
14840 align @r{align all tables}
14841 noalign @r{don't align tables on startup}
14844 @vindex org-startup-with-inline-images
14845 When visiting a file, inline images can be automatically displayed. The
14846 corresponding variable is @code{org-startup-with-inline-images}, with a
14847 default value @code{nil} to avoid delays when visiting a file.
14848 @cindex @code{inlineimages}, STARTUP keyword
14849 @cindex @code{noinlineimages}, STARTUP keyword
14851 inlineimages @r{show inline images}
14852 noinlineimages @r{don't show inline images on startup}
14855 @vindex org-log-done
14856 @vindex org-log-note-clock-out
14857 @vindex org-log-repeat
14858 Logging the closing and reopening of TODO items and clock intervals can be
14859 configured using these options (see variables @code{org-log-done},
14860 @code{org-log-note-clock-out} and @code{org-log-repeat})
14861 @cindex @code{logdone}, STARTUP keyword
14862 @cindex @code{lognotedone}, STARTUP keyword
14863 @cindex @code{nologdone}, STARTUP keyword
14864 @cindex @code{lognoteclock-out}, STARTUP keyword
14865 @cindex @code{nolognoteclock-out}, STARTUP keyword
14866 @cindex @code{logrepeat}, STARTUP keyword
14867 @cindex @code{lognoterepeat}, STARTUP keyword
14868 @cindex @code{nologrepeat}, STARTUP keyword
14869 @cindex @code{logreschedule}, STARTUP keyword
14870 @cindex @code{lognotereschedule}, STARTUP keyword
14871 @cindex @code{nologreschedule}, STARTUP keyword
14872 @cindex @code{logredeadline}, STARTUP keyword
14873 @cindex @code{lognoteredeadline}, STARTUP keyword
14874 @cindex @code{nologredeadline}, STARTUP keyword
14875 @cindex @code{logrefile}, STARTUP keyword
14876 @cindex @code{lognoterefile}, STARTUP keyword
14877 @cindex @code{nologrefile}, STARTUP keyword
14879 logdone @r{record a timestamp when an item is marked DONE}
14880 lognotedone @r{record timestamp and a note when DONE}
14881 nologdone @r{don't record when items are marked DONE}
14882 logrepeat @r{record a time when reinstating a repeating item}
14883 lognoterepeat @r{record a note when reinstating a repeating item}
14884 nologrepeat @r{do not record when reinstating repeating item}
14885 lognoteclock-out @r{record a note when clocking out}
14886 nolognoteclock-out @r{don't record a note when clocking out}
14887 logreschedule @r{record a timestamp when scheduling time changes}
14888 lognotereschedule @r{record a note when scheduling time changes}
14889 nologreschedule @r{do not record when a scheduling date changes}
14890 logredeadline @r{record a timestamp when deadline changes}
14891 lognoteredeadline @r{record a note when deadline changes}
14892 nologredeadline @r{do not record when a deadline date changes}
14893 logrefile @r{record a timestamp when refiling}
14894 lognoterefile @r{record a note when refiling}
14895 nologrefile @r{do not record when refiling}
14897 @vindex org-hide-leading-stars
14898 @vindex org-odd-levels-only
14899 Here are the options for hiding leading stars in outline headings, and for
14900 indenting outlines. The corresponding variables are
14901 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
14902 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
14903 @cindex @code{hidestars}, STARTUP keyword
14904 @cindex @code{showstars}, STARTUP keyword
14905 @cindex @code{odd}, STARTUP keyword
14906 @cindex @code{even}, STARTUP keyword
14908 hidestars @r{make all but one of the stars starting a headline invisible.}
14909 showstars @r{show all stars starting a headline}
14910 indent @r{virtual indentation according to outline level}
14911 noindent @r{no virtual indentation according to outline level}
14912 odd @r{allow only odd outline levels (1,3,...)}
14913 oddeven @r{allow all outline levels}
14915 @vindex org-put-time-stamp-overlays
14916 @vindex org-time-stamp-overlay-formats
14917 To turn on custom format overlays over timestamps (variables
14918 @code{org-put-time-stamp-overlays} and
14919 @code{org-time-stamp-overlay-formats}), use
14920 @cindex @code{customtime}, STARTUP keyword
14922 customtime @r{overlay custom time format}
14924 @vindex constants-unit-system
14925 The following options influence the table spreadsheet (variable
14926 @code{constants-unit-system}).
14927 @cindex @code{constcgs}, STARTUP keyword
14928 @cindex @code{constSI}, STARTUP keyword
14930 constcgs @r{@file{constants.el} should use the c-g-s unit system}
14931 constSI @r{@file{constants.el} should use the SI unit system}
14933 @vindex org-footnote-define-inline
14934 @vindex org-footnote-auto-label
14935 @vindex org-footnote-auto-adjust
14936 To influence footnote settings, use the following keywords. The
14937 corresponding variables are @code{org-footnote-define-inline},
14938 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
14939 @cindex @code{fninline}, STARTUP keyword
14940 @cindex @code{nofninline}, STARTUP keyword
14941 @cindex @code{fnlocal}, STARTUP keyword
14942 @cindex @code{fnprompt}, STARTUP keyword
14943 @cindex @code{fnauto}, STARTUP keyword
14944 @cindex @code{fnconfirm}, STARTUP keyword
14945 @cindex @code{fnplain}, STARTUP keyword
14946 @cindex @code{fnadjust}, STARTUP keyword
14947 @cindex @code{nofnadjust}, STARTUP keyword
14949 fninline @r{define footnotes inline}
14950 fnnoinline @r{define footnotes in separate section}
14951 fnlocal @r{define footnotes near first reference, but not inline}
14952 fnprompt @r{prompt for footnote labels}
14953 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
14954 fnconfirm @r{offer automatic label for editing or confirmation}
14955 fnplain @r{create @code{[1]}-like labels automatically}
14956 fnadjust @r{automatically renumber and sort footnotes}
14957 nofnadjust @r{do not renumber and sort automatically}
14959 @cindex org-hide-block-startup
14960 To hide blocks on startup, use these keywords. The corresponding variable is
14961 @code{org-hide-block-startup}.
14962 @cindex @code{hideblocks}, STARTUP keyword
14963 @cindex @code{nohideblocks}, STARTUP keyword
14965 hideblocks @r{Hide all begin/end blocks on startup}
14966 nohideblocks @r{Do not hide blocks on startup}
14968 @cindex org-pretty-entities
14969 The display of entities as UTF-8 characters is governed by the variable
14970 @code{org-pretty-entities} and the keywords
14971 @cindex @code{entitiespretty}, STARTUP keyword
14972 @cindex @code{entitiesplain}, STARTUP keyword
14974 entitiespretty @r{Show entities as UTF-8 characters where possible}
14975 entitiesplain @r{Leave entities plain}
14977 @item #+TAGS: TAG1(c1) TAG2(c2)
14978 @vindex org-tag-alist
14979 These lines (several such lines are allowed) specify the valid tags in
14980 this file, and (potentially) the corresponding @emph{fast tag selection}
14981 keys. The corresponding variable is @code{org-tag-alist}.
14983 This line contains the formulas for the table directly above the line.
14984 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
14985 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
14986 @itemx #+DESCRIPTION:, #+KEYWORDS:,
14987 @itemx #+LaTeX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
14988 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
14989 These lines provide settings for exporting files. For more details see
14990 @ref{Export options}.
14991 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
14992 @vindex org-todo-keywords
14993 These lines set the TODO keywords and their interpretation in the
14994 current file. The corresponding variable is @code{org-todo-keywords}.
14997 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
14998 @section The very busy C-c C-c key
15000 @cindex C-c C-c, overview
15002 The key @kbd{C-c C-c} has many purposes in Org, which are all
15003 mentioned scattered throughout this manual. One specific function of
15004 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
15005 other circumstances it means something like @emph{``Hey Org, look
15006 here and update according to what you see here''}. Here is a summary of
15007 what this means in different contexts.
15011 If there are highlights in the buffer from the creation of a sparse
15012 tree, or from clock display, remove these highlights.
15014 If the cursor is in one of the special @code{#+KEYWORD} lines, this
15015 triggers scanning the buffer for these lines and updating the
15018 If the cursor is inside a table, realign the table. This command
15019 works even if the automatic table editor has been turned off.
15021 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
15024 If the current buffer is a capture buffer, close the note and file it.
15025 With a prefix argument, file it, without further interaction, to the
15028 If the cursor is on a @code{<<<target>>>}, update radio targets and
15029 corresponding links in this buffer.
15031 If the cursor is in a property line or at the start or end of a property
15032 drawer, offer property commands.
15034 If the cursor is at a footnote reference, go to the corresponding
15035 definition, and vice versa.
15037 If the cursor is on a statistics cookie, update it.
15039 If the cursor is in a plain list item with a checkbox, toggle the status
15042 If the cursor is on a numbered item in a plain list, renumber the
15045 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
15048 If the cursor is at a timestamp, fix the day name in the timestamp.
15051 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
15052 @section A cleaner outline view
15053 @cindex hiding leading stars
15054 @cindex dynamic indentation
15055 @cindex odd-levels-only outlines
15056 @cindex clean outline view
15058 Some people find it noisy and distracting that the Org headlines start with a
15059 potentially large number of stars, and that text below the headlines is not
15060 indented. While this is no problem when writing a @emph{book-like} document
15061 where the outline headings are really section headings, in a more
15062 @emph{list-oriented} outline, indented structure is a lot cleaner:
15066 * Top level headline | * Top level headline
15067 ** Second level | * Second level
15068 *** 3rd level | * 3rd level
15069 some text | some text
15070 *** 3rd level | * 3rd level
15071 more text | more text
15072 * Another top level headline | * Another top level headline
15078 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
15079 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
15080 be achieved dynamically at display time using @code{org-indent-mode}. In
15081 this minor mode, all lines are prefixed for display with the necessary amount
15082 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
15083 property, such that @code{visual-line-mode} (or purely setting
15084 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
15085 }. Also headlines are prefixed with additional stars, so that the amount of
15086 indentation shifts by two@footnote{See the variable
15087 @code{org-indent-indentation-per-level}.} spaces per level. All headline
15088 stars but the last one are made invisible using the @code{org-hide}
15089 face@footnote{Turning on @code{org-indent-mode} sets
15090 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
15091 @code{nil}.} - see below under @samp{2.} for more information on how this
15092 works. You can turn on @code{org-indent-mode} for all files by customizing
15093 the variable @code{org-startup-indented}, or you can turn it on for
15094 individual files using
15100 If you want a similar effect in an earlier version of Emacs and/or Org, or if
15101 you want the indentation to be hard space characters so that the plain text
15102 file looks as similar as possible to the Emacs display, Org supports you in
15107 @emph{Indentation of text below headlines}@*
15108 You may indent text below each headline to make the left boundary line up
15109 with the headline, like
15113 more text, now indented
15116 @vindex org-adapt-indentation
15117 Org supports this with paragraph filling, line wrapping, and structure
15118 editing@footnote{See also the variable @code{org-adapt-indentation}.},
15119 preserving or adapting the indentation as appropriate.
15122 @vindex org-hide-leading-stars
15123 @emph{Hiding leading stars}@* You can modify the display in such a way that
15124 all leading stars become invisible. To do this in a global way, configure
15125 the variable @code{org-hide-leading-stars} or change this on a per-file basis
15129 #+STARTUP: hidestars
15130 #+STARTUP: showstars
15133 With hidden stars, the tree becomes:
15137 * Top level headline
15145 @vindex org-hide @r{(face)}
15146 The leading stars are not truly replaced by whitespace, they are only
15147 fontified with the face @code{org-hide} that uses the background color as
15148 font color. If you are not using either white or black background, you may
15149 have to customize this face to get the wanted effect. Another possibility is
15150 to set this font such that the extra stars are @i{almost} invisible, for
15151 example using the color @code{grey90} on a white background.
15154 @vindex org-odd-levels-only
15155 Things become cleaner still if you skip all the even levels and use only odd
15156 levels 1, 3, 5..., effectively adding two stars to go from one outline level
15157 to the next@footnote{When you need to specify a level for a property search
15158 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc@.}. In this
15159 way we get the outline view shown at the beginning of this section. In order
15160 to make the structure editing and export commands handle this convention
15161 correctly, configure the variable @code{org-odd-levels-only}, or set this on
15162 a per-file basis with one of the following lines:
15169 You can convert an Org file from single-star-per-level to the
15170 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
15171 RET} in that file. The reverse operation is @kbd{M-x
15172 org-convert-to-oddeven-levels}.
15175 @node TTY keys, Interaction, Clean view, Miscellaneous
15176 @section Using Org on a tty
15177 @cindex tty key bindings
15179 Because Org contains a large number of commands, by default many of
15180 Org's core commands are bound to keys that are generally not
15181 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
15182 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
15183 together with modifiers like @key{Meta} and/or @key{Shift}. To access
15184 these commands on a tty when special keys are unavailable, the following
15185 alternative bindings can be used. The tty bindings below will likely be
15186 more cumbersome; you may find for some of the bindings below that a
15187 customized workaround suits you better. For example, changing a timestamp
15188 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
15189 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
15191 @multitable @columnfractions 0.15 0.2 0.1 0.2
15192 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
15193 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
15194 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
15195 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
15196 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
15197 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
15198 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
15199 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
15200 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
15201 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
15202 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
15203 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
15204 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
15205 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
15206 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
15207 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
15208 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
15209 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
15210 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
15214 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
15215 @section Interaction with other packages
15216 @cindex packages, interaction with other
15217 Org lives in the world of GNU Emacs and interacts in various ways
15218 with other code out there.
15221 * Cooperation:: Packages Org cooperates with
15222 * Conflicts:: Packages that lead to conflicts
15225 @node Cooperation, Conflicts, Interaction, Interaction
15226 @subsection Packages that Org cooperates with
15229 @cindex @file{calc.el}
15230 @cindex Gillespie, Dave
15231 @item @file{calc.el} by Dave Gillespie
15232 Org uses the Calc package for implementing spreadsheet
15233 functionality in its tables (@pxref{The spreadsheet}). Org
15234 checks for the availability of Calc by looking for the function
15235 @code{calc-eval} which will have been autoloaded during setup if Calc has
15236 been installed properly. As of Emacs 22, Calc is part of the Emacs
15237 distribution. Another possibility for interaction between the two
15238 packages is using Calc for embedded calculations. @xref{Embedded Mode,
15239 , Embedded Mode, calc, GNU Emacs Calc Manual}.
15240 @item @file{constants.el} by Carsten Dominik
15241 @cindex @file{constants.el}
15242 @cindex Dominik, Carsten
15243 @vindex org-table-formula-constants
15244 In a table formula (@pxref{The spreadsheet}), it is possible to use
15245 names for natural constants or units. Instead of defining your own
15246 constants in the variable @code{org-table-formula-constants}, install
15247 the @file{constants} package which defines a large number of constants
15248 and units, and lets you use unit prefixes like @samp{M} for
15249 @samp{Mega}, etc@. You will need version 2.0 of this package, available
15250 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
15251 the function @code{constants-get}, which has to be autoloaded in your
15252 setup. See the installation instructions in the file
15253 @file{constants.el}.
15254 @item @file{cdlatex.el} by Carsten Dominik
15255 @cindex @file{cdlatex.el}
15256 @cindex Dominik, Carsten
15257 Org mode can make use of the CD@LaTeX{} package to efficiently enter
15258 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
15259 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
15260 @cindex @file{imenu.el}
15261 Imenu allows menu access to an index of items in a file. Org mode
15262 supports Imenu---all you need to do to get the index is the following:
15264 (add-hook 'org-mode-hook
15265 (lambda () (imenu-add-to-menubar "Imenu")))
15267 @vindex org-imenu-depth
15268 By default the index is two levels deep---you can modify the depth using
15269 the option @code{org-imenu-depth}.
15270 @item @file{remember.el} by John Wiegley
15271 @cindex @file{remember.el}
15272 @cindex Wiegley, John
15273 Org used to use this package for capture, but no longer does.
15274 @item @file{speedbar.el} by Eric M. Ludlam
15275 @cindex @file{speedbar.el}
15276 @cindex Ludlam, Eric M.
15277 Speedbar is a package that creates a special frame displaying files and
15278 index items in files. Org mode supports Speedbar and allows you to
15279 drill into Org files directly from the Speedbar. It also allows you to
15280 restrict the scope of agenda commands to a file or a subtree by using
15281 the command @kbd{<} in the Speedbar frame.
15282 @cindex @file{table.el}
15283 @item @file{table.el} by Takaaki Ota
15285 @cindex table editor, @file{table.el}
15286 @cindex @file{table.el}
15287 @cindex Ota, Takaaki
15289 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
15290 and alignment can be created using the Emacs table package by Takaaki Ota
15291 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
15292 Org mode will recognize these tables and export them properly. Because of
15293 interference with other Org mode functionality, you unfortunately cannot edit
15294 these tables directly in the buffer. Instead, you need to use the command
15295 @kbd{C-c '} to edit them, similar to source code snippets.
15298 @orgcmd{C-c ',org-edit-special}
15299 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
15301 @orgcmd{C-c ~,org-table-create-with-table.el}
15302 Insert a @file{table.el} table. If there is already a table at point, this
15303 command converts it between the @file{table.el} format and the Org mode
15304 format. See the documentation string of the command
15305 @code{org-convert-table} for the restrictions under which this is
15308 @file{table.el} is part of Emacs since Emacs 22.
15309 @item @file{footnote.el} by Steven L. Baur
15310 @cindex @file{footnote.el}
15311 @cindex Baur, Steven L.
15312 Org mode recognizes numerical footnotes as provided by this package.
15313 However, Org mode also has its own footnote support (@pxref{Footnotes}),
15314 which makes using @file{footnote.el} unnecessary.
15317 @node Conflicts, , Cooperation, Interaction
15318 @subsection Packages that lead to conflicts with Org mode
15322 @cindex @code{shift-selection-mode}
15323 @vindex org-support-shift-select
15324 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
15325 cursor motions combined with the shift key should start or enlarge regions.
15326 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
15327 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
15328 at such a location. By default, @kbd{S-@key{cursor}} commands outside
15329 special contexts don't do anything, but you can customize the variable
15330 @code{org-support-shift-select}. Org mode then tries to accommodate shift
15331 selection by (i) using it outside of the special contexts where special
15332 commands apply, and by (ii) extending an existing active region even if the
15333 cursor moves across a special context.
15335 @item @file{CUA.el} by Kim. F. Storm
15336 @cindex @file{CUA.el}
15337 @cindex Storm, Kim. F.
15338 @vindex org-replace-disputed-keys
15339 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
15340 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
15341 region. In fact, Emacs 23 has this built-in in the form of
15342 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
15343 23, you probably don't want to use another package for this purpose. However,
15344 if you prefer to leave these keys to a different package while working in
15345 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
15346 Org will move the following key bindings in Org files, and in the agenda
15347 buffer (but not during date selection).
15350 S-UP @result{} M-p S-DOWN @result{} M-n
15351 S-LEFT @result{} M-- S-RIGHT @result{} M-+
15352 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
15355 @vindex org-disputed-keys
15356 Yes, these are unfortunately more difficult to remember. If you want
15357 to have other replacement keys, look at the variable
15358 @code{org-disputed-keys}.
15360 @item @file{yasnippet.el}
15361 @cindex @file{yasnippet.el}
15362 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
15363 @code{"\t"}) overrules YASnippet's access to this key. The following code
15364 fixed this problem:
15367 (add-hook 'org-mode-hook
15369 (org-set-local 'yas/trigger-key [tab])
15370 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
15373 The latest version of yasnippet doesn't play well with Org mode. If the
15374 above code does not fix the conflict, start by defining the following
15378 (defun yas/org-very-safe-expand ()
15379 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
15382 Then, tell Org mode what to do with the new function:
15385 (add-hook 'org-mode-hook
15387 (make-variable-buffer-local 'yas/trigger-key)
15388 (setq yas/trigger-key [tab])
15389 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
15390 (define-key yas/keymap [tab] 'yas/next-field)))
15393 @item @file{windmove.el} by Hovav Shacham
15394 @cindex @file{windmove.el}
15395 This package also uses the @kbd{S-<cursor>} keys, so everything written
15396 in the paragraph above about CUA mode also applies here. If you want make
15397 the windmove function active in locations where Org mode does not have
15398 special functionality on @kbd{S-@key{cursor}}, add this to your
15402 ;; Make windmove work in org-mode:
15403 (add-hook 'org-shiftup-final-hook 'windmove-up)
15404 (add-hook 'org-shiftleft-final-hook 'windmove-left)
15405 (add-hook 'org-shiftdown-final-hook 'windmove-down)
15406 (add-hook 'org-shiftright-final-hook 'windmove-right)
15409 @item @file{viper.el} by Michael Kifer
15410 @cindex @file{viper.el}
15412 Viper uses @kbd{C-c /} and therefore makes this key not access the
15413 corresponding Org mode command @code{org-sparse-tree}. You need to find
15414 another key for this command, or override the key in
15415 @code{viper-vi-global-user-map} with
15418 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
15423 @node org-crypt.el, , Interaction, Miscellaneous
15424 @section org-crypt.el
15425 @cindex @file{org-crypt.el}
15426 @cindex @code{org-decrypt-entry}
15428 Org-crypt will encrypt the text of an entry, but not the headline, or
15429 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
15432 Any text below a headline that has a @samp{:crypt:} tag will be automatically
15433 be encrypted when the file is saved. If you want to use a different tag just
15434 customize the @code{org-crypt-tag-matcher} setting.
15436 To use org-crypt it is suggested that you have the following in your
15440 (require 'org-crypt)
15441 (org-crypt-use-before-save-magic)
15442 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
15444 (setq org-crypt-key nil)
15445 ;; GPG key to use for encryption
15446 ;; Either the Key ID or set to nil to use symmetric encryption.
15448 (setq auto-save-default nil)
15449 ;; Auto-saving does not cooperate with org-crypt.el: so you need
15450 ;; to turn it off if you plan to use org-crypt.el quite often.
15451 ;; Otherwise, you'll get an (annoying) message each time you
15454 ;; To turn it off only locally, you can insert this:
15456 ;; # -*- buffer-auto-save-file-name: nil; -*-
15459 Excluding the crypt tag from inheritance prevents already encrypted text
15460 being encrypted again.
15462 @node Hacking, MobileOrg, Miscellaneous, Top
15466 This appendix covers some aspects where users can extend the functionality of
15470 * Hooks:: How to reach into Org's internals
15471 * Add-on packages:: Available extensions
15472 * Adding hyperlink types:: New custom link types
15473 * Context-sensitive commands:: How to add functionality to such commands
15474 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
15475 * Dynamic blocks:: Automatically filled blocks
15476 * Special agenda views:: Customized views
15477 * Extracting agenda information:: Postprocessing of agenda information
15478 * Using the property API:: Writing programs that use entry properties
15479 * Using the mapping API:: Mapping over all or selected entries
15482 @node Hooks, Add-on packages, Hacking, Hacking
15486 Org has a large number of hook variables that can be used to add
15487 functionality. This appendix about hacking is going to illustrate the
15488 use of some of them. A complete list of all hooks with documentation is
15489 maintained by the Worg project and can be found at
15490 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
15492 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
15493 @section Add-on packages
15494 @cindex add-on packages
15496 A large number of add-on packages have been written by various authors.
15497 These packages are not part of Emacs, but they are distributed as contributed
15498 packages with the separate release available at the Org mode home page at
15499 @uref{http://orgmode.org}. The list of contributed packages, along with
15500 documentation about each package, is maintained by the Worg project at
15501 @uref{http://orgmode.org/worg/org-contrib/}.
15505 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
15506 @section Adding hyperlink types
15507 @cindex hyperlinks, adding new types
15509 Org has a large number of hyperlink types built-in
15510 (@pxref{Hyperlinks}). If you would like to add new link types, Org
15511 provides an interface for doing so. Let's look at an example file,
15512 @file{org-man.el}, that will add support for creating links like
15513 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
15517 ;;; org-man.el - Support for links to manpages in Org
15521 (org-add-link-type "man" 'org-man-open)
15522 (add-hook 'org-store-link-functions 'org-man-store-link)
15524 (defcustom org-man-command 'man
15525 "The Emacs command to be used to display a man page."
15527 :type '(choice (const man) (const woman)))
15529 (defun org-man-open (path)
15530 "Visit the manpage on PATH.
15531 PATH should be a topic that can be thrown at the man command."
15532 (funcall org-man-command path))
15534 (defun org-man-store-link ()
15535 "Store a link to a manpage."
15536 (when (memq major-mode '(Man-mode woman-mode))
15537 ;; This is a man page, we do make this link
15538 (let* ((page (org-man-get-page-name))
15539 (link (concat "man:" page))
15540 (description (format "Manpage for %s" page)))
15541 (org-store-link-props
15544 :description description))))
15546 (defun org-man-get-page-name ()
15547 "Extract the page name from the buffer name."
15548 ;; This works for both `Man-mode' and `woman-mode'.
15549 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
15550 (match-string 1 (buffer-name))
15551 (error "Cannot create link to this man page")))
15555 ;;; org-man.el ends here
15559 You would activate this new link type in @file{.emacs} with
15566 Let's go through the file and see what it does.
15569 It does @code{(require 'org)} to make sure that @file{org.el} has been
15572 The next line calls @code{org-add-link-type} to define a new link type
15573 with prefix @samp{man}. The call also contains the name of a function
15574 that will be called to follow such a link.
15576 @vindex org-store-link-functions
15577 The next line adds a function to @code{org-store-link-functions}, in
15578 order to allow the command @kbd{C-c l} to record a useful link in a
15579 buffer displaying a man page.
15582 The rest of the file defines the necessary variables and functions.
15583 First there is a customization variable that determines which Emacs
15584 command should be used to display man pages. There are two options,
15585 @code{man} and @code{woman}. Then the function to follow a link is
15586 defined. It gets the link path as an argument---in this case the link
15587 path is just a topic for the manual command. The function calls the
15588 value of @code{org-man-command} to display the man page.
15590 Finally the function @code{org-man-store-link} is defined. When you try
15591 to store a link with @kbd{C-c l}, this function will be called to
15592 try to make a link. The function must first decide if it is supposed to
15593 create the link for this buffer type; we do this by checking the value
15594 of the variable @code{major-mode}. If not, the function must exit and
15595 return the value @code{nil}. If yes, the link is created by getting the
15596 manual topic from the buffer name and prefixing it with the string
15597 @samp{man:}. Then it must call the command @code{org-store-link-props}
15598 and set the @code{:type} and @code{:link} properties. Optionally you
15599 can also set the @code{:description} property to provide a default for
15600 the link description when the link is later inserted into an Org
15601 buffer with @kbd{C-c C-l}.
15603 When it makes sense for your new link type, you may also define a function
15604 @code{org-PREFIX-complete-link} that implements special (e.g.@: completion)
15605 support for inserting such a link with @kbd{C-c C-l}. Such a function should
15606 not accept any arguments, and return the full link with prefix.
15608 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
15609 @section Context-sensitive commands
15610 @cindex context-sensitive commands, hooks
15611 @cindex add-ons, context-sensitive commands
15612 @vindex org-ctrl-c-ctrl-c-hook
15614 Org has several commands that act differently depending on context. The most
15615 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
15616 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
15618 Add-ons can tap into this functionality by providing a function that detects
15619 special context for that add-on and executes functionality appropriate for
15620 the context. Here is an example from Dan Davison's @file{org-R.el} which
15621 allows you to evaluate commands based on the @file{R} programming language
15622 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
15623 described in @ref{Working With Source Code} and is now obsolete.}. For this
15624 package, special contexts are lines that start with @code{#+R:} or
15628 (defun org-R-apply-maybe ()
15629 "Detect if this is context for org-R and execute R commands."
15630 (if (save-excursion
15631 (beginning-of-line 1)
15632 (looking-at "#\\+RR?:"))
15633 (progn (call-interactively 'org-R-apply)
15634 t) ;; to signal that we took action
15635 nil)) ;; to signal that we did not
15637 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
15640 The function first checks if the cursor is in such a line. If that is the
15641 case, @code{org-R-apply} is called and the function returns @code{t} to
15642 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
15643 contexts. If the function finds it should do nothing locally, it returns
15644 @code{nil} so that other, similar functions can have a try.
15647 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
15648 @section Tables and lists in arbitrary syntax
15649 @cindex tables, in other modes
15650 @cindex lists, in other modes
15651 @cindex Orgtbl mode
15653 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
15654 frequent feature request has been to make it work with native tables in
15655 specific languages, for example @LaTeX{}. However, this is extremely
15656 hard to do in a general way, would lead to a customization nightmare,
15657 and would take away much of the simplicity of the Orgtbl mode table
15660 This appendix describes a different approach. We keep the Orgtbl mode
15661 table in its native format (the @i{source table}), and use a custom
15662 function to @i{translate} the table to the correct syntax, and to
15663 @i{install} it in the right location (the @i{target table}). This puts
15664 the burden of writing conversion functions on the user, but it allows
15665 for a very flexible system.
15667 Bastien added the ability to do the same with lists, in Orgstruct mode. You
15668 can use Org's facilities to edit and structure lists by turning
15669 @code{orgstruct-mode} on, then locally exporting such lists in another format
15670 (HTML, @LaTeX{} or Texinfo.)
15674 * Radio tables:: Sending and receiving radio tables
15675 * A @LaTeX{} example:: Step by step, almost a tutorial
15676 * Translator functions:: Copy and modify
15677 * Radio lists:: Doing the same for lists
15680 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
15681 @subsection Radio tables
15682 @cindex radio tables
15684 To define the location of the target table, you first need to create two
15685 lines that are comments in the current mode, but contain magic words for
15686 Orgtbl mode to find. Orgtbl mode will insert the translated table
15687 between these lines, replacing whatever was there before. For example:
15690 /* BEGIN RECEIVE ORGTBL table_name */
15691 /* END RECEIVE ORGTBL table_name */
15695 Just above the source table, we put a special line that tells
15696 Orgtbl mode how to translate this table and where to install it. For
15700 #+ORGTBL: SEND table_name translation_function arguments....
15704 @code{table_name} is the reference name for the table that is also used
15705 in the receiver lines. @code{translation_function} is the Lisp function
15706 that does the translation. Furthermore, the line can contain a list of
15707 arguments (alternating key and value) at the end. The arguments will be
15708 passed as a property list to the translation function for
15709 interpretation. A few standard parameters are already recognized and
15710 acted upon before the translation function is called:
15714 Skip the first N lines of the table. Hlines do count as separate lines for
15717 @item :skipcols (n1 n2 ...)
15718 List of columns that should be skipped. If the table has a column with
15719 calculation marks, that column is automatically discarded as well.
15720 Please note that the translator function sees the table @emph{after} the
15721 removal of these columns, the function never knows that there have been
15722 additional columns.
15725 When non-nil, do not escape special characters @code{&%#_^} when exporting
15726 the table. The default value is nil.
15730 The one problem remaining is how to keep the source table in the buffer
15731 without disturbing the normal workings of the file, for example during
15732 compilation of a C file or processing of a @LaTeX{} file. There are a
15733 number of different solutions:
15737 The table could be placed in a block comment if that is supported by the
15738 language. For example, in C mode you could wrap the table between
15739 @samp{/*} and @samp{*/} lines.
15741 Sometimes it is possible to put the table after some kind of @i{END}
15742 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
15745 You can just comment the table line-by-line whenever you want to process
15746 the file, and uncomment it whenever you need to edit the table. This
15747 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
15748 makes this comment-toggling very easy, in particular if you bind it to a
15752 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
15753 @subsection A @LaTeX{} example of radio tables
15754 @cindex @LaTeX{}, and Orgtbl mode
15756 The best way to wrap the source table in @LaTeX{} is to use the
15757 @code{comment} environment provided by @file{comment.sty}. It has to be
15758 activated by placing @code{\usepackage@{comment@}} into the document
15759 header. Orgtbl mode can insert a radio table skeleton@footnote{By
15760 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
15761 variable @code{orgtbl-radio-tables} to install templates for other
15762 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
15763 be prompted for a table name, let's say we use @samp{salesfigures}. You
15764 will then get the following template:
15766 @cindex #+ORGTBL, SEND
15768 % BEGIN RECEIVE ORGTBL salesfigures
15769 % END RECEIVE ORGTBL salesfigures
15771 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15777 @vindex @LaTeX{}-verbatim-environments
15778 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
15779 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
15780 into the receiver location with name @code{salesfigures}. You may now
15781 fill in the table---feel free to use the spreadsheet features@footnote{If
15782 the @samp{#+TBLFM} line contains an odd number of dollar characters,
15783 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
15784 example you can fix this by adding an extra line inside the
15785 @code{comment} environment that is used to balance the dollar
15786 expressions. If you are using AUC@TeX{} with the font-latex library, a
15787 much better solution is to add the @code{comment} environment to the
15788 variable @code{LaTeX-verbatim-environments}.}:
15791 % BEGIN RECEIVE ORGTBL salesfigures
15792 % END RECEIVE ORGTBL salesfigures
15794 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15795 | Month | Days | Nr sold | per day |
15796 |-------+------+---------+---------|
15797 | Jan | 23 | 55 | 2.4 |
15798 | Feb | 21 | 16 | 0.8 |
15799 | March | 22 | 278 | 12.6 |
15800 #+TBLFM: $4=$3/$2;%.1f
15801 % $ (optional extra dollar to keep font-lock happy, see footnote)
15806 When you are done, press @kbd{C-c C-c} in the table to get the converted
15807 table inserted between the two marker lines.
15809 Now let's assume you want to make the table header by hand, because you
15810 want to control how columns are aligned, etc@. In this case we make sure
15811 that the table translator skips the first 2 lines of the source
15812 table, and tell the command to work as a @i{splice}, i.e.@: to not produce
15813 header and footer commands of the target table:
15816 \begin@{tabular@}@{lrrr@}
15817 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
15818 % BEGIN RECEIVE ORGTBL salesfigures
15819 % END RECEIVE ORGTBL salesfigures
15823 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
15824 | Month | Days | Nr sold | per day |
15825 |-------+------+---------+---------|
15826 | Jan | 23 | 55 | 2.4 |
15827 | Feb | 21 | 16 | 0.8 |
15828 | March | 22 | 278 | 12.6 |
15829 #+TBLFM: $4=$3/$2;%.1f
15833 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
15834 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
15835 and marks horizontal lines with @code{\hline}. Furthermore, it
15836 interprets the following parameters (see also @pxref{Translator functions}):
15839 @item :splice nil/t
15840 When set to t, return only table body lines, don't wrap them into a
15841 tabular environment. Default is nil.
15844 A format to be used to wrap each field, it should contain @code{%s} for the
15845 original field value. For example, to wrap each field value in dollars,
15846 you could use @code{:fmt "$%s$"}. This may also be a property list with
15847 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
15848 A function of one argument can be used in place of the strings; the
15849 function must return a formatted string.
15852 Use this format to print numbers with exponentials. The format should
15853 have @code{%s} twice for inserting mantissa and exponent, for example
15854 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
15855 may also be a property list with column numbers and formats, for example
15856 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
15857 @code{efmt} has been applied to a value, @code{fmt} will also be
15858 applied. Similar to @code{fmt}, functions of two arguments can be
15859 supplied instead of strings.
15862 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
15863 @subsection Translator functions
15864 @cindex HTML, and Orgtbl mode
15865 @cindex translator function
15867 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
15868 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
15869 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
15870 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
15871 code that produces tables during HTML export.}, these all use a generic
15872 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
15873 itself is a very short function that computes the column definitions for the
15874 @code{tabular} environment, defines a few field and line separators and then
15875 hands processing over to the generic translator. Here is the entire code:
15879 (defun orgtbl-to-latex (table params)
15880 "Convert the Orgtbl mode TABLE to LaTeX."
15881 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
15882 org-table-last-alignment ""))
15885 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
15886 :tend "\\end@{tabular@}"
15887 :lstart "" :lend " \\\\" :sep " & "
15888 :efmt "%s\\,(%s)" :hline "\\hline")))
15889 (orgtbl-to-generic table (org-combine-plists params2 params))))
15893 As you can see, the properties passed into the function (variable
15894 @var{PARAMS}) are combined with the ones newly defined in the function
15895 (variable @var{PARAMS2}). The ones passed into the function (i.e.@: the
15896 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
15897 would like to use the @LaTeX{} translator, but wanted the line endings to
15898 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
15899 overrule the default with
15902 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
15905 For a new language, you can either write your own converter function in
15906 analogy with the @LaTeX{} translator, or you can use the generic function
15907 directly. For example, if you have a language where a table is started
15908 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
15909 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
15910 separator is a TAB, you could call the generic translator like this (on
15914 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
15915 :lstart "!BL! " :lend " !EL!" :sep "\t"
15919 Please check the documentation string of the function
15920 @code{orgtbl-to-generic} for a full list of parameters understood by
15921 that function, and remember that you can pass each of them into
15922 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
15923 using the generic function.
15925 Of course you can also write a completely new function doing complicated
15926 things the generic translator cannot do. A translator function takes
15927 two arguments. The first argument is the table, a list of lines, each
15928 line either the symbol @code{hline} or a list of fields. The second
15929 argument is the property list containing all parameters specified in the
15930 @samp{#+ORGTBL: SEND} line. The function must return a single string
15931 containing the formatted table. If you write a generally useful
15932 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
15933 others can benefit from your work.
15935 @node Radio lists, , Translator functions, Tables in arbitrary syntax
15936 @subsection Radio lists
15937 @cindex radio lists
15938 @cindex org-list-insert-radio-list
15940 Sending and receiving radio lists works exactly the same way as sending and
15941 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
15942 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
15943 @code{org-list-insert-radio-list}.
15945 Here are the differences with radio tables:
15949 Orgstruct mode must be active.
15951 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
15953 The available translation functions for radio lists don't take
15956 @kbd{C-c C-c} will work when pressed on the first item of the list.
15959 Here is a @LaTeX{} example. Let's say that you have this in your
15964 % BEGIN RECEIVE ORGLST to-buy
15965 % END RECEIVE ORGLST to-buy
15967 #+ORGLST: SEND to-buy org-list-to-latex
15976 Pressing `C-c C-c' on @code{a new house} and will insert the converted
15977 @LaTeX{} list between the two marker lines.
15979 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
15980 @section Dynamic blocks
15981 @cindex dynamic blocks
15983 Org documents can contain @emph{dynamic blocks}. These are
15984 specially marked regions that are updated by some user-written function.
15985 A good example for such a block is the clock table inserted by the
15986 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
15988 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
15989 to the block and can also specify parameters for the function producing
15990 the content of the block.
15992 @cindex #+BEGIN:dynamic block
15994 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
15999 Dynamic blocks are updated with the following commands
16002 @orgcmd{C-c C-x C-u,org-dblock-update}
16003 Update dynamic block at point.
16004 @orgkey{C-u C-c C-x C-u}
16005 Update all dynamic blocks in the current file.
16008 Updating a dynamic block means to remove all the text between BEGIN and
16009 END, parse the BEGIN line for parameters and then call the specific
16010 writer function for this block to insert the new content. If you want
16011 to use the original content in the writer function, you can use the
16012 extra parameter @code{:content}.
16014 For a block with name @code{myblock}, the writer function is
16015 @code{org-dblock-write:myblock} with as only parameter a property list
16016 with the parameters given in the begin line. Here is a trivial example
16017 of a block that keeps track of when the block update function was last
16021 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
16027 The corresponding block writer function could look like this:
16030 (defun org-dblock-write:block-update-time (params)
16031 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
16032 (insert "Last block update at: "
16033 (format-time-string fmt (current-time)))))
16036 If you want to make sure that all dynamic blocks are always up-to-date,
16037 you could add the function @code{org-update-all-dblocks} to a hook, for
16038 example @code{before-save-hook}. @code{org-update-all-dblocks} is
16039 written in a way such that it does nothing in buffers that are not in
16042 You can narrow the current buffer to the current dynamic block (like any
16043 other block) with @code{org-narrow-to-block}.
16045 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
16046 @section Special agenda views
16047 @cindex agenda views, user-defined
16049 @vindex org-agenda-skip-function
16050 @vindex org-agenda-skip-function-global
16051 Org provides a special hook that can be used to narrow down the selection
16052 made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
16053 @code{tags}, @code{tags-todo}, @code{tags-tree}. You may specify a function
16054 that is used at each match to verify if the match should indeed be part of
16055 the agenda view, and if not, how much should be skipped. You can specify a
16056 global condition that will be applied to all agenda views, this condition
16057 would be stored in the variable @code{org-agenda-skip-function-global}. More
16058 commonly, such a definition is applied only to specific custom searches,
16059 using @code{org-agenda-skip-function}.
16061 Let's say you want to produce a list of projects that contain a WAITING
16062 tag anywhere in the project tree. Let's further assume that you have
16063 marked all tree headings that define a project with the TODO keyword
16064 PROJECT. In this case you would run a TODO search for the keyword
16065 PROJECT, but skip the match unless there is a WAITING tag anywhere in
16066 the subtree belonging to the project line.
16068 To achieve this, you must write a function that searches the subtree for
16069 the tag. If the tag is found, the function must return @code{nil} to
16070 indicate that this match should not be skipped. If there is no such
16071 tag, return the location of the end of the subtree, to indicate that
16072 search should continue from there.
16075 (defun my-skip-unless-waiting ()
16076 "Skip trees that are not waiting"
16077 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
16078 (if (re-search-forward ":waiting:" subtree-end t)
16079 nil ; tag found, do not skip
16080 subtree-end))) ; tag not found, continue after end of subtree
16083 Now you may use this function in an agenda custom command, for example
16087 (org-add-agenda-custom-command
16088 '("b" todo "PROJECT"
16089 ((org-agenda-skip-function 'my-skip-unless-waiting)
16090 (org-agenda-overriding-header "Projects waiting for something: "))))
16093 @vindex org-agenda-overriding-header
16094 Note that this also binds @code{org-agenda-overriding-header} to get a
16095 meaningful header in the agenda view.
16097 @vindex org-odd-levels-only
16098 @vindex org-agenda-skip-function
16099 A general way to create custom searches is to base them on a search for
16100 entries with a certain level limit. If you want to study all entries with
16101 your custom search function, simply do a search for
16102 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
16103 level number corresponds to order in the hierarchy, not to the number of
16104 stars.}, and then use @code{org-agenda-skip-function} to select the entries
16105 you really want to have.
16107 You may also put a Lisp form into @code{org-agenda-skip-function}. In
16108 particular, you may use the functions @code{org-agenda-skip-entry-if}
16109 and @code{org-agenda-skip-subtree-if} in this form, for example:
16112 @item (org-agenda-skip-entry-if 'scheduled)
16113 Skip current entry if it has been scheduled.
16114 @item (org-agenda-skip-entry-if 'notscheduled)
16115 Skip current entry if it has not been scheduled.
16116 @item (org-agenda-skip-entry-if 'deadline)
16117 Skip current entry if it has a deadline.
16118 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
16119 Skip current entry if it has a deadline, or if it is scheduled.
16120 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
16121 Skip current entry if the TODO keyword is TODO or WAITING.
16122 @item (org-agenda-skip-entry-if 'todo 'done)
16123 Skip current entry if the TODO keyword marks a DONE state.
16124 @item (org-agenda-skip-entry-if 'timestamp)
16125 Skip current entry if it has any timestamp, may also be deadline or scheduled.
16126 @anchor{x-agenda-skip-entry-regexp}
16127 @item (org-agenda-skip-entry-if 'regexp "regular expression")
16128 Skip current entry if the regular expression matches in the entry.
16129 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
16130 Skip current entry unless the regular expression matches.
16131 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
16132 Same as above, but check and skip the entire subtree.
16135 Therefore we could also have written the search for WAITING projects
16136 like this, even without defining a special function:
16139 (org-add-agenda-custom-command
16140 '("b" todo "PROJECT"
16141 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
16142 'regexp ":waiting:"))
16143 (org-agenda-overriding-header "Projects waiting for something: "))))
16146 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
16147 @section Extracting agenda information
16148 @cindex agenda, pipe
16149 @cindex Scripts, for agenda processing
16151 @vindex org-agenda-custom-commands
16152 Org provides commands to access agenda information for the command
16153 line in Emacs batch mode. This extracted information can be sent
16154 directly to a printer, or it can be read by a program that does further
16155 processing of the data. The first of these commands is the function
16156 @code{org-batch-agenda}, that produces an agenda view and sends it as
16157 ASCII text to STDOUT. The command takes a single string as parameter.
16158 If the string has length 1, it is used as a key to one of the commands
16159 you have configured in @code{org-agenda-custom-commands}, basically any
16160 key you can use after @kbd{C-c a}. For example, to directly print the
16161 current TODO list, you could use
16164 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
16167 If the parameter is a string with 2 or more characters, it is used as a
16168 tags/TODO match string. For example, to print your local shopping list
16169 (all items with the tag @samp{shop}, but excluding the tag
16170 @samp{NewYork}), you could use
16173 emacs -batch -l ~/.emacs \
16174 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
16178 You may also modify parameters on the fly like this:
16181 emacs -batch -l ~/.emacs \
16182 -eval '(org-batch-agenda "a" \
16183 org-agenda-span (quote month) \
16184 org-agenda-include-diary nil \
16185 org-agenda-files (quote ("~/org/project.org")))' \
16190 which will produce a 30-day agenda, fully restricted to the Org file
16191 @file{~/org/projects.org}, not even including the diary.
16193 If you want to process the agenda data in more sophisticated ways, you
16194 can use the command @code{org-batch-agenda-csv} to get a comma-separated
16195 list of values for each agenda item. Each line in the output will
16196 contain a number of fields separated by commas. The fields in a line
16200 category @r{The category of the item}
16201 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
16202 type @r{The type of the agenda entry, can be}
16203 todo @r{selected in TODO match}
16204 tagsmatch @r{selected in tags match}
16205 diary @r{imported from diary}
16206 deadline @r{a deadline}
16207 scheduled @r{scheduled}
16208 timestamp @r{appointment, selected by timestamp}
16209 closed @r{entry was closed on date}
16210 upcoming-deadline @r{warning about nearing deadline}
16211 past-scheduled @r{forwarded scheduled item}
16212 block @r{entry has date block including date}
16213 todo @r{The TODO keyword, if any}
16214 tags @r{All tags including inherited ones, separated by colons}
16215 date @r{The relevant date, like 2007-2-14}
16216 time @r{The time, like 15:00-16:50}
16217 extra @r{String with extra planning info}
16218 priority-l @r{The priority letter if any was given}
16219 priority-n @r{The computed numerical priority}
16223 Time and date will only be given if a timestamp (or deadline/scheduled)
16224 led to the selection of the item.
16226 A CSV list like this is very easy to use in a post-processing script.
16227 For example, here is a Perl program that gets the TODO list from
16228 Emacs/Org and prints all the items, preceded by a checkbox:
16233 # define the Emacs command to run
16234 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
16236 # run it and capture the output
16237 $agenda = qx@{$cmd 2>/dev/null@};
16239 # loop over all lines
16240 foreach $line (split(/\n/,$agenda)) @{
16241 # get the individual values
16242 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
16243 $priority_l,$priority_n) = split(/,/,$line);
16244 # process and print
16245 print "[ ] $head\n";
16249 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
16250 @section Using the property API
16251 @cindex API, for properties
16252 @cindex properties, API
16254 Here is a description of the functions that can be used to work with
16257 @defun org-entry-properties &optional pom which
16258 Get all properties of the entry at point-or-marker POM.@*
16259 This includes the TODO keyword, the tags, time strings for deadline,
16260 scheduled, and clocking, and any additional properties defined in the
16261 entry. The return value is an alist. Keys may occur multiple times
16262 if the property key was used several times.@*
16263 POM may also be nil, in which case the current entry is used.
16264 If WHICH is nil or `all', get all properties. If WHICH is
16265 `special' or `standard', only get that subclass.
16267 @vindex org-use-property-inheritance
16268 @findex org-insert-property-drawer
16269 @defun org-entry-get pom property &optional inherit
16270 Get value of PROPERTY for entry at point-or-marker POM. By default,
16271 this only looks at properties defined locally in the entry. If INHERIT
16272 is non-nil and the entry does not have the property, then also check
16273 higher levels of the hierarchy. If INHERIT is the symbol
16274 @code{selective}, use inheritance if and only if the setting of
16275 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
16278 @defun org-entry-delete pom property
16279 Delete the property PROPERTY from entry at point-or-marker POM.
16282 @defun org-entry-put pom property value
16283 Set PROPERTY to VALUE for entry at point-or-marker POM.
16286 @defun org-buffer-property-keys &optional include-specials
16287 Get all property keys in the current buffer.
16290 @defun org-insert-property-drawer
16291 Insert a property drawer for the current entry. Also
16294 @defun org-entry-put-multivalued-property pom property &rest values
16295 Set PROPERTY at point-or-marker POM to VALUES. VALUES should be a list of
16296 strings. They will be concatenated, with spaces as separators.
16299 @defun org-entry-get-multivalued-property pom property
16300 Treat the value of the property PROPERTY as a whitespace-separated list of
16301 values and return the values as a list of strings.
16304 @defun org-entry-add-to-multivalued-property pom property value
16305 Treat the value of the property PROPERTY as a whitespace-separated list of
16306 values and make sure that VALUE is in this list.
16309 @defun org-entry-remove-from-multivalued-property pom property value
16310 Treat the value of the property PROPERTY as a whitespace-separated list of
16311 values and make sure that VALUE is @emph{not} in this list.
16314 @defun org-entry-member-in-multivalued-property pom property value
16315 Treat the value of the property PROPERTY as a whitespace-separated list of
16316 values and check if VALUE is in this list.
16319 @defopt org-property-allowed-value-functions
16320 Hook for functions supplying allowed values for a specific property.
16321 The functions must take a single argument, the name of the property, and
16322 return a flat list of allowed values. If @samp{:ETC} is one of
16323 the values, use the values as completion help, but allow also other values
16324 to be entered. The functions must return @code{nil} if they are not
16325 responsible for this property.
16328 @node Using the mapping API, , Using the property API, Hacking
16329 @section Using the mapping API
16330 @cindex API, for mapping
16331 @cindex mapping entries, API
16333 Org has sophisticated mapping capabilities to find all entries satisfying
16334 certain criteria. Internally, this functionality is used to produce agenda
16335 views, but there is also an API that can be used to execute arbitrary
16336 functions for each or selected entries. The main entry point for this API
16339 @defun org-map-entries func &optional match scope &rest skip
16340 Call FUNC at each headline selected by MATCH in SCOPE.
16342 FUNC is a function or a Lisp form. The function will be called without
16343 arguments, with the cursor positioned at the beginning of the headline.
16344 The return values of all calls to the function will be collected and
16345 returned as a list.
16347 The call to FUNC will be wrapped into a save-excursion form, so FUNC
16348 does not need to preserve point. After evaluation, the cursor will be
16349 moved to the end of the line (presumably of the headline of the
16350 processed entry) and search continues from there. Under some
16351 circumstances, this may not produce the wanted results. For example,
16352 if you have removed (e.g.@: archived) the current (sub)tree it could
16353 mean that the next entry will be skipped entirely. In such cases, you
16354 can specify the position from where search should continue by making
16355 FUNC set the variable `org-map-continue-from' to the desired buffer
16358 MATCH is a tags/property/todo match as it is used in the agenda match view.
16359 Only headlines that are matched by this query will be considered during
16360 the iteration. When MATCH is nil or t, all headlines will be
16361 visited by the iteration.
16363 SCOPE determines the scope of this command. It can be any of:
16366 nil @r{the current buffer, respecting the restriction if any}
16367 tree @r{the subtree started with the entry at point}
16368 region @r{The entries within the active region, if any}
16369 file @r{the current buffer, without restriction}
16371 @r{the current buffer, and any archives associated with it}
16372 agenda @r{all agenda files}
16373 agenda-with-archives
16374 @r{all agenda files with any archive files associated with them}
16376 @r{if this is a list, all files in the list will be scanned}
16379 The remaining args are treated as settings for the skipping facilities of
16380 the scanner. The following items can be given here:
16382 @vindex org-agenda-skip-function
16384 archive @r{skip trees with the archive tag}
16385 comment @r{skip trees with the COMMENT keyword}
16386 function or Lisp form
16387 @r{will be used as value for @code{org-agenda-skip-function},}
16388 @r{so whenever the function returns t, FUNC}
16389 @r{will not be called for that entry and search will}
16390 @r{continue from the point where the function leaves it}
16394 The function given to that mapping routine can really do anything you like.
16395 It can use the property API (@pxref{Using the property API}) to gather more
16396 information about the entry, or in order to change metadata in the entry.
16397 Here are a couple of functions that might be handy:
16399 @defun org-todo &optional arg
16400 Change the TODO state of the entry. See the docstring of the functions for
16401 the many possible values for the argument ARG.
16404 @defun org-priority &optional action
16405 Change the priority of the entry. See the docstring of this function for the
16406 possible values for ACTION.
16409 @defun org-toggle-tag tag &optional onoff
16410 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
16411 or @code{off} will not toggle tag, but ensure that it is either on or off.
16415 Promote the current entry.
16419 Demote the current entry.
16422 Here is a simple example that will turn all entries in the current file with
16423 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
16424 Entries in comment trees and in archive trees will be ignored.
16428 '(org-todo "UPCOMING")
16429 "+TOMORROW" 'file 'archive 'comment)
16432 The following example counts the number of entries with TODO keyword
16433 @code{WAITING}, in all agenda files.
16436 (length (org-map-entries t "/+WAITING" 'agenda))
16439 @node MobileOrg, History and Acknowledgments, Hacking, Top
16440 @appendix MobileOrg
16444 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
16445 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
16446 capture support for an Org mode system rooted on a ``real'' computer. It
16447 does also allow you to record changes to existing entries.
16448 The @uref{http://mobileorg.ncogni.to/, iOS implementation} for the
16449 @i{iPhone/iPod Touch/iPad} series of devices, was developed by Richard
16450 Moreland. Android users should check out
16451 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
16452 by Matt Jones. The two implementations are not identical but offer similar
16455 This appendix describes the support Org has for creating agenda views in a
16456 format that can be displayed by @i{MobileOrg}, and for integrating notes
16457 captured and changes made by @i{MobileOrg} into the main system.
16459 For changing tags and TODO states in MobileOrg, you should have set up the
16460 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
16461 cover all important tags and TODO keywords, even if individual files use only
16462 part of these. MobileOrg will also offer you states and tags set up with
16463 in-buffer settings, but it will understand the logistics of TODO state
16464 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
16465 (@pxref{Setting tags}) only for those set in these variables.
16468 * Setting up the staging area:: Where to interact with the mobile device
16469 * Pushing to MobileOrg:: Uploading Org files and agendas
16470 * Pulling from MobileOrg:: Integrating captured and flagged items
16473 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
16474 @section Setting up the staging area
16476 MobileOrg needs to interact with Emacs through a directory on a server. If you
16477 are using a public server, you should consider to encrypt the files that are
16478 uploaded to the server. This can be done with Org mode 7.02 and with
16479 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
16480 installation on your system. To turn on encryption, set a password in
16481 @i{MobileOrg} and, on the Emacs side, configure the variable
16482 @code{org-mobile-use-encryption}@footnote{If you can safely store the
16483 password in your Emacs setup, you might also want to configure
16484 @code{org-mobile-encryption-password}. Please read the docstring of that
16485 variable. Note that encryption will apply only to the contents of the
16486 @file{.org} files. The file names themselves will remain visible.}.
16488 The easiest way to create that directory is to use a free
16489 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
16490 Dropbox, or if your version of MobileOrg does not support it, you can use a
16491 webdav server. For more information, check out the documentation of MobileOrg and also this
16492 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
16493 When MobileOrg first connects to your Dropbox, it will create a directory
16494 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
16498 (setq org-mobile-directory "~/Dropbox/MobileOrg")
16501 Org mode has commands to put files for @i{MobileOrg} into that directory,
16502 and to read captured notes from there.
16504 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
16505 @section Pushing to MobileOrg
16507 This operation copies all files currently listed in @code{org-mobile-files}
16508 to the directory @code{org-mobile-directory}. By default this list contains
16509 all agenda files (as listed in @code{org-agenda-files}), but additional files
16510 can be included by customizing @code{org-mobile-files}. File names will be
16511 staged with paths relative to @code{org-directory}, so all files should be
16512 inside this directory. The push operation also creates a special Org file
16513 @file{agendas.org} with all custom agenda view defined by the
16514 user@footnote{While creating the agendas, Org mode will force ID properties
16515 on all referenced entries, so that these entries can be uniquely identified
16516 if @i{MobileOrg} flags them for further action. If you do not want to get
16517 these properties in so many entries, you can set the variable
16518 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
16519 rely on outline paths, in the hope that these will be unique enough.}.
16520 Finally, Org writes the file @file{index.org}, containing links to all other
16521 files. @i{MobileOrg} first reads this file from the server, and then
16522 downloads all agendas and Org files listed in it. To speed up the download,
16523 MobileOrg will only read files whose checksums@footnote{Checksums are stored
16524 automatically in the file @file{checksums.dat}} have changed.
16526 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
16527 @section Pulling from MobileOrg
16529 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
16530 files for viewing. It also appends captured entries and pointers to flagged
16531 and changed entries to the file @file{mobileorg.org} on the server. Org has
16532 a @emph{pull} operation that integrates this information into an inbox file
16533 and operates on the pointers to flagged entries. Here is how it works:
16537 Org moves all entries found in
16538 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
16539 operation.} and appends them to the file pointed to by the variable
16540 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
16541 will be a top-level entry in the inbox file.
16543 After moving the entries, Org will attempt to implement the changes made in
16544 @i{MobileOrg}. Some changes are applied directly and without user
16545 interaction. Examples are all changes to tags, TODO state, headline and body
16546 text that can be cleanly applied. Entries that have been flagged for further
16547 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
16548 again. When there is a problem finding an entry or applying the change, the
16549 pointer entry will remain in the inbox and will be marked with an error
16550 message. You need to later resolve these issues by hand.
16552 Org will then generate an agenda view with all flagged entries. The user
16553 should then go through these entries and do whatever actions are necessary.
16554 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
16555 will be displayed in the echo area when the cursor is on the corresponding
16560 Pressing @kbd{?} in that special agenda will display the full flagging note in
16561 another window and also push it onto the kill ring. So you could use @kbd{?
16562 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
16563 Pressing @kbd{?} twice in succession will offer to remove the
16564 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
16565 in a property). In this way you indicate that the intended processing for
16566 this flagged entry is finished.
16571 If you are not able to process all flagged entries directly, you can always
16572 return to this agenda view@footnote{Note, however, that there is a subtle
16573 difference. The view created automatically by @kbd{M-x org-mobile-pull
16574 @key{RET}} is guaranteed to search all files that have been addressed by the
16575 last pull. This might include a file that is not currently in your list of
16576 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
16577 the current agenda files will be searched.} using @kbd{C-c a ?}.
16579 @node History and Acknowledgments, Main Index, MobileOrg, Top
16580 @appendix History and acknowledgments
16581 @cindex acknowledgments
16585 Org was born in 2003, out of frustration over the user interface of the Emacs
16586 Outline mode. I was trying to organize my notes and projects, and using
16587 Emacs seemed to be the natural way to go. However, having to remember eleven
16588 different commands with two or three keys per command, only to hide and show
16589 parts of the outline tree, that seemed entirely unacceptable to me. Also,
16590 when using outlines to take notes, I constantly wanted to restructure the
16591 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
16592 cycling} and @emph{structure editing} were originally implemented in the
16593 package @file{outline-magic.el}, but quickly moved to the more general
16594 @file{org.el}. As this environment became comfortable for project planning,
16595 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
16596 @emph{table support}. These areas highlighted the two main goals that Org
16597 still has today: to be a new, outline-based, plain text mode with innovative
16598 and intuitive editing features, and to incorporate project planning
16599 functionality directly into a notes file.
16601 Since the first release, literally thousands of emails to me or to
16602 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
16603 reports, feedback, new ideas, and sometimes patches and add-on code.
16604 Many thanks to everyone who has helped to improve this package. I am
16605 trying to keep here a list of the people who had significant influence
16606 in shaping one or more aspects of Org. The list may not be
16607 complete, if I have forgotten someone, please accept my apologies and
16610 Before I get to this list, a few special mentions are in order:
16613 @item Bastien Guerry
16614 Bastien has written a large number of extensions to Org (most of them
16615 integrated into the core by now), including the @LaTeX{} exporter and the plain
16616 list parser. His support during the early days, when he basically acted as
16617 co-maintainer, was central to the success of this project. Bastien also
16618 invented Worg, helped establishing the Web presence of Org, and sponsored
16619 hosting costs for the orgmode.org website.
16620 @item Eric Schulte and Dan Davison
16621 Eric and Dan are jointly responsible for the Org-babel system, which turns
16622 Org into a multi-language environment for evaluating code and doing literate
16623 programming and reproducible research.
16625 John has contributed a number of great ideas and patches directly to Org,
16626 including the attachment system (@file{org-attach.el}), integration with
16627 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
16628 items, habit tracking (@file{org-habits.el}), and encryption
16629 (@file{org-crypt.el}). Also, the capture system is really an extended copy
16630 of his great @file{remember.el}.
16631 @item Sebastian Rose
16632 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
16633 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
16634 higher level. He also wrote @file{org-info.js}, a Java script for displaying
16635 webpages derived from Org using an Info-like or a folding interface with
16636 single-key navigation.
16639 @noindent OK, now to the full list of contributions! Again, please let me
16640 know what I am missing here!
16645 @i{Russel Adams} came up with the idea for drawers.
16647 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
16649 @i{Christophe Bataillon} created the great unicorn logo that we use on the
16652 @i{Alex Bochannek} provided a patch for rounding timestamps.
16654 @i{Jan Böcker} wrote @file{org-docview.el}.
16656 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
16658 @i{Tom Breton} wrote @file{org-choose.el}.
16660 @i{Charles Cave}'s suggestion sparked the implementation of templates
16661 for Remember, which are now templates for capture.
16663 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
16666 @i{Gregory Chernov} patched support for Lisp forms into table
16667 calculations and improved XEmacs compatibility, in particular by porting
16668 @file{nouline.el} to XEmacs.
16670 @i{Sacha Chua} suggested copying some linking code from Planner.
16672 @i{Baoqiu Cui} contributed the DocBook exporter.
16674 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
16675 came up with the idea of properties, and that there should be an API for
16678 @i{Nick Dokos} tracked down several nasty bugs.
16680 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
16681 inspired some of the early development, including HTML export. He also
16682 asked for a way to narrow wide table columns.
16684 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
16685 the Org-Babel documentation into the manual.
16687 @i{Christian Egli} converted the documentation into Texinfo format, inspired
16688 the agenda, patched CSS formatting into the HTML exporter, and wrote
16689 @file{org-taskjuggler.el}.
16691 @i{David Emery} provided a patch for custom CSS support in exported
16694 @i{Nic Ferrier} contributed mailcap and XOXO support.
16696 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
16698 @i{John Foerch} figured out how to make incremental search show context
16699 around a match in a hidden outline tree.
16701 @i{Raimar Finken} wrote @file{org-git-line.el}.
16703 @i{Mikael Fornius} works as a mailing list moderator.
16705 @i{Austin Frank} works as a mailing list moderator.
16707 @i{Eric Fraga} drove the development of BEAMER export with ideas and
16710 @i{Barry Gidden} did proofreading the manual in preparation for the book
16711 publication through Network Theory Ltd.
16713 @i{Niels Giesen} had the idea to automatically archive DONE trees.
16715 @i{Nicolas Goaziou} rewrote much of the plain list code.
16717 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
16719 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
16722 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
16723 task state change logging, and the clocktable. His clear explanations have
16724 been critical when we started to adopt the Git version control system.
16726 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
16729 @i{Phil Jackson} wrote @file{org-irc.el}.
16731 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
16732 folded entries, and column view for properties.
16734 @i{Matt Jones} wrote @i{MobileOrg Android}.
16736 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
16738 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
16739 provided frequent feedback and some patches.
16741 @i{Matt Lundin} has proposed last-row references for table formulas and named
16742 invisible anchors. He has also worked a lot on the FAQ.
16744 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
16745 and is a prolific contributor on the mailing list with competent replies,
16746 small fixes and patches.
16748 @i{Jason F. McBrayer} suggested agenda export to CSV format.
16750 @i{Max Mikhanosha} came up with the idea of refiling.
16752 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
16755 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
16758 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
16760 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
16761 and being able to quickly restrict the agenda to a subtree.
16763 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
16765 @i{Greg Newman} refreshed the unicorn logo into its current form.
16767 @i{Tim O'Callaghan} suggested in-file links, search options for general
16768 file links, and TAGS.
16770 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
16771 version of the reference card.
16773 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
16776 @i{Oliver Oppitz} suggested multi-state TODO items.
16778 @i{Scott Otterson} sparked the introduction of descriptive text for
16779 links, among other things.
16781 @i{Pete Phillips} helped during the development of the TAGS feature, and
16782 provided frequent feedback.
16784 @i{Martin Pohlack} provided the code snippet to bundle character insertion
16785 into bundles of 20 for undo.
16787 @i{T.V. Raman} reported bugs and suggested improvements.
16789 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
16792 @i{Paul Rivier} provided the basic implementation of named footnotes. He
16793 also acted as mailing list moderator for some time.
16795 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
16797 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
16798 conflict with @file{allout.el}.
16800 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
16803 @i{Philip Rooke} created the Org reference card, provided lots
16804 of feedback, developed and applied standards to the Org documentation.
16806 @i{Christian Schlauer} proposed angular brackets around links, among
16809 @i{Paul Sexton} wrote @file{org-ctags.el}.
16811 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
16812 @file{organizer-mode.el}.
16814 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
16815 examples, and remote highlighting for referenced code lines.
16817 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
16818 now packaged into Org's @file{contrib} directory.
16820 @i{Daniel Sinder} came up with the idea of internal archiving by locking
16823 @i{Dale Smith} proposed link abbreviations.
16825 @i{James TD Smith} has contributed a large number of patches for useful
16826 tweaks and features.
16828 @i{Adam Spiers} asked for global linking commands, inspired the link
16829 extension system, added support for mairix, and proposed the mapping API.
16831 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
16832 @LaTeX{}, UTF-8, Latin-1 and ASCII.
16834 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
16835 with links transformation to Org syntax.
16837 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
16838 chapter about publishing.
16840 @i{Jambunathan K} contributed the ODT exporter.
16842 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
16843 enabled source code highlighting in Gnus.
16845 @i{Stefan Vollmar} organized a video-recorded talk at the
16846 Max-Planck-Institute for Neurology. He also inspired the creation of a
16847 concept index for HTML export.
16849 @i{J@"urgen Vollmer} contributed code generating the table of contents
16852 @i{Samuel Wales} has provided important feedback and bug reports.
16854 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
16857 @i{David Wainberg} suggested archiving, and improvements to the linking
16860 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
16863 @i{Roland Winkler} requested additional key bindings to make Org
16866 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
16867 and contributed various ideas and code snippets.
16871 @node Main Index, Key Index, History and Acknowledgments, Top
16872 @unnumbered Concept index
16876 @node Key Index, Command and Function Index, Main Index, Top
16877 @unnumbered Key index
16881 @node Command and Function Index, Variable Index, Key Index, Top
16882 @unnumbered Command and function index
16886 @node Variable Index, , Command and Function Index, Top
16887 @unnumbered Variable index
16889 This is not a complete index of variables and faces, only the ones that are
16890 mentioned in the manual. For a more complete list, use @kbd{M-x
16891 org-customize @key{RET}} and then click yourself through the tree.
16897 @c Local variables:
16899 @c indent-tabs-mode: nil
16900 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
16901 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
16905 @c LocalWords: webdavhost pre