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 Bastien Guerry
17 @set MAINTAINEREMAIL @email{bzg at gnu dot org}
18 @set MAINTAINERCONTACT @uref{mailto:bzg at gnu 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--2013 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.''
281 @dircategory Emacs editing modes
283 * Org Mode: (org). Outline-based notes management and organizer
287 @title The Org Manual
289 @subtitle Release @value{VERSION}
290 @author by Carsten Dominik
291 with contributions by David O'Toole, Bastien Guerry, Philip Rooke, Dan Davison, Eric Schulte, Thomas Dye and Jambunathan K.
293 @c The following two commands start the copyright page.
295 @vskip 0pt plus 1filll
299 @c Output the table of contents at the beginning.
303 @c FIXME These hand-written next,prev,up node pointers make editing a lot
304 @c harder. There should be no need for them, makeinfo can do it
305 @c automatically for any document with a normal structure.
306 @node Top, Introduction, (dir), (dir)
313 * Introduction:: Getting started
314 * Document Structure:: A tree works like your brain
315 * Tables:: Pure magic for quick formatting
316 * Hyperlinks:: Notes in context
317 * TODO Items:: Every tree branch can be a TODO item
318 * Tags:: Tagging headlines and matching sets of tags
319 * Properties and Columns:: Storing information about an entry
320 * Dates and Times:: Making items useful for planning
321 * Capture - Refile - Archive:: The ins and outs for projects
322 * Agenda Views:: Collecting information into views
323 * Markup:: Prepare text for rich export
324 * Exporting:: Sharing and publishing of notes
325 * Publishing:: Create a web site of linked Org files
326 * Working With Source Code:: Export, evaluate, and tangle code blocks
327 * Miscellaneous:: All the rest which did not fit elsewhere
328 * Hacking:: How to hack your way around
329 * MobileOrg:: Viewing and capture on a mobile device
330 * History and Acknowledgments:: How Org came into being
331 * GNU Free Documentation License:: The license for this documentation.
332 * Main Index:: An index of Org's concepts and features
333 * Key Index:: Key bindings and where they are described
334 * Command and Function Index:: Command names and some internal functions
335 * Variable Index:: Variables mentioned in the manual
338 --- The Detailed Node Listing ---
342 * Summary:: Brief summary of what Org does
343 * Installation:: Installing Org
344 * Activation:: How to activate Org for certain buffers
345 * Feedback:: Bug reports, ideas, patches etc.
346 * Conventions:: Typesetting conventions in the manual
350 * Outlines:: Org is based on Outline mode
351 * Headlines:: How to typeset Org tree headlines
352 * Visibility cycling:: Show and hide, much simplified
353 * Motion:: Jumping to other headlines
354 * Structure editing:: Changing sequence and level of headlines
355 * Sparse trees:: Matches embedded in context
356 * Plain lists:: Additional structure within an entry
357 * Drawers:: Tucking stuff away
358 * Blocks:: Folding blocks
359 * Footnotes:: How footnotes are defined in Org's syntax
360 * Orgstruct mode:: Structure editing outside Org
364 * Built-in table editor:: Simple tables
365 * Column width and alignment:: Overrule the automatic settings
366 * Column groups:: Grouping to trigger vertical lines
367 * Orgtbl mode:: The table editor as minor mode
368 * The spreadsheet:: The table editor has spreadsheet capabilities
369 * Org-Plot:: Plotting from org tables
373 * References:: How to refer to another field or range
374 * Formula syntax for Calc:: Using Calc to compute stuff
375 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
376 * Durations and time values:: How to compute durations and time values
377 * Field and range formulas:: Formula for specific (ranges of) fields
378 * Column formulas:: Formulas valid for an entire column
379 * Lookup functions:: Lookup functions for searching tables
380 * Editing and debugging formulas:: Fixing formulas
381 * Updating the table:: Recomputing all dependent fields
382 * Advanced features:: Field and column names, parameters and automatic recalc
386 * Link format:: How links in Org are formatted
387 * Internal links:: Links to other places in the current file
388 * External links:: URL-like links to the world
389 * Handling links:: Creating, inserting and following
390 * Using links outside Org:: Linking from my C source code?
391 * Link abbreviations:: Shortcuts for writing complex links
392 * Search options:: Linking to a specific location
393 * Custom searches:: When the default search is not enough
397 * Radio targets:: Make targets trigger links in plain text
401 * TODO basics:: Marking and displaying TODO entries
402 * TODO extensions:: Workflow and assignments
403 * Progress logging:: Dates and notes for progress
404 * Priorities:: Some things are more important than others
405 * Breaking down tasks:: Splitting a task into manageable pieces
406 * Checkboxes:: Tick-off lists
408 Extended use of TODO keywords
410 * Workflow states:: From TODO to DONE in steps
411 * TODO types:: I do this, Fred does the rest
412 * Multiple sets in one file:: Mixing it all, and still finding your way
413 * Fast access to TODO states:: Single letter selection of a state
414 * Per-file keywords:: Different files, different requirements
415 * Faces for TODO keywords:: Highlighting states
416 * TODO dependencies:: When one task needs to wait for others
420 * Closing items:: When was this entry marked DONE?
421 * Tracking TODO state changes:: When did the status change?
422 * Tracking your habits:: How consistent have you been?
426 * Tag inheritance:: Tags use the tree structure of the outline
427 * Setting tags:: How to assign tags to a headline
428 * Tag searches:: Searching for combinations of tags
430 Properties and columns
432 * Property syntax:: How properties are spelled out
433 * Special properties:: Access to other Org mode features
434 * Property searches:: Matching property values
435 * Property inheritance:: Passing values down the tree
436 * Column view:: Tabular viewing and editing
437 * Property API:: Properties for Lisp programmers
441 * Defining columns:: The COLUMNS format property
442 * Using column view:: How to create and use column view
443 * Capturing column view:: A dynamic block for column view
447 * Scope of column definitions:: Where defined, where valid?
448 * Column attributes:: Appearance and content of a column
452 * Timestamps:: Assigning a time to a tree entry
453 * Creating timestamps:: Commands which insert timestamps
454 * Deadlines and scheduling:: Planning your work
455 * Clocking work time:: Tracking how long you spend on a task
456 * Effort estimates:: Planning work effort in advance
457 * Relative timer:: Notes with a running timer
458 * Countdown timer:: Starting a countdown timer for a task
462 * The date/time prompt:: How Org mode helps you entering date and time
463 * Custom time format:: Making dates look different
465 Deadlines and scheduling
467 * Inserting deadline/schedule:: Planning items
468 * Repeated tasks:: Items that show up again and again
472 * Clocking commands:: Starting and stopping a clock
473 * The clock table:: Detailed reports
474 * Resolving idle time:: Resolving time when you've been idle
476 Capture - Refile - Archive
478 * Capture:: Capturing new stuff
479 * Attachments:: Add files to tasks
480 * RSS Feeds:: Getting input from RSS feeds
481 * Protocols:: External (e.g., Browser) access to Emacs and Org
482 * Refile and copy:: Moving/copying a tree from one place to another
483 * Archiving:: What to do with finished projects
487 * Setting up capture:: Where notes will be stored
488 * Using capture:: Commands to invoke and terminate capture
489 * Capture templates:: Define the outline of different note types
493 * Template elements:: What is needed for a complete template entry
494 * Template expansion:: Filling in information about time and context
495 * Templates in contexts:: Only show a template in a specific context
499 * Moving subtrees:: Moving a tree to an archive file
500 * Internal archiving:: Switch off a tree but keep it in the file
504 * Agenda files:: Files being searched for agenda information
505 * Agenda dispatcher:: Keyboard access to agenda views
506 * Built-in agenda views:: What is available out of the box?
507 * Presentation and sorting:: How agenda items are prepared for display
508 * Agenda commands:: Remote editing of Org trees
509 * Custom agenda views:: Defining special searches and views
510 * Exporting Agenda Views:: Writing a view to a file
511 * Agenda column view:: Using column view for collected entries
513 The built-in agenda views
515 * Weekly/daily agenda:: The calendar page with current tasks
516 * Global TODO list:: All unfinished action items
517 * Matching tags and properties:: Structured information with fine-tuned search
518 * Timeline:: Time-sorted view for single file
519 * Search view:: Find entries by searching for text
520 * Stuck projects:: Find projects you need to review
522 Presentation and sorting
524 * Categories:: Not all tasks are equal
525 * Time-of-day specifications:: How the agenda knows the time
526 * Sorting of agenda items:: The order of things
530 * Storing searches:: Type once, use often
531 * Block agenda:: All the stuff you need in a single buffer
532 * Setting Options:: Changing the rules
534 Markup for rich export
536 * Structural markup elements:: The basic structure as seen by the exporter
537 * Images and tables:: Tables and Images will be included
538 * Literal examples:: Source code examples with special formatting
539 * Include files:: Include additional files into a document
540 * Index entries:: Making an index
541 * Macro replacement:: Use macros to create complex output
542 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
544 Structural markup elements
546 * Document title:: Where the title is taken from
547 * Headings and sections:: The document structure as seen by the exporter
548 * Table of contents:: The if and where of the table of contents
549 * Initial text:: Text before the first heading?
551 * Paragraphs:: Paragraphs
552 * Footnote markup:: Footnotes
553 * Emphasis and monospace:: Bold, italic, etc.
554 * Horizontal rules:: Make a line
555 * Comment lines:: What will *not* be exported
559 * Special symbols:: Greek letters and other symbols
560 * Subscripts and superscripts:: Simple syntax for raising/lowering text
561 * @LaTeX{} fragments:: Complex formulas made easy
562 * Previewing @LaTeX{} fragments:: What will this snippet look like?
563 * CDLaTeX mode:: Speed up entering of formulas
567 * Selective export:: Using tags to select and exclude trees
568 * Export options:: Per-file export settings
569 * The export dispatcher:: How to access exporter commands
570 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
571 * HTML export:: Exporting to HTML
572 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
573 * OpenDocument Text export:: Exporting to OpenDocument Text
574 * Freemind export:: Exporting to Freemind mind maps
575 * XOXO export:: Exporting to XOXO
576 * iCalendar export:: Exporting in iCalendar format
580 * HTML Export commands:: How to invoke HTML export
581 * HTML preamble and postamble:: How to insert a preamble and a postamble
582 * Quoting HTML tags:: Using direct HTML in Org mode
583 * Links in HTML export:: How links will be interpreted and formatted
584 * Tables in HTML export:: How to modify the formatting of tables
585 * Images in HTML export:: How to insert figures into HTML output
586 * Math formatting in HTML export:: Beautiful math also on the web
587 * Text areas in HTML export:: An alternative way to show an example
588 * CSS support:: Changing the appearance of the output
589 * JavaScript support:: Info and Folding in a web browser
591 @LaTeX{} and PDF export
593 * @LaTeX{}/PDF export commands::
594 * Header and sectioning:: Setting up the export file structure
595 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
596 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
597 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
598 * Beamer class export:: Turning the file into a presentation
600 OpenDocument Text export
602 * Pre-requisites for ODT export:: What packages ODT exporter relies on
603 * ODT export commands:: How to invoke ODT export
604 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
605 * Applying custom styles:: How to apply custom styles to the output
606 * Links in ODT export:: How links will be interpreted and formatted
607 * Tables in ODT export:: How Tables are exported
608 * Images in ODT export:: How to insert images
609 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
610 * Labels and captions in ODT export:: How captions are rendered
611 * Literal examples in ODT export:: How source and example blocks are formatted
612 * Advanced topics in ODT export:: Read this if you are a power user
614 Math formatting in ODT export
616 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
617 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
619 Advanced topics in ODT export
621 * Configuring a document converter:: How to register a document converter
622 * Working with OpenDocument style files:: Explore the internals
623 * Creating one-off styles:: How to produce custom highlighting etc
624 * Customizing tables in ODT export:: How to define and use Table templates
625 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
629 * Configuration:: Defining projects
630 * Uploading files:: How to get files up on the server
631 * Sample configuration:: Example projects
632 * Triggering publication:: Publication commands
636 * Project alist:: The central configuration variable
637 * Sources and destinations:: From here to there
638 * Selecting files:: What files are part of the project?
639 * Publishing action:: Setting the function doing the publishing
640 * Publishing options:: Tweaking HTML/@LaTeX{} export
641 * Publishing links:: Which links keep working after publishing?
642 * Sitemap:: Generating a list of all pages
643 * Generating an index:: An index that reaches across pages
647 * Simple example:: One-component publishing
648 * Complex example:: A multi-component publishing example
650 Working with source code
652 * Structure of code blocks:: Code block syntax described
653 * Editing source code:: Language major-mode editing
654 * Exporting code blocks:: Export contents and/or results
655 * Extracting source code:: Create pure source code files
656 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
657 * Library of Babel:: Use and contribute to a library of useful code blocks
658 * Languages:: List of supported code block languages
659 * Header arguments:: Configure code block functionality
660 * Results of evaluation:: How evaluation results are handled
661 * Noweb reference syntax:: Literate programming in Org mode
662 * Key bindings and useful functions:: Work quickly with code blocks
663 * Batch execution:: Call functions from the command line
667 * Using header arguments:: Different ways to set header arguments
668 * Specific header arguments:: List of header arguments
670 Using header arguments
672 * System-wide header arguments:: Set global default values
673 * Language-specific header arguments:: Set default values by language
674 * Buffer-wide header arguments:: Set default values for a specific buffer
675 * Header arguments in Org mode properties:: Set default values for a buffer or heading
676 * Code block specific header arguments:: The most common way to set values
677 * Header arguments in function calls:: The most specific level
679 Specific header arguments
681 * var:: Pass arguments to code blocks
682 * results:: Specify the type of results and how they will
683 be collected and handled
684 * file:: Specify a path for file output
685 * file-desc:: Specify a description for file results
686 * dir:: Specify the default (possibly remote)
687 directory for code block execution
688 * exports:: Export code and/or results
689 * tangle:: Toggle tangling and specify file name
690 * mkdirp:: Toggle creation of parent directories of target
691 files during tangling
692 * comments:: Toggle insertion of comments in tangled
694 * padline:: Control insertion of padding lines in tangled
696 * no-expand:: Turn off variable assignment and noweb
697 expansion during tangling
698 * session:: Preserve the state of code evaluation
699 * noweb:: Toggle expansion of noweb references
700 * noweb-ref:: Specify block's noweb reference resolution target
701 * noweb-sep:: String used to separate noweb references
702 * cache:: Avoid re-evaluating unchanged code blocks
703 * sep:: Delimiter for writing tabular results outside Org
704 * hlines:: Handle horizontal lines in tables
705 * colnames:: Handle column names in tables
706 * rownames:: Handle row names in tables
707 * shebang:: Make tangled files executable
708 * eval:: Limit evaluation of specific code blocks
709 * wrap:: Mark source block evaluation results
713 * Completion:: M-TAB knows what you need
714 * Easy Templates:: Quick insertion of structural elements
715 * Speed keys:: Electric commands at the beginning of a headline
716 * Code evaluation security:: Org mode files evaluate inline code
717 * Customization:: Adapting Org to your taste
718 * In-buffer settings:: Overview of the #+KEYWORDS
719 * The very busy C-c C-c key:: When in doubt, press C-c C-c
720 * Clean view:: Getting rid of leading stars in the outline
721 * TTY keys:: Using Org on a tty
722 * Interaction:: Other Emacs packages
723 * org-crypt.el:: Encrypting Org files
725 Interaction with other packages
727 * Cooperation:: Packages Org cooperates with
728 * Conflicts:: Packages that lead to conflicts
732 * Hooks:: How to reach into Org's internals
733 * Add-on packages:: Available extensions
734 * Adding hyperlink types:: New custom link types
735 * Context-sensitive commands:: How to add functionality to such commands
736 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
737 * Dynamic blocks:: Automatically filled blocks
738 * Special agenda views:: Customized views
739 * Extracting agenda information:: Postprocessing of agenda information
740 * Using the property API:: Writing programs that use entry properties
741 * Using the mapping API:: Mapping over all or selected entries
743 Tables and lists in arbitrary syntax
745 * Radio tables:: Sending and receiving radio tables
746 * A @LaTeX{} example:: Step by step, almost a tutorial
747 * Translator functions:: Copy and modify
748 * Radio lists:: Doing the same for lists
752 * Setting up the staging area:: Where to interact with the mobile device
753 * Pushing to MobileOrg:: Uploading Org files and agendas
754 * Pulling from MobileOrg:: Integrating captured and flagged items
759 @node Introduction, Document Structure, Top, Top
760 @chapter Introduction
764 * Summary:: Brief summary of what Org does
765 * Installation:: Installing Org
766 * Activation:: How to activate Org for certain buffers
767 * Feedback:: Bug reports, ideas, patches etc.
768 * Conventions:: Typesetting conventions in the manual
771 @node Summary, Installation, Introduction, Introduction
775 Org is a mode for keeping notes, maintaining TODO lists, and doing
776 project planning with a fast and effective plain-text system.
778 Org develops organizational tasks around NOTES files that contain
779 lists or information about projects as plain text. Org is
780 implemented on top of Outline mode, which makes it possible to keep the
781 content of large files well structured. Visibility cycling and
782 structure editing help to work with the tree. Tables are easily created
783 with a built-in table editor. Org supports TODO items, deadlines,
784 timestamps, and scheduling. It dynamically compiles entries into an
785 agenda that utilizes and smoothly integrates much of the Emacs calendar
786 and diary. Plain text URL-like links connect to websites, emails,
787 Usenet messages, BBDB entries, and any files related to the projects.
788 For printing and sharing of notes, an Org file can be exported as a
789 structured ASCII file, as HTML, or (TODO and agenda items only) as an
790 iCalendar file. It can also serve as a publishing tool for a set of
793 As a project planning environment, Org works by adding metadata to outline
794 nodes. Based on this data, specific entries can be extracted in queries and
795 create dynamic @i{agenda views}.
797 Org mode contains the Org Babel environment which allows you to work with
798 embedded source code blocks in a file, to facilitate code evaluation,
799 documentation, and literate programming techniques.
801 Org's automatic, context-sensitive table editor with spreadsheet
802 capabilities can be integrated into any major mode by activating the
803 minor Orgtbl mode. Using a translation step, it can be used to maintain
804 tables in arbitrary file types, for example in @LaTeX{}. The structure
805 editing and list creation capabilities can be used outside Org with
806 the minor Orgstruct mode.
808 Org keeps simple things simple. When first fired up, it should
809 feel like a straightforward, easy to use outliner. Complexity is not
810 imposed, but a large amount of functionality is available when you need
811 it. Org is a toolbox and can be used in different ways and for different
815 @r{@bullet{} an outline extension with visibility cycling and structure editing}
816 @r{@bullet{} an ASCII system and table editor for taking structured notes}
817 @r{@bullet{} a TODO list editor}
818 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
819 @pindex GTD, Getting Things Done
820 @r{@bullet{} an environment in which to implement David Allen's GTD system}
821 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
822 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
823 @r{@bullet{} an environment for literate programming}
827 There is a website for Org which provides links to the newest
828 version of Org, as well as additional information, frequently asked
829 questions (FAQ), links to tutorials, etc. This page is located at
830 @uref{http://orgmode.org}.
832 @cindex print edition
833 The version 7.3 of this manual is available as a
834 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
840 @node Installation, Activation, Summary, Introduction
841 @section Installation
845 Org is part of recent distributions of GNU Emacs, so you normally don't need
846 to install it. If, for one reason or another, you want to install Org on top
847 of this pre-packaged version, there are three ways to do it:
850 @item By using Emacs package system.
851 @item By downloading Org as an archive.
852 @item By using Org's git repository.
855 We @b{strongly recommend} to stick to a single installation method.
857 @subsubheading Using Emacs packaging system
859 Recent Emacs distributions include a packaging system which lets you install
860 Elisp libraries. You can install Org with @kbd{M-x package-install RET org}.
861 To make sure your Org configuration is well taken into account, initialize
862 the package system with @code{(package-initialize)} before setting any Org
863 option. If you want to use Org's package repository, check out the
864 @uref{http://orgmode.org/elpa.html, Org ELPA page}.
866 @subsubheading Downloading Org as an archive
868 You can download Org latest release from @uref{http://orgmode.org/, Org's
869 website}. In this case, make sure you set the load-path correctly in your
873 (add-to-list 'load-path "~/path/to/orgdir/lisp")
876 The downloaded archive contains contributed libraries that are not included
877 in Emacs. If you want to use them, add the @file{contrib} directory to your
881 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
884 Optionally, you can compile the files and/or install them in your system.
885 Run @code{make help} to list compilation and installation options.
887 @subsubheading Using Org's git repository
889 You can clone Org's repository and install Org like this:
893 $ git clone git://orgmode.org/org-mode.git
897 Note that in this case, @code{make autoloads} is mandatory: it defines Org's
898 version in @file{org-version.el} and Org's autoloads in
899 @file{org-loaddefs.el}.
901 Remember to add the correct load-path as described in the method above.
903 You can also compile with @code{make}, generate the documentation with
904 @code{make doc}, create a local configuration with @code{make config} and
905 install Org with @code{make install}. Please run @code{make help} to get
906 the list of compilation/installation options.
908 For more detailed explanations on Org's build system, please check the Org
909 Build System page on @uref{http://orgmode.org/worg/dev/org-build-system.html,
912 @node Activation, Feedback, Installation, Introduction
917 @cindex global key bindings
918 @cindex key bindings, global
921 @findex org-store-link
924 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
925 default. If you are using an earlier version of Emacs, add this line to your
929 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
932 Org mode buffers need font-lock to be turned on: this is the default in
933 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
934 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
936 There are compatibility issues between Org mode and some other Elisp
937 packages, please take the time to check the list (@pxref{Conflicts}).
939 The four Org commands @command{org-store-link}, @command{org-capture},
940 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
941 global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
942 suggested bindings for these keys, please modify the keys to your own
945 (global-set-key "\C-cl" 'org-store-link)
946 (global-set-key "\C-cc" 'org-capture)
947 (global-set-key "\C-ca" 'org-agenda)
948 (global-set-key "\C-cb" 'org-iswitchb)
951 @cindex Org mode, turning on
952 With this setup, all files with extension @samp{.org} will be put
953 into Org mode. As an alternative, make the first line of a file look
957 MY PROJECTS -*- mode: org; -*-
960 @vindex org-insert-mode-line-in-empty-file
961 @noindent which will select Org mode for this buffer no matter what
962 the file's name is. See also the variable
963 @code{org-insert-mode-line-in-empty-file}.
965 Many commands in Org work on the region if the region is @i{active}. To make
966 use of this, you need to have @code{transient-mark-mode}
967 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
968 in Emacs 22 you need to do this yourself with
970 (transient-mark-mode 1)
972 @noindent If you do not like @code{transient-mark-mode}, you can create an
973 active region by using the mouse to select a region, or pressing
974 @kbd{C-@key{SPC}} twice before moving the cursor.
976 @node Feedback, Conventions, Activation, Introduction
983 If you find problems with Org, or if you have questions, remarks, or ideas
984 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
985 If you are not a member of the mailing list, your mail will be passed to the
986 list after a moderator has approved it@footnote{Please consider subscribing
987 to the mailing list, in order to minimize the work the mailing list
988 moderators have to do.}.
990 For bug reports, please first try to reproduce the bug with the latest
991 version of Org available---if you are running an outdated version, it is
992 quite possible that the bug has been fixed already. If the bug persists,
993 prepare a report and provide as much information as possible, including the
994 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
995 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
996 @file{.emacs}. The easiest way to do this is to use the command
998 @kbd{M-x org-submit-bug-report}
1000 @noindent which will put all this information into an Emacs mail buffer so
1001 that you only need to add your description. If you re not sending the Email
1002 from within Emacs, please copy and paste the content into your Email program.
1004 Sometimes you might face a problem due to an error in your Emacs or Org mode
1005 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1006 customizations and reproduce the problem. Doing so often helps you determine
1007 if the problem is with your customization or with Org mode itself. You can
1008 start a typical minimal session with a command like the example below.
1011 $ emacs -Q -l /path/to/minimal-org.el
1014 However if you are using Org mode as distributed with Emacs, a minimal setup
1015 is not necessary. In that case it is sufficient to start Emacs as
1016 @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
1020 ;;; Minimal setup to load latest `org-mode'
1022 ;; activate debugging
1023 (setq debug-on-error t
1027 ;; add latest org-mode to load path
1028 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1029 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1032 If an error occurs, a backtrace can be very useful (see below on how to
1033 create one). Often a small example file helps, along with clear information
1037 @item What exactly did you do?
1038 @item What did you expect to happen?
1039 @item What happened instead?
1041 @noindent Thank you for helping to improve this program.
1043 @subsubheading How to create a useful backtrace
1045 @cindex backtrace of an error
1046 If working with Org produces an error with a message you don't
1047 understand, you may have hit a bug. The best way to report this is by
1048 providing, in addition to what was mentioned above, a @emph{backtrace}.
1049 This is information from the built-in debugger about where and how the
1050 error occurred. Here is how to produce a useful backtrace:
1054 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1055 contains much more information if it is produced with uncompiled code.
1058 C-u M-x org-reload RET
1061 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1064 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1065 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1067 Do whatever you have to do to hit the error. Don't forget to
1068 document the steps you take.
1070 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1071 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1072 attach it to your bug report.
1075 @node Conventions, , Feedback, Introduction
1076 @section Typesetting conventions used in this manual
1078 @subsubheading TODO keywords, tags, properties, etc.
1080 Org mainly uses three types of keywords: TODO keywords, tags and property
1081 names. In this manual we use the following conventions:
1086 TODO keywords are written with all capitals, even if they are
1090 User-defined tags are written in lowercase; built-in tags with special
1091 meaning are written with all capitals.
1094 User-defined properties are capitalized; built-in properties with
1095 special meaning are written with all capitals.
1098 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1099 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1100 environment). They are written in uppercase in the manual to enhance its
1101 readability, but you can use lowercase in your Org files@footnote{Easy
1102 templates insert lowercase keywords and Babel dynamically inserts
1105 @subsubheading Keybindings and commands
1111 The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda}
1112 and @kbd{C-c c} for @code{org-capture}. These are only suggestions, but the
1113 rest of the manual assumes that you are using these keybindings.
1115 Also, the manual lists both the keys and the corresponding commands for
1116 accessing a functionality. Org mode often uses the same key for different
1117 functions, depending on context. The command that is bound to such keys has
1118 a generic name, like @code{org-metaright}. In the manual we will, wherever
1119 possible, give the function that is internally called by the generic command.
1120 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1121 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1122 will be listed to call @code{org-table-move-column-right}. If you prefer,
1123 you can compile the manual without the command names by unsetting the flag
1124 @code{cmdnames} in @file{org.texi}.
1126 @node Document Structure, Tables, Introduction, Top
1127 @chapter Document structure
1128 @cindex document structure
1129 @cindex structure of document
1131 Org is based on Outline mode and provides flexible commands to
1132 edit the structure of the document.
1135 * Outlines:: Org is based on Outline mode
1136 * Headlines:: How to typeset Org tree headlines
1137 * Visibility cycling:: Show and hide, much simplified
1138 * Motion:: Jumping to other headlines
1139 * Structure editing:: Changing sequence and level of headlines
1140 * Sparse trees:: Matches embedded in context
1141 * Plain lists:: Additional structure within an entry
1142 * Drawers:: Tucking stuff away
1143 * Blocks:: Folding blocks
1144 * Footnotes:: How footnotes are defined in Org's syntax
1145 * Orgstruct mode:: Structure editing outside Org
1148 @node Outlines, Headlines, Document Structure, Document Structure
1151 @cindex Outline mode
1153 Org is implemented on top of Outline mode. Outlines allow a
1154 document to be organized in a hierarchical structure, which (at least
1155 for me) is the best representation of notes and thoughts. An overview
1156 of this structure is achieved by folding (hiding) large parts of the
1157 document to show only the general document structure and the parts
1158 currently being worked on. Org greatly simplifies the use of
1159 outlines by compressing the entire show/hide functionality into a single
1160 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1162 @node Headlines, Visibility cycling, Outlines, Document Structure
1165 @cindex outline tree
1166 @vindex org-special-ctrl-a/e
1167 @vindex org-special-ctrl-k
1168 @vindex org-ctrl-k-protect-subtree
1170 Headlines define the structure of an outline tree. The headlines in Org
1171 start with one or more stars, on the left margin@footnote{See the variables
1172 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1173 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1174 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1175 headings indented less then 30 stars.}. For example:
1178 * Top level headline
1185 * Another top level headline
1188 @noindent Some people find the many stars too noisy and would prefer an
1189 outline that has whitespace followed by a single star as headline
1190 starters. @ref{Clean view}, describes a setup to realize this.
1192 @vindex org-cycle-separator-lines
1193 An empty line after the end of a subtree is considered part of it and
1194 will be hidden when the subtree is folded. However, if you leave at
1195 least two empty lines, one empty line will remain visible after folding
1196 the subtree, in order to structure the collapsed view. See the
1197 variable @code{org-cycle-separator-lines} to modify this behavior.
1199 @node Visibility cycling, Motion, Headlines, Document Structure
1200 @section Visibility cycling
1201 @cindex cycling, visibility
1202 @cindex visibility cycling
1203 @cindex trees, visibility
1204 @cindex show hidden text
1207 Outlines make it possible to hide parts of the text in the buffer.
1208 Org uses just two commands, bound to @key{TAB} and
1209 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1211 @cindex subtree visibility states
1212 @cindex subtree cycling
1213 @cindex folded, subtree visibility state
1214 @cindex children, subtree visibility state
1215 @cindex subtree, subtree visibility state
1217 @orgcmd{@key{TAB},org-cycle}
1218 @emph{Subtree cycling}: Rotate current subtree among the states
1221 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1222 '-----------------------------------'
1225 @vindex org-cycle-emulate-tab
1226 @vindex org-cycle-global-at-bob
1227 The cursor must be on a headline for this to work@footnote{see, however,
1228 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1229 beginning of the buffer and the first line is not a headline, then
1230 @key{TAB} actually runs global cycling (see below)@footnote{see the
1231 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1232 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1234 @cindex global visibility states
1235 @cindex global cycling
1236 @cindex overview, global visibility state
1237 @cindex contents, global visibility state
1238 @cindex show all, global visibility state
1239 @orgcmd{S-@key{TAB},org-global-cycle}
1240 @itemx C-u @key{TAB}
1241 @emph{Global cycling}: Rotate the entire buffer among the states
1244 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1245 '--------------------------------------'
1248 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1249 CONTENTS view up to headlines of level N will be shown. Note that inside
1250 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1252 @cindex show all, command
1253 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1254 Show all, including drawers.
1255 @cindex revealing context
1256 @orgcmd{C-c C-r,org-reveal}
1257 Reveal context around point, showing the current entry, the following heading
1258 and the hierarchy above. Useful for working near a location that has been
1259 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1260 (@pxref{Agenda commands}). With a prefix argument show, on each
1261 level, all sibling headings. With a double prefix argument, also show the
1262 entire subtree of the parent.
1263 @cindex show branches, command
1264 @orgcmd{C-c C-k,show-branches}
1265 Expose all the headings of the subtree, CONTENT view for just one subtree.
1266 @cindex show children, command
1267 @orgcmd{C-c @key{TAB},show-children}
1268 Expose all direct children of the subtree. With a numeric prefix argument N,
1269 expose all children down to level N@.
1270 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1271 Show the current subtree in an indirect buffer@footnote{The indirect
1274 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1277 (see the Emacs manual for more information about indirect buffers)
1279 will contain the entire buffer, but will be narrowed to the current
1280 tree. Editing the indirect buffer will also change the original buffer,
1281 but without affecting visibility in that buffer.}. With a numeric
1282 prefix argument N, go up to level N and then take that tree. If N is
1283 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1284 the previously used indirect buffer.
1285 @orgcmd{C-c C-x v,org-copy-visible}
1286 Copy the @i{visible} text in the region into the kill ring.
1289 @vindex org-startup-folded
1290 @vindex org-agenda-inhibit-startup
1291 @cindex @code{overview}, STARTUP keyword
1292 @cindex @code{content}, STARTUP keyword
1293 @cindex @code{showall}, STARTUP keyword
1294 @cindex @code{showeverything}, STARTUP keyword
1296 When Emacs first visits an Org file, the global state is set to
1297 OVERVIEW, i.e., only the top level headlines are visible. This can be
1298 configured through the variable @code{org-startup-folded}, or on a
1299 per-file basis by adding one of the following lines anywhere in the
1306 #+STARTUP: showeverything
1309 The startup visibility options are ignored when the file is open for the
1310 first time during the agenda generation: if you want the agenda to honor
1311 the startup visibility, set @code{org-agenda-inhibit-startup} to nil.
1313 @cindex property, VISIBILITY
1315 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1316 and Columns}) will get their visibility adapted accordingly. Allowed values
1317 for this property are @code{folded}, @code{children}, @code{content}, and
1320 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1321 Switch back to the startup visibility of the buffer, i.e., whatever is
1322 requested by startup options and @samp{VISIBILITY} properties in individual
1326 @node Motion, Structure editing, Visibility cycling, Document Structure
1328 @cindex motion, between headlines
1329 @cindex jumping, to headlines
1330 @cindex headline navigation
1331 The following commands jump to other headlines in the buffer.
1334 @orgcmd{C-c C-n,outline-next-visible-heading}
1336 @orgcmd{C-c C-p,outline-previous-visible-heading}
1338 @orgcmd{C-c C-f,org-forward-same-level}
1339 Next heading same level.
1340 @orgcmd{C-c C-b,org-backward-same-level}
1341 Previous heading same level.
1342 @orgcmd{C-c C-u,outline-up-heading}
1343 Backward to higher level heading.
1344 @orgcmd{C-c C-j,org-goto}
1345 Jump to a different place without changing the current outline
1346 visibility. Shows the document structure in a temporary buffer, where
1347 you can use the following keys to find your destination:
1348 @vindex org-goto-auto-isearch
1350 @key{TAB} @r{Cycle visibility.}
1351 @key{down} / @key{up} @r{Next/previous visible headline.}
1352 @key{RET} @r{Select this location.}
1353 @kbd{/} @r{Do a Sparse-tree search}
1354 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1355 n / p @r{Next/previous visible headline.}
1356 f / b @r{Next/previous headline same level.}
1358 0-9 @r{Digit argument.}
1361 @vindex org-goto-interface
1363 See also the variable @code{org-goto-interface}.
1366 @node Structure editing, Sparse trees, Motion, Document Structure
1367 @section Structure editing
1368 @cindex structure editing
1369 @cindex headline, promotion and demotion
1370 @cindex promotion, of subtrees
1371 @cindex demotion, of subtrees
1372 @cindex subtree, cut and paste
1373 @cindex pasting, of subtrees
1374 @cindex cutting, of subtrees
1375 @cindex copying, of subtrees
1376 @cindex sorting, of subtrees
1377 @cindex subtrees, cut and paste
1380 @orgcmd{M-@key{RET},org-insert-heading}
1381 @vindex org-M-RET-may-split-line
1382 Insert new heading with same level as current. If the cursor is in a plain
1383 list item, a new item is created (@pxref{Plain lists}). To force creation of
1384 a new headline, use a prefix argument. When this command is used in the
1385 middle of a line, the line is split and the rest of the line becomes the new
1386 headline@footnote{If you do not want the line to be split, customize the
1387 variable @code{org-M-RET-may-split-line}.}. If the command is used at the
1388 beginning of a headline, the new headline is created before the current line.
1389 If at the beginning of any other line, the content of that line is made the
1390 new heading. If the command is used at the end of a folded subtree (i.e.,
1391 behind the ellipses at the end of a headline), then a headline like the
1392 current one will be inserted after the end of the subtree.
1393 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1394 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1395 current heading, the new heading is placed after the body instead of before
1396 it. This command works from anywhere in the entry.
1397 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1398 @vindex org-treat-insert-todo-heading-as-state-change
1399 Insert new TODO entry with same level as current heading. See also the
1400 variable @code{org-treat-insert-todo-heading-as-state-change}.
1401 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1402 Insert new TODO entry with same level as current heading. Like
1403 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1405 @orgcmd{@key{TAB},org-cycle}
1406 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1407 become a child of the previous one. The next @key{TAB} makes it a parent,
1408 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1409 to the initial level.
1410 @orgcmd{M-@key{left},org-do-promote}
1411 Promote current heading by one level.
1412 @orgcmd{M-@key{right},org-do-demote}
1413 Demote current heading by one level.
1414 @orgcmd{M-S-@key{left},org-promote-subtree}
1415 Promote the current subtree by one level.
1416 @orgcmd{M-S-@key{right},org-demote-subtree}
1417 Demote the current subtree by one level.
1418 @orgcmd{M-S-@key{up},org-move-subtree-up}
1419 Move subtree up (swap with previous subtree of same
1421 @orgcmd{M-S-@key{down},org-move-subtree-down}
1422 Move subtree down (swap with next subtree of same level).
1423 @orgcmd{M-h,org-mark-element}
1424 Mark the element at point. Hitting repeatedly will mark subsequent elements
1425 of the one just marked. E.g., hitting @key{M-h} on a paragraph will mark it,
1426 hitting @key{M-h} immediately again will mark the next one.
1427 @orgcmd{C-c @@,org-mark-subtree}
1428 Mark the subtree at point. Hitting repeatedly will mark subsequent subtrees
1429 of the same level than the marked subtree.
1430 @orgcmd{C-c C-x C-w,org-cut-subtree}
1431 Kill subtree, i.e., remove it from buffer but save in kill ring.
1432 With a numeric prefix argument N, kill N sequential subtrees.
1433 @orgcmd{C-c C-x M-w,org-copy-subtree}
1434 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1435 sequential subtrees.
1436 @orgcmd{C-c C-x C-y,org-paste-subtree}
1437 Yank subtree from kill ring. This does modify the level of the subtree to
1438 make sure the tree fits in nicely at the yank position. The yank level can
1439 also be specified with a numeric prefix argument, or by yanking after a
1440 headline marker like @samp{****}.
1441 @orgcmd{C-y,org-yank}
1442 @vindex org-yank-adjusted-subtrees
1443 @vindex org-yank-folded-subtrees
1444 Depending on the variables @code{org-yank-adjusted-subtrees} and
1445 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1446 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1447 C-x C-y}. With the default settings, no level adjustment will take place,
1448 but the yanked tree will be folded unless doing so would swallow text
1449 previously visible. Any prefix argument to this command will force a normal
1450 @code{yank} to be executed, with the prefix passed along. A good way to
1451 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1452 yank, it will yank previous kill items plainly, without adjustment and
1454 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1455 Clone a subtree by making a number of sibling copies of it. You will be
1456 prompted for the number of copies to make, and you can also specify if any
1457 timestamps in the entry should be shifted. This can be useful, for example,
1458 to create a number of tasks related to a series of lectures to prepare. For
1459 more details, see the docstring of the command
1460 @code{org-clone-subtree-with-time-shift}.
1461 @orgcmd{C-c C-w,org-refile}
1462 Refile entry or region to a different location. @xref{Refile and copy}.
1463 @orgcmd{C-c ^,org-sort}
1464 Sort same-level entries. When there is an active region, all entries in the
1465 region will be sorted. Otherwise the children of the current headline are
1466 sorted. The command prompts for the sorting method, which can be
1467 alphabetically, numerically, by time (first timestamp with active preferred,
1468 creation time, scheduled time, deadline time), by priority, by TODO keyword
1469 (in the sequence the keywords have been defined in the setup) or by the value
1470 of a property. Reverse sorting is possible as well. You can also supply
1471 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1472 sorting will be case-sensitive.
1473 @orgcmd{C-x n s,org-narrow-to-subtree}
1474 Narrow buffer to current subtree.
1475 @orgcmd{C-x n b,org-narrow-to-block}
1476 Narrow buffer to current block.
1477 @orgcmd{C-x n w,widen}
1478 Widen buffer to remove narrowing.
1479 @orgcmd{C-c *,org-toggle-heading}
1480 Turn a normal line or plain list item into a headline (so that it becomes a
1481 subheading at its location). Also turn a headline into a normal line by
1482 removing the stars. If there is an active region, turn all lines in the
1483 region into headlines. If the first line in the region was an item, turn
1484 only the item lines into headlines. Finally, if the first line is a
1485 headline, remove the stars from all headlines in the region.
1488 @cindex region, active
1489 @cindex active region
1490 @cindex transient mark mode
1491 When there is an active region (Transient Mark mode), promotion and
1492 demotion work on all headlines in the region. To select a region of
1493 headlines, it is best to place both point and mark at the beginning of a
1494 line, mark at the beginning of the first headline, and point at the line
1495 just after the last headline to change. Note that when the cursor is
1496 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1500 @node Sparse trees, Plain lists, Structure editing, Document Structure
1501 @section Sparse trees
1502 @cindex sparse trees
1503 @cindex trees, sparse
1504 @cindex folding, sparse trees
1505 @cindex occur, command
1507 @vindex org-show-hierarchy-above
1508 @vindex org-show-following-heading
1509 @vindex org-show-siblings
1510 @vindex org-show-entry-below
1511 An important feature of Org mode is the ability to construct @emph{sparse
1512 trees} for selected information in an outline tree, so that the entire
1513 document is folded as much as possible, but the selected information is made
1514 visible along with the headline structure above it@footnote{See also the
1515 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1516 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1517 control on how much context is shown around each match.}. Just try it out
1518 and you will see immediately how it works.
1520 Org mode contains several commands creating such trees, all these
1521 commands can be accessed through a dispatcher:
1524 @orgcmd{C-c /,org-sparse-tree}
1525 This prompts for an extra key to select a sparse-tree creating command.
1526 @orgcmd{C-c / r,org-occur}
1527 @vindex org-remove-highlights-with-change
1528 Prompts for a regexp and shows a sparse tree with all matches. If
1529 the match is in a headline, the headline is made visible. If the match is in
1530 the body of an entry, headline and body are made visible. In order to
1531 provide minimal context, also the full hierarchy of headlines above the match
1532 is shown, as well as the headline following the match. Each match is also
1533 highlighted; the highlights disappear when the buffer is changed by an
1534 editing command@footnote{This depends on the option
1535 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1536 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1537 so several calls to this command can be stacked.
1538 @orgcmdkkc{M-g n,M-g M-n,next-error}
1539 Jump to the next sparse tree match in this buffer.
1540 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1541 Jump to the previous sparse tree match in this buffer.
1546 @vindex org-agenda-custom-commands
1547 For frequently used sparse trees of specific search strings, you can
1548 use the variable @code{org-agenda-custom-commands} to define fast
1549 keyboard access to specific sparse trees. These commands will then be
1550 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1554 (setq org-agenda-custom-commands
1555 '(("f" occur-tree "FIXME")))
1558 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1559 a sparse tree matching the string @samp{FIXME}.
1561 The other sparse tree commands select headings based on TODO keywords,
1562 tags, or properties and will be discussed later in this manual.
1565 @cindex printing sparse trees
1566 @cindex visible text, printing
1567 To print a sparse tree, you can use the Emacs command
1568 @code{ps-print-buffer-with-faces} which does not print invisible parts
1569 of the document @footnote{This does not work under XEmacs, because
1570 XEmacs uses selective display for outlining, not text properties.}.
1571 Or you can use the command @kbd{C-c C-e v} to export only the visible
1572 part of the document and print the resulting file.
1574 @node Plain lists, Drawers, Sparse trees, Document Structure
1575 @section Plain lists
1577 @cindex lists, plain
1578 @cindex lists, ordered
1579 @cindex ordered lists
1581 Within an entry of the outline tree, hand-formatted lists can provide
1582 additional structure. They also provide a way to create lists of checkboxes
1583 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1584 (@pxref{Exporting}) can parse and format them.
1586 Org knows ordered lists, unordered lists, and description lists.
1589 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1590 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1591 they will be seen as top-level headlines. Also, when you are hiding leading
1592 stars to get a clean outline view, plain list items starting with a star may
1593 be hard to distinguish from true headlines. In short: even though @samp{*}
1594 is supported, it may be better to not use it for plain list items.} as
1597 @vindex org-plain-list-ordered-item-terminator
1598 @vindex org-alphabetical-lists
1599 @emph{Ordered} list items start with a numeral followed by either a period or
1600 a right parenthesis@footnote{You can filter out any of them by configuring
1601 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1602 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1603 @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
1604 confusion with normal text, those are limited to one character only. Beyond
1605 that limit, bullets will automatically fallback to numbers.}. If you want a
1606 list to start with a different value (e.g., 20), start the text of the item
1607 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1608 must be put @emph{before} the checkbox. If you have activated alphabetical
1609 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1610 be used in any item of the list in order to enforce a particular numbering.
1612 @emph{Description} list items are unordered list items, and contain the
1613 separator @samp{ :: } to distinguish the description @emph{term} from the
1617 Items belonging to the same list must have the same indentation on the first
1618 line. In particular, if an ordered list reaches number @samp{10.}, then the
1619 2--digit numbers must be written left-aligned with the other numbers in the
1620 list. An item ends before the next line that is less or equally indented
1621 than its bullet/number.
1623 @vindex org-empty-line-terminates-plain-lists
1624 A list ends whenever every item has ended, which means before any line less
1625 or equally indented than items at top level. It also ends before two blank
1626 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
1627 that case, all items are closed. Here is an example:
1631 ** Lord of the Rings
1632 My favorite scenes are (in this order)
1633 1. The attack of the Rohirrim
1634 2. Eowyn's fight with the witch king
1635 + this was already my favorite scene in the book
1636 + I really like Miranda Otto.
1637 3. Peter Jackson being shot by Legolas
1639 He makes a really funny face when it happens.
1640 But in the end, no individual scenes matter but the film as a whole.
1641 Important actors in this film are:
1642 - @b{Elijah Wood} :: He plays Frodo
1643 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1644 him very well from his role as Mikey Walsh in @i{The Goonies}.
1648 Org supports these lists by tuning filling and wrapping commands to deal with
1649 them correctly@footnote{Org only changes the filling settings for Emacs. For
1650 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1651 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1652 properly (@pxref{Exporting}). Since indentation is what governs the
1653 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1654 blocks can be indented to signal that they belong to a particular item.
1656 @vindex org-list-demote-modify-bullet
1657 @vindex org-list-indent-offset
1658 If you find that using a different bullet for a sub-list (than that used for
1659 the current list-level) improves readability, customize the variable
1660 @code{org-list-demote-modify-bullet}. To get a greater difference of
1661 indentation between items and theirs sub-items, customize
1662 @code{org-list-indent-offset}.
1664 @vindex org-list-automatic-rules
1665 The following commands act on items when the cursor is in the first line of
1666 an item (the line with the bullet or number). Some of them imply the
1667 application of automatic rules to keep list structure intact. If some of
1668 these actions get in your way, configure @code{org-list-automatic-rules}
1669 to disable them individually.
1672 @orgcmd{@key{TAB},org-cycle}
1673 @cindex cycling, in plain lists
1674 @vindex org-cycle-include-plain-lists
1675 Items can be folded just like headline levels. Normally this works only if
1676 the cursor is on a plain list item. For more details, see the variable
1677 @code{org-cycle-include-plain-lists}. If this variable is set to
1678 @code{integrate}, plain list items will be treated like low-level
1679 headlines. The level of an item is then given by the indentation of the
1680 bullet/number. Items are always subordinate to real headlines, however; the
1681 hierarchies remain completely separated. In a new item with no text yet, the
1682 first @key{TAB} demotes the item to become a child of the previous
1683 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1684 and eventually get it back to its initial position.
1685 @orgcmd{M-@key{RET},org-insert-heading}
1686 @vindex org-M-RET-may-split-line
1687 @vindex org-list-automatic-rules
1688 Insert new item at current level. With a prefix argument, force a new
1689 heading (@pxref{Structure editing}). If this command is used in the middle
1690 of an item, that item is @emph{split} in two, and the second part becomes the
1691 new item@footnote{If you do not want the item to be split, customize the
1692 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1693 @emph{before item's body}, the new item is created @emph{before} the current
1698 @kindex M-S-@key{RET}
1700 Insert a new item with a checkbox (@pxref{Checkboxes}).
1701 @kindex S-@key{down}
1704 @cindex shift-selection-mode
1705 @vindex org-support-shift-select
1706 @vindex org-list-use-circular-motion
1707 Jump to the previous/next item in the current list@footnote{If you want to
1708 cycle around items that way, you may customize
1709 @code{org-list-use-circular-motion}.}, but only if
1710 @code{org-support-shift-select} is off. If not, you can still use paragraph
1711 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1714 @kindex M-@key{down}
1717 Move the item including subitems up/down@footnote{See
1718 @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
1719 previous/next item of same indentation). If the list is ordered, renumbering
1721 @kindex M-@key{left}
1722 @kindex M-@key{right}
1725 Decrease/increase the indentation of an item, leaving children alone.
1726 @kindex M-S-@key{left}
1727 @kindex M-S-@key{right}
1730 Decrease/increase the indentation of the item, including subitems.
1731 Initially, the item tree is selected based on current indentation. When
1732 these commands are executed several times in direct succession, the initially
1733 selected region is used, even if the new indentation would imply a different
1734 hierarchy. To use the new hierarchy, break the command chain with a cursor
1737 As a special case, using this command on the very first item of a list will
1738 move the whole list. This behavior can be disabled by configuring
1739 @code{org-list-automatic-rules}. The global indentation of a list has no
1740 influence on the text @emph{after} the list.
1743 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1744 state of the checkbox. In any case, verify bullets and indentation
1745 consistency in the whole list.
1747 @vindex org-plain-list-ordered-item-terminator
1749 Cycle the entire list level through the different itemize/enumerate bullets
1750 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1751 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1752 and its indentation. With a numeric prefix argument N, select the Nth bullet
1753 from this list. If there is an active region when calling this, selected
1754 text will be changed into an item. With a prefix argument, all lines will be
1755 converted to list items. If the first line already was a list item, any item
1756 marker will be removed from the list. Finally, even without an active
1757 region, a normal line will be converted into a list item.
1760 Turn a plain list item into a headline (so that it becomes a subheading at
1761 its location). @xref{Structure editing}, for a detailed explanation.
1764 Turn the whole plain list into a subtree of the current heading. Checkboxes
1765 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1767 @kindex S-@key{left}
1768 @kindex S-@key{right}
1770 @vindex org-support-shift-select
1771 This command also cycles bullet styles when the cursor in on the bullet or
1772 anywhere in an item line, details depending on
1773 @code{org-support-shift-select}.
1776 Sort the plain list. You will be prompted for the sorting method:
1777 numerically, alphabetically, by time, or by custom function.
1780 @node Drawers, Blocks, Plain lists, Document Structure
1784 @cindex visibility cycling, drawers
1787 @cindex org-insert-drawer
1789 Sometimes you want to keep information associated with an entry, but you
1790 normally don't want to see it. For this, Org mode has @emph{drawers}.
1791 Drawers need to be configured with the variable
1792 @code{org-drawers}@footnote{You can define additional drawers on a
1793 per-file basis with a line like @code{#+DRAWERS: HIDDEN STATE}}. Drawers
1797 ** This is a headline
1798 Still outside the drawer
1800 This is inside the drawer.
1805 You can interactively insert drawers at point by calling
1806 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1807 region, this command will put the region inside the drawer. With a prefix
1808 argument, this command calls @code{org-insert-property-drawer} and add a
1809 property drawer right below the current headline. Completion over drawer
1810 keywords is also possible using @key{M-TAB}.
1812 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1813 show the entry, but keep the drawer collapsed to a single line. In order to
1814 look inside the drawer, you need to move the cursor to the drawer line and
1815 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1816 storing properties (@pxref{Properties and Columns}), and you can also arrange
1817 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1818 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1819 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1824 Add a time-stamped note to the LOGBOOK drawer.
1827 @node Blocks, Footnotes, Drawers, Document Structure
1830 @vindex org-hide-block-startup
1831 @cindex blocks, folding
1832 Org mode uses begin...end blocks for various purposes from including source
1833 code examples (@pxref{Literal examples}) to capturing time logging
1834 information (@pxref{Clocking work time}). These blocks can be folded and
1835 unfolded by pressing TAB in the begin line. You can also get all blocks
1836 folded at startup by configuring the variable @code{org-hide-block-startup}
1837 or on a per-file basis by using
1839 @cindex @code{hideblocks}, STARTUP keyword
1840 @cindex @code{nohideblocks}, STARTUP keyword
1842 #+STARTUP: hideblocks
1843 #+STARTUP: nohideblocks
1846 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1850 Org mode supports the creation of footnotes. In contrast to the
1851 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1852 larger document, not only for one-off documents like emails. The basic
1853 syntax is similar to the one used by @file{footnote.el}, i.e., a footnote is
1854 defined in a paragraph that is started by a footnote marker in square
1855 brackets in column 0, no indentation allowed. If you need a paragraph break
1856 inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
1857 is simply the marker in square brackets, inside text. For example:
1860 The Org homepage[fn:1] now looks a lot better than it used to.
1862 [fn:1] The link is: http://orgmode.org
1865 Org mode extends the number-based syntax to @emph{named} footnotes and
1866 optional inline definition. Using plain numbers as markers (as
1867 @file{footnote.el} does) is supported for backward compatibility, but not
1868 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1869 @LaTeX{}}). Here are the valid references:
1873 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1874 recommended because something like @samp{[1]} could easily be part of a code
1877 A named footnote reference, where @code{name} is a unique label word, or, for
1878 simplicity of automatic creation, a number.
1879 @item [fn:: This is the inline definition of this footnote]
1880 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1882 @item [fn:name: a definition]
1883 An inline definition of a footnote, which also specifies a name for the note.
1884 Since Org allows multiple references to the same note, you can then use
1885 @code{[fn:name]} to create additional references.
1888 @vindex org-footnote-auto-label
1889 Footnote labels can be created automatically, or you can create names yourself.
1890 This is handled by the variable @code{org-footnote-auto-label} and its
1891 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1894 @noindent The following command handles footnotes:
1899 The footnote action command.
1901 When the cursor is on a footnote reference, jump to the definition. When it
1902 is at a definition, jump to the (first) reference.
1904 @vindex org-footnote-define-inline
1905 @vindex org-footnote-section
1906 @vindex org-footnote-auto-adjust
1907 Otherwise, create a new footnote. Depending on the variable
1908 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1909 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1910 definition will be placed right into the text as part of the reference, or
1911 separately into the location determined by the variable
1912 @code{org-footnote-section}.
1914 When this command is called with a prefix argument, a menu of additional
1917 s @r{Sort the footnote definitions by reference sequence. During editing,}
1918 @r{Org makes no effort to sort footnote definitions into a particular}
1919 @r{sequence. If you want them sorted, use this command, which will}
1920 @r{also move entries according to @code{org-footnote-section}. Automatic}
1921 @r{sorting after each insertion/deletion can be configured using the}
1922 @r{variable @code{org-footnote-auto-adjust}.}
1923 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1924 @r{after each insertion/deletion can be configured using the variable}
1925 @r{@code{org-footnote-auto-adjust}.}
1926 S @r{Short for first @code{r}, then @code{s} action.}
1927 n @r{Normalize the footnotes by collecting all definitions (including}
1928 @r{inline definitions) into a special section, and then numbering them}
1929 @r{in sequence. The references will then also be numbers. This is}
1930 @r{meant to be the final step before finishing a document (e.g., sending}
1931 @r{off an email). The exporters do this automatically, and so could}
1932 @r{something like @code{message-send-hook}.}
1933 d @r{Delete the footnote at point, and all definitions of and references}
1936 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1937 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1938 renumbering and sorting footnotes can be automatic after each insertion or
1943 If the cursor is on a footnote reference, jump to the definition. If it is a
1944 the definition, jump back to the reference. When called at a footnote
1945 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1949 @item C-c C-o @r{or} mouse-1/2
1950 Footnote labels are also links to the corresponding definition/reference, and
1951 you can use the usual commands to follow these links.
1954 @node Orgstruct mode, , Footnotes, Document Structure
1955 @section The Orgstruct minor mode
1956 @cindex Orgstruct mode
1957 @cindex minor mode for structure editing
1959 If you like the intuitive way the Org mode structure editing and list
1960 formatting works, you might want to use these commands in other modes like
1961 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
1962 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
1963 turn it on by default, for example in Message mode, with one of:
1966 (add-hook 'message-mode-hook 'turn-on-orgstruct)
1967 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
1970 When this mode is active and the cursor is on a line that looks to Org like a
1971 headline or the first line of a list item, most structure editing commands
1972 will work, even if the same keys normally have different functionality in the
1973 major mode you are using. If the cursor is not in one of those special
1974 lines, Orgstruct mode lurks silently in the shadows. When you use
1975 @code{orgstruct++-mode}, Org will also export indentation and autofill
1976 settings into that mode, and detect item context after the first line of an
1979 @node Tables, Hyperlinks, Document Structure, Top
1982 @cindex editing tables
1984 Org comes with a fast and intuitive table editor. Spreadsheet-like
1985 calculations are supported using the Emacs @file{calc} package
1986 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
1989 * Built-in table editor:: Simple tables
1990 * Column width and alignment:: Overrule the automatic settings
1991 * Column groups:: Grouping to trigger vertical lines
1992 * Orgtbl mode:: The table editor as minor mode
1993 * The spreadsheet:: The table editor has spreadsheet capabilities
1994 * Org-Plot:: Plotting from org tables
1997 @node Built-in table editor, Column width and alignment, Tables, Tables
1998 @section The built-in table editor
1999 @cindex table editor, built-in
2001 Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
2002 the first non-whitespace character is considered part of a table. @samp{|}
2003 is also the column separator@footnote{To insert a vertical bar into a table
2004 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2005 might look like this:
2008 | Name | Phone | Age |
2009 |-------+-------+-----|
2010 | Peter | 1234 | 17 |
2011 | Anna | 4321 | 25 |
2014 A table is re-aligned automatically each time you press @key{TAB} or
2015 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2016 the next field (@key{RET} to the next row) and creates new table rows
2017 at the end of the table or before horizontal lines. The indentation
2018 of the table is set by the first line. Any line starting with
2019 @samp{|-} is considered as a horizontal separator line and will be
2020 expanded on the next re-align to span the whole table width. So, to
2021 create the above table, you would only type
2028 @noindent and then press @key{TAB} to align the table and start filling in
2029 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2030 @kbd{C-c @key{RET}}.
2032 @vindex org-enable-table-editor
2033 @vindex org-table-auto-blank-field
2034 When typing text into a field, Org treats @key{DEL},
2035 @key{Backspace}, and all character keys in a special way, so that
2036 inserting and deleting avoids shifting other fields. Also, when
2037 typing @emph{immediately after the cursor was moved into a new field
2038 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2039 field is automatically made blank. If this behavior is too
2040 unpredictable for you, configure the variables
2041 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2044 @tsubheading{Creation and conversion}
2045 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2046 Convert the active region to table. If every line contains at least one
2047 TAB character, the function assumes that the material is tab separated.
2048 If every line contains a comma, comma-separated values (CSV) are assumed.
2049 If not, lines are split at whitespace into fields. You can use a prefix
2050 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2051 C-u} forces TAB, and a numeric argument N indicates that at least N
2052 consecutive spaces, or alternatively a TAB will be the separator.
2054 If there is no active region, this command creates an empty Org
2055 table. But it is easier just to start typing, like
2056 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2058 @tsubheading{Re-aligning and field motion}
2059 @orgcmd{C-c C-c,org-table-align}
2060 Re-align the table and don't move to another field.
2062 @orgcmd{<TAB>,org-table-next-field}
2063 Re-align the table, move to the next field. Creates a new row if
2066 @orgcmd{S-@key{TAB},org-table-previous-field}
2067 Re-align, move to previous field.
2069 @orgcmd{@key{RET},org-table-next-row}
2070 Re-align the table and move down to next row. Creates a new row if
2071 necessary. At the beginning or end of a line, @key{RET} still does
2072 NEWLINE, so it can be used to split a table.
2074 @orgcmd{M-a,org-table-beginning-of-field}
2075 Move to beginning of the current table field, or on to the previous field.
2076 @orgcmd{M-e,org-table-end-of-field}
2077 Move to end of the current table field, or on to the next field.
2079 @tsubheading{Column and row editing}
2080 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2081 Move the current column left/right.
2083 @orgcmd{M-S-@key{left},org-table-delete-column}
2084 Kill the current column.
2086 @orgcmd{M-S-@key{right},org-table-insert-column}
2087 Insert a new column to the left of the cursor position.
2089 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2090 Move the current row up/down.
2092 @orgcmd{M-S-@key{up},org-table-kill-row}
2093 Kill the current row or horizontal line.
2095 @orgcmd{M-S-@key{down},org-table-insert-row}
2096 Insert a new row above the current row. With a prefix argument, the line is
2097 created below the current one.
2099 @orgcmd{C-c -,org-table-insert-hline}
2100 Insert a horizontal line below current row. With a prefix argument, the line
2101 is created above the current line.
2103 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2104 Insert a horizontal line below current row, and move the cursor into the row
2107 @orgcmd{C-c ^,org-table-sort-lines}
2108 Sort the table lines in the region. The position of point indicates the
2109 column to be used for sorting, and the range of lines is the range
2110 between the nearest horizontal separator lines, or the entire table. If
2111 point is before the first column, you will be prompted for the sorting
2112 column. If there is an active region, the mark specifies the first line
2113 and the sorting column, while point should be in the last line to be
2114 included into the sorting. The command prompts for the sorting type
2115 (alphabetically, numerically, or by time). When called with a prefix
2116 argument, alphabetic sorting will be case-sensitive.
2118 @tsubheading{Regions}
2119 @orgcmd{C-c C-x M-w,org-table-copy-region}
2120 Copy a rectangular region from a table to a special clipboard. Point and
2121 mark determine edge fields of the rectangle. If there is no active region,
2122 copy just the current field. The process ignores horizontal separator lines.
2124 @orgcmd{C-c C-x C-w,org-table-cut-region}
2125 Copy a rectangular region from a table to a special clipboard, and
2126 blank all fields in the rectangle. So this is the ``cut'' operation.
2128 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2129 Paste a rectangular region into a table.
2130 The upper left corner ends up in the current field. All involved fields
2131 will be overwritten. If the rectangle does not fit into the present table,
2132 the table is enlarged as needed. The process ignores horizontal separator
2135 @orgcmd{M-@key{RET},org-table-wrap-region}
2136 Split the current field at the cursor position and move the rest to the line
2137 below. If there is an active region, and both point and mark are in the same
2138 column, the text in the column is wrapped to minimum width for the given
2139 number of lines. A numeric prefix argument may be used to change the number
2140 of desired lines. If there is no region, but you specify a prefix argument,
2141 the current field is made blank, and the content is appended to the field
2144 @tsubheading{Calculations}
2145 @cindex formula, in tables
2146 @cindex calculations, in tables
2147 @cindex region, active
2148 @cindex active region
2149 @cindex transient mark mode
2150 @orgcmd{C-c +,org-table-sum}
2151 Sum the numbers in the current column, or in the rectangle defined by
2152 the active region. The result is shown in the echo area and can
2153 be inserted with @kbd{C-y}.
2155 @orgcmd{S-@key{RET},org-table-copy-down}
2156 @vindex org-table-copy-increment
2157 When current field is empty, copy from first non-empty field above. When not
2158 empty, copy current field down to next row and move cursor along with it.
2159 Depending on the variable @code{org-table-copy-increment}, integer field
2160 values will be incremented during copy. Integers that are too large will not
2161 be incremented. Also, a @code{0} prefix argument temporarily disables the
2162 increment. This key is also used by shift-selection and related modes
2163 (@pxref{Conflicts}).
2165 @tsubheading{Miscellaneous}
2166 @orgcmd{C-c `,org-table-edit-field}
2167 Edit the current field in a separate window. This is useful for fields that
2168 are not fully visible (@pxref{Column width and alignment}). When called with
2169 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2170 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2171 window follow the cursor through the table and always show the current
2172 field. The follow mode exits automatically when the cursor leaves the table,
2173 or when you repeat this command with @kbd{C-u C-u C-c `}.
2175 @item M-x org-table-import
2176 Import a file as a table. The table should be TAB or whitespace
2177 separated. Use, for example, to import a spreadsheet table or data
2178 from a database, because these programs generally can write
2179 TAB-separated text files. This command works by inserting the file into
2180 the buffer and then converting the region to a table. Any prefix
2181 argument is passed on to the converter, which uses it to determine the
2183 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2184 Tables can also be imported by pasting tabular text into the Org
2185 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2186 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2188 @item M-x org-table-export
2189 @findex org-table-export
2190 @vindex org-table-export-default-format
2191 Export the table, by default as a TAB-separated file. Use for data
2192 exchange with, for example, spreadsheet or database programs. The format
2193 used to export the file can be configured in the variable
2194 @code{org-table-export-default-format}. You may also use properties
2195 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2196 name and the format for table export in a subtree. Org supports quite
2197 general formats for exported tables. The exporter format is the same as the
2198 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2199 detailed description.
2202 If you don't like the automatic table editor because it gets in your
2203 way on lines which you would like to start with @samp{|}, you can turn
2207 (setq org-enable-table-editor nil)
2210 @noindent Then the only table command that still works is
2211 @kbd{C-c C-c} to do a manual re-align.
2213 @node Column width and alignment, Column groups, Built-in table editor, Tables
2214 @section Column width and alignment
2215 @cindex narrow columns in tables
2216 @cindex alignment in tables
2218 The width of columns is automatically determined by the table editor. And
2219 also the alignment of a column is determined automatically from the fraction
2220 of number-like versus non-number fields in the column.
2222 Sometimes a single field or a few fields need to carry more text, leading to
2223 inconveniently wide columns. Or maybe you want to make a table with several
2224 columns having a fixed width, regardless of content. To set@footnote{This
2225 feature does not work on XEmacs.} the width of a column, one field anywhere
2226 in the column may contain just the string @samp{<N>} where @samp{N} is an
2227 integer specifying the width of the column in characters. The next re-align
2228 will then set the width of this column to this value.
2232 |---+------------------------------| |---+--------|
2234 | 1 | one | | 1 | one |
2235 | 2 | two | ----\ | 2 | two |
2236 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2237 | 4 | four | | 4 | four |
2238 |---+------------------------------| |---+--------|
2243 Fields that are wider become clipped and end in the string @samp{=>}.
2244 Note that the full text is still in the buffer but is hidden.
2245 To see the full text, hold the mouse over the field---a tool-tip window
2246 will show the full content. To edit such a field, use the command
2247 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2248 open a new window with the full field. Edit it and finish with @kbd{C-c
2251 @vindex org-startup-align-all-tables
2252 When visiting a file containing a table with narrowed columns, the
2253 necessary character hiding has not yet happened, and the table needs to
2254 be aligned before it looks nice. Setting the option
2255 @code{org-startup-align-all-tables} will realign all tables in a file
2256 upon visiting, but also slow down startup. You can also set this option
2257 on a per-file basis with:
2264 If you would like to overrule the automatic alignment of number-rich columns
2265 to the right and of string-rich column to the left, you can use @samp{<r>},
2266 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2267 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2268 also combine alignment and field width like this: @samp{<r10>}.
2270 Lines which only contain these formatting cookies will be removed
2271 automatically when exporting the document.
2273 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2274 @section Column groups
2275 @cindex grouping columns in tables
2277 When Org exports tables, it does so by default without vertical
2278 lines because that is visually more satisfying in general. Occasionally
2279 however, vertical lines can be useful to structure a table into groups
2280 of columns, much like horizontal lines can do for groups of rows. In
2281 order to specify column groups, you can use a special row where the
2282 first field contains only @samp{/}. The further fields can either
2283 contain @samp{<} to indicate that this column should start a group,
2284 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2285 and @samp{>}) to make a column
2286 a group of its own. Boundaries between column groups will upon export be
2287 marked with vertical lines. Here is an example:
2290 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2291 |---+-----+-----+-----+---------+------------|
2292 | / | < | | > | < | > |
2293 | 1 | 1 | 1 | 1 | 1 | 1 |
2294 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2295 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2296 |---+-----+-----+-----+---------+------------|
2297 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2300 It is also sufficient to just insert the column group starters after
2301 every vertical line you would like to have:
2304 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2305 |----+-----+-----+-----+---------+------------|
2309 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2310 @section The Orgtbl minor mode
2312 @cindex minor mode for tables
2314 If you like the intuitive way the Org table editor works, you
2315 might also want to use it in other modes like Text mode or Mail mode.
2316 The minor mode Orgtbl mode makes this possible. You can always toggle
2317 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2318 example in Message mode, use
2321 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2324 Furthermore, with some special setup, it is possible to maintain tables
2325 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2326 construct @LaTeX{} tables with the underlying ease and power of
2327 Orgtbl mode, including spreadsheet capabilities. For details, see
2328 @ref{Tables in arbitrary syntax}.
2330 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2331 @section The spreadsheet
2332 @cindex calculations, in tables
2333 @cindex spreadsheet capabilities
2334 @cindex @file{calc} package
2336 The table editor makes use of the Emacs @file{calc} package to implement
2337 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2338 derive fields from other fields. While fully featured, Org's implementation
2339 is not identical to other spreadsheets. For example, Org knows the concept
2340 of a @emph{column formula} that will be applied to all non-header fields in a
2341 column without having to copy the formula to each relevant field. There is
2342 also a formula debugger, and a formula editor with features for highlighting
2343 fields in the table corresponding to the references at the point in the
2344 formula, moving these references by arrow keys
2347 * References:: How to refer to another field or range
2348 * Formula syntax for Calc:: Using Calc to compute stuff
2349 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2350 * Durations and time values:: How to compute durations and time values
2351 * Field and range formulas:: Formula for specific (ranges of) fields
2352 * Column formulas:: Formulas valid for an entire column
2353 * Lookup functions:: Lookup functions for searching tables
2354 * Editing and debugging formulas:: Fixing formulas
2355 * Updating the table:: Recomputing all dependent fields
2356 * Advanced features:: Field and column names, parameters and automatic recalc
2359 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2360 @subsection References
2363 To compute fields in the table from other fields, formulas must
2364 reference other fields or ranges. In Org, fields can be referenced
2365 by name, by absolute coordinates, and by relative coordinates. To find
2366 out what the coordinates of a field are, press @kbd{C-c ?} in that
2367 field, or press @kbd{C-c @}} to toggle the display of a grid.
2369 @subsubheading Field references
2370 @cindex field references
2371 @cindex references, to fields
2373 Formulas can reference the value of another field in two ways. Like in
2374 any other spreadsheet, you may reference fields with a letter/number
2375 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2376 @vindex org-table-use-standard-references
2377 However, Org prefers@footnote{Org will understand references typed by the
2378 user as @samp{B4}, but it will not use this syntax when offering a formula
2379 for editing. You can customize this behavior using the variable
2380 @code{org-table-use-standard-references}.} to use another, more general
2381 representation that looks like this:
2383 @@@var{row}$@var{column}
2386 Column specifications can be absolute like @code{$1},
2387 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2388 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2389 @code{$<} and @code{$>} are immutable references to the first and last
2390 column, respectively, and you can use @code{$>>>} to indicate the third
2391 column from the right.
2393 The row specification only counts data lines and ignores horizontal separator
2394 lines (hlines). Like with columns, you can use absolute row numbers
2395 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2396 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2397 immutable references the first and last@footnote{For backward compatibility
2398 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2399 a stable way to the 5th and 12th field in the last row of the table.
2400 However, this syntax is deprecated, it should not be used for new documents.
2401 Use @code{@@>$} instead.} row in the table, respectively. You may also
2402 specify the row relative to one of the hlines: @code{@@I} refers to the first
2403 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2404 line above the current line, @code{@@+I} to the first such line below the
2405 current line. You can also write @code{@@III+2} which is the second data line
2406 after the third hline in the table.
2408 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2409 i.e., to the row/column for the field being computed. Also, if you omit
2410 either the column or the row part of the reference, the current row/column is
2413 Org's references with @emph{unsigned} numbers are fixed references
2414 in the sense that if you use the same reference in the formula for two
2415 different fields, the same field will be referenced each time.
2416 Org's references with @emph{signed} numbers are floating
2417 references because the same reference operator can reference different
2418 fields depending on the field being calculated by the formula.
2420 Here are a few examples:
2423 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2424 $5 @r{column 5 in the current row (same as @code{E&})}
2425 @@2 @r{current column, row 2}
2426 @@-1$-3 @r{the field one row up, three columns to the left}
2427 @@-I$2 @r{field just under hline above current row, column 2}
2428 @@>$5 @r{field in the last row, in column 5}
2431 @subsubheading Range references
2432 @cindex range references
2433 @cindex references, to ranges
2435 You may reference a rectangular range of fields by specifying two field
2436 references connected by two dots @samp{..}. If both fields are in the
2437 current row, you may simply use @samp{$2..$7}, but if at least one field
2438 is in a different row, you need to use the general @code{@@row$column}
2439 format at least for the first field (i.e the reference must start with
2440 @samp{@@} in order to be interpreted correctly). Examples:
2443 $1..$3 @r{first three fields in the current row}
2444 $P..$Q @r{range, using column names (see under Advanced)}
2445 $<<<..$>> @r{start in third column, continue to the one but last}
2446 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2447 @@-1$-2..@@-1 @r{3 fields in the row above, starting from 2 columns on the left}
2448 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2451 @noindent Range references return a vector of values that can be fed
2452 into Calc vector functions. Empty fields in ranges are normally
2453 suppressed, so that the vector contains only the non-empty fields (but
2454 see the @samp{E} mode switch below). If there are no non-empty fields,
2455 @samp{[0]} is returned to avoid syntax errors in formulas.
2457 @subsubheading Field coordinates in formulas
2458 @cindex field coordinates
2459 @cindex coordinates, of field
2460 @cindex row, of field coordinates
2461 @cindex column, of field coordinates
2463 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2464 get the row or column number of the field where the formula result goes.
2465 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2466 and @code{org-table-current-column}. Examples:
2469 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2470 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2471 @r{column 3 of the current table}
2474 @noindent For the second example, table FOO must have at least as many rows
2475 as the current table. Note that this is inefficient@footnote{The computation time scales as
2476 O(N^2) because table FOO is parsed for each field to be copied.} for large
2479 @subsubheading Named references
2480 @cindex named references
2481 @cindex references, named
2482 @cindex name, of column or field
2483 @cindex constants, in calculations
2486 @vindex org-table-formula-constants
2487 @samp{$name} is interpreted as the name of a column, parameter or
2488 constant. Constants are defined globally through the variable
2489 @code{org-table-formula-constants}, and locally (for the file) through a
2493 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2497 @vindex constants-unit-system
2498 @pindex constants.el
2499 Also properties (@pxref{Properties and Columns}) can be used as
2500 constants in table formulas: for a property @samp{:Xyz:} use the name
2501 @samp{$PROP_Xyz}, and the property will be searched in the current
2502 outline entry and in the hierarchy above it. If you have the
2503 @file{constants.el} package, it will also be used to resolve constants,
2504 including natural constants like @samp{$h} for Planck's constant, and
2505 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2506 supply the values of constants in two different unit systems, @code{SI}
2507 and @code{cgs}. Which one is used depends on the value of the variable
2508 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2509 @code{constSI} and @code{constcgs} to set this value for the current
2510 buffer.}. Column names and parameters can be specified in special table
2511 lines. These are described below, see @ref{Advanced features}. All
2512 names must start with a letter, and further consist of letters and
2515 @subsubheading Remote references
2516 @cindex remote references
2517 @cindex references, remote
2518 @cindex references, to a different table
2519 @cindex name, of column or field
2520 @cindex constants, in calculations
2523 You may also reference constants, fields and ranges from a different table,
2524 either in the current file or even in a different file. The syntax is
2527 remote(NAME-OR-ID,REF)
2531 where NAME can be the name of a table in the current file as set by a
2532 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2533 entry, even in a different file, and the reference then refers to the first
2534 table in that entry. REF is an absolute field or range reference as
2535 described above for example @code{@@3$3} or @code{$somename}, valid in the
2538 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2539 @subsection Formula syntax for Calc
2540 @cindex formula syntax, Calc
2541 @cindex syntax, of formulas
2543 A formula can be any algebraic expression understood by the Emacs
2544 @file{Calc} package. @b{Note that @file{calc} has the
2545 non-standard convention that @samp{/} has lower precedence than
2546 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2547 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2548 Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc, GNU
2549 Emacs Calc Manual}),
2550 variable substitution takes place according to the rules described above.
2551 @cindex vectors, in table calculations
2552 The range vectors can be directly fed into the Calc vector functions
2553 like @samp{vmean} and @samp{vsum}.
2555 @cindex format specifier
2556 @cindex mode, for @file{calc}
2557 @vindex org-calc-default-modes
2558 A formula can contain an optional mode string after a semicolon. This
2559 string consists of flags to influence Calc and other modes during
2560 execution. By default, Org uses the standard Calc modes (precision
2561 12, angular units degrees, fraction and symbolic modes off). The display
2562 format, however, has been changed to @code{(float 8)} to keep tables
2563 compact. The default settings can be configured using the variable
2564 @code{org-calc-default-modes}.
2567 p20 @r{set the internal Calc calculation precision to 20 digits}
2568 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2569 @r{format of the result of Calc passed back to Org.}
2570 @r{Calc formatting is unlimited in precision as}
2571 @r{long as the Calc calculation precision is greater.}
2572 D R @r{angle modes: degrees, radians}
2573 F S @r{fraction and symbolic modes}
2574 E @r{keep empty fields in ranges and use nan (not a number)}
2575 @r{in Calc formulas for empty fields in range references and}
2576 @r{for empty field references; else suppress empty fields in}
2577 @r{range references and use 0 for empty field references, see}
2578 @r{also the notes for `Range references' in @pxref{References}}
2579 N @r{interpret all fields as numbers, use 0 for non-numbers;}
2580 @r{N has higher precedence than E (for the value of the field)}
2581 L @r{literal, for Lisp formulas only}
2585 Unless you use large integer numbers or high-precision-calculation
2586 and -display for floating point numbers you may alternatively provide a
2587 @code{printf} format specifier to reformat the Calc result after it has been
2588 passed back to Org instead of letting Calc already do the
2589 formatting@footnote{The @code{printf} reformatting is limited in precision
2590 because the value passed to it is converted into an @code{integer} or
2591 @code{double}. The @code{integer} is limited in size by truncating the
2592 signed value to 32 bits. The @code{double} is limited in precision to 64
2593 bits overall which leaves approximately 16 significant decimal digits.}.
2597 $1+$2 @r{Sum of first and second field}
2598 $1+$2;%.2f @r{Same, format result to two decimals}
2599 exp($2)+exp($1) @r{Math functions can be used}
2600 $0;%.1f @r{Reformat current cell to 1 decimal}
2601 ($3-32)*5/9 @r{Degrees F -> C conversion}
2602 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2603 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2604 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2605 vmean($2..$7) @r{Compute column range mean, suppress empty fields}
2606 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2607 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2610 Calc also contains a complete set of logical operations. For example
2613 if($1 < 20, teen, string(""))
2614 @r{"teen" if age $1 is less than 20, else empty}
2615 if("$1" = "nan" || "$2" = "nan", string(""), $1 + $2); E
2616 @r{sum of first two columns unless one or both empty}
2619 Note that you can also use two org-specific flags @code{T} and @code{t} for
2620 durations computations @ref{Durations and time values}.
2622 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2623 and use them in formula syntax for Calc.
2625 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2626 @subsection Emacs Lisp forms as formulas
2627 @cindex Lisp forms, as table formulas
2629 It is also possible to write a formula in Emacs Lisp. This can be useful
2630 for string manipulation and control structures, if Calc's functionality is
2633 If a formula starts with a single-quote followed by an opening parenthesis,
2634 then it is evaluated as a Lisp form. The evaluation should return either a
2635 string or a number. Just as with @file{calc} formulas, you can specify modes
2636 and a printf format after a semicolon.
2638 With Emacs Lisp forms, you need to be conscious about the way field
2639 references are interpolated into the form. By default, a reference will be
2640 interpolated as a Lisp string (in double-quotes) containing the field. If
2641 you provide the @samp{N} mode switch, all referenced elements will be numbers
2642 (non-number fields will be zero) and interpolated as Lisp numbers, without
2643 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2644 literally, without quotes. I.e., if you want a reference to be interpreted
2645 as a string by the Lisp form, enclose the reference operator itself in
2646 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2647 fields, so you can embed them in list or vector syntax.
2649 Here are a few examples---note how the @samp{N} mode is used when we do
2650 computations in Lisp:
2653 @r{Swap the first two characters of the content of column 1}
2654 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2655 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2657 @r{Compute the sum of columns 1--4, like Calc's @code{vsum($1..$4)}}
2658 '(apply '+ '($1..$4));N
2661 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2662 @subsection Durations and time values
2663 @cindex Duration, computing
2664 @cindex Time, computing
2665 @vindex org-table-duration-custom-format
2667 If you want to compute time values use the @code{T} flag, either in Calc
2668 formulas or Elisp formulas:
2672 | Task 1 | Task 2 | Total |
2673 |---------+----------+----------|
2674 | 2:12 | 1:47 | 03:59:00 |
2675 | 3:02:20 | -2:07:00 | 0.92 |
2676 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2680 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2681 are optional. With the @code{T} flag, computed durations will be displayed
2682 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2683 computed durations will be displayed according to the value of the variable
2684 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2685 will display the result as a fraction of hours (see the second formula in the
2688 Negative duration values can be manipulated as well, and integers will be
2689 considered as seconds in addition and subtraction.
2691 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2692 @subsection Field and range formulas
2693 @cindex field formula
2694 @cindex range formula
2695 @cindex formula, for individual table field
2696 @cindex formula, for range of fields
2698 To assign a formula to a particular field, type it directly into the field,
2699 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2700 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2701 the formula will be stored as the formula for this field, evaluated, and the
2702 current field will be replaced with the result.
2705 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2706 below the table. If you type the equation in the 4th field of the 3rd data
2707 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2708 inserting/deleting/swapping column and rows with the appropriate commands,
2709 @i{absolute references} (but not relative ones) in stored formulas are
2710 modified in order to still reference the same field. To avoid this from
2711 happening, in particular in range references, anchor ranges at the table
2712 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2713 using the @code{@@I} notation. Automatic adaptation of field references does
2714 of course not happen if you edit the table structure with normal editing
2715 commands---then you must fix the equations yourself.
2717 Instead of typing an equation into the field, you may also use the following
2721 @orgcmd{C-u C-c =,org-table-eval-formula}
2722 Install a new formula for the current field. The command prompts for a
2723 formula with default taken from the @samp{#+TBLFM:} line, applies
2724 it to the current field, and stores it.
2727 The left-hand side of a formula can also be a special expression in order to
2728 assign the formula to a number of different fields. There is no keyboard
2729 shortcut to enter such range formulas. To add them, use the formula editor
2730 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2735 Column formula, valid for the entire column. This is so common that Org
2736 treats these formulas in a special way, see @ref{Column formulas}.
2738 Row formula, applies to all fields in the specified row. @code{@@>=} means
2741 Range formula, applies to all fields in the given rectangular range. This
2742 can also be used to assign a formula to some but not all fields in a row.
2744 Named field, see @ref{Advanced features}.
2747 @node Column formulas, Lookup functions, Field and range formulas, The spreadsheet
2748 @subsection Column formulas
2749 @cindex column formula
2750 @cindex formula, for table column
2752 When you assign a formula to a simple column reference like @code{$3=}, the
2753 same formula will be used in all fields of that column, with the following
2754 very convenient exceptions: (i) If the table contains horizontal separator
2755 hlines with rows above and below, everything before the first such hline is
2756 considered part of the table @emph{header} and will not be modified by column
2757 formulas. Therefore a header is mandatory when you use column formulas and
2758 want to add hlines to group rows, like for example to separate a total row at
2759 the bottom from the summand rows above. (ii) Fields that already get a value
2760 from a field/range formula will be left alone by column formulas. These
2761 conditions make column formulas very easy to use.
2763 To assign a formula to a column, type it directly into any field in the
2764 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2765 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2766 the formula will be stored as the formula for the current column, evaluated
2767 and the current field replaced with the result. If the field contains only
2768 @samp{=}, the previously stored formula for this column is used. For each
2769 column, Org will only remember the most recently used formula. In the
2770 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2771 left-hand side of a column formula can not be the name of column, it must be
2772 the numeric column reference or @code{$>}.
2774 Instead of typing an equation into the field, you may also use the
2778 @orgcmd{C-c =,org-table-eval-formula}
2779 Install a new formula for the current column and replace current field with
2780 the result of the formula. The command prompts for a formula, with default
2781 taken from the @samp{#+TBLFM} line, applies it to the current field and
2782 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2783 will apply it to that many consecutive fields in the current column.
2786 @node Lookup functions, Editing and debugging formulas, Column formulas, The spreadsheet
2787 @subsection Lookup functions
2788 @cindex lookup functions in tables
2789 @cindex table lookup functions
2791 Org has three predefined Emacs Lisp functions for lookups in tables.
2793 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2794 @findex org-lookup-first
2795 Searches for the first element @code{S} in list @code{S-LIST} for which
2799 is @code{t}; returns the value from the corresponding position in list
2800 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2801 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2802 order as the correspoding parameters are in the call to
2803 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2804 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2806 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2807 @findex org-lookup-last
2808 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2809 element for which @code{PREDICATE} is @code{t}.
2810 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2811 @findex org-lookup-all
2812 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2813 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2814 values. This function can not be used by itself in a formula, because it
2815 returns a list of values. However, powerful lookups can be built when this
2816 function is combined with other Emacs Lisp functions.
2819 If the ranges used in these functions contain empty fields, the @code{E} mode
2820 for the formula should usually be specified: otherwise empty fields will not be
2821 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2822 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2823 element of @code{R-LIST}.
2825 These three functions can be used to implement associative arrays, count
2826 matching cells, rank results, group data etc. For practical examples
2827 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2830 @node Editing and debugging formulas, Updating the table, Lookup functions, The spreadsheet
2831 @subsection Editing and debugging formulas
2832 @cindex formula editing
2833 @cindex editing, of table formulas
2835 @vindex org-table-use-standard-references
2836 You can edit individual formulas in the minibuffer or directly in the
2837 field. Org can also prepare a special buffer with all active
2838 formulas of a table. When offering a formula for editing, Org
2839 converts references to the standard format (like @code{B3} or @code{D&})
2840 if possible. If you prefer to only work with the internal format (like
2841 @code{@@3$2} or @code{$4}), configure the variable
2842 @code{org-table-use-standard-references}.
2845 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2846 Edit the formula associated with the current column/field in the
2847 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2848 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2849 Re-insert the active formula (either a
2850 field formula, or a column formula) into the current field, so that you
2851 can edit it directly in the field. The advantage over editing in the
2852 minibuffer is that you can use the command @kbd{C-c ?}.
2853 @orgcmd{C-c ?,org-table-field-info}
2854 While editing a formula in a table field, highlight the field(s)
2855 referenced by the reference at the cursor position in the formula.
2857 @findex org-table-toggle-coordinate-overlays
2859 Toggle the display of row and column numbers for a table, using overlays
2860 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2861 time the table is aligned; you can force it with @kbd{C-c C-c}.
2863 @findex org-table-toggle-formula-debugger
2865 Toggle the formula debugger on and off
2866 (@command{org-table-toggle-formula-debugger}). See below.
2867 @orgcmd{C-c ',org-table-edit-formulas}
2868 Edit all formulas for the current table in a special buffer, where the
2869 formulas will be displayed one per line. If the current field has an
2870 active formula, the cursor in the formula editor will mark it.
2871 While inside the special buffer, Org will automatically highlight
2872 any field or range reference at the cursor position. You may edit,
2873 remove and add formulas, and use the following commands:
2875 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2876 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2877 prefix, also apply the new formulas to the entire table.
2878 @orgcmd{C-c C-q,org-table-fedit-abort}
2879 Exit the formula editor without installing changes.
2880 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2881 Toggle all references in the formula editor between standard (like
2882 @code{B3}) and internal (like @code{@@3$2}).
2883 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2884 Pretty-print or indent Lisp formula at point. When in a line containing
2885 a Lisp formula, format the formula according to Emacs Lisp rules.
2886 Another @key{TAB} collapses the formula back again. In the open
2887 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2888 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2889 Complete Lisp symbols, just like in Emacs Lisp mode.
2891 @kindex S-@key{down}
2892 @kindex S-@key{left}
2893 @kindex S-@key{right}
2894 @findex org-table-fedit-ref-up
2895 @findex org-table-fedit-ref-down
2896 @findex org-table-fedit-ref-left
2897 @findex org-table-fedit-ref-right
2898 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2899 Shift the reference at point. For example, if the reference is
2900 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2901 This also works for relative references and for hline references.
2902 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2903 Move the test line for column formulas in the Org buffer up and
2905 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2906 Scroll the window displaying the table.
2908 @findex org-table-toggle-coordinate-overlays
2910 Turn the coordinate grid in the table on and off.
2914 Making a table field blank does not remove the formula associated with
2915 the field, because that is stored in a different line (the @samp{#+TBLFM}
2916 line)---during the next recalculation the field will be filled again.
2917 To remove a formula from a field, you have to give an empty reply when
2918 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2921 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2922 equations with @kbd{C-c C-c} in that line or with the normal
2923 recalculation commands in the table.
2925 @subsubheading Debugging formulas
2926 @cindex formula debugging
2927 @cindex debugging, of table formulas
2928 When the evaluation of a formula leads to an error, the field content
2929 becomes the string @samp{#ERROR}. If you would like see what is going
2930 on during variable substitution and calculation in order to find a bug,
2931 turn on formula debugging in the @code{Tbl} menu and repeat the
2932 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2933 field. Detailed information will be displayed.
2935 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2936 @subsection Updating the table
2937 @cindex recomputing table fields
2938 @cindex updating, table
2940 Recalculation of a table is normally not automatic, but needs to be
2941 triggered by a command. See @ref{Advanced features}, for a way to make
2942 recalculation at least semi-automatic.
2944 In order to recalculate a line of a table or the entire table, use the
2948 @orgcmd{C-c *,org-table-recalculate}
2949 Recalculate the current row by first applying the stored column formulas
2950 from left to right, and all field/range formulas in the current row.
2956 Recompute the entire table, line by line. Any lines before the first
2957 hline are left alone, assuming that these are part of the table header.
2959 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
2960 Iterate the table by recomputing it until no further changes occur.
2961 This may be necessary if some computed fields use the value of other
2962 fields that are computed @i{later} in the calculation sequence.
2963 @item M-x org-table-recalculate-buffer-tables
2964 @findex org-table-recalculate-buffer-tables
2965 Recompute all tables in the current buffer.
2966 @item M-x org-table-iterate-buffer-tables
2967 @findex org-table-iterate-buffer-tables
2968 Iterate all tables in the current buffer, in order to converge table-to-table
2972 @node Advanced features, , Updating the table, The spreadsheet
2973 @subsection Advanced features
2975 If you want the recalculation of fields to happen automatically, or if you
2976 want to be able to assign @i{names}@footnote{Such names must start by an
2977 alphabetic character and use only alphanumeric/underscore characters.} to
2978 fields and columns, you need to reserve the first column of the table for
2979 special marking characters.
2982 @orgcmd{C-#,org-table-rotate-recalc-marks}
2983 Rotate the calculation mark in first column through the states @samp{ },
2984 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
2985 change all marks in the region.
2988 Here is an example of a table that collects exam results of students and
2989 makes use of these features:
2993 |---+---------+--------+--------+--------+-------+------|
2994 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
2995 |---+---------+--------+--------+--------+-------+------|
2996 | ! | | P1 | P2 | P3 | Tot | |
2997 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
2998 | ^ | | m1 | m2 | m3 | mt | |
2999 |---+---------+--------+--------+--------+-------+------|
3000 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3001 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3002 |---+---------+--------+--------+--------+-------+------|
3003 | | Average | | | | 25.0 | |
3004 | ^ | | | | | at | |
3005 | $ | max=50 | | | | | |
3006 |---+---------+--------+--------+--------+-------+------|
3007 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3011 @noindent @b{Important}: please note that for these special tables,
3012 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3013 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3014 to the field itself. The column formulas are not applied in rows with
3017 @cindex marking characters, tables
3018 The marking characters have the following meaning:
3021 The fields in this line define names for the columns, so that you may
3022 refer to a column as @samp{$Tot} instead of @samp{$6}.
3024 This row defines names for the fields @emph{above} the row. With such
3025 a definition, any formula in the table may use @samp{$m1} to refer to
3026 the value @samp{10}. Also, if you assign a formula to a names field, it
3027 will be stored as @samp{$name=...}.
3029 Similar to @samp{^}, but defines names for the fields in the row
3032 Fields in this row can define @emph{parameters} for formulas. For
3033 example, if a field in a @samp{$} row contains @samp{max=50}, then
3034 formulas in this table can refer to the value 50 using @samp{$max}.
3035 Parameters work exactly like constants, only that they can be defined on
3038 Fields in this row are automatically recalculated when pressing
3039 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3040 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3041 lines will be left alone by this command.
3043 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3044 not for automatic recalculation. Use this when automatic
3045 recalculation slows down editing too much.
3047 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3048 All lines that should be recalculated should be marked with @samp{#}
3051 Do not export this line. Useful for lines that contain the narrowing
3052 @samp{<N>} markers or column group markers.
3055 Finally, just to whet your appetite for what can be done with the
3056 fantastic @file{calc.el} package, here is a table that computes the Taylor
3057 series of degree @code{n} at location @code{x} for a couple of
3062 |---+-------------+---+-----+--------------------------------------|
3063 | | Func | n | x | Result |
3064 |---+-------------+---+-----+--------------------------------------|
3065 | # | exp(x) | 1 | x | 1 + x |
3066 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3067 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3068 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3069 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3070 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3071 |---+-------------+---+-----+--------------------------------------|
3072 #+TBLFM: $5=taylor($2,$4,$3);n3
3076 @node Org-Plot, , The spreadsheet, Tables
3078 @cindex graph, in tables
3079 @cindex plot tables using Gnuplot
3082 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3083 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3084 @uref{http://xafs.org/BruceRavel/GnuplotMode}. To see this in action, ensure
3085 that you have both Gnuplot and Gnuplot mode installed on your system, then
3086 call @code{org-plot/gnuplot} on the following table.
3090 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3091 | Sede | Max cites | H-index |
3092 |-----------+-----------+---------|
3093 | Chile | 257.72 | 21.39 |
3094 | Leeds | 165.77 | 19.68 |
3095 | Sao Paolo | 71.00 | 11.50 |
3096 | Stockholm | 134.19 | 14.33 |
3097 | Morelia | 257.56 | 17.67 |
3101 Notice that Org Plot is smart enough to apply the table's headers as labels.
3102 Further control over the labels, type, content, and appearance of plots can
3103 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3104 for a complete list of Org-plot options. For more information and examples
3105 see the Org-plot tutorial at
3106 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3108 @subsubheading Plot Options
3112 Specify any @command{gnuplot} option to be set when graphing.
3115 Specify the title of the plot.
3118 Specify which column of the table to use as the @code{x} axis.
3121 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3122 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3123 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3127 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3130 Specify a @code{with} option to be inserted for every col being plotted
3131 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3132 Defaults to @code{lines}.
3135 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3138 List of labels to be used for the @code{deps} (defaults to the column headers
3142 Specify an entire line to be inserted in the Gnuplot script.
3145 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3146 flat mapping rather than a @code{3d} slope.
3149 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3150 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3153 If you want total control, you can specify a script file (place the file name
3154 between double-quotes) which will be used to plot. Before plotting, every
3155 instance of @code{$datafile} in the specified script will be replaced with
3156 the path to the generated data file. Note: even if you set this option, you
3157 may still want to specify the plot type, as that can impact the content of
3161 @node Hyperlinks, TODO Items, Tables, Top
3165 Like HTML, Org provides links inside a file, external links to
3166 other files, Usenet articles, emails, and much more.
3169 * Link format:: How links in Org are formatted
3170 * Internal links:: Links to other places in the current file
3171 * External links:: URL-like links to the world
3172 * Handling links:: Creating, inserting and following
3173 * Using links outside Org:: Linking from my C source code?
3174 * Link abbreviations:: Shortcuts for writing complex links
3175 * Search options:: Linking to a specific location
3176 * Custom searches:: When the default search is not enough
3179 @node Link format, Internal links, Hyperlinks, Hyperlinks
3180 @section Link format
3182 @cindex format, of links
3184 Org will recognize plain URL-like links and activate them as
3185 clickable links. The general link format, however, looks like this:
3188 [[link][description]] @r{or alternatively} [[link]]
3192 Once a link in the buffer is complete (all brackets present), Org
3193 will change the display so that @samp{description} is displayed instead
3194 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3195 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3196 which by default is an underlined face. You can directly edit the
3197 visible part of a link. Note that this can be either the @samp{link}
3198 part (if there is no description) or the @samp{description} part. To
3199 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3202 If you place the cursor at the beginning or just behind the end of the
3203 displayed text and press @key{BACKSPACE}, you will remove the
3204 (invisible) bracket at that location. This makes the link incomplete
3205 and the internals are again displayed as plain text. Inserting the
3206 missing bracket hides the link internals again. To show the
3207 internal structure of all links, use the menu entry
3208 @code{Org->Hyperlinks->Literal links}.
3210 @node Internal links, External links, Link format, Hyperlinks
3211 @section Internal links
3212 @cindex internal links
3213 @cindex links, internal
3214 @cindex targets, for links
3216 @cindex property, CUSTOM_ID
3217 If the link does not look like a URL, it is considered to be internal in the
3218 current file. The most important case is a link like
3219 @samp{[[#my-custom-id]]} which will link to the entry with the
3220 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
3221 for HTML export (@pxref{HTML export}) where they produce pretty section
3222 links. You are responsible yourself to make sure these custom IDs are unique
3225 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3226 lead to a text search in the current file.
3228 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3229 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3230 point to the corresponding headline. The preferred match for a text link is
3231 a @i{dedicated target}: the same string in double angular brackets. Targets
3232 may be located anywhere; sometimes it is convenient to put them into a
3233 comment line. For example
3239 @noindent In HTML export (@pxref{HTML export}), such targets will become
3240 named anchors for direct access through @samp{http} links@footnote{Note that
3241 text before the first headline is usually not exported, so the first such
3242 target should be after the first headline, or in the line directly before the
3245 If no dedicated target exists, Org will search for a headline that is exactly
3246 the link text but may also include a TODO keyword and tags@footnote{To insert
3247 a link targeting a headline, in-buffer completion can be used. Just type a
3248 star followed by a few optional letters into the buffer and press
3249 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3250 completions.}. In non-Org files, the search will look for the words in the
3251 link text. In the above example the search would be for @samp{my target}.
3253 Following a link pushes a mark onto Org's own mark ring. You can
3254 return to the previous position with @kbd{C-c &}. Using this command
3255 several times in direct succession goes back to positions recorded
3259 * Radio targets:: Make targets trigger links in plain text
3262 @node Radio targets, , Internal links, Internal links
3263 @subsection Radio targets
3264 @cindex radio targets
3265 @cindex targets, radio
3266 @cindex links, radio targets
3268 Org can automatically turn any occurrences of certain target names
3269 in normal text into a link. So without explicitly creating a link, the
3270 text connects to the target radioing its position. Radio targets are
3271 enclosed by triple angular brackets. For example, a target @samp{<<<My
3272 Target>>>} causes each occurrence of @samp{my target} in normal text to
3273 become activated as a link. The Org file is scanned automatically
3274 for radio targets only when the file is first loaded into Emacs. To
3275 update the target list during editing, press @kbd{C-c C-c} with the
3276 cursor on or at a target.
3278 @node External links, Handling links, Internal links, Hyperlinks
3279 @section External links
3280 @cindex links, external
3281 @cindex external links
3282 @cindex links, external
3290 @cindex WANDERLUST links
3292 @cindex USENET links
3297 Org supports links to files, websites, Usenet and email messages,
3298 BBDB database entries and links to both IRC conversations and their
3299 logs. External links are URL-like locators. They start with a short
3300 identifying string followed by a colon. There can be no space after
3301 the colon. The following list shows examples for each link type.
3304 http://www.astro.uva.nl/~dominik @r{on the web}
3305 doi:10.1000/182 @r{DOI for an electronic resource}
3306 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3307 /home/dominik/images/jupiter.jpg @r{same as above}
3308 file:papers/last.pdf @r{file, relative path}
3309 ./papers/last.pdf @r{same as above}
3310 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3311 /myself@@some.where:papers/last.pdf @r{same as above}
3312 file:sometextfile::NNN @r{file, jump to line number}
3313 file:projects.org @r{another Org file}
3314 file:projects.org::some words @r{text search in Org file}@footnote{
3315 The actual behavior of the search will depend on the value of
3316 the variable @code{org-link-search-must-match-exact-headline}. If its value
3317 is nil, then a fuzzy text search will be done. If it is t, then only the
3318 exact headline will be matched. If the value is @code{'query-to-create},
3319 then an exact headline will be searched; if it is not found, then the user
3320 will be queried to create it.}
3321 file:projects.org::*task title @r{heading search in Org file}
3322 file+sys:/path/to/file @r{open via OS, like double-click}
3323 file+emacs:/path/to/file @r{force opening by Emacs}
3324 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3325 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3326 news:comp.emacs @r{Usenet link}
3327 mailto:adent@@galaxy.net @r{Mail link}
3328 vm:folder @r{VM folder link}
3329 vm:folder#id @r{VM message link}
3330 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3331 vm-imap:account:folder @r{VM IMAP folder link}
3332 vm-imap:account:folder#id @r{VM IMAP message link}
3333 wl:folder @r{WANDERLUST folder link}
3334 wl:folder#id @r{WANDERLUST message link}
3335 mhe:folder @r{MH-E folder link}
3336 mhe:folder#id @r{MH-E message link}
3337 rmail:folder @r{RMAIL folder link}
3338 rmail:folder#id @r{RMAIL message link}
3339 gnus:group @r{Gnus group link}
3340 gnus:group#id @r{Gnus article link}
3341 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3342 irc:/irc.com/#emacs/bob @r{IRC link}
3343 info:org#External links @r{Info node link}
3344 shell:ls *.org @r{A shell command}
3345 elisp:org-agenda @r{Interactive Elisp command}
3346 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3349 For customizing Org to add new link types @ref{Adding hyperlink types}.
3351 A link should be enclosed in double brackets and may contain a
3352 descriptive text to be displayed instead of the URL (@pxref{Link
3353 format}), for example:
3356 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3360 If the description is a file name or URL that points to an image, HTML
3361 export (@pxref{HTML export}) will inline the image as a clickable
3362 button. If there is no description at all and the link points to an
3364 that image will be inlined into the exported HTML file.
3366 @cindex square brackets, around links
3367 @cindex plain text external links
3368 Org also finds external links in the normal text and activates them
3369 as links. If spaces must be part of the link (for example in
3370 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3371 about the end of the link, enclose them in square brackets.
3373 @node Handling links, Using links outside Org, External links, Hyperlinks
3374 @section Handling links
3375 @cindex links, handling
3377 Org provides methods to create a link in the correct syntax, to
3378 insert it into an Org file, and to follow the link.
3381 @orgcmd{C-c l,org-store-link}
3382 @cindex storing links
3383 Store a link to the current location. This is a @emph{global} command (you
3384 must create the key binding yourself) which can be used in any buffer to
3385 create a link. The link will be stored for later insertion into an Org
3386 buffer (see below). What kind of link will be created depends on the current
3389 @b{Org mode buffers}@*
3390 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3391 to the target. Otherwise it points to the current headline, which will also
3392 be the description@footnote{If the headline contains a timestamp, it will be
3393 removed from the link and result in a wrong link---you should avoid putting
3394 timestamp in the headline.}.
3396 @vindex org-id-link-to-org-use-id
3397 @cindex property, CUSTOM_ID
3398 @cindex property, ID
3399 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3400 will be stored. In addition or alternatively (depending on the value of
3401 @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will
3402 be created and/or used to construct a link@footnote{The library @code{org-id}
3403 must first be loaded, either through @code{org-customize} by enabling
3404 @code{id} in @code{org-modules} , or by adding @code{(require 'org-id)} in
3405 your @file{.emacs}.}. So using this command in Org
3406 buffers will potentially create two links: a human-readable from the custom
3407 ID, and one that is globally unique and works even if the entry is moved from
3408 file to file. Later, when inserting the link, you need to decide which one
3411 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3412 Pretty much all Emacs mail clients are supported. The link will point to the
3413 current article, or, in some GNUS buffers, to the group. The description is
3414 constructed from the author and the subject.
3416 @b{Web browsers: W3 and W3M}@*
3417 Here the link will be the current URL, with the page title as description.
3419 @b{Contacts: BBDB}@*
3420 Links created in a BBDB buffer will point to the current entry.
3423 @vindex org-irc-link-to-logs
3424 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3425 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3426 the current conversation is created. Otherwise an @samp{irc:/} style link to
3427 the user/channel/server under the point will be stored.
3430 For any other files, the link will point to the file, with a search string
3431 (@pxref{Search options}) pointing to the contents of the current line. If
3432 there is an active region, the selected words will form the basis of the
3433 search string. If the automatically created link is not working correctly or
3434 accurately enough, you can write custom functions to select the search string
3435 and to do the search for particular file types---see @ref{Custom searches}.
3436 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3439 When the cursor is in an agenda view, the created link points to the
3440 entry referenced by the current line.
3443 @orgcmd{C-c C-l,org-insert-link}
3444 @cindex link completion
3445 @cindex completion, of links
3446 @cindex inserting links
3447 @vindex org-keep-stored-link-after-insertion
3448 Insert a link@footnote{ Note that you don't have to use this command to
3449 insert a link. Links in Org are plain text, and you can type or paste them
3450 straight into the buffer. By using this command, the links are automatically
3451 enclosed in double brackets, and you will be asked for the optional
3452 descriptive text.}. This prompts for a link to be inserted into the buffer.
3453 You can just type a link, using text for an internal link, or one of the link
3454 type prefixes mentioned in the examples above. The link will be inserted
3455 into the buffer@footnote{After insertion of a stored link, the link will be
3456 removed from the list of stored links. To keep it in the list later use, use
3457 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3458 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3459 If some text was selected when this command is called, the selected text
3460 becomes the default description.
3462 @b{Inserting stored links}@*
3463 All links stored during the
3464 current session are part of the history for this prompt, so you can access
3465 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3467 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3468 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3469 defined through link abbreviations (@pxref{Link abbreviations}). If you
3470 press @key{RET} after inserting only the @var{prefix}, Org will offer
3471 specific completion support for some link types@footnote{This works by
3472 calling a special function @code{org-PREFIX-complete-link}.} For
3473 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3474 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3475 @key{RET}} you can complete contact names.
3477 @cindex file name completion
3478 @cindex completion, of file names
3479 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3480 a file will be inserted and you may use file name completion to select
3481 the name of the file. The path to the file is inserted relative to the
3482 directory of the current Org file, if the linked file is in the current
3483 directory or in a sub-directory of it, or if the path is written relative
3484 to the current directory using @samp{../}. Otherwise an absolute path
3485 is used, if possible with @samp{~/} for your home directory. You can
3486 force an absolute path with two @kbd{C-u} prefixes.
3488 @item C-c C-l @ @r{(with cursor on existing link)}
3489 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3490 link and description parts of the link.
3492 @cindex following links
3493 @orgcmd{C-c C-o,org-open-at-point}
3494 @vindex org-file-apps
3495 @vindex org-link-frame-setup
3496 Open link at point. This will launch a web browser for URLs (using
3497 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3498 the corresponding links, and execute the command in a shell link. When the
3499 cursor is on an internal link, this command runs the corresponding search.
3500 When the cursor is on a TAG list in a headline, it creates the corresponding
3501 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3502 date. Furthermore, it will visit text and remote files in @samp{file:} links
3503 with Emacs and select a suitable application for local non-text files.
3504 Classification of files is based on file extension only. See option
3505 @code{org-file-apps}. If you want to override the default application and
3506 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3507 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3508 If the cursor is on a headline, but not on a link, offer all links in the
3509 headline and entry text. If you want to setup the frame configuration for
3510 following links, customize @code{org-link-frame-setup}.
3513 @vindex org-return-follows-link
3514 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3521 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3522 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3526 @vindex org-display-internal-link-with-indirect-buffer
3527 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3528 internal links to be displayed in another window@footnote{See the
3529 variable @code{org-display-internal-link-with-indirect-buffer}}.
3531 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3532 @cindex inlining images
3533 @cindex images, inlining
3534 @vindex org-startup-with-inline-images
3535 @cindex @code{inlineimages}, STARTUP keyword
3536 @cindex @code{noinlineimages}, STARTUP keyword
3537 Toggle the inline display of linked images. Normally this will only inline
3538 images that have no description part in the link, i.e., images that will also
3539 be inlined during export. When called with a prefix argument, also display
3540 images that do have a link description. You can ask for inline images to be
3541 displayed at startup by configuring the variable
3542 @code{org-startup-with-inline-images}@footnote{with corresponding
3543 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3544 @orgcmd{C-c %,org-mark-ring-push}
3546 Push the current position onto the mark ring, to be able to return
3547 easily. Commands following an internal link do this automatically.
3549 @orgcmd{C-c &,org-mark-ring-goto}
3550 @cindex links, returning to
3551 Jump back to a recorded position. A position is recorded by the
3552 commands following internal links, and by @kbd{C-c %}. Using this
3553 command several times in direct succession moves through a ring of
3554 previously recorded positions.
3556 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3557 @cindex links, finding next/previous
3558 Move forward/backward to the next link in the buffer. At the limit of
3559 the buffer, the search fails once, and then wraps around. The key
3560 bindings for this are really too long; you might want to bind this also
3561 to @kbd{C-n} and @kbd{C-p}
3563 (add-hook 'org-load-hook
3565 (define-key org-mode-map "\C-n" 'org-next-link)
3566 (define-key org-mode-map "\C-p" 'org-previous-link)))
3570 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3571 @section Using links outside Org
3573 You can insert and follow links that have Org syntax not only in
3574 Org, but in any Emacs buffer. For this, you should create two
3575 global commands, like this (please select suitable global keys
3579 (global-set-key "\C-c L" 'org-insert-link-global)
3580 (global-set-key "\C-c o" 'org-open-at-point-global)
3583 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3584 @section Link abbreviations
3585 @cindex link abbreviations
3586 @cindex abbreviation, links
3588 Long URLs can be cumbersome to type, and often many similar links are
3589 needed in a document. For this you can use link abbreviations. An
3590 abbreviated link looks like this
3593 [[linkword:tag][description]]
3597 @vindex org-link-abbrev-alist
3598 where the tag is optional.
3599 The @i{linkword} must be a word, starting with a letter, followed by
3600 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3601 according to the information in the variable @code{org-link-abbrev-alist}
3602 that relates the linkwords to replacement text. Here is an example:
3606 (setq org-link-abbrev-alist
3607 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3608 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3609 ("google" . "http://www.google.com/search?q=")
3610 ("gmap" . "http://maps.google.com/maps?q=%s")
3611 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3612 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3616 If the replacement text contains the string @samp{%s}, it will be
3617 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3618 url-encode the tag (see the example above, where we need to encode
3619 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3620 to a custom function, and replace it by the resulting string.
3622 If the replacement text don't contain any specifier, it will simply
3623 be appended to the string in order to create the link.
3625 Instead of a string, you may also specify a function that will be
3626 called with the tag as the only argument to create the link.
3628 With the above setting, you could link to a specific bug with
3629 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3630 @code{[[google:OrgMode]]}, show the map location of the Free Software
3631 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3632 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3633 what the Org author is doing besides Emacs hacking with
3634 @code{[[ads:Dominik,C]]}.
3636 If you need special abbreviations just for a single Org buffer, you
3637 can define them in the file with
3641 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3642 #+LINK: google http://www.google.com/search?q=%s
3646 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3647 complete link abbreviations. You may also define a function
3648 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3649 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3650 not accept any arguments, and return the full link with prefix.
3652 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3653 @section Search options in file links
3654 @cindex search option in file links
3655 @cindex file links, searching
3657 File links can contain additional information to make Emacs jump to a
3658 particular location in the file when following a link. This can be a
3659 line number or a search option after a double@footnote{For backward
3660 compatibility, line numbers can also follow a single colon.} colon. For
3661 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3662 links}) to a file, it encodes the words in the current line as a search
3663 string that can be used to find this line back later when following the
3664 link with @kbd{C-c C-o}.
3666 Here is the syntax of the different ways to attach a search to a file
3667 link, together with an explanation:
3670 [[file:~/code/main.c::255]]
3671 [[file:~/xx.org::My Target]]
3672 [[file:~/xx.org::*My Target]]
3673 [[file:~/xx.org::#my-custom-id]]
3674 [[file:~/xx.org::/regexp/]]
3681 Search for a link target @samp{<<My Target>>}, or do a text search for
3682 @samp{my target}, similar to the search in internal links, see
3683 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3684 link will become a HTML reference to the corresponding named anchor in
3687 In an Org file, restrict search to headlines.
3689 Link to a heading with a @code{CUSTOM_ID} property
3691 Do a regular expression search for @code{regexp}. This uses the Emacs
3692 command @code{occur} to list all matches in a separate window. If the
3693 target file is in Org mode, @code{org-occur} is used to create a
3694 sparse tree with the matches.
3695 @c If the target file is a directory,
3696 @c @code{grep} will be used to search all files in the directory.
3699 As a degenerate case, a file link with an empty file name can be used
3700 to search the current file. For example, @code{[[file:::find me]]} does
3701 a search for @samp{find me} in the current file, just as
3702 @samp{[[find me]]} would.
3704 @node Custom searches, , Search options, Hyperlinks
3705 @section Custom Searches
3706 @cindex custom search strings
3707 @cindex search strings, custom
3709 The default mechanism for creating search strings and for doing the
3710 actual search related to a file link may not work correctly in all
3711 cases. For example, Bib@TeX{} database files have many entries like
3712 @samp{year="1993"} which would not result in good search strings,
3713 because the only unique identification for a Bib@TeX{} entry is the
3716 @vindex org-create-file-search-functions
3717 @vindex org-execute-file-search-functions
3718 If you come across such a problem, you can write custom functions to set
3719 the right search string for a particular file type, and to do the search
3720 for the string in the file. Using @code{add-hook}, these functions need
3721 to be added to the hook variables
3722 @code{org-create-file-search-functions} and
3723 @code{org-execute-file-search-functions}. See the docstring for these
3724 variables for more information. Org actually uses this mechanism
3725 for Bib@TeX{} database files, and you can use the corresponding code as
3726 an implementation example. See the file @file{org-bibtex.el}.
3728 @node TODO Items, Tags, Hyperlinks, Top
3732 Org mode does not maintain TODO lists as separate documents@footnote{Of
3733 course, you can make a document that contains only long lists of TODO items,
3734 but this is not required.}. Instead, TODO items are an integral part of the
3735 notes file, because TODO items usually come up while taking notes! With Org
3736 mode, simply mark any entry in a tree as being a TODO item. In this way,
3737 information is not duplicated, and the entire context from which the TODO
3738 item emerged is always present.
3740 Of course, this technique for managing TODO items scatters them
3741 throughout your notes file. Org mode compensates for this by providing
3742 methods to give you an overview of all the things that you have to do.
3745 * TODO basics:: Marking and displaying TODO entries
3746 * TODO extensions:: Workflow and assignments
3747 * Progress logging:: Dates and notes for progress
3748 * Priorities:: Some things are more important than others
3749 * Breaking down tasks:: Splitting a task into manageable pieces
3750 * Checkboxes:: Tick-off lists
3753 @node TODO basics, TODO extensions, TODO Items, TODO Items
3754 @section Basic TODO functionality
3756 Any headline becomes a TODO item when it starts with the word
3757 @samp{TODO}, for example:
3760 *** TODO Write letter to Sam Fortune
3764 The most important commands to work with TODO entries are:
3767 @orgcmd{C-c C-t,org-todo}
3768 @cindex cycling, of TODO states
3769 @vindex org-use-fast-todo-selection
3771 Rotate the TODO state of the current item among
3774 ,-> (unmarked) -> TODO -> DONE --.
3775 '--------------------------------'
3778 If TODO keywords have fast access keys (see @ref{Fast access to TODO
3779 states}), you will be prompted for a TODO keyword through the fast selection
3780 interface; this is the default behavior when
3781 @var{org-use-fast-todo-selection} is @code{non-nil}.
3783 The same rotation can also be done ``remotely'' from the timeline and agenda
3784 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3786 @orgkey{C-u C-c C-t}
3787 When TODO keywords have no selection keys, select a specific keyword using
3788 completion; otherwise force cycling through TODO states with no prompt. When
3789 @var{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
3790 selection interface.
3792 @kindex S-@key{right}
3793 @kindex S-@key{left}
3794 @item S-@key{right} @ @r{/} @ S-@key{left}
3795 @vindex org-treat-S-cursor-todo-selection-as-state-change
3796 Select the following/preceding TODO state, similar to cycling. Useful
3797 mostly if more than two TODO states are possible (@pxref{TODO
3798 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3799 with @code{shift-selection-mode}. See also the variable
3800 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3801 @orgcmd{C-c / t,org-show-todo-tree}
3802 @cindex sparse tree, for TODO
3803 @vindex org-todo-keywords
3804 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3805 entire buffer, but shows all TODO items (with not-DONE state) and the
3806 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3807 / T}), search for a specific TODO@. You will be prompted for the keyword, and
3808 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3809 entries that match any one of these keywords. With a numeric prefix argument
3810 N, show the tree for the Nth keyword in the variable
3811 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3812 both un-done and done.
3813 @orgcmd{C-c a t,org-todo-list}
3814 Show the global TODO list. Collects the TODO items (with not-DONE states)
3815 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3816 buffer will be in @code{agenda-mode}, which provides commands to examine and
3817 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3818 @xref{Global TODO list}, for more information.
3819 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3820 Insert a new TODO entry below the current one.
3824 @vindex org-todo-state-tags-triggers
3825 Changing a TODO state can also trigger tag changes. See the docstring of the
3826 option @code{org-todo-state-tags-triggers} for details.
3828 @node TODO extensions, Progress logging, TODO basics, TODO Items
3829 @section Extended use of TODO keywords
3830 @cindex extended TODO keywords
3832 @vindex org-todo-keywords
3833 By default, marked TODO entries have one of only two states: TODO and
3834 DONE@. Org mode allows you to classify TODO items in more complex ways
3835 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3836 special setup, the TODO keyword system can work differently in different
3839 Note that @i{tags} are another way to classify headlines in general and
3840 TODO items in particular (@pxref{Tags}).
3843 * Workflow states:: From TODO to DONE in steps
3844 * TODO types:: I do this, Fred does the rest
3845 * Multiple sets in one file:: Mixing it all, and still finding your way
3846 * Fast access to TODO states:: Single letter selection of a state
3847 * Per-file keywords:: Different files, different requirements
3848 * Faces for TODO keywords:: Highlighting states
3849 * TODO dependencies:: When one task needs to wait for others
3852 @node Workflow states, TODO types, TODO extensions, TODO extensions
3853 @subsection TODO keywords as workflow states
3854 @cindex TODO workflow
3855 @cindex workflow states as TODO keywords
3857 You can use TODO keywords to indicate different @emph{sequential} states
3858 in the process of working on an item, for example@footnote{Changing
3859 this variable only becomes effective after restarting Org mode in a
3863 (setq org-todo-keywords
3864 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3867 The vertical bar separates the TODO keywords (states that @emph{need
3868 action}) from the DONE states (which need @emph{no further action}). If
3869 you don't provide the separator bar, the last state is used as the DONE
3871 @cindex completion, of TODO keywords
3872 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3873 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
3874 also use a numeric prefix argument to quickly select a specific state. For
3875 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
3876 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3877 define many keywords, you can use in-buffer completion
3878 (@pxref{Completion}) or even a special one-key selection scheme
3879 (@pxref{Fast access to TODO states}) to insert these words into the
3880 buffer. Changing a TODO state can be logged with a timestamp, see
3881 @ref{Tracking TODO state changes}, for more information.
3883 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3884 @subsection TODO keywords as types
3886 @cindex names as TODO keywords
3887 @cindex types as TODO keywords
3889 The second possibility is to use TODO keywords to indicate different
3890 @emph{types} of action items. For example, you might want to indicate
3891 that items are for ``work'' or ``home''. Or, when you work with several
3892 people on a single project, you might want to assign action items
3893 directly to persons, by using their names as TODO keywords. This would
3894 be set up like this:
3897 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3900 In this case, different keywords do not indicate a sequence, but rather
3901 different types. So the normal work flow would be to assign a task to a
3902 person, and later to mark it DONE@. Org mode supports this style by adapting
3903 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3904 @kbd{t} command in the timeline and agenda buffers.}. When used several
3905 times in succession, it will still cycle through all names, in order to first
3906 select the right type for a task. But when you return to the item after some
3907 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3908 to DONE@. Use prefix arguments or completion to quickly select a specific
3909 name. You can also review the items of a specific TODO type in a sparse tree
3910 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3911 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3912 from all agenda files into a single buffer, you would use the numeric prefix
3913 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3915 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3916 @subsection Multiple keyword sets in one file
3917 @cindex TODO keyword sets
3919 Sometimes you may want to use different sets of TODO keywords in
3920 parallel. For example, you may want to have the basic
3921 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3922 separate state indicating that an item has been canceled (so it is not
3923 DONE, but also does not require action). Your setup would then look
3927 (setq org-todo-keywords
3928 '((sequence "TODO" "|" "DONE")
3929 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3930 (sequence "|" "CANCELED")))
3933 The keywords should all be different, this helps Org mode to keep track
3934 of which subsequence should be used for a given entry. In this setup,
3935 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3936 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3937 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3938 select the correct sequence. Besides the obvious ways like typing a
3939 keyword or using completion, you may also apply the following commands:
3942 @kindex C-S-@key{right}
3943 @kindex C-S-@key{left}
3944 @kindex C-u C-u C-c C-t
3945 @item C-u C-u C-c C-t
3946 @itemx C-S-@key{right}
3947 @itemx C-S-@key{left}
3948 These keys jump from one TODO subset to the next. In the above example,
3949 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3950 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3951 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3952 @code{shift-selection-mode} (@pxref{Conflicts}).
3953 @kindex S-@key{right}
3954 @kindex S-@key{left}
3957 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
3958 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
3959 from @code{DONE} to @code{REPORT} in the example above. See also
3960 @ref{Conflicts}, for a discussion of the interaction with
3961 @code{shift-selection-mode}.
3964 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
3965 @subsection Fast access to TODO states
3967 If you would like to quickly change an entry to an arbitrary TODO state
3968 instead of cycling through the states, you can set up keys for single-letter
3969 access to the states. This is done by adding the selection character after
3970 each keyword, in parentheses@footnote{All characters are allowed except
3971 @code{@@^!}, which have a special meaning here.}. For example:
3974 (setq org-todo-keywords
3975 '((sequence "TODO(t)" "|" "DONE(d)")
3976 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
3977 (sequence "|" "CANCELED(c)")))
3980 @vindex org-fast-tag-selection-include-todo
3981 If you then press @kbd{C-c C-t} followed by the selection key, the entry
3982 will be switched to this state. @kbd{SPC} can be used to remove any TODO
3983 keyword from an entry.@footnote{Check also the variable
3984 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
3985 state through the tags interface (@pxref{Setting tags}), in case you like to
3986 mingle the two concepts. Note that this means you need to come up with
3987 unique keys across both sets of keywords.}
3989 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
3990 @subsection Setting up keywords for individual files
3991 @cindex keyword options
3992 @cindex per-file keywords
3997 It can be very useful to use different aspects of the TODO mechanism in
3998 different files. For file-local settings, you need to add special lines
3999 to the file which set the keywords and interpretation for that file
4000 only. For example, to set one of the two examples discussed above, you
4001 need one of the following lines, starting in column zero anywhere in the
4005 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4007 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4008 interpretation, but it means the same as @code{#+TODO}), or
4010 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4013 A setup for using several sets in parallel would be:
4017 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4021 @cindex completion, of option keywords
4023 @noindent To make sure you are using the correct keyword, type
4024 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4026 @cindex DONE, final TODO keyword
4027 Remember that the keywords after the vertical bar (or the last keyword
4028 if no bar is there) must always mean that the item is DONE (although you
4029 may use a different word). After changing one of these lines, use
4030 @kbd{C-c C-c} with the cursor still in the line to make the changes
4031 known to Org mode@footnote{Org mode parses these lines only when
4032 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
4033 cursor in a line starting with @samp{#+} is simply restarting Org mode
4034 for the current buffer.}.
4036 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
4037 @subsection Faces for TODO keywords
4038 @cindex faces, for TODO keywords
4040 @vindex org-todo @r{(face)}
4041 @vindex org-done @r{(face)}
4042 @vindex org-todo-keyword-faces
4043 Org mode highlights TODO keywords with special faces: @code{org-todo}
4044 for keywords indicating that an item still has to be acted upon, and
4045 @code{org-done} for keywords indicating that an item is finished. If
4046 you are using more than 2 different states, you might want to use
4047 special faces for some of them. This can be done using the variable
4048 @code{org-todo-keyword-faces}. For example:
4052 (setq org-todo-keyword-faces
4053 '(("TODO" . org-warning) ("STARTED" . "yellow")
4054 ("CANCELED" . (:foreground "blue" :weight bold))))
4058 While using a list with face properties as shown for CANCELED @emph{should}
4059 work, this does not always seem to be the case. If necessary, define a
4060 special face and use that. A string is interpreted as a color. The variable
4061 @code{org-faces-easy-properties} determines if that color is interpreted as a
4062 foreground or a background color.
4064 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
4065 @subsection TODO dependencies
4066 @cindex TODO dependencies
4067 @cindex dependencies, of TODO states
4069 @vindex org-enforce-todo-dependencies
4070 @cindex property, ORDERED
4071 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4072 dependencies. Usually, a parent TODO task should not be marked DONE until
4073 all subtasks (defined as children tasks) are marked as DONE@. And sometimes
4074 there is a logical sequence to a number of (sub)tasks, so that one task
4075 cannot be acted upon before all siblings above it are done. If you customize
4076 the variable @code{org-enforce-todo-dependencies}, Org will block entries
4077 from changing state to DONE while they have children that are not DONE@.
4078 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4079 will be blocked until all earlier siblings are marked DONE@. Here is an
4083 * TODO Blocked until (two) is done
4092 ** TODO b, needs to wait for (a)
4093 ** TODO c, needs to wait for (a) and (b)
4097 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4098 @vindex org-track-ordered-property-with-tag
4099 @cindex property, ORDERED
4100 Toggle the @code{ORDERED} property of the current entry. A property is used
4101 for this behavior because this should be local to the current entry, not
4102 inherited like a tag. However, if you would like to @i{track} the value of
4103 this property with a tag for better visibility, customize the variable
4104 @code{org-track-ordered-property-with-tag}.
4105 @orgkey{C-u C-u C-u C-c C-t}
4106 Change TODO state, circumventing any state blocking.
4109 @vindex org-agenda-dim-blocked-tasks
4110 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
4111 that cannot be closed because of such dependencies will be shown in a dimmed
4112 font or even made invisible in agenda views (@pxref{Agenda Views}).
4114 @cindex checkboxes and TODO dependencies
4115 @vindex org-enforce-todo-dependencies
4116 You can also block changes of TODO states by looking at checkboxes
4117 (@pxref{Checkboxes}). If you set the variable
4118 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4119 checkboxes will be blocked from switching to DONE.
4121 If you need more complex dependency structures, for example dependencies
4122 between entries in different trees or files, check out the contributed
4123 module @file{org-depend.el}.
4126 @node Progress logging, Priorities, TODO extensions, TODO Items
4127 @section Progress logging
4128 @cindex progress logging
4129 @cindex logging, of progress
4131 Org mode can automatically record a timestamp and possibly a note when
4132 you mark a TODO item as DONE, or even each time you change the state of
4133 a TODO item. This system is highly configurable; settings can be on a
4134 per-keyword basis and can be localized to a file or even a subtree. For
4135 information on how to clock working time for a task, see @ref{Clocking
4139 * Closing items:: When was this entry marked DONE?
4140 * Tracking TODO state changes:: When did the status change?
4141 * Tracking your habits:: How consistent have you been?
4144 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4145 @subsection Closing items
4147 The most basic logging is to keep track of @emph{when} a certain TODO
4148 item was finished. This is achieved with@footnote{The corresponding
4149 in-buffer setting is: @code{#+STARTUP: logdone}}
4152 (setq org-log-done 'time)
4156 Then each time you turn an entry from a TODO (not-done) state into any
4157 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
4158 just after the headline. If you turn the entry back into a TODO item
4159 through further state cycling, that line will be removed again. If you
4160 want to record a note along with the timestamp, use@footnote{The
4161 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4164 (setq org-log-done 'note)
4168 You will then be prompted for a note, and that note will be stored below
4169 the entry with a @samp{Closing Note} heading.
4171 In the timeline (@pxref{Timeline}) and in the agenda
4172 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4173 display the TODO items with a @samp{CLOSED} timestamp on each day,
4174 giving you an overview of what has been done.
4176 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4177 @subsection Tracking TODO state changes
4178 @cindex drawer, for state change recording
4180 @vindex org-log-states-order-reversed
4181 @vindex org-log-into-drawer
4182 @cindex property, LOG_INTO_DRAWER
4183 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4184 might want to keep track of when a state change occurred and maybe take a
4185 note about this change. You can either record just a timestamp, or a
4186 time-stamped note for a change. These records will be inserted after the
4187 headline as an itemized list, newest first@footnote{See the variable
4188 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4189 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4190 Customize the variable @code{org-log-into-drawer} to get this behavior---the
4191 recommended drawer for this is called @code{LOGBOOK}@footnote{Note that the
4192 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4193 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4194 overrule the setting of this variable for a subtree by setting a
4195 @code{LOG_INTO_DRAWER} property.
4197 Since it is normally too much to record a note for every state, Org mode
4198 expects configuration on a per-keyword basis for this. This is achieved by
4199 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4200 with timestamp) in parentheses after each keyword. For example, with the
4204 (setq org-todo-keywords
4205 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4208 To record a timestamp without a note for TODO keywords configured with
4209 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4212 @vindex org-log-done
4213 you not only define global TODO keywords and fast access keys, but also
4214 request that a time is recorded when the entry is set to
4215 DONE@footnote{It is possible that Org mode will record two timestamps
4216 when you are using both @code{org-log-done} and state change logging.
4217 However, it will never prompt for two notes---if you have configured
4218 both, the state change recording note will take precedence and cancel
4219 the @samp{Closing Note}.}, and that a note is recorded when switching to
4220 WAIT or CANCELED@. The setting for WAIT is even more special: the
4221 @samp{!} after the slash means that in addition to the note taken when
4222 entering the state, a timestamp should be recorded when @i{leaving} the
4223 WAIT state, if and only if the @i{target} state does not configure
4224 logging for entering it. So it has no effect when switching from WAIT
4225 to DONE, because DONE is configured to record a timestamp only. But
4226 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4227 setting now triggers a timestamp even though TODO has no logging
4230 You can use the exact same syntax for setting logging preferences local
4233 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4236 @cindex property, LOGGING
4237 In order to define logging settings that are local to a subtree or a
4238 single item, define a LOGGING property in this entry. Any non-empty
4239 LOGGING property resets all logging settings to nil. You may then turn
4240 on logging for this specific tree using STARTUP keywords like
4241 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4242 settings like @code{TODO(!)}. For example
4245 * TODO Log each state with only a time
4247 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4249 * TODO Only log when switching to WAIT, and when repeating
4251 :LOGGING: WAIT(@@) logrepeat
4253 * TODO No logging at all
4259 @node Tracking your habits, , Tracking TODO state changes, Progress logging
4260 @subsection Tracking your habits
4263 Org has the ability to track the consistency of a special category of TODOs,
4264 called ``habits''. A habit has the following properties:
4268 You have enabled the @code{habits} module by customizing the variable
4271 The habit is a TODO item, with a TODO keyword representing an open state.
4273 The property @code{STYLE} is set to the value @code{habit}.
4275 The TODO has a scheduled date, usually with a @code{.+} style repeat
4276 interval. A @code{++} style may be appropriate for habits with time
4277 constraints, e.g., must be done on weekends, or a @code{+} style for an
4278 unusual habit that can have a backlog, e.g., weekly reports.
4280 The TODO may also have minimum and maximum ranges specified by using the
4281 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4282 three days, but at most every two days.
4284 You must also have state logging for the @code{DONE} state enabled
4285 (@pxref{Tracking TODO state changes}), in order for historical data to be
4286 represented in the consistency graph. If it is not enabled it is not an
4287 error, but the consistency graphs will be largely meaningless.
4290 To give you an idea of what the above rules look like in action, here's an
4291 actual habit with some history:
4295 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4296 - State "DONE" from "TODO" [2009-10-15 Thu]
4297 - State "DONE" from "TODO" [2009-10-12 Mon]
4298 - State "DONE" from "TODO" [2009-10-10 Sat]
4299 - State "DONE" from "TODO" [2009-10-04 Sun]
4300 - State "DONE" from "TODO" [2009-10-02 Fri]
4301 - State "DONE" from "TODO" [2009-09-29 Tue]
4302 - State "DONE" from "TODO" [2009-09-25 Fri]
4303 - State "DONE" from "TODO" [2009-09-19 Sat]
4304 - State "DONE" from "TODO" [2009-09-16 Wed]
4305 - State "DONE" from "TODO" [2009-09-12 Sat]
4308 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4312 What this habit says is: I want to shave at most every 2 days (given by the
4313 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4314 today is the 15th, then the habit first appears in the agenda on Oct 17,
4315 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4316 after four days have elapsed.
4318 What's really useful about habits is that they are displayed along with a
4319 consistency graph, to show how consistent you've been at getting that task
4320 done in the past. This graph shows every day that the task was done over the
4321 past three weeks, with colors for each day. The colors used are:
4325 If the task wasn't to be done yet on that day.
4327 If the task could have been done on that day.
4329 If the task was going to be overdue the next day.
4331 If the task was overdue on that day.
4334 In addition to coloring each day, the day is also marked with an asterisk if
4335 the task was actually done that day, and an exclamation mark to show where
4336 the current day falls in the graph.
4338 There are several configuration variables that can be used to change the way
4339 habits are displayed in the agenda.
4342 @item org-habit-graph-column
4343 The buffer column at which the consistency graph should be drawn. This will
4344 overwrite any text in that column, so it is a good idea to keep your habits'
4345 titles brief and to the point.
4346 @item org-habit-preceding-days
4347 The amount of history, in days before today, to appear in consistency graphs.
4348 @item org-habit-following-days
4349 The number of days after today that will appear in consistency graphs.
4350 @item org-habit-show-habits-only-for-today
4351 If non-nil, only show habits in today's agenda view. This is set to true by
4355 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4356 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4357 bring them back. They are also subject to tag filtering, if you have habits
4358 which should only be done in certain contexts, for example.
4360 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4364 If you use Org mode extensively, you may end up with enough TODO items that
4365 it starts to make sense to prioritize them. Prioritizing can be done by
4366 placing a @emph{priority cookie} into the headline of a TODO item, like this
4369 *** TODO [#A] Write letter to Sam Fortune
4373 @vindex org-priority-faces
4374 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4375 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4376 treated just like priority @samp{B}. Priorities make a difference only for
4377 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4378 have no inherent meaning to Org mode. The cookies can be highlighted with
4379 special faces by customizing the variable @code{org-priority-faces}.
4381 Priorities can be attached to any outline node; they do not need to be TODO
4387 @findex org-priority
4388 Set the priority of the current headline (@command{org-priority}). The
4389 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4390 When you press @key{SPC} instead, the priority cookie is removed from the
4391 headline. The priorities can also be changed ``remotely'' from the timeline
4392 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4394 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4395 @vindex org-priority-start-cycle-with-default
4396 Increase/decrease priority of current headline@footnote{See also the option
4397 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4398 also used to modify timestamps (@pxref{Creating timestamps}). See also
4399 @ref{Conflicts}, for a discussion of the interaction with
4400 @code{shift-selection-mode}.
4403 @vindex org-highest-priority
4404 @vindex org-lowest-priority
4405 @vindex org-default-priority
4406 You can change the range of allowed priorities by setting the variables
4407 @code{org-highest-priority}, @code{org-lowest-priority}, and
4408 @code{org-default-priority}. For an individual buffer, you may set
4409 these values (highest, lowest, default) like this (please make sure that
4410 the highest priority is earlier in the alphabet than the lowest
4413 @cindex #+PRIORITIES
4418 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4419 @section Breaking tasks down into subtasks
4420 @cindex tasks, breaking down
4421 @cindex statistics, for TODO items
4423 @vindex org-agenda-todo-list-sublevels
4424 It is often advisable to break down large tasks into smaller, manageable
4425 subtasks. You can do this by creating an outline tree below a TODO item,
4426 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4427 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4428 the overview over the fraction of subtasks that are already completed, insert
4429 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4430 be updated each time the TODO status of a child changes, or when pressing
4431 @kbd{C-c C-c} on the cookie. For example:
4434 * Organize Party [33%]
4435 ** TODO Call people [1/2]
4439 ** DONE Talk to neighbor
4442 @cindex property, COOKIE_DATA
4443 If a heading has both checkboxes and TODO children below it, the meaning of
4444 the statistics cookie become ambiguous. Set the property
4445 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4448 @vindex org-hierarchical-todo-statistics
4449 If you would like to have the statistics cookie count any TODO entries in the
4450 subtree (not just direct children), configure the variable
4451 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4452 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4456 * Parent capturing statistics [2/20]
4458 :COOKIE_DATA: todo recursive
4462 If you would like a TODO entry to automatically change to DONE
4463 when all children are done, you can use the following setup:
4466 (defun org-summary-todo (n-done n-not-done)
4467 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4468 (let (org-log-done org-log-states) ; turn off logging
4469 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4471 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4475 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4476 large number of subtasks (@pxref{Checkboxes}).
4479 @node Checkboxes, , Breaking down tasks, TODO Items
4483 @vindex org-list-automatic-rules
4484 Every item in a plain list@footnote{With the exception of description
4485 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4486 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4487 it with the string @samp{[ ]}. This feature is similar to TODO items
4488 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4489 in the global TODO list, so they are often great to split a task into a
4490 number of simple steps. Or you can use them in a shopping list. To toggle a
4491 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4492 @file{org-mouse.el}).
4494 Here is an example of a checkbox list.
4497 * TODO Organize party [2/4]
4498 - [-] call people [1/3]
4503 - [ ] think about what music to play
4504 - [X] talk to the neighbors
4507 Checkboxes work hierarchically, so if a checkbox item has children that
4508 are checkboxes, toggling one of the children checkboxes will make the
4509 parent checkbox reflect if none, some, or all of the children are
4512 @cindex statistics, for checkboxes
4513 @cindex checkbox statistics
4514 @cindex property, COOKIE_DATA
4515 @vindex org-hierarchical-checkbox-statistics
4516 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4517 indicating how many checkboxes present in this entry have been checked off,
4518 and the total number of checkboxes present. This can give you an idea on how
4519 many checkboxes remain, even without opening a folded entry. The cookies can
4520 be placed into a headline or into (the first line of) a plain list item.
4521 Each cookie covers checkboxes of direct children structurally below the
4522 headline/item on which the cookie appears@footnote{Set the variable
4523 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4524 count all checkboxes below the cookie, not just those belonging to direct
4525 children.}. You have to insert the cookie yourself by typing either
4526 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4527 result, as in the examples above. With @samp{[%]} you get information about
4528 the percentage of checkboxes checked (in the above example, this would be
4529 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4530 count either checkboxes below the heading or TODO states of children, and it
4531 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4532 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4534 @cindex blocking, of checkboxes
4535 @cindex checkbox blocking
4536 @cindex property, ORDERED
4537 If the current outline node has an @code{ORDERED} property, checkboxes must
4538 be checked off in sequence, and an error will be thrown if you try to check
4539 off a box while there are unchecked boxes above it.
4541 @noindent The following commands work with checkboxes:
4544 @orgcmd{C-c C-c,org-toggle-checkbox}
4545 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4546 With a single prefix argument, add an empty checkbox or remove the current
4547 one@footnote{@kbd{C-u C-c C-c} on the @emph{first} item of a list with no checkbox
4548 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4549 considered to be an intermediate state.
4550 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4551 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4552 double prefix argument, set it to @samp{[-]}, which is considered to be an
4556 If there is an active region, toggle the first checkbox in the region
4557 and set all remaining boxes to the same status as the first. With a prefix
4558 arg, add or remove the checkbox for all items in the region.
4560 If the cursor is in a headline, toggle checkboxes in the region between
4561 this headline and the next (so @emph{not} the entire subtree).
4563 If there is no active region, just toggle the checkbox at point.
4565 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4566 Insert a new item with a checkbox. This works only if the cursor is already
4567 in a plain list item (@pxref{Plain lists}).
4568 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4569 @vindex org-track-ordered-property-with-tag
4570 @cindex property, ORDERED
4571 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4572 be checked off in sequence. A property is used for this behavior because
4573 this should be local to the current entry, not inherited like a tag.
4574 However, if you would like to @i{track} the value of this property with a tag
4575 for better visibility, customize the variable
4576 @code{org-track-ordered-property-with-tag}.
4577 @orgcmd{C-c #,org-update-statistics-cookies}
4578 Update the statistics cookie in the current outline entry. When called with
4579 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4580 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4581 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4582 changing TODO states. If you delete boxes/entries or add/change them by
4583 hand, use this command to get things back into sync.
4586 @node Tags, Properties and Columns, TODO Items, Top
4589 @cindex headline tagging
4590 @cindex matching, tags
4591 @cindex sparse tree, tag based
4593 An excellent way to implement labels and contexts for cross-correlating
4594 information is to assign @i{tags} to headlines. Org mode has extensive
4597 @vindex org-tag-faces
4598 Every headline can contain a list of tags; they occur at the end of the
4599 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4600 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4601 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4602 Tags will by default be in bold face with the same color as the headline.
4603 You may specify special faces for specific tags using the variable
4604 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4605 (@pxref{Faces for TODO keywords}).
4608 * Tag inheritance:: Tags use the tree structure of the outline
4609 * Setting tags:: How to assign tags to a headline
4610 * Tag searches:: Searching for combinations of tags
4613 @node Tag inheritance, Setting tags, Tags, Tags
4614 @section Tag inheritance
4615 @cindex tag inheritance
4616 @cindex inheritance, of tags
4617 @cindex sublevels, inclusion into tags match
4619 @i{Tags} make use of the hierarchical structure of outline trees. If a
4620 heading has a certain tag, all subheadings will inherit the tag as
4621 well. For example, in the list
4624 * Meeting with the French group :work:
4625 ** Summary by Frank :boss:notes:
4626 *** TODO Prepare slides for him :action:
4630 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4631 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4632 explicitly marked with those tags. You can also set tags that all entries in
4633 a file should inherit just as if these tags were defined in a hypothetical
4634 level zero that surrounds the entire file. Use a line like this@footnote{As
4635 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4636 changes in the line.}:
4640 #+FILETAGS: :Peter:Boss:Secret:
4644 @vindex org-use-tag-inheritance
4645 @vindex org-tags-exclude-from-inheritance
4646 To limit tag inheritance to specific tags, use @code{org-tags-exclude-from-inheritance}.
4647 To turn it off entirely, use @code{org-use-tag-inheritance}.
4649 @vindex org-tags-match-list-sublevels
4650 When a headline matches during a tags search while tag inheritance is turned
4651 on, all the sublevels in the same tree will (for a simple match form) match
4652 as well@footnote{This is only true if the search does not involve more
4653 complex tests including properties (@pxref{Property searches}).}. The list
4654 of matches may then become very long. If you only want to see the first tags
4655 match in a subtree, configure the variable
4656 @code{org-tags-match-list-sublevels} (not recommended).
4658 @vindex org-agenda-use-tag-inheritance
4659 Tag inheritance is relevant when the agenda search tries to match a tag,
4660 either in the @code{tags} or @code{tags-todo} agenda types. In other agenda
4661 types, @code{org-use-tag-inheritance} has no effect. Still, you may want to
4662 have your tags correctly set in the agenda, so that tag filtering works fine,
4663 with inherited tags. Set @code{org-agenda-use-tag-inheritance} to control
4664 this: the default value includes all agenda types, but setting this to nil
4665 can really speed up agenda generation.
4667 @node Setting tags, Tag searches, Tag inheritance, Tags
4668 @section Setting tags
4669 @cindex setting tags
4670 @cindex tags, setting
4673 Tags can simply be typed into the buffer at the end of a headline.
4674 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4675 also a special command for inserting tags:
4678 @orgcmd{C-c C-q,org-set-tags-command}
4679 @cindex completion, of tags
4680 @vindex org-tags-column
4681 Enter new tags for the current headline. Org mode will either offer
4682 completion or a special single-key interface for setting tags, see
4683 below. After pressing @key{RET}, the tags will be inserted and aligned
4684 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4685 tags in the current buffer will be aligned to that column, just to make
4686 things look nice. TAGS are automatically realigned after promotion,
4687 demotion, and TODO state changes (@pxref{TODO basics}).
4688 @orgcmd{C-c C-c,org-set-tags-command}
4689 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4692 @vindex org-tag-alist
4693 Org supports tag insertion based on a @emph{list of tags}. By
4694 default this list is constructed dynamically, containing all tags
4695 currently used in the buffer. You may also globally specify a hard list
4696 of tags with the variable @code{org-tag-alist}. Finally you can set
4697 the default tags for a given file with lines like
4701 #+TAGS: @@work @@home @@tennisclub
4702 #+TAGS: laptop car pc sailboat
4705 If you have globally defined your preferred set of tags using the
4706 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4707 in a specific file, add an empty TAGS option line to that file:
4713 @vindex org-tag-persistent-alist
4714 If you have a preferred set of tags that you would like to use in every file,
4715 in addition to those defined on a per-file basis by TAGS option lines, then
4716 you may specify a list of tags with the variable
4717 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4718 by adding a STARTUP option line to that file:
4724 By default Org mode uses the standard minibuffer completion facilities for
4725 entering tags. However, it also implements another, quicker, tag selection
4726 method called @emph{fast tag selection}. This allows you to select and
4727 deselect tags with just a single key press. For this to work well you should
4728 assign unique letters to most of your commonly used tags. You can do this
4729 globally by configuring the variable @code{org-tag-alist} in your
4730 @file{.emacs} file. For example, you may find the need to tag many items in
4731 different files with @samp{:@@home:}. In this case you can set something
4735 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4738 @noindent If the tag is only relevant to the file you are working on, then you
4739 can instead set the TAGS option line as:
4742 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4745 @noindent The tags interface will show the available tags in a splash
4746 window. If you want to start a new line after a specific tag, insert
4747 @samp{\n} into the tag list
4750 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4753 @noindent or write them in two lines:
4756 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4757 #+TAGS: laptop(l) pc(p)
4761 You can also group together tags that are mutually exclusive by using
4765 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4768 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4769 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4771 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4772 these lines to activate any changes.
4775 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4776 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4777 of the braces. Similarly, you can use @code{:newline} to indicate a line
4778 break. The previous example would be set globally by the following
4782 (setq org-tag-alist '((:startgroup . nil)
4783 ("@@work" . ?w) ("@@home" . ?h)
4784 ("@@tennisclub" . ?t)
4786 ("laptop" . ?l) ("pc" . ?p)))
4789 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4790 automatically present you with a special interface, listing inherited tags,
4791 the tags of the current headline, and a list of all valid tags with
4792 corresponding keys@footnote{Keys will automatically be assigned to tags which
4793 have no configured keys.}. In this interface, you can use the following
4798 Pressing keys assigned to tags will add or remove them from the list of
4799 tags in the current line. Selecting a tag in a group of mutually
4800 exclusive tags will turn off any other tags from that group.
4803 Enter a tag in the minibuffer, even if the tag is not in the predefined
4804 list. You will be able to complete on all tags present in the buffer.
4805 You can also add several tags: just separate them with a comma.
4809 Clear all tags for this line.
4812 Accept the modified set.
4814 Abort without installing changes.
4816 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4818 Turn off groups of mutually exclusive tags. Use this to (as an
4819 exception) assign several tags from such a group.
4821 Toggle auto-exit after the next change (see below).
4822 If you are using expert mode, the first @kbd{C-c} will display the
4827 This method lets you assign tags to a headline with very few keys. With
4828 the above setup, you could clear the current tags and set @samp{@@home},
4829 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4830 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4831 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4832 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4833 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4834 @key{RET} @key{RET}}.
4836 @vindex org-fast-tag-selection-single-key
4837 If you find that most of the time you need only a single key press to
4838 modify your list of tags, set the variable
4839 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4840 press @key{RET} to exit fast tag selection---it will immediately exit
4841 after the first change. If you then occasionally need more keys, press
4842 @kbd{C-c} to turn off auto-exit for the current tag selection process
4843 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4844 C-c}). If you set the variable to the value @code{expert}, the special
4845 window is not even shown for single-key tag selection, it comes up only
4846 when you press an extra @kbd{C-c}.
4848 @node Tag searches, , Setting tags, Tags
4849 @section Tag searches
4850 @cindex tag searches
4851 @cindex searching for tags
4853 Once a system of tags has been set up, it can be used to collect related
4854 information into special lists.
4857 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
4858 Create a sparse tree with all headlines matching a tags search. With a
4859 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4860 @orgcmd{C-c a m,org-tags-view}
4861 Create a global list of tag matches from all agenda files.
4862 @xref{Matching tags and properties}.
4863 @orgcmd{C-c a M,org-tags-view}
4864 @vindex org-tags-match-list-sublevels
4865 Create a global list of tag matches from all agenda files, but check
4866 only TODO items and force checking subitems (see variable
4867 @code{org-tags-match-list-sublevels}).
4870 These commands all prompt for a match string which allows basic Boolean logic
4871 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4872 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4873 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4874 string is rich and allows also matching against TODO keywords, entry levels
4875 and properties. For a complete description with many examples, see
4876 @ref{Matching tags and properties}.
4879 @node Properties and Columns, Dates and Times, Tags, Top
4880 @chapter Properties and columns
4883 A property is a key-value pair associated with an entry. Properties can be
4884 set so they are associated with a single entry, with every entry in a tree,
4885 or with every entry in an Org mode file.
4887 There are two main applications for properties in Org mode. First,
4888 properties are like tags, but with a value. Imagine maintaining a file where
4889 you document bugs and plan releases for a piece of software. Instead of
4890 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
4891 property, say @code{:Release:}, that in different subtrees has different
4892 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
4893 implement (very basic) database capabilities in an Org buffer. Imagine
4894 keeping track of your music CDs, where properties could be things such as the
4895 album, artist, date of release, number of tracks, and so on.
4897 Properties can be conveniently edited and viewed in column view
4898 (@pxref{Column view}).
4901 * Property syntax:: How properties are spelled out
4902 * Special properties:: Access to other Org mode features
4903 * Property searches:: Matching property values
4904 * Property inheritance:: Passing values down the tree
4905 * Column view:: Tabular viewing and editing
4906 * Property API:: Properties for Lisp programmers
4909 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4910 @section Property syntax
4911 @cindex property syntax
4912 @cindex drawer, for properties
4914 Properties are key-value pairs. When they are associated with a single entry
4915 or with a tree they need to be inserted into a special
4916 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4917 is specified on a single line, with the key (surrounded by colons)
4918 first, and the value after it. Here is an example:
4923 *** Goldberg Variations
4925 :Title: Goldberg Variations
4926 :Composer: J.S. Bach
4928 :Publisher: Deutsche Grammophon
4933 Depending on the value of @code{org-use-property-inheritance}, a property set
4934 this way will either be associated with a single entry, or the sub-tree
4935 defined by the entry, see @ref{Property inheritance}.
4937 You may define the allowed values for a particular property @samp{:Xyz:}
4938 by setting a property @samp{:Xyz_ALL:}. This special property is
4939 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4940 the entire tree. When allowed values are defined, setting the
4941 corresponding property becomes easier and is less prone to typing
4942 errors. For the example with the CD collection, we can predefine
4943 publishers and the number of disks in a box like this:
4948 :NDisks_ALL: 1 2 3 4
4949 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4953 If you want to set properties that can be inherited by any entry in a
4954 file, use a line like
4955 @cindex property, _ALL
4958 #+PROPERTY: NDisks_ALL 1 2 3 4
4961 Contrary to properties set from a special drawer, you have to refresh the
4962 buffer with @kbd{C-c C-c} to activate this changes.
4964 If you want to add to the value of an existing property, append a @code{+} to
4965 the property name. The following results in the property @code{var} having
4966 the value ``foo=1 bar=2''.
4969 #+PROPERTY: var foo=1
4970 #+PROPERTY: var+ bar=2
4973 It is also possible to add to the values of inherited properties. The
4974 following results in the @code{genres} property having the value ``Classic
4975 Baroque'' under the @code{Goldberg Variations} subtree.
4983 *** Goldberg Variations
4985 :Title: Goldberg Variations
4986 :Composer: J.S. Bach
4988 :Publisher: Deutsche Grammophon
4993 Note that a property can only have one entry per Drawer.
4995 @vindex org-global-properties
4996 Property values set with the global variable
4997 @code{org-global-properties} can be inherited by all entries in all
5001 The following commands help to work with properties:
5004 @orgcmd{M-@key{TAB},pcomplete}
5005 After an initial colon in a line, complete property keys. All keys used
5006 in the current file will be offered as possible completions.
5007 @orgcmd{C-c C-x p,org-set-property}
5008 Set a property. This prompts for a property name and a value. If
5009 necessary, the property drawer is created as well.
5010 @item C-u M-x org-insert-drawer
5011 @cindex org-insert-drawer
5012 Insert a property drawer into the current entry. The drawer will be
5013 inserted early in the entry, but after the lines with planning
5014 information like deadlines.
5015 @orgcmd{C-c C-c,org-property-action}
5016 With the cursor in a property drawer, this executes property commands.
5017 @orgcmd{C-c C-c s,org-set-property}
5018 Set a property in the current entry. Both the property and the value
5019 can be inserted using completion.
5020 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5021 Switch property at point to the next/previous allowed value.
5022 @orgcmd{C-c C-c d,org-delete-property}
5023 Remove a property from the current entry.
5024 @orgcmd{C-c C-c D,org-delete-property-globally}
5025 Globally remove a property, from all entries in the current file.
5026 @orgcmd{C-c C-c c,org-compute-property-at-point}
5027 Compute the property at point, using the operator and scope from the
5028 nearest column format definition.
5031 @node Special properties, Property searches, Property syntax, Properties and Columns
5032 @section Special properties
5033 @cindex properties, special
5035 Special properties provide an alternative access method to Org mode features,
5036 like the TODO state or the priority of an entry, discussed in the previous
5037 chapters. This interface exists so that you can include these states in a
5038 column view (@pxref{Column view}), or to use them in queries. The following
5039 property names are special and (except for @code{:CATEGORY:}) should not be
5040 used as keys in the properties drawer:
5042 @cindex property, special, ID
5043 @cindex property, special, TODO
5044 @cindex property, special, TAGS
5045 @cindex property, special, ALLTAGS
5046 @cindex property, special, CATEGORY
5047 @cindex property, special, PRIORITY
5048 @cindex property, special, DEADLINE
5049 @cindex property, special, SCHEDULED
5050 @cindex property, special, CLOSED
5051 @cindex property, special, TIMESTAMP
5052 @cindex property, special, TIMESTAMP_IA
5053 @cindex property, special, CLOCKSUM
5054 @cindex property, special, CLOCKSUM_T
5055 @cindex property, special, BLOCKED
5056 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5057 @cindex property, special, ITEM
5058 @cindex property, special, FILE
5060 ID @r{A globally unique ID used for synchronization during}
5061 @r{iCalendar or MobileOrg export.}
5062 TODO @r{The TODO keyword of the entry.}
5063 TAGS @r{The tags defined directly in the headline.}
5064 ALLTAGS @r{All tags, including inherited ones.}
5065 CATEGORY @r{The category of an entry.}
5066 PRIORITY @r{The priority of the entry, a string with a single letter.}
5067 DEADLINE @r{The deadline time string, without the angular brackets.}
5068 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5069 CLOSED @r{When was this entry closed?}
5070 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5071 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5072 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5073 @r{must be run first to compute the values in the current buffer.}
5074 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5075 @r{@code{org-clock-sum-today} must be run first to compute the}
5076 @r{values in the current buffer.}
5077 BLOCKED @r{"t" if task is currently blocked by children or siblings}
5078 ITEM @r{The headline of the entry.}
5079 FILE @r{The filename the entry is located in.}
5082 @node Property searches, Property inheritance, Special properties, Properties and Columns
5083 @section Property searches
5084 @cindex properties, searching
5085 @cindex searching, of properties
5087 To create sparse trees and special lists with selection based on properties,
5088 the same commands are used as for tag searches (@pxref{Tag searches}).
5090 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
5091 Create a sparse tree with all matching entries. With a
5092 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5093 @orgcmd{C-c a m,org-tags-view}
5094 Create a global list of tag/property matches from all agenda files.
5095 @xref{Matching tags and properties}.
5096 @orgcmd{C-c a M,org-tags-view}
5097 @vindex org-tags-match-list-sublevels
5098 Create a global list of tag matches from all agenda files, but check
5099 only TODO items and force checking of subitems (see variable
5100 @code{org-tags-match-list-sublevels}).
5103 The syntax for the search string is described in @ref{Matching tags and
5106 There is also a special command for creating sparse trees based on a
5111 Create a sparse tree based on the value of a property. This first
5112 prompts for the name of a property, and then for a value. A sparse tree
5113 is created with all entries that define this property with the given
5114 value. If you enclose the value in curly braces, it is interpreted as
5115 a regular expression and matched against the property values.
5118 @node Property inheritance, Column view, Property searches, Properties and Columns
5119 @section Property Inheritance
5120 @cindex properties, inheritance
5121 @cindex inheritance, of properties
5123 @vindex org-use-property-inheritance
5124 The outline structure of Org mode documents lends itself to an
5125 inheritance model of properties: if the parent in a tree has a certain
5126 property, the children can inherit this property. Org mode does not
5127 turn this on by default, because it can slow down property searches
5128 significantly and is often not needed. However, if you find inheritance
5129 useful, you can turn it on by setting the variable
5130 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5131 all properties inherited from the parent, to a list of properties
5132 that should be inherited, or to a regular expression that matches
5133 inherited properties. If a property has the value @samp{nil}, this is
5134 interpreted as an explicit undefine of the property, so that inheritance
5135 search will stop at this value and return @code{nil}.
5137 Org mode has a few properties for which inheritance is hard-coded, at
5138 least for the special applications for which they are used:
5140 @cindex property, COLUMNS
5143 The @code{:COLUMNS:} property defines the format of column view
5144 (@pxref{Column view}). It is inherited in the sense that the level
5145 where a @code{:COLUMNS:} property is defined is used as the starting
5146 point for a column view table, independently of the location in the
5147 subtree from where columns view is turned on.
5149 @cindex property, CATEGORY
5150 For agenda view, a category set through a @code{:CATEGORY:} property
5151 applies to the entire subtree.
5153 @cindex property, ARCHIVE
5154 For archiving, the @code{:ARCHIVE:} property may define the archive
5155 location for the entire subtree (@pxref{Moving subtrees}).
5157 @cindex property, LOGGING
5158 The LOGGING property may define logging settings for an entry or a
5159 subtree (@pxref{Tracking TODO state changes}).
5162 @node Column view, Property API, Property inheritance, Properties and Columns
5163 @section Column view
5165 A great way to view and edit properties in an outline tree is
5166 @emph{column view}. In column view, each outline node is turned into a
5167 table row. Columns in this table provide access to properties of the
5168 entries. Org mode implements columns by overlaying a tabular structure
5169 over the headline of each item. While the headlines have been turned
5170 into a table row, you can still change the visibility of the outline
5171 tree. For example, you get a compact table by switching to CONTENTS
5172 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5173 is active), but you can still open, read, and edit the entry below each
5174 headline. Or, you can switch to column view after executing a sparse
5175 tree command and in this way get a table only for the selected items.
5176 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5177 queries have collected selected items, possibly from a number of files.
5180 * Defining columns:: The COLUMNS format property
5181 * Using column view:: How to create and use column view
5182 * Capturing column view:: A dynamic block for column view
5185 @node Defining columns, Using column view, Column view, Column view
5186 @subsection Defining columns
5187 @cindex column view, for properties
5188 @cindex properties, column view
5190 Setting up a column view first requires defining the columns. This is
5191 done by defining a column format line.
5194 * Scope of column definitions:: Where defined, where valid?
5195 * Column attributes:: Appearance and content of a column
5198 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5199 @subsubsection Scope of column definitions
5201 To define a column format for an entire file, use a line like
5205 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5208 To specify a format that only applies to a specific tree, add a
5209 @code{:COLUMNS:} property to the top node of that tree, for example:
5212 ** Top node for columns view
5214 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5218 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5219 for the entry itself, and for the entire subtree below it. Since the
5220 column definition is part of the hierarchical structure of the document,
5221 you can define columns on level 1 that are general enough for all
5222 sublevels, and more specific columns further down, when you edit a
5223 deeper part of the tree.
5225 @node Column attributes, , Scope of column definitions, Defining columns
5226 @subsubsection Column attributes
5227 A column definition sets the attributes of a column. The general
5228 definition looks like this:
5231 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5235 Except for the percent sign and the property name, all items are
5236 optional. The individual parts have the following meaning:
5239 @var{width} @r{An integer specifying the width of the column in characters.}
5240 @r{If omitted, the width will be determined automatically.}
5241 @var{property} @r{The property that should be edited in this column.}
5242 @r{Special properties representing meta data are allowed here}
5243 @r{as well (@pxref{Special properties})}
5244 @var{title} @r{The header text for the column. If omitted, the property}
5246 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5247 @r{parent nodes are computed from the children.}
5248 @r{Supported summary types are:}
5249 @{+@} @r{Sum numbers in this column.}
5250 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5251 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5252 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5253 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5254 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5255 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5256 @{min@} @r{Smallest number in column.}
5257 @{max@} @r{Largest number.}
5258 @{mean@} @r{Arithmetic mean of numbers.}
5259 @{:min@} @r{Smallest time value in column.}
5260 @{:max@} @r{Largest time value.}
5261 @{:mean@} @r{Arithmetic mean of time values.}
5262 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5263 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5264 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5265 @{est+@} @r{Add low-high estimates.}
5269 Be aware that you can only have one summary type for any property you
5270 include. Subsequent columns referencing the same property will all display the
5271 same summary information.
5273 The @code{est+} summary type requires further explanation. It is used for
5274 combining estimates, expressed as low-high ranges. For example, instead
5275 of estimating a particular task will take 5 days, you might estimate it as
5276 5--6 days if you're fairly confident you know how much work is required, or
5277 1--10 days if you don't really know what needs to be done. Both ranges
5278 average at 5.5 days, but the first represents a more predictable delivery.
5280 When combining a set of such estimates, simply adding the lows and highs
5281 produces an unrealistically wide result. Instead, @code{est+} adds the
5282 statistical mean and variance of the sub-tasks, generating a final estimate
5283 from the sum. For example, suppose you had ten tasks, each of which was
5284 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5285 of 5 to 20 days, representing what to expect if everything goes either
5286 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5287 full job more realistically, at 10--15 days.
5289 Here is an example for a complete columns definition, along with allowed
5293 :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.}
5294 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5295 :Owner_ALL: Tammy Mark Karl Lisa Don
5296 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5297 :Approved_ALL: "[ ]" "[X]"
5301 The first column, @samp{%25ITEM}, means the first 25 characters of the
5302 item itself, i.e., of the headline. You probably always should start the
5303 column definition with the @samp{ITEM} specifier. The other specifiers
5304 create columns @samp{Owner} with a list of names as allowed values, for
5305 @samp{Status} with four different possible values, and for a checkbox
5306 field @samp{Approved}. When no width is given after the @samp{%}
5307 character, the column will be exactly as wide as it needs to be in order
5308 to fully display all values. The @samp{Approved} column does have a
5309 modified title (@samp{Approved?}, with a question mark). Summaries will
5310 be created for the @samp{Time_Estimate} column by adding time duration
5311 expressions like HH:MM, and for the @samp{Approved} column, by providing
5312 an @samp{[X]} status if all children have been checked. The
5313 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5314 sums of CLOCK intervals in the subtree, either for all clocks or just for
5317 @node Using column view, Capturing column view, Defining columns, Column view
5318 @subsection Using column view
5321 @tsubheading{Turning column view on and off}
5322 @orgcmd{C-c C-x C-c,org-columns}
5323 @vindex org-columns-default-format
5324 Turn on column view. If the cursor is before the first headline in the file,
5325 column view is turned on for the entire file, using the @code{#+COLUMNS}
5326 definition. If the cursor is somewhere inside the outline, this command
5327 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5328 defines a format. When one is found, the column view table is established
5329 for the tree starting at the entry that contains the @code{:COLUMNS:}
5330 property. If no such property is found, the format is taken from the
5331 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5332 and column view is established for the current entry and its subtree.
5333 @orgcmd{r,org-columns-redo}
5334 Recreate the column view, to include recent changes made in the buffer.
5335 @orgcmd{g,org-columns-redo}
5337 @orgcmd{q,org-columns-quit}
5339 @tsubheading{Editing values}
5340 @item @key{left} @key{right} @key{up} @key{down}
5341 Move through the column view from field to field.
5342 @kindex S-@key{left}
5343 @kindex S-@key{right}
5344 @item S-@key{left}/@key{right}
5345 Switch to the next/previous allowed value of the field. For this, you
5346 have to have specified allowed values for a property.
5348 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5349 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5350 Same as @kbd{S-@key{left}/@key{right}}
5351 @orgcmd{e,org-columns-edit-value}
5352 Edit the property at point. For the special properties, this will
5353 invoke the same interface that you normally use to change that
5354 property. For example, when editing a TAGS property, the tag completion
5355 or fast selection interface will pop up.
5356 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5357 When there is a checkbox at point, toggle it.
5358 @orgcmd{v,org-columns-show-value}
5359 View the full value of this property. This is useful if the width of
5360 the column is smaller than that of the value.
5361 @orgcmd{a,org-columns-edit-allowed}
5362 Edit the list of allowed values for this property. If the list is found
5363 in the hierarchy, the modified values is stored there. If no list is
5364 found, the new value is stored in the first entry that is part of the
5365 current column view.
5366 @tsubheading{Modifying the table structure}
5367 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5368 Make the column narrower/wider by one character.
5369 @orgcmd{S-M-@key{right},org-columns-new}
5370 Insert a new column, to the left of the current column.
5371 @orgcmd{S-M-@key{left},org-columns-delete}
5372 Delete the current column.
5375 @node Capturing column view, , Using column view, Column view
5376 @subsection Capturing column view
5378 Since column view is just an overlay over a buffer, it cannot be
5379 exported or printed directly. If you want to capture a column view, use
5380 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5381 of this block looks like this:
5383 @cindex #+BEGIN, columnview
5386 #+BEGIN: columnview :hlines 1 :id "label"
5391 @noindent This dynamic block has the following parameters:
5395 This is the most important parameter. Column view is a feature that is
5396 often localized to a certain (sub)tree, and the capture block might be
5397 at a different location in the file. To identify the tree whose view to
5398 capture, you can use 4 values:
5399 @cindex property, ID
5401 local @r{use the tree in which the capture block is located}
5402 global @r{make a global view, including all headings in the file}
5403 "file:@var{path-to-file}"
5404 @r{run column view at the top of this file}
5405 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5406 @r{property with the value @i{label}. You can use}
5407 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5408 @r{the current entry and copy it to the kill-ring.}
5411 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5412 an hline before each headline with level @code{<= @var{N}}.
5414 When set to @code{t}, force column groups to get vertical lines.
5416 When set to a number, don't capture entries below this level.
5417 @item :skip-empty-rows
5418 When set to @code{t}, skip rows where the only non-empty specifier of the
5419 column view is @code{ITEM}.
5424 The following commands insert or update the dynamic block:
5427 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5428 Insert a dynamic block capturing a column view. You will be prompted
5429 for the scope or ID of the view.
5430 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5431 Update dynamic block at point. The cursor needs to be in the
5432 @code{#+BEGIN} line of the dynamic block.
5433 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5434 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5435 you have several clock table blocks, column-capturing blocks or other dynamic
5439 You can add formulas to the column view table and you may add plotting
5440 instructions in front of the table---these will survive an update of the
5441 block. If there is a @code{#+TBLFM:} after the table, the table will
5442 actually be recalculated automatically after an update.
5444 An alternative way to capture and process property values into a table is
5445 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5446 package@footnote{Contributed packages are not part of Emacs, but are
5447 distributed with the main distribution of Org (visit
5448 @uref{http://orgmode.org}).}. It provides a general API to collect
5449 properties from entries in a certain scope, and arbitrary Lisp expressions to
5450 process these values before inserting them into a table or a dynamic block.
5452 @node Property API, , Column view, Properties and Columns
5453 @section The Property API
5454 @cindex properties, API
5455 @cindex API, for properties
5457 There is a full API for accessing and changing properties. This API can
5458 be used by Emacs Lisp programs to work with properties and to implement
5459 features based on them. For more information see @ref{Using the
5462 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5463 @chapter Dates and times
5469 To assist project planning, TODO items can be labeled with a date and/or
5470 a time. The specially formatted string carrying the date and time
5471 information is called a @emph{timestamp} in Org mode. This may be a
5472 little confusing because timestamp is often used as indicating when
5473 something was created or last changed. However, in Org mode this term
5474 is used in a much wider sense.
5477 * Timestamps:: Assigning a time to a tree entry
5478 * Creating timestamps:: Commands which insert timestamps
5479 * Deadlines and scheduling:: Planning your work
5480 * Clocking work time:: Tracking how long you spend on a task
5481 * Effort estimates:: Planning work effort in advance
5482 * Relative timer:: Notes with a running timer
5483 * Countdown timer:: Starting a countdown timer for a task
5487 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5488 @section Timestamps, deadlines, and scheduling
5490 @cindex ranges, time
5495 A timestamp is a specification of a date (possibly with a time or a range of
5496 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5497 simplest form, the day name is optional when you type the date yourself.
5498 However, any dates inserted or modified by Org will add that day name, for
5499 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5500 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5501 date/time format. To use an alternative format, see @ref{Custom time
5502 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5503 tree entry. Its presence causes entries to be shown on specific dates in the
5504 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5507 @item Plain timestamp; Event; Appointment
5510 A simple timestamp just assigns a date/time to an item. This is just
5511 like writing down an appointment or event in a paper agenda. In the
5512 timeline and agenda displays, the headline of an entry associated with a
5513 plain timestamp will be shown exactly on that date.
5516 * Meet Peter at the movies
5517 <2006-11-01 Wed 19:15>
5518 * Discussion on climate change
5519 <2006-11-02 Thu 20:00-22:00>
5522 @item Timestamp with repeater interval
5523 @cindex timestamp, with repeater interval
5524 A timestamp may contain a @emph{repeater interval}, indicating that it
5525 applies not only on the given date, but again and again after a certain
5526 interval of N days (d), weeks (w), months (m), or years (y). The
5527 following will show up in the agenda every Wednesday:
5530 * Pick up Sam at school
5531 <2007-05-16 Wed 12:30 +1w>
5534 @item Diary-style sexp entries
5535 For more complex date specifications, Org mode supports using the special
5536 sexp diary entries implemented in the Emacs calendar/diary
5537 package@footnote{When working with the standard diary sexp functions, you
5538 need to be very careful with the order of the arguments. That order depend
5539 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5540 versions, @code{european-calendar-style}). For example, to specify a date
5541 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5542 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5543 the settings. This has been the source of much confusion. Org mode users
5544 can resort to special versions of these functions like @code{org-date} or
5545 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5546 functions, but with stable ISO order of arguments (year, month, day) wherever
5547 applicable, independent of the value of @code{calendar-date-style}.}. For
5548 example with optional time
5551 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5552 <%%(diary-float t 4 2)>
5555 @item Time/Date range
5558 Two timestamps connected by @samp{--} denote a range. The headline
5559 will be shown on the first and last day of the range, and on any dates
5560 that are displayed and fall in the range. Here is an example:
5563 ** Meeting in Amsterdam
5564 <2004-08-23 Mon>--<2004-08-26 Thu>
5567 @item Inactive timestamp
5568 @cindex timestamp, inactive
5569 @cindex inactive timestamp
5570 Just like a plain timestamp, but with square brackets instead of
5571 angular ones. These timestamps are inactive in the sense that they do
5572 @emph{not} trigger an entry to show up in the agenda.
5575 * Gillian comes late for the fifth time
5581 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5582 @section Creating timestamps
5583 @cindex creating timestamps
5584 @cindex timestamps, creating
5586 For Org mode to recognize timestamps, they need to be in the specific
5587 format. All commands listed below produce timestamps in the correct
5591 @orgcmd{C-c .,org-time-stamp}
5592 Prompt for a date and insert a corresponding timestamp. When the cursor is
5593 at an existing timestamp in the buffer, the command is used to modify this
5594 timestamp instead of inserting a new one. When this command is used twice in
5595 succession, a time range is inserted.
5597 @orgcmd{C-c !,org-time-stamp-inactive}
5598 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5605 @vindex org-time-stamp-rounding-minutes
5606 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5607 contains date and time. The default time can be rounded to multiples of 5
5608 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5611 Normalize timestamp, insert/fix day name if missing or wrong.
5613 @orgcmd{C-c <,org-date-from-calendar}
5614 Insert a timestamp corresponding to the cursor date in the Calendar.
5616 @orgcmd{C-c >,org-goto-calendar}
5617 Access the Emacs calendar for the current date. If there is a
5618 timestamp in the current line, go to the corresponding date
5621 @orgcmd{C-c C-o,org-open-at-point}
5622 Access the agenda for the date given by the timestamp or -range at
5623 point (@pxref{Weekly/daily agenda}).
5625 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5626 Change date at cursor by one day. These key bindings conflict with
5627 shift-selection and related modes (@pxref{Conflicts}).
5629 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5630 Change the item under the cursor in a timestamp. The cursor can be on a
5631 year, month, day, hour or minute. When the timestamp contains a time range
5632 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5633 shifting the time block with constant length. To change the length, modify
5634 the second time. Note that if the cursor is in a headline and not at a
5635 timestamp, these same keys modify the priority of an item.
5636 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5637 related modes (@pxref{Conflicts}).
5639 @orgcmd{C-c C-y,org-evaluate-time-range}
5640 @cindex evaluate time range
5641 Evaluate a time range by computing the difference between start and end.
5642 With a prefix argument, insert result after the time range (in a table: into
5643 the following column).
5648 * The date/time prompt:: How Org mode helps you entering date and time
5649 * Custom time format:: Making dates look different
5652 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5653 @subsection The date/time prompt
5654 @cindex date, reading in minibuffer
5655 @cindex time, reading in minibuffer
5657 @vindex org-read-date-prefer-future
5658 When Org mode prompts for a date/time, the default is shown in default
5659 date/time format, and the prompt therefore seems to ask for a specific
5660 format. But it will in fact accept date/time information in a variety of
5661 formats. Generally, the information should start at the beginning of the
5662 string. Org mode will find whatever information is in
5663 there and derive anything you have not specified from the @emph{default date
5664 and time}. The default is usually the current date and time, but when
5665 modifying an existing timestamp, or when entering the second stamp of a
5666 range, it is taken from the stamp in the buffer. When filling in
5667 information, Org mode assumes that most of the time you will want to enter a
5668 date in the future: if you omit the month/year and the given day/month is
5669 @i{before} today, it will assume that you mean a future date@footnote{See the
5670 variable @code{org-read-date-prefer-future}. You may set that variable to
5671 the symbol @code{time} to even make a time before now shift the date to
5672 tomorrow.}. If the date has been automatically shifted into the future, the
5673 time prompt will show this with @samp{(=>F).}
5675 For example, let's assume that today is @b{June 13, 2006}. Here is how
5676 various inputs will be interpreted, the items filled in by Org mode are
5680 3-2-5 @result{} 2003-02-05
5681 2/5/3 @result{} 2003-02-05
5682 14 @result{} @b{2006}-@b{06}-14
5683 12 @result{} @b{2006}-@b{07}-12
5684 2/5 @result{} @b{2007}-02-05
5685 Fri @result{} nearest Friday (default date or later)
5686 sep 15 @result{} @b{2006}-09-15
5687 feb 15 @result{} @b{2007}-02-15
5688 sep 12 9 @result{} 2009-09-12
5689 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5690 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5691 w4 @result{} ISO week for of the current year @b{2006}
5692 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5693 2012-w04-5 @result{} Same as above
5696 Furthermore you can specify a relative date by giving, as the
5697 @emph{first} thing in the input: a plus/minus sign, a number and a
5698 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5699 single plus or minus, the date is always relative to today. With a
5700 double plus or minus, it is relative to the default date. If instead of
5701 a single letter, you use the abbreviation of day name, the date will be
5702 the Nth such day, e.g.:
5707 +4d @result{} four days from today
5708 +4 @result{} same as above
5709 +2w @result{} two weeks from today
5710 ++5 @result{} five days from default date
5711 +2tue @result{} second Tuesday from now.
5714 @vindex parse-time-months
5715 @vindex parse-time-weekdays
5716 The function understands English month and weekday abbreviations. If
5717 you want to use unabbreviated names and/or other languages, configure
5718 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5720 @vindex org-read-date-force-compatible-dates
5721 Not all dates can be represented in a given Emacs implementation. By default
5722 Org mode forces dates into the compatibility range 1970--2037 which works on
5723 all Emacs implementations. If you want to use dates outside of this range,
5724 read the docstring of the variable
5725 @code{org-read-date-force-compatible-dates}.
5727 You can specify a time range by giving start and end times or by giving a
5728 start time and a duration (in HH:MM format). Use one or two dash(es) as the
5729 separator in the former case and use '+' as the separator in the latter
5733 11am-1:15pm @result{} 11:00-13:15
5734 11am--1:15pm @result{} same as above
5735 11am+2:15 @result{} same as above
5738 @cindex calendar, for selecting date
5739 @vindex org-popup-calendar-for-date-prompt
5740 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5741 you don't need/want the calendar, configure the variable
5742 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5743 prompt, either by clicking on a date in the calendar, or by pressing
5744 @key{RET}, the date selected in the calendar will be combined with the
5745 information entered at the prompt. You can control the calendar fully
5746 from the minibuffer:
5753 @kindex S-@key{right}
5754 @kindex S-@key{left}
5755 @kindex S-@key{down}
5757 @kindex M-S-@key{right}
5758 @kindex M-S-@key{left}
5761 @key{RET} @r{Choose date at cursor in calendar.}
5762 mouse-1 @r{Select date by clicking on it.}
5763 S-@key{right}/@key{left} @r{One day forward/backward.}
5764 S-@key{down}/@key{up} @r{One week forward/backward.}
5765 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5766 > / < @r{Scroll calendar forward/backward by one month.}
5767 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5770 @vindex org-read-date-display-live
5771 The actions of the date/time prompt may seem complex, but I assure you they
5772 will grow on you, and you will start getting annoyed by pretty much any other
5773 way of entering a date/time out there. To help you understand what is going
5774 on, the current interpretation of your input will be displayed live in the
5775 minibuffer@footnote{If you find this distracting, turn the display of with
5776 @code{org-read-date-display-live}.}.
5778 @node Custom time format, , The date/time prompt, Creating timestamps
5779 @subsection Custom time format
5780 @cindex custom date/time format
5781 @cindex time format, custom
5782 @cindex date format, custom
5784 @vindex org-display-custom-times
5785 @vindex org-time-stamp-custom-formats
5786 Org mode uses the standard ISO notation for dates and times as it is
5787 defined in ISO 8601. If you cannot get used to this and require another
5788 representation of date and time to keep you happy, you can get it by
5789 customizing the variables @code{org-display-custom-times} and
5790 @code{org-time-stamp-custom-formats}.
5793 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5794 Toggle the display of custom formats for dates and times.
5798 Org mode needs the default format for scanning, so the custom date/time
5799 format does not @emph{replace} the default format---instead it is put
5800 @emph{over} the default format using text properties. This has the
5801 following consequences:
5804 You cannot place the cursor onto a timestamp anymore, only before or
5807 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5808 each component of a timestamp. If the cursor is at the beginning of
5809 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5810 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5811 time will be changed by one minute.
5813 If the timestamp contains a range of clock times or a repeater, these
5814 will not be overlaid, but remain in the buffer as they were.
5816 When you delete a timestamp character-by-character, it will only
5817 disappear from the buffer after @emph{all} (invisible) characters
5818 belonging to the ISO timestamp have been removed.
5820 If the custom timestamp format is longer than the default and you are
5821 using dates in tables, table alignment will be messed up. If the custom
5822 format is shorter, things do work as expected.
5826 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5827 @section Deadlines and scheduling
5829 A timestamp may be preceded by special keywords to facilitate planning:
5833 @cindex DEADLINE keyword
5835 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5836 to be finished on that date.
5838 @vindex org-deadline-warning-days
5839 @vindex org-agenda-skip-deadline-prewarning-if-scheduled
5840 On the deadline date, the task will be listed in the agenda. In
5841 addition, the agenda for @emph{today} will carry a warning about the
5842 approaching or missed deadline, starting
5843 @code{org-deadline-warning-days} before the due date, and continuing
5844 until the entry is marked DONE@. An example:
5847 *** TODO write article about the Earth for the Guide
5848 DEADLINE: <2004-02-29 Sun>
5849 The editor in charge is [[bbdb:Ford Prefect]]
5852 You can specify a different lead time for warnings for a specific
5853 deadlines using the following syntax. Here is an example with a warning
5854 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}. This warning is
5855 deactivated if the task get scheduled and you set
5856 @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
5859 @cindex SCHEDULED keyword
5861 Meaning: you are planning to start working on that task on the given
5864 @vindex org-agenda-skip-scheduled-if-done
5865 The headline will be listed under the given date@footnote{It will still
5866 be listed on that date after it has been marked DONE@. If you don't like
5867 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5868 addition, a reminder that the scheduled date has passed will be present
5869 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
5870 the task will automatically be forwarded until completed.
5873 *** TODO Call Trillian for a date on New Years Eve.
5874 SCHEDULED: <2004-12-25 Sat>
5877 @vindex org-scheduled-delay-days
5878 @vindex org-agenda-skip-scheduled-delay-if-deadline
5879 If you want to @emph{delay} the display of this task in the agenda, use
5880 @code{SCHEDULED: <2004-12-25 Sat -2d>}: the task is still scheduled on the
5881 25th but will appear two days later. In case the task contains a repeater,
5882 the delay is considered to affect all occurrences; if you want it to affect
5883 only the first scheduled occurrence of the task, use @code{--2d} instead.
5884 See @code{org-scheduled-delay-days} and
5885 @code{org-agenda-skip-scheduled-delay-if-deadline} for details on how to
5886 control this globally or per agenda.
5889 @b{Important:} Scheduling an item in Org mode should @i{not} be
5890 understood in the same way that we understand @i{scheduling a meeting}.
5891 Setting a date for a meeting is just a simple appointment, you should
5892 mark this entry with a simple plain timestamp, to get this item shown
5893 on the date where it applies. This is a frequent misunderstanding by
5894 Org users. In Org mode, @i{scheduling} means setting a date when you
5895 want to start working on an action item.
5898 You may use timestamps with repeaters in scheduling and deadline
5899 entries. Org mode will issue early and late warnings based on the
5900 assumption that the timestamp represents the @i{nearest instance} of
5901 the repeater. However, the use of diary sexp entries like
5903 @code{<%%(diary-float t 42)>}
5905 in scheduling and deadline timestamps is limited. Org mode does not
5906 know enough about the internals of each sexp function to issue early and
5907 late warnings. However, it will show the item on each day where the
5911 * Inserting deadline/schedule:: Planning items
5912 * Repeated tasks:: Items that show up again and again
5915 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5916 @subsection Inserting deadlines or schedules
5918 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
5919 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
5920 any text between this line and the headline.} a deadline or to schedule
5925 @orgcmd{C-c C-d,org-deadline}
5926 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5927 in the line directly following the headline. Any CLOSED timestamp will be
5928 removed. When called with a prefix arg, an existing deadline will be removed
5929 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
5930 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5931 and @code{nologredeadline}}, a note will be taken when changing an existing
5934 @orgcmd{C-c C-s,org-schedule}
5935 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5936 happen in the line directly following the headline. Any CLOSED timestamp
5937 will be removed. When called with a prefix argument, remove the scheduling
5938 date from the entry. Depending on the variable
5939 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5940 keywords @code{logreschedule}, @code{lognotereschedule}, and
5941 @code{nologreschedule}}, a note will be taken when changing an existing
5944 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5947 Mark the current entry for agenda action. After you have marked the entry
5948 like this, you can open the agenda or the calendar to find an appropriate
5949 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5950 schedule the marked item.
5952 @orgcmd{C-c / d,org-check-deadlines}
5953 @cindex sparse tree, for deadlines
5954 @vindex org-deadline-warning-days
5955 Create a sparse tree with all deadlines that are either past-due, or
5956 which will become due within @code{org-deadline-warning-days}.
5957 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5958 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5959 all deadlines due tomorrow.
5961 @orgcmd{C-c / b,org-check-before-date}
5962 Sparse tree for deadlines and scheduled items before a given date.
5964 @orgcmd{C-c / a,org-check-after-date}
5965 Sparse tree for deadlines and scheduled items after a given date.
5968 Note that @code{org-schedule} and @code{org-deadline} supports
5969 setting the date by indicating a relative time: e.g., +1d will set
5970 the date to the next day after today, and --1w will set the date
5971 to the previous week before any current timestamp.
5973 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5974 @subsection Repeated tasks
5975 @cindex tasks, repeated
5976 @cindex repeated tasks
5978 Some tasks need to be repeated again and again. Org mode helps to
5979 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5980 or plain timestamp. In the following example
5982 ** TODO Pay the rent
5983 DEADLINE: <2005-10-01 Sat +1m>
5986 the @code{+1m} is a repeater; the intended interpretation is that the task
5987 has a deadline on <2005-10-01> and repeats itself every (one) month starting
5988 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
5989 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
5990 and a special warning period in a deadline entry, the repeater should come
5991 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
5993 @vindex org-todo-repeat-to-state
5994 Deadlines and scheduled items produce entries in the agenda when they are
5995 over-due, so it is important to be able to mark such an entry as completed
5996 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
5997 keyword DONE, it will no longer produce entries in the agenda. The problem
5998 with this is, however, that then also the @emph{next} instance of the
5999 repeated entry will not be active. Org mode deals with this in the following
6000 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6001 shift the base date of the repeating timestamp by the repeater interval, and
6002 immediately set the entry state back to TODO@footnote{In fact, the target
6003 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6004 the variable @code{org-todo-repeat-to-state}. If neither of these is
6005 specified, the target state defaults to the first state of the TODO state
6006 sequence.}. In the example above, setting the state to DONE would actually
6007 switch the date like this:
6010 ** TODO Pay the rent
6011 DEADLINE: <2005-11-01 Tue +1m>
6014 @vindex org-log-repeat
6015 A timestamp@footnote{You can change this using the option
6016 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6017 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
6018 will also be prompted for a note.} will be added under the deadline, to keep
6019 a record that you actually acted on the previous instance of this deadline.
6021 As a consequence of shifting the base date, this entry will no longer be
6022 visible in the agenda when checking past dates, but all future instances
6025 With the @samp{+1m} cookie, the date shift will always be exactly one
6026 month. So if you have not paid the rent for three months, marking this
6027 entry DONE will still keep it as an overdue deadline. Depending on the
6028 task, this may not be the best way to handle it. For example, if you
6029 forgot to call your father for 3 weeks, it does not make sense to call
6030 him 3 times in a single day to make up for it. Finally, there are tasks
6031 like changing batteries which should always repeat a certain time
6032 @i{after} the last time you did it. For these tasks, Org mode has
6033 special repeaters @samp{++} and @samp{.+}. For example:
6037 DEADLINE: <2008-02-10 Sun ++1w>
6038 Marking this DONE will shift the date by at least one week,
6039 but also by as many weeks as it takes to get this date into
6040 the future. However, it stays on a Sunday, even if you called
6041 and marked it done on Saturday.
6042 ** TODO Check the batteries in the smoke detectors
6043 DEADLINE: <2005-11-01 Tue .+1m>
6044 Marking this DONE will shift the date to one month after
6048 You may have both scheduling and deadline information for a specific
6049 task---just make sure that the repeater intervals on both are the same.
6051 An alternative to using a repeater is to create a number of copies of a task
6052 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6053 created for this purpose, it is described in @ref{Structure editing}.
6056 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
6057 @section Clocking work time
6058 @cindex clocking time
6059 @cindex time clocking
6061 Org mode allows you to clock the time you spend on specific tasks in a
6062 project. When you start working on an item, you can start the clock. When
6063 you stop working on that task, or when you mark the task done, the clock is
6064 stopped and the corresponding time interval is recorded. It also computes
6065 the total time spent on each subtree@footnote{Clocking only works if all
6066 headings are indented with less than 30 stars. This is a hardcoded
6067 limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
6068 history or tasks recently clocked, to that you can jump quickly between a
6069 number of tasks absorbing your time.
6071 To save the clock history across Emacs sessions, use
6073 (setq org-clock-persist 'history)
6074 (org-clock-persistence-insinuate)
6076 When you clock into a new task after resuming Emacs, the incomplete
6077 clock@footnote{To resume the clock under the assumption that you have worked
6078 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6079 will be found (@pxref{Resolving idle time}) and you will be prompted about
6083 * Clocking commands:: Starting and stopping a clock
6084 * The clock table:: Detailed reports
6085 * Resolving idle time:: Resolving time when you've been idle
6088 @node Clocking commands, The clock table, Clocking work time, Clocking work time
6089 @subsection Clocking commands
6092 @orgcmd{C-c C-x C-i,org-clock-in}
6093 @vindex org-clock-into-drawer
6094 @vindex org-clock-continuously
6095 @cindex property, LOG_INTO_DRAWER
6096 Start the clock on the current item (clock-in). This inserts the CLOCK
6097 keyword together with a timestamp. If this is not the first clocking of
6098 this item, the multiple CLOCK lines will be wrapped into a
6099 @code{:LOGBOOK:} drawer (see also the variable
6100 @code{org-clock-into-drawer}). You can also overrule
6101 the setting of this variable for a subtree by setting a
6102 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6103 When called with a @kbd{C-u} prefix argument,
6104 select the task from a list of recently clocked tasks. With two @kbd{C-u
6105 C-u} prefixes, clock into the task at point and mark it as the default task;
6106 the default task will then always be available with letter @kbd{d} when
6107 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6108 continuous clocking by starting the clock when the last clock stopped.@*
6109 @cindex property: CLOCK_MODELINE_TOTAL
6110 @cindex property: LAST_REPEAT
6111 @vindex org-clock-modeline-total
6112 While the clock is running, the current clocking time is shown in the mode
6113 line, along with the title of the task. The clock time shown will be all
6114 time ever clocked for this task and its children. If the task has an effort
6115 estimate (@pxref{Effort estimates}), the mode line displays the current
6116 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6117 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6118 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6119 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6120 will be shown. More control over what time is shown can be exercised with
6121 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6122 @code{current} to show only the current clocking instance, @code{today} to
6123 show all time clocked on this tasks today (see also the variable
6124 @code{org-extend-today-until}), @code{all} to include all time, or
6125 @code{auto} which is the default@footnote{See also the variable
6126 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6127 mode line entry will pop up a menu with clocking options.
6129 @orgcmd{C-c C-x C-o,org-clock-out}
6130 @vindex org-log-note-clock-out
6131 Stop the clock (clock-out). This inserts another timestamp at the same
6132 location where the clock was last started. It also directly computes
6133 the resulting time in inserts it after the time range as @samp{=>
6134 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6135 possibility to record an additional note together with the clock-out
6136 timestamp@footnote{The corresponding in-buffer setting is:
6137 @code{#+STARTUP: lognoteclock-out}}.
6138 @orgcmd{C-c C-x C-x,org-clock-in-last}
6139 @vindex org-clock-continuously
6140 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6141 select the task from the clock history. With two @kbd{C-u} prefixes,
6142 force continuous clocking by starting the clock when the last clock
6144 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6145 Update the effort estimate for the current clock task.
6148 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6149 Recompute the time interval after changing one of the timestamps. This
6150 is only necessary if you edit the timestamps directly. If you change
6151 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6152 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6153 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6154 clock duration keeps the same.
6155 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6156 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6157 the one of the previous (or the next clock) timestamp by the same duration.
6158 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6159 by five minutes, then the clocked-in timestamp of the next clock will be
6160 increased by five minutes.
6161 @orgcmd{C-c C-t,org-todo}
6162 Changing the TODO state of an item to DONE automatically stops the clock
6163 if it is running in this same item.
6164 @orgcmd{C-c C-x C-q,org-clock-cancel}
6165 Cancel the current clock. This is useful if a clock was started by
6166 mistake, or if you ended up working on something else.
6167 @orgcmd{C-c C-x C-j,org-clock-goto}
6168 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6169 prefix arg, select the target task from a list of recently clocked tasks.
6170 @orgcmd{C-c C-x C-d,org-clock-display}
6171 @vindex org-remove-highlights-with-change
6172 Display time summaries for each subtree in the current buffer. This puts
6173 overlays at the end of each headline, showing the total time recorded under
6174 that heading, including the time of any subheadings. You can use visibility
6175 cycling to study the tree, but the overlays disappear when you change the
6176 buffer (see variable @code{org-remove-highlights-with-change}) or press
6180 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6181 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6182 worked on or closed during a day.
6184 @strong{Important:} note that both @code{org-clock-out} and
6185 @code{org-clock-in-last} can have a global keybinding and will not
6186 modify the window disposition.
6188 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6189 @subsection The clock table
6190 @cindex clocktable, dynamic block
6191 @cindex report, of clocked time
6193 Org mode can produce quite complex reports based on the time clocking
6194 information. Such a report is called a @emph{clock table}, because it is
6195 formatted as one or several Org tables.
6198 @orgcmd{C-c C-x C-r,org-clock-report}
6199 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6200 report as an Org mode table into the current file. When the cursor is
6201 at an existing clock table, just update it. When called with a prefix
6202 argument, jump to the first clock report in the current document and
6203 update it. The clock table always includes also trees with
6204 @code{:ARCHIVE:} tag.
6205 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6206 Update dynamic block at point. The cursor needs to be in the
6207 @code{#+BEGIN} line of the dynamic block.
6208 @orgkey{C-u C-c C-x C-u}
6209 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6210 you have several clock table blocks in a buffer.
6211 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6212 Shift the current @code{:block} interval and update the table. The cursor
6213 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6214 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6218 Here is an example of the frame for a clock table as it is inserted into the
6219 buffer with the @kbd{C-c C-x C-r} command:
6221 @cindex #+BEGIN, clocktable
6223 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6227 @vindex org-clocktable-defaults
6228 The @samp{BEGIN} line and specify a number of options to define the scope,
6229 structure, and formatting of the report. Defaults for all these options can
6230 be configured in the variable @code{org-clocktable-defaults}.
6232 @noindent First there are options that determine which clock entries are to
6235 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6236 @r{Clocks at deeper levels will be summed into the upper level.}
6237 :scope @r{The scope to consider. This can be any of the following:}
6238 nil @r{the current buffer or narrowed region}
6239 file @r{the full current buffer}
6240 subtree @r{the subtree where the clocktable is located}
6241 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6242 tree @r{the surrounding level 1 tree}
6243 agenda @r{all agenda files}
6244 ("file"..) @r{scan these files}
6245 file-with-archives @r{current file and its archives}
6246 agenda-with-archives @r{all agenda files, including archives}
6247 :block @r{The time block to consider. This block is specified either}
6248 @r{absolute, or relative to the current time and may be any of}
6250 2007-12-31 @r{New year eve 2007}
6251 2007-12 @r{December 2007}
6252 2007-W50 @r{ISO-week 50 in 2007}
6253 2007-Q2 @r{2nd quarter in 2007}
6254 2007 @r{the year 2007}
6255 today, yesterday, today-@var{N} @r{a relative day}
6256 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6257 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6258 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6259 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6260 :tstart @r{A time string specifying when to start considering times.}
6261 @r{Relative times like @code{"<-2w>"} can also be used. See}
6262 @r{@ref{Matching tags and properties} for relative time syntax.}
6263 :tend @r{A time string specifying when to stop considering times.}
6264 @r{Relative times like @code{"<now>"} can also be used. See}
6265 @r{@ref{Matching tags and properties} for relative time syntax.}
6266 :wstart @r{The starting day of the week. The default is 1 for monday.}
6267 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6268 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6269 :stepskip0 @r{Do not show steps that have zero time.}
6270 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6271 :tags @r{A tags match to select entries that should contribute. See}
6272 @r{@ref{Matching tags and properties} for the match syntax.}
6275 Then there are options which determine the formatting of the table. There
6276 options are interpreted by the function @code{org-clocktable-write-default},
6277 but you can specify your own function using the @code{:formatter} parameter.
6279 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6280 :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".}
6281 :link @r{Link the item headlines in the table to their origins.}
6282 :narrow @r{An integer to limit the width of the headline column in}
6283 @r{the org table. If you write it like @samp{50!}, then the}
6284 @r{headline will also be shortened in export.}
6285 :indent @r{Indent each headline field according to its level.}
6286 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6287 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6288 :level @r{Should a level number column be included?}
6289 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6290 @r{All are overwritten except if there is an explicit @code{:narrow}}
6291 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6292 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6293 :properties @r{List of properties that should be shown in the table. Each}
6294 @r{property will get its own column.}
6295 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6296 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6297 @r{As a special case, @samp{:formula %} adds a column with % time.}
6298 @r{If you do not specify a formula here, any existing formula}
6299 @r{below the clock table will survive updates and be evaluated.}
6300 :formatter @r{A function to format clock data and insert it into the buffer.}
6302 To get a clock summary of the current level 1 tree, for the current
6303 day, you could write
6305 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6309 and to use a specific time range you could write@footnote{Note that all
6310 parameters must be specified in a single line---the line is broken here
6311 only to fit it into the manual.}
6313 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6314 :tend "<2006-08-10 Thu 12:00>"
6317 A range starting a week ago and ending right now could be written as
6319 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6322 A summary of the current subtree with % times would be
6324 #+BEGIN: clocktable :scope subtree :link t :formula %
6327 A horizontally compact representation of everything clocked during last week
6330 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6334 @node Resolving idle time, , The clock table, Clocking work time
6335 @subsection Resolving idle time and continuous clocking
6337 @subsubheading Resolving idle time
6338 @cindex resolve idle time
6339 @vindex org-clock-x11idle-program-name
6341 @cindex idle, resolve, dangling
6342 If you clock in on a work item, and then walk away from your
6343 computer---perhaps to take a phone call---you often need to ``resolve'' the
6344 time you were away by either subtracting it from the current clock, or
6345 applying it to another one.
6347 @vindex org-clock-idle-time
6348 By customizing the variable @code{org-clock-idle-time} to some integer, such
6349 as 10 or 15, Emacs can alert you when you get back to your computer after
6350 being idle for that many minutes@footnote{On computers using Mac OS X,
6351 idleness is based on actual user idleness, not just Emacs' idle time. For
6352 X11, you can install a utility program @file{x11idle.c}, available in the
6353 @code{contrib/scripts} directory of the Org git distribution, or install the
6354 @file{xprintidle} package and set it to the variable
6355 @code{org-clock-x11idle-program-name} if you are running Debian, to get the
6356 same general treatment of idleness. On other systems, idle time refers to
6357 Emacs idle time only.}, and ask what you want to do with the idle time.
6358 There will be a question waiting for you when you get back, indicating how
6359 much idle time has passed (constantly updated with the current amount), as
6360 well as a set of choices to correct the discrepancy:
6364 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6365 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6366 effectively changing nothing, or enter a number to keep that many minutes.
6368 If you use the shift key and press @kbd{K}, it will keep however many minutes
6369 you request and then immediately clock out of that task. If you keep all of
6370 the minutes, this is the same as just clocking out of the current task.
6372 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6373 the clock, and then check back in from the moment you returned.
6375 To keep none of the minutes and just clock out at the start of the away time,
6376 use the shift key and press @kbd{S}. Remember that using shift will always
6377 leave you clocked out, no matter which option you choose.
6379 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6380 canceling you subtract the away time, and the resulting clock amount is less
6381 than a minute, the clock will still be canceled rather than clutter up the
6382 log with an empty entry.
6385 What if you subtracted those away minutes from the current clock, and now
6386 want to apply them to a new clock? Simply clock in to any task immediately
6387 after the subtraction. Org will notice that you have subtracted time ``on
6388 the books'', so to speak, and will ask if you want to apply those minutes to
6389 the next task you clock in on.
6391 There is one other instance when this clock resolution magic occurs. Say you
6392 were clocked in and hacking away, and suddenly your cat chased a mouse who
6393 scared a hamster that crashed into your UPS's power button! You suddenly
6394 lose all your buffers, but thanks to auto-save you still have your recent Org
6395 mode changes, including your last clock in.
6397 If you restart Emacs and clock into any task, Org will notice that you have a
6398 dangling clock which was never clocked out from your last session. Using
6399 that clock's starting time as the beginning of the unaccounted-for period,
6400 Org will ask how you want to resolve that time. The logic and behavior is
6401 identical to dealing with away time due to idleness; it is just happening due
6402 to a recovery event rather than a set amount of idle time.
6404 You can also check all the files visited by your Org agenda for dangling
6405 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6407 @subsubheading Continuous clocking
6408 @cindex continuous clocking
6409 @vindex org-clock-continuously
6411 You may want to start clocking from the time when you clocked out the
6412 previous task. To enable this systematically, set @code{org-clock-continuously}
6413 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6414 last clocked entry for this session, and start the new clock from there.
6416 If you only want this from time to time, use three universal prefix arguments
6417 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6419 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6420 @section Effort estimates
6421 @cindex effort estimates
6423 @cindex property, Effort
6424 @vindex org-effort-property
6425 If you want to plan your work in a very detailed way, or if you need to
6426 produce offers with quotations of the estimated work effort, you may want to
6427 assign effort estimates to entries. If you are also clocking your work, you
6428 may later want to compare the planned effort with the actual working time, a
6429 great way to improve planning estimates. Effort estimates are stored in a
6430 special property @samp{Effort}@footnote{You may change the property being
6431 used with the variable @code{org-effort-property}.}. You can set the effort
6432 for an entry with the following commands:
6435 @orgcmd{C-c C-x e,org-set-effort}
6436 Set the effort estimate for the current entry. With a numeric prefix
6437 argument, set it to the Nth allowed value (see below). This command is also
6438 accessible from the agenda with the @kbd{e} key.
6439 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6440 Modify the effort estimate of the item currently being clocked.
6443 Clearly the best way to work with effort estimates is through column view
6444 (@pxref{Column view}). You should start by setting up discrete values for
6445 effort estimates, and a @code{COLUMNS} format that displays these values
6446 together with clock sums (if you want to clock your time). For a specific
6450 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6451 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6455 @vindex org-global-properties
6456 @vindex org-columns-default-format
6457 or, even better, you can set up these values globally by customizing the
6458 variables @code{org-global-properties} and @code{org-columns-default-format}.
6459 In particular if you want to use this setup also in the agenda, a global
6460 setup may be advised.
6462 The way to assign estimates to individual items is then to switch to column
6463 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6464 value. The values you enter will immediately be summed up in the hierarchy.
6465 In the column next to it, any clocked time will be displayed.
6467 @vindex org-agenda-columns-add-appointments-to-effort-sum
6468 If you switch to column view in the daily/weekly agenda, the effort column
6469 will summarize the estimated work effort for each day@footnote{Please note
6470 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6471 column view}).}, and you can use this to find space in your schedule. To get
6472 an overview of the entire part of the day that is committed, you can set the
6473 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6474 appointments on a day that take place over a specified time interval will
6475 then also be added to the load estimate of the day.
6477 Effort estimates can be used in secondary agenda filtering that is triggered
6478 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6479 these estimates defined consistently, two or three key presses will narrow
6480 down the list to stuff that fits into an available time slot.
6482 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6483 @section Taking notes with a relative timer
6484 @cindex relative timer
6486 When taking notes during, for example, a meeting or a video viewing, it can
6487 be useful to have access to times relative to a starting time. Org provides
6488 such a relative timer and make it easy to create timed notes.
6491 @orgcmd{C-c C-x .,org-timer}
6492 Insert a relative time into the buffer. The first time you use this, the
6493 timer will be started. When called with a prefix argument, the timer is
6495 @orgcmd{C-c C-x -,org-timer-item}
6496 Insert a description list item with the current relative time. With a prefix
6497 argument, first reset the timer to 0.
6498 @orgcmd{M-@key{RET},org-insert-heading}
6499 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6501 @c for key sequences with a comma, command name macros fail :(
6504 Pause the timer, or continue it if it is already paused
6505 (@command{org-timer-pause-or-continue}).
6506 @c removed the sentence because it is redundant to the following item
6507 @kindex C-u C-c C-x ,
6509 Stop the timer. After this, you can only start a new timer, not continue the
6510 old one. This command also removes the timer from the mode line.
6511 @orgcmd{C-c C-x 0,org-timer-start}
6512 Reset the timer without inserting anything into the buffer. By default, the
6513 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6514 specific starting offset. The user is prompted for the offset, with a
6515 default taken from a timer string at point, if any, So this can be used to
6516 restart taking notes after a break in the process. When called with a double
6517 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6518 by a certain amount. This can be used to fix timer strings if the timer was
6519 not started at exactly the right moment.
6522 @node Countdown timer, , Relative timer, Dates and Times
6523 @section Countdown timer
6524 @cindex Countdown timer
6528 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6529 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6531 @code{org-timer-set-timer} prompts the user for a duration and displays a
6532 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6533 default countdown value. Giving a prefix numeric argument overrides this
6536 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6537 @chapter Capture - Refile - Archive
6540 An important part of any organization system is the ability to quickly
6541 capture new ideas and tasks, and to associate reference material with them.
6542 Org does this using a process called @i{capture}. It also can store files
6543 related to a task (@i{attachments}) in a special directory. Once in the
6544 system, tasks and projects need to be moved around. Moving completed project
6545 trees to an archive file keeps the system compact and fast.
6548 * Capture:: Capturing new stuff
6549 * Attachments:: Add files to tasks
6550 * RSS Feeds:: Getting input from RSS feeds
6551 * Protocols:: External (e.g., Browser) access to Emacs and Org
6552 * Refile and copy:: Moving/copying a tree from one place to another
6553 * Archiving:: What to do with finished projects
6556 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6560 Org's method for capturing new items is heavily inspired by John Wiegley
6561 excellent remember package. Up to version 6.36 Org used a special setup
6562 for @file{remember.el}. @file{org-remember.el} is still part of Org mode for
6563 backward compatibility with existing setups. You can find the documentation
6564 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6566 The new capturing setup described here is preferred and should be used by new
6567 users. To convert your @code{org-remember-templates}, run the command
6569 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6571 @noindent and then customize the new variable with @kbd{M-x
6572 customize-variable org-capture-templates}, check the result, and save the
6573 customization. You can then use both remember and capture until
6574 you are familiar with the new mechanism.
6576 Capture lets you quickly store notes with little interruption of your work
6577 flow. The basic process of capturing is very similar to remember, but Org
6578 does enhance it with templates and more.
6581 * Setting up capture:: Where notes will be stored
6582 * Using capture:: Commands to invoke and terminate capture
6583 * Capture templates:: Define the outline of different note types
6586 @node Setting up capture, Using capture, Capture, Capture
6587 @subsection Setting up capture
6589 The following customization sets a default target file for notes, and defines
6590 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6591 suggestion.} for capturing new material.
6593 @vindex org-default-notes-file
6595 (setq org-default-notes-file (concat org-directory "/notes.org"))
6596 (define-key global-map "\C-cc" 'org-capture)
6599 @node Using capture, Capture templates, Setting up capture, Capture
6600 @subsection Using capture
6603 @orgcmd{C-c c,org-capture}
6604 Call the command @code{org-capture}. Note that this keybinding is global and
6605 not active by default: you need to install it. If you have templates
6607 defined @pxref{Capture templates}, it will offer these templates for
6608 selection or use a new Org outline node as the default template. It will
6609 insert the template into the target file and switch to an indirect buffer
6610 narrowed to this new node. You may then insert the information you want.
6612 @orgcmd{C-c C-c,org-capture-finalize}
6613 Once you have finished entering information into the capture buffer, @kbd{C-c
6614 C-c} will return you to the window configuration before the capture process,
6615 so that you can resume your work without further distraction. When called
6616 with a prefix arg, finalize and then jump to the captured item.
6618 @orgcmd{C-c C-w,org-capture-refile}
6619 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6620 a different place. Please realize that this is a normal refiling command
6621 that will be executed---so the cursor position at the moment you run this
6622 command is important. If you have inserted a tree with a parent and
6623 children, first move the cursor back to the parent. Any prefix argument
6624 given to this command will be passed on to the @code{org-refile} command.
6626 @orgcmd{C-c C-k,org-capture-kill}
6627 Abort the capture process and return to the previous state.
6631 You can also call @code{org-capture} in a special way from the agenda, using
6632 the @kbd{k c} key combination. With this access, any timestamps inserted by
6633 the selected capture template will default to the cursor date in the agenda,
6634 rather than to the current date.
6636 To find the locations of the last stored capture, use @code{org-capture} with
6641 Visit the target location of a capture template. You get to select the
6642 template in the usual way.
6643 @orgkey{C-u C-u C-c c}
6644 Visit the last stored capture item in its buffer.
6647 @vindex org-capture-bookmark
6648 @cindex org-capture-last-stored
6649 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6650 automatically be created unless you set @code{org-capture-bookmark} to
6653 To insert the capture at point in an Org buffer, call @code{org-capture} with
6654 a @code{C-0} prefix argument.
6656 @node Capture templates, , Using capture, Capture
6657 @subsection Capture templates
6658 @cindex templates, for Capture
6660 You can use templates for different types of capture items, and
6661 for different target locations. The easiest way to create such templates is
6662 through the customize interface.
6666 Customize the variable @code{org-capture-templates}.
6669 Before we give the formal description of template definitions, let's look at
6670 an example. Say you would like to use one template to create general TODO
6671 entries, and you want to put these entries under the heading @samp{Tasks} in
6672 your file @file{~/org/gtd.org}. Also, a date tree in the file
6673 @file{journal.org} should capture journal entries. A possible configuration
6677 (setq org-capture-templates
6678 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6679 "* TODO %?\n %i\n %a")
6680 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6681 "* %?\nEntered on %U\n %i\n %a")))
6684 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6688 [[file:@var{link to where you initiated capture}]]
6692 During expansion of the template, @code{%a} has been replaced by a link to
6693 the location from where you called the capture command. This can be
6694 extremely useful for deriving tasks from emails, for example. You fill in
6695 the task definition, press @code{C-c C-c} and Org returns you to the same
6696 place where you started the capture process.
6698 To define special keys to capture to a particular template without going
6699 through the interactive template selection, you can create your key binding
6703 (define-key global-map "\C-cx"
6704 (lambda () (interactive) (org-capture nil "x")))
6708 * Template elements:: What is needed for a complete template entry
6709 * Template expansion:: Filling in information about time and context
6710 * Templates in contexts:: Only show a template in a specific context
6713 @node Template elements, Template expansion, Capture templates, Capture templates
6714 @subsubsection Template elements
6716 Now lets look at the elements of a template definition. Each entry in
6717 @code{org-capture-templates} is a list with the following items:
6721 The keys that will select the template, as a string, characters
6722 only, for example @code{"a"} for a template to be selected with a
6723 single key, or @code{"bt"} for selection with two keys. When using
6724 several keys, keys using the same prefix key must be sequential
6725 in the list and preceded by a 2-element entry explaining the
6726 prefix key, for example
6728 ("b" "Templates for marking stuff to buy")
6730 @noindent If you do not define a template for the @kbd{C} key, this key will
6731 be used to open the customize buffer for this complex variable.
6734 A short string describing the template, which will be shown during
6738 The type of entry, a symbol. Valid values are:
6741 An Org mode node, with a headline. Will be filed as the child of the target
6742 entry or as a top-level entry. The target file should be an Org mode file.
6744 A plain list item, placed in the first plain list at the target
6745 location. Again the target file should be an Org file.
6747 A checkbox item. This only differs from the plain list item by the
6750 a new line in the first table at the target location. Where exactly the
6751 line will be inserted depends on the properties @code{:prepend} and
6752 @code{:table-line-pos} (see below).
6754 Text to be inserted as it is.
6758 @vindex org-default-notes-file
6759 Specification of where the captured item should be placed. In Org mode
6760 files, targets usually define a node. Entries will become children of this
6761 node. Other types will be added to the table or list in the body of this
6762 node. Most target specifications contain a file name. If that file name is
6763 the empty string, it defaults to @code{org-default-notes-file}. A file can
6764 also be given as a variable, function, or Emacs Lisp form.
6768 @item (file "path/to/file")
6769 Text will be placed at the beginning or end of that file.
6771 @item (id "id of existing org entry")
6772 Filing as child of this entry, or in the body of the entry.
6774 @item (file+headline "path/to/file" "node headline")
6775 Fast configuration if the target heading is unique in the file.
6777 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6778 For non-unique headings, the full path is safer.
6780 @item (file+regexp "path/to/file" "regexp to find location")
6781 Use a regular expression to position the cursor.
6783 @item (file+datetree "path/to/file")
6784 Will create a heading in a date tree for today's date.
6786 @item (file+datetree+prompt "path/to/file")
6787 Will create a heading in a date tree, but will prompt for the date.
6789 @item (file+function "path/to/file" function-finding-location)
6790 A function to find the right location in the file.
6793 File to the entry that is currently being clocked.
6795 @item (function function-finding-location)
6796 Most general way, write your own function to find both
6801 The template for creating the capture item. If you leave this empty, an
6802 appropriate default template will be used. Otherwise this is a string with
6803 escape codes, which will be replaced depending on time and context of the
6804 capture call. The string with escapes may be loaded from a template file,
6805 using the special syntax @code{(file "path/to/template")}. See below for
6809 The rest of the entry is a property list of additional options.
6810 Recognized properties are:
6813 Normally new captured information will be appended at
6814 the target location (last child, last table line, last list item...).
6815 Setting this property will change that.
6817 @item :immediate-finish
6818 When set, do not offer to edit the information, just
6819 file it away immediately. This makes sense if the template only needs
6820 information that can be added automatically.
6823 Set this to the number of lines to insert
6824 before and after the new item. Default 0, only common other value is 1.
6827 Start the clock in this item.
6830 Keep the clock running when filing the captured entry.
6833 If starting the capture interrupted a clock, restart that clock when finished
6834 with the capture. Note that @code{:clock-keep} has precedence over
6835 @code{:clock-resume}. When setting both to @code{t}, the current clock will
6836 run and the previous one will not be resumed.
6839 Do not narrow the target buffer, simply show the full buffer. Default is to
6840 narrow it so that you only see the new material.
6842 @item :table-line-pos
6843 Specification of the location in the table where the new line should be
6844 inserted. It should be a string like @code{"II-3"} meaning that the new
6845 line should become the third line before the second horizontal separator
6849 If the target file was not yet visited when capture was invoked, kill the
6850 buffer again after capture is completed.
6854 @node Template expansion, Templates in contexts, Template elements, Capture templates
6855 @subsubsection Template expansion
6857 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6858 these sequences literally, escape the @kbd{%} with a backslash.} allow
6859 dynamic insertion of content. The templates are expanded in the order given here:
6862 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
6863 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
6864 @r{For convenience, %:keyword (see below) placeholders}
6865 @r{within the expression will be expanded prior to this.}
6866 @r{The sexp must return a string.}
6867 %<...> @r{The result of format-time-string on the ... format specification.}
6868 %t @r{Timestamp, date only.}
6869 %T @r{Timestamp, with date and time.}
6870 %u, %U @r{Like the above, but inactive timestamps.}
6871 %i @r{Initial content, the region when capture is called while the}
6872 @r{region is active.}
6873 @r{The entire text will be indented like @code{%i} itself.}
6874 %a @r{Annotation, normally the link created with @code{org-store-link}.}
6875 %A @r{Like @code{%a}, but prompt for the description part.}
6876 %l @r{Like %a, but only insert the literal link.}
6877 %c @r{Current kill ring head.}
6878 %x @r{Content of the X clipboard.}
6879 %k @r{Title of the currently clocked task.}
6880 %K @r{Link to the currently clocked task.}
6881 %n @r{User name (taken from @code{user-full-name}).}
6882 %f @r{File visited by current buffer when org-capture was called.}
6883 %F @r{Full path of the file or directory visited by current buffer.}
6884 %:keyword @r{Specific information for certain link types, see below.}
6885 %^g @r{Prompt for tags, with completion on tags in target file.}
6886 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
6887 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
6888 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
6889 %^C @r{Interactive selection of which kill or clip to use.}
6890 %^L @r{Like @code{%^C}, but insert as link.}
6891 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
6892 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6893 @r{You may specify a default value and a completion table with}
6894 @r{%^@{prompt|default|completion2|completion3...@}.}
6895 @r{The arrow keys access a prompt-specific history.}
6896 %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
6897 @r{a number, starting from 1.}
6898 %? @r{After completing the template, position cursor here.}
6902 For specific link types, the following keywords will be
6903 defined@footnote{If you define your own link types (@pxref{Adding
6904 hyperlink types}), any property you store with
6905 @code{org-store-link-props} can be accessed in capture templates in a
6908 @vindex org-from-is-user-regexp
6910 Link type | Available keywords
6911 ---------------------------------+----------------------------------------------
6912 bbdb | %:name %:company
6913 irc | %:server %:port %:nick
6914 vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
6915 | %:from %:fromname %:fromaddress
6916 | %:to %:toname %:toaddress
6917 | %:date @r{(message date header field)}
6918 | %:date-timestamp @r{(date as active timestamp)}
6919 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6920 | %: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}.}}
6921 gnus | %:group, @r{for messages also all email fields}
6923 info | %:file %:node
6928 To place the cursor after template expansion use:
6931 %? @r{After completing the template, position cursor here.}
6934 @node Templates in contexts, , Template expansion, Capture templates
6935 @subsubsection Templates in contexts
6937 @vindex org-capture-templates-contexts
6938 To control whether a capture template should be accessible from a specific
6939 context, you can customize @var{org-capture-templates-contexts}. Let's say
6940 for example that you have a capture template @code{"p"} for storing Gnus
6941 emails containing patches. Then you would configure this option like this:
6944 (setq org-capture-templates-contexts
6945 '(("p" (in-mode . "message-mode"))))
6948 You can also tell that the command key @code{"p"} should refer to another
6949 template. In that case, add this command key like this:
6952 (setq org-capture-templates-contexts
6953 '(("p" "q" (in-mode . "message-mode"))))
6956 See the docstring of the variable for more information.
6958 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6959 @section Attachments
6962 @vindex org-attach-directory
6963 It is often useful to associate reference material with an outline node/task.
6964 Small chunks of plain text can simply be stored in the subtree of a project.
6965 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6966 files that live elsewhere on your computer or in the cloud, like emails or
6967 source code files belonging to a project. Another method is @i{attachments},
6968 which are files located in a directory belonging to an outline node. Org
6969 uses directories named by the unique ID of each entry. These directories are
6970 located in the @file{data} directory which lives in the same directory where
6971 your Org file lives@footnote{If you move entries or Org files from one
6972 directory to another, you may want to configure @code{org-attach-directory}
6973 to contain an absolute path.}. If you initialize this directory with
6974 @code{git init}, Org will automatically commit changes when it sees them.
6975 The attachment system has been contributed to Org by John Wiegley.
6977 In cases where it seems better to do so, you can also attach a directory of your
6978 choice to an entry. You can also make children inherit the attachment
6979 directory from a parent, so that an entire subtree uses the same attached
6982 @noindent The following commands deal with attachments:
6986 @orgcmd{C-c C-a,org-attach}
6987 The dispatcher for commands related to the attachment system. After these
6988 keys, a list of commands is displayed and you must press an additional key
6989 to select a command:
6992 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
6993 @vindex org-attach-method
6994 Select a file and move it into the task's attachment directory. The file
6995 will be copied, moved, or linked, depending on @code{org-attach-method}.
6996 Note that hard links are not supported on all systems.
7002 Attach a file using the copy/move/link method.
7003 Note that hard links are not supported on all systems.
7005 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7006 Create a new attachment as an Emacs buffer.
7008 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7009 Synchronize the current task with its attachment directory, in case you added
7010 attachments yourself.
7012 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7013 @vindex org-file-apps
7014 Open current task's attachment. If there is more than one, prompt for a
7015 file name first. Opening will follow the rules set by @code{org-file-apps}.
7016 For more details, see the information on following hyperlinks
7017 (@pxref{Handling links}).
7019 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7020 Also open the attachment, but force opening the file in Emacs.
7022 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7023 Open the current task's attachment directory.
7025 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7026 Also open the directory, but force using @command{dired} in Emacs.
7028 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7029 Select and delete a single attachment.
7031 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7032 Delete all of a task's attachments. A safer way is to open the directory in
7033 @command{dired} and delete from there.
7035 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7036 @cindex property, ATTACH_DIR
7037 Set a specific directory as the entry's attachment directory. This works by
7038 putting the directory path into the @code{ATTACH_DIR} property.
7040 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7041 @cindex property, ATTACH_DIR_INHERIT
7042 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7043 same directory for attachments as the parent does.
7047 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
7052 Org can add and change entries based on information found in RSS feeds and
7053 Atom feeds. You could use this to make a task out of each new podcast in a
7054 podcast feed. Or you could use a phone-based note-creating service on the
7055 web to import tasks into Org. To access feeds, configure the variable
7056 @code{org-feed-alist}. The docstring of this variable has detailed
7057 information. Here is just an example:
7060 (setq org-feed-alist
7062 "http://rss.slashdot.org/Slashdot/slashdot"
7063 "~/txt/org/feeds.org" "Slashdot Entries")))
7067 will configure that new items from the feed provided by
7068 @code{rss.slashdot.org} will result in new entries in the file
7069 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7070 the following command is used:
7073 @orgcmd{C-c C-x g,org-feed-update-all}
7075 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7077 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7078 Prompt for a feed name and go to the inbox configured for this feed.
7081 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7082 it will store information about the status of items in the feed, to avoid
7083 adding the same item several times. You should add @samp{FEEDSTATUS} to the
7084 list of drawers in that file:
7087 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
7090 For more information, including how to read atom feeds, see
7091 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7093 @node Protocols, Refile and copy, RSS Feeds, Capture - Refile - Archive
7094 @section Protocols for external access
7095 @cindex protocols, for external access
7098 You can set up Org for handling protocol calls from outside applications that
7099 are passed to Emacs through the @file{emacsserver}. For example, you can
7100 configure bookmarks in your web browser to send a link to the current page to
7101 Org and create a note from it using capture (@pxref{Capture}). Or you
7102 could create a bookmark that will tell Emacs to open the local source file of
7103 a remote website you are looking at with the browser. See
7104 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7105 documentation and setup instructions.
7107 @node Refile and copy, Archiving, Protocols, Capture - Refile - Archive
7108 @section Refile and copy
7109 @cindex refiling notes
7110 @cindex copying notes
7112 When reviewing the captured data, you may want to refile or to copy some of
7113 the entries into a different list, for example into a project. Cutting,
7114 finding the right location, and then pasting the note is cumbersome. To
7115 simplify this process, you can use the following special command:
7118 @orgcmd{C-c M-w,org-copy}
7120 Copying works like refiling, except that the original note is not deleted.
7121 @orgcmd{C-c C-w,org-refile}
7123 @vindex org-reverse-note-order
7124 @vindex org-refile-targets
7125 @vindex org-refile-use-outline-path
7126 @vindex org-outline-path-complete-in-steps
7127 @vindex org-refile-allow-creating-parent-nodes
7128 @vindex org-log-refile
7129 @vindex org-refile-use-cache
7130 Refile the entry or region at point. This command offers possible locations
7131 for refiling the entry and lets you select one with completion. The item (or
7132 all items in the region) is filed below the target heading as a subitem.
7133 Depending on @code{org-reverse-note-order}, it will be either the first or
7135 By default, all level 1 headlines in the current buffer are considered to be
7136 targets, but you can have more complex definitions across a number of files.
7137 See the variable @code{org-refile-targets} for details. If you would like to
7138 select a location via a file-path-like completion along the outline path, see
7139 the variables @code{org-refile-use-outline-path} and
7140 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7141 create new nodes as new parents for refiling on the fly, check the
7142 variable @code{org-refile-allow-creating-parent-nodes}.
7143 When the variable @code{org-log-refile}@footnote{with corresponding
7144 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7145 and @code{nologrefile}} is set, a timestamp or a note will be
7146 recorded when an entry has been refiled.
7147 @orgkey{C-u C-c C-w}
7148 Use the refile interface to jump to a heading.
7149 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7150 Jump to the location where @code{org-refile} last moved a tree to.
7152 Refile as the child of the item currently being clocked.
7153 @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}
7154 Clear the target cache. Caching of refile targets can be turned on by
7155 setting @code{org-refile-use-cache}. To make the command see new possible
7156 targets, you have to clear the cache with this command.
7159 @node Archiving, , Refile and copy, Capture - Refile - Archive
7163 When a project represented by a (sub)tree is finished, you may want
7164 to move the tree out of the way and to stop it from contributing to the
7165 agenda. Archiving is important to keep your working files compact and global
7166 searches like the construction of agenda views fast.
7169 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7170 @vindex org-archive-default-command
7171 Archive the current entry using the command specified in the variable
7172 @code{org-archive-default-command}.
7176 * Moving subtrees:: Moving a tree to an archive file
7177 * Internal archiving:: Switch off a tree but keep it in the file
7180 @node Moving subtrees, Internal archiving, Archiving, Archiving
7181 @subsection Moving a tree to the archive file
7182 @cindex external archiving
7184 The most common archiving action is to move a project tree to another file,
7188 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7189 @vindex org-archive-location
7190 Archive the subtree starting at the cursor position to the location
7191 given by @code{org-archive-location}.
7192 @orgkey{C-u C-c C-x C-s}
7193 Check if any direct children of the current headline could be moved to
7194 the archive. To do this, each subtree is checked for open TODO entries.
7195 If none are found, the command offers to move it to the archive
7196 location. If the cursor is @emph{not} on a headline when this command
7197 is invoked, the level 1 trees will be checked.
7200 @cindex archive locations
7201 The default archive location is a file in the same directory as the
7202 current file, with the name derived by appending @file{_archive} to the
7203 current file name. You can also choose what heading to file archived
7204 items under, with the possibility to add them to a datetree in a file.
7205 For information and examples on how to specify the file and the heading,
7206 see the documentation string of the variable
7207 @code{org-archive-location}.
7209 There is also an in-buffer option for setting this variable, for
7210 example@footnote{For backward compatibility, the following also works:
7211 If there are several such lines in a file, each specifies the archive
7212 location for the text below it. The first such line also applies to any
7213 text before its definition. However, using this method is
7214 @emph{strongly} deprecated as it is incompatible with the outline
7215 structure of the document. The correct method for setting multiple
7216 archive locations in a buffer is using properties.}:
7220 #+ARCHIVE: %s_done::
7223 @cindex property, ARCHIVE
7225 If you would like to have a special ARCHIVE location for a single entry
7226 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7227 location as the value (@pxref{Properties and Columns}).
7229 @vindex org-archive-save-context-info
7230 When a subtree is moved, it receives a number of special properties that
7231 record context information like the file from where the entry came, its
7232 outline path the archiving time etc. Configure the variable
7233 @code{org-archive-save-context-info} to adjust the amount of information
7237 @node Internal archiving, , Moving subtrees, Archiving
7238 @subsection Internal archiving
7240 If you want to just switch off (for agenda views) certain subtrees without
7241 moving them to a different file, you can use the @code{ARCHIVE tag}.
7243 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7244 its location in the outline tree, but behaves in the following way:
7247 @vindex org-cycle-open-archived-trees
7248 It does not open when you attempt to do so with a visibility cycling
7249 command (@pxref{Visibility cycling}). You can force cycling archived
7250 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7251 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7252 @code{show-all} will open archived subtrees.
7254 @vindex org-sparse-tree-open-archived-trees
7255 During sparse tree construction (@pxref{Sparse trees}), matches in
7256 archived subtrees are not exposed, unless you configure the option
7257 @code{org-sparse-tree-open-archived-trees}.
7259 @vindex org-agenda-skip-archived-trees
7260 During agenda view construction (@pxref{Agenda Views}), the content of
7261 archived trees is ignored unless you configure the option
7262 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7263 be included. In the agenda you can press @kbd{v a} to get archives
7264 temporarily included.
7266 @vindex org-export-with-archived-trees
7267 Archived trees are not exported (@pxref{Exporting}), only the headline
7268 is. Configure the details using the variable
7269 @code{org-export-with-archived-trees}.
7271 @vindex org-columns-skip-archived-trees
7272 Archived trees are excluded from column view unless the variable
7273 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7276 The following commands help manage the ARCHIVE tag:
7279 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7280 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7281 the headline changes to a shadowed face, and the subtree below it is
7283 @orgkey{C-u C-c C-x a}
7284 Check if any direct children of the current headline should be archived.
7285 To do this, each subtree is checked for open TODO entries. If none are
7286 found, the command offers to set the ARCHIVE tag for the child. If the
7287 cursor is @emph{not} on a headline when this command is invoked, the
7288 level 1 trees will be checked.
7289 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7290 Cycle a tree even if it is tagged with ARCHIVE.
7291 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7292 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7293 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7294 entry becomes a child of that sibling and in this way retains a lot of its
7295 original context, including inherited tags and approximate position in the
7300 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7301 @chapter Agenda views
7302 @cindex agenda views
7304 Due to the way Org works, TODO items, time-stamped items, and
7305 tagged headlines can be scattered throughout a file or even a number of
7306 files. To get an overview of open action items, or of events that are
7307 important for a particular date, this information must be collected,
7308 sorted and displayed in an organized way.
7310 Org can select items based on various criteria and display them
7311 in a separate buffer. Seven different view types are provided:
7315 an @emph{agenda} that is like a calendar and shows information
7318 a @emph{TODO list} that covers all unfinished
7321 a @emph{match view}, showings headlines based on the tags, properties, and
7322 TODO state associated with them,
7324 a @emph{timeline view} that shows all events in a single Org file,
7325 in time-sorted view,
7327 a @emph{text search view} that shows all entries from multiple files
7328 that contain specified keywords,
7330 a @emph{stuck projects view} showing projects that currently don't move
7333 @emph{custom views} that are special searches and combinations of different
7338 The extracted information is displayed in a special @emph{agenda
7339 buffer}. This buffer is read-only, but provides commands to visit the
7340 corresponding locations in the original Org files, and even to
7341 edit these files remotely.
7343 @vindex org-agenda-window-setup
7344 @vindex org-agenda-restore-windows-after-quit
7345 Two variables control how the agenda buffer is displayed and whether the
7346 window configuration is restored when the agenda exits:
7347 @code{org-agenda-window-setup} and
7348 @code{org-agenda-restore-windows-after-quit}.
7351 * Agenda files:: Files being searched for agenda information
7352 * Agenda dispatcher:: Keyboard access to agenda views
7353 * Built-in agenda views:: What is available out of the box?
7354 * Presentation and sorting:: How agenda items are prepared for display
7355 * Agenda commands:: Remote editing of Org trees
7356 * Custom agenda views:: Defining special searches and views
7357 * Exporting Agenda Views:: Writing a view to a file
7358 * Agenda column view:: Using column view for collected entries
7361 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7362 @section Agenda files
7363 @cindex agenda files
7364 @cindex files for agenda
7366 @vindex org-agenda-files
7367 The information to be shown is normally collected from all @emph{agenda
7368 files}, the files listed in the variable
7369 @code{org-agenda-files}@footnote{If the value of that variable is not a
7370 list, but a single file name, then the list of agenda files will be
7371 maintained in that external file.}. If a directory is part of this list,
7372 all files with the extension @file{.org} in this directory will be part
7375 Thus, even if you only work with a single Org file, that file should
7376 be put into the list@footnote{When using the dispatcher, pressing
7377 @kbd{<} before selecting a command will actually limit the command to
7378 the current file, and ignore @code{org-agenda-files} until the next
7379 dispatcher command.}. You can customize @code{org-agenda-files}, but
7380 the easiest way to maintain it is through the following commands
7382 @cindex files, adding to agenda list
7384 @orgcmd{C-c [,org-agenda-file-to-front}
7385 Add current file to the list of agenda files. The file is added to
7386 the front of the list. If it was already in the list, it is moved to
7387 the front. With a prefix argument, file is added/moved to the end.
7388 @orgcmd{C-c ],org-remove-file}
7389 Remove current file from the list of agenda files.
7391 @cindex cycling, of agenda files
7392 @orgcmd{C-',org-cycle-agenda-files}
7394 Cycle through agenda file list, visiting one file after the other.
7395 @kindex M-x org-iswitchb
7396 @item M-x org-iswitchb
7397 Command to use an @code{iswitchb}-like interface to switch to and between Org
7402 The Org menu contains the current list of files and can be used
7403 to visit any of them.
7405 If you would like to focus the agenda temporarily on a file not in
7406 this list, or on just one file in the list, or even on only a subtree in a
7407 file, then this can be done in different ways. For a single agenda command,
7408 you may press @kbd{<} once or several times in the dispatcher
7409 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7410 extended period, use the following commands:
7413 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7414 Permanently restrict the agenda to the current subtree. When with a
7415 prefix argument, or with the cursor before the first headline in a file,
7416 the agenda scope is set to the entire file. This restriction remains in
7417 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7418 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7419 agenda view, the new restriction takes effect immediately.
7420 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7421 Remove the permanent restriction created by @kbd{C-c C-x <}.
7425 When working with @file{speedbar.el}, you can use the following commands in
7428 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7429 Permanently restrict the agenda to the item---either an Org file or a subtree
7430 in such a file---at the cursor in the Speedbar frame.
7431 If there is a window displaying an agenda view, the new restriction takes
7433 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7434 Lift the restriction.
7437 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7438 @section The agenda dispatcher
7439 @cindex agenda dispatcher
7440 @cindex dispatching agenda commands
7441 The views are created through a dispatcher, which should be bound to a
7442 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7443 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7444 is accessed and list keyboard access to commands accordingly. After
7445 pressing @kbd{C-c a}, an additional letter is required to execute a
7446 command. The dispatcher offers the following default commands:
7449 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7451 Create a list of all TODO items (@pxref{Global TODO list}).
7453 Create a list of headlines matching a TAGS expression (@pxref{Matching
7454 tags and properties}).
7456 Create the timeline view for the current buffer (@pxref{Timeline}).
7458 Create a list of entries selected by a boolean expression of keywords
7459 and/or regular expressions that must or must not occur in the entry.
7461 @vindex org-agenda-text-search-extra-files
7462 Search for a regular expression in all agenda files and additionally in
7463 the files listed in @code{org-agenda-text-search-extra-files}. This
7464 uses the Emacs command @code{multi-occur}. A prefix argument can be
7465 used to specify the number of context lines for each match, default is
7468 Create a list of stuck projects (@pxref{Stuck projects}).
7470 Restrict an agenda command to the current buffer@footnote{For backward
7471 compatibility, you can also press @kbd{1} to restrict to the current
7472 buffer.}. After pressing @kbd{<}, you still need to press the character
7473 selecting the command.
7475 If there is an active region, restrict the following agenda command to
7476 the region. Otherwise, restrict it to the current subtree@footnote{For
7477 backward compatibility, you can also press @kbd{0} to restrict to the
7478 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7479 character selecting the command.
7482 @vindex org-agenda-sticky
7483 Toggle sticky agenda views. By default, Org maintains only a single agenda
7484 buffer and rebuilds it each time you change the view, to make sure everything
7485 is always up to date. If you switch between views often and the build time
7486 bothers you, you can turn on sticky agenda buffers (make this the default by
7487 customizing the variable @code{org-agenda-sticky}). With sticky agendas, the
7488 dispatcher only switches to the selected view, you need to update it by hand
7489 with @kbd{r} or @kbd{g}. You can toggle sticky agenda view any time with
7490 @code{org-toggle-sticky-agenda}.
7493 You can also define custom commands that will be accessible through the
7494 dispatcher, just like the default commands. This includes the
7495 possibility to create extended agenda buffers that contain several
7496 blocks together, for example the weekly agenda, the global TODO list and
7497 a number of special tags matches. @xref{Custom agenda views}.
7499 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7500 @section The built-in agenda views
7502 In this section we describe the built-in views.
7505 * Weekly/daily agenda:: The calendar page with current tasks
7506 * Global TODO list:: All unfinished action items
7507 * Matching tags and properties:: Structured information with fine-tuned search
7508 * Timeline:: Time-sorted view for single file
7509 * Search view:: Find entries by searching for text
7510 * Stuck projects:: Find projects you need to review
7513 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7514 @subsection The weekly/daily agenda
7516 @cindex weekly agenda
7517 @cindex daily agenda
7519 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7520 paper agenda, showing all the tasks for the current week or day.
7523 @cindex org-agenda, command
7524 @orgcmd{C-c a a,org-agenda-list}
7525 Compile an agenda for the current week from a list of Org files. The agenda
7526 shows the entries for each day. With a numeric prefix@footnote{For backward
7527 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7528 listed before the agenda. This feature is deprecated, use the dedicated TODO
7529 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7530 C-c a a}) you may set the number of days to be displayed.
7533 @vindex org-agenda-span
7534 @vindex org-agenda-ndays
7535 The default number of days displayed in the agenda is set by the variable
7536 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7537 variable can be set to any number of days you want to see by default in the
7538 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7541 Remote editing from the agenda buffer means, for example, that you can
7542 change the dates of deadlines and appointments from the agenda buffer.
7543 The commands available in the Agenda buffer are listed in @ref{Agenda
7546 @subsubheading Calendar/Diary integration
7547 @cindex calendar integration
7548 @cindex diary integration
7550 Emacs contains the calendar and diary by Edward M. Reingold. The
7551 calendar displays a three-month calendar with holidays from different
7552 countries and cultures. The diary allows you to keep track of
7553 anniversaries, lunar phases, sunrise/set, recurrent appointments
7554 (weekly, monthly) and more. In this way, it is quite complementary to
7555 Org. It can be very useful to combine output from Org with
7558 In order to include entries from the Emacs diary into Org mode's
7559 agenda, you only need to customize the variable
7562 (setq org-agenda-include-diary t)
7565 @noindent After that, everything will happen automatically. All diary
7566 entries including holidays, anniversaries, etc., will be included in the
7567 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7568 @key{RET} can be used from the agenda buffer to jump to the diary
7569 file in order to edit existing diary entries. The @kbd{i} command to
7570 insert new entries for the current date works in the agenda buffer, as
7571 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7572 Sunrise/Sunset times, show lunar phases and to convert to other
7573 calendars, respectively. @kbd{c} can be used to switch back and forth
7574 between calendar and agenda.
7576 If you are using the diary only for sexp entries and holidays, it is
7577 faster to not use the above setting, but instead to copy or even move
7578 the entries into an Org file. Org mode evaluates diary-style sexp
7579 entries, and does it faster because there is no overhead for first
7580 creating the diary display. Note that the sexp entries must start at
7581 the left margin, no whitespace is allowed before them. For example,
7582 the following segment of an Org file will be processed and entries
7583 will be made in the agenda:
7586 * Birthdays and similar stuff
7588 %%(org-calendar-holiday) ; special function for holiday names
7590 %%(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
7591 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7594 @subsubheading Anniversaries from BBDB
7595 @cindex BBDB, anniversaries
7596 @cindex anniversaries, from BBDB
7598 If you are using the Big Brothers Database to store your contacts, you will
7599 very likely prefer to store anniversaries in BBDB rather than in a
7600 separate Org or diary file. Org supports this and will show BBDB
7601 anniversaries as part of the agenda. All you need to do is to add the
7602 following to one of your agenda files:
7609 %%(org-bbdb-anniversaries)
7612 You can then go ahead and define anniversaries for a BBDB record. Basically,
7613 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7614 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7615 followed by a space and the class of the anniversary (@samp{birthday} or
7616 @samp{wedding}, or a format string). If you omit the class, it will default to
7617 @samp{birthday}. Here are a few examples, the header for the file
7618 @file{org-bbdb.el} contains more detailed information.
7624 2008-04-14 %s released version 6.01 of org mode, %d years ago
7627 After a change to BBDB, or for the first agenda display during an Emacs
7628 session, the agenda display will suffer a short delay as Org updates its
7629 hash with anniversaries. However, from then on things will be very fast---much
7630 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7631 in an Org or Diary file.
7633 @subsubheading Appointment reminders
7634 @cindex @file{appt.el}
7635 @cindex appointment reminders
7639 Org can interact with Emacs appointments notification facility. To add the
7640 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7641 This command lets you filter through the list of your appointments and add
7642 only those belonging to a specific category or matching a regular expression.
7643 It also reads a @code{APPT_WARNTIME} property which will then override the
7644 value of @code{appt-message-warning-time} for this appointment. See the
7645 docstring for details.
7647 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7648 @subsection The global TODO list
7649 @cindex global TODO list
7650 @cindex TODO list, global
7652 The global TODO list contains all unfinished TODO items formatted and
7653 collected into a single place.
7656 @orgcmd{C-c a t,org-todo-list}
7657 Show the global TODO list. This collects the TODO items from all agenda
7658 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7659 items with a state the is not a DONE state. The buffer is in
7660 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7661 entries directly from that buffer (@pxref{Agenda commands}).
7662 @orgcmd{C-c a T,org-todo-list}
7663 @cindex TODO keyword matching
7664 @vindex org-todo-keywords
7665 Like the above, but allows selection of a specific TODO keyword. You can
7666 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7667 prompted for a keyword, and you may also specify several keywords by
7668 separating them with @samp{|} as the boolean OR operator. With a numeric
7669 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7671 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7672 a prefix argument to this command to change the selected TODO keyword,
7673 for example @kbd{3 r}. If you often need a search for a specific
7674 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7675 Matching specific TODO keywords can also be done as part of a tags
7676 search (@pxref{Tag searches}).
7679 Remote editing of TODO items means that you can change the state of a
7680 TODO entry with a single key press. The commands available in the
7681 TODO list are described in @ref{Agenda commands}.
7683 @cindex sublevels, inclusion into TODO list
7684 Normally the global TODO list simply shows all headlines with TODO
7685 keywords. This list can become very long. There are two ways to keep
7689 @vindex org-agenda-todo-ignore-scheduled
7690 @vindex org-agenda-todo-ignore-deadlines
7691 @vindex org-agenda-todo-ignore-timestamp
7692 @vindex org-agenda-todo-ignore-with-date
7693 Some people view a TODO item that has been @emph{scheduled} for execution or
7694 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7695 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7696 @code{org-agenda-todo-ignore-deadlines},
7697 @code{org-agenda-todo-ignore-timestamp} and/or
7698 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7701 @vindex org-agenda-todo-list-sublevels
7702 TODO items may have sublevels to break up the task into subtasks. In
7703 such cases it may be enough to list only the highest level TODO headline
7704 and omit the sublevels from the global list. Configure the variable
7705 @code{org-agenda-todo-list-sublevels} to get this behavior.
7708 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7709 @subsection Matching tags and properties
7710 @cindex matching, of tags
7711 @cindex matching, of properties
7715 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7716 or have properties (@pxref{Properties and Columns}), you can select headlines
7717 based on this metadata and collect them into an agenda buffer. The match
7718 syntax described here also applies when creating sparse trees with @kbd{C-c /
7722 @orgcmd{C-c a m,org-tags-view}
7723 Produce a list of all headlines that match a given set of tags. The
7724 command prompts for a selection criterion, which is a boolean logic
7725 expression with tags, like @samp{+work+urgent-withboss} or
7726 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7727 define a custom command for it (@pxref{Agenda dispatcher}).
7728 @orgcmd{C-c a M,org-tags-view}
7729 @vindex org-tags-match-list-sublevels
7730 @vindex org-agenda-tags-todo-honor-ignore-options
7731 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7732 not-DONE state and force checking subitems (see variable
7733 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7734 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7735 specific TODO keywords together with a tags match is also possible, see
7739 The commands available in the tags list are described in @ref{Agenda
7742 @subsubheading Match syntax
7744 @cindex Boolean logic, for tag/property searches
7745 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7746 OR@. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7747 not implemented. Each element in the search is either a tag, a regular
7748 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7749 VALUE} with a comparison operator, accessing a property value. Each element
7750 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7751 sugar for positive selection. The AND operator @samp{&} is optional when
7752 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7756 Select headlines tagged @samp{:work:}, but discard those also tagged
7759 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7760 @item work|laptop+night
7761 Like before, but require the @samp{:laptop:} lines to be tagged also
7765 @cindex regular expressions, with tags search
7766 Instead of a tag, you may also specify a regular expression enclosed in curly
7767 braces. For example,
7768 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7769 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7771 @cindex TODO keyword matching, with tags search
7772 @cindex level, require for tags/property match
7773 @cindex category, require for tags/property match
7774 @vindex org-odd-levels-only
7775 You may also test for properties (@pxref{Properties and Columns}) at the same
7776 time as matching tags. The properties may be real properties, or special
7777 properties that represent other metadata (@pxref{Special properties}). For
7778 example, the ``property'' @code{TODO} represents the TODO keyword of the
7779 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7780 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7781 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7782 DONE@. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7783 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7784 The ITEM special property cannot currently be used in tags/property
7785 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
7786 ,skipping entries based on regexp}.}.
7788 Here are more examples:
7790 @item work+TODO="WAITING"
7791 Select @samp{:work:}-tagged TODO lines with the specific TODO
7792 keyword @samp{WAITING}.
7793 @item work+TODO="WAITING"|home+TODO="WAITING"
7794 Waiting tasks both at work and at home.
7797 When matching properties, a number of different operators can be used to test
7798 the value of a property. Here is a complex example:
7801 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7802 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7806 The type of comparison will depend on how the comparison value is written:
7809 If the comparison value is a plain number, a numerical comparison is done,
7810 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7811 @samp{>=}, and @samp{<>}.
7813 If the comparison value is enclosed in double-quotes,
7814 a string comparison is done, and the same operators are allowed.
7816 If the comparison value is enclosed in double-quotes @emph{and} angular
7817 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7818 assumed to be date/time specifications in the standard Org way, and the
7819 comparison will be done accordingly. Special values that will be recognized
7820 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7821 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
7822 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7823 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7824 respectively, can be used.
7826 If the comparison value is enclosed
7827 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7828 regexp matches the property value, and @samp{<>} meaning that it does not
7832 So the search string in the example finds entries tagged @samp{:work:} but
7833 not @samp{:boss:}, which also have a priority value @samp{A}, a
7834 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7835 property that is numerically smaller than 2, a @samp{:With:} property that is
7836 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7837 on or after October 11, 2008.
7839 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7840 other properties will slow down the search. However, once you have paid the
7841 price by accessing one property, testing additional properties is cheap
7844 You can configure Org mode to use property inheritance during a search, but
7845 beware that this can slow down searches considerably. See @ref{Property
7846 inheritance}, for details.
7848 For backward compatibility, and also for typing speed, there is also a
7849 different way to test TODO states in a search. For this, terminate the
7850 tags/property part of the search string (which may include several terms
7851 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7852 expression just for TODO keywords. The syntax is then similar to that for
7853 tags, but should be applied with care: for example, a positive selection on
7854 several TODO keywords cannot meaningfully be combined with boolean AND@.
7855 However, @emph{negative selection} combined with AND can be meaningful. To
7856 make sure that only lines are checked that actually have any TODO keyword
7857 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7858 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7859 not match TODO keywords in a DONE state. Examples:
7863 Same as @samp{work+TODO="WAITING"}
7864 @item work/!-WAITING-NEXT
7865 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7867 @item work/!+WAITING|+NEXT
7868 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7872 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7873 @subsection Timeline for a single file
7874 @cindex timeline, single file
7875 @cindex time-sorted view
7877 The timeline summarizes all time-stamped items from a single Org mode
7878 file in a @emph{time-sorted view}. The main purpose of this command is
7879 to give an overview over events in a project.
7882 @orgcmd{C-c a L,org-timeline}
7883 Show a time-sorted view of the Org file, with all time-stamped items.
7884 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7885 (scheduled or not) are also listed under the current date.
7889 The commands available in the timeline buffer are listed in
7890 @ref{Agenda commands}.
7892 @node Search view, Stuck projects, Timeline, Built-in agenda views
7893 @subsection Search view
7896 @cindex searching, for text
7898 This agenda view is a general text search facility for Org mode entries.
7899 It is particularly useful to find notes.
7902 @orgcmd{C-c a s,org-search-view}
7903 This is a special search that lets you select entries by matching a substring
7904 or specific words using a boolean logic.
7906 For example, the search string @samp{computer equipment} will find entries
7907 that contain @samp{computer equipment} as a substring. If the two words are
7908 separated by more space or a line break, the search will still match.
7909 Search view can also search for specific keywords in the entry, using Boolean
7910 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7911 will search for note entries that contain the keywords @code{computer}
7912 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7913 not matched by the regular expression @code{8\.11[bg]}, meaning to
7914 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7915 word search, other @samp{+} characters are optional. For more details, see
7916 the docstring of the command @code{org-search-view}.
7918 @vindex org-agenda-text-search-extra-files
7919 Note that in addition to the agenda files, this command will also search
7920 the files listed in @code{org-agenda-text-search-extra-files}.
7922 @node Stuck projects, , Search view, Built-in agenda views
7923 @subsection Stuck projects
7924 @pindex GTD, Getting Things Done
7926 If you are following a system like David Allen's GTD to organize your
7927 work, one of the ``duties'' you have is a regular review to make sure
7928 that all projects move along. A @emph{stuck} project is a project that
7929 has no defined next actions, so it will never show up in the TODO lists
7930 Org mode produces. During the review, you need to identify such
7931 projects and define next actions for them.
7934 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7935 List projects that are stuck.
7938 @vindex org-stuck-projects
7939 Customize the variable @code{org-stuck-projects} to define what a stuck
7940 project is and how to find it.
7943 You almost certainly will have to configure this view before it will
7944 work for you. The built-in default assumes that all your projects are
7945 level-2 headlines, and that a project is not stuck if it has at least
7946 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7948 Let's assume that you, in your own way of using Org mode, identify
7949 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7950 indicate a project that should not be considered yet. Let's further
7951 assume that the TODO keyword DONE marks finished projects, and that NEXT
7952 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7953 is a next action even without the NEXT tag. Finally, if the project
7954 contains the special word IGNORE anywhere, it should not be listed
7955 either. In this case you would start by identifying eligible projects
7956 with a tags/todo match@footnote{@xref{Tag searches}.}
7957 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7958 IGNORE in the subtree to identify projects that are not stuck. The
7959 correct customization for this is
7962 (setq org-stuck-projects
7963 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7967 Note that if a project is identified as non-stuck, the subtree of this entry
7968 will still be searched for stuck projects.
7970 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7971 @section Presentation and sorting
7972 @cindex presentation, of agenda items
7974 @vindex org-agenda-prefix-format
7975 @vindex org-agenda-tags-column
7976 Before displaying items in an agenda view, Org mode visually prepares the
7977 items and sorts them. Each item occupies a single line. The line starts
7978 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
7979 of the item and other important information. You can customize in which
7980 column tags will be displayed through @code{org-agenda-tags-column}. You can
7981 also customize the prefix using the option @code{org-agenda-prefix-format}.
7982 This prefix is followed by a cleaned-up version of the outline headline
7983 associated with the item.
7986 * Categories:: Not all tasks are equal
7987 * Time-of-day specifications:: How the agenda knows the time
7988 * Sorting of agenda items:: The order of things
7991 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
7992 @subsection Categories
7996 The category is a broad label assigned to each agenda item. By default,
7997 the category is simply derived from the file name, but you can also
7998 specify it with a special line in the buffer, like this@footnote{For
7999 backward compatibility, the following also works: if there are several
8000 such lines in a file, each specifies the category for the text below it.
8001 The first category also applies to any text before the first CATEGORY
8002 line. However, using this method is @emph{strongly} deprecated as it is
8003 incompatible with the outline structure of the document. The correct
8004 method for setting multiple categories in a buffer is using a
8012 @cindex property, CATEGORY
8013 If you would like to have a special CATEGORY for a single entry or a
8014 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8015 special category you want to apply as the value.
8018 The display in the agenda buffer looks best if the category is not
8019 longer than 10 characters.
8022 You can set up icons for category by customizing the
8023 @code{org-agenda-category-icon-alist} variable.
8025 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
8026 @subsection Time-of-day specifications
8027 @cindex time-of-day specification
8029 Org mode checks each agenda item for a time-of-day specification. The
8030 time can be part of the timestamp that triggered inclusion into the
8031 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8032 ranges can be specified with two timestamps, like
8034 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8036 In the headline of the entry itself, a time(range) may also appear as
8037 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8038 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8039 specifications in diary entries are recognized as well.
8041 For agenda display, Org mode extracts the time and displays it in a
8042 standard 24 hour format as part of the prefix. The example times in
8043 the previous paragraphs would end up in the agenda like this:
8046 8:30-13:00 Arthur Dent lies in front of the bulldozer
8047 12:45...... Ford Prefect arrives and takes Arthur to the pub
8048 19:00...... The Vogon reads his poem
8049 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8053 If the agenda is in single-day mode, or for the display of today, the
8054 timed entries are embedded in a time grid, like
8057 8:00...... ------------------
8058 8:30-13:00 Arthur Dent lies in front of the bulldozer
8059 10:00...... ------------------
8060 12:00...... ------------------
8061 12:45...... Ford Prefect arrives and takes Arthur to the pub
8062 14:00...... ------------------
8063 16:00...... ------------------
8064 18:00...... ------------------
8065 19:00...... The Vogon reads his poem
8066 20:00...... ------------------
8067 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8070 @vindex org-agenda-use-time-grid
8071 @vindex org-agenda-time-grid
8072 The time grid can be turned on and off with the variable
8073 @code{org-agenda-use-time-grid}, and can be configured with
8074 @code{org-agenda-time-grid}.
8076 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
8077 @subsection Sorting of agenda items
8078 @cindex sorting, of agenda items
8079 @cindex priorities, of agenda items
8080 Before being inserted into a view, the items are sorted. How this is
8081 done depends on the type of view.
8084 @vindex org-agenda-files
8085 For the daily/weekly agenda, the items for each day are sorted. The
8086 default order is to first collect all items containing an explicit
8087 time-of-day specification. These entries will be shown at the beginning
8088 of the list, as a @emph{schedule} for the day. After that, items remain
8089 grouped in categories, in the sequence given by @code{org-agenda-files}.
8090 Within each category, items are sorted by priority (@pxref{Priorities}),
8091 which is composed of the base priority (2000 for priority @samp{A}, 1000
8092 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8093 overdue scheduled or deadline items.
8095 For the TODO list, items remain in the order of categories, but within
8096 each category, sorting takes place according to priority
8097 (@pxref{Priorities}). The priority used for sorting derives from the
8098 priority cookie, with additions depending on how close an item is to its due
8101 For tags matches, items are not sorted at all, but just appear in the
8102 sequence in which they are found in the agenda files.
8105 @vindex org-agenda-sorting-strategy
8106 Sorting can be customized using the variable
8107 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8108 the estimated effort of an entry (@pxref{Effort estimates}).
8110 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
8111 @section Commands in the agenda buffer
8112 @cindex commands, in agenda buffer
8114 Entries in the agenda buffer are linked back to the Org file or diary
8115 file where they originate. You are not allowed to edit the agenda
8116 buffer itself, but commands are provided to show and jump to the
8117 original entry location, and to edit the Org files ``remotely'' from
8118 the agenda buffer. In this way, all information is stored only once,
8119 removing the risk that your agenda and note files may diverge.
8121 Some commands can be executed with mouse clicks on agenda lines. For
8122 the other commands, the cursor needs to be in the desired line.
8125 @tsubheading{Motion}
8126 @cindex motion commands in agenda
8127 @orgcmd{n,org-agenda-next-line}
8128 Next line (same as @key{down} and @kbd{C-n}).
8129 @orgcmd{p,org-agenda-previous-line}
8130 Previous line (same as @key{up} and @kbd{C-p}).
8131 @tsubheading{View/Go to Org file}
8132 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8133 Display the original location of the item in another window.
8134 With prefix arg, make sure that the entire entry is made visible in the
8135 outline, not only the heading.
8137 @orgcmd{L,org-agenda-recenter}
8138 Display original location and recenter that window.
8140 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8141 Go to the original location of the item in another window.
8143 @orgcmd{@key{RET},org-agenda-switch-to}
8144 Go to the original location of the item and delete other windows.
8146 @orgcmd{F,org-agenda-follow-mode}
8147 @vindex org-agenda-start-with-follow-mode
8148 Toggle Follow mode. In Follow mode, as you move the cursor through
8149 the agenda buffer, the other window always shows the corresponding
8150 location in the Org file. The initial setting for this mode in new
8151 agenda buffers can be set with the variable
8152 @code{org-agenda-start-with-follow-mode}.
8154 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8155 Display the entire subtree of the current item in an indirect buffer. With a
8156 numeric prefix argument N, go up to level N and then take that tree. If N is
8157 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8158 previously used indirect buffer.
8160 @orgcmd{C-c C-o,org-agenda-open-link}
8161 Follow a link in the entry. This will offer a selection of any links in the
8162 text belonging to the referenced Org node. If there is only one link, it
8163 will be followed without a selection prompt.
8165 @tsubheading{Change display}
8166 @cindex display changing, in agenda
8169 Interactively select another agenda view and append it to the current view.
8173 Delete other windows.
8175 @orgcmdkskc{v d,d,org-agenda-day-view}
8176 @xorgcmdkskc{v w,w,org-agenda-week-view}
8177 @xorgcmd{v m,org-agenda-month-view}
8178 @xorgcmd{v y,org-agenda-year-view}
8179 @xorgcmd{v SPC,org-agenda-reset-view}
8180 @vindex org-agenda-span
8181 Switch to day/week/month/year view. When switching to day or week view, this
8182 setting becomes the default for subsequent agenda refreshes. Since month and
8183 year views are slow to create, they do not become the default. A numeric
8184 prefix argument may be used to jump directly to a specific day of the year,
8185 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8186 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8187 month view, a year may be encoded in the prefix argument as well. For
8188 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8189 specification has only one or two digits, it will be mapped to the interval
8190 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8191 @code{org-agenda-span}.
8193 @orgcmd{f,org-agenda-later}
8194 Go forward in time to display the following @code{org-agenda-current-span} days.
8195 For example, if the display covers a week, switch to the following week.
8196 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8198 @orgcmd{b,org-agenda-earlier}
8199 Go backward in time to display earlier dates.
8201 @orgcmd{.,org-agenda-goto-today}
8204 @orgcmd{j,org-agenda-goto-date}
8205 Prompt for a date and go there.
8207 @orgcmd{J,org-agenda-clock-goto}
8208 Go to the currently clocked-in task @i{in the agenda buffer}.
8210 @orgcmd{D,org-agenda-toggle-diary}
8211 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8213 @orgcmdkskc{v l,l,org-agenda-log-mode}
8215 @vindex org-log-done
8216 @vindex org-agenda-log-mode-items
8217 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8218 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8219 entries that have been clocked on that day. You can configure the entry
8220 types that should be included in log mode using the variable
8221 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8222 all possible logbook entries, including state changes. When called with two
8223 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
8224 @kbd{v L} is equivalent to @kbd{C-u v l}.
8226 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8227 Include inactive timestamps into the current view. Only for weekly/daily
8228 agenda and timeline views.
8230 @orgcmd{v a,org-agenda-archives-mode}
8231 @xorgcmd{v A,org-agenda-archives-mode 'files}
8232 Toggle Archives mode. In Archives mode, trees that are marked
8233 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8234 capital @kbd{A}, even all archive files are included. To exit archives mode,
8235 press @kbd{v a} again.
8237 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8238 @vindex org-agenda-start-with-clockreport-mode
8239 @vindex org-clock-report-include-clocking-task
8240 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8241 always show a table with the clocked times for the timespan and file scope
8242 covered by the current agenda view. The initial setting for this mode in new
8243 agenda buffers can be set with the variable
8244 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8245 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8246 contributions from entries that are hidden by agenda filtering@footnote{Only
8247 tags filtering will be respected here, effort filtering is ignored.}. See
8248 also the variable @code{org-clock-report-include-clocking-task}.
8251 @vindex org-agenda-clock-consistency-checks
8252 Show overlapping clock entries, clocking gaps, and other clocking problems in
8253 the current agenda range. You can then visit clocking lines and fix them
8254 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8255 information on how to customize the definition of what constituted a clocking
8256 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8259 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8260 @vindex org-agenda-start-with-entry-text-mode
8261 @vindex org-agenda-entry-text-maxlines
8262 Toggle entry text mode. In entry text mode, a number of lines from the Org
8263 outline node referenced by an agenda line will be displayed below the line.
8264 The maximum number of lines is given by the variable
8265 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8266 prefix argument will temporarily modify that number to the prefix value.
8268 @orgcmd{G,org-agenda-toggle-time-grid}
8269 @vindex org-agenda-use-time-grid
8270 @vindex org-agenda-time-grid
8271 Toggle the time grid on and off. See also the variables
8272 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8274 @orgcmd{r,org-agenda-redo}
8275 Recreate the agenda buffer, for example to reflect the changes after
8276 modification of the timestamps of items with @kbd{S-@key{left}} and
8277 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8278 argument is interpreted to create a selective list for a specific TODO
8280 @orgcmd{g,org-agenda-redo}
8283 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8284 Save all Org buffers in the current Emacs session, and also the locations of
8287 @orgcmd{C-c C-x C-c,org-agenda-columns}
8288 @vindex org-columns-default-format
8289 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8290 view format is taken from the entry at point, or (if there is no entry at
8291 point), from the first entry in the agenda view. So whatever the format for
8292 that entry would be in the original buffer (taken from a property, from a
8293 @code{#+COLUMNS} line, or from the default variable
8294 @code{org-columns-default-format}), will be used in the agenda.
8296 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8297 Remove the restriction lock on the agenda, if it is currently restricted to a
8298 file or subtree (@pxref{Agenda files}).
8300 @tsubheading{Secondary filtering and query editing}
8301 @cindex filtering, by tag category and effort, in agenda
8302 @cindex tag filtering, in agenda
8303 @cindex category filtering, in agenda
8304 @cindex effort filtering, in agenda
8305 @cindex query editing, in agenda
8307 @orgcmd{<,org-agenda-filter-by-category}
8308 @vindex org-agenda-category-filter-preset
8310 Filter the current agenda view with respect to the category of the item at
8311 point. Pressing @code{<} another time will remove this filter. You can add
8312 a filter preset through the option @code{org-agenda-category-filter-preset}
8315 @orgcmd{/,org-agenda-filter-by-tag}
8316 @vindex org-agenda-tag-filter-preset
8317 Filter the current agenda view with respect to a tag and/or effort estimates.
8318 The difference between this and a custom agenda command is that filtering is
8319 very fast, so that you can switch quickly between different filters without
8320 having to recreate the agenda.@footnote{Custom commands can preset a filter by
8321 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8322 filter will then be applied to the view and persist as a basic filter through
8323 refreshes and more secondary filtering. The filter is a global property of
8324 the entire agenda view---in a block agenda, you should only set this in the
8325 global options section, not in the section of an individual block.}
8327 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8328 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8329 tag (including any tags that do not have a selection character). The command
8330 then hides all entries that do not contain or inherit this tag. When called
8331 with prefix arg, remove the entries that @emph{do} have the tag. A second
8332 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8333 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8334 will be narrowed by requiring or forbidding the selected additional tag.
8335 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8336 immediately use the @kbd{\} command.
8338 @vindex org-sort-agenda-noeffort-is-high
8339 In order to filter for effort estimates, you should set up allowed
8340 efforts globally, for example
8342 (setq org-global-properties
8343 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8345 You can then filter for an effort by first typing an operator, one of
8346 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8347 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8348 The filter will then restrict to entries with effort smaller-or-equal, equal,
8349 or larger-or-equal than the selected value. If the digits 0--9 are not used
8350 as fast access keys to tags, you can also simply press the index digit
8351 directly without an operator. In this case, @kbd{<} will be assumed. For
8352 application of the operator, entries without a defined effort will be treated
8353 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
8354 for tasks without effort definition, press @kbd{?} as the operator.
8356 Org also supports automatic, context-aware tag filtering. If the variable
8357 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8358 that function can decide which tags should be excluded from the agenda
8359 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8360 as a sub-option key and runs the auto exclusion logic. For example, let's
8361 say you use a @code{Net} tag to identify tasks which need network access, an
8362 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8363 calls. You could auto-exclude these tags based on the availability of the
8364 Internet, and outside of business hours, with something like this:
8368 (defun org-my-auto-exclude-function (tag)
8370 ((string= tag "Net")
8371 (/= 0 (call-process "/sbin/ping" nil nil nil
8372 "-c1" "-q" "-t1" "mail.gnu.org")))
8373 ((or (string= tag "Errand") (string= tag "Call"))
8374 (let ((hour (nth 2 (decode-time))))
8375 (or (< hour 8) (> hour 21)))))
8378 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8382 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8383 Narrow the current agenda filter by an additional condition. When called with
8384 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8385 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8386 @kbd{-} as the first key after the @kbd{/} command.
8395 @item @r{in} search view
8396 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8397 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8398 add a positive search term prefixed by @samp{+}, indicating that this search
8399 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8400 negative search term which @i{must not} occur/match in the entry for it to be
8404 @tsubheading{Remote editing}
8405 @cindex remote editing, from agenda
8410 @cindex undoing remote-editing events
8411 @cindex remote editing, undo
8412 @orgcmd{C-_,org-agenda-undo}
8413 Undo a change due to a remote editing command. The change is undone
8414 both in the agenda buffer and in the remote buffer.
8416 @orgcmd{t,org-agenda-todo}
8417 Change the TODO state of the item, both in the agenda and in the
8420 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8421 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8422 Switch to the next/previous set of TODO keywords.
8424 @orgcmd{C-k,org-agenda-kill}
8425 @vindex org-agenda-confirm-kill
8426 Delete the current agenda item along with the entire subtree belonging
8427 to it in the original Org file. If the text to be deleted remotely
8428 is longer than one line, the kill needs to be confirmed by the user. See
8429 variable @code{org-agenda-confirm-kill}.
8431 @orgcmd{C-c C-w,org-agenda-refile}
8432 Refile the entry at point.
8434 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8435 @vindex org-archive-default-command
8436 Archive the subtree corresponding to the entry at point using the default
8437 archiving command set in @code{org-archive-default-command}. When using the
8438 @code{a} key, confirmation will be required.
8440 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8441 Toggle the ARCHIVE tag for the current headline.
8443 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8444 Move the subtree corresponding to the current entry to its @emph{archive
8447 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8448 Archive the subtree corresponding to the current headline. This means the
8449 entry will be moved to the configured archive location, most likely a
8452 @orgcmd{T,org-agenda-show-tags}
8453 @vindex org-agenda-show-inherited-tags
8454 Show all tags associated with the current item. This is useful if you have
8455 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8456 tags of a headline occasionally.
8458 @orgcmd{:,org-agenda-set-tags}
8459 Set tags for the current headline. If there is an active region in the
8460 agenda, change a tag for all headings in the region.
8464 Set the priority for the current item (@command{org-agenda-priority}).
8465 Org mode prompts for the priority character. If you reply with @key{SPC},
8466 the priority cookie is removed from the entry.
8468 @orgcmd{P,org-agenda-show-priority}
8469 Display weighted priority of current item.
8471 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8472 Increase the priority of the current item. The priority is changed in
8473 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8476 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8477 Decrease the priority of the current item.
8479 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8480 @vindex org-log-into-drawer
8481 Add a note to the entry. This note will be recorded, and then filed to the
8482 same location where state change notes are put. Depending on
8483 @code{org-log-into-drawer}, this may be inside a drawer.
8485 @orgcmd{C-c C-a,org-attach}
8486 Dispatcher for all command related to attachments.
8488 @orgcmd{C-c C-s,org-agenda-schedule}
8489 Schedule this item. With prefix arg remove the scheduling timestamp
8491 @orgcmd{C-c C-d,org-agenda-deadline}
8492 Set a deadline for this item. With prefix arg remove the deadline.
8494 @orgcmd{S-@key{right},org-agenda-do-date-later}
8495 Change the timestamp associated with the current line by one day into the
8496 future. If the date is in the past, the first call to this command will move
8498 With a numeric prefix argument, change it by that many days. For example,
8499 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8500 change the time by one hour. If you immediately repeat the command, it will
8501 continue to change hours even without the prefix arg. With a double @kbd{C-u
8502 C-u} prefix, do the same for changing minutes.@*
8503 The stamp is changed in the original Org file, but the change is not directly
8504 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8506 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8507 Change the timestamp associated with the current line by one day
8510 @orgcmd{>,org-agenda-date-prompt}
8511 Change the timestamp associated with the current line. The key @kbd{>} has
8512 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8514 @orgcmd{I,org-agenda-clock-in}
8515 Start the clock on the current item. If a clock is running already, it
8518 @orgcmd{O,org-agenda-clock-out}
8519 Stop the previously started clock.
8521 @orgcmd{X,org-agenda-clock-cancel}
8522 Cancel the currently running clock.
8524 @orgcmd{J,org-agenda-clock-goto}
8525 Jump to the running clock in another window.
8527 @orgcmd{k,org-agenda-capture}
8528 Like @code{org-capture}, but use the date at point as the default date for
8529 the capture template. See @var{org-capture-use-agenda-date} to make this
8530 the default behavior of @code{org-capture}.
8531 @cindex capturing, from agenda
8532 @vindex org-capture-use-agenda-date
8534 @tsubheading{Bulk remote editing selected entries}
8535 @cindex remote editing, bulk, from agenda
8536 @vindex org-agenda-bulk-persistent-marks
8537 @vindex org-agenda-bulk-custom-functions
8539 @orgcmd{m,org-agenda-bulk-mark}
8540 Mark the entry at point for bulk action. With prefix arg, mark that many
8543 @orgcmd{%,org-agenda-bulk-mark-regexp}
8544 Mark entries matching a regular expression for bulk action.
8546 @orgcmd{u,org-agenda-bulk-unmark}
8547 Unmark entry for bulk action.
8549 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8550 Unmark all marked entries for bulk action.
8552 @orgcmd{B,org-agenda-bulk-action}
8553 Bulk action: act on all marked entries in the agenda. This will prompt for
8554 another key to select the action to be applied. The prefix arg to @kbd{B}
8555 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8556 these special timestamps. By default, marks are removed after the bulk. If
8557 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
8558 @code{t} or hit @kbd{p} at the prompt.
8561 * @r{Toggle persistent marks.}
8562 $ @r{Archive all selected entries.}
8563 A @r{Archive entries by moving them to their respective archive siblings.}
8564 t @r{Change TODO state. This prompts for a single TODO keyword and}
8565 @r{changes the state of all selected entries, bypassing blocking and}
8566 @r{suppressing logging notes (but not timestamps).}
8567 + @r{Add a tag to all selected entries.}
8568 - @r{Remove a tag from all selected entries.}
8569 s @r{Schedule all items to a new date. To shift existing schedule dates}
8570 @r{by a fixed number of days, use something starting with double plus}
8571 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8572 d @r{Set deadline to a specific date.}
8573 r @r{Prompt for a single refile target and move all entries. The entries}
8574 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8575 S @r{Reschedule randomly into the coming N days. N will be prompted for.}
8576 @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
8577 f @r{Apply a function@footnote{You can also create persistent custom functions through@code{org-agenda-bulk-custom-functions}.} to marked entries.}
8578 @r{For example, the function below sets the CATEGORY property of the}
8580 @r{(defun set-category ()}
8581 @r{ (interactive "P")}
8582 @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
8583 @r{ (org-agenda-error)))}
8584 @r{ (buffer (marker-buffer marker)))}
8585 @r{ (with-current-buffer buffer}
8586 @r{ (save-excursion}
8587 @r{ (save-restriction}
8589 @r{ (goto-char marker)}
8590 @r{ (org-back-to-heading t)}
8591 @r{ (org-set-property "CATEGORY" "web"))))))}
8595 @tsubheading{Calendar commands}
8596 @cindex calendar commands, from agenda
8598 @orgcmd{c,org-agenda-goto-calendar}
8599 Open the Emacs calendar and move to the date at the agenda cursor.
8601 @orgcmd{c,org-calendar-goto-agenda}
8602 When in the calendar, compute and show the Org mode agenda for the
8605 @cindex diary entries, creating from agenda
8606 @orgcmd{i,org-agenda-diary-entry}
8607 @vindex org-agenda-diary-file
8608 Insert a new entry into the diary, using the date at the cursor and (for
8609 block entries) the date at the mark. This will add to the Emacs diary
8610 file@footnote{This file is parsed for the agenda when
8611 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8612 command in the calendar. The diary file will pop up in another window, where
8613 you can add the entry.
8615 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
8616 Org will create entries (in Org mode syntax) in that file instead. Most
8617 entries will be stored in a date-based outline tree that will later make it
8618 easy to archive appointments from previous months/years. The tree will be
8619 built under an entry with a @code{DATE_TREE} property, or else with years as
8620 top-level entries. Emacs will prompt you for the entry text---if you specify
8621 it, the entry will be created in @code{org-agenda-diary-file} without further
8622 interaction. If you directly press @key{RET} at the prompt without typing
8623 text, the target file will be shown in another window for you to finish the
8624 entry there. See also the @kbd{k r} command.
8626 @orgcmd{M,org-agenda-phases-of-moon}
8627 Show the phases of the moon for the three months around current date.
8629 @orgcmd{S,org-agenda-sunrise-sunset}
8630 Show sunrise and sunset times. The geographical location must be set
8631 with calendar variables, see the documentation for the Emacs calendar.
8633 @orgcmd{C,org-agenda-convert-date}
8634 Convert the date at cursor into many other cultural and historic
8637 @orgcmd{H,org-agenda-holidays}
8638 Show holidays for three months around the cursor date.
8640 @item M-x org-export-icalendar-combine-agenda-files
8641 Export a single iCalendar file containing entries from all agenda files.
8642 This is a globally available command, and also available in the agenda menu.
8644 @tsubheading{Exporting to a file}
8645 @orgcmd{C-x C-w,org-agenda-write}
8646 @cindex exporting agenda views
8647 @cindex agenda views, exporting
8648 @vindex org-agenda-exporter-settings
8649 Write the agenda view to a file. Depending on the extension of the selected
8650 file name, the view will be exported as HTML (extension @file{.html} or
8651 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8652 and plain text (any other extension). When called with a @kbd{C-u} prefix
8653 argument, immediately open the newly created file. Use the variable
8654 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8655 for @file{htmlize} to be used during export.
8657 @tsubheading{Quit and Exit}
8658 @orgcmd{q,org-agenda-quit}
8659 Quit agenda, remove the agenda buffer.
8661 @cindex agenda files, removing buffers
8662 @orgcmd{x,org-agenda-exit}
8663 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8664 for the compilation of the agenda. Buffers created by the user to
8665 visit Org files will not be removed.
8669 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8670 @section Custom agenda views
8671 @cindex custom agenda views
8672 @cindex agenda views, custom
8674 Custom agenda commands serve two purposes: to store and quickly access
8675 frequently used TODO and tags searches, and to create special composite
8676 agenda buffers. Custom agenda commands will be accessible through the
8677 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8680 * Storing searches:: Type once, use often
8681 * Block agenda:: All the stuff you need in a single buffer
8682 * Setting Options:: Changing the rules
8685 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8686 @subsection Storing searches
8688 The first application of custom searches is the definition of keyboard
8689 shortcuts for frequently used searches, either creating an agenda
8690 buffer, or a sparse tree (the latter covering of course only the current
8693 @vindex org-agenda-custom-commands
8694 @cindex agenda views, main example
8695 @cindex tags, as an agenda view
8696 @cindex todo, as an agenda view
8702 Custom commands are configured in the variable
8703 @code{org-agenda-custom-commands}. You can customize this variable, for
8704 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
8705 Lisp in @file{.emacs}. The following example contains all valid search
8710 (setq org-agenda-custom-commands
8711 '(("w" todo "WAITING")
8712 ("W" todo-tree "WAITING")
8713 ("u" tags "+boss-urgent")
8714 ("v" tags-todo "+boss-urgent")
8715 ("U" tags-tree "+boss-urgent")
8716 ("f" occur-tree "\\<FIXME\\>")
8717 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8718 ("hl" tags "+home+Lisa")
8719 ("hp" tags "+home+Peter")
8720 ("hk" tags "+home+Kim")))
8725 The initial string in each entry defines the keys you have to press
8726 after the dispatcher command @kbd{C-c a} in order to access the command.
8727 Usually this will be just a single character, but if you have many
8728 similar commands, you can also define two-letter combinations where the
8729 first character is the same in several combinations and serves as a
8730 prefix key@footnote{You can provide a description for a prefix key by
8731 inserting a cons cell with the prefix and the description.}. The second
8732 parameter is the search type, followed by the string or regular
8733 expression to be used for the matching. The example above will
8738 as a global search for TODO entries with @samp{WAITING} as the TODO
8741 as the same search, but only in the current buffer and displaying the
8742 results as a sparse tree
8744 as a global tags search for headlines marked @samp{:boss:} but not
8747 as the same search as @kbd{C-c a u}, but limiting the search to
8748 headlines that are also TODO items
8750 as the same search as @kbd{C-c a u}, but only in the current buffer and
8751 displaying the result as a sparse tree
8753 to create a sparse tree (again: current buffer only) with all entries
8754 containing the word @samp{FIXME}
8756 as a prefix command for a HOME tags search where you have to press an
8757 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8758 Peter, or Kim) as additional tag to match.
8761 Note that the @code{*-tree} agenda views need to be called from an
8762 Org buffer as they operate on the current buffer only.
8764 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8765 @subsection Block agenda
8766 @cindex block agenda
8767 @cindex agenda, with block views
8769 Another possibility is the construction of agenda views that comprise
8770 the results of @emph{several} commands, each of which creates a block in
8771 the agenda buffer. The available commands include @code{agenda} for the
8772 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8773 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8774 matching commands discussed above: @code{todo}, @code{tags}, and
8775 @code{tags-todo}. Here are two examples:
8779 (setq org-agenda-custom-commands
8780 '(("h" "Agenda and Home-related tasks"
8784 ("o" "Agenda and Office-related tasks"
8792 This will define @kbd{C-c a h} to create a multi-block view for stuff
8793 you need to attend to at home. The resulting agenda buffer will contain
8794 your agenda for the current week, all TODO items that carry the tag
8795 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8796 command @kbd{C-c a o} provides a similar view for office tasks.
8798 @node Setting Options, , Block agenda, Custom agenda views
8799 @subsection Setting options for custom commands
8800 @cindex options, for custom agenda views
8802 @vindex org-agenda-custom-commands
8803 Org mode contains a number of variables regulating agenda construction
8804 and display. The global variables define the behavior for all agenda
8805 commands, including the custom commands. However, if you want to change
8806 some settings just for a single custom view, you can do so. Setting
8807 options requires inserting a list of variable names and values at the
8808 right spot in @code{org-agenda-custom-commands}. For example:
8812 (setq org-agenda-custom-commands
8813 '(("w" todo "WAITING"
8814 ((org-agenda-sorting-strategy '(priority-down))
8815 (org-agenda-prefix-format " Mixed: ")))
8816 ("U" tags-tree "+boss-urgent"
8817 ((org-show-following-heading nil)
8818 (org-show-hierarchy-above nil)))
8820 ((org-agenda-files '("~org/notes.org"))
8821 (org-agenda-text-search-extra-files nil)))))
8826 Now the @kbd{C-c a w} command will sort the collected entries only by
8827 priority, and the prefix format is modified to just say @samp{ Mixed: }
8828 instead of giving the category of the entry. The sparse tags tree of
8829 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8830 headline hierarchy above the match, nor the headline following the match
8831 will be shown. The command @kbd{C-c a N} will do a text search limited
8832 to only a single file.
8834 @vindex org-agenda-custom-commands
8835 For command sets creating a block agenda,
8836 @code{org-agenda-custom-commands} has two separate spots for setting
8837 options. You can add options that should be valid for just a single
8838 command in the set, and options that should be valid for all commands in
8839 the set. The former are just added to the command entry; the latter
8840 must come after the list of command entries. Going back to the block
8841 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8842 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8843 the results for GARDEN tags query in the opposite order,
8844 @code{priority-up}. This would look like this:
8848 (setq org-agenda-custom-commands
8849 '(("h" "Agenda and Home-related tasks"
8853 ((org-agenda-sorting-strategy '(priority-up)))))
8854 ((org-agenda-sorting-strategy '(priority-down))))
8855 ("o" "Agenda and Office-related tasks"
8862 As you see, the values and parentheses setting is a little complex.
8863 When in doubt, use the customize interface to set this variable---it
8864 fully supports its structure. Just one caveat: when setting options in
8865 this interface, the @emph{values} are just Lisp expressions. So if the
8866 value is a string, you need to add the double-quotes around the value
8869 @vindex org-agenda-custom-commands-contexts
8870 To control whether an agenda command should be accessible from a specific
8871 context, you can customize @var{org-agenda-custom-commands-contexts}. Let's
8872 say for example that you have an agenda commands @code{"o"} displaying a view
8873 that you only need when reading emails. Then you would configure this option
8877 (setq org-agenda-custom-commands-contexts
8878 '(("o" (in-mode . "message-mode"))))
8881 You can also tell that the command key @code{"o"} should refer to another
8882 command key @code{"r"}. In that case, add this command key like this:
8885 (setq org-agenda-custom-commands-contexts
8886 '(("o" "r" (in-mode . "message-mode"))))
8889 See the docstring of the variable for more information.
8891 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8892 @section Exporting Agenda Views
8893 @cindex agenda views, exporting
8895 If you are away from your computer, it can be very useful to have a printed
8896 version of some agenda views to carry around. Org mode can export custom
8897 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8898 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8899 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8900 a PDF file will also create the postscript file.}, and iCalendar files. If
8901 you want to do this only occasionally, use the command
8904 @orgcmd{C-x C-w,org-agenda-write}
8905 @cindex exporting agenda views
8906 @cindex agenda views, exporting
8907 @vindex org-agenda-exporter-settings
8908 Write the agenda view to a file. Depending on the extension of the selected
8909 file name, the view will be exported as HTML (extension @file{.html} or
8910 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8911 @file{.ics}), or plain text (any other extension). Use the variable
8912 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8913 for @file{htmlize} to be used during export, for example
8915 @vindex org-agenda-add-entry-text-maxlines
8916 @vindex htmlize-output-type
8917 @vindex ps-number-of-columns
8918 @vindex ps-landscape-mode
8920 (setq org-agenda-exporter-settings
8921 '((ps-number-of-columns 2)
8922 (ps-landscape-mode t)
8923 (org-agenda-add-entry-text-maxlines 5)
8924 (htmlize-output-type 'css)))
8928 If you need to export certain agenda views frequently, you can associate
8929 any custom agenda command with a list of output file names
8930 @footnote{If you want to store standard views like the weekly agenda
8931 or the global TODO list as well, you need to define custom commands for
8932 them in order to be able to specify file names.}. Here is an example
8933 that first defines custom commands for the agenda and the global
8934 TODO list, together with a number of files to which to export them.
8935 Then we define two block agenda commands and specify file names for them
8936 as well. File names can be relative to the current working directory,
8941 (setq org-agenda-custom-commands
8942 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8943 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8944 ("h" "Agenda and Home-related tasks"
8949 ("~/views/home.html"))
8950 ("o" "Agenda and Office-related tasks"
8955 ("~/views/office.ps" "~/calendars/office.ics"))))
8959 The extension of the file name determines the type of export. If it is
8960 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
8961 the buffer to HTML and save it to this file name. If the extension is
8962 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8963 Postscript output. If the extension is @file{.ics}, iCalendar export is
8964 run export over all files that were used to construct the agenda, and
8965 limit the export to entries listed in the agenda. Any other
8966 extension produces a plain ASCII file.
8968 The export files are @emph{not} created when you use one of those
8969 commands interactively because this might use too much overhead.
8970 Instead, there is a special command to produce @emph{all} specified
8974 @orgcmd{C-c a e,org-store-agenda-views}
8975 Export all agenda views that have export file names associated with
8979 You can use the options section of the custom agenda commands to also
8980 set options for the export commands. For example:
8983 (setq org-agenda-custom-commands
8985 ((ps-number-of-columns 2)
8986 (ps-landscape-mode t)
8987 (org-agenda-prefix-format " [ ] ")
8988 (org-agenda-with-colors nil)
8989 (org-agenda-remove-tags t))
8994 This command sets two options for the Postscript exporter, to make it
8995 print in two columns in landscape format---the resulting page can be cut
8996 in two and then used in a paper agenda. The remaining settings modify
8997 the agenda prefix to omit category and scheduling information, and
8998 instead include a checkbox to check off items. We also remove the tags
8999 to make the lines compact, and we don't want to use colors for the
9000 black-and-white printer. Settings specified in
9001 @code{org-agenda-exporter-settings} will also apply, but the settings
9002 in @code{org-agenda-custom-commands} take precedence.
9005 From the command line you may also use
9007 emacs -eval (org-batch-store-agenda-views) -kill
9010 or, if you need to modify some parameters@footnote{Quoting depends on the
9011 system you use, please check the FAQ for examples.}
9013 emacs -eval '(org-batch-store-agenda-views \
9014 org-agenda-span (quote month) \
9015 org-agenda-start-day "2007-11-01" \
9016 org-agenda-include-diary nil \
9017 org-agenda-files (quote ("~/org/project.org")))' \
9021 which will create the agenda views restricted to the file
9022 @file{~/org/project.org}, without diary entries and with a 30-day
9025 You can also extract agenda information in a way that allows further
9026 processing by other programs. See @ref{Extracting agenda information}, for
9030 @node Agenda column view, , Exporting Agenda Views, Agenda Views
9031 @section Using column view in the agenda
9032 @cindex column view, in agenda
9033 @cindex agenda, column view
9035 Column view (@pxref{Column view}) is normally used to view and edit
9036 properties embedded in the hierarchical structure of an Org file. It can be
9037 quite useful to use column view also from the agenda, where entries are
9038 collected by certain criteria.
9041 @orgcmd{C-c C-x C-c,org-agenda-columns}
9042 Turn on column view in the agenda.
9045 To understand how to use this properly, it is important to realize that the
9046 entries in the agenda are no longer in their proper outline environment.
9047 This causes the following issues:
9051 @vindex org-columns-default-format
9052 @vindex org-overriding-columns-format
9053 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9054 entries in the agenda are collected from different files, and different files
9055 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9056 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9057 currently set, and if so, takes the format from there. Otherwise it takes
9058 the format associated with the first item in the agenda, or, if that item
9059 does not have a specific format (defined in a property, or in its file), it
9060 uses @code{org-columns-default-format}.
9062 @cindex property, special, CLOCKSUM
9063 If any of the columns has a summary type defined (@pxref{Column attributes}),
9064 turning on column view in the agenda will visit all relevant agenda files and
9065 make sure that the computations of this property are up to date. This is
9066 also true for the special @code{CLOCKSUM} property. Org will then sum the
9067 values displayed in the agenda. In the daily/weekly agenda, the sums will
9068 cover a single day; in all other views they cover the entire block. It is
9069 vital to realize that the agenda may show the same entry @emph{twice} (for
9070 example as scheduled and as a deadline), and it may show two entries from the
9071 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9072 cases, the summation in the agenda will lead to incorrect results because
9073 some values will count double.
9075 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9076 the entire clocked time for this item. So even in the daily/weekly agenda,
9077 the clocksum listed in column view may originate from times outside the
9078 current view. This has the advantage that you can compare these values with
9079 a column listing the planned total effort for a task---one of the major
9080 applications for column view in the agenda. If you want information about
9081 clocked time in the displayed period use clock table mode (press @kbd{R} in
9085 @cindex property, special, CLOCKSUM_T
9086 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9087 always today's clocked time for this item. So even in the weekly agenda,
9088 the clocksum listed in column view only originates from today. This lets
9089 you compare the time you spent on a task for today, with the time already
9090 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9094 @node Markup, Exporting, Agenda Views, Top
9095 @chapter Markup for rich export
9097 When exporting Org mode documents, the exporter tries to reflect the
9098 structure of the document as accurately as possible in the backend. Since
9099 export targets like HTML, @LaTeX{} allow much richer formatting, Org mode has
9100 rules on how to prepare text for rich export. This section summarizes the
9101 markup rules used in an Org mode buffer.
9104 * Structural markup elements:: The basic structure as seen by the exporter
9105 * Images and tables:: Tables and Images will be included
9106 * Literal examples:: Source code examples with special formatting
9107 * Include files:: Include additional files into a document
9108 * Index entries:: Making an index
9109 * Macro replacement:: Use macros to create complex output
9110 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9113 @node Structural markup elements, Images and tables, Markup, Markup
9114 @section Structural markup elements
9117 * Document title:: Where the title is taken from
9118 * Headings and sections:: The document structure as seen by the exporter
9119 * Table of contents:: The if and where of the table of contents
9120 * Initial text:: Text before the first heading?
9122 * Paragraphs:: Paragraphs
9123 * Footnote markup:: Footnotes
9124 * Emphasis and monospace:: Bold, italic, etc.
9125 * Horizontal rules:: Make a line
9126 * Comment lines:: What will *not* be exported
9129 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
9130 @subheading Document title
9131 @cindex document title, markup rules
9134 The title of the exported document is taken from the special line
9138 #+TITLE: This is the title of the document
9142 If this line does not exist, the title is derived from the first non-empty,
9143 non-comment line in the buffer. If no such line exists, or if you have
9144 turned off exporting of the text before the first headline (see below), the
9145 title will be the file name without extension.
9147 @cindex property, EXPORT_TITLE
9148 If you are exporting only a subtree by marking is as the region, the heading
9149 of the subtree will become the title of the document. If the subtree has a
9150 property @code{EXPORT_TITLE}, that will take precedence.
9152 @node Headings and sections, Table of contents, Document title, Structural markup elements
9153 @subheading Headings and sections
9154 @cindex headings and sections, markup rules
9156 @vindex org-export-headline-levels
9157 The outline structure of the document as described in @ref{Document
9158 Structure}, forms the basis for defining sections of the exported document.
9159 However, since the outline structure is also used for (for example) lists of
9160 tasks, only the first three outline levels will be used as headings. Deeper
9161 levels will become itemized lists. You can change the location of this
9162 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9163 per-file basis with a line
9170 @node Table of contents, Initial text, Headings and sections, Structural markup elements
9171 @subheading Table of contents
9172 @cindex table of contents, markup rules
9174 @vindex org-export-with-toc
9175 The table of contents is normally inserted directly before the first headline
9176 of the file. If you would like to get it to a different location, insert the
9177 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
9178 location. The depth of the table of contents is by default the same as the
9179 number of headline levels, but you can choose a smaller number, or turn off
9180 the table of contents entirely, by configuring the variable
9181 @code{org-export-with-toc}, or on a per-file basis with a line like
9184 #+OPTIONS: toc:2 (only to two levels in TOC)
9185 #+OPTIONS: toc:nil (no TOC at all)
9188 @node Initial text, Lists, Table of contents, Structural markup elements
9189 @subheading Text before the first headline
9190 @cindex text before first headline, markup rules
9193 Org mode normally exports the text before the first headline, and even uses
9194 the first line as the document title. The text will be fully marked up. If
9195 you need to include literal HTML or @LaTeX{} code, use the special constructs
9196 described below in the sections for the individual exporters.
9198 @vindex org-export-skip-text-before-1st-heading
9199 Some people like to use the space before the first headline for setup and
9200 internal links and therefore would like to control the exported text before
9201 the first headline in a different way. You can do so by setting the variable
9202 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
9203 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
9206 If you still want to have some text before the first headline, use the
9207 @code{#+TEXT} construct:
9211 #+TEXT: This text will go before the *first* headline.
9212 #+TEXT: [TABLE-OF-CONTENTS]
9213 #+TEXT: This goes between the table of contents and the *first* headline
9216 @node Lists, Paragraphs, Initial text, Structural markup elements
9218 @cindex lists, markup rules
9220 Plain lists as described in @ref{Plain lists}, are translated to the backend's
9221 syntax for such lists. Most backends support unordered, ordered, and
9224 @node Paragraphs, Footnote markup, Lists, Structural markup elements
9225 @subheading Paragraphs, line breaks, and quoting
9226 @cindex paragraphs, markup rules
9228 Paragraphs are separated by at least one empty line. If you need to enforce
9229 a line break within a paragraph, use @samp{\\} at the end of a line.
9231 To keep the line breaks in a region, but otherwise use normal formatting, you
9232 can use this construct, which can also be used to format poetry.
9234 @cindex #+BEGIN_VERSE
9237 Great clouds overhead
9238 Tiny black birds rise and fall
9245 When quoting a passage from another document, it is customary to format this
9246 as a paragraph that is indented on both the left and the right margin. You
9247 can include quotations in Org mode documents like this:
9249 @cindex #+BEGIN_QUOTE
9252 Everything should be made as simple as possible,
9253 but not any simpler -- Albert Einstein
9257 If you would like to center some text, do it like this:
9258 @cindex #+BEGIN_CENTER
9261 Everything should be made as simple as possible, \\
9267 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
9268 @subheading Footnote markup
9269 @cindex footnotes, markup rules
9270 @cindex @file{footnote.el}
9272 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9273 by all backends. Org allows multiple references to the same note, and
9274 multiple footnotes side by side.
9276 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
9277 @subheading Emphasis and monospace
9279 @cindex underlined text, markup rules
9280 @cindex bold text, markup rules
9281 @cindex italic text, markup rules
9282 @cindex verbatim text, markup rules
9283 @cindex code text, markup rules
9284 @cindex strike-through text, markup rules
9285 @vindex org-fontify-emphasized-text
9286 @vindex org-emphasis-regexp-components
9287 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
9288 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
9289 in the code and verbatim string is not processed for Org mode specific
9290 syntax; it is exported verbatim.
9292 To turn off fontification for marked up text, you can set
9293 @code{org-fontify-emphasized-text} to @code{nil}. To fine tune what
9294 characters are allowed before and after the special characters, see
9295 @code{org-emphasis-regexp-components}.
9297 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
9298 @subheading Horizontal rules
9299 @cindex horizontal rules, markup rules
9300 A line consisting of only dashes, and at least 5 of them, will be exported as
9301 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
9303 @node Comment lines, , Horizontal rules, Structural markup elements
9304 @subheading Comment lines
9305 @cindex comment lines
9306 @cindex exporting, not
9307 @cindex #+BEGIN_COMMENT
9309 Lines starting with zero or more whitespace characters followed by one
9310 @samp{#} and a whitespace are treated as comments and will never be exported.
9311 Also entire subtrees starting with the word @samp{COMMENT} will never be
9312 exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
9313 ... @samp{#+END_COMMENT} will not be exported.
9318 Toggle the COMMENT keyword at the beginning of an entry.
9322 @node Images and tables, Literal examples, Structural markup elements, Markup
9323 @section Images and Tables
9325 @cindex tables, markup rules
9328 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9329 the @file{table.el} package will be exported properly. For Org mode tables,
9330 the lines before the first horizontal separator line will become table header
9331 lines. You can use the following lines somewhere before the table to assign
9332 a caption and a label for cross references, and in the text you can refer to
9333 the object with @code{\ref@{tab:basic-data@}}:
9336 #+CAPTION: This is the caption for the next table (or link)
9337 #+LABEL: tab:basic-data
9342 Optionally, the caption can take the form:
9344 #+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
9347 @cindex inlined images, markup rules
9348 Some backends (HTML and @LaTeX{}) allow you to directly include images into
9349 the exported document. Org does this, if a link to an image files does not
9350 have a description part, for example @code{[[./img/a.jpg]]}. If you wish to
9351 define a caption for the image and maybe a label for internal cross
9352 references, make sure that the link is on a line by itself and precede it
9353 with @code{#+CAPTION} and @code{#+LABEL} as follows:
9356 #+CAPTION: This is the caption for the next figure link (or table)
9357 #+LABEL: fig:SED-HR4049
9361 You may also define additional attributes for the figure. As this is
9362 backend-specific, see the sections about the individual backends for more
9365 @xref{Handling links,the discussion of image links}.
9367 @node Literal examples, Include files, Images and tables, Markup
9368 @section Literal examples
9369 @cindex literal examples, markup rules
9370 @cindex code line references, markup rules
9372 You can include literal examples that should not be subjected to
9373 markup. Such examples will be typeset in monospace, so this is well suited
9374 for source code and similar examples.
9375 @cindex #+BEGIN_EXAMPLE
9379 Some example from a text file.
9383 Note that such blocks may be @i{indented} in order to align nicely with
9384 indented text and in particular with plain list structure (@pxref{Plain
9385 lists}). For simplicity when using small examples, you can also start the
9386 example lines with a colon followed by a space. There may also be additional
9387 whitespace before the colon:
9391 : Some example from a text file.
9394 @cindex formatting source code, markup rules
9395 If the example is source code from a programming language, or any other text
9396 that can be marked up by font-lock in Emacs, you can ask for the example to
9397 look like the fontified Emacs buffer@footnote{This works automatically for
9398 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
9399 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9400 achieved using either the listings or the
9401 @url{http://code.google.com/p/minted, minted,} package. Refer to
9402 @code{org-latex-listings} documentation for details.}. This is done
9403 with the @samp{src} block, where you also need to specify the name of the
9404 major mode that should be used to fontify the example@footnote{Code in
9405 @samp{src} blocks may also be evaluated either interactively or on export.
9406 See @pxref{Working With Source Code} for more information on evaluating code
9407 blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code
9412 #+BEGIN_SRC emacs-lisp
9413 (defun org-xor (a b)
9419 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9420 switch to the end of the @code{BEGIN} line, to get the lines of the example
9421 numbered. If you use a @code{+n} switch, the numbering from the previous
9422 numbered snippet will be continued in the current one. In literal examples,
9423 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9424 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9425 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9426 link will remote-highlight the corresponding code line, which is kind of
9429 You can also add a @code{-r} switch which @i{removes} the labels from the
9430 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9431 labels in the source code while using line numbers for the links, which might
9432 be useful to explain those in an Org mode example code.}. With the @code{-n}
9433 switch, links to these references will be labeled by the line numbers from
9434 the code listing, otherwise links will use the labels with no parentheses.
9438 #+BEGIN_SRC emacs-lisp -n -r
9439 (save-excursion (ref:sc)
9440 (goto-char (point-min)) (ref:jump)
9442 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9446 @vindex org-coderef-label-format
9447 If the syntax for the label format conflicts with the language syntax, use a
9448 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9449 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9451 HTML export also allows examples to be published as text areas (@pxref{Text
9452 areas in HTML export}).
9454 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9455 so often, shortcuts are provided using the Easy Templates facility
9456 (@pxref{Easy Templates}).
9461 Edit the source code example at point in its native mode. This works by
9462 switching to a temporary buffer with the source code. You need to exit by
9463 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9464 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9465 from being interpreted by Org as outline nodes or special syntax. These
9466 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9467 The edited version will then replace the old version in the Org buffer.
9468 Fixed-width regions (where each line starts with a colon followed by a space)
9469 will be edited using @code{artist-mode}@footnote{You may select
9470 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9471 to allow creating ASCII drawings easily. Using this command in an empty line
9472 will create a new fixed-width region.
9475 Calling @code{org-store-link} while editing a source code example in a
9476 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9477 that it is unique in the current buffer, and insert it with the proper
9478 formatting like @samp{(ref:label)} at the end of the current line. Then the
9479 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9483 @node Include files, Index entries, Literal examples, Markup
9484 @section Include files
9485 @cindex include files, markup rules
9487 During export, you can include the content of another file. For example, to
9488 include your @file{.emacs} file, you could use:
9492 #+INCLUDE: "~/.emacs" src emacs-lisp
9496 The optional second and third parameter are the markup (e.g., @samp{quote},
9497 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9498 language for formatting the contents. The markup is optional; if it is not
9499 given, the text will be assumed to be in Org mode format and will be
9500 processed normally. The include line will also allow additional keyword
9501 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
9502 first line and for each following line, @code{:minlevel} in order to get
9503 Org mode content demoted to a specified level, as well as any options
9504 accepted by the selected markup. For example, to include a file as an item,
9508 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
9511 You can also include a portion of a file by specifying a lines range using
9512 the @code{:lines} parameter. The line at the upper end of the range will not
9513 be included. The start and/or the end of the range may be omitted to use the
9517 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
9518 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
9519 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
9525 Visit the include file at point.
9528 @node Index entries, Macro replacement, Include files, Markup
9529 @section Index entries
9530 @cindex index entries, for publishing
9532 You can specify entries that will be used for generating an index during
9533 publishing. This is done by lines starting with @code{#+INDEX}. An entry
9534 the contains an exclamation mark will create a sub item. See @ref{Generating
9535 an index} for more information.
9540 #+INDEX: Application!CV
9546 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
9547 @section Macro replacement
9548 @cindex macro replacement, during export
9551 You can define text snippets with
9554 #+MACRO: name replacement text $1, $2 are arguments
9557 @noindent which can be referenced anywhere in the document (even in
9558 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
9559 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
9560 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
9561 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9562 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9563 and to the modification time of the file being exported, respectively.
9564 @var{FORMAT} should be a format string understood by
9565 @code{format-time-string}.
9567 Macro expansion takes place during export, and some people use it to
9568 construct complex HTML code.
9571 @node Embedded @LaTeX{}, , Macro replacement, Markup
9572 @section Embedded @LaTeX{}
9573 @cindex @TeX{} interpretation
9574 @cindex @LaTeX{} interpretation
9576 Plain ASCII is normally sufficient for almost all note taking. Exceptions
9577 include scientific notes, which often require mathematical symbols and the
9578 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9579 Donald E. Knuth's @TeX{} system. Many of the features described here as
9580 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9581 distinction.} is widely used to typeset scientific documents. Org mode
9582 supports embedding @LaTeX{} code into its files, because many academics are
9583 used to writing and reading @LaTeX{} source code, and because it can be
9584 readily processed to produce pretty output for a number of export backends.
9587 * Special symbols:: Greek letters and other symbols
9588 * Subscripts and superscripts:: Simple syntax for raising/lowering text
9589 * @LaTeX{} fragments:: Complex formulas made easy
9590 * Previewing @LaTeX{} fragments:: What will this snippet look like?
9591 * CDLaTeX mode:: Speed up entering of formulas
9594 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
9595 @subsection Special symbols
9596 @cindex math symbols
9597 @cindex special symbols
9598 @cindex @TeX{} macros
9599 @cindex @LaTeX{} fragments, markup rules
9600 @cindex HTML entities
9601 @cindex @LaTeX{} entities
9603 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
9604 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
9605 for these macros is available, just type @samp{\} and maybe a few letters,
9606 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
9607 code, Org mode allows these macros to be present without surrounding math
9608 delimiters, for example:
9611 Angles are written as Greek letters \alpha, \beta and \gamma.
9614 @vindex org-entities
9615 During export, these symbols will be transformed into the native format of
9616 the exporter backend. Strings like @code{\alpha} will be exported as
9617 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9618 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
9619 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
9620 like this: @samp{\Aacute@{@}stor}.
9622 A large number of entities is provided, with names taken from both HTML and
9623 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9624 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9625 @samp{...} are all converted into special commands creating hyphens of
9626 different lengths or a compact set of dots.
9628 If you would like to see entities displayed as UTF8 characters, use the
9629 following command@footnote{You can turn this on by default by setting the
9630 variable @code{org-pretty-entities}, or on a per-file base with the
9631 @code{#+STARTUP} option @code{entitiespretty}.}:
9636 Toggle display of entities as UTF-8 characters. This does not change the
9637 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9638 for display purposes only.
9641 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
9642 @subsection Subscripts and superscripts
9646 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9647 and subscripts. Again, these can be used without embedding them in
9648 math-mode delimiters. To increase the readability of ASCII text, it is
9649 not necessary (but OK) to surround multi-character sub- and superscripts
9650 with curly braces. For example
9653 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9654 the sun is R_@{sun@} = 6.96 x 10^8 m.
9657 @vindex org-export-with-sub-superscripts
9658 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9659 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9660 where the underscore is often used in a different context, Org's convention
9661 to always interpret these as subscripts can get in your way. Configure the
9662 variable @code{org-export-with-sub-superscripts} to globally change this
9663 convention, or use, on a per-file basis:
9669 @noindent With this setting, @samp{a_b} will not be interpreted as a
9670 subscript, but @samp{a_@{b@}} will.
9675 In addition to showing entities as UTF-8 characters, this command will also
9676 format sub- and superscripts in a WYSIWYM way.
9679 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
9680 @subsection @LaTeX{} fragments
9681 @cindex @LaTeX{} fragments
9683 @vindex org-format-latex-header
9684 Going beyond symbols and sub- and superscripts, a full formula language is
9685 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
9686 to process these for several export backends. When exporting to @LaTeX{},
9687 the code is obviously left as it is. When exporting to HTML, Org invokes the
9688 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9689 HTML export}) to process and display the math@footnote{If you plan to use
9690 this regularly or on pages with significant page views, you should install
9691 @file{MathJax} on your own
9692 server in order to limit the load of our server.}. Finally, it can also
9693 process the mathematical expressions into images@footnote{For this to work
9694 you need to be on a system with a working @LaTeX{} installation. You also
9695 need the @file{dvipng} program or the @file{convert}, respectively available
9696 at @url{http://sourceforge.net/projects/dvipng/} and from the
9697 @file{imagemagick} suite. The @LaTeX{} header that will be used when
9698 processing a fragment can be configured with the variable
9699 @code{org-format-latex-header}.} that can be displayed in a browser.
9701 @LaTeX{} fragments don't need any special marking at all. The following
9702 snippets will be identified as @LaTeX{} source code:
9705 Environments of any kind@footnote{When @file{MathJax} is used, only the
9706 environment recognized by @file{MathJax} will be processed. When
9707 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9708 handled.}. The only requirement is that the @code{\begin} statement appears
9709 on a new line, preceded by only whitespace.
9711 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9712 currency specifications, single @samp{$} characters are only recognized as
9713 math delimiters if the enclosed text contains at most two line breaks, is
9714 directly attached to the @samp{$} characters with no whitespace in between,
9715 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9716 For the other delimiters, there is no such restriction, so when in doubt, use
9717 @samp{\(...\)} as inline math delimiters.
9720 @noindent For example:
9723 \begin@{equation@} % arbitrary environments,
9724 x=\sqrt@{b@} % even tables, figures
9725 \end@{equation@} % etc
9727 If $a^2=b$ and \( b=2 \), then the solution must be
9728 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9732 @vindex org-format-latex-options
9733 If you need any of the delimiter ASCII sequences for other purposes, you
9734 can configure the option @code{org-format-latex-options} to deselect the
9735 ones you do not wish to have interpreted by the @LaTeX{} converter.
9737 @vindex org-export-with-LaTeX-fragments
9738 @LaTeX{} processing can be configured with the variable
9739 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9740 which means @file{MathJax} for HTML, and no processing for ASCII and @LaTeX{}
9741 backends. You can also set this variable on a per-file basis using one of
9745 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9746 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9747 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9748 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9751 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
9752 @subsection Previewing @LaTeX{} fragments
9753 @cindex @LaTeX{} fragments, preview
9755 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9756 produce preview images of the typeset expressions:
9761 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9762 over the source code. If there is no fragment at point, process all
9763 fragments in the current entry (between two headlines). When called
9764 with a prefix argument, process the entire subtree. When called with
9765 two prefix arguments, or when the cursor is before the first headline,
9766 process the entire buffer.
9769 Remove the overlay preview images.
9772 @vindex org-format-latex-options
9773 You can customize the variable @code{org-format-latex-options} to influence
9774 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9775 export, @code{:html-scale}) property can be used to adjust the size of the
9778 @vindex org-startup-with-latex-preview
9779 You can turn on the previewing of all @LaTeX{} fragments in a file with
9782 #+STARTUP: latexpreview
9785 To disable it, simply use
9788 #+STARTUP: nolatexpreview
9791 @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
9792 @subsection Using CD@LaTeX{} to enter math
9795 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
9796 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9797 environments and math templates. Inside Org mode, you can make use of
9798 some of the features of CD@LaTeX{} mode. You need to install
9799 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9800 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9801 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
9802 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
9803 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9807 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9810 When this mode is enabled, the following features are present (for more
9811 details see the documentation of CD@LaTeX{} mode):
9815 Environment templates can be inserted with @kbd{C-c @{}.
9818 The @key{TAB} key will do template expansion if the cursor is inside a
9819 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
9820 inside such a fragment, see the documentation of the function
9821 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9822 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9823 correctly inside the first brace. Another @key{TAB} will get you into
9824 the second brace. Even outside fragments, @key{TAB} will expand
9825 environment abbreviations at the beginning of a line. For example, if
9826 you write @samp{equ} at the beginning of a line and press @key{TAB},
9827 this abbreviation will be expanded to an @code{equation} environment.
9828 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9832 @vindex cdlatex-simplify-sub-super-scripts
9833 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9834 characters together with a pair of braces. If you use @key{TAB} to move
9835 out of the braces, and if the braces surround only a single character or
9836 macro, they are removed again (depending on the variable
9837 @code{cdlatex-simplify-sub-super-scripts}).
9840 Pressing the backquote @kbd{`} followed by a character inserts math
9841 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9842 after the backquote, a help window will pop up.
9845 Pressing the single-quote @kbd{'} followed by another character modifies
9846 the symbol before point with an accent or a font. If you wait more than
9847 1.5 seconds after the single-quote, a help window will pop up. Character
9848 modification will work only inside @LaTeX{} fragments; outside the quote
9852 @node Exporting, Publishing, Markup, Top
9856 Org mode documents can be exported into a variety of other formats. For
9857 printing and sharing of notes, ASCII export produces a readable and simple
9858 version of an Org file. HTML export allows you to publish a notes file on
9859 the web, while the XOXO format provides a solid base for exchange with a
9860 broad range of other applications. @LaTeX{} export lets you use Org mode and
9861 its structured editing functions to easily create @LaTeX{} files.
9862 OpenDocument Text (ODT) export allows seamless collaboration across
9863 organizational boundaries. To incorporate entries with associated times like
9864 deadlines or appointments into a desktop calendar program like iCal, Org mode
9865 can also produce extracts in the iCalendar format. Currently, Org mode only
9866 supports export, not import of these different formats.
9868 Org supports export of selected regions when @code{transient-mark-mode} is
9869 enabled (default in Emacs 23).
9872 * Selective export:: Using tags to select and exclude trees
9873 * Export options:: Per-file export settings
9874 * The export dispatcher:: How to access exporter commands
9875 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9876 * HTML export:: Exporting to HTML
9877 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9878 * OpenDocument Text export:: Exporting to OpenDocument Text
9879 * Freemind export:: Exporting to Freemind mind maps
9880 * XOXO export:: Exporting to XOXO
9881 * iCalendar export:: Exporting in iCalendar format
9884 @node Selective export, Export options, Exporting, Exporting
9885 @section Selective export
9886 @cindex export, selective by tags or TODO keyword
9888 @vindex org-export-select-tags
9889 @vindex org-export-exclude-tags
9890 @cindex org-export-with-tasks
9891 You may use tags to select the parts of a document that should be exported,
9892 or to exclude parts from export. This behavior is governed by two variables:
9893 @code{org-export-select-tags} and @code{org-export-exclude-tags},
9894 respectively defaulting to @code{'(:export:)} and @code{'(:noexport:)}.
9898 Org first checks if any of the @emph{select} tags is present in the
9899 buffer. If yes, all trees that do not carry one of these tags will be
9900 excluded. If a selected tree is a subtree, the heading hierarchy above it
9901 will also be selected for export, but not the text below those headings.
9904 If none of the select tags is found, the whole buffer will be selected for
9908 Finally, all subtrees that are marked by any of the @emph{exclude} tags will
9909 be removed from the export buffer.
9912 The variable @code{org-export-with-tasks} can be configured to select which
9913 kind of tasks should be included for export. See the docstring of the
9914 variable for more information.
9916 @node Export options, The export dispatcher, Selective export, Exporting
9917 @section Export options
9918 @cindex options, for export
9920 @cindex completion, of option keywords
9921 The exporter recognizes special lines in the buffer which provide
9922 additional information. These lines may be put anywhere in the file.
9923 The whole set of lines can be inserted into the buffer with @kbd{C-c
9924 C-e t}. For individual lines, a good way to make sure the keyword is
9925 correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion
9926 (@pxref{Completion}). For a summary of other in-buffer settings not
9927 specifically related to export, see @ref{In-buffer settings}.
9928 In particular, note that you can place commonly-used (export) options in
9929 a separate file which can be included using @code{#+SETUPFILE}.
9932 @orgcmd{C-c C-e t,org-insert-export-options-template}
9933 Insert template with export options, see example below.
9940 @cindex #+DESCRIPTION
9946 @cindex #+HTML_LINK_UP
9947 @cindex #+HTML_LINK_HOME
9948 @cindex #+SELECT_TAGS
9949 @cindex #+EXCLUDE_TAGS
9950 @cindex #+LaTeX_HEADER
9951 @vindex user-full-name
9952 @vindex user-mail-address
9953 @vindex org-export-default-language
9954 @vindex org-export-date-timestamp-format
9956 #+TITLE: the title to be shown (default is the buffer name)
9957 #+AUTHOR: the author (default taken from @code{user-full-name})
9958 #+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}
9959 #+EMAIL: his/her email address (default from @code{user-mail-address})
9960 #+DESCRIPTION: the page description, e.g., for the XHTML meta tag
9961 #+KEYWORDS: the page keywords, e.g., for the XHTML meta tag
9962 #+LANGUAGE: language for HTML, e.g., @samp{en} (@code{org-export-default-language})
9963 #+TEXT: Some descriptive text to be inserted at the beginning.
9964 #+TEXT: Several lines may be given.
9965 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9966 #+BIND: lisp-var lisp-val, e.g., @code{org-latex-image-default-option width=.7\\linewidth}
9967 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9968 #+HTML_LINK_UP: the ``up'' link of an exported page
9969 #+HTML_LINK_HOME: the ``home'' link of an exported page
9970 #+LaTeX_HEADER: extra line(s) for the @LaTeX{} header, like \usepackage@{xyz@}
9971 #+SELECT_TAGS: Tags that select a tree for export
9972 #+EXCLUDE_TAGS: Tags that exclude a tree from export
9976 The @code{#+OPTIONS} line is a compact@footnote{If you want to configure many options
9977 this way, you can use several @code{#+OPTIONS} lines.} form to specify export
9978 settings. Here you can:
9979 @cindex headline levels
9980 @cindex section-numbers
9981 @cindex table of contents
9982 @cindex line-break preservation
9983 @cindex quoted HTML tags
9984 @cindex fixed-width sections
9986 @cindex @TeX{}-like syntax for sub- and superscripts
9988 @cindex special strings
9989 @cindex emphasized text
9990 @cindex @TeX{} macros
9991 @cindex @LaTeX{} fragments
9992 @cindex author info, in export
9993 @cindex time info, in export
9994 @vindex org-export-plist-vars
9995 @vindex org-export-author-info
9996 @vindex org-export-creator-info
9997 @vindex org-export-email-info
9998 @vindex org-export-time-stamp-file
10000 H: @r{set the number of headline levels for export}
10001 num: @r{turn on/off section-numbers}
10002 toc: @r{turn on/off table of contents, or set level limit (integer)}
10003 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
10004 @@: @r{turn on/off quoted HTML tags}
10005 :: @r{turn on/off fixed-width sections}
10006 |: @r{turn on/off tables}
10007 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
10008 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
10009 @r{the simple @code{a_b} will be left as it is.}
10010 -: @r{turn on/off conversion of special strings.}
10011 f: @r{turn on/off footnotes like this[1].}
10012 todo: @r{turn on/off inclusion of TODO keywords into exported text}
10013 tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
10014 @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
10015 pri: @r{turn on/off priority cookies}
10016 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
10017 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
10018 *: @r{turn on/off emphasized text (bold, italic, underlined)}
10019 TeX: @r{turn on/off simple @TeX{} macros in plain text}
10020 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
10021 skip: @r{turn on/off skipping the text before the first heading}
10022 author: @r{turn on/off inclusion of author name/email into exported file}
10023 email: @r{turn on/off inclusion of author email into exported file}
10024 creator: @r{turn on/off inclusion of creator info into exported file}
10025 timestamp: @r{turn on/off inclusion creation time into exported file}
10026 d: @r{turn on/off inclusion of drawers, or list drawers to include}
10029 These options take effect in both the HTML and @LaTeX{} export, except for
10030 @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
10031 @code{nil} for the @LaTeX{} export.
10033 The default values for these and many other options are given by a set of
10034 variables. For a list of such variables, the corresponding OPTIONS keys and
10035 also the publishing keys (@pxref{Project alist}), see the constant
10036 @code{org-export-plist-vars}.
10038 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
10039 calling an export command, the subtree can overrule some of the file's export
10040 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
10041 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
10042 @code{EXPORT_OPTIONS}.
10044 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
10045 @section The export dispatcher
10046 @cindex dispatcher, for export commands
10048 All export commands can be reached using the export dispatcher, which is a
10049 prefix key that prompts for an additional key specifying the command.
10050 Normally the entire file is exported, but if there is an active region that
10051 contains one outline tree, the first heading is used as document title and
10052 the subtrees are exported.
10055 @orgcmd{C-c C-e,org-export}
10056 @vindex org-export-run-in-background
10057 Dispatcher for export and publishing commands. Displays a help-window
10058 listing the additional key(s) needed to launch an export or publishing
10059 command. The prefix arg is passed through to the exporter. A double prefix
10060 @kbd{C-u C-u} causes most commands to be executed in the background, in a
10061 separate Emacs process@footnote{To make this behavior the default, customize
10062 the variable @code{org-export-run-in-background}.}.
10063 @orgcmd{C-c C-e v,org-export-visible}
10064 Like @kbd{C-c C-e}, but only export the text that is currently visible
10065 (i.e., not hidden by outline visibility).
10066 @orgcmd{C-u C-u C-c C-e,org-export}
10067 @vindex org-export-run-in-background
10068 Call the exporter, but reverse the setting of
10069 @code{org-export-run-in-background}, i.e., request background processing if
10070 not set, or force processing in the current Emacs process if set.
10073 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
10074 @section ASCII/Latin-1/UTF-8 export
10075 @cindex ASCII export
10076 @cindex Latin-1 export
10077 @cindex UTF-8 export
10079 ASCII export produces a simple and very readable version of an Org mode
10080 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10081 with special characters and symbols available in these encodings.
10083 @cindex region, active
10084 @cindex active region
10085 @cindex transient-mark-mode
10087 @orgcmd{C-c C-e a,org-export-as-ascii}
10088 @cindex property, EXPORT_FILE_NAME
10089 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
10090 will be @file{myfile.txt}. The file will be overwritten without
10091 warning. If there is an active region@footnote{This requires
10092 @code{transient-mark-mode} be turned on.}, only the region will be
10093 exported. If the selected region is a single tree@footnote{To select the
10094 current subtree, use @kbd{C-c @@}.}, the tree head will
10095 become the document title. If the tree head entry has or inherits an
10096 @code{EXPORT_FILE_NAME} property, that name will be used for the
10098 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
10099 Export to a temporary buffer. Do not create a file.
10100 @orgcmd{C-c C-e n,org-export-as-latin1}
10101 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
10102 Like the above commands, but use Latin-1 encoding.
10103 @orgcmd{C-c C-e u,org-export-as-utf8}
10104 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
10105 Like the above commands, but use UTF-8 encoding.
10106 @item C-c C-e v a/n/u
10107 Export only the visible part of the document.
10110 @cindex headline levels, for exporting
10111 In the exported version, the first 3 outline levels will become
10112 headlines, defining a general document structure. Additional levels
10113 will be exported as itemized lists. If you want that transition to occur
10114 at a different level, specify it with a prefix argument. For example,
10117 @kbd{C-1 C-c C-e a}
10121 creates only top level headlines and exports the rest as items. When
10122 headlines are converted to items, the indentation of the text following
10123 the headline is changed to fit nicely under the item. This is done with
10124 the assumption that the first body line indicates the base indentation of
10125 the body text. Any indentation larger than this is adjusted to preserve
10126 the layout relative to the first line. Should there be lines with less
10127 indentation than the first one, these are left alone.
10129 @vindex org-export-ascii-links-to-notes
10130 Links will be exported in a footnote-like style, with the descriptive part in
10131 the text and the link in a note before the next heading. See the variable
10132 @code{org-export-ascii-links-to-notes} for details and other options.
10134 @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
10135 @section HTML export
10136 @cindex HTML export
10138 Org mode contains a HTML (XHTML 1.0 strict) exporter with extensive
10139 HTML formatting, in ways similar to John Gruber's @emph{markdown}
10140 language, but with additional support for tables.
10143 * HTML Export commands:: How to invoke HTML export
10144 * HTML preamble and postamble:: How to insert a preamble and a postamble
10145 * Quoting HTML tags:: Using direct HTML in Org mode
10146 * Links in HTML export:: How links will be interpreted and formatted
10147 * Tables in HTML export:: How to modify the formatting of tables
10148 * Images in HTML export:: How to insert figures into HTML output
10149 * Math formatting in HTML export:: Beautiful math also on the web
10150 * Text areas in HTML export:: An alternative way to show an example
10151 * CSS support:: Changing the appearance of the output
10152 * JavaScript support:: Info and Folding in a web browser
10155 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
10156 @subsection HTML export commands
10158 @cindex region, active
10159 @cindex active region
10160 @cindex transient-mark-mode
10162 @orgcmd{C-c C-e h,org-export-as-html}
10163 @cindex property, EXPORT_FILE_NAME
10164 Export as a HTML file. For an Org file @file{myfile.org},
10165 the HTML file will be @file{myfile.html}. The file will be overwritten
10166 without warning. If there is an active region@footnote{This requires
10167 @code{transient-mark-mode} be turned on.}, only the region will be
10168 exported. If the selected region is a single tree@footnote{To select the
10169 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10170 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10171 property, that name will be used for the export.
10172 @orgcmd{C-c C-e b,org-export-as-html-and-open}
10173 Export as a HTML file and immediately open it with a browser.
10174 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
10175 Export to a temporary buffer. Do not create a file.
10176 @orgcmd{C-c C-e R,org-export-region-as-html}
10177 Export the active region to a temporary buffer. With a prefix argument, do
10178 not produce the file header and footer, but just the plain HTML section for
10179 the region. This is good for cut-and-paste operations.
10180 @item C-c C-e v h/b/H/R
10181 Export only the visible part of the document.
10182 @item M-x org-export-region-as-html
10183 Convert the region to HTML under the assumption that it was in Org mode
10184 syntax before. This is a global command that can be invoked in any
10186 @item M-x org-replace-region-by-HTML
10187 Replace the active region (assumed to be in Org mode syntax) by HTML
10191 @cindex headline levels, for exporting
10192 In the exported version, the first 3 outline levels will become headlines,
10193 defining a general document structure. Additional levels will be exported as
10194 itemized lists. If you want that transition to occur at a different level,
10195 specify it with a numeric prefix argument. For example,
10198 @kbd{C-2 C-c C-e b}
10202 creates two levels of headings and does the rest as items.
10205 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
10206 @subsection HTML preamble and postamble
10207 @vindex org-html-preamble
10208 @vindex org-html-postamble
10209 @vindex org-html-preamble-format
10210 @vindex org-html-postamble-format
10211 @vindex org-html-validation-link
10212 @vindex org-export-author-info
10213 @vindex org-export-email-info
10214 @vindex org-export-creator-info
10215 @vindex org-export-time-stamp-file
10217 The HTML exporter lets you define a preamble and a postamble.
10219 The default value for @code{org-html-preamble} is @code{t}, which means
10220 that the preamble is inserted depending on the relevant format string in
10221 @code{org-html-preamble-format}.
10223 Setting @code{org-html-preamble} to a string will override the default
10224 format string. Setting it to a function, will insert the output of the
10225 function, which must be a string; such a function takes no argument but you
10226 can check against the value of @code{opt-plist}, which contains the list of
10227 publishing properties for the current file. Setting to @code{nil} will not
10228 insert any preamble.
10230 The default value for @code{org-html-postamble} is @code{'auto}, which
10231 means that the HTML exporter will look for the value of
10232 @code{org-export-author-info}, @code{org-export-email-info},
10233 @code{org-export-creator-info} and @code{org-export-time-stamp-file},
10234 @code{org-html-validation-link} and build the postamble from these
10235 values. Setting @code{org-html-postamble} to @code{t} will insert the
10236 postamble from the relevant format string found in
10237 @code{org-html-postamble-format}. Setting it to @code{nil} will not
10238 insert any postamble.
10240 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
10241 @subsection Quoting HTML tags
10243 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
10244 @samp{>} in HTML export. If you want to include simple HTML tags
10245 which should be interpreted as such, mark them with @samp{@@} as in
10246 @samp{@@<b>bold text@@</b>}. Note that this really works only for
10247 simple tags. For more extensive HTML that should be copied verbatim to
10248 the exported file use either
10251 @cindex #+BEGIN_HTML
10253 #+HTML: Literal HTML code for export
10257 @cindex #+BEGIN_HTML
10261 All lines between these markers are exported literally
10266 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
10267 @subsection Links in HTML export
10269 @cindex links, in HTML export
10270 @cindex internal links, in HTML export
10271 @cindex external links, in HTML export
10272 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
10273 includes automatic links created by radio targets (@pxref{Radio
10274 targets}). Links to external files will still work if the target file is on
10275 the same @i{relative} path as the published Org file. Links to other
10276 @file{.org} files will be translated into HTML links under the assumption
10277 that a HTML version also exists of the linked file, at the same relative
10278 path. @samp{id:} links can then be used to jump to specific entries across
10279 files. For information related to linking files while publishing them to a
10280 publishing directory see @ref{Publishing links}.
10282 If you want to specify attributes for links, you can do so using a special
10283 @code{#+ATTR_HTML} line to define attributes that will be added to the
10284 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
10285 and @code{style} attributes for a link:
10287 @cindex #+ATTR_HTML
10289 #+ATTR_HTML: title="The Org mode homepage" style="color:red;"
10290 [[http://orgmode.org]]
10293 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
10295 @cindex tables, in HTML
10296 @vindex org-html-table-tag
10298 Org mode tables are exported to HTML using the table tag defined in
10299 @code{org-html-table-tag}. The default setting makes tables without
10300 cell borders and frame. If you would like to change this for individual
10301 tables, place something like the following before the table:
10304 @cindex #+ATTR_HTML
10306 #+CAPTION: This is a table with lines around and between cells
10307 #+ATTR_HTML: border="2" rules="all" frame="border"
10310 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
10311 @subsection Images in HTML export
10313 @cindex images, inline in HTML
10314 @cindex inlining images in HTML
10315 @vindex org-html-inline-images
10316 HTML export can inline images given as links in the Org file, and
10317 it can make an image the clickable part of a link. By
10318 default@footnote{But see the variable
10319 @code{org-html-inline-images}.}, images are inlined if a link does
10320 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
10321 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
10322 @samp{the image} that points to the image. If the description part
10323 itself is a @code{file:} link or a @code{http:} URL pointing to an
10324 image, this image will be inlined and activated so that clicking on the
10325 image will activate the link. For example, to include a thumbnail that
10326 will link to a high resolution version of the image, you could use:
10329 [[file:highres.jpg][file:thumb.jpg]]
10332 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
10333 In the example below we specify the @code{alt} and @code{title} attributes to
10334 support text viewers and accessibility, and align it to the right.
10337 @cindex #+ATTR_HTML
10339 #+CAPTION: A black cat stalking a spider
10340 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
10345 You could use @code{http} addresses just as well.
10347 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
10348 @subsection Math formatting in HTML export
10352 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
10353 different ways on HTML pages. The default is to use the
10354 @uref{http://www.mathjax.org, MathJax system} which should work out of the
10355 box with Org mode installation because @code{http://orgmode.org} serves
10356 @file{MathJax} for Org mode users for small applications and for testing
10357 purposes. @b{If you plan to use this regularly or on pages with significant
10358 page views, you should install@footnote{Installation instructions can be
10359 found on the MathJax website, see
10360 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
10361 your own server in order to limit the load of our server.} To configure
10362 @file{MathJax}, use the variable @code{org-html-mathjax-options} or
10363 insert something like the following into the buffer:
10366 #+HTML_MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
10369 @noindent See the docstring of the variable
10370 @code{org-html-mathjax-options} for the meaning of the parameters in
10373 If you prefer, you can also request that @LaTeX{} fragments are processed
10374 into small images that will be inserted into the browser page. Before the
10375 availability of MathJax, this was the default method for Org files. This
10376 method requires that the @file{dvipng} program is available on your system.
10377 You can still get this processing with
10380 #+OPTIONS: LaTeX:dvipng
10383 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
10384 @subsection Text areas in HTML export
10386 @cindex text areas, in HTML
10387 An alternative way to publish literal code examples in HTML is to use text
10388 areas, where the example can even be edited before pasting it into an
10389 application. It is triggered by a @code{-t} switch at an @code{example} or
10390 @code{src} block. Using this switch disables any options for syntax and
10391 label highlighting, and line numbering, which may be present. You may also
10392 use @code{-h} and @code{-w} switches to specify the height and width of the
10393 text area, which default to the number of lines in the example, and 80,
10394 respectively. For example
10397 #+BEGIN_EXAMPLE -t -w 40
10398 (defun org-xor (a b)
10405 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
10406 @subsection CSS support
10407 @cindex CSS, for HTML export
10408 @cindex HTML export, CSS
10410 @vindex org-html-todo-kwd-class-prefix
10411 @vindex org-html-tag-class-prefix
10412 You can also give style information for the exported file. The HTML exporter
10413 assigns the following special CSS classes@footnote{If the classes on TODO
10414 keywords and tags lead to conflicts, use the variables
10415 @code{org-html-todo-kwd-class-prefix} and
10416 @code{org-html-tag-class-prefix} to make them unique.} to appropriate
10417 parts of the document---your style specifications may change these, in
10418 addition to any of the standard classes like for headlines, tables, etc.
10420 p.author @r{author information, including email}
10421 p.date @r{publishing date}
10422 p.creator @r{creator info, about org mode version}
10423 .title @r{document title}
10424 .todo @r{TODO keywords, all not-done states}
10425 .done @r{the DONE keywords, all states that count as done}
10426 .WAITING @r{each TODO keyword also uses a class named after itself}
10427 .timestamp @r{timestamp}
10428 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
10429 .timestamp-wrapper @r{span around keyword plus timestamp}
10430 .tag @r{tag in a headline}
10431 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
10432 .target @r{target for links}
10433 .linenr @r{the line number in a code example}
10434 .code-highlighted @r{for highlighting referenced code lines}
10435 div.outline-N @r{div for outline level N (headline plus text))}
10436 div.outline-text-N @r{extra div for text at outline level N}
10437 .section-number-N @r{section number in headlines, different for each level}
10438 div.figure @r{how to format an inlined image}
10439 pre.src @r{formatted source code}
10440 pre.example @r{normal example}
10441 p.verse @r{verse paragraph}
10442 div.footnotes @r{footnote section headline}
10443 p.footnote @r{footnote definition paragraph, containing a footnote}
10444 .footref @r{a footnote reference number (always a <sup>)}
10445 .footnum @r{footnote number in footnote definition (always <sup>)}
10448 @vindex org-html-style-default
10449 @vindex org-html-style-include-default
10450 @vindex org-html-style
10451 @vindex org-html-style-default
10452 Each exported file contains a compact default style that defines these
10453 classes in a basic way@footnote{This style is defined in the constant
10454 @code{org-html-style-default}, which you should not modify. To turn
10455 inclusion of these defaults off, customize
10456 @code{org-html-style-include-default}}. You may overwrite these
10457 settings, or add to them by using the variables @code{org-html-style}
10458 (for Org-wide settings) and @code{org-html-style-extra} (for more
10459 fine-grained settings, like file-local settings). To set the latter variable
10460 individually for each file, you can use
10462 @cindex #+HTML_STYLE
10464 #+HTML_STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
10468 For longer style definitions, you can use several such lines. You could also
10469 directly write a @code{<style>} @code{</style>} section in this way, without
10470 referring to an external file.
10472 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
10473 property to assign a class to the tree. In order to specify CSS styles for a
10474 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
10477 @c FIXME: More about header and footer styles
10478 @c FIXME: Talk about links and targets.
10480 @node JavaScript support, , CSS support, HTML export
10481 @subsection JavaScript supported display of web pages
10483 @cindex Rose, Sebastian
10484 Sebastian Rose has written a JavaScript program especially designed to
10485 enhance the web viewing experience of HTML files created with Org. This
10486 program allows you to view large files in two different ways. The first one
10487 is an @emph{Info}-like mode where each section is displayed separately and
10488 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
10489 as well, press @kbd{?} for an overview of the available keys). The second
10490 view type is a @emph{folding} view much like Org provides inside Emacs. The
10491 script is available at @url{http://orgmode.org/org-info.js} and you can find
10492 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
10493 We host the script at our site, but if you use it a lot, you might
10494 not want to be dependent on @url{orgmode.org} and prefer to install a local
10495 copy on your own web server.
10497 To use the script, you need to make sure that the @file{org-jsinfo.el} module
10498 gets loaded. It should be loaded by default, but you can try @kbd{M-x
10499 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
10500 this is indeed the case. All it then takes to make use of the program is
10501 adding a single line to the Org file:
10503 @cindex #+INFOJS_OPT
10505 #+INFOJS_OPT: view:info toc:nil
10509 If this line is found, the HTML header will automatically contain the code
10510 needed to invoke the script. Using the line above, you can set the following
10514 path: @r{The path to the script. The default is to grab the script from}
10515 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
10516 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
10517 view: @r{Initial view when the website is first shown. Possible values are:}
10518 info @r{Info-like interface with one section per page.}
10519 overview @r{Folding interface, initially showing only top-level.}
10520 content @r{Folding interface, starting with all headlines visible.}
10521 showall @r{Folding interface, all headlines and text visible.}
10522 sdepth: @r{Maximum headline level that will still become an independent}
10523 @r{section for info and folding modes. The default is taken from}
10524 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
10525 @r{If this is smaller than in @code{org-export-headline-levels}, each}
10526 @r{info/folding section can still contain child headlines.}
10527 toc: @r{Should the table of contents @emph{initially} be visible?}
10528 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
10529 tdepth: @r{The depth of the table of contents. The defaults are taken from}
10530 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
10531 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
10532 @r{If yes, the toc will never be displayed as a section.}
10533 ltoc: @r{Should there be short contents (children) in each section?}
10534 @r{Make this @code{above} if the section should be above initial text.}
10535 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
10536 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
10537 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
10538 @r{default), only one such button will be present.}
10541 @vindex org-infojs-options
10542 @vindex org-export-html-use-infojs
10543 You can choose default values for these options by customizing the variable
10544 @code{org-infojs-options}. If you always want to apply the script to your
10545 pages, configure the variable @code{org-export-html-use-infojs}.
10547 @node @LaTeX{} and PDF export, OpenDocument Text export, HTML export, Exporting
10548 @section @LaTeX{} and PDF export
10549 @cindex @LaTeX{} export
10551 @cindex Guerry, Bastien
10553 Org mode contains a @LaTeX{} exporter. With further processing@footnote{The
10554 default @LaTeX{} output is designed for processing with @code{pdftex} or
10555 @LaTeX{}. It includes packages that are not compatible with @code{xetex} and
10556 possibly @code{luatex}. See the variables
10557 @code{org-latex-default-packages-alist} and
10558 @code{org-latex-packages-alist}.}, this backend is also used to produce PDF
10559 output. Since the @LaTeX{} output uses @file{hyperref} to implement links
10560 and cross references, the PDF output file will be fully linked. Beware of
10561 the fact that your @code{org} file has to be properly structured in order to
10562 be correctly exported: respect the hierarchy of sections.
10565 * @LaTeX{}/PDF export commands::
10566 * Header and sectioning:: Setting up the export file structure
10567 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
10568 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
10569 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
10570 * Beamer class export:: Turning the file into a presentation
10573 @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
10574 @subsection @LaTeX{} export commands
10576 @cindex region, active
10577 @cindex active region
10578 @cindex transient-mark-mode
10580 @orgcmd{C-c C-e l,org-export-as-latex}
10581 @cindex property EXPORT_FILE_NAME
10582 Export as a @LaTeX{} file. For an Org file
10583 @file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will
10584 be overwritten without warning. If there is an active region@footnote{This
10585 requires @code{transient-mark-mode} be turned on.}, only the region will be
10586 exported. If the selected region is a single tree@footnote{To select the
10587 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10588 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
10589 property, that name will be used for the export.
10590 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
10591 Export to a temporary buffer. Do not create a file.
10592 @item C-c C-e v l/L
10593 Export only the visible part of the document.
10594 @item M-x org-export-region-as-latex
10595 Convert the region to @LaTeX{} under the assumption that it was in Org mode
10596 syntax before. This is a global command that can be invoked in any
10598 @item M-x org-replace-region-by-latex
10599 Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
10601 @orgcmd{C-c C-e p,org-export-as-pdf}
10602 Export as @LaTeX{} and then process to PDF.
10603 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
10604 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10607 @cindex headline levels, for exporting
10608 @vindex org-latex-low-levels
10609 In the exported version, the first 3 outline levels will become
10610 headlines, defining a general document structure. Additional levels
10611 will be exported as description lists. The exporter can ignore them or
10612 convert them to a custom string depending on
10613 @code{org-latex-low-levels}.
10615 If you want that transition to occur at a different level, specify it
10616 with a numeric prefix argument. For example,
10619 @kbd{C-2 C-c C-e l}
10623 creates two levels of headings and does the rest as items.
10625 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
10626 @subsection Header and sectioning structure
10627 @cindex @LaTeX{} class
10628 @cindex @LaTeX{} sectioning structure
10629 @cindex @LaTeX{} header
10630 @cindex header, for @LaTeX{} files
10631 @cindex sectioning structure, for @LaTeX{} export
10633 By default, the @LaTeX{} output uses the class @code{article}.
10635 @vindex org-latex-default-class
10636 @vindex org-latex-classes
10637 @vindex org-latex-default-packages-alist
10638 @vindex org-latex-packages-alist
10639 @cindex #+LaTeX_HEADER
10640 @cindex #+LaTeX_CLASS
10641 @cindex #+LaTeX_CLASS_OPTIONS
10642 @cindex property, LaTeX_CLASS
10643 @cindex property, LaTeX_CLASS_OPTIONS
10644 You can change this globally by setting a different value for
10645 @code{org-latex-default-class} or locally by adding an option like
10646 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
10647 property that applies when exporting a region containing only this (sub)tree.
10648 The class must be listed in @code{org-latex-classes}. This variable
10649 defines a header template for each class@footnote{Into which the values of
10650 @code{org-latex-default-packages-alist} and
10651 @code{org-latex-packages-alist} are spliced.}, and allows you to
10652 define the sectioning structure for each class. You can also define your own
10653 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{:LaTeX_CLASS_OPTIONS:}
10654 property can specify the options for the @code{\documentclass} macro. The
10655 options to documentclass have to be provided, as expected by @LaTeX{}, within
10656 square brackets. You can also use @code{#+LaTeX_HEADER: \usepackage@{xyz@}}
10657 to add lines to the header. See the docstring of
10658 @code{org-latex-classes} for more information. An example is shown
10662 #+LaTeX_CLASS: article
10663 #+LaTeX_CLASS_OPTIONS: [a4paper]
10664 #+LaTeX_HEADER: \usepackage@{xyz@}
10670 @node Quoting @LaTeX{} code, Tables in @LaTeX{} export, Header and sectioning, @LaTeX{} and PDF export
10671 @subsection Quoting @LaTeX{} code
10673 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
10674 inserted into the @LaTeX{} file. This includes simple macros like
10675 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
10676 you can add special code that should only be present in @LaTeX{} export with
10677 the following constructs:
10680 @cindex #+BEGIN_LaTeX
10682 #+LaTeX: Literal @LaTeX{} code for export
10686 @cindex #+BEGIN_LaTeX
10690 All lines between these markers are exported literally
10695 @node Tables in @LaTeX{} export, Images in @LaTeX{} export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
10696 @subsection Tables in @LaTeX{} export
10697 @cindex tables, in @LaTeX{} export
10699 For @LaTeX{} export of a table, you can specify a label, a caption and
10700 placement options (@pxref{Images and tables}). You can also use the
10701 @code{ATTR_LaTeX} line to request a @code{longtable} environment for the
10702 table, so that it may span several pages, or to change the default table
10703 environment from @code{table} to @code{table*} or to change the default inner
10704 tabular environment to @code{tabularx} or @code{tabulary}. Finally, you can
10705 set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
10710 @cindex #+ATTR_LaTeX
10712 #+CAPTION: A long table
10714 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10719 or to specify a multicolumn table with @code{tabulary}
10723 @cindex #+ATTR_LaTeX
10725 #+CAPTION: A wide table with tabulary
10727 #+ATTR_LaTeX: table* tabulary width=\textwidth
10732 @node Images in @LaTeX{} export, Beamer class export, Tables in @LaTeX{} export, @LaTeX{} and PDF export
10733 @subsection Images in @LaTeX{} export
10734 @cindex images, inline in @LaTeX{}
10735 @cindex inlining images in @LaTeX{}
10737 Images that are linked to without a description part in the link, like
10738 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10739 output file resulting from @LaTeX{} processing. Org will use an
10740 @code{\includegraphics} macro to insert the image. If you have specified a
10741 caption and/or a label as described in @ref{Images and tables}, the figure
10742 will be wrapped into a @code{figure} environment and thus become a floating
10743 element. You can use an @code{#+ATTR_LaTeX:} line to specify various other
10744 options. You can ask org to export an image as a float without specifying
10745 a label or a caption by using the keyword @code{float} in this line. Various
10746 optional arguments to the @code{\includegraphics} macro can also be specified
10747 in this fashion. To modify the placement option of the floating environment,
10748 add something like @samp{placement=[h!]} to the attributes. It is to be noted
10749 this option can be used with tables as well@footnote{One can also take
10750 advantage of this option to pass other, unrelated options into the figure or
10751 table environment. For an example see the section ``Exporting org files'' in
10752 @url{http://orgmode.org/worg/org-hacks.html}}.
10754 If you would like to let text flow around the image, add the word @samp{wrap}
10755 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10756 half of the page. To fine-tune, the @code{placement} field will be the set
10757 of additional arguments needed by the @code{wrapfigure} environment. Note
10758 that if you change the size of the image, you need to use compatible settings
10759 for @code{\includegraphics} and @code{wrapfigure}.
10763 @cindex #+ATTR_LaTeX
10765 #+CAPTION: The black-body emission of the disk around HR 4049
10766 #+LABEL: fig:SED-HR4049
10767 #+ATTR_LaTeX: width=5cm,angle=90
10768 [[./img/sed-hr4049.pdf]]
10770 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10774 If you wish to include an image which spans multiple columns in a page, you
10775 can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line. This
10776 will export the image wrapped in a @code{figure*} environment.
10778 If you need references to a label created in this way, write
10779 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10781 @node Beamer class export, , Images in @LaTeX{} export, @LaTeX{} and PDF export
10782 @subsection Beamer class export
10784 The @LaTeX{} class @file{beamer} allows production of high quality presentations
10785 using @LaTeX{} and pdf processing. Org mode has special support for turning an
10786 Org mode file or tree into a @file{beamer} presentation.
10788 When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
10789 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10790 @code{beamer}, a special export mode will turn the file or tree into a beamer
10791 presentation. Any tree with not-too-deep level nesting should in principle be
10792 exportable as a beamer presentation. By default, the top-level entries (or
10793 the first level below the selected subtree heading) will be turned into
10794 frames, and the outline structure below this level will become itemize lists.
10795 You can also configure the variable @code{org-beamer-frame-level} to a
10796 different level---then the hierarchy above frames will produce the sectioning
10797 structure of the presentation.
10799 A template for useful in-buffer settings or properties can be inserted into
10800 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10801 things, this will install a column view format which is very handy for
10802 editing special properties used by beamer.
10804 You can influence the structure of the presentation using the following
10809 The environment that should be used to format this entry. Valid environments
10810 are defined in the constant @code{org-beamer-environments-default}, and you
10811 can define more in @code{org-beamer-environments-extra}. If this property is
10812 set, the entry will also get a @code{:B_environment:} tag to make this
10813 visible. This tag has no semantic meaning, it is only a visual aid.
10814 @item BEAMER_envargs
10815 The beamer-special arguments that should be used for the environment, like
10816 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10817 property is also set, something like @code{C[t]} can be added here as well to
10818 set an options argument for the implied @code{columns} environment.
10819 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10822 The width of a column that should start with this entry. If this property is
10823 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10824 Also this tag is only a visual aid. When this is a plain number, it will be
10825 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10826 that you have specified the units, like @samp{3cm}. The first such property
10827 in a frame will start a @code{columns} environment to surround the columns.
10828 This environment is closed when an entry has a @code{BEAMER_col} property
10829 with value 0 or 1, or automatically at the end of the frame.
10831 Additional commands that should be inserted after the environment has been
10832 opened. For example, when creating a frame, this can be used to specify
10836 Frames will automatically receive a @code{fragile} option if they contain
10837 source code that uses the verbatim environment. Special @file{beamer}
10838 specific code can be inserted using @code{#+BEAMER:} and
10839 @code{#+BEGIN_BEAMER...#+END_BEAMER} constructs, similar to other export
10840 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10841 in the presentation as well.
10843 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10844 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10845 into @code{\note@{...@}}. The former will include the heading as part of the
10846 note text, the latter will ignore the heading of that node. To simplify note
10847 generation, it is actually enough to mark the note with a @emph{tag} (either
10848 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10849 @code{BEAMER_env} property.
10851 You can turn on a special minor mode @code{org-beamer-mode} for editing
10859 @orgcmd{C-c C-b,org-beamer-select-environment}
10860 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10861 environment or the @code{BEAMER_col} property.
10864 Column view provides a great way to set the environment of a node and other
10865 important parameters. Make sure you are using a COLUMN format that is geared
10866 toward this special purpose. The command @kbd{M-x
10867 org-insert-beamer-options-template} defines such a format.
10869 Here is a simple example Org document that is intended for beamer export.
10872 #+LaTeX_CLASS: beamer
10873 #+TITLE: Example Presentation
10874 #+AUTHOR: Carsten Dominik
10875 #+LaTeX_CLASS_OPTIONS: [presentation]
10876 #+BEAMER_FRAME_LEVEL: 2
10877 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10878 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10880 * This is the first structural section
10882 ** Frame 1 \\ with a subtitle
10883 *** Thanks to Eric Fraga :BMCOL:B_block:
10886 :BEAMER_envargs: C[t]
10889 for the first viable beamer setup in Org
10890 *** Thanks to everyone else :BMCOL:B_block:
10894 :BEAMER_envargs: <2->
10896 for contributing to the discussion
10897 **** This will be formatted as a beamer note :B_note:
10898 ** Frame 2 \\ where we will not use columns
10899 *** Request :B_block:
10900 Please test this stuff!
10906 For more information, see the documentation on Worg.
10908 @c begin opendocument
10910 @node OpenDocument Text export, Freemind export, @LaTeX{} and PDF export, Exporting
10911 @section OpenDocument Text export
10912 @cindex K, Jambunathan
10914 @cindex OpenDocument
10915 @cindex export, OpenDocument
10916 @cindex LibreOffice
10918 @cindex org-modules
10920 Org Mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
10921 (ODT) format using the @file{org-odt.el} module. Documents created
10922 by this exporter use the @cite{OpenDocument-v1.2
10923 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
10924 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
10925 are compatible with LibreOffice 3.4.
10928 * Pre-requisites for ODT export:: What packages ODT exporter relies on
10929 * ODT export commands:: How to invoke ODT export
10930 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
10931 * Applying custom styles:: How to apply custom styles to the output
10932 * Links in ODT export:: How links will be interpreted and formatted
10933 * Tables in ODT export:: How Tables are exported
10934 * Images in ODT export:: How to insert images
10935 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
10936 * Labels and captions in ODT export:: How captions are rendered
10937 * Literal examples in ODT export:: How source and example blocks are formatted
10938 * Advanced topics in ODT export:: Read this if you are a power user
10941 @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
10942 @subsection Pre-requisites for ODT export
10944 The ODT exporter relies on the @file{zip} program to create the final
10945 output. Check the availability of this program before proceeding further.
10947 @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
10948 @subsection ODT export commands
10950 @subsubheading Exporting to ODT
10951 @anchor{x-export-to-odt}
10953 @cindex region, active
10954 @cindex active region
10955 @cindex transient-mark-mode
10957 @orgcmd{C-c C-e o,org-export-as-odt}
10958 @cindex property EXPORT_FILE_NAME
10960 Export as OpenDocument Text file.
10962 @vindex org-export-odt-preferred-output-format
10963 If @code{org-export-odt-preferred-output-format} is specified, automatically
10964 convert the exported file to that format. @xref{x-export-to-other-formats, ,
10965 Automatically exporting to other formats}.
10967 For an Org file @file{myfile.org}, the ODT file will be
10968 @file{myfile.odt}. The file will be overwritten without warning. If there
10969 is an active region,@footnote{This requires @code{transient-mark-mode} to be
10970 turned on} only the region will be exported. If the selected region is a
10971 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
10972 tree head will become the document title. If the tree head entry has, or
10973 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
10976 @orgcmd{C-c C-e O,org-export-as-odt-and-open}
10977 Export as an OpenDocument Text file and open the resulting file.
10979 @vindex org-export-odt-preferred-output-format
10980 If @code{org-export-odt-preferred-output-format} is specified, open the
10981 converted file instead. @xref{x-export-to-other-formats, , Automatically
10982 exporting to other formats}.
10985 @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
10986 @subsection Extending ODT export
10988 The ODT exporter can interface with a variety of document
10989 converters and supports popular converters out of the box. As a result, you
10990 can use it to export to formats like @samp{doc} or convert a document from
10991 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
10993 @cindex @file{unoconv}
10994 @cindex LibreOffice
10995 If you have a working installation of LibreOffice, a document converter is
10996 pre-configured for you and you can use it right away. If you would like to
10997 use @file{unoconv} as your preferred converter, customize the variable
10998 @code{org-export-odt-convert-process} to point to @code{unoconv}. You can
10999 also use your own favorite converter or tweak the default settings of the
11000 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
11001 document converter}.
11003 @subsubsection Automatically exporting to other formats
11004 @anchor{x-export-to-other-formats}
11006 @vindex org-export-odt-preferred-output-format
11007 Very often, you will find yourself exporting to ODT format, only to
11008 immediately save the exported document to other formats like @samp{doc},
11009 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
11010 preferred output format by customizing the variable
11011 @code{org-export-odt-preferred-output-format}. This way, the export commands
11012 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
11013 format that is of immediate interest to you.
11015 @subsubsection Converting between document formats
11016 @anchor{x-convert-to-other-formats}
11018 There are many document converters in the wild which support conversion to
11019 and from various file formats, including, but not limited to the
11020 ODT format. LibreOffice converter, mentioned above, is one such
11021 converter. Once a converter is configured, you can interact with it using
11022 the following command.
11024 @vindex org-export-odt-convert
11027 @item M-x org-export-odt-convert
11028 Convert an existing document from one format to another. With a prefix
11029 argument, also open the newly produced file.
11032 @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
11033 @subsection Applying custom styles
11034 @cindex styles, custom
11035 @cindex template, custom
11037 The ODT exporter ships with a set of OpenDocument styles
11038 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
11039 output. These factory styles, however, may not cater to your specific
11040 tastes. To customize the output, you can either modify the above styles
11041 files directly, or generate the required styles using an application like
11042 LibreOffice. The latter method is suitable for expert and non-expert
11043 users alike, and is described here.
11045 @subsubsection Applying custom styles: the easy way
11049 Create a sample @file{example.org} file with the below settings and export it
11053 #+OPTIONS: H:10 num:t
11057 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
11058 to locate the target styles---these typically have the @samp{Org} prefix---and
11059 modify those to your taste. Save the modified file either as an
11060 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
11063 @cindex #+ODT_STYLES_FILE
11064 @vindex org-export-odt-styles-file
11065 Customize the variable @code{org-export-odt-styles-file} and point it to the
11066 newly created file. For additional configuration options
11067 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
11069 If you would like to choose a style on a per-file basis, you can use the
11070 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
11073 #+ODT_STYLES_FILE: "/path/to/example.ott"
11079 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
11084 @subsubsection Using third-party styles and templates
11086 You can use third-party styles and templates for customizing your output.
11087 This will produce the desired output only if the template provides all
11088 style names that the @samp{ODT} exporter relies on. Unless this condition is
11089 met, the output is going to be less than satisfactory. So it is highly
11090 recommended that you only work with templates that are directly derived from
11091 the factory settings.
11093 @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
11094 @subsection Links in ODT export
11095 @cindex links, in ODT export
11097 ODT exporter creates native cross-references for internal links. It creates
11098 Internet-style links for all other links.
11100 A link with no description and destined to a regular (un-itemized) outline
11101 heading is replaced with a cross-reference and section number of the heading.
11103 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
11104 with a cross-reference and sequence number of the labeled entity.
11105 @xref{Labels and captions in ODT export}.
11107 @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
11108 @subsection Tables in ODT export
11109 @cindex tables, in ODT export
11111 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
11112 tables is supported. However, export of complex @file{table.el} tables---tables
11113 that have column or row spans---is not supported. Such tables are
11114 stripped from the exported document.
11116 By default, a table is exported with top and bottom frames and with rules
11117 separating row and column groups (@pxref{Column groups}). Furthermore, all
11118 tables are typeset to occupy the same width. If the table specifies
11119 alignment and relative width for its columns (@pxref{Column width and
11120 alignment}) then these are honored on export.@footnote{The column widths are
11121 interpreted as weighted ratios with the default weight being 1}
11124 You can control the width of the table by specifying @code{:rel-width}
11125 property using an @code{#+ATTR_ODT} line.
11127 For example, consider the following table which makes use of all the rules
11131 #+ATTR_ODT: :rel-width 50
11132 | Area/Month | Jan | Feb | Mar | Sum |
11133 |---------------+-------+-------+-------+-------|
11135 | <l13> | <r5> | <r5> | <r5> | <r6> |
11136 | North America | 1 | 21 | 926 | 948 |
11137 | Middle East | 6 | 75 | 844 | 925 |
11138 | Asia Pacific | 9 | 27 | 790 | 826 |
11139 |---------------+-------+-------+-------+-------|
11140 | Sum | 16 | 123 | 2560 | 2699 |
11143 On export, the table will occupy 50% of text area. The columns will be sized
11144 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
11145 and rest of the columns will be right-aligned. There will be vertical rules
11146 after separating the header and last columns from other columns. There will
11147 be horizontal rules separating the header and last rows from other rows.
11149 If you are not satisfied with the above formatting options, you can create
11150 custom table styles and associate them with a table using the
11151 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
11153 @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
11154 @subsection Images in ODT export
11155 @cindex images, embedding in ODT
11156 @cindex embedding images in ODT
11158 @subsubheading Embedding images
11159 You can embed images within the exported document by providing a link to the
11160 desired image file with no link description. For example, to embed
11161 @samp{img.png} do either of the following:
11171 @subsubheading Embedding clickable images
11172 You can create clickable images by providing a link whose description is a
11173 link to an image file. For example, to embed a image
11174 @file{org-mode-unicorn.png} which when clicked jumps to
11175 @uref{http://Orgmode.org} website, do the following
11178 [[http://orgmode.org][./org-mode-unicorn.png]]
11181 @subsubheading Sizing and scaling of embedded images
11184 You can control the size and scale of the embedded images using the
11185 @code{#+ATTR_ODT} attribute.
11187 @cindex identify, ImageMagick
11188 @vindex org-export-odt-pixels-per-inch
11189 The exporter specifies the desired size of the image in the final document in
11190 units of centimeters. In order to scale the embedded images, the exporter
11191 queries for pixel dimensions of the images using one of a) ImageMagick's
11192 @file{identify} program or b) Emacs `create-image' and `image-size'
11193 APIs.@footnote{Use of @file{ImageMagick} is only desirable. However, if you
11194 routinely produce documents that have large images or you export your Org
11195 files that has images using a Emacs batch script, then the use of
11196 @file{ImageMagick} is mandatory.} The pixel dimensions are subsequently
11197 converted in to units of centimeters using
11198 @code{org-export-odt-pixels-per-inch}. The default value of this variable is
11199 set to @code{display-pixels-per-inch}. You can tweak this variable to
11200 achieve the best results.
11202 The examples below illustrate the various possibilities.
11205 @item Explicitly size the image
11206 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
11209 #+ATTR_ODT: :width 10 :height 10
11213 @item Scale the image
11214 To embed @file{img.png} at half its size, do the following:
11217 #+ATTR_ODT: :scale 0.5
11221 @item Scale the image to a specific width
11222 To embed @file{img.png} with a width of 10 cm while retaining the original
11223 height:width ratio, do the following:
11226 #+ATTR_ODT: :width 10
11230 @item Scale the image to a specific height
11231 To embed @file{img.png} with a height of 10 cm while retaining the original
11232 height:width ratio, do the following
11235 #+ATTR_ODT: :height 10
11240 @subsubheading Anchoring of images
11243 You can control the manner in which an image is anchored by setting the
11244 @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
11245 of the the following three values for the @code{:anchor} property:
11246 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
11248 To create an image that is anchored to a page, do the following:
11250 #+ATTR_ODT: :anchor "page"
11254 @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
11255 @subsection Math formatting in ODT export
11257 The ODT exporter has special support for handling math.
11260 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
11261 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
11264 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
11265 @subsubsection Working with @LaTeX{} math snippets
11267 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
11268 document in one of the following ways:
11274 This option is activated on a per-file basis with
11280 With this option, @LaTeX{} fragments are first converted into MathML
11281 fragments using an external @LaTeX{}-to-MathML converter program. The
11282 resulting MathML fragments are then embedded as an OpenDocument Formula in
11283 the exported document.
11285 @vindex org-latex-to-mathml-convert-command
11286 @vindex org-latex-to-mathml-jar-file
11288 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
11289 @code{org-latex-to-mathml-convert-command} and
11290 @code{org-latex-to-mathml-jar-file}.
11292 If you prefer to use @file{MathToWeb}@footnote{See
11293 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
11294 converter, you can configure the above variables as shown below.
11297 (setq org-latex-to-mathml-convert-command
11298 "java -jar %j -unicode -force -df %o %I"
11299 org-latex-to-mathml-jar-file
11300 "/path/to/mathtoweb.jar")
11303 You can use the following commands to quickly verify the reliability of
11304 the @LaTeX{}-to-MathML converter.
11308 @item M-x org-export-as-odf
11309 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
11311 @item M-x org-export-as-odf-and-open
11312 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
11313 and open the formula file with the system-registered application.
11319 This option is activated on a per-file basis with
11322 #+OPTIONS: LaTeX:dvipng
11325 With this option, @LaTeX{} fragments are processed into PNG images and the
11326 resulting images are embedded in the exported document. This method requires
11327 that the @file{dvipng} program be available on your system.
11330 @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in ODT export
11331 @subsubsection Working with MathML or OpenDocument formula files
11333 For various reasons, you may find embedding @LaTeX{} math snippets in an
11334 ODT document less than reliable. In that case, you can embed a
11335 math equation by linking to its MathML (@file{.mml}) source or its
11336 OpenDocument formula (@file{.odf}) file as shown below:
11348 @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
11349 @subsection Labels and captions in ODT export
11351 You can label and caption various category of objects---an inline image, a
11352 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
11353 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
11354 each labeled or captioned object of a given category separately. As a
11355 result, each such object is assigned a sequence number based on order of it's
11356 appearance in the Org file.
11358 In the exported document, a user-provided caption is augmented with the
11359 category and sequence number. Consider the following inline image in an Org
11363 #+CAPTION: Bell curve
11364 #+LABEL: fig:SED-HR4049
11368 It could be rendered as shown below in the exported document.
11371 Figure 2: Bell curve
11374 @vindex org-export-odt-category-strings
11375 You can modify the category component of the caption by customizing the
11376 variable @code{org-export-odt-category-strings}. For example, to tag all
11377 embedded images with the string @samp{Illustration} (instead of the default
11378 @samp{Figure}) use the following setting.
11381 (setq org-export-odt-category-strings
11382 '(("en" "Table" "Illustration" "Equation" "Equation")))
11385 With this, previous image will be captioned as below in the exported
11389 Illustration 2: Bell curve
11392 @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
11393 @subsection Literal examples in ODT export
11395 Export of literal examples (@pxref{Literal examples}) with full fontification
11396 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
11397 generate all style definitions needed for a fancy listing.@footnote{Your
11398 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
11399 fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
11400 as prefix and inherit their color from the faces used by Emacs
11401 @code{font-lock} library for the source language.
11403 @vindex org-export-odt-fontify-srcblocks
11404 If you prefer to use your own custom styles for fontification, you can do so
11405 by customizing the variable
11406 @code{org-export-odt-create-custom-styles-for-srcblocks}.
11408 @vindex org-export-odt-create-custom-styles-for-srcblocks
11409 You can turn off fontification of literal examples by customizing the
11410 variable @code{org-export-odt-fontify-srcblocks}.
11412 @node Advanced topics in ODT export, , Literal examples in ODT export, OpenDocument Text export
11413 @subsection Advanced topics in ODT export
11415 If you rely heavily on ODT export, you may want to exploit the full
11416 set of features that the exporter offers. This section describes features
11417 that would be of interest to power users.
11420 * Configuring a document converter:: How to register a document converter
11421 * Working with OpenDocument style files:: Explore the internals
11422 * Creating one-off styles:: How to produce custom highlighting etc
11423 * Customizing tables in ODT export:: How to define and use Table templates
11424 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
11427 @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
11428 @subsubsection Configuring a document converter
11430 @cindex doc, docx, rtf
11433 The ODT exporter can work with popular converters with little or no
11434 extra configuration from your side. @xref{Extending ODT export}.
11435 If you are using a converter that is not supported by default or if you would
11436 like to tweak the default converter settings, proceed as below.
11439 @item Register the converter
11441 @vindex org-export-odt-convert-processes
11442 Name your converter and add it to the list of known converters by customizing
11443 the variable @code{org-export-odt-convert-processes}. Also specify how the
11444 converter can be invoked via command-line to effect the conversion.
11446 @item Configure its capabilities
11448 @vindex org-export-odt-convert-capabilities
11449 @anchor{x-odt-converter-capabilities}
11450 Specify the set of formats the converter can handle by customizing the
11451 variable @code{org-export-odt-convert-capabilities}. Use the default value
11452 for this variable as a guide for configuring your converter. As suggested by
11453 the default setting, you can specify the full set of formats supported by the
11454 converter and not limit yourself to specifying formats that are related to
11455 just the OpenDocument Text format.
11457 @item Choose the converter
11459 @vindex org-export-odt-convert-process
11460 Select the newly added converter as the preferred one by customizing the
11461 variable @code{org-export-odt-convert-process}.
11464 @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
11465 @subsubsection Working with OpenDocument style files
11466 @cindex styles, custom
11467 @cindex template, custom
11469 This section explores the internals of the ODT exporter and the
11470 means by which it produces styled documents. Read this section if you are
11471 interested in exploring the automatic and custom OpenDocument styles used by
11474 @anchor{x-factory-styles}
11475 @subsubheading Factory styles
11477 The ODT exporter relies on two files for generating its output.
11478 These files are bundled with the distribution under the directory pointed to
11479 by the variable @code{org-odt-styles-dir}. The two files are:
11482 @anchor{x-orgodtstyles-xml}
11484 @file{OrgOdtStyles.xml}
11486 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
11487 document. This file gets modified for the following purposes:
11491 To control outline numbering based on user settings.
11494 To add styles generated by @file{htmlfontify.el} for fontification of code
11498 @anchor{x-orgodtcontenttemplate-xml}
11500 @file{OrgOdtContentTemplate.xml}
11502 This file contributes to the @file{content.xml} file of the final @samp{ODT}
11503 document. The contents of the Org outline are inserted between the
11504 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
11506 Apart from serving as a template file for the final @file{content.xml}, the
11507 file serves the following purposes:
11511 It contains automatic styles for formatting of tables which are referenced by
11515 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
11516 elements that control how various entities---tables, images, equations,
11517 etc.---are numbered.
11521 @anchor{x-overriding-factory-styles}
11522 @subsubheading Overriding factory styles
11523 The following two variables control the location from which the ODT
11524 exporter picks up the custom styles and content template files. You can
11525 customize these variables to override the factory styles used by the
11529 @anchor{x-org-export-odt-styles-file}
11531 @code{org-export-odt-styles-file}
11533 Use this variable to specify the @file{styles.xml} that will be used in the
11534 final output. You can specify one of the following values:
11537 @item A @file{styles.xml} file
11539 Use this file instead of the default @file{styles.xml}
11541 @item A @file{.odt} or @file{.ott} file
11543 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11546 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
11548 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11549 Template file. Additionally extract the specified member files and embed
11550 those within the final @samp{ODT} document.
11552 Use this option if the @file{styles.xml} file references additional files
11553 like header and footer images.
11557 Use the default @file{styles.xml}
11560 @anchor{x-org-export-odt-content-template-file}
11562 @code{org-export-odt-content-template-file}
11564 Use this variable to specify the blank @file{content.xml} that will be used
11565 in the final output.
11568 @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
11569 @subsubsection Creating one-off styles
11571 There are times when you would want one-off formatting in the exported
11572 document. You can achieve this by embedding raw OpenDocument XML in the Org
11573 file. The use of this feature is better illustrated with couple of examples.
11576 @item Embedding ODT tags as part of regular text
11578 You can include simple OpenDocument tags by prefixing them with
11579 @samp{@@}. For example, to highlight a region of text do the following:
11582 @@<text:span text:style-name="Highlight">This is a
11583 highlighted text@@</text:span>. But this is a
11587 @strong{Hint:} To see the above example in action, edit your
11588 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11589 custom @samp{Highlight} style as shown below.
11592 <style:style style:name="Highlight" style:family="text">
11593 <style:text-properties fo:background-color="#ff0000"/>
11597 @item Embedding a one-line OpenDocument XML
11599 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
11600 directive. For example, to force a page break do the following:
11603 #+ODT: <text:p text:style-name="PageBreak"/>
11606 @strong{Hint:} To see the above example in action, edit your
11607 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11608 custom @samp{PageBreak} style as shown below.
11611 <style:style style:name="PageBreak" style:family="paragraph"
11612 style:parent-style-name="Text_20_body">
11613 <style:paragraph-properties fo:break-before="page"/>
11617 @item Embedding a block of OpenDocument XML
11619 You can add a large block of OpenDocument XML using the
11620 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
11622 For example, to create a one-off paragraph that uses bold text, do the
11627 <text:p text:style-name="Text_20_body_20_bold">
11628 This paragraph is specially formatted and uses bold text.
11635 @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
11636 @subsubsection Customizing tables in ODT export
11637 @cindex tables, in ODT export
11640 You can override the default formatting of the table by specifying a custom
11641 table style with the @code{#+ATTR_ODT} line. For a discussion on default
11642 formatting of tables @pxref{Tables in ODT export}.
11644 This feature closely mimics the way table templates are defined in the
11646 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11647 OpenDocument-v1.2 Specification}}
11651 @subsubheading Custom table styles: an illustration
11653 To have a quick preview of this feature, install the below setting and export
11654 the table that follows.
11657 (setq org-export-odt-table-styles
11658 (append org-export-odt-table-styles
11659 '(("TableWithHeaderRowAndColumn" "Custom"
11660 ((use-first-row-styles . t)
11661 (use-first-column-styles . t)))
11662 ("TableWithFirstRowandLastRow" "Custom"
11663 ((use-first-row-styles . t)
11664 (use-last-row-styles . t))))))
11668 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
11669 | Name | Phone | Age |
11670 | Peter | 1234 | 17 |
11671 | Anna | 4321 | 25 |
11674 In the above example, you used a template named @samp{Custom} and installed
11675 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
11676 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
11677 styles needed for producing the above template have been pre-defined for you.
11678 These styles are available under the section marked @samp{Custom Table
11679 Template} in @file{OrgOdtContentTemplate.xml}
11680 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
11681 additional templates you have to define these styles yourselves.
11683 @subsubheading Custom table styles: the nitty-gritty
11684 To use this feature proceed as follows:
11688 Create a table template@footnote{See the @code{<table:table-template>}
11689 element of the OpenDocument-v1.2 specification}
11691 A table template is nothing but a set of @samp{table-cell} and
11692 @samp{paragraph} styles for each of the following table cell categories:
11706 The names for the above styles must be chosen based on the name of the table
11707 template using a well-defined convention.
11709 The naming convention is better illustrated with an example. For a table
11710 template with the name @samp{Custom}, the needed style names are listed in
11711 the following table.
11713 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
11714 @headitem Table cell type
11715 @tab @code{table-cell} style
11716 @tab @code{paragraph} style
11721 @tab @samp{CustomTableCell}
11722 @tab @samp{CustomTableParagraph}
11724 @tab @samp{CustomFirstColumnTableCell}
11725 @tab @samp{CustomFirstColumnTableParagraph}
11727 @tab @samp{CustomLastColumnTableCell}
11728 @tab @samp{CustomLastColumnTableParagraph}
11730 @tab @samp{CustomFirstRowTableCell}
11731 @tab @samp{CustomFirstRowTableParagraph}
11733 @tab @samp{CustomLastRowTableCell}
11734 @tab @samp{CustomLastRowTableParagraph}
11736 @tab @samp{CustomEvenRowTableCell}
11737 @tab @samp{CustomEvenRowTableParagraph}
11739 @tab @samp{CustomOddRowTableCell}
11740 @tab @samp{CustomOddRowTableParagraph}
11742 @tab @samp{CustomEvenColumnTableCell}
11743 @tab @samp{CustomEvenColumnTableParagraph}
11745 @tab @samp{CustomOddColumnTableCell}
11746 @tab @samp{CustomOddColumnTableParagraph}
11749 To create a table template with the name @samp{Custom}, define the above
11751 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
11752 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
11756 Define a table style@footnote{See the attributes @code{table:template-name},
11757 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
11758 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
11759 @code{table:use-banding-rows-styles}, and
11760 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
11761 the OpenDocument-v1.2 specification}
11763 @vindex org-export-odt-table-styles
11764 To define a table style, create an entry for the style in the variable
11765 @code{org-export-odt-table-styles} and specify the following:
11768 @item the name of the table template created in step (1)
11769 @item the set of cell styles in that template that are to be activated
11772 For example, the entry below defines two different table styles
11773 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
11774 based on the same template @samp{Custom}. The styles achieve their intended
11775 effect by selectively activating the individual cell styles in that template.
11778 (setq org-export-odt-table-styles
11779 (append org-export-odt-table-styles
11780 '(("TableWithHeaderRowAndColumn" "Custom"
11781 ((use-first-row-styles . t)
11782 (use-first-column-styles . t)))
11783 ("TableWithFirstRowandLastRow" "Custom"
11784 ((use-first-row-styles . t)
11785 (use-last-row-styles . t))))))
11789 Associate a table with the table style
11791 To do this, specify the table style created in step (2) as part of
11792 the @code{ATTR_ODT} line as shown below.
11795 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
11796 | Name | Phone | Age |
11797 | Peter | 1234 | 17 |
11798 | Anna | 4321 | 25 |
11802 @node Validating OpenDocument XML, , Customizing tables in ODT export, Advanced topics in ODT export
11803 @subsubsection Validating OpenDocument XML
11805 Occasionally, you will discover that the document created by the
11806 ODT exporter cannot be opened by your favorite application. One of
11807 the common reasons for this is that the @file{.odt} file is corrupt. In such
11808 cases, you may want to validate the document against the OpenDocument RELAX
11809 NG Compact Syntax (RNC) schema.
11811 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
11812 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
11813 general help with validation (and schema-sensitive editing) of XML files:
11814 @inforef{Introduction,,nxml-mode}.
11816 @vindex org-export-odt-schema-dir
11817 If you have ready access to OpenDocument @file{.rnc} files and the needed
11818 schema-locating rules in a single folder, you can customize the variable
11819 @code{org-export-odt-schema-dir} to point to that directory. The
11820 ODT exporter will take care of updating the
11821 @code{rng-schema-locating-files} for you.
11823 @c end opendocument
11825 @node Freemind export, XOXO export, OpenDocument Text export, Exporting
11826 @section Freemind export
11827 @cindex Freemind export
11830 The Freemind exporter was written by Lennart Borgman.
11833 @orgcmd{C-c C-e m,org-export-as-freemind}
11834 Export as a Freemind mind map. For an Org file @file{myfile.org}, the Freemind
11835 file will be @file{myfile.mm}.
11838 @node XOXO export, iCalendar export, Freemind export, Exporting
11839 @section XOXO export
11840 @cindex XOXO export
11842 Org mode contains an exporter that produces XOXO-style output.
11843 Currently, this exporter only handles the general outline structure and
11844 does not interpret any additional Org mode features.
11847 @orgcmd{C-c C-e x,org-export-as-xoxo}
11848 Export as an XOXO file. For an Org file @file{myfile.org}, the XOXO file will be
11849 @file{myfile.html}.
11850 @orgkey{C-c C-e v x}
11851 Export only the visible part of the document.
11854 @node iCalendar export, , XOXO export, Exporting
11855 @section iCalendar export
11856 @cindex iCalendar export
11858 @vindex org-icalendar-include-todo
11859 @vindex org-icalendar-use-deadline
11860 @vindex org-icalendar-use-scheduled
11861 @vindex org-icalendar-categories
11862 @vindex org-icalendar-alarm-time
11863 Some people use Org mode for keeping track of projects, but still prefer a
11864 standard calendar application for anniversaries and appointments. In this
11865 case it can be useful to show deadlines and other time-stamped items in Org
11866 files in the calendar application. Org mode can export calendar information
11867 in the standard iCalendar format. If you also want to have TODO entries
11868 included in the export, configure the variable
11869 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
11870 and TODO items as VTODO@. It will also create events from deadlines that are
11871 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
11872 to set the start and due dates for the TODO entry@footnote{See the variables
11873 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
11874 As categories, it will use the tags locally defined in the heading, and the
11875 file/tree category@footnote{To add inherited tags or the TODO state,
11876 configure the variable @code{org-icalendar-categories}.}. See the variable
11877 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
11880 @vindex org-icalendar-store-UID
11881 @cindex property, ID
11882 The iCalendar standard requires each entry to have a globally unique
11883 identifier (UID). Org creates these identifiers during export. If you set
11884 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
11885 @code{:ID:} property of the entry and re-used next time you report this
11886 entry. Since a single entry can give rise to multiple iCalendar entries (as
11887 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
11888 prefixes to the UID, depending on what triggered the inclusion of the entry.
11889 In this way the UID remains unique, but a synchronization program can still
11890 figure out from which entry all the different instances originate.
11893 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
11894 Create iCalendar entries for the current file and store them in the same
11895 directory, using a file extension @file{.ics}.
11896 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
11897 @vindex org-agenda-files
11898 Like @kbd{C-c C-e i}, but do this for all files in
11899 @code{org-agenda-files}. For each of these files, a separate iCalendar
11900 file will be written.
11901 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
11902 @vindex org-combined-agenda-icalendar-file
11903 Create a single large iCalendar file from all files in
11904 @code{org-agenda-files} and write it to the file given by
11905 @code{org-combined-agenda-icalendar-file}.
11908 @vindex org-use-property-inheritance
11909 @vindex org-icalendar-include-body
11910 @cindex property, SUMMARY
11911 @cindex property, DESCRIPTION
11912 @cindex property, LOCATION
11913 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
11914 property can be inherited from higher in the hierarchy if you configure
11915 @code{org-use-property-inheritance} accordingly.} properties if the selected
11916 entries have them. If not, the summary will be derived from the headline,
11917 and the description from the body (limited to
11918 @code{org-icalendar-include-body} characters).
11920 How this calendar is best read and updated, depends on the application
11921 you are using. The FAQ covers this issue.
11923 @node Publishing, Working With Source Code, Exporting, Top
11924 @chapter Publishing
11927 Org includes a publishing management system that allows you to configure
11928 automatic HTML conversion of @emph{projects} composed of interlinked org
11929 files. You can also configure Org to automatically upload your exported HTML
11930 pages and related attachments, such as images and source code files, to a web
11933 You can also use Org to convert files into PDF, or even combine HTML and PDF
11934 conversion so that files are available in both formats on the server.
11936 Publishing has been contributed to Org by David O'Toole.
11939 * Configuration:: Defining projects
11940 * Uploading files:: How to get files up on the server
11941 * Sample configuration:: Example projects
11942 * Triggering publication:: Publication commands
11945 @node Configuration, Uploading files, Publishing, Publishing
11946 @section Configuration
11948 Publishing needs significant configuration to specify files, destination
11949 and many other properties of a project.
11952 * Project alist:: The central configuration variable
11953 * Sources and destinations:: From here to there
11954 * Selecting files:: What files are part of the project?
11955 * Publishing action:: Setting the function doing the publishing
11956 * Publishing options:: Tweaking HTML/@LaTeX{} export
11957 * Publishing links:: Which links keep working after publishing?
11958 * Sitemap:: Generating a list of all pages
11959 * Generating an index:: An index that reaches across pages
11962 @node Project alist, Sources and destinations, Configuration, Configuration
11963 @subsection The variable @code{org-publish-project-alist}
11964 @cindex org-publish-project-alist
11965 @cindex projects, for publishing
11967 @vindex org-publish-project-alist
11968 Publishing is configured almost entirely through setting the value of one
11969 variable, called @code{org-publish-project-alist}. Each element of the list
11970 configures one project, and may be in one of the two following forms:
11973 ("project-name" :property value :property value ...)
11974 @r{i.e., a well-formed property list with alternating keys and values}
11976 ("project-name" :components ("project-name" "project-name" ...))
11980 In both cases, projects are configured by specifying property values. A
11981 project defines the set of files that will be published, as well as the
11982 publishing configuration to use when publishing those files. When a project
11983 takes the second form listed above, the individual members of the
11984 @code{:components} property are taken to be sub-projects, which group
11985 together files requiring different publishing options. When you publish such
11986 a ``meta-project'', all the components will also be published, in the
11989 @node Sources and destinations, Selecting files, Project alist, Configuration
11990 @subsection Sources and destinations for files
11991 @cindex directories, for publishing
11993 Most properties are optional, but some should always be set. In
11994 particular, Org needs to know where to look for source files,
11995 and where to put published files.
11997 @multitable @columnfractions 0.3 0.7
11998 @item @code{:base-directory}
11999 @tab Directory containing publishing source files
12000 @item @code{:publishing-directory}
12001 @tab Directory where output files will be published. You can directly
12002 publish to a webserver using a file name syntax appropriate for
12003 the Emacs @file{tramp} package. Or you can publish to a local directory and
12004 use external tools to upload your website (@pxref{Uploading files}).
12005 @item @code{:preparation-function}
12006 @tab Function or list of functions to be called before starting the
12007 publishing process, for example, to run @code{make} for updating files to be
12008 published. The project property list is scoped into this call as the
12009 variable @code{project-plist}.
12010 @item @code{:completion-function}
12011 @tab Function or list of functions called after finishing the publishing
12012 process, for example, to change permissions of the resulting files. The
12013 project property list is scoped into this call as the variable
12014 @code{project-plist}.
12018 @node Selecting files, Publishing action, Sources and destinations, Configuration
12019 @subsection Selecting files
12020 @cindex files, selecting for publishing
12022 By default, all files with extension @file{.org} in the base directory
12023 are considered part of the project. This can be modified by setting the
12025 @multitable @columnfractions 0.25 0.75
12026 @item @code{:base-extension}
12027 @tab Extension (without the dot!) of source files. This actually is a
12028 regular expression. Set this to the symbol @code{any} if you want to get all
12029 files in @code{:base-directory}, even without extension.
12031 @item @code{:exclude}
12032 @tab Regular expression to match file names that should not be
12033 published, even though they have been selected on the basis of their
12036 @item @code{:include}
12037 @tab List of files to be included regardless of @code{:base-extension}
12038 and @code{:exclude}.
12040 @item @code{:recursive}
12041 @tab Non-nil means, check base-directory recursively for files to publish.
12044 @node Publishing action, Publishing options, Selecting files, Configuration
12045 @subsection Publishing action
12046 @cindex action, for publishing
12048 Publishing means that a file is copied to the destination directory and
12049 possibly transformed in the process. The default transformation is to export
12050 Org files as HTML files, and this is done by the function
12051 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
12052 export}). But you also can publish your content as PDF files using
12053 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
12054 @code{utf8} encoded files using the corresponding functions. If you want to
12055 publish the Org file itself, but with @i{archived}, @i{commented}, and
12056 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
12057 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
12058 produce @file{file.org} and @file{file.org.html} in the publishing
12059 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
12060 source and publishing directories are equal. Note that with this kind of
12061 setup, you need to add @code{:exclude "-source\\.org"} to the project
12062 definition in @code{org-publish-project-alist} to prevent the published
12063 source files from being considered as new org files the next time the project
12064 is published.}. Other files like images only need to be copied to the
12065 publishing destination; for this you may use @code{org-publish-attachment}.
12066 For non-Org files, you always need to specify the publishing function:
12068 @multitable @columnfractions 0.3 0.7
12069 @item @code{:publishing-function}
12070 @tab Function executing the publication of a file. This may also be a
12071 list of functions, which will all be called in turn.
12072 @item @code{:plain-source}
12073 @tab Non-nil means, publish plain source.
12074 @item @code{:htmlized-source}
12075 @tab Non-nil means, publish htmlized source.
12078 The function must accept three arguments: a property list containing at least
12079 a @code{:publishing-directory} property, the name of the file to be
12080 published, and the path to the publishing directory of the output file. It
12081 should take the specified file, make the necessary transformation (if any)
12082 and place the result into the destination folder.
12084 @node Publishing options, Publishing links, Publishing action, Configuration
12085 @subsection Options for the HTML/@LaTeX{} exporters
12086 @cindex options, for publishing
12088 The property list can be used to set many export options for the HTML
12089 and @LaTeX{} exporters. In most cases, these properties correspond to user
12090 variables in Org. The table below lists these properties along
12091 with the variable they belong to. See the documentation string for the
12092 respective variable for details.
12094 @vindex org-html-link-up
12095 @vindex org-html-link-home
12096 @vindex org-export-default-language
12097 @vindex org-display-custom-times
12098 @vindex org-export-headline-levels
12099 @vindex org-export-with-section-numbers
12100 @vindex org-export-section-number-format
12101 @vindex org-export-with-toc
12102 @vindex org-export-preserve-breaks
12103 @vindex org-export-with-archived-trees
12104 @vindex org-export-with-emphasize
12105 @vindex org-export-with-sub-superscripts
12106 @vindex org-export-with-special-strings
12107 @vindex org-export-with-footnotes
12108 @vindex org-export-with-drawers
12109 @vindex org-export-with-tags
12110 @vindex org-export-with-todo-keywords
12111 @vindex org-export-with-tasks
12112 @vindex org-export-with-done-tasks
12113 @vindex org-export-with-priority
12114 @vindex org-export-with-TeX-macros
12115 @vindex org-export-with-LaTeX-fragments
12116 @vindex org-export-skip-text-before-1st-heading
12117 @vindex org-export-with-fixed-width
12118 @vindex org-export-with-timestamps
12119 @vindex org-export-author-info
12120 @vindex org-export-email-info
12121 @vindex org-export-creator-info
12122 @vindex org-export-time-stamp-file
12123 @vindex org-export-with-tables
12124 @vindex org-export-highlight-first-table-line
12125 @vindex org-html-style-include-default
12126 @vindex org-html-style-include-scripts
12127 @vindex org-html-style
12128 @vindex org-html-style-extra
12129 @vindex org-html-link-org-files-as-html
12130 @vindex org-html-inline-images
12131 @vindex org-html-extension
12132 @vindex org-html-table-tag
12133 @vindex org-export-publishing-directory
12134 @vindex org-html-preamble
12135 @vindex org-html-postamble
12136 @vindex user-full-name
12137 @vindex user-mail-address
12138 @vindex org-export-select-tags
12139 @vindex org-export-exclude-tags
12141 @multitable @columnfractions 0.32 0.68
12142 @item @code{:link-up} @tab @code{org-html-link-up}
12143 @item @code{:link-home} @tab @code{org-html-link-home}
12144 @item @code{:language} @tab @code{org-export-default-language}
12145 @item @code{:customtime} @tab @code{org-display-custom-times}
12146 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
12147 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
12148 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
12149 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
12150 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
12151 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
12152 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
12153 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
12154 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
12155 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
12156 @item @code{:drawers} @tab @code{org-export-with-drawers}
12157 @item @code{:tags} @tab @code{org-export-with-tags}
12158 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
12159 @item @code{:tasks} @tab @code{org-export-with-tasks}
12160 @item @code{:priority} @tab @code{org-export-with-priority}
12161 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
12162 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
12163 @item @code{:latex-listings} @tab @code{org-latex-listings}
12164 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
12165 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
12166 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
12167 @item @code{:author} @tab @code{user-full-name}
12168 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
12169 @item @code{:author-info} @tab @code{org-export-author-info}
12170 @item @code{:email-info} @tab @code{org-export-email-info}
12171 @item @code{:creator-info} @tab @code{org-export-creator-info}
12172 @item @code{:tables} @tab @code{org-export-with-tables}
12173 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
12174 @item @code{:style-include-default} @tab @code{org-html-style-include-default}
12175 @item @code{:style-include-scripts} @tab @code{org-html-style-include-scripts}
12176 @item @code{:style} @tab @code{org-html-style}
12177 @item @code{:style-extra} @tab @code{org-html-style-extra}
12178 @item @code{:convert-org-links} @tab @code{org-html-link-org-files-as-html}
12179 @item @code{:inline-images} @tab @code{org-html-inline-images}
12180 @item @code{:html-extension} @tab @code{org-html-extension}
12181 @item @code{:html-preamble} @tab @code{org-html-preamble}
12182 @item @code{:html-postamble} @tab @code{org-html-postamble}
12183 @item @code{:xml-declaration} @tab @code{org-html-xml-declaration}
12184 @item @code{:html-table-tag} @tab @code{org-html-table-tag}
12185 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
12186 @item @code{:select-tags} @tab @code{org-export-select-tags}
12187 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
12188 @item @code{:latex-image-options} @tab @code{org-latex-image-default-option}
12191 Most of the @code{org-export-with-*} variables have the same effect in
12192 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
12193 @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
12194 @LaTeX{} export. See @code{org-export-plist-vars} to check this list of
12199 @vindex org-publish-project-alist
12200 When a property is given a value in @code{org-publish-project-alist},
12201 its setting overrides the value of the corresponding user variable (if
12202 any) during publishing. Options set within a file (@pxref{Export
12203 options}), however, override everything.
12205 @node Publishing links, Sitemap, Publishing options, Configuration
12206 @subsection Links between published files
12207 @cindex links, publishing
12209 To create a link from one Org file to another, you would use
12210 something like @samp{[[file:foo.org][The foo]]} or simply
12211 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
12212 becomes a link to @file{foo.html}. In this way, you can interlink the
12213 pages of your "org web" project and the links will work as expected when
12214 you publish them to HTML@. If you also publish the Org source file and want
12215 to link to that, use an @code{http:} link instead of a @code{file:} link,
12216 because @code{file:} links are converted to link to the corresponding
12219 You may also link to related files, such as images. Provided you are careful
12220 with relative file names, and provided you have also configured Org to upload
12221 the related files, these links will work too. See @ref{Complex example}, for
12222 an example of this usage.
12224 Sometimes an Org file to be published may contain links that are
12225 only valid in your production environment, but not in the publishing
12226 location. In this case, use the property
12228 @multitable @columnfractions 0.4 0.6
12229 @item @code{:link-validation-function}
12230 @tab Function to validate links
12234 to define a function for checking link validity. This function must
12235 accept two arguments, the file name and a directory relative to which
12236 the file name is interpreted in the production environment. If this
12237 function returns @code{nil}, then the HTML generator will only insert a
12238 description into the HTML file, but no link. One option for this
12239 function is @code{org-publish-validate-link} which checks if the given
12240 file is part of any project in @code{org-publish-project-alist}.
12242 @node Sitemap, Generating an index, Publishing links, Configuration
12243 @subsection Generating a sitemap
12244 @cindex sitemap, of published pages
12246 The following properties may be used to control publishing of
12247 a map of files for a given project.
12249 @multitable @columnfractions 0.35 0.65
12250 @item @code{:auto-sitemap}
12251 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
12252 or @code{org-publish-all}.
12254 @item @code{:sitemap-filename}
12255 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
12256 becomes @file{sitemap.html}).
12258 @item @code{:sitemap-title}
12259 @tab Title of sitemap page. Defaults to name of file.
12261 @item @code{:sitemap-function}
12262 @tab Plug-in function to use for generation of the sitemap.
12263 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
12264 of links to all files in the project.
12266 @item @code{:sitemap-sort-folders}
12267 @tab Where folders should appear in the sitemap. Set this to @code{first}
12268 (default) or @code{last} to display folders first or last,
12269 respectively. Any other value will mix files and folders.
12271 @item @code{:sitemap-sort-files}
12272 @tab How the files are sorted in the site map. Set this to
12273 @code{alphabetically} (default), @code{chronologically} or
12274 @code{anti-chronologically}. @code{chronologically} sorts the files with
12275 older date first while @code{anti-chronologically} sorts the files with newer
12276 date first. @code{alphabetically} sorts the files alphabetically. The date of
12277 a file is retrieved with @code{org-publish-find-date}.
12279 @item @code{:sitemap-ignore-case}
12280 @tab Should sorting be case-sensitive? Default @code{nil}.
12282 @item @code{:sitemap-file-entry-format}
12283 @tab With this option one can tell how a sitemap's entry is formatted in the
12284 sitemap. This is a format string with some escape sequences: @code{%t} stands
12285 for the title of the file, @code{%a} stands for the author of the file and
12286 @code{%d} stands for the date of the file. The date is retrieved with the
12287 @code{org-publish-find-date} function and formatted with
12288 @code{org-publish-sitemap-date-format}. Default @code{%t}.
12290 @item @code{:sitemap-date-format}
12291 @tab Format string for the @code{format-time-string} function that tells how
12292 a sitemap entry's date is to be formatted. This property bypasses
12293 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
12295 @item @code{:sitemap-sans-extension}
12296 @tab When non-nil, remove filenames' extensions from the generated sitemap.
12297 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
12298 Defaults to @code{nil}.
12302 @node Generating an index, , Sitemap, Configuration
12303 @subsection Generating an index
12304 @cindex index, in a publishing project
12306 Org mode can generate an index across the files of a publishing project.
12308 @multitable @columnfractions 0.25 0.75
12309 @item @code{:makeindex}
12310 @tab When non-nil, generate in index in the file @file{theindex.org} and
12311 publish it as @file{theindex.html}.
12314 The file will be created when first publishing a project with the
12315 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
12316 "theindex.inc"}. You can then build around this include statement by adding
12317 a title, style information, etc.
12319 @node Uploading files, Sample configuration, Configuration, Publishing
12320 @section Uploading files
12324 For those people already utilizing third party sync tools such as
12325 @command{rsync} or @command{unison}, it might be preferable not to use the built in
12326 @i{remote} publishing facilities of Org mode which rely heavily on
12327 Tramp. Tramp, while very useful and powerful, tends not to be
12328 so efficient for multiple file transfer and has been known to cause problems
12331 Specialized synchronization utilities offer several advantages. In addition
12332 to timestamp comparison, they also do content and permissions/attribute
12333 checks. For this reason you might prefer to publish your web to a local
12334 directory (possibly even @i{in place} with your Org files) and then use
12335 @file{unison} or @file{rsync} to do the synchronization with the remote host.
12337 Since Unison (for example) can be configured as to which files to transfer to
12338 a certain remote destination, it can greatly simplify the project publishing
12339 definition. Simply keep all files in the correct location, process your Org
12340 files with @code{org-publish} and let the synchronization tool do the rest.
12341 You do not need, in this scenario, to include attachments such as @file{jpg},
12342 @file{css} or @file{gif} files in the project definition since the 3rd party
12345 Publishing to a local directory is also much faster than to a remote one, so
12346 that you can afford more easily to republish entire projects. If you set
12347 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
12348 benefit of re-including any changed external files such as source example
12349 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
12350 Org is not smart enough to detect if included files have been modified.
12352 @node Sample configuration, Triggering publication, Uploading files, Publishing
12353 @section Sample configuration
12355 Below we provide two example configurations. The first one is a simple
12356 project publishing only a set of Org files. The second example is
12357 more complex, with a multi-component project.
12360 * Simple example:: One-component publishing
12361 * Complex example:: A multi-component publishing example
12364 @node Simple example, Complex example, Sample configuration, Sample configuration
12365 @subsection Example: simple publishing configuration
12367 This example publishes a set of Org files to the @file{public_html}
12368 directory on the local machine.
12371 (setq org-publish-project-alist
12373 :base-directory "~/org/"
12374 :publishing-directory "~/public_html"
12375 :section-numbers nil
12376 :table-of-contents nil
12377 :style "<link rel=\"stylesheet\"
12378 href=\"../other/mystyle.css\"
12379 type=\"text/css\"/>")))
12382 @node Complex example, , Simple example, Sample configuration
12383 @subsection Example: complex publishing configuration
12385 This more complicated example publishes an entire website, including
12386 Org files converted to HTML, image files, Emacs Lisp source code, and
12387 style sheets. The publishing directory is remote and private files are
12390 To ensure that links are preserved, care should be taken to replicate
12391 your directory structure on the web server, and to use relative file
12392 paths. For example, if your Org files are kept in @file{~/org} and your
12393 publishable images in @file{~/images}, you would link to an image with
12396 file:../images/myimage.png
12399 On the web server, the relative path to the image should be the
12400 same. You can accomplish this by setting up an "images" folder in the
12401 right place on the web server, and publishing images to it.
12404 (setq org-publish-project-alist
12406 :base-directory "~/org/"
12407 :base-extension "org"
12408 :publishing-directory "/ssh:user@@host:~/html/notebook/"
12409 :publishing-function org-publish-org-to-html
12410 :exclude "PrivatePage.org" ;; regexp
12412 :section-numbers nil
12413 :table-of-contents nil
12414 :style "<link rel=\"stylesheet\"
12415 href=\"../other/mystyle.css\" type=\"text/css\"/>"
12419 :base-directory "~/images/"
12420 :base-extension "jpg\\|gif\\|png"
12421 :publishing-directory "/ssh:user@@host:~/html/images/"
12422 :publishing-function org-publish-attachment)
12425 :base-directory "~/other/"
12426 :base-extension "css\\|el"
12427 :publishing-directory "/ssh:user@@host:~/html/other/"
12428 :publishing-function org-publish-attachment)
12429 ("website" :components ("orgfiles" "images" "other"))))
12432 @node Triggering publication, , Sample configuration, Publishing
12433 @section Triggering publication
12435 Once properly configured, Org can publish with the following commands:
12438 @orgcmd{C-c C-e X,org-publish}
12439 Prompt for a specific project and publish all files that belong to it.
12440 @orgcmd{C-c C-e P,org-publish-current-project}
12441 Publish the project containing the current file.
12442 @orgcmd{C-c C-e F,org-publish-current-file}
12443 Publish only the current file.
12444 @orgcmd{C-c C-e E,org-publish-all}
12445 Publish every project.
12448 @vindex org-publish-use-timestamps-flag
12449 Org uses timestamps to track when a file has changed. The above functions
12450 normally only publish changed files. You can override this and force
12451 publishing of all files by giving a prefix argument to any of the commands
12452 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
12453 This may be necessary in particular if files include other files via
12454 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
12456 @comment node-name, next, previous, up
12457 @comment Working With Source Code, Miscellaneous, Publishing, Top
12459 @node Working With Source Code, Miscellaneous, Publishing, Top
12460 @chapter Working with source code
12461 @cindex Schulte, Eric
12462 @cindex Davison, Dan
12463 @cindex source code, working with
12465 Source code can be included in Org mode documents using a @samp{src} block,
12469 #+BEGIN_SRC emacs-lisp
12470 (defun org-xor (a b)
12476 Org mode provides a number of features for working with live source code,
12477 including editing of code blocks in their native major-mode, evaluation of
12478 code blocks, converting code blocks into source files (known as @dfn{tangling}
12479 in literate programming), and exporting code blocks and their
12480 results in several formats. This functionality was contributed by Eric
12481 Schulte and Dan Davison, and was originally named Org-babel.
12483 The following sections describe Org mode's code block handling facilities.
12486 * Structure of code blocks:: Code block syntax described
12487 * Editing source code:: Language major-mode editing
12488 * Exporting code blocks:: Export contents and/or results
12489 * Extracting source code:: Create pure source code files
12490 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
12491 * Library of Babel:: Use and contribute to a library of useful code blocks
12492 * Languages:: List of supported code block languages
12493 * Header arguments:: Configure code block functionality
12494 * Results of evaluation:: How evaluation results are handled
12495 * Noweb reference syntax:: Literate programming in Org mode
12496 * Key bindings and useful functions:: Work quickly with code blocks
12497 * Batch execution:: Call functions from the command line
12500 @comment node-name, next, previous, up
12501 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12503 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12504 @section Structure of code blocks
12505 @cindex code block, structure
12506 @cindex source code, block structure
12508 @cindex #+BEGIN_SRC
12510 Live code blocks can be specified with a @samp{src} block or
12511 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
12512 @ref{Easy Templates} system} The structure of a @samp{src} block is
12516 #+BEGIN_SRC <language> <switches> <header arguments>
12521 The @code{#+NAME:} line is optional, and can be used to name the code
12522 block. Live code blocks require that a language be specified on the
12523 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
12524 @cindex source code, inline
12526 Live code blocks can also be specified inline using
12529 src_<language>@{<body>@}
12535 src_<language>[<header arguments>]@{<body>@}
12539 @item <#+NAME: name>
12540 This line associates a name with the code block. This is similar to the
12541 @code{#+TBLNAME: NAME} lines that can be used to name tables in Org mode
12542 files. Referencing the name of a code block makes it possible to evaluate
12543 the block from other places in the file, from other files, or from Org mode
12544 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
12545 and the behavior of Org mode when two or more blocks share the same name is
12549 The language of the code in the block (see @ref{Languages}).
12550 @cindex source code, language
12552 Optional switches control code block export (see the discussion of switches in
12553 @ref{Literal examples})
12554 @cindex source code, switches
12555 @item <header arguments>
12556 Optional header arguments control many aspects of evaluation, export and
12557 tangling of code blocks (see @ref{Header arguments}).
12558 Header arguments can also be set on a per-buffer or per-subtree
12559 basis using properties.
12560 @item source code, header arguments
12562 Source code in the specified language.
12565 @comment node-name, next, previous, up
12566 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12568 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12569 @section Editing source code
12570 @cindex code block, editing
12571 @cindex source code, editing
12574 Use @kbd{C-c '} to edit the current code block. This brings up
12575 a language major-mode edit buffer containing the body of the code
12576 block. Saving this buffer will write the new contents back to the Org
12577 buffer. Use @kbd{C-c '} again to exit.
12579 The @code{org-src-mode} minor mode will be active in the edit buffer. The
12580 following variables can be used to configure the behavior of the edit
12581 buffer. See also the customization group @code{org-edit-structure} for
12582 further configuration options.
12585 @item org-src-lang-modes
12586 If an Emacs major-mode named @code{<lang>-mode} exists, where
12587 @code{<lang>} is the language named in the header line of the code block,
12588 then the edit buffer will be placed in that major-mode. This variable
12589 can be used to map arbitrary language names to existing major modes.
12590 @item org-src-window-setup
12591 Controls the way Emacs windows are rearranged when the edit buffer is created.
12592 @item org-src-preserve-indentation
12593 This variable is especially useful for tangling languages such as
12594 Python, in which whitespace indentation in the output is critical.
12595 @item org-src-ask-before-returning-to-edit-buffer
12596 By default, Org will ask before returning to an open edit buffer. Set this
12597 variable to nil to switch without asking.
12600 To turn on native code fontification in the @emph{Org} buffer, configure the
12601 variable @code{org-src-fontify-natively}.
12603 @comment node-name, next, previous, up
12604 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12606 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12607 @section Exporting code blocks
12608 @cindex code block, exporting
12609 @cindex source code, exporting
12611 It is possible to export the @emph{code} of code blocks, the @emph{results}
12612 of code block evaluation, @emph{both} the code and the results of code block
12613 evaluation, or @emph{none}. For most languages, the default exports code.
12614 However, for some languages (e.g., @code{ditaa}) the default exports the
12615 results of code block evaluation. For information on exporting code block
12616 bodies, see @ref{Literal examples}.
12618 The @code{:exports} header argument can be used to specify export
12621 @subsubheading Header arguments:
12623 @item :exports code
12624 The default in most languages. The body of the code block is exported, as
12625 described in @ref{Literal examples}.
12626 @item :exports results
12627 The code block will be evaluated and the results will be placed in the
12628 Org mode buffer for export, either updating previous results of the code
12629 block located anywhere in the buffer or, if no previous results exist,
12630 placing the results immediately after the code block. The body of the code
12631 block will not be exported.
12632 @item :exports both
12633 Both the code block and its results will be exported.
12634 @item :exports none
12635 Neither the code block nor its results will be exported.
12638 It is possible to inhibit the evaluation of code blocks during export.
12639 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
12640 ensure that no code blocks are evaluated as part of the export process. This
12641 can be useful in situations where potentially untrusted Org mode files are
12642 exported in an automated fashion, for example when Org mode is used as the
12643 markup language for a wiki.
12645 @comment node-name, next, previous, up
12646 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12647 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12648 @section Extracting source code
12650 @cindex source code, extracting
12651 @cindex code block, extracting source code
12653 Creating pure source code files by extracting code from source blocks is
12654 referred to as ``tangling''---a term adopted from the literate programming
12655 community. During ``tangling'' of code blocks their bodies are expanded
12656 using @code{org-babel-expand-src-block} which can expand both variable and
12657 ``noweb'' style references (see @ref{Noweb reference syntax}).
12659 @subsubheading Header arguments
12662 The default. The code block is not included in the tangled output.
12664 Include the code block in the tangled output. The output file name is the
12665 name of the org file with the extension @samp{.org} replaced by the extension
12666 for the block language.
12667 @item :tangle filename
12668 Include the code block in the tangled output to file @samp{filename}.
12672 @subsubheading Functions
12674 @item org-babel-tangle
12675 Tangle the current file. Bound to @kbd{C-c C-v t}.
12677 With prefix argument only tangle the current code block.
12678 @item org-babel-tangle-file
12679 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
12682 @subsubheading Hooks
12684 @item org-babel-post-tangle-hook
12685 This hook is run from within code files tangled by @code{org-babel-tangle}.
12686 Example applications could include post-processing, compilation or evaluation
12687 of tangled code files.
12690 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
12691 @section Evaluating code blocks
12692 @cindex code block, evaluating
12693 @cindex source code, evaluating
12696 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
12697 potential for that code to do harm. Org mode provides safeguards to ensure
12698 that code is only evaluated after explicit confirmation from the user. For
12699 information on these safeguards (and on how to disable them) see @ref{Code
12700 evaluation security}.} and the results of evaluation optionally placed in the
12701 Org mode buffer. The results of evaluation are placed following a line that
12702 begins by default with @code{#+RESULTS} and optionally a cache identifier
12703 and/or the name of the evaluated code block. The default value of
12704 @code{#+RESULTS} can be changed with the customizable variable
12705 @code{org-babel-results-keyword}.
12707 By default, the evaluation facility is only enabled for Lisp code blocks
12708 specified as @code{emacs-lisp}. However, source code blocks in many languages
12709 can be evaluated within Org mode (see @ref{Languages} for a list of supported
12710 languages and @ref{Structure of code blocks} for information on the syntax
12711 used to define a code block).
12714 There are a number of ways to evaluate code blocks. The simplest is to press
12715 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
12716 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
12717 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
12718 @code{org-babel-execute-src-block} function to evaluate the block and insert
12719 its results into the Org mode buffer.
12722 It is also possible to evaluate named code blocks from anywhere in an Org
12723 mode buffer or an Org mode table. Live code blocks located in the current
12724 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
12725 can be executed. Named code blocks can be executed with a separate
12726 @code{#+CALL:} line or inline within a block of text.
12728 The syntax of the @code{#+CALL:} line is
12731 #+CALL: <name>(<arguments>)
12732 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
12735 The syntax for inline evaluation of named code blocks is
12738 ... call_<name>(<arguments>) ...
12739 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
12744 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
12746 Arguments specified in this section will be passed to the code block. These
12747 arguments use standard function call syntax, rather than
12748 header argument syntax. For example, a @code{#+CALL:} line that passes the
12749 number four to a code block named @code{double}, which declares the header
12750 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
12751 @item <inside header arguments>
12752 Inside header arguments are passed through and applied to the named code
12753 block. These arguments use header argument syntax rather than standard
12754 function call syntax. Inside header arguments affect how the code block is
12755 evaluated. For example, @code{[:results output]} will collect the results of
12756 everything printed to @code{STDOUT} during execution of the code block.
12757 @item <end header arguments>
12758 End header arguments are applied to the calling instance and do not affect
12759 evaluation of the named code block. They affect how the results are
12760 incorporated into the Org mode buffer and how the call line is exported. For
12761 example, @code{:results html} will insert the results of the call line
12762 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
12764 For more examples of passing header arguments to @code{#+CALL:} lines see
12765 @ref{Header arguments in function calls}.
12768 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
12769 @section Library of Babel
12770 @cindex babel, library of
12771 @cindex source code, library
12772 @cindex code block, library
12774 The ``Library of Babel'' consists of code blocks that can be called from any
12775 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
12776 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
12777 code blocks} for information on the syntax of remote code block evaluation).
12780 The central repository of code blocks in the ``Library of Babel'' is housed
12781 in an Org mode file located in the @samp{contrib} directory of Org mode.
12783 Users can add code blocks they believe to be generally useful to their
12784 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
12785 then loaded into the library with @code{org-babel-lob-ingest}.
12789 Code blocks located in any Org mode file can be loaded into the ``Library of
12790 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
12793 @node Languages, Header arguments, Library of Babel, Working With Source Code
12795 @cindex babel, languages
12796 @cindex source code, languages
12797 @cindex code block, languages
12799 Code blocks in the following languages are supported.
12801 @multitable @columnfractions 0.28 0.3 0.22 0.2
12802 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
12803 @item Asymptote @tab asymptote @tab Awk @tab awk
12804 @item Emacs Calc @tab calc @tab C @tab C
12805 @item C++ @tab C++ @tab Clojure @tab clojure
12806 @item CSS @tab css @tab ditaa @tab ditaa
12807 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
12808 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
12809 @item Java @tab java @tab @tab
12810 @item Javascript @tab js @tab LaTeX @tab latex
12811 @item Ledger @tab ledger @tab Lisp @tab lisp
12812 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
12813 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
12814 @item Octave @tab octave @tab Org mode @tab org
12815 @item Oz @tab oz @tab Perl @tab perl
12816 @item Plantuml @tab plantuml @tab Python @tab python
12817 @item R @tab R @tab Ruby @tab ruby
12818 @item Sass @tab sass @tab Scheme @tab scheme
12819 @item GNU Screen @tab screen @tab shell @tab sh
12820 @item SQL @tab sql @tab SQLite @tab sqlite
12823 Language-specific documentation is available for some languages. If
12824 available, it can be found at
12825 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
12827 The @code{org-babel-load-languages} controls which languages are enabled for
12828 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
12829 be set using the customization interface or by adding code like the following
12830 to your emacs configuration.
12833 The following disables @code{emacs-lisp} evaluation and enables evaluation of
12834 @code{R} code blocks.
12838 (org-babel-do-load-languages
12839 'org-babel-load-languages
12840 '((emacs-lisp . nil)
12844 It is also possible to enable support for a language by loading the related
12845 elisp file with @code{require}.
12848 The following adds support for evaluating @code{clojure} code blocks.
12852 (require 'ob-clojure)
12855 @node Header arguments, Results of evaluation, Languages, Working With Source Code
12856 @section Header arguments
12857 @cindex code block, header arguments
12858 @cindex source code, block header arguments
12860 Code block functionality can be configured with header arguments. This
12861 section provides an overview of the use of header arguments, and then
12862 describes each header argument in detail.
12865 * Using header arguments:: Different ways to set header arguments
12866 * Specific header arguments:: List of header arguments
12869 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
12870 @subsection Using header arguments
12872 The values of header arguments can be set in six different ways, each more
12873 specific (and having higher priority) than the last.
12875 * System-wide header arguments:: Set global default values
12876 * Language-specific header arguments:: Set default values by language
12877 * Buffer-wide header arguments:: Set default values for a specific buffer
12878 * Header arguments in Org mode properties:: Set default values for a buffer or heading
12879 * Code block specific header arguments:: The most common way to set values
12880 * Header arguments in function calls:: The most specific level
12884 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
12885 @subsubheading System-wide header arguments
12886 @vindex org-babel-default-header-args
12887 System-wide values of header arguments can be specified by customizing the
12888 @code{org-babel-default-header-args} variable:
12892 :results => "replace"
12899 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
12901 @c ((:session . "none")
12902 @c (:results . "replace")
12903 @c (:exports . "code")
12905 @c (:noweb . "no"))
12909 @c Default arguments to use when evaluating a code block.
12912 For example, the following example could be used to set the default value of
12913 @code{:noweb} header arguments to @code{yes}. This would have the effect of
12914 expanding @code{:noweb} references by default when evaluating source code
12918 (setq org-babel-default-header-args
12919 (cons '(:noweb . "yes")
12920 (assq-delete-all :noweb org-babel-default-header-args)))
12923 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
12924 @subsubheading Language-specific header arguments
12925 Each language can define its own set of default header arguments. See the
12926 language-specific documentation available online at
12927 @uref{http://orgmode.org/worg/org-contrib/babel}.
12929 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
12930 @subsubheading Buffer-wide header arguments
12931 Buffer-wide header arguments may be specified as properties through the use
12932 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
12933 @ref{Property syntax}).
12935 For example the following would set @code{session} to @code{*R*}, and
12936 @code{results} to @code{silent} for every code block in the buffer, ensuring
12937 that all execution took place in the same session, and no results would be
12938 inserted into the buffer.
12941 #+PROPERTY: session *R*
12942 #+PROPERTY: results silent
12945 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
12946 @subsubheading Header arguments in Org mode properties
12948 Header arguments are also read from Org mode properties (see @ref{Property
12949 syntax}), which can be set on a buffer-wide or per-heading basis. An example
12950 of setting a header argument for all code blocks in a buffer is
12953 #+PROPERTY: tangle yes
12956 @vindex org-use-property-inheritance
12957 When properties are used to set default header arguments, they are looked up
12958 with inheritance, regardless of the value of
12959 @code{org-use-property-inheritance}. In the following example the value of
12960 the @code{:cache} header argument will default to @code{yes} in all code
12961 blocks in the subtree rooted at the following heading:
12971 @vindex org-babel-default-header-args
12972 Properties defined in this way override the properties set in
12973 @code{org-babel-default-header-args}. It is convenient to use the
12974 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
12975 in Org mode documents.
12977 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
12978 @subsubheading Code block specific header arguments
12980 The most common way to assign values to header arguments is at the
12981 code block level. This can be done by listing a sequence of header
12982 arguments and their values as part of the @code{#+BEGIN_SRC} line.
12983 Properties set in this way override both the values of
12984 @code{org-babel-default-header-args} and header arguments specified as
12985 properties. In the following example, the @code{:results} header argument
12986 is set to @code{silent}, meaning the results of execution will not be
12987 inserted in the buffer, and the @code{:exports} header argument is set to
12988 @code{code}, meaning only the body of the code block will be
12989 preserved on export to HTML or @LaTeX{}.
12993 #+BEGIN_SRC haskell :results silent :exports code :var n=0
12995 fac n = n * fac (n-1)
12998 Similarly, it is possible to set header arguments for inline code blocks
13001 src_haskell[:exports both]@{fac 5@}
13004 Code block header arguments can span multiple lines using @code{#+HEADER:} or
13005 @code{#+HEADERS:} lines preceding a code block or nested between the
13006 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
13010 Multi-line header arguments on an un-named code block:
13013 #+HEADERS: :var data1=1
13014 #+BEGIN_SRC emacs-lisp :var data2=2
13015 (message "data1:%S, data2:%S" data1 data2)
13022 Multi-line header arguments on a named code block:
13025 #+NAME: named-block
13026 #+HEADER: :var data=2
13027 #+BEGIN_SRC emacs-lisp
13028 (message "data:%S" data)
13031 #+RESULTS: named-block
13035 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
13036 @comment node-name, next, previous, up
13037 @subsubheading Header arguments in function calls
13039 At the most specific level, header arguments for ``Library of Babel'' or
13040 @code{#+CALL:} lines can be set as shown in the two examples below. For more
13041 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
13044 The following will apply the @code{:exports results} header argument to the
13045 evaluation of the @code{#+CALL:} line.
13048 #+CALL: factorial(n=5) :exports results
13051 The following will apply the @code{:session special} header argument to the
13052 evaluation of the @code{factorial} code block.
13055 #+CALL: factorial[:session special](n=5)
13058 @node Specific header arguments, , Using header arguments, Header arguments
13059 @subsection Specific header arguments
13060 Header arguments consist of an initial colon followed by the name of the
13061 argument in lowercase letters. The following header arguments are defined:
13064 * var:: Pass arguments to code blocks
13065 * results:: Specify the type of results and how they will
13066 be collected and handled
13067 * file:: Specify a path for file output
13068 * file-desc:: Specify a description for file results
13069 * dir:: Specify the default (possibly remote)
13070 directory for code block execution
13071 * exports:: Export code and/or results
13072 * tangle:: Toggle tangling and specify file name
13073 * mkdirp:: Toggle creation of parent directories of target
13074 files during tangling
13075 * comments:: Toggle insertion of comments in tangled
13077 * padline:: Control insertion of padding lines in tangled
13079 * no-expand:: Turn off variable assignment and noweb
13080 expansion during tangling
13081 * session:: Preserve the state of code evaluation
13082 * noweb:: Toggle expansion of noweb references
13083 * noweb-ref:: Specify block's noweb reference resolution target
13084 * noweb-sep:: String used to separate noweb references
13085 * cache:: Avoid re-evaluating unchanged code blocks
13086 * sep:: Delimiter for writing tabular results outside Org
13087 * hlines:: Handle horizontal lines in tables
13088 * colnames:: Handle column names in tables
13089 * rownames:: Handle row names in tables
13090 * shebang:: Make tangled files executable
13091 * eval:: Limit evaluation of specific code blocks
13092 * wrap:: Mark source block evaluation results
13095 Additional header arguments are defined on a language-specific basis, see
13098 @node var, results, Specific header arguments, Specific header arguments
13099 @subsubsection @code{:var}
13100 The @code{:var} header argument is used to pass arguments to code blocks.
13101 The specifics of how arguments are included in a code block vary by language;
13102 these are addressed in the language-specific documentation. However, the
13103 syntax used to specify arguments is the same across all languages. In every
13104 case, variables require a default value when they are declared.
13106 The values passed to arguments can either be literal values, references, or
13107 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
13108 include anything in the Org mode file that takes a @code{#+NAME:},
13109 @code{#+TBLNAME:}, or @code{#+RESULTS:} line. This includes tables, lists,
13110 @code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
13113 Argument values can be indexed in a manner similar to arrays (see @ref{var,
13114 Indexable variable values}).
13116 The following syntax is used to pass arguments to code blocks using the
13117 @code{:var} header argument.
13123 The argument, @code{assign}, can either be a literal value, such as a string
13124 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
13125 literal example, another code block (with or without arguments), or the
13126 results of evaluating another code block.
13128 Here are examples of passing values by reference:
13133 an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
13136 #+TBLNAME: example-table
13142 #+NAME: table-length
13143 #+BEGIN_SRC emacs-lisp :var table=example-table
13147 #+RESULTS: table-length
13152 a simple list named with a @code{#+NAME:} line (note that nesting is not
13153 carried through to the source code block)
13156 #+NAME: example-list
13162 #+BEGIN_SRC emacs-lisp :var x=example-list
13170 @item code block without arguments
13171 a code block name (from the example above), as assigned by @code{#+NAME:},
13172 optionally followed by parentheses
13175 #+BEGIN_SRC emacs-lisp :var length=table-length()
13183 @item code block with arguments
13184 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
13185 optional arguments passed within the parentheses following the
13186 code block name using standard function call syntax
13190 #+BEGIN_SRC emacs-lisp :var input=8
13198 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
13206 @item literal example
13207 a literal example block named with a @code{#+NAME:} line
13210 #+NAME: literal-example
13216 #+NAME: read-literal-example
13217 #+BEGIN_SRC emacs-lisp :var x=literal-example
13218 (concatenate 'string x " for you.")
13221 #+RESULTS: read-literal-example
13222 : A literal example
13223 : on two lines for you.
13229 @subsubheading Alternate argument syntax
13230 It is also possible to specify arguments in a potentially more natural way
13231 using the @code{#+NAME:} line of a code block. As in the following
13232 example, arguments can be packed inside of parentheses, separated by commas,
13233 following the source name.
13236 #+NAME: double(input=0, x=2)
13237 #+BEGIN_SRC emacs-lisp
13242 @subsubheading Indexable variable values
13243 It is possible to reference portions of variable values by ``indexing'' into
13244 the variables. Indexes are 0 based with negative values counting back from
13245 the end. If an index is separated by @code{,}s then each subsequent section
13246 will index into the next deepest nesting or dimension of the value. Note
13247 that this indexing occurs @emph{before} other table related header arguments
13248 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
13249 following example assigns the last cell of the first row the table
13250 @code{example-table} to the variable @code{data}:
13253 #+NAME: example-table
13259 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
13267 Ranges of variable values can be referenced using two integers separated by a
13268 @code{:}, in which case the entire inclusive range is referenced. For
13269 example the following assigns the middle three rows of @code{example-table}
13273 #+NAME: example-table
13280 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
13290 Additionally, an empty index, or the single character @code{*}, are both
13291 interpreted to mean the entire range and as such are equivalent to
13292 @code{0:-1}, as shown in the following example in which the entire first
13293 column is referenced.
13296 #+NAME: example-table
13302 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
13310 It is possible to index into the results of code blocks as well as tables.
13311 Any number of dimensions can be indexed. Dimensions are separated from one
13312 another by commas, as shown in the following example.
13316 #+BEGIN_SRC emacs-lisp
13317 '(((1 2 3) (4 5 6) (7 8 9))
13318 ((10 11 12) (13 14 15) (16 17 18))
13319 ((19 20 21) (22 23 24) (25 26 27)))
13322 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
13330 @subsubheading Emacs Lisp evaluation of variables
13332 Emacs lisp code can be used to initialize variable values. When a variable
13333 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
13334 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
13335 the variable value. The following example demonstrates use of this
13336 evaluation to reliably pass the file-name of the Org mode buffer to a code
13337 block---note that evaluation of header arguments is guaranteed to take place
13338 in the original Org mode file, while there is no such guarantee for
13339 evaluation of the code block body.
13342 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
13347 Note that values read from tables and lists will not be evaluated as
13348 Emacs Lisp, as shown in the following example.
13354 #+HEADERS: :var data=table[0,0]
13363 @node results, file, var, Specific header arguments
13364 @subsubsection @code{:results}
13366 There are three classes of @code{:results} header argument. Only one option
13367 per class may be supplied per code block.
13371 @b{collection} header arguments specify how the results should be collected
13372 from the code block
13374 @b{type} header arguments specify what type of result the code block will
13375 return---which has implications for how they will be inserted into the
13378 @b{handling} header arguments specify how the results of evaluating the code
13379 block should be handled.
13382 @subsubheading Collection
13383 The following options are mutually exclusive, and specify how the results
13384 should be collected from the code block.
13388 This is the default. The result is the value of the last statement in the
13389 code block. This header argument places the evaluation in functional
13390 mode. Note that in some languages, e.g., Python, use of this result type
13391 requires that a @code{return} statement be included in the body of the source
13392 code block. E.g., @code{:results value}.
13393 @item @code{output}
13394 The result is the collection of everything printed to STDOUT during the
13395 execution of the code block. This header argument places the
13396 evaluation in scripting mode. E.g., @code{:results output}.
13399 @subsubheading Type
13401 The following options are mutually exclusive and specify what type of results
13402 the code block will return. By default, results are inserted as either a
13403 table or scalar depending on their value.
13406 @item @code{table}, @code{vector}
13407 The results should be interpreted as an Org mode table. If a single value is
13408 returned, it will be converted into a table with one row and one column.
13409 E.g., @code{:results value table}.
13411 The results should be interpreted as an Org mode list. If a single scalar
13412 value is returned it will be converted into a list with only one element.
13413 @item @code{scalar}, @code{verbatim}
13414 The results should be interpreted literally---they will not be
13415 converted into a table. The results will be inserted into the Org mode
13416 buffer as quoted text. E.g., @code{:results value verbatim}.
13418 The results will be interpreted as the path to a file, and will be inserted
13419 into the Org mode buffer as a file link. E.g., @code{:results value file}.
13421 The results are interpreted as raw Org mode code and are inserted directly
13422 into the buffer. If the results look like a table they will be aligned as
13423 such by Org mode. E.g., @code{:results value raw}.
13425 The results are will be enclosed in a @code{BEGIN_SRC org} block.
13426 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
13427 in the block and/or if you export the file. E.g., @code{:results value org}.
13429 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
13430 block. E.g., @code{:results value html}.
13432 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
13433 E.g., @code{:results value latex}.
13435 Result are assumed to be parsable code and are enclosed in a code block.
13436 E.g., @code{:results value code}.
13438 The result is converted to pretty-printed code and is enclosed in a code
13439 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
13440 @code{:results value pp}.
13441 @item @code{drawer}
13442 The result is wrapped in a RESULTS drawer. This can be useful for
13443 inserting @code{raw} or @code{org} syntax results in such a way that their
13444 extent is known and they can be automatically removed or replaced.
13447 @subsubheading Handling
13448 The following results options indicate what happens with the
13449 results once they are collected.
13452 @item @code{silent}
13453 The results will be echoed in the minibuffer but will not be inserted into
13454 the Org mode buffer. E.g., @code{:results output silent}.
13455 @item @code{replace}
13456 The default value. Any existing results will be removed, and the new results
13457 will be inserted into the Org mode buffer in their place. E.g.,
13458 @code{:results output replace}.
13459 @item @code{append}
13460 If there are pre-existing results of the code block then the new results will
13461 be appended to the existing results. Otherwise the new results will be
13462 inserted as with @code{replace}.
13463 @item @code{prepend}
13464 If there are pre-existing results of the code block then the new results will
13465 be prepended to the existing results. Otherwise the new results will be
13466 inserted as with @code{replace}.
13469 @node file, file-desc, results, Specific header arguments
13470 @subsubsection @code{:file}
13472 The header argument @code{:file} is used to specify an external file in which
13473 to save code block results. After code block evaluation an Org mode style
13474 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
13475 into the Org mode buffer. Some languages including R, gnuplot, dot, and
13476 ditaa provide special handling of the @code{:file} header argument
13477 automatically wrapping the code block body in the boilerplate code required
13478 to save output to the specified file. This is often useful for saving
13479 graphical output of a code block to the specified file.
13481 The argument to @code{:file} should be either a string specifying the path to
13482 a file, or a list of two strings in which case the first element of the list
13483 should be the path to a file and the second a description for the link.
13485 @node file-desc, dir, file, Specific header arguments
13486 @subsubsection @code{:file-desc}
13488 The value of the @code{:file-desc} header argument is used to provide a
13489 description for file code block results which are inserted as Org mode links
13490 (see @ref{Link format}). If the @code{:file-desc} header argument is given
13491 with no value the link path will be placed in both the ``link'' and the
13492 ``description'' portion of the Org mode link.
13494 @node dir, exports, file-desc, Specific header arguments
13495 @subsubsection @code{:dir} and remote execution
13497 While the @code{:file} header argument can be used to specify the path to the
13498 output file, @code{:dir} specifies the default directory during code block
13499 execution. If it is absent, then the directory associated with the current
13500 buffer is used. In other words, supplying @code{:dir path} temporarily has
13501 the same effect as changing the current directory with @kbd{M-x cd path}, and
13502 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
13503 the value of the Emacs variable @code{default-directory}.
13505 When using @code{:dir}, you should supply a relative path for file output
13506 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
13507 case that path will be interpreted relative to the default directory.
13509 In other words, if you want your plot to go into a folder called @file{Work}
13510 in your home directory, you could use
13513 #+BEGIN_SRC R :file myplot.png :dir ~/Work
13514 matplot(matrix(rnorm(100), 10), type="l")
13518 @subsubheading Remote execution
13519 A directory on a remote machine can be specified using tramp file syntax, in
13520 which case the code will be evaluated on the remote machine. An example is
13523 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
13524 plot(1:10, main=system("hostname", intern=TRUE))
13528 Text results will be returned to the local Org mode buffer as usual, and file
13529 output will be created on the remote machine with relative paths interpreted
13530 relative to the remote directory. An Org mode link to the remote file will be
13533 So, in the above example a plot will be created on the remote machine,
13534 and a link of the following form will be inserted in the org buffer:
13537 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
13540 Most of this functionality follows immediately from the fact that @code{:dir}
13541 sets the value of the Emacs variable @code{default-directory}, thanks to
13542 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
13543 install tramp separately in order for these features to work correctly.
13545 @subsubheading Further points
13549 If @code{:dir} is used in conjunction with @code{:session}, although it will
13550 determine the starting directory for a new session as expected, no attempt is
13551 currently made to alter the directory associated with an existing session.
13553 @code{:dir} should typically not be used to create files during export with
13554 @code{:exports results} or @code{:exports both}. The reason is that, in order
13555 to retain portability of exported material between machines, during export
13556 links inserted into the buffer will @emph{not} be expanded against @code{default
13557 directory}. Therefore, if @code{default-directory} is altered using
13558 @code{:dir}, it is probable that the file will be created in a location to
13559 which the link does not point.
13562 @node exports, tangle, dir, Specific header arguments
13563 @subsubsection @code{:exports}
13565 The @code{:exports} header argument specifies what should be included in HTML
13566 or @LaTeX{} exports of the Org mode file.
13570 The default. The body of code is included into the exported file. E.g.,
13571 @code{:exports code}.
13572 @item @code{results}
13573 The result of evaluating the code is included in the exported file. E.g.,
13574 @code{:exports results}.
13576 Both the code and results are included in the exported file. E.g.,
13577 @code{:exports both}.
13579 Nothing is included in the exported file. E.g., @code{:exports none}.
13582 @node tangle, mkdirp, exports, Specific header arguments
13583 @subsubsection @code{:tangle}
13585 The @code{:tangle} header argument specifies whether or not the code
13586 block should be included in tangled extraction of source code files.
13589 @item @code{tangle}
13590 The code block is exported to a source code file named after the full path
13591 (including the directory) and file name (w/o extension) of the Org mode file.
13592 E.g., @code{:tangle yes}.
13594 The default. The code block is not exported to a source code file.
13595 E.g., @code{:tangle no}.
13597 Any other string passed to the @code{:tangle} header argument is interpreted
13598 as a path (directory and file name relative to the directory of the Org mode
13599 file) to which the block will be exported. E.g., @code{:tangle path}.
13602 @node mkdirp, comments, tangle, Specific header arguments
13603 @subsubsection @code{:mkdirp}
13605 The @code{:mkdirp} header argument can be used to create parent directories
13606 of tangled files when missing. This can be set to @code{yes} to enable
13607 directory creation or to @code{no} to inhibit directory creation.
13609 @node comments, padline, mkdirp, Specific header arguments
13610 @subsubsection @code{:comments}
13611 By default code blocks are tangled to source-code files without any insertion
13612 of comments beyond those which may already exist in the body of the code
13613 block. The @code{:comments} header argument can be set as follows to control
13614 the insertion of extra comments into the tangled code file.
13618 The default. No extra comments are inserted during tangling.
13620 The code block is wrapped in comments which contain pointers back to the
13621 original Org file from which the code was tangled.
13623 A synonym for ``link'' to maintain backwards compatibility.
13625 Include text from the Org mode file as a comment.
13627 The text is picked from the leading context of the tangled code and is
13628 limited by the nearest headline or source block as the case may be.
13630 Turns on both the ``link'' and ``org'' comment options.
13632 Turns on the ``link'' comment option, and additionally wraps expanded noweb
13633 references in the code block body in link comments.
13636 @node padline, no-expand, comments, Specific header arguments
13637 @subsubsection @code{:padline}
13638 Control in insertion of padding lines around code block bodies in tangled
13639 code files. The default value is @code{yes} which results in insertion of
13640 newlines before and after each tangled code block. The following arguments
13645 Insert newlines before and after each code block body in tangled code files.
13647 Do not insert any newline padding in tangled output.
13650 @node no-expand, session, padline, Specific header arguments
13651 @subsubsection @code{:no-expand}
13653 By default, code blocks are expanded with @code{org-babel-expand-src-block}
13654 during tangling. This has the effect of assigning values to variables
13655 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
13656 references (see @ref{Noweb reference syntax}) with their targets. The
13657 @code{:no-expand} header argument can be used to turn off this behavior.
13659 @node session, noweb, no-expand, Specific header arguments
13660 @subsubsection @code{:session}
13662 The @code{:session} header argument starts a session for an interpreted
13663 language where state is preserved.
13665 By default, a session is not started.
13667 A string passed to the @code{:session} header argument will give the session
13668 a name. This makes it possible to run concurrent sessions for each
13669 interpreted language.
13671 @node noweb, noweb-ref, session, Specific header arguments
13672 @subsubsection @code{:noweb}
13674 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
13675 references (see @ref{Noweb reference syntax}) when the code block is
13676 evaluated, tangled, or exported. The @code{:noweb} header argument can have
13677 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
13678 @code{no-export} @code{strip-export}.
13682 The default. ``Noweb'' syntax references in the body of the code block will
13683 not be expanded before the code block is evaluated, tangled or exported.
13685 ``Noweb'' syntax references in the body of the code block will be
13686 expanded before the code block is evaluated, tangled or exported.
13687 @item @code{tangle}
13688 ``Noweb'' syntax references in the body of the code block will be expanded
13689 before the code block is tangled. However, ``noweb'' syntax references will
13690 not be expanded when the code block is evaluated or exported.
13691 @item @code{no-export}
13692 ``Noweb'' syntax references in the body of the code block will be expanded
13693 before the block is evaluated or tangled. However, ``noweb'' syntax
13694 references will not be expanded when the code block is exported.
13695 @item @code{strip-export}
13696 ``Noweb'' syntax references in the body of the code block will be expanded
13697 before the block is evaluated or tangled. However, ``noweb'' syntax
13698 references will not be removed when the code block is exported.
13700 ``Noweb'' syntax references in the body of the code block will only be
13701 expanded before the block is evaluated.
13704 @subsubheading Noweb prefix lines
13705 Noweb insertions are now placed behind the line prefix of the
13706 @code{<<reference>>}.
13707 This behavior is illustrated in the following example. Because the
13708 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
13709 each line of the expanded noweb reference will be commented.
13721 -- multi-line body of example
13724 Note that noweb replacement text that does not contain any newlines will not
13725 be affected by this change, so it is still possible to use inline noweb
13728 @node noweb-ref, noweb-sep, noweb, Specific header arguments
13729 @subsubsection @code{:noweb-ref}
13730 When expanding ``noweb'' style references the bodies of all code block with
13731 @emph{either} a block name matching the reference name @emph{or} a
13732 @code{:noweb-ref} header argument matching the reference name will be
13733 concatenated together to form the replacement text.
13735 By setting this header argument at the sub-tree or file level, simple code
13736 block concatenation may be achieved. For example, when tangling the
13737 following Org mode file, the bodies of code blocks will be concatenated into
13738 the resulting pure code file@footnote{(The example needs property inheritance
13739 to be turned on for the @code{noweb-ref} property, see @ref{Property
13743 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
13746 * the mount point of the fullest disk
13748 :noweb-ref: fullest-disk
13751 ** query all mounted disks
13756 ** strip the header row
13761 ** sort by the percent full
13763 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
13766 ** extract the mount point
13768 |awk '@{print $2@}'
13772 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
13773 used to separate accumulate noweb references like those above. By default a
13776 @node noweb-sep, cache, noweb-ref, Specific header arguments
13777 @subsubsection @code{:noweb-sep}
13779 The @code{:noweb-sep} header argument holds the string used to separate
13780 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
13783 @node cache, sep, noweb-sep, Specific header arguments
13784 @subsubsection @code{:cache}
13786 The @code{:cache} header argument controls the use of in-buffer caching of
13787 the results of evaluating code blocks. It can be used to avoid re-evaluating
13788 unchanged code blocks. Note that the @code{:cache} header argument will not
13789 attempt to cache results when the @code{:session} header argument is used,
13790 because the results of the code block execution may be stored in the session
13791 outside of the Org mode buffer. The @code{:cache} header argument can have
13792 one of two values: @code{yes} or @code{no}.
13796 The default. No caching takes place, and the code block will be evaluated
13797 every time it is called.
13799 Every time the code block is run a SHA1 hash of the code and arguments
13800 passed to the block will be generated. This hash is packed into the
13801 @code{#+RESULTS:} line and will be checked on subsequent
13802 executions of the code block. If the code block has not
13803 changed since the last time it was evaluated, it will not be re-evaluated.
13806 Code block caches notice if the value of a variable argument
13807 to the code block has changed. If this is the case, the cache is
13808 invalidated and the code block is re-run. In the following example,
13809 @code{caller} will not be re-run unless the results of @code{random} have
13810 changed since it was last run.
13814 #+BEGIN_SRC R :cache yes
13818 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
13822 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
13826 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
13830 @node sep, hlines, cache, Specific header arguments
13831 @subsubsection @code{:sep}
13833 The @code{:sep} header argument can be used to control the delimiter used
13834 when writing tabular results out to files external to Org mode. This is used
13835 either when opening tabular results of a code block by calling the
13836 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
13837 or when writing code block results to an external file (see @ref{file})
13840 By default, when @code{:sep} is not specified output tables are tab
13843 @node hlines, colnames, sep, Specific header arguments
13844 @subsubsection @code{:hlines}
13846 Tables are frequently represented with one or more horizontal lines, or
13847 hlines. The @code{:hlines} argument to a code block accepts the
13848 values @code{yes} or @code{no}, with a default value of @code{no}.
13852 Strips horizontal lines from the input table. In most languages this is the
13853 desired effect because an @code{hline} symbol is interpreted as an unbound
13854 variable and raises an error. Setting @code{:hlines no} or relying on the
13855 default value yields the following results. Note that the @code{:hline}
13856 header argument has no effect for Emacs Lisp code blocks.
13859 #+TBLNAME: many-cols
13867 #+BEGIN_SRC python :var tab=many-cols
13871 #+RESULTS: echo-table
13878 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
13881 #+TBLNAME: many-cols
13889 #+BEGIN_SRC python :var tab=many-cols :hlines yes
13893 #+RESULTS: echo-table
13902 @node colnames, rownames, hlines, Specific header arguments
13903 @subsubsection @code{:colnames}
13905 The @code{:colnames} header argument accepts the values @code{yes},
13906 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
13907 Note that the behavior of the @code{:colnames} header argument may differ
13908 across languages. For example Emacs Lisp code blocks ignore the
13909 @code{:colnames} header argument entirely given the ease with which tables
13910 with column names may be handled directly in Emacs Lisp.
13914 If an input table looks like it has column names
13915 (because its second row is an hline), then the column
13916 names will be removed from the table before
13917 processing, then reapplied to the results.
13920 #+TBLNAME: less-cols
13926 #+NAME: echo-table-again
13927 #+BEGIN_SRC python :var tab=less-cols
13928 return [[val + '*' for val in row] for row in tab]
13931 #+RESULTS: echo-table-again
13938 Please note that column names are not removed before the table is indexed
13939 using variable indexing @xref{var, Indexable variable values}.
13942 No column name pre-processing takes place
13945 Column names are removed and reapplied as with @code{nil} even if the table
13946 does not ``look like'' it has column names (i.e., the second row is not an
13950 @node rownames, shebang, colnames, Specific header arguments
13951 @subsubsection @code{:rownames}
13953 The @code{:rownames} header argument can take on the values @code{yes} or
13954 @code{no}, with a default value of @code{no}. Note that Emacs Lisp code
13955 blocks ignore the @code{:rownames} header argument entirely given the ease
13956 with which tables with row names may be handled directly in Emacs Lisp.
13960 No row name pre-processing will take place.
13963 The first column of the table is removed from the table before processing,
13964 and is then reapplied to the results.
13967 #+TBLNAME: with-rownames
13968 | one | 1 | 2 | 3 | 4 | 5 |
13969 | two | 6 | 7 | 8 | 9 | 10 |
13971 #+NAME: echo-table-once-again
13972 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
13973 return [[val + 10 for val in row] for row in tab]
13976 #+RESULTS: echo-table-once-again
13977 | one | 11 | 12 | 13 | 14 | 15 |
13978 | two | 16 | 17 | 18 | 19 | 20 |
13981 Please note that row names are not removed before the table is indexed using
13982 variable indexing @xref{var, Indexable variable values}.
13986 @node shebang, eval, rownames, Specific header arguments
13987 @subsubsection @code{:shebang}
13989 Setting the @code{:shebang} header argument to a string value
13990 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
13991 first line of any tangled file holding the code block, and the file
13992 permissions of the tangled file are set to make it executable.
13994 @node eval, wrap, shebang, Specific header arguments
13995 @subsubsection @code{:eval}
13996 The @code{:eval} header argument can be used to limit the evaluation of
13997 specific code blocks. The @code{:eval} header argument can be useful for
13998 protecting against the evaluation of dangerous code blocks or to ensure that
13999 evaluation will require a query regardless of the value of the
14000 @code{org-confirm-babel-evaluate} variable. The possible values of
14001 @code{:eval} and their effects are shown below.
14005 The code block will not be evaluated under any circumstances.
14007 Evaluation of the code block will require a query.
14008 @item never-export or no-export
14009 The code block will not be evaluated during export but may still be called
14012 Evaluation of the code block during export will require a query.
14015 If this header argument is not set then evaluation is determined by the value
14016 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
14019 @node wrap, , eval, Specific header arguments
14020 @subsubsection @code{:wrap}
14021 The @code{:wrap} header argument is used to mark the results of source block
14022 evaluation. The header argument can be passed a string that will be appended
14023 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
14024 results. If not string is specified then the results will be wrapped in a
14025 @code{#+BEGIN/END_RESULTS} block.
14027 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
14028 @section Results of evaluation
14029 @cindex code block, results of evaluation
14030 @cindex source code, results of evaluation
14032 The way in which results are handled depends on whether a session is invoked,
14033 as well as on whether @code{:results value} or @code{:results output} is
14034 used. The following table shows the table possibilities. For a full listing
14035 of the possible results header arguments see @ref{results}.
14037 @multitable @columnfractions 0.26 0.33 0.41
14038 @item @tab @b{Non-session} @tab @b{Session}
14039 @item @code{:results value} @tab value of last expression @tab value of last expression
14040 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
14043 Note: With @code{:results value}, the result in both @code{:session} and
14044 non-session is returned to Org mode as a table (a one- or two-dimensional
14045 vector of strings or numbers) when appropriate.
14047 @subsection Non-session
14048 @subsubsection @code{:results value}
14049 This is the default. Internally, the value is obtained by wrapping the code
14050 in a function definition in the external language, and evaluating that
14051 function. Therefore, code should be written as if it were the body of such a
14052 function. In particular, note that Python does not automatically return a
14053 value from a function unless a @code{return} statement is present, and so a
14054 @samp{return} statement will usually be required in Python.
14056 This is the only one of the four evaluation contexts in which the code is
14057 automatically wrapped in a function definition.
14059 @subsubsection @code{:results output}
14060 The code is passed to the interpreter as an external process, and the
14061 contents of the standard output stream are returned as text. (In certain
14062 languages this also contains the error output stream; this is an area for
14065 @subsection Session
14066 @subsubsection @code{:results value}
14067 The code is passed to an interpreter running as an interactive Emacs inferior
14068 process. Only languages which provide tools for interactive evaluation of
14069 code have session support, so some language (e.g., C and ditaa) do not
14070 support the @code{:session} header argument, and in other languages (e.g.,
14071 Python and Haskell) which have limitations on the code which may be entered
14072 into interactive sessions, those limitations apply to the code in code blocks
14073 using the @code{:session} header argument as well.
14075 Unless the @code{:results output} option is supplied (see below) the result
14076 returned is the result of the last evaluation performed by the
14077 interpreter. (This is obtained in a language-specific manner: the value of
14078 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
14081 @subsubsection @code{:results output}
14082 The code is passed to the interpreter running as an interactive Emacs
14083 inferior process. The result returned is the concatenation of the sequence of
14084 (text) output from the interactive interpreter. Notice that this is not
14085 necessarily the same as what would be sent to @code{STDOUT} if the same code
14086 were passed to a non-interactive interpreter running as an external
14087 process. For example, compare the following two blocks:
14090 #+BEGIN_SRC python :results output
14101 In non-session mode, the `2' is not printed and does not appear.
14104 #+BEGIN_SRC python :results output :session
14116 But in @code{:session} mode, the interactive interpreter receives input `2'
14117 and prints out its value, `2'. (Indeed, the other print statements are
14120 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
14121 @section Noweb reference syntax
14122 @cindex code block, noweb reference
14123 @cindex syntax, noweb
14124 @cindex source code, noweb reference
14126 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
14127 Programming system allows named blocks of code to be referenced by using the
14128 familiar Noweb syntax:
14131 <<code-block-name>>
14134 When a code block is tangled or evaluated, whether or not ``noweb''
14135 references are expanded depends upon the value of the @code{:noweb} header
14136 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
14137 evaluation. If @code{:noweb no}, the default, then the reference is not
14138 expanded before evaluation. See the @ref{noweb-ref} header argument for
14139 a more flexible way to resolve noweb references.
14141 It is possible to include the @emph{results} of a code block rather than the
14142 body. This is done by appending parenthesis to the code block name which may
14143 optionally contain arguments to the code block as shown below.
14146 <<code-block-name(optional arguments)>>
14149 Note: the default value, @code{:noweb no}, was chosen to ensure that
14150 correct code is not broken in a language, such as Ruby, where
14151 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
14152 syntactically valid in languages that you use, then please consider setting
14155 Note: if noweb tangling is slow in large Org mode files consider setting the
14156 @code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
14157 This will result in faster noweb reference resolution at the expense of not
14158 correctly resolving inherited values of the @code{:noweb-ref} header
14161 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
14162 @section Key bindings and useful functions
14163 @cindex code block, key bindings
14165 Many common Org mode key sequences are re-bound depending on
14168 Within a code block, the following key bindings
14171 @multitable @columnfractions 0.25 0.75
14173 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
14175 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
14177 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
14179 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
14182 In an Org mode buffer, the following key bindings are active:
14184 @multitable @columnfractions 0.45 0.55
14186 @kindex C-c C-v C-p
14187 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
14189 @kindex C-c C-v C-n
14190 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
14192 @kindex C-c C-v C-e
14193 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
14195 @kindex C-c C-v C-o
14196 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
14198 @kindex C-c C-v C-v
14199 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
14201 @kindex C-c C-v C-u
14202 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
14204 @kindex C-c C-v C-g
14205 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
14207 @kindex C-c C-v C-r
14208 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
14210 @kindex C-c C-v C-b
14211 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14213 @kindex C-c C-v C-s
14214 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14216 @kindex C-c C-v C-d
14217 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
14219 @kindex C-c C-v C-t
14220 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14222 @kindex C-c C-v C-f
14223 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14225 @kindex C-c C-v C-c
14226 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
14228 @kindex C-c C-v C-j
14229 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
14231 @kindex C-c C-v C-l
14232 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
14234 @kindex C-c C-v C-i
14235 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
14237 @kindex C-c C-v C-I
14238 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
14240 @kindex C-c C-v C-z
14241 @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}
14243 @kindex C-c C-v C-a
14244 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14246 @kindex C-c C-v C-h
14247 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
14249 @kindex C-c C-v C-x
14250 @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}
14253 @c When possible these keybindings were extended to work when the control key is
14254 @c kept pressed, resulting in the following additional keybindings.
14256 @c @multitable @columnfractions 0.25 0.75
14257 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14258 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14259 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14260 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14261 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14262 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14263 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14264 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14267 @node Batch execution, , Key bindings and useful functions, Working With Source Code
14268 @section Batch execution
14269 @cindex code block, batch execution
14270 @cindex source code, batch execution
14272 It is possible to call functions from the command line. This shell
14273 script calls @code{org-babel-tangle} on every one of its arguments.
14275 Be sure to adjust the paths to fit your system.
14279 # -*- mode: shell-script -*-
14281 # tangle files with org-mode
14286 # wrap each argument in the code required to call tangle on it
14288 FILES="$FILES \"$i\""
14293 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
14294 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
14295 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
14296 (mapc (lambda (file)
14297 (find-file (expand-file-name file \"$DIR\"))
14299 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
14302 @node Miscellaneous, Hacking, Working With Source Code, Top
14303 @chapter Miscellaneous
14306 * Completion:: M-TAB knows what you need
14307 * Easy Templates:: Quick insertion of structural elements
14308 * Speed keys:: Electric commands at the beginning of a headline
14309 * Code evaluation security:: Org mode files evaluate inline code
14310 * Customization:: Adapting Org to your taste
14311 * In-buffer settings:: Overview of the #+KEYWORDS
14312 * The very busy C-c C-c key:: When in doubt, press C-c C-c
14313 * Clean view:: Getting rid of leading stars in the outline
14314 * TTY keys:: Using Org on a tty
14315 * Interaction:: Other Emacs packages
14316 * org-crypt.el:: Encrypting Org files
14320 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
14321 @section Completion
14322 @cindex completion, of @TeX{} symbols
14323 @cindex completion, of TODO keywords
14324 @cindex completion, of dictionary words
14325 @cindex completion, of option keywords
14326 @cindex completion, of tags
14327 @cindex completion, of property keys
14328 @cindex completion, of link abbreviations
14329 @cindex @TeX{} symbol completion
14330 @cindex TODO keywords completion
14331 @cindex dictionary word completion
14332 @cindex option keyword completion
14333 @cindex tag completion
14334 @cindex link abbreviations, completion of
14336 Emacs would not be Emacs without completion, and Org mode uses it whenever it
14337 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
14338 some of the completion prompts, you can specify your preference by setting at
14339 most one of the variables @code{org-completion-use-iswitchb}
14340 @code{org-completion-use-ido}.
14342 Org supports in-buffer completion. This type of completion does
14343 not make use of the minibuffer. You simply type a few letters into
14344 the buffer and use the key to complete text right there.
14347 @kindex M-@key{TAB}
14349 Complete word at point
14352 At the beginning of a headline, complete TODO keywords.
14354 After @samp{\}, complete @TeX{} symbols supported by the exporter.
14356 After @samp{*}, complete headlines in the current buffer so that they
14357 can be used in search links like @samp{[[*find this headline]]}.
14359 After @samp{:} in a headline, complete tags. The list of tags is taken
14360 from the variable @code{org-tag-alist} (possibly set through the
14361 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
14362 dynamically from all tags used in the current buffer.
14364 After @samp{:} and not in a headline, complete property keys. The list
14365 of keys is constructed dynamically from all keys used in the current
14368 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
14370 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
14371 @samp{OPTIONS} which set file-specific options for Org mode. When the
14372 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
14373 will insert example settings for this keyword.
14375 In the line after @samp{#+STARTUP: }, complete startup keywords,
14376 i.e., valid keys for this line.
14378 Elsewhere, complete dictionary words using Ispell.
14382 @node Easy Templates, Speed keys, Completion, Miscellaneous
14383 @section Easy Templates
14384 @cindex template insertion
14385 @cindex insertion, of templates
14387 Org mode supports insertion of empty structural elements (like
14388 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
14389 strokes. This is achieved through a native template expansion mechanism.
14390 Note that Emacs has several other template mechanisms which could be used in
14391 a similar way, for example @file{yasnippet}.
14393 To insert a structural element, type a @samp{<}, followed by a template
14394 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
14395 keystrokes are typed on a line by itself.
14397 The following template selectors are currently supported.
14399 @multitable @columnfractions 0.1 0.9
14400 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
14401 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
14402 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
14403 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
14404 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
14405 @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
14406 @item @kbd{L} @tab @code{#+LaTeX:}
14407 @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
14408 @item @kbd{H} @tab @code{#+HTML:}
14409 @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
14410 @item @kbd{A} @tab @code{#+ASCII:}
14411 @item @kbd{i} @tab @code{#+INDEX:} line
14412 @item @kbd{I} @tab @code{#+INCLUDE:} line
14415 For example, on an empty line, typing "<e" and then pressing TAB, will expand
14416 into a complete EXAMPLE template.
14418 You can install additional templates by customizing the variable
14419 @code{org-structure-template-alist}. See the docstring of the variable for
14420 additional details.
14422 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
14423 @section Speed keys
14425 @vindex org-use-speed-commands
14426 @vindex org-speed-commands-user
14428 Single keys can be made to execute commands when the cursor is at the
14429 beginning of a headline, i.e., before the first star. Configure the variable
14430 @code{org-use-speed-commands} to activate this feature. There is a
14431 pre-defined list of commands, and you can add more such commands using the
14432 variable @code{org-speed-commands-user}. Speed keys do not only speed up
14433 navigation and other commands, but they also provide an alternative way to
14434 execute commands bound to keys that are not or not easily available on a TTY,
14435 or on a small mobile device with a limited keyboard.
14437 To see which commands are available, activate the feature and press @kbd{?}
14438 with the cursor at the beginning of a headline.
14440 @node Code evaluation security, Customization, Speed keys, Miscellaneous
14441 @section Code evaluation and security issues
14443 Org provides tools to work with the code snippets, including evaluating them.
14445 Running code on your machine always comes with a security risk. Badly
14446 written or malicious code can be executed on purpose or by accident. Org has
14447 default settings which will only evaluate such code if you give explicit
14448 permission to do so, and as a casual user of these features you should leave
14449 these precautions intact.
14451 For people who regularly work with such code, the confirmation prompts can
14452 become annoying, and you might want to turn them off. This can be done, but
14453 you must be aware of the risks that are involved.
14455 Code evaluation can happen under the following circumstances:
14458 @item Source code blocks
14459 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
14460 C-c} in the block. The most important thing to realize here is that Org mode
14461 files which contain code snippets are, in a certain sense, like executable
14462 files. So you should accept them and load them into Emacs only from trusted
14463 sources---just like you would do with a program you install on your computer.
14465 Make sure you know what you are doing before customizing the variables
14466 which take off the default security brakes.
14468 @defopt org-confirm-babel-evaluate
14469 When t (the default), the user is asked before every code block evaluation.
14470 When nil, the user is not asked. When set to a function, it is called with
14471 two arguments (language and body of the code block) and should return t to
14472 ask and nil not to ask.
14475 For example, here is how to execute "ditaa" code (which is considered safe)
14479 (defun my-org-confirm-babel-evaluate (lang body)
14480 (not (string= lang "ditaa"))) ; don't ask for ditaa
14481 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
14484 @item Following @code{shell} and @code{elisp} links
14485 Org has two link types that can directly evaluate code (@pxref{External
14486 links}). These links can be problematic because the code to be evaluated is
14489 @defopt org-confirm-shell-link-function
14490 Function to queries user about shell link execution.
14492 @defopt org-confirm-elisp-link-function
14493 Functions to query user for Emacs Lisp link execution.
14496 @item Formulas in tables
14497 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
14498 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
14501 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
14502 @section Customization
14503 @cindex customization
14504 @cindex options, for customization
14505 @cindex variables, for customization
14507 There are more than 500 variables that can be used to customize
14508 Org. For the sake of compactness of the manual, I am not
14509 describing the variables here. A structured overview of customization
14510 variables is available with @kbd{M-x org-customize}. Or select
14511 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
14512 settings can also be activated on a per-file basis, by putting special
14513 lines into the buffer (@pxref{In-buffer settings}).
14515 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
14516 @section Summary of in-buffer settings
14517 @cindex in-buffer settings
14518 @cindex special keywords
14520 Org mode uses special lines in the buffer to define settings on a
14521 per-file basis. These lines start with a @samp{#+} followed by a
14522 keyword, a colon, and then individual words defining a setting. Several
14523 setting words can be in the same line, but you can also have multiple
14524 lines for the keyword. While these settings are described throughout
14525 the manual, here is a summary. After changing any of those lines in the
14526 buffer, press @kbd{C-c C-c} with the cursor still in the line to
14527 activate the changes immediately. Otherwise they become effective only
14528 when the file is visited again in a new Emacs session.
14530 @vindex org-archive-location
14532 @item #+ARCHIVE: %s_done::
14533 This line sets the archive location for the agenda file. It applies for
14534 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
14535 of the file. The first such line also applies to any entries before it.
14536 The corresponding variable is @code{org-archive-location}.
14538 This line sets the category for the agenda file. The category applies
14539 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
14540 end of the file. The first such line also applies to any entries before it.
14541 @item #+COLUMNS: %25ITEM .....
14542 @cindex property, COLUMNS
14543 Set the default format for columns view. This format applies when
14544 columns view is invoked in locations where no @code{COLUMNS} property
14546 @item #+CONSTANTS: name1=value1 ...
14547 @vindex org-table-formula-constants
14548 @vindex org-table-formula
14549 Set file-local values for constants to be used in table formulas. This
14550 line sets the local variable @code{org-table-formula-constants-local}.
14551 The global version of this variable is
14552 @code{org-table-formula-constants}.
14553 @item #+FILETAGS: :tag1:tag2:tag3:
14554 Set tags that can be inherited by any entry in the file, including the
14556 @item #+DRAWERS: NAME1 .....
14557 @vindex org-drawers
14558 Set the file-local set of additional drawers. The corresponding global
14559 variable is @code{org-drawers}.
14560 @item #+LINK: linkword replace
14561 @vindex org-link-abbrev-alist
14562 These lines (several are allowed) specify link abbreviations.
14563 @xref{Link abbreviations}. The corresponding variable is
14564 @code{org-link-abbrev-alist}.
14565 @item #+PRIORITIES: highest lowest default
14566 @vindex org-highest-priority
14567 @vindex org-lowest-priority
14568 @vindex org-default-priority
14569 This line sets the limits and the default for the priorities. All three
14570 must be either letters A--Z or numbers 0--9. The highest priority must
14571 have a lower ASCII number than the lowest priority.
14572 @item #+PROPERTY: Property_Name Value
14573 This line sets a default inheritance value for entries in the current
14574 buffer, most useful for specifying the allowed values of a property.
14575 @cindex #+SETUPFILE
14576 @item #+SETUPFILE: file
14577 This line defines a file that holds more in-buffer setup. Normally this is
14578 entirely ignored. Only when the buffer is parsed for option-setting lines
14579 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
14580 settings line, or when exporting), then the contents of this file are parsed
14581 as if they had been included in the buffer. In particular, the file can be
14582 any other Org mode file with internal setup. You can visit the file the
14583 cursor is in the line with @kbd{C-c '}.
14586 This line sets options to be used at startup of Org mode, when an
14587 Org file is being visited.
14589 The first set of options deals with the initial visibility of the outline
14590 tree. The corresponding variable for global default settings is
14591 @code{org-startup-folded}, with a default value @code{t}, which means
14593 @vindex org-startup-folded
14594 @cindex @code{overview}, STARTUP keyword
14595 @cindex @code{content}, STARTUP keyword
14596 @cindex @code{showall}, STARTUP keyword
14597 @cindex @code{showeverything}, STARTUP keyword
14599 overview @r{top-level headlines only}
14600 content @r{all headlines}
14601 showall @r{no folding of any entries}
14602 showeverything @r{show even drawer contents}
14605 @vindex org-startup-indented
14606 @cindex @code{indent}, STARTUP keyword
14607 @cindex @code{noindent}, STARTUP keyword
14608 Dynamic virtual indentation is controlled by the variable
14609 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
14611 indent @r{start with @code{org-indent-mode} turned on}
14612 noindent @r{start with @code{org-indent-mode} turned off}
14615 @vindex org-startup-align-all-tables
14616 Then there are options for aligning tables upon visiting a file. This
14617 is useful in files containing narrowed table columns. The corresponding
14618 variable is @code{org-startup-align-all-tables}, with a default value
14620 @cindex @code{align}, STARTUP keyword
14621 @cindex @code{noalign}, STARTUP keyword
14623 align @r{align all tables}
14624 noalign @r{don't align tables on startup}
14627 @vindex org-startup-with-inline-images
14628 When visiting a file, inline images can be automatically displayed. The
14629 corresponding variable is @code{org-startup-with-inline-images}, with a
14630 default value @code{nil} to avoid delays when visiting a file.
14631 @cindex @code{inlineimages}, STARTUP keyword
14632 @cindex @code{noinlineimages}, STARTUP keyword
14634 inlineimages @r{show inline images}
14635 noinlineimages @r{don't show inline images on startup}
14638 @vindex org-startup-with-latex-preview
14639 When visiting a file, @LaTeX{} fragments can be converted to images
14640 automatically. The variable @code{org-startup-with-latex-preview} which
14641 controls this behavior, is set to @code{nil} by default to avoid delays on
14643 @cindex @code{latexpreview}, STARTUP keyword
14644 @cindex @code{nolatexpreview}, STARTUP keyword
14646 latexpreview @r{preview @LaTeX{} fragments}
14647 nolatexpreview @r{don't preview @LaTeX{} fragments}
14650 @vindex org-log-done
14651 @vindex org-log-note-clock-out
14652 @vindex org-log-repeat
14653 Logging the closing and reopening of TODO items and clock intervals can be
14654 configured using these options (see variables @code{org-log-done},
14655 @code{org-log-note-clock-out} and @code{org-log-repeat})
14656 @cindex @code{logdone}, STARTUP keyword
14657 @cindex @code{lognotedone}, STARTUP keyword
14658 @cindex @code{nologdone}, STARTUP keyword
14659 @cindex @code{lognoteclock-out}, STARTUP keyword
14660 @cindex @code{nolognoteclock-out}, STARTUP keyword
14661 @cindex @code{logrepeat}, STARTUP keyword
14662 @cindex @code{lognoterepeat}, STARTUP keyword
14663 @cindex @code{nologrepeat}, STARTUP keyword
14664 @cindex @code{logreschedule}, STARTUP keyword
14665 @cindex @code{lognotereschedule}, STARTUP keyword
14666 @cindex @code{nologreschedule}, STARTUP keyword
14667 @cindex @code{logredeadline}, STARTUP keyword
14668 @cindex @code{lognoteredeadline}, STARTUP keyword
14669 @cindex @code{nologredeadline}, STARTUP keyword
14670 @cindex @code{logrefile}, STARTUP keyword
14671 @cindex @code{lognoterefile}, STARTUP keyword
14672 @cindex @code{nologrefile}, STARTUP keyword
14673 @cindex @code{logdrawer}, STARTUP keyword
14674 @cindex @code{nologdrawer}, STARTUP keyword
14675 @cindex @code{logstatesreversed}, STARTUP keyword
14676 @cindex @code{nologstatesreversed}, STARTUP keyword
14678 logdone @r{record a timestamp when an item is marked DONE}
14679 lognotedone @r{record timestamp and a note when DONE}
14680 nologdone @r{don't record when items are marked DONE}
14681 logrepeat @r{record a time when reinstating a repeating item}
14682 lognoterepeat @r{record a note when reinstating a repeating item}
14683 nologrepeat @r{do not record when reinstating repeating item}
14684 lognoteclock-out @r{record a note when clocking out}
14685 nolognoteclock-out @r{don't record a note when clocking out}
14686 logreschedule @r{record a timestamp when scheduling time changes}
14687 lognotereschedule @r{record a note when scheduling time changes}
14688 nologreschedule @r{do not record when a scheduling date changes}
14689 logredeadline @r{record a timestamp when deadline changes}
14690 lognoteredeadline @r{record a note when deadline changes}
14691 nologredeadline @r{do not record when a deadline date changes}
14692 logrefile @r{record a timestamp when refiling}
14693 lognoterefile @r{record a note when refiling}
14694 nologrefile @r{do not record when refiling}
14695 logdrawer @r{store log into drawer}
14696 nologdrawer @r{store log outside of drawer}
14697 logstatesreversed @r{reverse the order of states notes}
14698 nologstatesreversed @r{do not reverse the order of states notes}
14701 @vindex org-hide-leading-stars
14702 @vindex org-odd-levels-only
14703 Here are the options for hiding leading stars in outline headings, and for
14704 indenting outlines. The corresponding variables are
14705 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
14706 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
14707 @cindex @code{hidestars}, STARTUP keyword
14708 @cindex @code{showstars}, STARTUP keyword
14709 @cindex @code{odd}, STARTUP keyword
14710 @cindex @code{even}, STARTUP keyword
14712 hidestars @r{make all but one of the stars starting a headline invisible.}
14713 showstars @r{show all stars starting a headline}
14714 indent @r{virtual indentation according to outline level}
14715 noindent @r{no virtual indentation according to outline level}
14716 odd @r{allow only odd outline levels (1,3,...)}
14717 oddeven @r{allow all outline levels}
14720 @vindex org-put-time-stamp-overlays
14721 @vindex org-time-stamp-overlay-formats
14722 To turn on custom format overlays over timestamps (variables
14723 @code{org-put-time-stamp-overlays} and
14724 @code{org-time-stamp-overlay-formats}), use
14725 @cindex @code{customtime}, STARTUP keyword
14727 customtime @r{overlay custom time format}
14730 @vindex constants-unit-system
14731 The following options influence the table spreadsheet (variable
14732 @code{constants-unit-system}).
14733 @cindex @code{constcgs}, STARTUP keyword
14734 @cindex @code{constSI}, STARTUP keyword
14736 constcgs @r{@file{constants.el} should use the c-g-s unit system}
14737 constSI @r{@file{constants.el} should use the SI unit system}
14740 @vindex org-footnote-define-inline
14741 @vindex org-footnote-auto-label
14742 @vindex org-footnote-auto-adjust
14743 To influence footnote settings, use the following keywords. The
14744 corresponding variables are @code{org-footnote-define-inline},
14745 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
14746 @cindex @code{fninline}, STARTUP keyword
14747 @cindex @code{nofninline}, STARTUP keyword
14748 @cindex @code{fnlocal}, STARTUP keyword
14749 @cindex @code{fnprompt}, STARTUP keyword
14750 @cindex @code{fnauto}, STARTUP keyword
14751 @cindex @code{fnconfirm}, STARTUP keyword
14752 @cindex @code{fnplain}, STARTUP keyword
14753 @cindex @code{fnadjust}, STARTUP keyword
14754 @cindex @code{nofnadjust}, STARTUP keyword
14756 fninline @r{define footnotes inline}
14757 fnnoinline @r{define footnotes in separate section}
14758 fnlocal @r{define footnotes near first reference, but not inline}
14759 fnprompt @r{prompt for footnote labels}
14760 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
14761 fnconfirm @r{offer automatic label for editing or confirmation}
14762 fnplain @r{create @code{[1]}-like labels automatically}
14763 fnadjust @r{automatically renumber and sort footnotes}
14764 nofnadjust @r{do not renumber and sort automatically}
14767 @cindex org-hide-block-startup
14768 To hide blocks on startup, use these keywords. The corresponding variable is
14769 @code{org-hide-block-startup}.
14770 @cindex @code{hideblocks}, STARTUP keyword
14771 @cindex @code{nohideblocks}, STARTUP keyword
14773 hideblocks @r{Hide all begin/end blocks on startup}
14774 nohideblocks @r{Do not hide blocks on startup}
14777 @cindex org-pretty-entities
14778 The display of entities as UTF-8 characters is governed by the variable
14779 @code{org-pretty-entities} and the keywords
14780 @cindex @code{entitiespretty}, STARTUP keyword
14781 @cindex @code{entitiesplain}, STARTUP keyword
14783 entitiespretty @r{Show entities as UTF-8 characters where possible}
14784 entitiesplain @r{Leave entities plain}
14787 @item #+TAGS: TAG1(c1) TAG2(c2)
14788 @vindex org-tag-alist
14789 These lines (several such lines are allowed) specify the valid tags in
14790 this file, and (potentially) the corresponding @emph{fast tag selection}
14791 keys. The corresponding variable is @code{org-tag-alist}.
14793 This line contains the formulas for the table directly above the line.
14794 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
14795 @itemx #+OPTIONS:, #+BIND:,
14796 @itemx #+DESCRIPTION:, #+KEYWORDS:,
14797 @itemx #+LaTeX_HEADER:, #+HTML_STYLE:, #+HTML_LINK_UP:, #+HTML_LINK_HOME:,
14798 @itemx #+SELECT_TAGS:, #+EXCLUDE_TAGS:
14799 These lines provide settings for exporting files. For more details see
14800 @ref{Export options}.
14801 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
14802 @vindex org-todo-keywords
14803 These lines set the TODO keywords and their interpretation in the
14804 current file. The corresponding variable is @code{org-todo-keywords}.
14807 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
14808 @section The very busy C-c C-c key
14810 @cindex C-c C-c, overview
14812 The key @kbd{C-c C-c} has many purposes in Org, which are all
14813 mentioned scattered throughout this manual. One specific function of
14814 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
14815 other circumstances it means something like @emph{``Hey Org, look
14816 here and update according to what you see here''}. Here is a summary of
14817 what this means in different contexts.
14821 If there are highlights in the buffer from the creation of a sparse
14822 tree, or from clock display, remove these highlights.
14824 If the cursor is in one of the special @code{#+KEYWORD} lines, this
14825 triggers scanning the buffer for these lines and updating the
14828 If the cursor is inside a table, realign the table. This command
14829 works even if the automatic table editor has been turned off.
14831 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
14834 If the current buffer is a capture buffer, close the note and file it.
14835 With a prefix argument, file it, without further interaction, to the
14838 If the cursor is on a @code{<<<target>>>}, update radio targets and
14839 corresponding links in this buffer.
14841 If the cursor is in a property line or at the start or end of a property
14842 drawer, offer property commands.
14844 If the cursor is at a footnote reference, go to the corresponding
14845 definition, and vice versa.
14847 If the cursor is on a statistics cookie, update it.
14849 If the cursor is in a plain list item with a checkbox, toggle the status
14852 If the cursor is on a numbered item in a plain list, renumber the
14855 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
14858 If the cursor is at a timestamp, fix the day name in the timestamp.
14861 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
14862 @section A cleaner outline view
14863 @cindex hiding leading stars
14864 @cindex dynamic indentation
14865 @cindex odd-levels-only outlines
14866 @cindex clean outline view
14868 Some people find it noisy and distracting that the Org headlines start with a
14869 potentially large number of stars, and that text below the headlines is not
14870 indented. While this is no problem when writing a @emph{book-like} document
14871 where the outline headings are really section headings, in a more
14872 @emph{list-oriented} outline, indented structure is a lot cleaner:
14876 * Top level headline | * Top level headline
14877 ** Second level | * Second level
14878 *** 3rd level | * 3rd level
14879 some text | some text
14880 *** 3rd level | * 3rd level
14881 more text | more text
14882 * Another top level headline | * Another top level headline
14888 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
14889 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
14890 be achieved dynamically at display time using @code{org-indent-mode}. In
14891 this minor mode, all lines are prefixed for display with the necessary amount
14892 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
14893 property, such that @code{visual-line-mode} (or purely setting
14894 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
14895 }. Also headlines are prefixed with additional stars, so that the amount of
14896 indentation shifts by two@footnote{See the variable
14897 @code{org-indent-indentation-per-level}.} spaces per level. All headline
14898 stars but the last one are made invisible using the @code{org-hide}
14899 face@footnote{Turning on @code{org-indent-mode} sets
14900 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
14901 @code{nil}.}; see below under @samp{2.} for more information on how this
14902 works. You can turn on @code{org-indent-mode} for all files by customizing
14903 the variable @code{org-startup-indented}, or you can turn it on for
14904 individual files using
14910 If you want a similar effect in an earlier version of Emacs and/or Org, or if
14911 you want the indentation to be hard space characters so that the plain text
14912 file looks as similar as possible to the Emacs display, Org supports you in
14917 @emph{Indentation of text below headlines}@*
14918 You may indent text below each headline to make the left boundary line up
14919 with the headline, like
14923 more text, now indented
14926 @vindex org-adapt-indentation
14927 Org supports this with paragraph filling, line wrapping, and structure
14928 editing@footnote{See also the variable @code{org-adapt-indentation}.},
14929 preserving or adapting the indentation as appropriate.
14932 @vindex org-hide-leading-stars
14933 @emph{Hiding leading stars}@* You can modify the display in such a way that
14934 all leading stars become invisible. To do this in a global way, configure
14935 the variable @code{org-hide-leading-stars} or change this on a per-file basis
14939 #+STARTUP: hidestars
14940 #+STARTUP: showstars
14943 With hidden stars, the tree becomes:
14947 * Top level headline
14955 @vindex org-hide @r{(face)}
14956 The leading stars are not truly replaced by whitespace, they are only
14957 fontified with the face @code{org-hide} that uses the background color as
14958 font color. If you are not using either white or black background, you may
14959 have to customize this face to get the wanted effect. Another possibility is
14960 to set this font such that the extra stars are @i{almost} invisible, for
14961 example using the color @code{grey90} on a white background.
14964 @vindex org-odd-levels-only
14965 Things become cleaner still if you skip all the even levels and use only odd
14966 levels 1, 3, 5..., effectively adding two stars to go from one outline level
14967 to the next@footnote{When you need to specify a level for a property search
14968 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
14969 way we get the outline view shown at the beginning of this section. In order
14970 to make the structure editing and export commands handle this convention
14971 correctly, configure the variable @code{org-odd-levels-only}, or set this on
14972 a per-file basis with one of the following lines:
14979 You can convert an Org file from single-star-per-level to the
14980 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
14981 RET} in that file. The reverse operation is @kbd{M-x
14982 org-convert-to-oddeven-levels}.
14985 @node TTY keys, Interaction, Clean view, Miscellaneous
14986 @section Using Org on a tty
14987 @cindex tty key bindings
14989 Because Org contains a large number of commands, by default many of
14990 Org's core commands are bound to keys that are generally not
14991 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
14992 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
14993 together with modifiers like @key{Meta} and/or @key{Shift}. To access
14994 these commands on a tty when special keys are unavailable, the following
14995 alternative bindings can be used. The tty bindings below will likely be
14996 more cumbersome; you may find for some of the bindings below that a
14997 customized workaround suits you better. For example, changing a timestamp
14998 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
14999 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
15001 @multitable @columnfractions 0.15 0.2 0.1 0.2
15002 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
15003 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
15004 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
15005 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
15006 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
15007 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
15008 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
15009 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
15010 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
15011 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
15012 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
15013 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
15014 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
15015 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
15016 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
15017 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
15018 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
15019 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
15020 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
15024 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
15025 @section Interaction with other packages
15026 @cindex packages, interaction with other
15027 Org lives in the world of GNU Emacs and interacts in various ways
15028 with other code out there.
15031 * Cooperation:: Packages Org cooperates with
15032 * Conflicts:: Packages that lead to conflicts
15035 @node Cooperation, Conflicts, Interaction, Interaction
15036 @subsection Packages that Org cooperates with
15039 @cindex @file{calc.el}
15040 @cindex Gillespie, Dave
15041 @item @file{calc.el} by Dave Gillespie
15042 Org uses the Calc package for implementing spreadsheet
15043 functionality in its tables (@pxref{The spreadsheet}). Org
15044 checks for the availability of Calc by looking for the function
15045 @code{calc-eval} which will have been autoloaded during setup if Calc has
15046 been installed properly. As of Emacs 22, Calc is part of the Emacs
15047 distribution. Another possibility for interaction between the two
15048 packages is using Calc for embedded calculations. @xref{Embedded Mode,
15049 , Embedded Mode, calc, GNU Emacs Calc Manual}.
15050 @item @file{constants.el} by Carsten Dominik
15051 @cindex @file{constants.el}
15052 @cindex Dominik, Carsten
15053 @vindex org-table-formula-constants
15054 In a table formula (@pxref{The spreadsheet}), it is possible to use
15055 names for natural constants or units. Instead of defining your own
15056 constants in the variable @code{org-table-formula-constants}, install
15057 the @file{constants} package which defines a large number of constants
15058 and units, and lets you use unit prefixes like @samp{M} for
15059 @samp{Mega}, etc. You will need version 2.0 of this package, available
15060 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
15061 the function @code{constants-get}, which has to be autoloaded in your
15062 setup. See the installation instructions in the file
15063 @file{constants.el}.
15064 @item @file{cdlatex.el} by Carsten Dominik
15065 @cindex @file{cdlatex.el}
15066 @cindex Dominik, Carsten
15067 Org mode can make use of the CD@LaTeX{} package to efficiently enter
15068 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
15069 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
15070 @cindex @file{imenu.el}
15071 Imenu allows menu access to an index of items in a file. Org mode
15072 supports Imenu---all you need to do to get the index is the following:
15074 (add-hook 'org-mode-hook
15075 (lambda () (imenu-add-to-menubar "Imenu")))
15077 @vindex org-imenu-depth
15078 By default the index is two levels deep---you can modify the depth using
15079 the option @code{org-imenu-depth}.
15080 @item @file{remember.el} by John Wiegley
15081 @cindex @file{remember.el}
15082 @cindex Wiegley, John
15083 Org used to use this package for capture, but no longer does.
15084 @item @file{speedbar.el} by Eric M. Ludlam
15085 @cindex @file{speedbar.el}
15086 @cindex Ludlam, Eric M.
15087 Speedbar is a package that creates a special frame displaying files and
15088 index items in files. Org mode supports Speedbar and allows you to
15089 drill into Org files directly from the Speedbar. It also allows you to
15090 restrict the scope of agenda commands to a file or a subtree by using
15091 the command @kbd{<} in the Speedbar frame.
15092 @cindex @file{table.el}
15093 @item @file{table.el} by Takaaki Ota
15095 @cindex table editor, @file{table.el}
15096 @cindex @file{table.el}
15097 @cindex Ota, Takaaki
15099 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
15100 and alignment can be created using the Emacs table package by Takaaki Ota
15101 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
15102 Org mode will recognize these tables and export them properly. Because of
15103 interference with other Org mode functionality, you unfortunately cannot edit
15104 these tables directly in the buffer. Instead, you need to use the command
15105 @kbd{C-c '} to edit them, similar to source code snippets.
15108 @orgcmd{C-c ',org-edit-special}
15109 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
15111 @orgcmd{C-c ~,org-table-create-with-table.el}
15112 Insert a @file{table.el} table. If there is already a table at point, this
15113 command converts it between the @file{table.el} format and the Org mode
15114 format. See the documentation string of the command
15115 @code{org-convert-table} for the restrictions under which this is
15118 @file{table.el} is part of Emacs since Emacs 22.
15119 @item @file{footnote.el} by Steven L. Baur
15120 @cindex @file{footnote.el}
15121 @cindex Baur, Steven L.
15122 Org mode recognizes numerical footnotes as provided by this package.
15123 However, Org mode also has its own footnote support (@pxref{Footnotes}),
15124 which makes using @file{footnote.el} unnecessary.
15127 @node Conflicts, , Cooperation, Interaction
15128 @subsection Packages that lead to conflicts with Org mode
15132 @cindex @code{shift-selection-mode}
15133 @vindex org-support-shift-select
15134 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
15135 cursor motions combined with the shift key should start or enlarge regions.
15136 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
15137 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
15138 at such a location. By default, @kbd{S-@key{cursor}} commands outside
15139 special contexts don't do anything, but you can customize the variable
15140 @code{org-support-shift-select}. Org mode then tries to accommodate shift
15141 selection by (i) using it outside of the special contexts where special
15142 commands apply, and by (ii) extending an existing active region even if the
15143 cursor moves across a special context.
15145 @item @file{CUA.el} by Kim. F. Storm
15146 @cindex @file{CUA.el}
15147 @cindex Storm, Kim. F.
15148 @vindex org-replace-disputed-keys
15149 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
15150 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
15151 region. In fact, Emacs 23 has this built-in in the form of
15152 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
15153 23, you probably don't want to use another package for this purpose. However,
15154 if you prefer to leave these keys to a different package while working in
15155 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
15156 Org will move the following key bindings in Org files, and in the agenda
15157 buffer (but not during date selection).
15160 S-UP @result{} M-p S-DOWN @result{} M-n
15161 S-LEFT @result{} M-- S-RIGHT @result{} M-+
15162 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
15165 @vindex org-disputed-keys
15166 Yes, these are unfortunately more difficult to remember. If you want
15167 to have other replacement keys, look at the variable
15168 @code{org-disputed-keys}.
15170 @item @file{filladapt.el} by Kyle Jones
15171 @cindex @file{filladapt.el}
15173 Org mode tries to do the right thing when filling paragraphs, list items and
15174 other elements. Many users reported they had problems using both
15175 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
15179 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
15182 @item @file{yasnippet.el}
15183 @cindex @file{yasnippet.el}
15184 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
15185 @code{"\t"}) overrules YASnippet's access to this key. The following code
15186 fixed this problem:
15189 (add-hook 'org-mode-hook
15191 (org-set-local 'yas/trigger-key [tab])
15192 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
15195 The latest version of yasnippet doesn't play well with Org mode. If the
15196 above code does not fix the conflict, start by defining the following
15200 (defun yas/org-very-safe-expand ()
15201 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
15204 Then, tell Org mode what to do with the new function:
15207 (add-hook 'org-mode-hook
15209 (make-variable-buffer-local 'yas/trigger-key)
15210 (setq yas/trigger-key [tab])
15211 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
15212 (define-key yas/keymap [tab] 'yas/next-field)))
15215 @item @file{windmove.el} by Hovav Shacham
15216 @cindex @file{windmove.el}
15217 This package also uses the @kbd{S-<cursor>} keys, so everything written
15218 in the paragraph above about CUA mode also applies here. If you want make
15219 the windmove function active in locations where Org mode does not have
15220 special functionality on @kbd{S-@key{cursor}}, add this to your
15224 ;; Make windmove work in org-mode:
15225 (add-hook 'org-shiftup-final-hook 'windmove-up)
15226 (add-hook 'org-shiftleft-final-hook 'windmove-left)
15227 (add-hook 'org-shiftdown-final-hook 'windmove-down)
15228 (add-hook 'org-shiftright-final-hook 'windmove-right)
15231 @item @file{viper.el} by Michael Kifer
15232 @cindex @file{viper.el}
15234 Viper uses @kbd{C-c /} and therefore makes this key not access the
15235 corresponding Org mode command @code{org-sparse-tree}. You need to find
15236 another key for this command, or override the key in
15237 @code{viper-vi-global-user-map} with
15240 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
15245 @node org-crypt.el, , Interaction, Miscellaneous
15246 @section org-crypt.el
15247 @cindex @file{org-crypt.el}
15248 @cindex @code{org-decrypt-entry}
15250 Org-crypt will encrypt the text of an entry, but not the headline, or
15251 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
15254 Any text below a headline that has a @samp{:crypt:} tag will be automatically
15255 be encrypted when the file is saved. If you want to use a different tag just
15256 customize the @code{org-crypt-tag-matcher} setting.
15258 To use org-crypt it is suggested that you have the following in your
15262 (require 'org-crypt)
15263 (org-crypt-use-before-save-magic)
15264 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
15266 (setq org-crypt-key nil)
15267 ;; GPG key to use for encryption
15268 ;; Either the Key ID or set to nil to use symmetric encryption.
15270 (setq auto-save-default nil)
15271 ;; Auto-saving does not cooperate with org-crypt.el: so you need
15272 ;; to turn it off if you plan to use org-crypt.el quite often.
15273 ;; Otherwise, you'll get an (annoying) message each time you
15276 ;; To turn it off only locally, you can insert this:
15278 ;; # -*- buffer-auto-save-file-name: nil; -*-
15281 Excluding the crypt tag from inheritance prevents already encrypted text
15282 being encrypted again.
15284 @node Hacking, MobileOrg, Miscellaneous, Top
15288 This appendix covers some aspects where users can extend the functionality of
15292 * Hooks:: How to reach into Org's internals
15293 * Add-on packages:: Available extensions
15294 * Adding hyperlink types:: New custom link types
15295 * Context-sensitive commands:: How to add functionality to such commands
15296 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
15297 * Dynamic blocks:: Automatically filled blocks
15298 * Special agenda views:: Customized views
15299 * Extracting agenda information:: Postprocessing of agenda information
15300 * Using the property API:: Writing programs that use entry properties
15301 * Using the mapping API:: Mapping over all or selected entries
15304 @node Hooks, Add-on packages, Hacking, Hacking
15308 Org has a large number of hook variables that can be used to add
15309 functionality. This appendix about hacking is going to illustrate the
15310 use of some of them. A complete list of all hooks with documentation is
15311 maintained by the Worg project and can be found at
15312 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
15314 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
15315 @section Add-on packages
15316 @cindex add-on packages
15318 A large number of add-on packages have been written by various authors.
15319 These packages are not part of Emacs, but they are distributed as contributed
15320 packages with the separate release available at the Org mode home page at
15321 @uref{http://orgmode.org}. The list of contributed packages, along with
15322 documentation about each package, is maintained by the Worg project at
15323 @uref{http://orgmode.org/worg/org-contrib/}.
15327 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
15328 @section Adding hyperlink types
15329 @cindex hyperlinks, adding new types
15331 Org has a large number of hyperlink types built-in
15332 (@pxref{Hyperlinks}). If you would like to add new link types, Org
15333 provides an interface for doing so. Let's look at an example file,
15334 @file{org-man.el}, that will add support for creating links like
15335 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
15339 ;;; org-man.el - Support for links to manpages in Org
15343 (org-add-link-type "man" 'org-man-open)
15344 (add-hook 'org-store-link-functions 'org-man-store-link)
15346 (defcustom org-man-command 'man
15347 "The Emacs command to be used to display a man page."
15349 :type '(choice (const man) (const woman)))
15351 (defun org-man-open (path)
15352 "Visit the manpage on PATH.
15353 PATH should be a topic that can be thrown at the man command."
15354 (funcall org-man-command path))
15356 (defun org-man-store-link ()
15357 "Store a link to a manpage."
15358 (when (memq major-mode '(Man-mode woman-mode))
15359 ;; This is a man page, we do make this link
15360 (let* ((page (org-man-get-page-name))
15361 (link (concat "man:" page))
15362 (description (format "Manpage for %s" page)))
15363 (org-store-link-props
15366 :description description))))
15368 (defun org-man-get-page-name ()
15369 "Extract the page name from the buffer name."
15370 ;; This works for both `Man-mode' and `woman-mode'.
15371 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
15372 (match-string 1 (buffer-name))
15373 (error "Cannot create link to this man page")))
15377 ;;; org-man.el ends here
15381 You would activate this new link type in @file{.emacs} with
15388 Let's go through the file and see what it does.
15391 It does @code{(require 'org)} to make sure that @file{org.el} has been
15394 The next line calls @code{org-add-link-type} to define a new link type
15395 with prefix @samp{man}. The call also contains the name of a function
15396 that will be called to follow such a link.
15398 @vindex org-store-link-functions
15399 The next line adds a function to @code{org-store-link-functions}, in
15400 order to allow the command @kbd{C-c l} to record a useful link in a
15401 buffer displaying a man page.
15404 The rest of the file defines the necessary variables and functions.
15405 First there is a customization variable that determines which Emacs
15406 command should be used to display man pages. There are two options,
15407 @code{man} and @code{woman}. Then the function to follow a link is
15408 defined. It gets the link path as an argument---in this case the link
15409 path is just a topic for the manual command. The function calls the
15410 value of @code{org-man-command} to display the man page.
15412 Finally the function @code{org-man-store-link} is defined. When you try
15413 to store a link with @kbd{C-c l}, this function will be called to
15414 try to make a link. The function must first decide if it is supposed to
15415 create the link for this buffer type; we do this by checking the value
15416 of the variable @code{major-mode}. If not, the function must exit and
15417 return the value @code{nil}. If yes, the link is created by getting the
15418 manual topic from the buffer name and prefixing it with the string
15419 @samp{man:}. Then it must call the command @code{org-store-link-props}
15420 and set the @code{:type} and @code{:link} properties. Optionally you
15421 can also set the @code{:description} property to provide a default for
15422 the link description when the link is later inserted into an Org
15423 buffer with @kbd{C-c C-l}.
15425 When it makes sense for your new link type, you may also define a function
15426 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
15427 support for inserting such a link with @kbd{C-c C-l}. Such a function should
15428 not accept any arguments, and return the full link with prefix.
15430 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
15431 @section Context-sensitive commands
15432 @cindex context-sensitive commands, hooks
15433 @cindex add-ons, context-sensitive commands
15434 @vindex org-ctrl-c-ctrl-c-hook
15436 Org has several commands that act differently depending on context. The most
15437 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
15438 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
15440 Add-ons can tap into this functionality by providing a function that detects
15441 special context for that add-on and executes functionality appropriate for
15442 the context. Here is an example from Dan Davison's @file{org-R.el} which
15443 allows you to evaluate commands based on the @file{R} programming language
15444 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
15445 described in @ref{Working With Source Code} and is now obsolete.}. For this
15446 package, special contexts are lines that start with @code{#+R:} or
15450 (defun org-R-apply-maybe ()
15451 "Detect if this is context for org-R and execute R commands."
15452 (if (save-excursion
15453 (beginning-of-line 1)
15454 (looking-at "#\\+RR?:"))
15455 (progn (call-interactively 'org-R-apply)
15456 t) ;; to signal that we took action
15457 nil)) ;; to signal that we did not
15459 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
15462 The function first checks if the cursor is in such a line. If that is the
15463 case, @code{org-R-apply} is called and the function returns @code{t} to
15464 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
15465 contexts. If the function finds it should do nothing locally, it returns
15466 @code{nil} so that other, similar functions can have a try.
15469 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
15470 @section Tables and lists in arbitrary syntax
15471 @cindex tables, in other modes
15472 @cindex lists, in other modes
15473 @cindex Orgtbl mode
15475 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
15476 frequent feature request has been to make it work with native tables in
15477 specific languages, for example @LaTeX{}. However, this is extremely
15478 hard to do in a general way, would lead to a customization nightmare,
15479 and would take away much of the simplicity of the Orgtbl mode table
15482 This appendix describes a different approach. We keep the Orgtbl mode
15483 table in its native format (the @i{source table}), and use a custom
15484 function to @i{translate} the table to the correct syntax, and to
15485 @i{install} it in the right location (the @i{target table}). This puts
15486 the burden of writing conversion functions on the user, but it allows
15487 for a very flexible system.
15489 Bastien added the ability to do the same with lists, in Orgstruct mode. You
15490 can use Org's facilities to edit and structure lists by turning
15491 @code{orgstruct-mode} on, then locally exporting such lists in another format
15492 (HTML, @LaTeX{} or Texinfo.)
15496 * Radio tables:: Sending and receiving radio tables
15497 * A @LaTeX{} example:: Step by step, almost a tutorial
15498 * Translator functions:: Copy and modify
15499 * Radio lists:: Doing the same for lists
15502 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
15503 @subsection Radio tables
15504 @cindex radio tables
15506 To define the location of the target table, you first need to create two
15507 lines that are comments in the current mode, but contain magic words for
15508 Orgtbl mode to find. Orgtbl mode will insert the translated table
15509 between these lines, replacing whatever was there before. For example:
15512 /* BEGIN RECEIVE ORGTBL table_name */
15513 /* END RECEIVE ORGTBL table_name */
15517 Just above the source table, we put a special line that tells
15518 Orgtbl mode how to translate this table and where to install it. For
15522 #+ORGTBL: SEND table_name translation_function arguments....
15526 @code{table_name} is the reference name for the table that is also used
15527 in the receiver lines. @code{translation_function} is the Lisp function
15528 that does the translation. Furthermore, the line can contain a list of
15529 arguments (alternating key and value) at the end. The arguments will be
15530 passed as a property list to the translation function for
15531 interpretation. A few standard parameters are already recognized and
15532 acted upon before the translation function is called:
15536 Skip the first N lines of the table. Hlines do count as separate lines for
15539 @item :skipcols (n1 n2 ...)
15540 List of columns that should be skipped. If the table has a column with
15541 calculation marks, that column is automatically discarded as well.
15542 Please note that the translator function sees the table @emph{after} the
15543 removal of these columns, the function never knows that there have been
15544 additional columns.
15547 When non-nil, do not escape special characters @code{&%#_^} when exporting
15548 the table. The default value is nil.
15552 The one problem remaining is how to keep the source table in the buffer
15553 without disturbing the normal workings of the file, for example during
15554 compilation of a C file or processing of a @LaTeX{} file. There are a
15555 number of different solutions:
15559 The table could be placed in a block comment if that is supported by the
15560 language. For example, in C mode you could wrap the table between
15561 @samp{/*} and @samp{*/} lines.
15563 Sometimes it is possible to put the table after some kind of @i{END}
15564 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
15567 You can just comment the table line-by-line whenever you want to process
15568 the file, and uncomment it whenever you need to edit the table. This
15569 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
15570 makes this comment-toggling very easy, in particular if you bind it to a
15574 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
15575 @subsection A @LaTeX{} example of radio tables
15576 @cindex @LaTeX{}, and Orgtbl mode
15578 The best way to wrap the source table in @LaTeX{} is to use the
15579 @code{comment} environment provided by @file{comment.sty}. It has to be
15580 activated by placing @code{\usepackage@{comment@}} into the document
15581 header. Orgtbl mode can insert a radio table skeleton@footnote{By
15582 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
15583 variable @code{orgtbl-radio-tables} to install templates for other
15584 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
15585 be prompted for a table name, let's say we use @samp{salesfigures}. You
15586 will then get the following template:
15588 @cindex #+ORGTBL, SEND
15590 % BEGIN RECEIVE ORGTBL salesfigures
15591 % END RECEIVE ORGTBL salesfigures
15593 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15599 @vindex @LaTeX{}-verbatim-environments
15600 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
15601 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
15602 into the receiver location with name @code{salesfigures}. You may now
15603 fill in the table---feel free to use the spreadsheet features@footnote{If
15604 the @samp{#+TBLFM} line contains an odd number of dollar characters,
15605 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
15606 example you can fix this by adding an extra line inside the
15607 @code{comment} environment that is used to balance the dollar
15608 expressions. If you are using AUC@TeX{} with the font-latex library, a
15609 much better solution is to add the @code{comment} environment to the
15610 variable @code{LaTeX-verbatim-environments}.}:
15613 % BEGIN RECEIVE ORGTBL salesfigures
15614 % END RECEIVE ORGTBL salesfigures
15616 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15617 | Month | Days | Nr sold | per day |
15618 |-------+------+---------+---------|
15619 | Jan | 23 | 55 | 2.4 |
15620 | Feb | 21 | 16 | 0.8 |
15621 | March | 22 | 278 | 12.6 |
15622 #+TBLFM: $4=$3/$2;%.1f
15623 % $ (optional extra dollar to keep font-lock happy, see footnote)
15628 When you are done, press @kbd{C-c C-c} in the table to get the converted
15629 table inserted between the two marker lines.
15631 Now let's assume you want to make the table header by hand, because you
15632 want to control how columns are aligned, etc. In this case we make sure
15633 that the table translator skips the first 2 lines of the source
15634 table, and tell the command to work as a @i{splice}, i.e., to not produce
15635 header and footer commands of the target table:
15638 \begin@{tabular@}@{lrrr@}
15639 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
15640 % BEGIN RECEIVE ORGTBL salesfigures
15641 % END RECEIVE ORGTBL salesfigures
15645 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
15646 | Month | Days | Nr sold | per day |
15647 |-------+------+---------+---------|
15648 | Jan | 23 | 55 | 2.4 |
15649 | Feb | 21 | 16 | 0.8 |
15650 | March | 22 | 278 | 12.6 |
15651 #+TBLFM: $4=$3/$2;%.1f
15655 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
15656 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
15657 and marks horizontal lines with @code{\hline}. Furthermore, it
15658 interprets the following parameters (see also @pxref{Translator functions}):
15661 @item :splice nil/t
15662 When set to t, return only table body lines, don't wrap them into a
15663 tabular environment. Default is nil.
15666 A format to be used to wrap each field, it should contain @code{%s} for the
15667 original field value. For example, to wrap each field value in dollars,
15668 you could use @code{:fmt "$%s$"}. This may also be a property list with
15669 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
15670 A function of one argument can be used in place of the strings; the
15671 function must return a formatted string.
15674 Use this format to print numbers with exponentials. The format should
15675 have @code{%s} twice for inserting mantissa and exponent, for example
15676 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
15677 may also be a property list with column numbers and formats, for example
15678 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
15679 @code{efmt} has been applied to a value, @code{fmt} will also be
15680 applied. Similar to @code{fmt}, functions of two arguments can be
15681 supplied instead of strings.
15684 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
15685 @subsection Translator functions
15686 @cindex HTML, and Orgtbl mode
15687 @cindex translator function
15689 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
15690 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
15691 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
15692 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
15693 code that produces tables during HTML export.}, these all use a generic
15694 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
15695 itself is a very short function that computes the column definitions for the
15696 @code{tabular} environment, defines a few field and line separators and then
15697 hands processing over to the generic translator. Here is the entire code:
15701 (defun orgtbl-to-latex (table params)
15702 "Convert the Orgtbl mode TABLE to LaTeX."
15703 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
15704 org-table-last-alignment ""))
15707 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
15708 :tend "\\end@{tabular@}"
15709 :lstart "" :lend " \\\\" :sep " & "
15710 :efmt "%s\\,(%s)" :hline "\\hline")))
15711 (orgtbl-to-generic table (org-combine-plists params2 params))))
15715 As you can see, the properties passed into the function (variable
15716 @var{PARAMS}) are combined with the ones newly defined in the function
15717 (variable @var{PARAMS2}). The ones passed into the function (i.e., the
15718 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
15719 would like to use the @LaTeX{} translator, but wanted the line endings to
15720 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
15721 overrule the default with
15724 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
15727 For a new language, you can either write your own converter function in
15728 analogy with the @LaTeX{} translator, or you can use the generic function
15729 directly. For example, if you have a language where a table is started
15730 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
15731 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
15732 separator is a TAB, you could call the generic translator like this (on
15736 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
15737 :lstart "!BL! " :lend " !EL!" :sep "\t"
15741 Please check the documentation string of the function
15742 @code{orgtbl-to-generic} for a full list of parameters understood by
15743 that function, and remember that you can pass each of them into
15744 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
15745 using the generic function.
15747 Of course you can also write a completely new function doing complicated
15748 things the generic translator cannot do. A translator function takes
15749 two arguments. The first argument is the table, a list of lines, each
15750 line either the symbol @code{hline} or a list of fields. The second
15751 argument is the property list containing all parameters specified in the
15752 @samp{#+ORGTBL: SEND} line. The function must return a single string
15753 containing the formatted table. If you write a generally useful
15754 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
15755 others can benefit from your work.
15757 @node Radio lists, , Translator functions, Tables in arbitrary syntax
15758 @subsection Radio lists
15759 @cindex radio lists
15760 @cindex org-list-insert-radio-list
15762 Sending and receiving radio lists works exactly the same way as sending and
15763 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
15764 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
15765 @code{org-list-insert-radio-list}.
15767 Here are the differences with radio tables:
15771 Orgstruct mode must be active.
15773 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
15775 The available translation functions for radio lists don't take
15778 @kbd{C-c C-c} will work when pressed on the first item of the list.
15781 Here is a @LaTeX{} example. Let's say that you have this in your
15786 % BEGIN RECEIVE ORGLST to-buy
15787 % END RECEIVE ORGLST to-buy
15789 #+ORGLST: SEND to-buy org-list-to-latex
15798 Pressing @kbd{C-c C-c} on @code{a new house} and will insert the converted
15799 @LaTeX{} list between the two marker lines.
15801 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
15802 @section Dynamic blocks
15803 @cindex dynamic blocks
15805 Org documents can contain @emph{dynamic blocks}. These are
15806 specially marked regions that are updated by some user-written function.
15807 A good example for such a block is the clock table inserted by the
15808 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
15810 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
15811 to the block and can also specify parameters for the function producing
15812 the content of the block.
15814 @cindex #+BEGIN:dynamic block
15816 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
15821 Dynamic blocks are updated with the following commands
15824 @orgcmd{C-c C-x C-u,org-dblock-update}
15825 Update dynamic block at point.
15826 @orgkey{C-u C-c C-x C-u}
15827 Update all dynamic blocks in the current file.
15830 Updating a dynamic block means to remove all the text between BEGIN and
15831 END, parse the BEGIN line for parameters and then call the specific
15832 writer function for this block to insert the new content. If you want
15833 to use the original content in the writer function, you can use the
15834 extra parameter @code{:content}.
15836 For a block with name @code{myblock}, the writer function is
15837 @code{org-dblock-write:myblock} with as only parameter a property list
15838 with the parameters given in the begin line. Here is a trivial example
15839 of a block that keeps track of when the block update function was last
15843 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
15849 The corresponding block writer function could look like this:
15852 (defun org-dblock-write:block-update-time (params)
15853 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
15854 (insert "Last block update at: "
15855 (format-time-string fmt (current-time)))))
15858 If you want to make sure that all dynamic blocks are always up-to-date,
15859 you could add the function @code{org-update-all-dblocks} to a hook, for
15860 example @code{before-save-hook}. @code{org-update-all-dblocks} is
15861 written in a way such that it does nothing in buffers that are not in
15864 You can narrow the current buffer to the current dynamic block (like any
15865 other block) with @code{org-narrow-to-block}.
15867 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
15868 @section Special agenda views
15869 @cindex agenda views, user-defined
15871 @vindex org-agenda-skip-function
15872 @vindex org-agenda-skip-function-global
15873 Org provides a special hook that can be used to narrow down the selection
15874 made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
15875 @code{tags}, @code{tags-todo}, @code{tags-tree}. You may specify a function
15876 that is used at each match to verify if the match should indeed be part of
15877 the agenda view, and if not, how much should be skipped. You can specify a
15878 global condition that will be applied to all agenda views, this condition
15879 would be stored in the variable @code{org-agenda-skip-function-global}. More
15880 commonly, such a definition is applied only to specific custom searches,
15881 using @code{org-agenda-skip-function}.
15883 Let's say you want to produce a list of projects that contain a WAITING
15884 tag anywhere in the project tree. Let's further assume that you have
15885 marked all tree headings that define a project with the TODO keyword
15886 PROJECT@. In this case you would run a TODO search for the keyword
15887 PROJECT, but skip the match unless there is a WAITING tag anywhere in
15888 the subtree belonging to the project line.
15890 To achieve this, you must write a function that searches the subtree for
15891 the tag. If the tag is found, the function must return @code{nil} to
15892 indicate that this match should not be skipped. If there is no such
15893 tag, return the location of the end of the subtree, to indicate that
15894 search should continue from there.
15897 (defun my-skip-unless-waiting ()
15898 "Skip trees that are not waiting"
15899 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
15900 (if (re-search-forward ":waiting:" subtree-end t)
15901 nil ; tag found, do not skip
15902 subtree-end))) ; tag not found, continue after end of subtree
15905 Now you may use this function in an agenda custom command, for example
15909 (org-add-agenda-custom-command
15910 '("b" todo "PROJECT"
15911 ((org-agenda-skip-function 'my-skip-unless-waiting)
15912 (org-agenda-overriding-header "Projects waiting for something: "))))
15915 @vindex org-agenda-overriding-header
15916 Note that this also binds @code{org-agenda-overriding-header} to get a
15917 meaningful header in the agenda view.
15919 @vindex org-odd-levels-only
15920 @vindex org-agenda-skip-function
15921 A general way to create custom searches is to base them on a search for
15922 entries with a certain level limit. If you want to study all entries with
15923 your custom search function, simply do a search for
15924 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
15925 level number corresponds to order in the hierarchy, not to the number of
15926 stars.}, and then use @code{org-agenda-skip-function} to select the entries
15927 you really want to have.
15929 You may also put a Lisp form into @code{org-agenda-skip-function}. In
15930 particular, you may use the functions @code{org-agenda-skip-entry-if}
15931 and @code{org-agenda-skip-subtree-if} in this form, for example:
15934 @item (org-agenda-skip-entry-if 'scheduled)
15935 Skip current entry if it has been scheduled.
15936 @item (org-agenda-skip-entry-if 'notscheduled)
15937 Skip current entry if it has not been scheduled.
15938 @item (org-agenda-skip-entry-if 'deadline)
15939 Skip current entry if it has a deadline.
15940 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
15941 Skip current entry if it has a deadline, or if it is scheduled.
15942 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
15943 Skip current entry if the TODO keyword is TODO or WAITING.
15944 @item (org-agenda-skip-entry-if 'todo 'done)
15945 Skip current entry if the TODO keyword marks a DONE state.
15946 @item (org-agenda-skip-entry-if 'timestamp)
15947 Skip current entry if it has any timestamp, may also be deadline or scheduled.
15948 @anchor{x-agenda-skip-entry-regexp}
15949 @item (org-agenda-skip-entry-if 'regexp "regular expression")
15950 Skip current entry if the regular expression matches in the entry.
15951 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
15952 Skip current entry unless the regular expression matches.
15953 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
15954 Same as above, but check and skip the entire subtree.
15957 Therefore we could also have written the search for WAITING projects
15958 like this, even without defining a special function:
15961 (org-add-agenda-custom-command
15962 '("b" todo "PROJECT"
15963 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
15964 'regexp ":waiting:"))
15965 (org-agenda-overriding-header "Projects waiting for something: "))))
15968 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
15969 @section Extracting agenda information
15970 @cindex agenda, pipe
15971 @cindex Scripts, for agenda processing
15973 @vindex org-agenda-custom-commands
15974 Org provides commands to access agenda information for the command
15975 line in Emacs batch mode. This extracted information can be sent
15976 directly to a printer, or it can be read by a program that does further
15977 processing of the data. The first of these commands is the function
15978 @code{org-batch-agenda}, that produces an agenda view and sends it as
15979 ASCII text to STDOUT@. The command takes a single string as parameter.
15980 If the string has length 1, it is used as a key to one of the commands
15981 you have configured in @code{org-agenda-custom-commands}, basically any
15982 key you can use after @kbd{C-c a}. For example, to directly print the
15983 current TODO list, you could use
15986 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
15989 If the parameter is a string with 2 or more characters, it is used as a
15990 tags/TODO match string. For example, to print your local shopping list
15991 (all items with the tag @samp{shop}, but excluding the tag
15992 @samp{NewYork}), you could use
15995 emacs -batch -l ~/.emacs \
15996 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
16000 You may also modify parameters on the fly like this:
16003 emacs -batch -l ~/.emacs \
16004 -eval '(org-batch-agenda "a" \
16005 org-agenda-span (quote month) \
16006 org-agenda-include-diary nil \
16007 org-agenda-files (quote ("~/org/project.org")))' \
16012 which will produce a 30-day agenda, fully restricted to the Org file
16013 @file{~/org/projects.org}, not even including the diary.
16015 If you want to process the agenda data in more sophisticated ways, you
16016 can use the command @code{org-batch-agenda-csv} to get a comma-separated
16017 list of values for each agenda item. Each line in the output will
16018 contain a number of fields separated by commas. The fields in a line
16022 category @r{The category of the item}
16023 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
16024 type @r{The type of the agenda entry, can be}
16025 todo @r{selected in TODO match}
16026 tagsmatch @r{selected in tags match}
16027 diary @r{imported from diary}
16028 deadline @r{a deadline}
16029 scheduled @r{scheduled}
16030 timestamp @r{appointment, selected by timestamp}
16031 closed @r{entry was closed on date}
16032 upcoming-deadline @r{warning about nearing deadline}
16033 past-scheduled @r{forwarded scheduled item}
16034 block @r{entry has date block including date}
16035 todo @r{The TODO keyword, if any}
16036 tags @r{All tags including inherited ones, separated by colons}
16037 date @r{The relevant date, like 2007-2-14}
16038 time @r{The time, like 15:00-16:50}
16039 extra @r{String with extra planning info}
16040 priority-l @r{The priority letter if any was given}
16041 priority-n @r{The computed numerical priority}
16045 Time and date will only be given if a timestamp (or deadline/scheduled)
16046 led to the selection of the item.
16048 A CSV list like this is very easy to use in a post-processing script.
16049 For example, here is a Perl program that gets the TODO list from
16050 Emacs/Org and prints all the items, preceded by a checkbox:
16055 # define the Emacs command to run
16056 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
16058 # run it and capture the output
16059 $agenda = qx@{$cmd 2>/dev/null@};
16061 # loop over all lines
16062 foreach $line (split(/\n/,$agenda)) @{
16063 # get the individual values
16064 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
16065 $priority_l,$priority_n) = split(/,/,$line);
16066 # process and print
16067 print "[ ] $head\n";
16071 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
16072 @section Using the property API
16073 @cindex API, for properties
16074 @cindex properties, API
16076 Here is a description of the functions that can be used to work with
16079 @defun org-entry-properties &optional pom which
16080 Get all properties of the entry at point-or-marker POM.@*
16081 This includes the TODO keyword, the tags, time strings for deadline,
16082 scheduled, and clocking, and any additional properties defined in the
16083 entry. The return value is an alist. Keys may occur multiple times
16084 if the property key was used several times.@*
16085 POM may also be nil, in which case the current entry is used.
16086 If WHICH is nil or `all', get all properties. If WHICH is
16087 `special' or `standard', only get that subclass.
16089 @vindex org-use-property-inheritance
16090 @findex org-insert-property-drawer
16091 @defun org-entry-get pom property &optional inherit
16092 Get value of PROPERTY for entry at point-or-marker POM@. By default,
16093 this only looks at properties defined locally in the entry. If INHERIT
16094 is non-nil and the entry does not have the property, then also check
16095 higher levels of the hierarchy. If INHERIT is the symbol
16096 @code{selective}, use inheritance if and only if the setting of
16097 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
16100 @defun org-entry-delete pom property
16101 Delete the property PROPERTY from entry at point-or-marker POM.
16104 @defun org-entry-put pom property value
16105 Set PROPERTY to VALUE for entry at point-or-marker POM.
16108 @defun org-buffer-property-keys &optional include-specials
16109 Get all property keys in the current buffer.
16112 @defun org-insert-property-drawer
16113 Insert a property drawer for the current entry. Also
16116 @defun org-entry-put-multivalued-property pom property &rest values
16117 Set PROPERTY at point-or-marker POM to VALUES@. VALUES should be a list of
16118 strings. They will be concatenated, with spaces as separators.
16121 @defun org-entry-get-multivalued-property pom property
16122 Treat the value of the property PROPERTY as a whitespace-separated list of
16123 values and return the values as a list of strings.
16126 @defun org-entry-add-to-multivalued-property pom property value
16127 Treat the value of the property PROPERTY as a whitespace-separated list of
16128 values and make sure that VALUE is in this list.
16131 @defun org-entry-remove-from-multivalued-property pom property value
16132 Treat the value of the property PROPERTY as a whitespace-separated list of
16133 values and make sure that VALUE is @emph{not} in this list.
16136 @defun org-entry-member-in-multivalued-property pom property value
16137 Treat the value of the property PROPERTY as a whitespace-separated list of
16138 values and check if VALUE is in this list.
16141 @defopt org-property-allowed-value-functions
16142 Hook for functions supplying allowed values for a specific property.
16143 The functions must take a single argument, the name of the property, and
16144 return a flat list of allowed values. If @samp{:ETC} is one of
16145 the values, use the values as completion help, but allow also other values
16146 to be entered. The functions must return @code{nil} if they are not
16147 responsible for this property.
16150 @node Using the mapping API, , Using the property API, Hacking
16151 @section Using the mapping API
16152 @cindex API, for mapping
16153 @cindex mapping entries, API
16155 Org has sophisticated mapping capabilities to find all entries satisfying
16156 certain criteria. Internally, this functionality is used to produce agenda
16157 views, but there is also an API that can be used to execute arbitrary
16158 functions for each or selected entries. The main entry point for this API
16161 @defun org-map-entries func &optional match scope &rest skip
16162 Call FUNC at each headline selected by MATCH in SCOPE.
16164 FUNC is a function or a Lisp form. The function will be called without
16165 arguments, with the cursor positioned at the beginning of the headline.
16166 The return values of all calls to the function will be collected and
16167 returned as a list.
16169 The call to FUNC will be wrapped into a save-excursion form, so FUNC
16170 does not need to preserve point. After evaluation, the cursor will be
16171 moved to the end of the line (presumably of the headline of the
16172 processed entry) and search continues from there. Under some
16173 circumstances, this may not produce the wanted results. For example,
16174 if you have removed (e.g., archived) the current (sub)tree it could
16175 mean that the next entry will be skipped entirely. In such cases, you
16176 can specify the position from where search should continue by making
16177 FUNC set the variable `org-map-continue-from' to the desired buffer
16180 MATCH is a tags/property/todo match as it is used in the agenda match view.
16181 Only headlines that are matched by this query will be considered during
16182 the iteration. When MATCH is nil or t, all headlines will be
16183 visited by the iteration.
16185 SCOPE determines the scope of this command. It can be any of:
16188 nil @r{the current buffer, respecting the restriction if any}
16189 tree @r{the subtree started with the entry at point}
16190 region @r{The entries within the active region, if any}
16191 file @r{the current buffer, without restriction}
16193 @r{the current buffer, and any archives associated with it}
16194 agenda @r{all agenda files}
16195 agenda-with-archives
16196 @r{all agenda files with any archive files associated with them}
16198 @r{if this is a list, all files in the list will be scanned}
16201 The remaining args are treated as settings for the skipping facilities of
16202 the scanner. The following items can be given here:
16204 @vindex org-agenda-skip-function
16206 archive @r{skip trees with the archive tag}
16207 comment @r{skip trees with the COMMENT keyword}
16208 function or Lisp form
16209 @r{will be used as value for @code{org-agenda-skip-function},}
16210 @r{so whenever the function returns t, FUNC}
16211 @r{will not be called for that entry and search will}
16212 @r{continue from the point where the function leaves it}
16216 The function given to that mapping routine can really do anything you like.
16217 It can use the property API (@pxref{Using the property API}) to gather more
16218 information about the entry, or in order to change metadata in the entry.
16219 Here are a couple of functions that might be handy:
16221 @defun org-todo &optional arg
16222 Change the TODO state of the entry. See the docstring of the functions for
16223 the many possible values for the argument ARG.
16226 @defun org-priority &optional action
16227 Change the priority of the entry. See the docstring of this function for the
16228 possible values for ACTION.
16231 @defun org-toggle-tag tag &optional onoff
16232 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
16233 or @code{off} will not toggle tag, but ensure that it is either on or off.
16237 Promote the current entry.
16241 Demote the current entry.
16244 Here is a simple example that will turn all entries in the current file with
16245 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
16246 Entries in comment trees and in archive trees will be ignored.
16250 '(org-todo "UPCOMING")
16251 "+TOMORROW" 'file 'archive 'comment)
16254 The following example counts the number of entries with TODO keyword
16255 @code{WAITING}, in all agenda files.
16258 (length (org-map-entries t "/+WAITING" 'agenda))
16261 @node MobileOrg, History and Acknowledgments, Hacking, Top
16262 @appendix MobileOrg
16266 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
16267 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
16268 capture support for an Org mode system rooted on a ``real'' computer. It
16269 does also allow you to record changes to existing entries.
16270 The @uref{http://mobileorg.ncogni.to/, iOS implementation} for the
16271 @i{iPhone/iPod Touch/iPad} series of devices, was developed by Richard
16272 Moreland. Android users should check out
16273 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
16274 by Matt Jones. The two implementations are not identical but offer similar
16277 This appendix describes the support Org has for creating agenda views in a
16278 format that can be displayed by @i{MobileOrg}, and for integrating notes
16279 captured and changes made by @i{MobileOrg} into the main system.
16281 For changing tags and TODO states in MobileOrg, you should have set up the
16282 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
16283 cover all important tags and TODO keywords, even if individual files use only
16284 part of these. MobileOrg will also offer you states and tags set up with
16285 in-buffer settings, but it will understand the logistics of TODO state
16286 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
16287 (@pxref{Setting tags}) only for those set in these variables.
16290 * Setting up the staging area:: Where to interact with the mobile device
16291 * Pushing to MobileOrg:: Uploading Org files and agendas
16292 * Pulling from MobileOrg:: Integrating captured and flagged items
16295 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
16296 @section Setting up the staging area
16298 MobileOrg needs to interact with Emacs through a directory on a server. If you
16299 are using a public server, you should consider to encrypt the files that are
16300 uploaded to the server. This can be done with Org mode 7.02 and with
16301 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
16302 installation on your system. To turn on encryption, set a password in
16303 @i{MobileOrg} and, on the Emacs side, configure the variable
16304 @code{org-mobile-use-encryption}@footnote{If you can safely store the
16305 password in your Emacs setup, you might also want to configure
16306 @code{org-mobile-encryption-password}. Please read the docstring of that
16307 variable. Note that encryption will apply only to the contents of the
16308 @file{.org} files. The file names themselves will remain visible.}.
16310 The easiest way to create that directory is to use a free
16311 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
16312 Dropbox, or if your version of MobileOrg does not support it, you can use a
16313 webdav server. For more information, check out the documentation of MobileOrg and also this
16314 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
16315 When MobileOrg first connects to your Dropbox, it will create a directory
16316 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
16320 (setq org-mobile-directory "~/Dropbox/MobileOrg")
16323 Org mode has commands to put files for @i{MobileOrg} into that directory,
16324 and to read captured notes from there.
16326 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
16327 @section Pushing to MobileOrg
16329 This operation copies all files currently listed in @code{org-mobile-files}
16330 to the directory @code{org-mobile-directory}. By default this list contains
16331 all agenda files (as listed in @code{org-agenda-files}), but additional files
16332 can be included by customizing @code{org-mobile-files}. File names will be
16333 staged with paths relative to @code{org-directory}, so all files should be
16334 inside this directory@footnote{Symbolic links in @code{org-directory} need to
16335 have the same name than their targets.}.
16337 The push operation also creates a special Org file @file{agendas.org} with
16338 all custom agenda view defined by the user@footnote{While creating the
16339 agendas, Org mode will force ID properties on all referenced entries, so that
16340 these entries can be uniquely identified if @i{MobileOrg} flags them for
16341 further action. If you do not want to get these properties in so many
16342 entries, you can set the variable @code{org-mobile-force-id-on-agenda-items}
16343 to @code{nil}. Org mode will then rely on outline paths, in the hope that
16344 these will be unique enough.}.
16346 Finally, Org writes the file @file{index.org}, containing links to all other
16347 files. @i{MobileOrg} first reads this file from the server, and then
16348 downloads all agendas and Org files listed in it. To speed up the download,
16349 MobileOrg will only read files whose checksums@footnote{Checksums are stored
16350 automatically in the file @file{checksums.dat}} have changed.
16352 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
16353 @section Pulling from MobileOrg
16355 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
16356 files for viewing. It also appends captured entries and pointers to flagged
16357 and changed entries to the file @file{mobileorg.org} on the server. Org has
16358 a @emph{pull} operation that integrates this information into an inbox file
16359 and operates on the pointers to flagged entries. Here is how it works:
16363 Org moves all entries found in
16364 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
16365 operation.} and appends them to the file pointed to by the variable
16366 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
16367 will be a top-level entry in the inbox file.
16369 After moving the entries, Org will attempt to implement the changes made in
16370 @i{MobileOrg}. Some changes are applied directly and without user
16371 interaction. Examples are all changes to tags, TODO state, headline and body
16372 text that can be cleanly applied. Entries that have been flagged for further
16373 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
16374 again. When there is a problem finding an entry or applying the change, the
16375 pointer entry will remain in the inbox and will be marked with an error
16376 message. You need to later resolve these issues by hand.
16378 Org will then generate an agenda view with all flagged entries. The user
16379 should then go through these entries and do whatever actions are necessary.
16380 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
16381 will be displayed in the echo area when the cursor is on the corresponding
16386 Pressing @kbd{?} in that special agenda will display the full flagging note in
16387 another window and also push it onto the kill ring. So you could use @kbd{?
16388 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
16389 Pressing @kbd{?} twice in succession will offer to remove the
16390 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
16391 in a property). In this way you indicate that the intended processing for
16392 this flagged entry is finished.
16397 If you are not able to process all flagged entries directly, you can always
16398 return to this agenda view@footnote{Note, however, that there is a subtle
16399 difference. The view created automatically by @kbd{M-x org-mobile-pull
16400 @key{RET}} is guaranteed to search all files that have been addressed by the
16401 last pull. This might include a file that is not currently in your list of
16402 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
16403 the current agenda files will be searched.} using @kbd{C-c a ?}.
16405 @node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top
16406 @appendix History and acknowledgments
16407 @cindex acknowledgments
16411 @section From Carsten
16413 Org was born in 2003, out of frustration over the user interface of the Emacs
16414 Outline mode. I was trying to organize my notes and projects, and using
16415 Emacs seemed to be the natural way to go. However, having to remember eleven
16416 different commands with two or three keys per command, only to hide and show
16417 parts of the outline tree, that seemed entirely unacceptable to me. Also,
16418 when using outlines to take notes, I constantly wanted to restructure the
16419 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
16420 cycling} and @emph{structure editing} were originally implemented in the
16421 package @file{outline-magic.el}, but quickly moved to the more general
16422 @file{org.el}. As this environment became comfortable for project planning,
16423 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
16424 @emph{table support}. These areas highlighted the two main goals that Org
16425 still has today: to be a new, outline-based, plain text mode with innovative
16426 and intuitive editing features, and to incorporate project planning
16427 functionality directly into a notes file.
16429 Since the first release, literally thousands of emails to me or to
16430 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
16431 reports, feedback, new ideas, and sometimes patches and add-on code.
16432 Many thanks to everyone who has helped to improve this package. I am
16433 trying to keep here a list of the people who had significant influence
16434 in shaping one or more aspects of Org. The list may not be
16435 complete, if I have forgotten someone, please accept my apologies and
16438 Before I get to this list, a few special mentions are in order:
16441 @item Bastien Guerry
16442 Bastien has written a large number of extensions to Org (most of them
16443 integrated into the core by now), including the @LaTeX{} exporter and the plain
16444 list parser. His support during the early days, when he basically acted as
16445 co-maintainer, was central to the success of this project. Bastien also
16446 invented Worg, helped establishing the Web presence of Org, and sponsored
16447 hosting costs for the orgmode.org website.
16448 @item Eric Schulte and Dan Davison
16449 Eric and Dan are jointly responsible for the Org-babel system, which turns
16450 Org into a multi-language environment for evaluating code and doing literate
16451 programming and reproducible research.
16453 John has contributed a number of great ideas and patches directly to Org,
16454 including the attachment system (@file{org-attach.el}), integration with
16455 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
16456 items, habit tracking (@file{org-habits.el}), and encryption
16457 (@file{org-crypt.el}). Also, the capture system is really an extended copy
16458 of his great @file{remember.el}.
16459 @item Sebastian Rose
16460 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
16461 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
16462 higher level. He also wrote @file{org-info.js}, a Java script for displaying
16463 webpages derived from Org using an Info-like or a folding interface with
16464 single-key navigation.
16467 @noindent See below for the full list of contributions! Again, please
16468 let me know what I am missing here!
16470 @section From Bastien
16472 I (Bastien) have been maintaining Org since January 2011. This appendix
16473 would not be complete without adding a few more acknowledgements and thanks
16474 to Carsten's ones above.
16476 I am first grateful to Carsten for his trust while handing me over the
16477 maintainership of Org. His support as been great since day one of this new
16478 adventure, and it helped a lot.
16480 When I took over maintainership, I knew I would have to make Org more
16481 collaborative than ever, as I would have to rely on people that are more
16482 knowledgeable than I am on many parts of the code. Here is a list of the
16483 persons I could rely on, they should really be considered co-maintainers,
16484 either of the code or the community:
16488 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
16489 from worrying about possible bugs here and let me focus on other parts.
16491 @item Nicolas Goaziou
16492 Nicolas is maintaining the consistency of the deepest parts of Org. His work
16493 on @file{org-element.el} and @file{org-export.el} has been outstanding, and
16494 opened the doors for many new ideas and features.
16496 @item Jambunathan K
16497 Jambunathan contributed the ODT exporter, definitely a killer feature of
16498 Org mode. He also contributed the new HTML exporter, which is another core
16499 feature of Org. Here too, I knew I could rely on him to fix bugs in these
16500 areas and to patiently explain the users what was the problems and solutions.
16503 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
16504 into a flexible and conceptually clean process. He patiently coped with the
16505 many hiccups that such a change can create for users.
16508 The Org mode mailing list would not be such a nice place without Nick, who
16509 patiently helped users so many times. It is impossible to overestimate such
16510 a great help, and the list would not be so active without him.
16513 I received support from so many users that it is clearly impossible to be
16514 fair when shortlisting a few of them, but Org's history would not be
16515 complete if the ones above were not mentioned in this manual.
16517 @section List of contributions
16522 @i{Russel Adams} came up with the idea for drawers.
16524 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
16526 @i{Christophe Bataillon} created the great unicorn logo that we use on the
16529 @i{Alex Bochannek} provided a patch for rounding timestamps.
16531 @i{Jan Böcker} wrote @file{org-docview.el}.
16533 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
16535 @i{Tom Breton} wrote @file{org-choose.el}.
16537 @i{Charles Cave}'s suggestion sparked the implementation of templates
16538 for Remember, which are now templates for capture.
16540 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
16543 @i{Gregory Chernov} patched support for Lisp forms into table
16544 calculations and improved XEmacs compatibility, in particular by porting
16545 @file{nouline.el} to XEmacs.
16547 @i{Sacha Chua} suggested copying some linking code from Planner.
16549 @i{Baoqiu Cui} contributed the DocBook exporter. It has been deleted from
16550 Org 8.0: you can now export to Texinfo and export the @code{.texi} file to
16551 DocBook using @code{makeinfo}.
16553 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
16554 came up with the idea of properties, and that there should be an API for
16557 @i{Nick Dokos} tracked down several nasty bugs.
16559 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
16560 inspired some of the early development, including HTML export. He also
16561 asked for a way to narrow wide table columns.
16563 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
16564 the Org-Babel documentation into the manual.
16566 @i{Christian Egli} converted the documentation into Texinfo format, inspired
16567 the agenda, patched CSS formatting into the HTML exporter, and wrote
16568 @file{org-taskjuggler.el}, which has been rewritten by Nicolas Goaziou as
16569 @file{ox-taskjuggler.el} for Org 8.0.
16571 @i{David Emery} provided a patch for custom CSS support in exported
16574 @i{Nic Ferrier} contributed mailcap and XOXO support.
16576 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
16578 @i{John Foerch} figured out how to make incremental search show context
16579 around a match in a hidden outline tree.
16581 @i{Raimar Finken} wrote @file{org-git-line.el}.
16583 @i{Mikael Fornius} works as a mailing list moderator.
16585 @i{Austin Frank} works as a mailing list moderator.
16587 @i{Eric Fraga} drove the development of BEAMER export with ideas and
16590 @i{Barry Gidden} did proofreading the manual in preparation for the book
16591 publication through Network Theory Ltd.
16593 @i{Niels Giesen} had the idea to automatically archive DONE trees.
16595 @i{Nicolas Goaziou} rewrote much of the plain list code.
16597 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
16599 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
16602 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
16603 task state change logging, and the clocktable. His clear explanations have
16604 been critical when we started to adopt the Git version control system.
16606 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
16609 @i{Phil Jackson} wrote @file{org-irc.el}.
16611 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
16612 folded entries, and column view for properties.
16614 @i{Matt Jones} wrote @i{MobileOrg Android}.
16616 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
16618 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
16619 provided frequent feedback and some patches.
16621 @i{Matt Lundin} has proposed last-row references for table formulas and named
16622 invisible anchors. He has also worked a lot on the FAQ.
16624 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
16625 and is a prolific contributor on the mailing list with competent replies,
16626 small fixes and patches.
16628 @i{Jason F. McBrayer} suggested agenda export to CSV format.
16630 @i{Max Mikhanosha} came up with the idea of refiling.
16632 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
16635 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
16638 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
16640 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
16641 and being able to quickly restrict the agenda to a subtree.
16643 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
16645 @i{Greg Newman} refreshed the unicorn logo into its current form.
16647 @i{Tim O'Callaghan} suggested in-file links, search options for general
16648 file links, and TAGS.
16650 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
16651 version of the reference card.
16653 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
16656 @i{Oliver Oppitz} suggested multi-state TODO items.
16658 @i{Scott Otterson} sparked the introduction of descriptive text for
16659 links, among other things.
16661 @i{Pete Phillips} helped during the development of the TAGS feature, and
16662 provided frequent feedback.
16664 @i{Martin Pohlack} provided the code snippet to bundle character insertion
16665 into bundles of 20 for undo.
16667 @i{T.V. Raman} reported bugs and suggested improvements.
16669 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
16672 @i{Paul Rivier} provided the basic implementation of named footnotes. He
16673 also acted as mailing list moderator for some time.
16675 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
16677 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
16678 conflict with @file{allout.el}.
16680 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
16683 @i{Philip Rooke} created the Org reference card, provided lots
16684 of feedback, developed and applied standards to the Org documentation.
16686 @i{Christian Schlauer} proposed angular brackets around links, among
16689 @i{Paul Sexton} wrote @file{org-ctags.el}.
16691 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
16692 @file{organizer-mode.el}.
16694 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
16695 examples, and remote highlighting for referenced code lines.
16697 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
16698 now packaged into Org's @file{contrib} directory.
16700 @i{Daniel Sinder} came up with the idea of internal archiving by locking
16703 @i{Dale Smith} proposed link abbreviations.
16705 @i{James TD Smith} has contributed a large number of patches for useful
16706 tweaks and features.
16708 @i{Adam Spiers} asked for global linking commands, inspired the link
16709 extension system, added support for mairix, and proposed the mapping API.
16711 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
16712 @LaTeX{}, UTF-8, Latin-1 and ASCII.
16714 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
16715 with links transformation to Org syntax.
16717 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
16718 chapter about publishing.
16720 @i{Jambunathan K} contributed the ODT exporter.
16722 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
16723 enabled source code highlighting in Gnus.
16725 @i{Stefan Vollmar} organized a video-recorded talk at the
16726 Max-Planck-Institute for Neurology. He also inspired the creation of a
16727 concept index for HTML export.
16729 @i{J@"urgen Vollmer} contributed code generating the table of contents
16732 @i{Samuel Wales} has provided important feedback and bug reports.
16734 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
16737 @i{David Wainberg} suggested archiving, and improvements to the linking
16740 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
16743 @i{Roland Winkler} requested additional key bindings to make Org
16746 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
16747 and contributed various ideas and code snippets.
16751 @node GNU Free Documentation License, Main Index, History and Acknowledgments, Top
16752 @appendix GNU Free Documentation License
16753 @include doclicense.texi
16756 @node Main Index, Key Index, GNU Free Documentation License, Top
16757 @unnumbered Concept index
16761 @node Key Index, Command and Function Index, Main Index, Top
16762 @unnumbered Key index
16766 @node Command and Function Index, Variable Index, Key Index, Top
16767 @unnumbered Command and function index
16771 @node Variable Index, , Command and Function Index, Top
16772 @unnumbered Variable index
16774 This is not a complete index of variables and faces, only the ones that are
16775 mentioned in the manual. For a more complete list, use @kbd{M-x
16776 org-customize @key{RET}} and then click yourself through the tree.
16782 @c Local variables:
16784 @c indent-tabs-mode: nil
16785 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
16786 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
16790 @c LocalWords: webdavhost pre