3 @setfilename ../../info/org
4 @settitle The Org Manual
6 @include org-version.inc
8 @c Use proper quote and backtick for code sections in PDF output
9 @c Cf. Texinfo manual 14.2
10 @set txicodequoteundirected
11 @set txicodequotebacktick
13 @c Version and Contact Info
14 @set MAINTAINERSITE @uref{http://orgmode.org,maintainers webpage}
15 @set AUTHOR Carsten Dominik
16 @set MAINTAINER Carsten Dominik
17 @set MAINTAINEREMAIL @email{carsten at orgmode dot org}
18 @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer}
23 @c -----------------------------------------------------------------------------
25 @c Macro definitions for commands and keys
26 @c =======================================
28 @c The behavior of the key/command macros will depend on the flag cmdnames
29 @c When set, commands names are shown. When clear, they are not shown.
33 @c Below we define the following macros for Org key tables:
35 @c orgkey{key} A key item
36 @c orgcmd{key,cmd} Key with command name
37 @c xorgcmd{key,cmd} Key with command name as @itemx
38 @c orgcmdnki{key,cmd} Like orgcmd, but do not index the key
39 @c orgcmdtkc{text,key,cmd} Like orgcmd,special text instead of key
40 @c orgcmdkkc{key1,key2,cmd} Two keys with one command name, use "or"
41 @c orgcmdkxkc{key1,key2,cmd} Two keys with one command name, but
42 @c different functions, so format as @itemx
43 @c orgcmdkskc{key1,key2,cmd} Same as orgcmdkkc, but use "or short"
44 @c xorgcmdkskc{key1,key2,cmd} Same as previous, but use @itemx
45 @c orgcmdkkcc{key1,key2,cmd1,cmd2} Two keys and two commands
47 @c a key but no command
59 @c one key with a command
60 @c Inserts: @item KEY COMMAND
61 @macro orgcmd{key,command}
66 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
69 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
78 @c One key with one command, formatted using @itemx
79 @c Inserts: @itemx KEY COMMAND
80 @macro xorgcmd{key,command}
85 @itemx @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
88 @itemx @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
97 @c one key with a command, bit do not index the key
98 @c Inserts: @item KEY COMMAND
99 @macro orgcmdnki{key,command}
103 @item @kbd{\key\} @hskip 0pt plus 1filll @code{\command\}
106 @item @kbd{\key\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
114 @c one key with a command, and special text to replace key in item
115 @c Inserts: @item TEXT COMMAND
116 @macro orgcmdtkc{text,key,command}
121 @item @kbd{\text\} @hskip 0pt plus 1filll @code{\command\}
124 @item @kbd{\text\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
133 @c two keys with one command
134 @c Inserts: @item KEY1 or KEY2 COMMAND
135 @macro orgcmdkkc{key1,key2,command}
141 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
144 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
150 @item @kbd{\key1\} @ @r{or} @ @kbd{\key2\}
154 @c Two keys with one command name, but different functions, so format as
156 @c Inserts: @item KEY1
157 @c @itemx KEY2 COMMAND
158 @macro orgcmdkxkc{key1,key2,command}
165 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
169 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
180 @c Same as previous, but use "or short"
181 @c Inserts: @item KEY1 or short KEY2 COMMAND
182 @macro orgcmdkskc{key1,key2,command}
188 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
191 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
197 @item @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
201 @c Same as previous, but use @itemx
202 @c Inserts: @itemx KEY1 or short KEY2 COMMAND
203 @macro xorgcmdkskc{key1,key2,command}
209 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @hskip 0pt plus 1filll @code{\command\}
212 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command\})
218 @itemx @kbd{\key1\} @ @r{or short} @ @kbd{\key2\}
222 @c two keys with two commands
223 @c Inserts: @item KEY1 COMMAND1
224 @c @itemx KEY2 COMMAND2
225 @macro orgcmdkkcc{key1,key2,command1,command2}
232 @item @kbd{\key1\} @hskip 0pt plus 1filll @code{\command1\}
233 @itemx @kbd{\key2\} @hskip 0pt plus 1filll @code{\command2\}
236 @item @kbd{\key1\} @tie{}@tie{}@tie{}@tie{}(@code{\command1\})
237 @itemx @kbd{\key2\} @tie{}@tie{}@tie{}@tie{}(@code{\command2\})
247 @c -----------------------------------------------------------------------------
250 @c @hyphenation{time-stamp time-stamps time-stamp-ing time-stamp-ed}
253 @c Subheadings inside a table.
254 @macro tsubheading{text}
256 @subsubheading \text\
264 This manual is for Org version @value{VERSION}.
266 Copyright @copyright{} 2004--2012 Free Software Foundation, Inc.
269 Permission is granted to copy, distribute and/or modify this document
270 under the terms of the GNU Free Documentation License, Version 1.3 or
271 any later version published by the Free Software Foundation; with no
272 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
273 and with the Back-Cover Texts as in (a) below. A copy of the license
274 is included in the section entitled ``GNU Free Documentation License.''
276 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
277 modify this GNU manual.''
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:: How to install a downloaded version of 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 * DocBook export:: Exporting to DocBook
574 * OpenDocument Text export:: Exporting to OpenDocument Text
575 * TaskJuggler export:: Exporting to TaskJuggler
576 * Freemind export:: Exporting to Freemind mind maps
577 * XOXO export:: Exporting to XOXO
578 * iCalendar export:: Exporting in iCalendar format
582 * HTML Export commands:: How to invoke HTML export
583 * HTML preamble and postamble:: How to insert a preamble and a postamble
584 * Quoting HTML tags:: Using direct HTML in Org mode
585 * Links in HTML export:: How links will be interpreted and formatted
586 * Tables in HTML export:: How to modify the formatting of tables
587 * Images in HTML export:: How to insert figures into HTML output
588 * Math formatting in HTML export:: Beautiful math also on the web
589 * Text areas in HTML export:: An alternative way to show an example
590 * CSS support:: Changing the appearance of the output
591 * JavaScript support:: Info and Folding in a web browser
593 @LaTeX{} and PDF export
595 * @LaTeX{}/PDF export commands::
596 * Header and sectioning:: Setting up the export file structure
597 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
598 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
599 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
600 * Beamer class export:: Turning the file into a presentation
604 * DocBook export commands:: How to invoke DocBook export
605 * Quoting DocBook code:: Incorporating DocBook code in Org files
606 * Recursive sections:: Recursive sections in DocBook
607 * Tables in DocBook export:: Tables are exported as HTML tables
608 * Images in DocBook export:: How to insert figures into DocBook output
609 * Special characters:: How to handle special characters
611 OpenDocument Text export
613 * Pre-requisites for ODT export:: What packages ODT exporter relies on
614 * ODT export commands:: How to invoke ODT export
615 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
616 * Applying custom styles:: How to apply custom styles to the output
617 * Links in ODT export:: How links will be interpreted and formatted
618 * Tables in ODT export:: How Tables are exported
619 * Images in ODT export:: How to insert images
620 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
621 * Labels and captions in ODT export:: How captions are rendered
622 * Literal examples in ODT export:: How source and example blocks are formatted
623 * Advanced topics in ODT export:: Read this if you are a power user
625 Math formatting in ODT export
627 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
628 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
630 Advanced topics in ODT export
632 * Configuring a document converter:: How to register a document converter
633 * Working with OpenDocument style files:: Explore the internals
634 * Creating one-off styles:: How to produce custom highlighting etc
635 * Customizing tables in ODT export:: How to define and use Table templates
636 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
640 * Configuration:: Defining projects
641 * Uploading files:: How to get files up on the server
642 * Sample configuration:: Example projects
643 * Triggering publication:: Publication commands
647 * Project alist:: The central configuration variable
648 * Sources and destinations:: From here to there
649 * Selecting files:: What files are part of the project?
650 * Publishing action:: Setting the function doing the publishing
651 * Publishing options:: Tweaking HTML/@LaTeX{} export
652 * Publishing links:: Which links keep working after publishing?
653 * Sitemap:: Generating a list of all pages
654 * Generating an index:: An index that reaches across pages
658 * Simple example:: One-component publishing
659 * Complex example:: A multi-component publishing example
661 Working with source code
663 * Structure of code blocks:: Code block syntax described
664 * Editing source code:: Language major-mode editing
665 * Exporting code blocks:: Export contents and/or results
666 * Extracting source code:: Create pure source code files
667 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
668 * Library of Babel:: Use and contribute to a library of useful code blocks
669 * Languages:: List of supported code block languages
670 * Header arguments:: Configure code block functionality
671 * Results of evaluation:: How evaluation results are handled
672 * Noweb reference syntax:: Literate programming in Org mode
673 * Key bindings and useful functions:: Work quickly with code blocks
674 * Batch execution:: Call functions from the command line
678 * Using header arguments:: Different ways to set header arguments
679 * Specific header arguments:: List of header arguments
681 Using header arguments
683 * System-wide header arguments:: Set global default values
684 * Language-specific header arguments:: Set default values by language
685 * Buffer-wide header arguments:: Set default values for a specific buffer
686 * Header arguments in Org mode properties:: Set default values for a buffer or heading
687 * Code block specific header arguments:: The most common way to set values
688 * Header arguments in function calls:: The most specific level
690 Specific header arguments
692 * var:: Pass arguments to code blocks
693 * results:: Specify the type of results and how they will
694 be collected and handled
695 * file:: Specify a path for file output
696 * file-desc:: Specify a description for file results
697 * dir:: Specify the default (possibly remote)
698 directory for code block execution
699 * exports:: Export code and/or results
700 * tangle:: Toggle tangling and specify file name
701 * mkdirp:: Toggle creation of parent directories of target
702 files during tangling
703 * comments:: Toggle insertion of comments in tangled
705 * padline:: Control insertion of padding lines in tangled
707 * no-expand:: Turn off variable assignment and noweb
708 expansion during tangling
709 * session:: Preserve the state of code evaluation
710 * noweb:: Toggle expansion of noweb references
711 * noweb-ref:: Specify block's noweb reference resolution target
712 * noweb-sep:: String used to separate noweb references
713 * cache:: Avoid re-evaluating unchanged code blocks
714 * sep:: Delimiter for writing tabular results outside Org
715 * hlines:: Handle horizontal lines in tables
716 * colnames:: Handle column names in tables
717 * rownames:: Handle row names in tables
718 * shebang:: Make tangled files executable
719 * eval:: Limit evaluation of specific code blocks
720 * wrap:: Mark source block evaluation results
724 * Completion:: M-TAB knows what you need
725 * Easy Templates:: Quick insertion of structural elements
726 * Speed keys:: Electric commands at the beginning of a headline
727 * Code evaluation security:: Org mode files evaluate inline code
728 * Customization:: Adapting Org to your taste
729 * In-buffer settings:: Overview of the #+KEYWORDS
730 * The very busy C-c C-c key:: When in doubt, press C-c C-c
731 * Clean view:: Getting rid of leading stars in the outline
732 * TTY keys:: Using Org on a tty
733 * Interaction:: Other Emacs packages
734 * org-crypt.el:: Encrypting Org files
736 Interaction with other packages
738 * Cooperation:: Packages Org cooperates with
739 * Conflicts:: Packages that lead to conflicts
743 * Hooks:: How to reach into Org's internals
744 * Add-on packages:: Available extensions
745 * Adding hyperlink types:: New custom link types
746 * Context-sensitive commands:: How to add functionality to such commands
747 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
748 * Dynamic blocks:: Automatically filled blocks
749 * Special agenda views:: Customized views
750 * Extracting agenda information:: Postprocessing of agenda information
751 * Using the property API:: Writing programs that use entry properties
752 * Using the mapping API:: Mapping over all or selected entries
754 Tables and lists in arbitrary syntax
756 * Radio tables:: Sending and receiving radio tables
757 * A @LaTeX{} example:: Step by step, almost a tutorial
758 * Translator functions:: Copy and modify
759 * Radio lists:: Doing the same for lists
763 * Setting up the staging area:: Where to interact with the mobile device
764 * Pushing to MobileOrg:: Uploading Org files and agendas
765 * Pulling from MobileOrg:: Integrating captured and flagged items
770 @node Introduction, Document Structure, Top, Top
771 @chapter Introduction
775 * Summary:: Brief summary of what Org does
776 * Installation:: How to install a downloaded version of Org
777 * Activation:: How to activate Org for certain buffers
778 * Feedback:: Bug reports, ideas, patches etc.
779 * Conventions:: Typesetting conventions in the manual
782 @node Summary, Installation, Introduction, Introduction
786 Org is a mode for keeping notes, maintaining TODO lists, and doing
787 project planning with a fast and effective plain-text system.
789 Org develops organizational tasks around NOTES files that contain
790 lists or information about projects as plain text. Org is
791 implemented on top of Outline mode, which makes it possible to keep the
792 content of large files well structured. Visibility cycling and
793 structure editing help to work with the tree. Tables are easily created
794 with a built-in table editor. Org supports TODO items, deadlines,
795 timestamps, and scheduling. It dynamically compiles entries into an
796 agenda that utilizes and smoothly integrates much of the Emacs calendar
797 and diary. Plain text URL-like links connect to websites, emails,
798 Usenet messages, BBDB entries, and any files related to the projects.
799 For printing and sharing of notes, an Org file can be exported as a
800 structured ASCII file, as HTML, or (TODO and agenda items only) as an
801 iCalendar file. It can also serve as a publishing tool for a set of
804 As a project planning environment, Org works by adding metadata to outline
805 nodes. Based on this data, specific entries can be extracted in queries and
806 create dynamic @i{agenda views}.
808 Org mode contains the Org Babel environment which allows you to work with
809 embedded source code blocks in a file, to facilitate code evaluation,
810 documentation, and literate programming techniques.
812 Org's automatic, context-sensitive table editor with spreadsheet
813 capabilities can be integrated into any major mode by activating the
814 minor Orgtbl mode. Using a translation step, it can be used to maintain
815 tables in arbitrary file types, for example in @LaTeX{}. The structure
816 editing and list creation capabilities can be used outside Org with
817 the minor Orgstruct mode.
819 Org keeps simple things simple. When first fired up, it should
820 feel like a straightforward, easy to use outliner. Complexity is not
821 imposed, but a large amount of functionality is available when you need
822 it. Org is a toolbox and can be used in different ways and for different
826 @r{@bullet{} an outline extension with visibility cycling and structure editing}
827 @r{@bullet{} an ASCII system and table editor for taking structured notes}
828 @r{@bullet{} a TODO list editor}
829 @r{@bullet{} a full agenda and planner with deadlines and work scheduling}
830 @pindex GTD, Getting Things Done
831 @r{@bullet{} an environment in which to implement David Allen's GTD system}
832 @r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export}
833 @r{@bullet{} a publishing tool to create a set of interlinked webpages}
834 @r{@bullet{} an environment for literate programming}
838 There is a website for Org which provides links to the newest
839 version of Org, as well as additional information, frequently asked
840 questions (FAQ), links to tutorials, etc. This page is located at
841 @uref{http://orgmode.org}.
843 @cindex print edition
844 The version 7.3 of this manual is available as a
845 @uref{http://www.network-theory.co.uk/org/manual/, paperback book from Network
851 @node Installation, Activation, Summary, Introduction
852 @section Installation
856 @b{Important:} @i{If you the version of Org that comes with Emacs or as a
857 XEmacs package, please skip this section and go directly to @ref{Activation}.
858 If you downloaded Org as an ELPA package, please read the instructions on the
859 @uref{http://orgmode.org/elpa.html, Org ELPA page}. To see what version of Org
860 (if any) is part of your Emacs distribution, type @kbd{M-x org-version} (if
861 your Emacs distribution does not come with Org, this function will not be
864 Installation of Org mode uses a build system, which is described in more
865 detail on @uref{http://orgmode.org/worg/dev/org-build-system.html, Worg}.
867 If you have downloaded Org from the Web as a distribution @file{.zip} or
868 @file{.tar.gz} archive, take the following steps to install it:
871 @item Unpack the distribution archive.
872 @item Change into (@code{cd}) the Org directory.
873 @item Run @code{make help config}
874 and then check and edit the file @file{local.mk} if the default configuration
875 does not match your system. Set the name of the Emacs binary (likely either
876 @file{emacs} or @file{xemacs}), and the paths to the directories where local
877 Lisp and Info files will be installed. If the Emacs binary is not in your
878 path, give the full path to the executable. Avoid spaces in any path names.
879 @item Run @code{make config}
880 again to check the configuration.
881 @item Run @code{make install} or @code{sudo make install}
882 to build and install Org mode on your system.
885 If you use a cloned Git repository, then the procedure is slightly different.
886 The following description assumes that you are using the @code{master} branch
887 (where the development is done). You could also use the @code{maint} branch
888 instead, where the release versions are published, just replace @code{master}
889 with @code{maint} in the description below.
892 @item Change into (@code{cd}) the Org repository.
893 @item Run @code{git checkout master}
894 to switch to the @code{master} branch of the Org repository.
895 @item Run @code{make help}
896 and then check and edit the file @file{local.mk}. You must set the name of
897 the Emacs binary (likely either @file{emacs} or @file{xemacs}), and the paths
898 to the directories where local Lisp and Info files will be installed. If the
899 Emacs binary is not in your path, you must give the full path to the
900 executable. Avoid spaces in any path names.
901 @item Run @code{make config}
902 to check the configuration.
903 @item Optionally run @code{make test}
904 to build Org mode and then run the full testsuite.
905 @item Run @code{make update2} or @code{make up2}
906 to update the Git repository and build and install Org mode. The latter
907 invocation runs the complete test suite before installation and installs only
908 if the build passes all tests.
911 If you don't have access to the system-wide directories and you don't want to
912 install somewhere into your home directory, you can run Org directly from the
913 distribution directory or Org repository by compiling Org mode in place:
916 @item Change into (@code{cd}) the Org repository.
917 @item Run @code{git checkout master}
918 to switch to the @code{master} branch of the Org repository.
919 @item Run @code{make compile}
922 Last but not least you can also run Org mode directly from an Org repository
923 without any compilation. Simply replace the last step in the recipe above
924 with @code{make uncompiled}.
926 Then add the following line to @file{.emacs}:
929 (add-to-list 'load-path "~/path/to/orgdir/lisp")
933 If you plan to use code from the @file{contrib} subdirectory without
934 compiling them, do a similar step for this directory:
937 (add-to-list 'load-path "~/path/to/orgdir/contrib/lisp" t)
940 If you want to include those files with the build and install, please
941 customize the variable @code{ORG_ADD_CONTRIB} instead in your @code{local.mk}
942 file, for more details please see this
943 @uref{http://orgmode.org/worg/dev/org-build-system.html#sec-4-1-2,
944 description on Worg}.
946 Installing Info files is system dependent, because of differences in the
947 @file{install-info} program. The Info documentation is installed together
948 with the rest of Org mode. If you don't install Org mode, it is possible to
949 install the Info documentation separately (you need to have
950 install-info@footnote{The output from install-info (if any) is system
951 dependent. In particular Debian and its derivatives use two different
952 versions of install-info and you may see the message:
955 This is not dpkg install-info anymore, but GNU install-info
956 See the man page for ginstall-info for command line arguments
959 @noindent which can be safely ignored.}
966 Do not forget to activate Org as described in the following section.
969 @node Activation, Feedback, Installation, Introduction
974 @cindex global key bindings
975 @cindex key bindings, global
978 @findex org-store-link
981 Since Emacs 22.2, files with the @file{.org} extension use Org mode by
982 default. If you are using an earlier version of Emacs, add this line to your
986 (add-to-list 'auto-mode-alist '("\\.org\\'" . org-mode))
989 Org mode buffers need font-lock to be turned on: this is the default in
990 Emacs@footnote{If you don't use font-lock globally, turn it on in Org buffer
991 with @code{(add-hook 'org-mode-hook 'turn-on-font-lock)}}.
993 There are compatibility issues between Org mode and some other Elisp
994 packages, please take the time to check the list (@pxref{Conflicts}).
996 The four Org commands @command{org-store-link}, @command{org-capture},
997 @command{org-agenda}, and @command{org-iswitchb} should be accessible through
998 global keys (i.e., anywhere in Emacs, not just in Org buffers). Here are
999 suggested bindings for these keys, please modify the keys to your own
1002 (global-set-key "\C-cl" 'org-store-link)
1003 (global-set-key "\C-cc" 'org-capture)
1004 (global-set-key "\C-ca" 'org-agenda)
1005 (global-set-key "\C-cb" 'org-iswitchb)
1008 @cindex Org mode, turning on
1009 With this setup, all files with extension @samp{.org} will be put
1010 into Org mode. As an alternative, make the first line of a file look
1014 MY PROJECTS -*- mode: org; -*-
1017 @vindex org-insert-mode-line-in-empty-file
1018 @noindent which will select Org mode for this buffer no matter what
1019 the file's name is. See also the variable
1020 @code{org-insert-mode-line-in-empty-file}.
1022 Many commands in Org work on the region if the region is @i{active}. To make
1023 use of this, you need to have @code{transient-mark-mode}
1024 (@code{zmacs-regions} in XEmacs) turned on. In Emacs 23 this is the default,
1025 in Emacs 22 you need to do this yourself with
1027 (transient-mark-mode 1)
1029 @noindent If you do not like @code{transient-mark-mode}, you can create an
1030 active region by using the mouse to select a region, or pressing
1031 @kbd{C-@key{SPC}} twice before moving the cursor.
1033 @node Feedback, Conventions, Activation, Introduction
1040 If you find problems with Org, or if you have questions, remarks, or ideas
1041 about it, please mail to the Org mailing list @email{emacs-orgmode@@gnu.org}.
1042 If you are not a member of the mailing list, your mail will be passed to the
1043 list after a moderator has approved it@footnote{Please consider subscribing
1044 to the mailing list, in order to minimize the work the mailing list
1045 moderators have to do.}.
1047 For bug reports, please first try to reproduce the bug with the latest
1048 version of Org available---if you are running an outdated version, it is
1049 quite possible that the bug has been fixed already. If the bug persists,
1050 prepare a report and provide as much information as possible, including the
1051 version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org
1052 (@kbd{M-x org-version @key{RET}}), as well as the Org related setup in
1053 @file{.emacs}. The easiest way to do this is to use the command
1055 @kbd{M-x org-submit-bug-report}
1057 @noindent which will put all this information into an Emacs mail buffer so
1058 that you only need to add your description. If you re not sending the Email
1059 from within Emacs, please copy and paste the content into your Email program.
1061 Sometimes you might face a problem due to an error in your Emacs or Org mode
1062 setup. Before reporting a bug, it is very helpful to start Emacs with minimal
1063 customizations and reproduce the problem. Doing so often helps you determine
1064 if the problem is with your customization or with Org mode itself. You can
1065 start a typical minimal session with a command like the example below.
1068 $ emacs -Q -l /path/to/minimal-org.el
1071 However if you are using Org mode as distributed with Emacs, a minimal setup
1072 is not necessary. In that case it is sufficient to start Emacs as
1073 @code{emacs -Q}. The @code{minimal-org.el} setup file can have contents as
1077 ;;; Minimal setup to load latest `org-mode'
1079 ;; activate debugging
1080 (setq debug-on-error t
1084 ;; add latest org-mode to load path
1085 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp"))
1086 (add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp" t))
1089 If an error occurs, a backtrace can be very useful (see below on how to
1090 create one). Often a small example file helps, along with clear information
1094 @item What exactly did you do?
1095 @item What did you expect to happen?
1096 @item What happened instead?
1098 @noindent Thank you for helping to improve this program.
1100 @subsubheading How to create a useful backtrace
1102 @cindex backtrace of an error
1103 If working with Org produces an error with a message you don't
1104 understand, you may have hit a bug. The best way to report this is by
1105 providing, in addition to what was mentioned above, a @emph{backtrace}.
1106 This is information from the built-in debugger about where and how the
1107 error occurred. Here is how to produce a useful backtrace:
1111 Reload uncompiled versions of all Org mode Lisp files. The backtrace
1112 contains much more information if it is produced with uncompiled code.
1115 C-u M-x org-reload RET
1118 or select @code{Org -> Refresh/Reload -> Reload Org uncompiled} from the
1121 Go to the @code{Options} menu and select @code{Enter Debugger on Error}
1122 (XEmacs has this option in the @code{Troubleshooting} sub-menu).
1124 Do whatever you have to do to hit the error. Don't forget to
1125 document the steps you take.
1127 When you hit the error, a @file{*Backtrace*} buffer will appear on the
1128 screen. Save this buffer to a file (for example using @kbd{C-x C-w}) and
1129 attach it to your bug report.
1132 @node Conventions, , Feedback, Introduction
1133 @section Typesetting conventions used in this manual
1135 @subsubheading TODO keywords, tags, properties, etc.
1137 Org mainly uses three types of keywords: TODO keywords, tags and property
1138 names. In this manual we use the following conventions:
1143 TODO keywords are written with all capitals, even if they are
1147 User-defined tags are written in lowercase; built-in tags with special
1148 meaning are written with all capitals.
1151 User-defined properties are capitalized; built-in properties with
1152 special meaning are written with all capitals.
1155 Moreover, Org uses @i{option keywords} (like @code{#+TITLE} to set the title)
1156 and @i{environment keywords} (like @code{#+BEGIN_HTML} to start a @code{HTML}
1157 environment). They are written in uppercase in the manual to enhance its
1158 readability, but you can use lowercase in your Org files@footnote{Easy
1159 templates insert lowercase keywords and Babel dynamically inserts
1162 @subsubheading Keybindings and commands
1168 The manual suggests two global keybindings: @kbd{C-c a} for @code{org-agenda}
1169 and @kbd{C-c c} for @code{org-capture}. These are only suggestions, but the
1170 rest of the manual assumes that you are using these keybindings.
1172 Also, the manual lists both the keys and the corresponding commands for
1173 accessing a functionality. Org mode often uses the same key for different
1174 functions, depending on context. The command that is bound to such keys has
1175 a generic name, like @code{org-metaright}. In the manual we will, wherever
1176 possible, give the function that is internally called by the generic command.
1177 For example, in the chapter on document structure, @kbd{M-@key{right}} will
1178 be listed to call @code{org-do-demote}, while in the chapter on tables, it
1179 will be listed to call @code{org-table-move-column-right}. If you prefer,
1180 you can compile the manual without the command names by unsetting the flag
1181 @code{cmdnames} in @file{org.texi}.
1183 @node Document Structure, Tables, Introduction, Top
1184 @chapter Document structure
1185 @cindex document structure
1186 @cindex structure of document
1188 Org is based on Outline mode and provides flexible commands to
1189 edit the structure of the document.
1192 * Outlines:: Org is based on Outline mode
1193 * Headlines:: How to typeset Org tree headlines
1194 * Visibility cycling:: Show and hide, much simplified
1195 * Motion:: Jumping to other headlines
1196 * Structure editing:: Changing sequence and level of headlines
1197 * Sparse trees:: Matches embedded in context
1198 * Plain lists:: Additional structure within an entry
1199 * Drawers:: Tucking stuff away
1200 * Blocks:: Folding blocks
1201 * Footnotes:: How footnotes are defined in Org's syntax
1202 * Orgstruct mode:: Structure editing outside Org
1205 @node Outlines, Headlines, Document Structure, Document Structure
1208 @cindex Outline mode
1210 Org is implemented on top of Outline mode. Outlines allow a
1211 document to be organized in a hierarchical structure, which (at least
1212 for me) is the best representation of notes and thoughts. An overview
1213 of this structure is achieved by folding (hiding) large parts of the
1214 document to show only the general document structure and the parts
1215 currently being worked on. Org greatly simplifies the use of
1216 outlines by compressing the entire show/hide functionality into a single
1217 command, @command{org-cycle}, which is bound to the @key{TAB} key.
1219 @node Headlines, Visibility cycling, Outlines, Document Structure
1222 @cindex outline tree
1223 @vindex org-special-ctrl-a/e
1224 @vindex org-special-ctrl-k
1225 @vindex org-ctrl-k-protect-subtree
1227 Headlines define the structure of an outline tree. The headlines in Org
1228 start with one or more stars, on the left margin@footnote{See the variables
1229 @code{org-special-ctrl-a/e}, @code{org-special-ctrl-k}, and
1230 @code{org-ctrl-k-protect-subtree} to configure special behavior of @kbd{C-a},
1231 @kbd{C-e}, and @kbd{C-k} in headlines.} @footnote{Clocking only works with
1232 headings indented less then 30 stars.}. For example:
1235 * Top level headline
1242 * Another top level headline
1245 @noindent Some people find the many stars too noisy and would prefer an
1246 outline that has whitespace followed by a single star as headline
1247 starters. @ref{Clean view}, describes a setup to realize this.
1249 @vindex org-cycle-separator-lines
1250 An empty line after the end of a subtree is considered part of it and
1251 will be hidden when the subtree is folded. However, if you leave at
1252 least two empty lines, one empty line will remain visible after folding
1253 the subtree, in order to structure the collapsed view. See the
1254 variable @code{org-cycle-separator-lines} to modify this behavior.
1256 @node Visibility cycling, Motion, Headlines, Document Structure
1257 @section Visibility cycling
1258 @cindex cycling, visibility
1259 @cindex visibility cycling
1260 @cindex trees, visibility
1261 @cindex show hidden text
1264 Outlines make it possible to hide parts of the text in the buffer.
1265 Org uses just two commands, bound to @key{TAB} and
1266 @kbd{S-@key{TAB}} to change the visibility in the buffer.
1268 @cindex subtree visibility states
1269 @cindex subtree cycling
1270 @cindex folded, subtree visibility state
1271 @cindex children, subtree visibility state
1272 @cindex subtree, subtree visibility state
1274 @orgcmd{@key{TAB},org-cycle}
1275 @emph{Subtree cycling}: Rotate current subtree among the states
1278 ,-> FOLDED -> CHILDREN -> SUBTREE --.
1279 '-----------------------------------'
1282 @vindex org-cycle-emulate-tab
1283 @vindex org-cycle-global-at-bob
1284 The cursor must be on a headline for this to work@footnote{see, however,
1285 the option @code{org-cycle-emulate-tab}.}. When the cursor is at the
1286 beginning of the buffer and the first line is not a headline, then
1287 @key{TAB} actually runs global cycling (see below)@footnote{see the
1288 option @code{org-cycle-global-at-bob}.}. Also when called with a prefix
1289 argument (@kbd{C-u @key{TAB}}), global cycling is invoked.
1291 @cindex global visibility states
1292 @cindex global cycling
1293 @cindex overview, global visibility state
1294 @cindex contents, global visibility state
1295 @cindex show all, global visibility state
1296 @orgcmd{S-@key{TAB},org-global-cycle}
1297 @itemx C-u @key{TAB}
1298 @emph{Global cycling}: Rotate the entire buffer among the states
1301 ,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
1302 '--------------------------------------'
1305 When @kbd{S-@key{TAB}} is called with a numeric prefix argument N, the
1306 CONTENTS view up to headlines of level N will be shown. Note that inside
1307 tables, @kbd{S-@key{TAB}} jumps to the previous field.
1309 @cindex show all, command
1310 @orgcmd{C-u C-u C-u @key{TAB},show-all}
1311 Show all, including drawers.
1312 @cindex revealing context
1313 @orgcmd{C-c C-r,org-reveal}
1314 Reveal context around point, showing the current entry, the following heading
1315 and the hierarchy above. Useful for working near a location that has been
1316 exposed by a sparse tree command (@pxref{Sparse trees}) or an agenda command
1317 (@pxref{Agenda commands}). With a prefix argument show, on each
1318 level, all sibling headings. With a double prefix argument, also show the
1319 entire subtree of the parent.
1320 @cindex show branches, command
1321 @orgcmd{C-c C-k,show-branches}
1322 Expose all the headings of the subtree, CONTENT view for just one subtree.
1323 @cindex show children, command
1324 @orgcmd{C-c @key{TAB},show-children}
1325 Expose all direct children of the subtree. With a numeric prefix argument N,
1326 expose all children down to level N@.
1327 @orgcmd{C-c C-x b,org-tree-to-indirect-buffer}
1328 Show the current subtree in an indirect buffer@footnote{The indirect
1331 (@pxref{Indirect Buffers,,,emacs,GNU Emacs Manual})
1334 (see the Emacs manual for more information about indirect buffers)
1336 will contain the entire buffer, but will be narrowed to the current
1337 tree. Editing the indirect buffer will also change the original buffer,
1338 but without affecting visibility in that buffer.}. With a numeric
1339 prefix argument N, go up to level N and then take that tree. If N is
1340 negative then go up that many levels. With a @kbd{C-u} prefix, do not remove
1341 the previously used indirect buffer.
1342 @orgcmd{C-c C-x v,org-copy-visible}
1343 Copy the @i{visible} text in the region into the kill ring.
1346 @vindex org-startup-folded
1347 @cindex @code{overview}, STARTUP keyword
1348 @cindex @code{content}, STARTUP keyword
1349 @cindex @code{showall}, STARTUP keyword
1350 @cindex @code{showeverything}, STARTUP keyword
1352 When Emacs first visits an Org file, the global state is set to
1353 OVERVIEW, i.e., only the top level headlines are visible. This can be
1354 configured through the variable @code{org-startup-folded}, or on a
1355 per-file basis by adding one of the following lines anywhere in the
1362 #+STARTUP: showeverything
1365 @cindex property, VISIBILITY
1367 Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties
1368 and Columns}) will get their visibility adapted accordingly. Allowed values
1369 for this property are @code{folded}, @code{children}, @code{content}, and
1372 @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility}
1373 Switch back to the startup visibility of the buffer, i.e., whatever is
1374 requested by startup options and @samp{VISIBILITY} properties in individual
1378 @node Motion, Structure editing, Visibility cycling, Document Structure
1380 @cindex motion, between headlines
1381 @cindex jumping, to headlines
1382 @cindex headline navigation
1383 The following commands jump to other headlines in the buffer.
1386 @orgcmd{C-c C-n,outline-next-visible-heading}
1388 @orgcmd{C-c C-p,outline-previous-visible-heading}
1390 @orgcmd{C-c C-f,org-forward-same-level}
1391 Next heading same level.
1392 @orgcmd{C-c C-b,org-backward-same-level}
1393 Previous heading same level.
1394 @orgcmd{C-c C-u,outline-up-heading}
1395 Backward to higher level heading.
1396 @orgcmd{C-c C-j,org-goto}
1397 Jump to a different place without changing the current outline
1398 visibility. Shows the document structure in a temporary buffer, where
1399 you can use the following keys to find your destination:
1400 @vindex org-goto-auto-isearch
1402 @key{TAB} @r{Cycle visibility.}
1403 @key{down} / @key{up} @r{Next/previous visible headline.}
1404 @key{RET} @r{Select this location.}
1405 @kbd{/} @r{Do a Sparse-tree search}
1406 @r{The following keys work if you turn off @code{org-goto-auto-isearch}}
1407 n / p @r{Next/previous visible headline.}
1408 f / b @r{Next/previous headline same level.}
1410 0-9 @r{Digit argument.}
1413 @vindex org-goto-interface
1415 See also the variable @code{org-goto-interface}.
1418 @node Structure editing, Sparse trees, Motion, Document Structure
1419 @section Structure editing
1420 @cindex structure editing
1421 @cindex headline, promotion and demotion
1422 @cindex promotion, of subtrees
1423 @cindex demotion, of subtrees
1424 @cindex subtree, cut and paste
1425 @cindex pasting, of subtrees
1426 @cindex cutting, of subtrees
1427 @cindex copying, of subtrees
1428 @cindex sorting, of subtrees
1429 @cindex subtrees, cut and paste
1432 @orgcmd{M-@key{RET},org-insert-heading}
1433 @vindex org-M-RET-may-split-line
1434 Insert new heading with same level as current. If the cursor is in a plain
1435 list item, a new item is created (@pxref{Plain lists}). To force creation of
1436 a new headline, use a prefix argument. When this command is used in the
1437 middle of a line, the line is split and the rest of the line becomes the new
1438 headline@footnote{If you do not want the line to be split, customize the
1439 variable @code{org-M-RET-may-split-line}.}. If the command is used at the
1440 beginning of a headline, the new headline is created before the current line.
1441 If at the beginning of any other line, the content of that line is made the
1442 new heading. If the command is used at the end of a folded subtree (i.e.,
1443 behind the ellipses at the end of a headline), then a headline like the
1444 current one will be inserted after the end of the subtree.
1445 @orgcmd{C-@key{RET},org-insert-heading-respect-content}
1446 Just like @kbd{M-@key{RET}}, except when adding a new heading below the
1447 current heading, the new heading is placed after the body instead of before
1448 it. This command works from anywhere in the entry.
1449 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
1450 @vindex org-treat-insert-todo-heading-as-state-change
1451 Insert new TODO entry with same level as current heading. See also the
1452 variable @code{org-treat-insert-todo-heading-as-state-change}.
1453 @orgcmd{C-S-@key{RET},org-insert-todo-heading-respect-content}
1454 Insert new TODO entry with same level as current heading. Like
1455 @kbd{C-@key{RET}}, the new headline will be inserted after the current
1457 @orgcmd{@key{TAB},org-cycle}
1458 In a new entry with no text yet, the first @key{TAB} demotes the entry to
1459 become a child of the previous one. The next @key{TAB} makes it a parent,
1460 and so on, all the way to top level. Yet another @key{TAB}, and you are back
1461 to the initial level.
1462 @orgcmd{M-@key{left},org-do-promote}
1463 Promote current heading by one level.
1464 @orgcmd{M-@key{right},org-do-demote}
1465 Demote current heading by one level.
1466 @orgcmd{M-S-@key{left},org-promote-subtree}
1467 Promote the current subtree by one level.
1468 @orgcmd{M-S-@key{right},org-demote-subtree}
1469 Demote the current subtree by one level.
1470 @orgcmd{M-S-@key{up},org-move-subtree-up}
1471 Move subtree up (swap with previous subtree of same
1473 @orgcmd{M-S-@key{down},org-move-subtree-down}
1474 Move subtree down (swap with next subtree of same level).
1475 @orgcmd{C-c C-x C-w,org-cut-subtree}
1476 Kill subtree, i.e., remove it from buffer but save in kill ring.
1477 With a numeric prefix argument N, kill N sequential subtrees.
1478 @orgcmd{C-c C-x M-w,org-copy-subtree}
1479 Copy subtree to kill ring. With a numeric prefix argument N, copy the N
1480 sequential subtrees.
1481 @orgcmd{C-c C-x C-y,org-paste-subtree}
1482 Yank subtree from kill ring. This does modify the level of the subtree to
1483 make sure the tree fits in nicely at the yank position. The yank level can
1484 also be specified with a numeric prefix argument, or by yanking after a
1485 headline marker like @samp{****}.
1486 @orgcmd{C-y,org-yank}
1487 @vindex org-yank-adjusted-subtrees
1488 @vindex org-yank-folded-subtrees
1489 Depending on the variables @code{org-yank-adjusted-subtrees} and
1490 @code{org-yank-folded-subtrees}, Org's internal @code{yank} command will
1491 paste subtrees folded and in a clever way, using the same command as @kbd{C-c
1492 C-x C-y}. With the default settings, no level adjustment will take place,
1493 but the yanked tree will be folded unless doing so would swallow text
1494 previously visible. Any prefix argument to this command will force a normal
1495 @code{yank} to be executed, with the prefix passed along. A good way to
1496 force a normal yank is @kbd{C-u C-y}. If you use @code{yank-pop} after a
1497 yank, it will yank previous kill items plainly, without adjustment and
1499 @orgcmd{C-c C-x c,org-clone-subtree-with-time-shift}
1500 Clone a subtree by making a number of sibling copies of it. You will be
1501 prompted for the number of copies to make, and you can also specify if any
1502 timestamps in the entry should be shifted. This can be useful, for example,
1503 to create a number of tasks related to a series of lectures to prepare. For
1504 more details, see the docstring of the command
1505 @code{org-clone-subtree-with-time-shift}.
1506 @orgcmd{C-c C-w,org-refile}
1507 Refile entry or region to a different location. @xref{Refile and copy}.
1508 @orgcmd{C-c ^,org-sort}
1509 Sort same-level entries. When there is an active region, all entries in the
1510 region will be sorted. Otherwise the children of the current headline are
1511 sorted. The command prompts for the sorting method, which can be
1512 alphabetically, numerically, by time (first timestamp with active preferred,
1513 creation time, scheduled time, deadline time), by priority, by TODO keyword
1514 (in the sequence the keywords have been defined in the setup) or by the value
1515 of a property. Reverse sorting is possible as well. You can also supply
1516 your own function to extract the sorting key. With a @kbd{C-u} prefix,
1517 sorting will be case-sensitive.
1518 @orgcmd{C-x n s,org-narrow-to-subtree}
1519 Narrow buffer to current subtree.
1520 @orgcmd{C-x n b,org-narrow-to-block}
1521 Narrow buffer to current block.
1522 @orgcmd{C-x n w,widen}
1523 Widen buffer to remove narrowing.
1524 @orgcmd{C-c *,org-toggle-heading}
1525 Turn a normal line or plain list item into a headline (so that it becomes a
1526 subheading at its location). Also turn a headline into a normal line by
1527 removing the stars. If there is an active region, turn all lines in the
1528 region into headlines. If the first line in the region was an item, turn
1529 only the item lines into headlines. Finally, if the first line is a
1530 headline, remove the stars from all headlines in the region.
1533 @cindex region, active
1534 @cindex active region
1535 @cindex transient mark mode
1536 When there is an active region (Transient Mark mode), promotion and
1537 demotion work on all headlines in the region. To select a region of
1538 headlines, it is best to place both point and mark at the beginning of a
1539 line, mark at the beginning of the first headline, and point at the line
1540 just after the last headline to change. Note that when the cursor is
1541 inside a table (@pxref{Tables}), the Meta-Cursor keys have different
1545 @node Sparse trees, Plain lists, Structure editing, Document Structure
1546 @section Sparse trees
1547 @cindex sparse trees
1548 @cindex trees, sparse
1549 @cindex folding, sparse trees
1550 @cindex occur, command
1552 @vindex org-show-hierarchy-above
1553 @vindex org-show-following-heading
1554 @vindex org-show-siblings
1555 @vindex org-show-entry-below
1556 An important feature of Org mode is the ability to construct @emph{sparse
1557 trees} for selected information in an outline tree, so that the entire
1558 document is folded as much as possible, but the selected information is made
1559 visible along with the headline structure above it@footnote{See also the
1560 variables @code{org-show-hierarchy-above}, @code{org-show-following-heading},
1561 @code{org-show-siblings}, and @code{org-show-entry-below} for detailed
1562 control on how much context is shown around each match.}. Just try it out
1563 and you will see immediately how it works.
1565 Org mode contains several commands creating such trees, all these
1566 commands can be accessed through a dispatcher:
1569 @orgcmd{C-c /,org-sparse-tree}
1570 This prompts for an extra key to select a sparse-tree creating command.
1571 @orgcmd{C-c / r,org-occur}
1572 @vindex org-remove-highlights-with-change
1573 Prompts for a regexp and shows a sparse tree with all matches. If
1574 the match is in a headline, the headline is made visible. If the match is in
1575 the body of an entry, headline and body are made visible. In order to
1576 provide minimal context, also the full hierarchy of headlines above the match
1577 is shown, as well as the headline following the match. Each match is also
1578 highlighted; the highlights disappear when the buffer is changed by an
1579 editing command@footnote{This depends on the option
1580 @code{org-remove-highlights-with-change}}, or by pressing @kbd{C-c C-c}.
1581 When called with a @kbd{C-u} prefix argument, previous highlights are kept,
1582 so several calls to this command can be stacked.
1583 @orgcmdkkc{M-g n,M-g M-n,next-error}
1584 Jump to the next sparse tree match in this buffer.
1585 @orgcmdkkc{M-g p,M-g M-p,previous-error}
1586 Jump to the previous sparse tree match in this buffer.
1591 @vindex org-agenda-custom-commands
1592 For frequently used sparse trees of specific search strings, you can
1593 use the variable @code{org-agenda-custom-commands} to define fast
1594 keyboard access to specific sparse trees. These commands will then be
1595 accessible through the agenda dispatcher (@pxref{Agenda dispatcher}).
1599 (setq org-agenda-custom-commands
1600 '(("f" occur-tree "FIXME")))
1603 @noindent will define the key @kbd{C-c a f} as a shortcut for creating
1604 a sparse tree matching the string @samp{FIXME}.
1606 The other sparse tree commands select headings based on TODO keywords,
1607 tags, or properties and will be discussed later in this manual.
1610 @cindex printing sparse trees
1611 @cindex visible text, printing
1612 To print a sparse tree, you can use the Emacs command
1613 @code{ps-print-buffer-with-faces} which does not print invisible parts
1614 of the document @footnote{This does not work under XEmacs, because
1615 XEmacs uses selective display for outlining, not text properties.}.
1616 Or you can use the command @kbd{C-c C-e v} to export only the visible
1617 part of the document and print the resulting file.
1619 @node Plain lists, Drawers, Sparse trees, Document Structure
1620 @section Plain lists
1622 @cindex lists, plain
1623 @cindex lists, ordered
1624 @cindex ordered lists
1626 Within an entry of the outline tree, hand-formatted lists can provide
1627 additional structure. They also provide a way to create lists of checkboxes
1628 (@pxref{Checkboxes}). Org supports editing such lists, and every exporter
1629 (@pxref{Exporting}) can parse and format them.
1631 Org knows ordered lists, unordered lists, and description lists.
1634 @emph{Unordered} list items start with @samp{-}, @samp{+}, or
1635 @samp{*}@footnote{When using @samp{*} as a bullet, lines must be indented or
1636 they will be seen as top-level headlines. Also, when you are hiding leading
1637 stars to get a clean outline view, plain list items starting with a star may
1638 be hard to distinguish from true headlines. In short: even though @samp{*}
1639 is supported, it may be better to not use it for plain list items.} as
1642 @vindex org-plain-list-ordered-item-terminator
1643 @vindex org-alphabetical-lists
1644 @emph{Ordered} list items start with a numeral followed by either a period or
1645 a right parenthesis@footnote{You can filter out any of them by configuring
1646 @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or
1647 @samp{1)}@footnote{You can also get @samp{a.}, @samp{A.}, @samp{a)} and
1648 @samp{A)} by configuring @code{org-alphabetical-lists}. To minimize
1649 confusion with normal text, those are limited to one character only. Beyond
1650 that limit, bullets will automatically fallback to numbers.}. If you want a
1651 list to start with a different value (e.g., 20), start the text of the item
1652 with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie
1653 must be put @emph{before} the checkbox. If you have activated alphabetical
1654 lists, you can also use counters like @code{[@@b]}.}. Those constructs can
1655 be used in any item of the list in order to enforce a particular numbering.
1657 @emph{Description} list items are unordered list items, and contain the
1658 separator @samp{ :: } to distinguish the description @emph{term} from the
1662 Items belonging to the same list must have the same indentation on the first
1663 line. In particular, if an ordered list reaches number @samp{10.}, then the
1664 2--digit numbers must be written left-aligned with the other numbers in the
1665 list. An item ends before the next line that is less or equally indented
1666 than its bullet/number.
1668 @vindex org-empty-line-terminates-plain-lists
1669 A list ends whenever every item has ended, which means before any line less
1670 or equally indented than items at top level. It also ends before two blank
1671 lines@footnote{See also @code{org-empty-line-terminates-plain-lists}.}. In
1672 that case, all items are closed. Here is an example:
1676 ** Lord of the Rings
1677 My favorite scenes are (in this order)
1678 1. The attack of the Rohirrim
1679 2. Eowyn's fight with the witch king
1680 + this was already my favorite scene in the book
1681 + I really like Miranda Otto.
1682 3. Peter Jackson being shot by Legolas
1684 He makes a really funny face when it happens.
1685 But in the end, no individual scenes matter but the film as a whole.
1686 Important actors in this film are:
1687 - @b{Elijah Wood} :: He plays Frodo
1688 - @b{Sean Austin} :: He plays Sam, Frodo's friend. I still remember
1689 him very well from his role as Mikey Walsh in @i{The Goonies}.
1693 Org supports these lists by tuning filling and wrapping commands to deal with
1694 them correctly@footnote{Org only changes the filling settings for Emacs. For
1695 XEmacs, you should use Kyle E. Jones' @file{filladapt.el}. To turn this on,
1696 put into @file{.emacs}: @code{(require 'filladapt)}}, and by exporting them
1697 properly (@pxref{Exporting}). Since indentation is what governs the
1698 structure of these lists, many structural constructs like @code{#+BEGIN_...}
1699 blocks can be indented to signal that they belong to a particular item.
1701 @vindex org-list-demote-modify-bullet
1702 @vindex org-list-indent-offset
1703 If you find that using a different bullet for a sub-list (than that used for
1704 the current list-level) improves readability, customize the variable
1705 @code{org-list-demote-modify-bullet}. To get a greater difference of
1706 indentation between items and theirs sub-items, customize
1707 @code{org-list-indent-offset}.
1709 @vindex org-list-automatic-rules
1710 The following commands act on items when the cursor is in the first line of
1711 an item (the line with the bullet or number). Some of them imply the
1712 application of automatic rules to keep list structure intact. If some of
1713 these actions get in your way, configure @code{org-list-automatic-rules}
1714 to disable them individually.
1717 @orgcmd{@key{TAB},org-cycle}
1718 @cindex cycling, in plain lists
1719 @vindex org-cycle-include-plain-lists
1720 Items can be folded just like headline levels. Normally this works only if
1721 the cursor is on a plain list item. For more details, see the variable
1722 @code{org-cycle-include-plain-lists}. If this variable is set to
1723 @code{integrate}, plain list items will be treated like low-level
1724 headlines. The level of an item is then given by the indentation of the
1725 bullet/number. Items are always subordinate to real headlines, however; the
1726 hierarchies remain completely separated. In a new item with no text yet, the
1727 first @key{TAB} demotes the item to become a child of the previous
1728 one. Subsequent @key{TAB}s move the item to meaningful levels in the list
1729 and eventually get it back to its initial position.
1730 @orgcmd{M-@key{RET},org-insert-heading}
1731 @vindex org-M-RET-may-split-line
1732 @vindex org-list-automatic-rules
1733 Insert new item at current level. With a prefix argument, force a new
1734 heading (@pxref{Structure editing}). If this command is used in the middle
1735 of an item, that item is @emph{split} in two, and the second part becomes the
1736 new item@footnote{If you do not want the item to be split, customize the
1737 variable @code{org-M-RET-may-split-line}.}. If this command is executed
1738 @emph{before item's body}, the new item is created @emph{before} the current
1743 @kindex M-S-@key{RET}
1745 Insert a new item with a checkbox (@pxref{Checkboxes}).
1746 @kindex S-@key{down}
1749 @cindex shift-selection-mode
1750 @vindex org-support-shift-select
1751 @vindex org-list-use-circular-motion
1752 Jump to the previous/next item in the current list@footnote{If you want to
1753 cycle around items that way, you may customize
1754 @code{org-list-use-circular-motion}.}, but only if
1755 @code{org-support-shift-select} is off. If not, you can still use paragraph
1756 jumping commands like @kbd{C-@key{up}} and @kbd{C-@key{down}} to quite
1759 @kindex M-@key{down}
1762 Move the item including subitems up/down@footnote{See
1763 @code{org-liste-use-circular-motion} for a cyclic behavior.} (swap with
1764 previous/next item of same indentation). If the list is ordered, renumbering
1766 @kindex M-@key{left}
1767 @kindex M-@key{right}
1770 Decrease/increase the indentation of an item, leaving children alone.
1771 @kindex M-S-@key{left}
1772 @kindex M-S-@key{right}
1775 Decrease/increase the indentation of the item, including subitems.
1776 Initially, the item tree is selected based on current indentation. When
1777 these commands are executed several times in direct succession, the initially
1778 selected region is used, even if the new indentation would imply a different
1779 hierarchy. To use the new hierarchy, break the command chain with a cursor
1782 As a special case, using this command on the very first item of a list will
1783 move the whole list. This behavior can be disabled by configuring
1784 @code{org-list-automatic-rules}. The global indentation of a list has no
1785 influence on the text @emph{after} the list.
1788 If there is a checkbox (@pxref{Checkboxes}) in the item line, toggle the
1789 state of the checkbox. In any case, verify bullets and indentation
1790 consistency in the whole list.
1792 @vindex org-plain-list-ordered-item-terminator
1794 Cycle the entire list level through the different itemize/enumerate bullets
1795 (@samp{-}, @samp{+}, @samp{*}, @samp{1.}, @samp{1)}) or a subset of them,
1796 depending on @code{org-plain-list-ordered-item-terminator}, the type of list,
1797 and its indentation. With a numeric prefix argument N, select the Nth bullet
1798 from this list. If there is an active region when calling this, selected
1799 text will be changed into an item. With a prefix argument, all lines will be
1800 converted to list items. If the first line already was a list item, any item
1801 marker will be removed from the list. Finally, even without an active
1802 region, a normal line will be converted into a list item.
1805 Turn a plain list item into a headline (so that it becomes a subheading at
1806 its location). @xref{Structure editing}, for a detailed explanation.
1809 Turn the whole plain list into a subtree of the current heading. Checkboxes
1810 (@pxref{Checkboxes}) will become TODO (resp. DONE) keywords when unchecked
1812 @kindex S-@key{left}
1813 @kindex S-@key{right}
1815 @vindex org-support-shift-select
1816 This command also cycles bullet styles when the cursor in on the bullet or
1817 anywhere in an item line, details depending on
1818 @code{org-support-shift-select}.
1821 Sort the plain list. You will be prompted for the sorting method:
1822 numerically, alphabetically, by time, or by custom function.
1825 @node Drawers, Blocks, Plain lists, Document Structure
1829 @cindex visibility cycling, drawers
1832 @cindex org-insert-drawer
1834 Sometimes you want to keep information associated with an entry, but you
1835 normally don't want to see it. For this, Org mode has @emph{drawers}.
1836 Drawers need to be configured with the variable
1837 @code{org-drawers}@footnote{You can define additional drawers on a
1838 per-file basis with a line like @code{#+DRAWERS: HIDDEN STATE}}. Drawers
1842 ** This is a headline
1843 Still outside the drawer
1845 This is inside the drawer.
1850 You can interactively insert drawers at point by calling
1851 @code{org-insert-drawer}, which is bound to @key{C-c C-x d}. With an active
1852 region, this command will put the region inside the drawer. With a prefix
1853 argument, this command calls @code{org-insert-property-drawer} and add a
1854 property drawer right below the current headline. Completion over drawer
1855 keywords is also possible using @key{M-TAB}.
1857 Visibility cycling (@pxref{Visibility cycling}) on the headline will hide and
1858 show the entry, but keep the drawer collapsed to a single line. In order to
1859 look inside the drawer, you need to move the cursor to the drawer line and
1860 press @key{TAB} there. Org mode uses the @code{PROPERTIES} drawer for
1861 storing properties (@pxref{Properties and Columns}), and you can also arrange
1862 for state change notes (@pxref{Tracking TODO state changes}) and clock times
1863 (@pxref{Clocking work time}) to be stored in a drawer @code{LOGBOOK}. If you
1864 want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use
1869 Add a time-stamped note to the LOGBOOK drawer.
1872 @node Blocks, Footnotes, Drawers, Document Structure
1875 @vindex org-hide-block-startup
1876 @cindex blocks, folding
1877 Org mode uses begin...end blocks for various purposes from including source
1878 code examples (@pxref{Literal examples}) to capturing time logging
1879 information (@pxref{Clocking work time}). These blocks can be folded and
1880 unfolded by pressing TAB in the begin line. You can also get all blocks
1881 folded at startup by configuring the variable @code{org-hide-block-startup}
1882 or on a per-file basis by using
1884 @cindex @code{hideblocks}, STARTUP keyword
1885 @cindex @code{nohideblocks}, STARTUP keyword
1887 #+STARTUP: hideblocks
1888 #+STARTUP: nohideblocks
1891 @node Footnotes, Orgstruct mode, Blocks, Document Structure
1895 Org mode supports the creation of footnotes. In contrast to the
1896 @file{footnote.el} package, Org mode's footnotes are designed for work on a
1897 larger document, not only for one-off documents like emails. The basic
1898 syntax is similar to the one used by @file{footnote.el}, i.e., a footnote is
1899 defined in a paragraph that is started by a footnote marker in square
1900 brackets in column 0, no indentation allowed. If you need a paragraph break
1901 inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference
1902 is simply the marker in square brackets, inside text. For example:
1905 The Org homepage[fn:1] now looks a lot better than it used to.
1907 [fn:1] The link is: http://orgmode.org
1910 Org mode extends the number-based syntax to @emph{named} footnotes and
1911 optional inline definition. Using plain numbers as markers (as
1912 @file{footnote.el} does) is supported for backward compatibility, but not
1913 encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded
1914 @LaTeX{}}). Here are the valid references:
1918 A plain numeric footnote marker. Compatible with @file{footnote.el}, but not
1919 recommended because something like @samp{[1]} could easily be part of a code
1922 A named footnote reference, where @code{name} is a unique label word, or, for
1923 simplicity of automatic creation, a number.
1924 @item [fn:: This is the inline definition of this footnote]
1925 A @LaTeX{}-like anonymous footnote where the definition is given directly at the
1927 @item [fn:name: a definition]
1928 An inline definition of a footnote, which also specifies a name for the note.
1929 Since Org allows multiple references to the same note, you can then use
1930 @code{[fn:name]} to create additional references.
1933 @vindex org-footnote-auto-label
1934 Footnote labels can be created automatically, or you can create names yourself.
1935 This is handled by the variable @code{org-footnote-auto-label} and its
1936 corresponding @code{#+STARTUP} keywords. See the docstring of that variable
1939 @noindent The following command handles footnotes:
1944 The footnote action command.
1946 When the cursor is on a footnote reference, jump to the definition. When it
1947 is at a definition, jump to the (first) reference.
1949 @vindex org-footnote-define-inline
1950 @vindex org-footnote-section
1951 @vindex org-footnote-auto-adjust
1952 Otherwise, create a new footnote. Depending on the variable
1953 @code{org-footnote-define-inline}@footnote{The corresponding in-buffer
1954 setting is: @code{#+STARTUP: fninline} or @code{#+STARTUP: nofninline}}, the
1955 definition will be placed right into the text as part of the reference, or
1956 separately into the location determined by the variable
1957 @code{org-footnote-section}.
1959 When this command is called with a prefix argument, a menu of additional
1962 s @r{Sort the footnote definitions by reference sequence. During editing,}
1963 @r{Org makes no effort to sort footnote definitions into a particular}
1964 @r{sequence. If you want them sorted, use this command, which will}
1965 @r{also move entries according to @code{org-footnote-section}. Automatic}
1966 @r{sorting after each insertion/deletion can be configured using the}
1967 @r{variable @code{org-footnote-auto-adjust}.}
1968 r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
1969 @r{after each insertion/deletion can be configured using the variable}
1970 @r{@code{org-footnote-auto-adjust}.}
1971 S @r{Short for first @code{r}, then @code{s} action.}
1972 n @r{Normalize the footnotes by collecting all definitions (including}
1973 @r{inline definitions) into a special section, and then numbering them}
1974 @r{in sequence. The references will then also be numbers. This is}
1975 @r{meant to be the final step before finishing a document (e.g., sending}
1976 @r{off an email). The exporters do this automatically, and so could}
1977 @r{something like @code{message-send-hook}.}
1978 d @r{Delete the footnote at point, and all definitions of and references}
1981 Depending on the variable @code{org-footnote-auto-adjust}@footnote{the
1982 corresponding in-buffer options are @code{fnadjust} and @code{nofnadjust}.},
1983 renumbering and sorting footnotes can be automatic after each insertion or
1988 If the cursor is on a footnote reference, jump to the definition. If it is a
1989 the definition, jump back to the reference. When called at a footnote
1990 location with a prefix argument, offer the same menu as @kbd{C-c C-x f}.
1994 @item C-c C-o @r{or} mouse-1/2
1995 Footnote labels are also links to the corresponding definition/reference, and
1996 you can use the usual commands to follow these links.
1999 @node Orgstruct mode, , Footnotes, Document Structure
2000 @section The Orgstruct minor mode
2001 @cindex Orgstruct mode
2002 @cindex minor mode for structure editing
2004 If you like the intuitive way the Org mode structure editing and list
2005 formatting works, you might want to use these commands in other modes like
2006 Text mode or Mail mode as well. The minor mode @code{orgstruct-mode} makes
2007 this possible. Toggle the mode with @kbd{M-x orgstruct-mode}, or
2008 turn it on by default, for example in Message mode, with one of:
2011 (add-hook 'message-mode-hook 'turn-on-orgstruct)
2012 (add-hook 'message-mode-hook 'turn-on-orgstruct++)
2015 When this mode is active and the cursor is on a line that looks to Org like a
2016 headline or the first line of a list item, most structure editing commands
2017 will work, even if the same keys normally have different functionality in the
2018 major mode you are using. If the cursor is not in one of those special
2019 lines, Orgstruct mode lurks silently in the shadows. When you use
2020 @code{orgstruct++-mode}, Org will also export indentation and autofill
2021 settings into that mode, and detect item context after the first line of an
2024 @node Tables, Hyperlinks, Document Structure, Top
2027 @cindex editing tables
2029 Org comes with a fast and intuitive table editor. Spreadsheet-like
2030 calculations are supported using the Emacs @file{calc} package
2031 (@pxref{Top, Calc, , calc, Gnu Emacs Calculator Manual}).
2034 * Built-in table editor:: Simple tables
2035 * Column width and alignment:: Overrule the automatic settings
2036 * Column groups:: Grouping to trigger vertical lines
2037 * Orgtbl mode:: The table editor as minor mode
2038 * The spreadsheet:: The table editor has spreadsheet capabilities
2039 * Org-Plot:: Plotting from org tables
2042 @node Built-in table editor, Column width and alignment, Tables, Tables
2043 @section The built-in table editor
2044 @cindex table editor, built-in
2046 Org makes it easy to format tables in plain ASCII@. Any line with @samp{|} as
2047 the first non-whitespace character is considered part of a table. @samp{|}
2048 is also the column separator@footnote{To insert a vertical bar into a table
2049 field, use @code{\vert} or, inside a word @code{abc\vert@{@}def}.}. A table
2050 might look like this:
2053 | Name | Phone | Age |
2054 |-------+-------+-----|
2055 | Peter | 1234 | 17 |
2056 | Anna | 4321 | 25 |
2059 A table is re-aligned automatically each time you press @key{TAB} or
2060 @key{RET} or @kbd{C-c C-c} inside the table. @key{TAB} also moves to
2061 the next field (@key{RET} to the next row) and creates new table rows
2062 at the end of the table or before horizontal lines. The indentation
2063 of the table is set by the first line. Any line starting with
2064 @samp{|-} is considered as a horizontal separator line and will be
2065 expanded on the next re-align to span the whole table width. So, to
2066 create the above table, you would only type
2073 @noindent and then press @key{TAB} to align the table and start filling in
2074 fields. Even faster would be to type @code{|Name|Phone|Age} followed by
2075 @kbd{C-c @key{RET}}.
2077 @vindex org-enable-table-editor
2078 @vindex org-table-auto-blank-field
2079 When typing text into a field, Org treats @key{DEL},
2080 @key{Backspace}, and all character keys in a special way, so that
2081 inserting and deleting avoids shifting other fields. Also, when
2082 typing @emph{immediately after the cursor was moved into a new field
2083 with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the
2084 field is automatically made blank. If this behavior is too
2085 unpredictable for you, configure the variables
2086 @code{org-enable-table-editor} and @code{org-table-auto-blank-field}.
2089 @tsubheading{Creation and conversion}
2090 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2091 Convert the active region to table. If every line contains at least one
2092 TAB character, the function assumes that the material is tab separated.
2093 If every line contains a comma, comma-separated values (CSV) are assumed.
2094 If not, lines are split at whitespace into fields. You can use a prefix
2095 argument to force a specific separator: @kbd{C-u} forces CSV, @kbd{C-u
2096 C-u} forces TAB, and a numeric argument N indicates that at least N
2097 consecutive spaces, or alternatively a TAB will be the separator.
2099 If there is no active region, this command creates an empty Org
2100 table. But it is easier just to start typing, like
2101 @kbd{|Name|Phone|Age @key{RET} |- @key{TAB}}.
2103 @tsubheading{Re-aligning and field motion}
2104 @orgcmd{C-c C-c,org-table-align}
2105 Re-align the table without moving the cursor.
2107 @orgcmd{<TAB>,org-table-next-field}
2108 Re-align the table, move to the next field. Creates a new row if
2111 @orgcmd{S-@key{TAB},org-table-previous-field}
2112 Re-align, move to previous field.
2114 @orgcmd{@key{RET},org-table-next-row}
2115 Re-align the table and move down to next row. Creates a new row if
2116 necessary. At the beginning or end of a line, @key{RET} still does
2117 NEWLINE, so it can be used to split a table.
2119 @orgcmd{M-a,org-table-beginning-of-field}
2120 Move to beginning of the current table field, or on to the previous field.
2121 @orgcmd{M-e,org-table-end-of-field}
2122 Move to end of the current table field, or on to the next field.
2124 @tsubheading{Column and row editing}
2125 @orgcmdkkcc{M-@key{left},M-@key{right},org-table-move-column-left,org-table-move-column-right}
2126 Move the current column left/right.
2128 @orgcmd{M-S-@key{left},org-table-delete-column}
2129 Kill the current column.
2131 @orgcmd{M-S-@key{right},org-table-insert-column}
2132 Insert a new column to the left of the cursor position.
2134 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-move-row-up,org-table-move-row-down}
2135 Move the current row up/down.
2137 @orgcmd{M-S-@key{up},org-table-kill-row}
2138 Kill the current row or horizontal line.
2140 @orgcmd{M-S-@key{down},org-table-insert-row}
2141 Insert a new row above the current row. With a prefix argument, the line is
2142 created below the current one.
2144 @orgcmd{C-c -,org-table-insert-hline}
2145 Insert a horizontal line below current row. With a prefix argument, the line
2146 is created above the current line.
2148 @orgcmd{C-c @key{RET},org-table-hline-and-move}
2149 Insert a horizontal line below current row, and move the cursor into the row
2152 @orgcmd{C-c ^,org-table-sort-lines}
2153 Sort the table lines in the region. The position of point indicates the
2154 column to be used for sorting, and the range of lines is the range
2155 between the nearest horizontal separator lines, or the entire table. If
2156 point is before the first column, you will be prompted for the sorting
2157 column. If there is an active region, the mark specifies the first line
2158 and the sorting column, while point should be in the last line to be
2159 included into the sorting. The command prompts for the sorting type
2160 (alphabetically, numerically, or by time). When called with a prefix
2161 argument, alphabetic sorting will be case-sensitive.
2163 @tsubheading{Regions}
2164 @orgcmd{C-c C-x M-w,org-table-copy-region}
2165 Copy a rectangular region from a table to a special clipboard. Point and
2166 mark determine edge fields of the rectangle. If there is no active region,
2167 copy just the current field. The process ignores horizontal separator lines.
2169 @orgcmd{C-c C-x C-w,org-table-cut-region}
2170 Copy a rectangular region from a table to a special clipboard, and
2171 blank all fields in the rectangle. So this is the ``cut'' operation.
2173 @orgcmd{C-c C-x C-y,org-table-paste-rectangle}
2174 Paste a rectangular region into a table.
2175 The upper left corner ends up in the current field. All involved fields
2176 will be overwritten. If the rectangle does not fit into the present table,
2177 the table is enlarged as needed. The process ignores horizontal separator
2180 @orgcmd{M-@key{RET},org-table-wrap-region}
2181 Split the current field at the cursor position and move the rest to the line
2182 below. If there is an active region, and both point and mark are in the same
2183 column, the text in the column is wrapped to minimum width for the given
2184 number of lines. A numeric prefix argument may be used to change the number
2185 of desired lines. If there is no region, but you specify a prefix argument,
2186 the current field is made blank, and the content is appended to the field
2189 @tsubheading{Calculations}
2190 @cindex formula, in tables
2191 @cindex calculations, in tables
2192 @cindex region, active
2193 @cindex active region
2194 @cindex transient mark mode
2195 @orgcmd{C-c +,org-table-sum}
2196 Sum the numbers in the current column, or in the rectangle defined by
2197 the active region. The result is shown in the echo area and can
2198 be inserted with @kbd{C-y}.
2200 @orgcmd{S-@key{RET},org-table-copy-down}
2201 @vindex org-table-copy-increment
2202 When current field is empty, copy from first non-empty field above. When not
2203 empty, copy current field down to next row and move cursor along with it.
2204 Depending on the variable @code{org-table-copy-increment}, integer field
2205 values will be incremented during copy. Integers that are too large will not
2206 be incremented. Also, a @code{0} prefix argument temporarily disables the
2207 increment. This key is also used by shift-selection and related modes
2208 (@pxref{Conflicts}).
2210 @tsubheading{Miscellaneous}
2211 @orgcmd{C-c `,org-table-edit-field}
2212 Edit the current field in a separate window. This is useful for fields that
2213 are not fully visible (@pxref{Column width and alignment}). When called with
2214 a @kbd{C-u} prefix, just make the full field visible, so that it can be
2215 edited in place. When called with two @kbd{C-u} prefixes, make the editor
2216 window follow the cursor through the table and always show the current
2217 field. The follow mode exits automatically when the cursor leaves the table,
2218 or when you repeat this command with @kbd{C-u C-u C-c `}.
2220 @item M-x org-table-import
2221 Import a file as a table. The table should be TAB or whitespace
2222 separated. Use, for example, to import a spreadsheet table or data
2223 from a database, because these programs generally can write
2224 TAB-separated text files. This command works by inserting the file into
2225 the buffer and then converting the region to a table. Any prefix
2226 argument is passed on to the converter, which uses it to determine the
2228 @orgcmd{C-c |,org-table-create-or-convert-from-region}
2229 Tables can also be imported by pasting tabular text into the Org
2230 buffer, selecting the pasted text with @kbd{C-x C-x} and then using the
2231 @kbd{C-c |} command (see above under @i{Creation and conversion}).
2233 @item M-x org-table-export
2234 @findex org-table-export
2235 @vindex org-table-export-default-format
2236 Export the table, by default as a TAB-separated file. Use for data
2237 exchange with, for example, spreadsheet or database programs. The format
2238 used to export the file can be configured in the variable
2239 @code{org-table-export-default-format}. You may also use properties
2240 @code{TABLE_EXPORT_FILE} and @code{TABLE_EXPORT_FORMAT} to specify the file
2241 name and the format for table export in a subtree. Org supports quite
2242 general formats for exported tables. The exporter format is the same as the
2243 format used by Orgtbl radio tables, see @ref{Translator functions}, for a
2244 detailed description.
2247 If you don't like the automatic table editor because it gets in your
2248 way on lines which you would like to start with @samp{|}, you can turn
2252 (setq org-enable-table-editor nil)
2255 @noindent Then the only table command that still works is
2256 @kbd{C-c C-c} to do a manual re-align.
2258 @node Column width and alignment, Column groups, Built-in table editor, Tables
2259 @section Column width and alignment
2260 @cindex narrow columns in tables
2261 @cindex alignment in tables
2263 The width of columns is automatically determined by the table editor. And
2264 also the alignment of a column is determined automatically from the fraction
2265 of number-like versus non-number fields in the column.
2267 Sometimes a single field or a few fields need to carry more text, leading to
2268 inconveniently wide columns. Or maybe you want to make a table with several
2269 columns having a fixed width, regardless of content. To set@footnote{This
2270 feature does not work on XEmacs.} the width of a column, one field anywhere
2271 in the column may contain just the string @samp{<N>} where @samp{N} is an
2272 integer specifying the width of the column in characters. The next re-align
2273 will then set the width of this column to this value.
2277 |---+------------------------------| |---+--------|
2279 | 1 | one | | 1 | one |
2280 | 2 | two | ----\ | 2 | two |
2281 | 3 | This is a long chunk of text | ----/ | 3 | This=> |
2282 | 4 | four | | 4 | four |
2283 |---+------------------------------| |---+--------|
2288 Fields that are wider become clipped and end in the string @samp{=>}.
2289 Note that the full text is still in the buffer but is hidden.
2290 To see the full text, hold the mouse over the field---a tool-tip window
2291 will show the full content. To edit such a field, use the command
2292 @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will
2293 open a new window with the full field. Edit it and finish with @kbd{C-c
2296 @vindex org-startup-align-all-tables
2297 When visiting a file containing a table with narrowed columns, the
2298 necessary character hiding has not yet happened, and the table needs to
2299 be aligned before it looks nice. Setting the option
2300 @code{org-startup-align-all-tables} will realign all tables in a file
2301 upon visiting, but also slow down startup. You can also set this option
2302 on a per-file basis with:
2309 If you would like to overrule the automatic alignment of number-rich columns
2310 to the right and of string-rich column to the left, you can use @samp{<r>},
2311 @samp{<c>}@footnote{Centering does not work inside Emacs, but it does have an
2312 effect when exporting to HTML.} or @samp{<l>} in a similar fashion. You may
2313 also combine alignment and field width like this: @samp{<l10>}.
2315 Lines which only contain these formatting cookies will be removed
2316 automatically when exporting the document.
2318 @node Column groups, Orgtbl mode, Column width and alignment, Tables
2319 @section Column groups
2320 @cindex grouping columns in tables
2322 When Org exports tables, it does so by default without vertical
2323 lines because that is visually more satisfying in general. Occasionally
2324 however, vertical lines can be useful to structure a table into groups
2325 of columns, much like horizontal lines can do for groups of rows. In
2326 order to specify column groups, you can use a special row where the
2327 first field contains only @samp{/}. The further fields can either
2328 contain @samp{<} to indicate that this column should start a group,
2329 @samp{>} to indicate the end of a column, or @samp{<>} (no space between @samp{<}
2330 and @samp{>}) to make a column
2331 a group of its own. Boundaries between column groups will upon export be
2332 marked with vertical lines. Here is an example:
2335 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2336 |---+-----+-----+-----+---------+------------|
2337 | / | < | | > | < | > |
2338 | 1 | 1 | 1 | 1 | 1 | 1 |
2339 | 2 | 4 | 8 | 16 | 1.4142 | 1.1892 |
2340 | 3 | 9 | 27 | 81 | 1.7321 | 1.3161 |
2341 |---+-----+-----+-----+---------+------------|
2342 #+TBLFM: $2=$1^2::$3=$1^3::$4=$1^4::$5=sqrt($1)::$6=sqrt(sqrt(($1)))
2345 It is also sufficient to just insert the column group starters after
2346 every vertical line you would like to have:
2349 | N | N^2 | N^3 | N^4 | sqrt(n) | sqrt[4](N) |
2350 |----+-----+-----+-----+---------+------------|
2354 @node Orgtbl mode, The spreadsheet, Column groups, Tables
2355 @section The Orgtbl minor mode
2357 @cindex minor mode for tables
2359 If you like the intuitive way the Org table editor works, you
2360 might also want to use it in other modes like Text mode or Mail mode.
2361 The minor mode Orgtbl mode makes this possible. You can always toggle
2362 the mode with @kbd{M-x orgtbl-mode}. To turn it on by default, for
2363 example in Message mode, use
2366 (add-hook 'message-mode-hook 'turn-on-orgtbl)
2369 Furthermore, with some special setup, it is possible to maintain tables
2370 in arbitrary syntax with Orgtbl mode. For example, it is possible to
2371 construct @LaTeX{} tables with the underlying ease and power of
2372 Orgtbl mode, including spreadsheet capabilities. For details, see
2373 @ref{Tables in arbitrary syntax}.
2375 @node The spreadsheet, Org-Plot, Orgtbl mode, Tables
2376 @section The spreadsheet
2377 @cindex calculations, in tables
2378 @cindex spreadsheet capabilities
2379 @cindex @file{calc} package
2381 The table editor makes use of the Emacs @file{calc} package to implement
2382 spreadsheet-like capabilities. It can also evaluate Emacs Lisp forms to
2383 derive fields from other fields. While fully featured, Org's implementation
2384 is not identical to other spreadsheets. For example, Org knows the concept
2385 of a @emph{column formula} that will be applied to all non-header fields in a
2386 column without having to copy the formula to each relevant field. There is
2387 also a formula debugger, and a formula editor with features for highlighting
2388 fields in the table corresponding to the references at the point in the
2389 formula, moving these references by arrow keys
2392 * References:: How to refer to another field or range
2393 * Formula syntax for Calc:: Using Calc to compute stuff
2394 * Formula syntax for Lisp:: Writing formulas in Emacs Lisp
2395 * Durations and time values:: How to compute durations and time values
2396 * Field and range formulas:: Formula for specific (ranges of) fields
2397 * Column formulas:: Formulas valid for an entire column
2398 * Lookup functions:: Lookup functions for searching tables
2399 * Editing and debugging formulas:: Fixing formulas
2400 * Updating the table:: Recomputing all dependent fields
2401 * Advanced features:: Field and column names, parameters and automatic recalc
2404 @node References, Formula syntax for Calc, The spreadsheet, The spreadsheet
2405 @subsection References
2408 To compute fields in the table from other fields, formulas must
2409 reference other fields or ranges. In Org, fields can be referenced
2410 by name, by absolute coordinates, and by relative coordinates. To find
2411 out what the coordinates of a field are, press @kbd{C-c ?} in that
2412 field, or press @kbd{C-c @}} to toggle the display of a grid.
2414 @subsubheading Field references
2415 @cindex field references
2416 @cindex references, to fields
2418 Formulas can reference the value of another field in two ways. Like in
2419 any other spreadsheet, you may reference fields with a letter/number
2420 combination like @code{B3}, meaning the 2nd field in the 3rd row.
2421 @vindex org-table-use-standard-references
2422 However, Org prefers@footnote{Org will understand references typed by the
2423 user as @samp{B4}, but it will not use this syntax when offering a formula
2424 for editing. You can customize this behavior using the variable
2425 @code{org-table-use-standard-references}.} to use another, more general
2426 representation that looks like this:
2428 @@@var{row}$@var{column}
2431 Column specifications can be absolute like @code{$1},
2432 @code{$2},...@code{$@var{N}}, or relative to the current column (i.e., the
2433 column of the field which is being computed) like @code{$+1} or @code{$-2}.
2434 @code{$<} and @code{$>} are immutable references to the first and last
2435 column, respectively, and you can use @code{$>>>} to indicate the third
2436 column from the right.
2438 The row specification only counts data lines and ignores horizontal separator
2439 lines (hlines). Like with columns, you can use absolute row numbers
2440 @code{@@1}, @code{@@2},...@code{@@@var{N}}, and row numbers relative to the
2441 current row like @code{@@+3} or @code{@@-1}. @code{@@<} and @code{@@>} are
2442 immutable references the first and last@footnote{For backward compatibility
2443 you can also use special names like @code{$LR5} and @code{$LR12} to refer in
2444 a stable way to the 5th and 12th field in the last row of the table.
2445 However, this syntax is deprecated, it should not be used for new documents.
2446 Use @code{@@>$} instead.} row in the table, respectively. You may also
2447 specify the row relative to one of the hlines: @code{@@I} refers to the first
2448 hline, @code{@@II} to the second, etc. @code{@@-I} refers to the first such
2449 line above the current line, @code{@@+I} to the first such line below the
2450 current line. You can also write @code{@@III+2} which is the second data line
2451 after the third hline in the table.
2453 @code{@@0} and @code{$0} refer to the current row and column, respectively,
2454 i.e., to the row/column for the field being computed. Also, if you omit
2455 either the column or the row part of the reference, the current row/column is
2458 Org's references with @emph{unsigned} numbers are fixed references
2459 in the sense that if you use the same reference in the formula for two
2460 different fields, the same field will be referenced each time.
2461 Org's references with @emph{signed} numbers are floating
2462 references because the same reference operator can reference different
2463 fields depending on the field being calculated by the formula.
2465 Here are a few examples:
2468 @@2$3 @r{2nd row, 3rd column (same as @code{C2})}
2469 $5 @r{column 5 in the current row (same as @code{E&})}
2470 @@2 @r{current column, row 2}
2471 @@-1$-3 @r{the field one row up, three columns to the left}
2472 @@-I$2 @r{field just under hline above current row, column 2}
2473 @@>$5 @r{field in the last row, in column 5}
2476 @subsubheading Range references
2477 @cindex range references
2478 @cindex references, to ranges
2480 You may reference a rectangular range of fields by specifying two field
2481 references connected by two dots @samp{..}. If both fields are in the
2482 current row, you may simply use @samp{$2..$7}, but if at least one field
2483 is in a different row, you need to use the general @code{@@row$column}
2484 format at least for the first field (i.e the reference must start with
2485 @samp{@@} in order to be interpreted correctly). Examples:
2488 $1..$3 @r{first three fields in the current row}
2489 $P..$Q @r{range, using column names (see under Advanced)}
2490 $<<<..$>> @r{start in third column, continue to the one but last}
2491 @@2$1..@@4$3 @r{6 fields between these two fields (same as @code{A2..C4})}
2492 @@-1$-2..@@-1 @r{3 numbers from the column to the left, 2 up to current row}
2493 @@I..II @r{between first and second hline, short for @code{@@I..@@II}}
2496 @noindent Range references return a vector of values that can be fed
2497 into Calc vector functions. Empty fields in ranges are normally
2498 suppressed, so that the vector contains only the non-empty fields (but
2499 see the @samp{E} mode switch below). If there are no non-empty fields,
2500 @samp{[0]} is returned to avoid syntax errors in formulas.
2502 @subsubheading Field coordinates in formulas
2503 @cindex field coordinates
2504 @cindex coordinates, of field
2505 @cindex row, of field coordinates
2506 @cindex column, of field coordinates
2508 For Calc formulas and Lisp formulas @code{@@#} and @code{$#} can be used to
2509 get the row or column number of the field where the formula result goes.
2510 The traditional Lisp formula equivalents are @code{org-table-current-dline}
2511 and @code{org-table-current-column}. Examples:
2514 if(@@# % 2, $#, string("")) @r{column number on odd lines only}
2515 $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into}
2516 @r{column 3 of the current table}
2519 @noindent For the second example, table FOO must have at least as many rows
2520 as the current table. Note that this is inefficient@footnote{The computation time scales as
2521 O(N^2) because table FOO is parsed for each field to be copied.} for large
2524 @subsubheading Named references
2525 @cindex named references
2526 @cindex references, named
2527 @cindex name, of column or field
2528 @cindex constants, in calculations
2531 @vindex org-table-formula-constants
2532 @samp{$name} is interpreted as the name of a column, parameter or
2533 constant. Constants are defined globally through the variable
2534 @code{org-table-formula-constants}, and locally (for the file) through a
2538 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
2542 @vindex constants-unit-system
2543 @pindex constants.el
2544 Also properties (@pxref{Properties and Columns}) can be used as
2545 constants in table formulas: for a property @samp{:Xyz:} use the name
2546 @samp{$PROP_Xyz}, and the property will be searched in the current
2547 outline entry and in the hierarchy above it. If you have the
2548 @file{constants.el} package, it will also be used to resolve constants,
2549 including natural constants like @samp{$h} for Planck's constant, and
2550 units like @samp{$km} for kilometers@footnote{@file{constants.el} can
2551 supply the values of constants in two different unit systems, @code{SI}
2552 and @code{cgs}. Which one is used depends on the value of the variable
2553 @code{constants-unit-system}. You can use the @code{#+STARTUP} options
2554 @code{constSI} and @code{constcgs} to set this value for the current
2555 buffer.}. Column names and parameters can be specified in special table
2556 lines. These are described below, see @ref{Advanced features}. All
2557 names must start with a letter, and further consist of letters and
2560 @subsubheading Remote references
2561 @cindex remote references
2562 @cindex references, remote
2563 @cindex references, to a different table
2564 @cindex name, of column or field
2565 @cindex constants, in calculations
2568 You may also reference constants, fields and ranges from a different table,
2569 either in the current file or even in a different file. The syntax is
2572 remote(NAME-OR-ID,REF)
2576 where NAME can be the name of a table in the current file as set by a
2577 @code{#+TBLNAME: NAME} line before the table. It can also be the ID of an
2578 entry, even in a different file, and the reference then refers to the first
2579 table in that entry. REF is an absolute field or range reference as
2580 described above for example @code{@@3$3} or @code{$somename}, valid in the
2583 @node Formula syntax for Calc, Formula syntax for Lisp, References, The spreadsheet
2584 @subsection Formula syntax for Calc
2585 @cindex formula syntax, Calc
2586 @cindex syntax, of formulas
2588 A formula can be any algebraic expression understood by the Emacs
2589 @file{Calc} package. @b{Note that @file{calc} has the
2590 non-standard convention that @samp{/} has lower precedence than
2591 @samp{*}, so that @samp{a/b*c} is interpreted as @samp{a/(b*c)}.} Before
2592 evaluation by @code{calc-eval} (@pxref{Calling Calc from
2593 Your Programs, calc-eval, Calling Calc from Your Lisp Programs, calc, GNU
2594 Emacs Calc Manual}),
2595 variable substitution takes place according to the rules described above.
2596 @cindex vectors, in table calculations
2597 The range vectors can be directly fed into the Calc vector functions
2598 like @samp{vmean} and @samp{vsum}.
2600 @cindex format specifier
2601 @cindex mode, for @file{calc}
2602 @vindex org-calc-default-modes
2603 A formula can contain an optional mode string after a semicolon. This
2604 string consists of flags to influence Calc and other modes during
2605 execution. By default, Org uses the standard Calc modes (precision
2606 12, angular units degrees, fraction and symbolic modes off). The display
2607 format, however, has been changed to @code{(float 8)} to keep tables
2608 compact. The default settings can be configured using the variable
2609 @code{org-calc-default-modes}.
2612 p20 @r{set the internal Calc calculation precision to 20 digits}
2613 n3 s3 e2 f4 @r{Normal, scientific, engineering, or fixed}
2614 @r{format of the result of Calc passed back to Org.}
2615 @r{Calc formatting is unlimited in precision as}
2616 @r{long as the Calc calculation precision is greater.}
2617 D R @r{angle modes: degrees, radians}
2618 F S @r{fraction and symbolic modes}
2619 E @r{keep empty fields in ranges and use nan (not a number)}
2620 @r{in Calc formulas for empty fields in range references and}
2621 @r{for empty field references; else suppress empty fields in}
2622 @r{range references and use 0 for empty field references, see}
2623 @r{also the notes for `Range references' in @pxref{References}}
2624 N @r{interpret all fields as numbers, use 0 for non-numbers;}
2625 @r{N has higher precedence than E (for the value of the field)}
2626 L @r{literal, for Lisp formulas only}
2630 Unless you use large integer numbers or high-precision-calculation
2631 and -display for floating point numbers you may alternatively provide a
2632 @code{printf} format specifier to reformat the Calc result after it has been
2633 passed back to Org instead of letting Calc already do the
2634 formatting@footnote{The @code{printf} reformatting is limited in precision
2635 because the value passed to it is converted into an @code{integer} or
2636 @code{double}. The @code{integer} is limited in size by truncating the
2637 signed value to 32 bits. The @code{double} is limited in precision to 64
2638 bits overall which leaves approximately 16 significant decimal digits.}.
2642 $1+$2 @r{Sum of first and second field}
2643 $1+$2;%.2f @r{Same, format result to two decimals}
2644 exp($2)+exp($1) @r{Math functions can be used}
2645 $0;%.1f @r{Reformat current cell to 1 decimal}
2646 ($3-32)*5/9 @r{Degrees F -> C conversion}
2647 $c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
2648 tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
2649 sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
2650 vmean($2..$7) @r{Compute column range mean, suppress empty fields}
2651 vmean($2..$7);EN @r{Same, but treat empty fields as 0}
2652 taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
2655 Calc also contains a complete set of logical operations. For example
2658 if($1 < 20, teen, string(""))
2659 @r{"teen" if age $1 is less than 20, else empty}
2660 if("$1" = "nan" || "$2" = "nan", string(""), $1 + $2); E
2661 @r{sum of first two columns unless one or both empty}
2664 Note that you can also use two org-specific flags @code{T} and @code{t} for
2665 durations computations @ref{Durations and time values}.
2667 You can add your own Calc functions defined in Emacs Lisp with @code{defmath}
2668 and use them in formula syntax for Calc.
2670 @node Formula syntax for Lisp, Durations and time values, Formula syntax for Calc, The spreadsheet
2671 @subsection Emacs Lisp forms as formulas
2672 @cindex Lisp forms, as table formulas
2674 It is also possible to write a formula in Emacs Lisp. This can be useful
2675 for string manipulation and control structures, if Calc's functionality is
2678 If a formula starts with a single-quote followed by an opening parenthesis,
2679 then it is evaluated as a Lisp form. The evaluation should return either a
2680 string or a number. Just as with @file{calc} formulas, you can specify modes
2681 and a printf format after a semicolon.
2683 With Emacs Lisp forms, you need to be conscious about the way field
2684 references are interpolated into the form. By default, a reference will be
2685 interpolated as a Lisp string (in double-quotes) containing the field. If
2686 you provide the @samp{N} mode switch, all referenced elements will be numbers
2687 (non-number fields will be zero) and interpolated as Lisp numbers, without
2688 quotes. If you provide the @samp{L} flag, all fields will be interpolated
2689 literally, without quotes. I.e., if you want a reference to be interpreted
2690 as a string by the Lisp form, enclose the reference operator itself in
2691 double-quotes, like @code{"$3"}. Ranges are inserted as space-separated
2692 fields, so you can embed them in list or vector syntax.
2694 Here are a few examples---note how the @samp{N} mode is used when we do
2695 computations in Lisp:
2698 @r{Swap the first two characters of the content of column 1}
2699 '(concat (substring $1 1 2) (substring $1 0 1) (substring $1 2))
2700 @r{Add columns 1 and 2, equivalent to Calc's @code{$1+$2}}
2702 @r{Compute the sum of columns 1--4, like Calc's @code{vsum($1..$4)}}
2703 '(apply '+ '($1..$4));N
2706 @node Durations and time values, Field and range formulas, Formula syntax for Lisp, The spreadsheet
2707 @subsection Durations and time values
2708 @cindex Duration, computing
2709 @cindex Time, computing
2710 @vindex org-table-duration-custom-format
2712 If you want to compute time values use the @code{T} flag, either in Calc
2713 formulas or Elisp formulas:
2717 | Task 1 | Task 2 | Total |
2718 |---------+----------+----------|
2719 | 2:12 | 1:47 | 03:59:00 |
2720 | 3:02:20 | -2:07:00 | 0.92 |
2721 #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t
2725 Input duration values must be of the form @code{[HH:MM[:SS]}, where seconds
2726 are optional. With the @code{T} flag, computed durations will be displayed
2727 as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag,
2728 computed durations will be displayed according to the value of the variable
2729 @code{org-table-duration-custom-format}, which defaults to @code{'hours} and
2730 will display the result as a fraction of hours (see the second formula in the
2733 Negative duration values can be manipulated as well, and integers will be
2734 considered as seconds in addition and subtraction.
2736 @node Field and range formulas, Column formulas, Durations and time values, The spreadsheet
2737 @subsection Field and range formulas
2738 @cindex field formula
2739 @cindex range formula
2740 @cindex formula, for individual table field
2741 @cindex formula, for range of fields
2743 To assign a formula to a particular field, type it directly into the field,
2744 preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press
2745 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2746 the formula will be stored as the formula for this field, evaluated, and the
2747 current field will be replaced with the result.
2750 Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
2751 below the table. If you type the equation in the 4th field of the 3rd data
2752 line in the table, the formula will look like @samp{@@3$4=$1+$2}. When
2753 inserting/deleting/swapping column and rows with the appropriate commands,
2754 @i{absolute references} (but not relative ones) in stored formulas are
2755 modified in order to still reference the same field. To avoid this from
2756 happening, in particular in range references, anchor ranges at the table
2757 borders (using @code{@@<}, @code{@@>}, @code{$<}, @code{$>}), or at hlines
2758 using the @code{@@I} notation. Automatic adaptation of field references does
2759 of course not happen if you edit the table structure with normal editing
2760 commands---then you must fix the equations yourself.
2762 Instead of typing an equation into the field, you may also use the following
2766 @orgcmd{C-u C-c =,org-table-eval-formula}
2767 Install a new formula for the current field. The command prompts for a
2768 formula with default taken from the @samp{#+TBLFM:} line, applies
2769 it to the current field, and stores it.
2772 The left-hand side of a formula can also be a special expression in order to
2773 assign the formula to a number of different fields. There is no keyboard
2774 shortcut to enter such range formulas. To add them, use the formula editor
2775 (@pxref{Editing and debugging formulas}) or edit the @code{#+TBLFM:} line
2780 Column formula, valid for the entire column. This is so common that Org
2781 treats these formulas in a special way, see @ref{Column formulas}.
2783 Row formula, applies to all fields in the specified row. @code{@@>=} means
2786 Range formula, applies to all fields in the given rectangular range. This
2787 can also be used to assign a formula to some but not all fields in a row.
2789 Named field, see @ref{Advanced features}.
2792 @node Column formulas, Lookup functions, Field and range formulas, The spreadsheet
2793 @subsection Column formulas
2794 @cindex column formula
2795 @cindex formula, for table column
2797 When you assign a formula to a simple column reference like @code{$3=}, the
2798 same formula will be used in all fields of that column, with the following
2799 very convenient exceptions: (i) If the table contains horizontal separator
2800 hlines with rows above and below, everything before the first such hline is
2801 considered part of the table @emph{header} and will not be modified by column
2802 formulas. Therefore a header is mandatory when you use column formulas and
2803 want to add hlines to group rows, like for example to separate a total row at
2804 the bottom from the summand rows above. (ii) Fields that already get a value
2805 from a field/range formula will be left alone by column formulas. These
2806 conditions make column formulas very easy to use.
2808 To assign a formula to a column, type it directly into any field in the
2809 column, preceded by an equal sign, like @samp{=$1+$2}. When you press
2810 @key{TAB} or @key{RET} or @kbd{C-c C-c} with the cursor still in the field,
2811 the formula will be stored as the formula for the current column, evaluated
2812 and the current field replaced with the result. If the field contains only
2813 @samp{=}, the previously stored formula for this column is used. For each
2814 column, Org will only remember the most recently used formula. In the
2815 @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The
2816 left-hand side of a column formula can not be the name of column, it must be
2817 the numeric column reference or @code{$>}.
2819 Instead of typing an equation into the field, you may also use the
2823 @orgcmd{C-c =,org-table-eval-formula}
2824 Install a new formula for the current column and replace current field with
2825 the result of the formula. The command prompts for a formula, with default
2826 taken from the @samp{#+TBLFM} line, applies it to the current field and
2827 stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command
2828 will apply it to that many consecutive fields in the current column.
2831 @node Lookup functions, Editing and debugging formulas, Column formulas, The spreadsheet
2832 @subsection Lookup functions
2833 @cindex lookup functions in tables
2834 @cindex table lookup functions
2836 Org has three predefined Emacs Lisp functions for lookups in tables.
2838 @item (org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)
2839 @findex org-lookup-first
2840 Searches for the first element @code{S} in list @code{S-LIST} for which
2844 is @code{t}; returns the value from the corresponding position in list
2845 @code{R-LIST}. The default @code{PREDICATE} is @code{equal}. Note that the
2846 parameters @code{VAL} and @code{S} are passed to @code{PREDICATE} in the same
2847 order as the correspoding parameters are in the call to
2848 @code{org-lookup-first}, where @code{VAL} precedes @code{S-LIST}. If
2849 @code{R-LIST} is @code{nil}, the matching element @code{S} of @code{S-LIST}
2851 @item (org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)
2852 @findex org-lookup-last
2853 Similar to @code{org-lookup-first} above, but searches for the @i{last}
2854 element for which @code{PREDICATE} is @code{t}.
2855 @item (org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)
2856 @findex org-lookup-all
2857 Similar to @code{org-lookup-first}, but searches for @i{all} elements for
2858 which @code{PREDICATE} is @code{t}, and returns @i{all} corresponding
2859 values. This function can not be used by itself in a formula, because it
2860 returns a list of values. However, powerful lookups can be built when this
2861 function is combined with other Emacs Lisp functions.
2864 If the ranges used in these functions contain empty fields, the @code{E} mode
2865 for the formula should usually be specified: otherwise empty fields will not be
2866 included in @code{S-LIST} and/or @code{R-LIST} which can, for example, result
2867 in an incorrect mapping from an element of @code{S-LIST} to the corresponding
2868 element of @code{R-LIST}.
2870 These three functions can be used to implement associative arrays, count
2871 matching cells, rank results, group data etc. For practical examples
2872 see @uref{http://orgmode.org/worg/org-tutorials/org-lookups.html, this
2875 @node Editing and debugging formulas, Updating the table, Lookup functions, The spreadsheet
2876 @subsection Editing and debugging formulas
2877 @cindex formula editing
2878 @cindex editing, of table formulas
2880 @vindex org-table-use-standard-references
2881 You can edit individual formulas in the minibuffer or directly in the
2882 field. Org can also prepare a special buffer with all active
2883 formulas of a table. When offering a formula for editing, Org
2884 converts references to the standard format (like @code{B3} or @code{D&})
2885 if possible. If you prefer to only work with the internal format (like
2886 @code{@@3$2} or @code{$4}), configure the variable
2887 @code{org-table-use-standard-references}.
2890 @orgcmdkkc{C-c =,C-u C-c =,org-table-eval-formula}
2891 Edit the formula associated with the current column/field in the
2892 minibuffer. See @ref{Column formulas}, and @ref{Field and range formulas}.
2893 @orgcmd{C-u C-u C-c =,org-table-eval-formula}
2894 Re-insert the active formula (either a
2895 field formula, or a column formula) into the current field, so that you
2896 can edit it directly in the field. The advantage over editing in the
2897 minibuffer is that you can use the command @kbd{C-c ?}.
2898 @orgcmd{C-c ?,org-table-field-info}
2899 While editing a formula in a table field, highlight the field(s)
2900 referenced by the reference at the cursor position in the formula.
2902 @findex org-table-toggle-coordinate-overlays
2904 Toggle the display of row and column numbers for a table, using overlays
2905 (@command{org-table-toggle-coordinate-overlays}). These are updated each
2906 time the table is aligned; you can force it with @kbd{C-c C-c}.
2908 @findex org-table-toggle-formula-debugger
2910 Toggle the formula debugger on and off
2911 (@command{org-table-toggle-formula-debugger}). See below.
2912 @orgcmd{C-c ',org-table-edit-formulas}
2913 Edit all formulas for the current table in a special buffer, where the
2914 formulas will be displayed one per line. If the current field has an
2915 active formula, the cursor in the formula editor will mark it.
2916 While inside the special buffer, Org will automatically highlight
2917 any field or range reference at the cursor position. You may edit,
2918 remove and add formulas, and use the following commands:
2920 @orgcmdkkc{C-c C-c,C-x C-s,org-table-fedit-finish}
2921 Exit the formula editor and store the modified formulas. With @kbd{C-u}
2922 prefix, also apply the new formulas to the entire table.
2923 @orgcmd{C-c C-q,org-table-fedit-abort}
2924 Exit the formula editor without installing changes.
2925 @orgcmd{C-c C-r,org-table-fedit-toggle-ref-type}
2926 Toggle all references in the formula editor between standard (like
2927 @code{B3}) and internal (like @code{@@3$2}).
2928 @orgcmd{@key{TAB},org-table-fedit-lisp-indent}
2929 Pretty-print or indent Lisp formula at point. When in a line containing
2930 a Lisp formula, format the formula according to Emacs Lisp rules.
2931 Another @key{TAB} collapses the formula back again. In the open
2932 formula, @key{TAB} re-indents just like in Emacs Lisp mode.
2933 @orgcmd{M-@key{TAB},lisp-complete-symbol}
2934 Complete Lisp symbols, just like in Emacs Lisp mode.
2936 @kindex S-@key{down}
2937 @kindex S-@key{left}
2938 @kindex S-@key{right}
2939 @findex org-table-fedit-ref-up
2940 @findex org-table-fedit-ref-down
2941 @findex org-table-fedit-ref-left
2942 @findex org-table-fedit-ref-right
2943 @item S-@key{up}/@key{down}/@key{left}/@key{right}
2944 Shift the reference at point. For example, if the reference is
2945 @code{B3} and you press @kbd{S-@key{right}}, it will become @code{C3}.
2946 This also works for relative references and for hline references.
2947 @orgcmdkkcc{M-S-@key{up},M-S-@key{down},org-table-fedit-line-up,org-table-fedit-line-down}
2948 Move the test line for column formulas in the Org buffer up and
2950 @orgcmdkkcc{M-@key{up},M-@key{down},org-table-fedit-scroll-down,org-table-fedit-scroll-up}
2951 Scroll the window displaying the table.
2953 @findex org-table-toggle-coordinate-overlays
2955 Turn the coordinate grid in the table on and off.
2959 Making a table field blank does not remove the formula associated with
2960 the field, because that is stored in a different line (the @samp{#+TBLFM}
2961 line)---during the next recalculation the field will be filled again.
2962 To remove a formula from a field, you have to give an empty reply when
2963 prompted for the formula, or to edit the @samp{#+TBLFM} line.
2966 You may edit the @samp{#+TBLFM} directly and re-apply the changed
2967 equations with @kbd{C-c C-c} in that line or with the normal
2968 recalculation commands in the table.
2970 @subsubheading Debugging formulas
2971 @cindex formula debugging
2972 @cindex debugging, of table formulas
2973 When the evaluation of a formula leads to an error, the field content
2974 becomes the string @samp{#ERROR}. If you would like see what is going
2975 on during variable substitution and calculation in order to find a bug,
2976 turn on formula debugging in the @code{Tbl} menu and repeat the
2977 calculation, for example by pressing @kbd{C-u C-u C-c = @key{RET}} in a
2978 field. Detailed information will be displayed.
2980 @node Updating the table, Advanced features, Editing and debugging formulas, The spreadsheet
2981 @subsection Updating the table
2982 @cindex recomputing table fields
2983 @cindex updating, table
2985 Recalculation of a table is normally not automatic, but needs to be
2986 triggered by a command. See @ref{Advanced features}, for a way to make
2987 recalculation at least semi-automatic.
2989 In order to recalculate a line of a table or the entire table, use the
2993 @orgcmd{C-c *,org-table-recalculate}
2994 Recalculate the current row by first applying the stored column formulas
2995 from left to right, and all field/range formulas in the current row.
3001 Recompute the entire table, line by line. Any lines before the first
3002 hline are left alone, assuming that these are part of the table header.
3004 @orgcmdkkc{C-u C-u C-c *,C-u C-u C-c C-c,org-table-iterate}
3005 Iterate the table by recomputing it until no further changes occur.
3006 This may be necessary if some computed fields use the value of other
3007 fields that are computed @i{later} in the calculation sequence.
3008 @item M-x org-table-recalculate-buffer-tables
3009 @findex org-table-recalculate-buffer-tables
3010 Recompute all tables in the current buffer.
3011 @item M-x org-table-iterate-buffer-tables
3012 @findex org-table-iterate-buffer-tables
3013 Iterate all tables in the current buffer, in order to converge table-to-table
3017 @node Advanced features, , Updating the table, The spreadsheet
3018 @subsection Advanced features
3020 If you want the recalculation of fields to happen automatically, or if you
3021 want to be able to assign @i{names}@footnote{Such names must start by an
3022 alphabetic character and use only alphanumeric/underscore characters.} to
3023 fields and columns, you need to reserve the first column of the table for
3024 special marking characters.
3027 @orgcmd{C-#,org-table-rotate-recalc-marks}
3028 Rotate the calculation mark in first column through the states @samp{ },
3029 @samp{#}, @samp{*}, @samp{!}, @samp{$}. When there is an active region,
3030 change all marks in the region.
3033 Here is an example of a table that collects exam results of students and
3034 makes use of these features:
3038 |---+---------+--------+--------+--------+-------+------|
3039 | | Student | Prob 1 | Prob 2 | Prob 3 | Total | Note |
3040 |---+---------+--------+--------+--------+-------+------|
3041 | ! | | P1 | P2 | P3 | Tot | |
3042 | # | Maximum | 10 | 15 | 25 | 50 | 10.0 |
3043 | ^ | | m1 | m2 | m3 | mt | |
3044 |---+---------+--------+--------+--------+-------+------|
3045 | # | Peter | 10 | 8 | 23 | 41 | 8.2 |
3046 | # | Sam | 2 | 4 | 3 | 9 | 1.8 |
3047 |---+---------+--------+--------+--------+-------+------|
3048 | | Average | | | | 25.0 | |
3049 | ^ | | | | | at | |
3050 | $ | max=50 | | | | | |
3051 |---+---------+--------+--------+--------+-------+------|
3052 #+TBLFM: $6=vsum($P1..$P3)::$7=10*$Tot/$max;%.1f::$at=vmean(@@-II..@@-I);%.1f
3056 @noindent @b{Important}: please note that for these special tables,
3057 recalculating the table with @kbd{C-u C-c *} will only affect rows that
3058 are marked @samp{#} or @samp{*}, and fields that have a formula assigned
3059 to the field itself. The column formulas are not applied in rows with
3062 @cindex marking characters, tables
3063 The marking characters have the following meaning:
3066 The fields in this line define names for the columns, so that you may
3067 refer to a column as @samp{$Tot} instead of @samp{$6}.
3069 This row defines names for the fields @emph{above} the row. With such
3070 a definition, any formula in the table may use @samp{$m1} to refer to
3071 the value @samp{10}. Also, if you assign a formula to a names field, it
3072 will be stored as @samp{$name=...}.
3074 Similar to @samp{^}, but defines names for the fields in the row
3077 Fields in this row can define @emph{parameters} for formulas. For
3078 example, if a field in a @samp{$} row contains @samp{max=50}, then
3079 formulas in this table can refer to the value 50 using @samp{$max}.
3080 Parameters work exactly like constants, only that they can be defined on
3083 Fields in this row are automatically recalculated when pressing
3084 @key{TAB} or @key{RET} or @kbd{S-@key{TAB}} in this row. Also, this row
3085 is selected for a global recalculation with @kbd{C-u C-c *}. Unmarked
3086 lines will be left alone by this command.
3088 Selects this line for global recalculation with @kbd{C-u C-c *}, but
3089 not for automatic recalculation. Use this when automatic
3090 recalculation slows down editing too much.
3092 Unmarked lines are exempt from recalculation with @kbd{C-u C-c *}.
3093 All lines that should be recalculated should be marked with @samp{#}
3096 Do not export this line. Useful for lines that contain the narrowing
3097 @samp{<N>} markers or column group markers.
3100 Finally, just to whet your appetite for what can be done with the
3101 fantastic @file{calc.el} package, here is a table that computes the Taylor
3102 series of degree @code{n} at location @code{x} for a couple of
3107 |---+-------------+---+-----+--------------------------------------|
3108 | | Func | n | x | Result |
3109 |---+-------------+---+-----+--------------------------------------|
3110 | # | exp(x) | 1 | x | 1 + x |
3111 | # | exp(x) | 2 | x | 1 + x + x^2 / 2 |
3112 | # | exp(x) | 3 | x | 1 + x + x^2 / 2 + x^3 / 6 |
3113 | # | x^2+sqrt(x) | 2 | x=0 | x*(0.5 / 0) + x^2 (2 - 0.25 / 0) / 2 |
3114 | # | x^2+sqrt(x) | 2 | x=1 | 2 + 2.5 x - 2.5 + 0.875 (x - 1)^2 |
3115 | * | tan(x) | 3 | x | 0.0175 x + 1.77e-6 x^3 |
3116 |---+-------------+---+-----+--------------------------------------|
3117 #+TBLFM: $5=taylor($2,$4,$3);n3
3121 @node Org-Plot, , The spreadsheet, Tables
3123 @cindex graph, in tables
3124 @cindex plot tables using Gnuplot
3127 Org-Plot can produce 2D and 3D graphs of information stored in org tables
3128 using @file{Gnuplot} @uref{http://www.gnuplot.info/} and @file{gnuplot-mode}
3129 @uref{http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html}. To see
3130 this in action, ensure that you have both Gnuplot and Gnuplot mode installed
3131 on your system, then call @code{org-plot/gnuplot} on the following table.
3135 #+PLOT: title:"Citas" ind:1 deps:(3) type:2d with:histograms set:"yrange [0:]"
3136 | Sede | Max cites | H-index |
3137 |-----------+-----------+---------|
3138 | Chile | 257.72 | 21.39 |
3139 | Leeds | 165.77 | 19.68 |
3140 | Sao Paolo | 71.00 | 11.50 |
3141 | Stockholm | 134.19 | 14.33 |
3142 | Morelia | 257.56 | 17.67 |
3146 Notice that Org Plot is smart enough to apply the table's headers as labels.
3147 Further control over the labels, type, content, and appearance of plots can
3148 be exercised through the @code{#+PLOT:} lines preceding a table. See below
3149 for a complete list of Org-plot options. For more information and examples
3150 see the Org-plot tutorial at
3151 @uref{http://orgmode.org/worg/org-tutorials/org-plot.html}.
3153 @subsubheading Plot Options
3157 Specify any @command{gnuplot} option to be set when graphing.
3160 Specify the title of the plot.
3163 Specify which column of the table to use as the @code{x} axis.
3166 Specify the columns to graph as a Lisp style list, surrounded by parentheses
3167 and separated by spaces for example @code{dep:(3 4)} to graph the third and
3168 fourth columns (defaults to graphing all other columns aside from the @code{ind}
3172 Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}.
3175 Specify a @code{with} option to be inserted for every col being plotted
3176 (e.g., @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...).
3177 Defaults to @code{lines}.
3180 If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}.
3183 List of labels to be used for the @code{deps} (defaults to the column headers
3187 Specify an entire line to be inserted in the Gnuplot script.
3190 When plotting @code{3d} or @code{grid} types, set this to @code{t} to graph a
3191 flat mapping rather than a @code{3d} slope.
3194 Specify format of Org mode timestamps as they will be parsed by Gnuplot.
3195 Defaults to @samp{%Y-%m-%d-%H:%M:%S}.
3198 If you want total control, you can specify a script file (place the file name
3199 between double-quotes) which will be used to plot. Before plotting, every
3200 instance of @code{$datafile} in the specified script will be replaced with
3201 the path to the generated data file. Note: even if you set this option, you
3202 may still want to specify the plot type, as that can impact the content of
3206 @node Hyperlinks, TODO Items, Tables, Top
3210 Like HTML, Org provides links inside a file, external links to
3211 other files, Usenet articles, emails, and much more.
3214 * Link format:: How links in Org are formatted
3215 * Internal links:: Links to other places in the current file
3216 * External links:: URL-like links to the world
3217 * Handling links:: Creating, inserting and following
3218 * Using links outside Org:: Linking from my C source code?
3219 * Link abbreviations:: Shortcuts for writing complex links
3220 * Search options:: Linking to a specific location
3221 * Custom searches:: When the default search is not enough
3224 @node Link format, Internal links, Hyperlinks, Hyperlinks
3225 @section Link format
3227 @cindex format, of links
3229 Org will recognize plain URL-like links and activate them as
3230 clickable links. The general link format, however, looks like this:
3233 [[link][description]] @r{or alternatively} [[link]]
3237 Once a link in the buffer is complete (all brackets present), Org
3238 will change the display so that @samp{description} is displayed instead
3239 of @samp{[[link][description]]} and @samp{link} is displayed instead of
3240 @samp{[[link]]}. Links will be highlighted in the face @code{org-link},
3241 which by default is an underlined face. You can directly edit the
3242 visible part of a link. Note that this can be either the @samp{link}
3243 part (if there is no description) or the @samp{description} part. To
3244 edit also the invisible @samp{link} part, use @kbd{C-c C-l} with the
3247 If you place the cursor at the beginning or just behind the end of the
3248 displayed text and press @key{BACKSPACE}, you will remove the
3249 (invisible) bracket at that location. This makes the link incomplete
3250 and the internals are again displayed as plain text. Inserting the
3251 missing bracket hides the link internals again. To show the
3252 internal structure of all links, use the menu entry
3253 @code{Org->Hyperlinks->Literal links}.
3255 @node Internal links, External links, Link format, Hyperlinks
3256 @section Internal links
3257 @cindex internal links
3258 @cindex links, internal
3259 @cindex targets, for links
3261 @cindex property, CUSTOM_ID
3262 If the link does not look like a URL, it is considered to be internal in the
3263 current file. The most important case is a link like
3264 @samp{[[#my-custom-id]]} which will link to the entry with the
3265 @code{CUSTOM_ID} property @samp{my-custom-id}. Such custom IDs are very good
3266 for HTML export (@pxref{HTML export}) where they produce pretty section
3267 links. You are responsible yourself to make sure these custom IDs are unique
3270 Links such as @samp{[[My Target]]} or @samp{[[My Target][Find my target]]}
3271 lead to a text search in the current file.
3273 The link can be followed with @kbd{C-c C-o} when the cursor is on the link,
3274 or with a mouse click (@pxref{Handling links}). Links to custom IDs will
3275 point to the corresponding headline. The preferred match for a text link is
3276 a @i{dedicated target}: the same string in double angular brackets. Targets
3277 may be located anywhere; sometimes it is convenient to put them into a
3278 comment line. For example
3284 @noindent In HTML export (@pxref{HTML export}), such targets will become
3285 named anchors for direct access through @samp{http} links@footnote{Note that
3286 text before the first headline is usually not exported, so the first such
3287 target should be after the first headline, or in the line directly before the
3290 If no dedicated target exists, Org will search for a headline that is exactly
3291 the link text but may also include a TODO keyword and tags@footnote{To insert
3292 a link targeting a headline, in-buffer completion can be used. Just type a
3293 star followed by a few optional letters into the buffer and press
3294 @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as
3295 completions.}. In non-Org files, the search will look for the words in the
3296 link text. In the above example the search would be for @samp{my target}.
3298 Following a link pushes a mark onto Org's own mark ring. You can
3299 return to the previous position with @kbd{C-c &}. Using this command
3300 several times in direct succession goes back to positions recorded
3304 * Radio targets:: Make targets trigger links in plain text
3307 @node Radio targets, , Internal links, Internal links
3308 @subsection Radio targets
3309 @cindex radio targets
3310 @cindex targets, radio
3311 @cindex links, radio targets
3313 Org can automatically turn any occurrences of certain target names
3314 in normal text into a link. So without explicitly creating a link, the
3315 text connects to the target radioing its position. Radio targets are
3316 enclosed by triple angular brackets. For example, a target @samp{<<<My
3317 Target>>>} causes each occurrence of @samp{my target} in normal text to
3318 become activated as a link. The Org file is scanned automatically
3319 for radio targets only when the file is first loaded into Emacs. To
3320 update the target list during editing, press @kbd{C-c C-c} with the
3321 cursor on or at a target.
3323 @node External links, Handling links, Internal links, Hyperlinks
3324 @section External links
3325 @cindex links, external
3326 @cindex external links
3327 @cindex links, external
3335 @cindex WANDERLUST links
3337 @cindex USENET links
3342 Org supports links to files, websites, Usenet and email messages,
3343 BBDB database entries and links to both IRC conversations and their
3344 logs. External links are URL-like locators. They start with a short
3345 identifying string followed by a colon. There can be no space after
3346 the colon. The following list shows examples for each link type.
3349 http://www.astro.uva.nl/~dominik @r{on the web}
3350 doi:10.1000/182 @r{DOI for an electronic resource}
3351 file:/home/dominik/images/jupiter.jpg @r{file, absolute path}
3352 /home/dominik/images/jupiter.jpg @r{same as above}
3353 file:papers/last.pdf @r{file, relative path}
3354 ./papers/last.pdf @r{same as above}
3355 file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine}
3356 /myself@@some.where:papers/last.pdf @r{same as above}
3357 file:sometextfile::NNN @r{file, jump to line number}
3358 file:projects.org @r{another Org file}
3359 file:projects.org::some words @r{text search in Org file}@footnote{
3360 The actual behavior of the search will depend on the value of
3361 the variable @code{org-link-search-must-match-exact-headline}. If its value
3362 is nil, then a fuzzy text search will be done. If it is t, then only the
3363 exact headline will be matched. If the value is @code{'query-to-create},
3364 then an exact headline will be searched; if it is not found, then the user
3365 will be queried to create it.}
3366 file:projects.org::*task title @r{heading search in Org file}
3367 file+sys:/path/to/file @r{open via OS, like double-click}
3368 file+emacs:/path/to/file @r{force opening by Emacs}
3369 docview:papers/last.pdf::NNN @r{open in doc-view mode at page}
3370 id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID}
3371 news:comp.emacs @r{Usenet link}
3372 mailto:adent@@galaxy.net @r{Mail link}
3373 vm:folder @r{VM folder link}
3374 vm:folder#id @r{VM message link}
3375 vm://myself@@some.where.org/folder#id @r{VM on remote machine}
3376 vm-imap:account:folder @r{VM IMAP folder link}
3377 vm-imap:account:folder#id @r{VM IMAP message link}
3378 wl:folder @r{WANDERLUST folder link}
3379 wl:folder#id @r{WANDERLUST message link}
3380 mhe:folder @r{MH-E folder link}
3381 mhe:folder#id @r{MH-E message link}
3382 rmail:folder @r{RMAIL folder link}
3383 rmail:folder#id @r{RMAIL message link}
3384 gnus:group @r{Gnus group link}
3385 gnus:group#id @r{Gnus article link}
3386 bbdb:R.*Stallman @r{BBDB link (with regexp)}
3387 irc:/irc.com/#emacs/bob @r{IRC link}
3388 info:org#External links @r{Info node link}
3389 shell:ls *.org @r{A shell command}
3390 elisp:org-agenda @r{Interactive Elisp command}
3391 elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate}
3394 For customizing Org to add new link types @ref{Adding hyperlink types}.
3396 A link should be enclosed in double brackets and may contain a
3397 descriptive text to be displayed instead of the URL (@pxref{Link
3398 format}), for example:
3401 [[http://www.gnu.org/software/emacs/][GNU Emacs]]
3405 If the description is a file name or URL that points to an image, HTML
3406 export (@pxref{HTML export}) will inline the image as a clickable
3407 button. If there is no description at all and the link points to an
3409 that image will be inlined into the exported HTML file.
3411 @cindex square brackets, around links
3412 @cindex plain text external links
3413 Org also finds external links in the normal text and activates them
3414 as links. If spaces must be part of the link (for example in
3415 @samp{bbdb:Richard Stallman}), or if you need to remove ambiguities
3416 about the end of the link, enclose them in square brackets.
3418 @node Handling links, Using links outside Org, External links, Hyperlinks
3419 @section Handling links
3420 @cindex links, handling
3422 Org provides methods to create a link in the correct syntax, to
3423 insert it into an Org file, and to follow the link.
3426 @orgcmd{C-c l,org-store-link}
3427 @cindex storing links
3428 Store a link to the current location. This is a @emph{global} command (you
3429 must create the key binding yourself) which can be used in any buffer to
3430 create a link. The link will be stored for later insertion into an Org
3431 buffer (see below). What kind of link will be created depends on the current
3434 @b{Org mode buffers}@*
3435 For Org files, if there is a @samp{<<target>>} at the cursor, the link points
3436 to the target. Otherwise it points to the current headline, which will also
3437 be the description@footnote{If the headline contains a timestamp, it will be
3438 removed from the link and result in a wrong link---you should avoid putting
3439 timestamp in the headline.}.
3441 @vindex org-link-to-org-use-id
3442 @cindex property, CUSTOM_ID
3443 @cindex property, ID
3444 If the headline has a @code{CUSTOM_ID} property, a link to this custom ID
3445 will be stored. In addition or alternatively (depending on the value of
3446 @code{org-link-to-org-use-id}), a globally unique @code{ID} property will be
3447 created and/or used to construct a link. So using this command in Org
3448 buffers will potentially create two links: a human-readable from the custom
3449 ID, and one that is globally unique and works even if the entry is moved from
3450 file to file. Later, when inserting the link, you need to decide which one
3453 @b{Email/News clients: VM, Rmail, Wanderlust, MH-E, Gnus}@*
3454 Pretty much all Emacs mail clients are supported. The link will point to the
3455 current article, or, in some GNUS buffers, to the group. The description is
3456 constructed from the author and the subject.
3458 @b{Web browsers: W3 and W3M}@*
3459 Here the link will be the current URL, with the page title as description.
3461 @b{Contacts: BBDB}@*
3462 Links created in a BBDB buffer will point to the current entry.
3465 @vindex org-irc-link-to-logs
3466 For IRC links, if you set the variable @code{org-irc-link-to-logs} to
3467 @code{t}, a @samp{file:/} style link to the relevant point in the logs for
3468 the current conversation is created. Otherwise an @samp{irc:/} style link to
3469 the user/channel/server under the point will be stored.
3472 For any other files, the link will point to the file, with a search string
3473 (@pxref{Search options}) pointing to the contents of the current line. If
3474 there is an active region, the selected words will form the basis of the
3475 search string. If the automatically created link is not working correctly or
3476 accurately enough, you can write custom functions to select the search string
3477 and to do the search for particular file types---see @ref{Custom searches}.
3478 The key binding @kbd{C-c l} is only a suggestion---see @ref{Installation}.
3481 When the cursor is in an agenda view, the created link points to the
3482 entry referenced by the current line.
3485 @orgcmd{C-c C-l,org-insert-link}
3486 @cindex link completion
3487 @cindex completion, of links
3488 @cindex inserting links
3489 @vindex org-keep-stored-link-after-insertion
3490 Insert a link@footnote{ Note that you don't have to use this command to
3491 insert a link. Links in Org are plain text, and you can type or paste them
3492 straight into the buffer. By using this command, the links are automatically
3493 enclosed in double brackets, and you will be asked for the optional
3494 descriptive text.}. This prompts for a link to be inserted into the buffer.
3495 You can just type a link, using text for an internal link, or one of the link
3496 type prefixes mentioned in the examples above. The link will be inserted
3497 into the buffer@footnote{After insertion of a stored link, the link will be
3498 removed from the list of stored links. To keep it in the list later use, use
3499 a triple @kbd{C-u} prefix argument to @kbd{C-c C-l}, or configure the option
3500 @code{org-keep-stored-link-after-insertion}.}, along with a descriptive text.
3501 If some text was selected when this command is called, the selected text
3502 becomes the default description.
3504 @b{Inserting stored links}@*
3505 All links stored during the
3506 current session are part of the history for this prompt, so you can access
3507 them with @key{up} and @key{down} (or @kbd{M-p/n}).
3509 @b{Completion support}@* Completion with @key{TAB} will help you to insert
3510 valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
3511 defined through link abbreviations (@pxref{Link abbreviations}). If you
3512 press @key{RET} after inserting only the @var{prefix}, Org will offer
3513 specific completion support for some link types@footnote{This works by
3514 calling a special function @code{org-PREFIX-complete-link}.} For
3515 example, if you type @kbd{file @key{RET}}, file name completion (alternative
3516 access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
3517 @key{RET}} you can complete contact names.
3519 @cindex file name completion
3520 @cindex completion, of file names
3521 When @kbd{C-c C-l} is called with a @kbd{C-u} prefix argument, a link to
3522 a file will be inserted and you may use file name completion to select
3523 the name of the file. The path to the file is inserted relative to the
3524 directory of the current Org file, if the linked file is in the current
3525 directory or in a sub-directory of it, or if the path is written relative
3526 to the current directory using @samp{../}. Otherwise an absolute path
3527 is used, if possible with @samp{~/} for your home directory. You can
3528 force an absolute path with two @kbd{C-u} prefixes.
3530 @item C-c C-l @ @r{(with cursor on existing link)}
3531 When the cursor is on an existing link, @kbd{C-c C-l} allows you to edit the
3532 link and description parts of the link.
3534 @cindex following links
3535 @orgcmd{C-c C-o,org-open-at-point}
3536 @vindex org-file-apps
3537 @vindex org-link-frame-setup
3538 Open link at point. This will launch a web browser for URLs (using
3539 @command{browse-url-at-point}), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for
3540 the corresponding links, and execute the command in a shell link. When the
3541 cursor is on an internal link, this command runs the corresponding search.
3542 When the cursor is on a TAG list in a headline, it creates the corresponding
3543 TAGS view. If the cursor is on a timestamp, it compiles the agenda for that
3544 date. Furthermore, it will visit text and remote files in @samp{file:} links
3545 with Emacs and select a suitable application for local non-text files.
3546 Classification of files is based on file extension only. See option
3547 @code{org-file-apps}. If you want to override the default application and
3548 visit the file with Emacs, use a @kbd{C-u} prefix. If you want to avoid
3549 opening in Emacs, use a @kbd{C-u C-u} prefix.@*
3550 If the cursor is on a headline, but not on a link, offer all links in the
3551 headline and entry text. If you want to setup the frame configuration for
3552 following links, customize @code{org-link-frame-setup}.
3555 @vindex org-return-follows-link
3556 When @code{org-return-follows-link} is set, @kbd{@key{RET}} will also follow
3563 On links, @kbd{mouse-2} will open the link just as @kbd{C-c C-o}
3564 would. Under Emacs 22 and later, @kbd{mouse-1} will also follow a link.
3568 @vindex org-display-internal-link-with-indirect-buffer
3569 Like @kbd{mouse-2}, but force file links to be opened with Emacs, and
3570 internal links to be displayed in another window@footnote{See the
3571 variable @code{org-display-internal-link-with-indirect-buffer}}.
3573 @orgcmd{C-c C-x C-v,org-toggle-inline-images}
3574 @cindex inlining images
3575 @cindex images, inlining
3576 @vindex org-startup-with-inline-images
3577 @cindex @code{inlineimages}, STARTUP keyword
3578 @cindex @code{noinlineimages}, STARTUP keyword
3579 Toggle the inline display of linked images. Normally this will only inline
3580 images that have no description part in the link, i.e., images that will also
3581 be inlined during export. When called with a prefix argument, also display
3582 images that do have a link description. You can ask for inline images to be
3583 displayed at startup by configuring the variable
3584 @code{org-startup-with-inline-images}@footnote{with corresponding
3585 @code{#+STARTUP} keywords @code{inlineimages} and @code{inlineimages}}.
3586 @orgcmd{C-c %,org-mark-ring-push}
3588 Push the current position onto the mark ring, to be able to return
3589 easily. Commands following an internal link do this automatically.
3591 @orgcmd{C-c &,org-mark-ring-goto}
3592 @cindex links, returning to
3593 Jump back to a recorded position. A position is recorded by the
3594 commands following internal links, and by @kbd{C-c %}. Using this
3595 command several times in direct succession moves through a ring of
3596 previously recorded positions.
3598 @orgcmdkkcc{C-c C-x C-n,C-c C-x C-p,org-next-link,org-previous-link}
3599 @cindex links, finding next/previous
3600 Move forward/backward to the next link in the buffer. At the limit of
3601 the buffer, the search fails once, and then wraps around. The key
3602 bindings for this are really too long; you might want to bind this also
3603 to @kbd{C-n} and @kbd{C-p}
3605 (add-hook 'org-load-hook
3607 (define-key org-mode-map "\C-n" 'org-next-link)
3608 (define-key org-mode-map "\C-p" 'org-previous-link)))
3612 @node Using links outside Org, Link abbreviations, Handling links, Hyperlinks
3613 @section Using links outside Org
3615 You can insert and follow links that have Org syntax not only in
3616 Org, but in any Emacs buffer. For this, you should create two
3617 global commands, like this (please select suitable global keys
3621 (global-set-key "\C-c L" 'org-insert-link-global)
3622 (global-set-key "\C-c o" 'org-open-at-point-global)
3625 @node Link abbreviations, Search options, Using links outside Org, Hyperlinks
3626 @section Link abbreviations
3627 @cindex link abbreviations
3628 @cindex abbreviation, links
3630 Long URLs can be cumbersome to type, and often many similar links are
3631 needed in a document. For this you can use link abbreviations. An
3632 abbreviated link looks like this
3635 [[linkword:tag][description]]
3639 @vindex org-link-abbrev-alist
3640 where the tag is optional.
3641 The @i{linkword} must be a word, starting with a letter, followed by
3642 letters, numbers, @samp{-}, and @samp{_}. Abbreviations are resolved
3643 according to the information in the variable @code{org-link-abbrev-alist}
3644 that relates the linkwords to replacement text. Here is an example:
3648 (setq org-link-abbrev-alist
3649 '(("bugzilla" . "http://10.1.2.9/bugzilla/show_bug.cgi?id=")
3650 ("url-to-ja" . "http://translate.google.fr/translate?sl=en&tl=ja&u=%h")
3651 ("google" . "http://www.google.com/search?q=")
3652 ("gmap" . "http://maps.google.com/maps?q=%s")
3653 ("omap" . "http://nominatim.openstreetmap.org/search?q=%s&polygon=1")
3654 ("ads" . "http://adsabs.harvard.edu/cgi-bin/nph-abs_connect?author=%s&db_key=AST")))
3658 If the replacement text contains the string @samp{%s}, it will be
3659 replaced with the tag. Using @samp{%h} instead of @samp{%s} will
3660 url-encode the tag (see the example above, where we need to encode
3661 the URL parameter.) Using @samp{%(my-function)} will pass the tag
3662 to a custom function, and replace it by the resulting string.
3664 If the replacement text don't contain any specifier, it will simply
3665 be appended to the string in order to create the link.
3667 Instead of a string, you may also specify a function that will be
3668 called with the tag as the only argument to create the link.
3670 With the above setting, you could link to a specific bug with
3671 @code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
3672 @code{[[google:OrgMode]]}, show the map location of the Free Software
3673 Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
3674 @code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
3675 what the Org author is doing besides Emacs hacking with
3676 @code{[[ads:Dominik,C]]}.
3678 If you need special abbreviations just for a single Org buffer, you
3679 can define them in the file with
3683 #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
3684 #+LINK: google http://www.google.com/search?q=%s
3688 In-buffer completion (@pxref{Completion}) can be used after @samp{[} to
3689 complete link abbreviations. You may also define a function
3690 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
3691 support for inserting such a link with @kbd{C-c C-l}. Such a function should
3692 not accept any arguments, and return the full link with prefix.
3694 @node Search options, Custom searches, Link abbreviations, Hyperlinks
3695 @section Search options in file links
3696 @cindex search option in file links
3697 @cindex file links, searching
3699 File links can contain additional information to make Emacs jump to a
3700 particular location in the file when following a link. This can be a
3701 line number or a search option after a double@footnote{For backward
3702 compatibility, line numbers can also follow a single colon.} colon. For
3703 example, when the command @kbd{C-c l} creates a link (@pxref{Handling
3704 links}) to a file, it encodes the words in the current line as a search
3705 string that can be used to find this line back later when following the
3706 link with @kbd{C-c C-o}.
3708 Here is the syntax of the different ways to attach a search to a file
3709 link, together with an explanation:
3712 [[file:~/code/main.c::255]]
3713 [[file:~/xx.org::My Target]]
3714 [[file:~/xx.org::*My Target]]
3715 [[file:~/xx.org::#my-custom-id]]
3716 [[file:~/xx.org::/regexp/]]
3723 Search for a link target @samp{<<My Target>>}, or do a text search for
3724 @samp{my target}, similar to the search in internal links, see
3725 @ref{Internal links}. In HTML export (@pxref{HTML export}), such a file
3726 link will become a HTML reference to the corresponding named anchor in
3729 In an Org file, restrict search to headlines.
3731 Link to a heading with a @code{CUSTOM_ID} property
3733 Do a regular expression search for @code{regexp}. This uses the Emacs
3734 command @code{occur} to list all matches in a separate window. If the
3735 target file is in Org mode, @code{org-occur} is used to create a
3736 sparse tree with the matches.
3737 @c If the target file is a directory,
3738 @c @code{grep} will be used to search all files in the directory.
3741 As a degenerate case, a file link with an empty file name can be used
3742 to search the current file. For example, @code{[[file:::find me]]} does
3743 a search for @samp{find me} in the current file, just as
3744 @samp{[[find me]]} would.
3746 @node Custom searches, , Search options, Hyperlinks
3747 @section Custom Searches
3748 @cindex custom search strings
3749 @cindex search strings, custom
3751 The default mechanism for creating search strings and for doing the
3752 actual search related to a file link may not work correctly in all
3753 cases. For example, Bib@TeX{} database files have many entries like
3754 @samp{year="1993"} which would not result in good search strings,
3755 because the only unique identification for a Bib@TeX{} entry is the
3758 @vindex org-create-file-search-functions
3759 @vindex org-execute-file-search-functions
3760 If you come across such a problem, you can write custom functions to set
3761 the right search string for a particular file type, and to do the search
3762 for the string in the file. Using @code{add-hook}, these functions need
3763 to be added to the hook variables
3764 @code{org-create-file-search-functions} and
3765 @code{org-execute-file-search-functions}. See the docstring for these
3766 variables for more information. Org actually uses this mechanism
3767 for Bib@TeX{} database files, and you can use the corresponding code as
3768 an implementation example. See the file @file{org-bibtex.el}.
3770 @node TODO Items, Tags, Hyperlinks, Top
3774 Org mode does not maintain TODO lists as separate documents@footnote{Of
3775 course, you can make a document that contains only long lists of TODO items,
3776 but this is not required.}. Instead, TODO items are an integral part of the
3777 notes file, because TODO items usually come up while taking notes! With Org
3778 mode, simply mark any entry in a tree as being a TODO item. In this way,
3779 information is not duplicated, and the entire context from which the TODO
3780 item emerged is always present.
3782 Of course, this technique for managing TODO items scatters them
3783 throughout your notes file. Org mode compensates for this by providing
3784 methods to give you an overview of all the things that you have to do.
3787 * TODO basics:: Marking and displaying TODO entries
3788 * TODO extensions:: Workflow and assignments
3789 * Progress logging:: Dates and notes for progress
3790 * Priorities:: Some things are more important than others
3791 * Breaking down tasks:: Splitting a task into manageable pieces
3792 * Checkboxes:: Tick-off lists
3795 @node TODO basics, TODO extensions, TODO Items, TODO Items
3796 @section Basic TODO functionality
3798 Any headline becomes a TODO item when it starts with the word
3799 @samp{TODO}, for example:
3802 *** TODO Write letter to Sam Fortune
3806 The most important commands to work with TODO entries are:
3809 @orgcmd{C-c C-t,org-todo}
3810 @cindex cycling, of TODO states
3811 @vindex org-use-fast-todo-selection
3813 Rotate the TODO state of the current item among
3816 ,-> (unmarked) -> TODO -> DONE --.
3817 '--------------------------------'
3820 If TODO keywords have fast access keys (see @ref{Fast access to TODO
3821 states}), you will be prompted for a TODO keyword through the fast selection
3822 interface; this is the default behavior when
3823 @var{org-use-fast-todo-selection} is @code{non-nil}.
3825 The same rotation can also be done ``remotely'' from the timeline and agenda
3826 buffers with the @kbd{t} command key (@pxref{Agenda commands}).
3828 @orgkey{C-u C-c C-t}
3829 When TODO keywords have no selection keys, select a specific keyword using
3830 completion; otherwise force cycling through TODO states with no prompt. When
3831 @var{org-use-fast-todo-selection} is set to @code{prefix}, use the fast
3832 selection interface.
3834 @kindex S-@key{right}
3835 @kindex S-@key{left}
3836 @item S-@key{right} @ @r{/} @ S-@key{left}
3837 @vindex org-treat-S-cursor-todo-selection-as-state-change
3838 Select the following/preceding TODO state, similar to cycling. Useful
3839 mostly if more than two TODO states are possible (@pxref{TODO
3840 extensions}). See also @ref{Conflicts}, for a discussion of the interaction
3841 with @code{shift-selection-mode}. See also the variable
3842 @code{org-treat-S-cursor-todo-selection-as-state-change}.
3843 @orgcmd{C-c / t,org-show-todo-tree}
3844 @cindex sparse tree, for TODO
3845 @vindex org-todo-keywords
3846 View TODO items in a @emph{sparse tree} (@pxref{Sparse trees}). Folds the
3847 entire buffer, but shows all TODO items (with not-DONE state) and the
3848 headings hierarchy above them. With a prefix argument (or by using @kbd{C-c
3849 / T}), search for a specific TODO@. You will be prompted for the keyword, and
3850 you can also give a list of keywords like @code{KWD1|KWD2|...} to list
3851 entries that match any one of these keywords. With a numeric prefix argument
3852 N, show the tree for the Nth keyword in the variable
3853 @code{org-todo-keywords}. With two prefix arguments, find all TODO states,
3854 both un-done and done.
3855 @orgcmd{C-c a t,org-todo-list}
3856 Show the global TODO list. Collects the TODO items (with not-DONE states)
3857 from all agenda files (@pxref{Agenda Views}) into a single buffer. The new
3858 buffer will be in @code{agenda-mode}, which provides commands to examine and
3859 manipulate the TODO entries from the new buffer (@pxref{Agenda commands}).
3860 @xref{Global TODO list}, for more information.
3861 @orgcmd{S-M-@key{RET},org-insert-todo-heading}
3862 Insert a new TODO entry below the current one.
3866 @vindex org-todo-state-tags-triggers
3867 Changing a TODO state can also trigger tag changes. See the docstring of the
3868 option @code{org-todo-state-tags-triggers} for details.
3870 @node TODO extensions, Progress logging, TODO basics, TODO Items
3871 @section Extended use of TODO keywords
3872 @cindex extended TODO keywords
3874 @vindex org-todo-keywords
3875 By default, marked TODO entries have one of only two states: TODO and
3876 DONE@. Org mode allows you to classify TODO items in more complex ways
3877 with @emph{TODO keywords} (stored in @code{org-todo-keywords}). With
3878 special setup, the TODO keyword system can work differently in different
3881 Note that @i{tags} are another way to classify headlines in general and
3882 TODO items in particular (@pxref{Tags}).
3885 * Workflow states:: From TODO to DONE in steps
3886 * TODO types:: I do this, Fred does the rest
3887 * Multiple sets in one file:: Mixing it all, and still finding your way
3888 * Fast access to TODO states:: Single letter selection of a state
3889 * Per-file keywords:: Different files, different requirements
3890 * Faces for TODO keywords:: Highlighting states
3891 * TODO dependencies:: When one task needs to wait for others
3894 @node Workflow states, TODO types, TODO extensions, TODO extensions
3895 @subsection TODO keywords as workflow states
3896 @cindex TODO workflow
3897 @cindex workflow states as TODO keywords
3899 You can use TODO keywords to indicate different @emph{sequential} states
3900 in the process of working on an item, for example@footnote{Changing
3901 this variable only becomes effective after restarting Org mode in a
3905 (setq org-todo-keywords
3906 '((sequence "TODO" "FEEDBACK" "VERIFY" "|" "DONE" "DELEGATED")))
3909 The vertical bar separates the TODO keywords (states that @emph{need
3910 action}) from the DONE states (which need @emph{no further action}). If
3911 you don't provide the separator bar, the last state is used as the DONE
3913 @cindex completion, of TODO keywords
3914 With this setup, the command @kbd{C-c C-t} will cycle an entry from TODO
3915 to FEEDBACK, then to VERIFY, and finally to DONE and DELEGATED@. You may
3916 also use a numeric prefix argument to quickly select a specific state. For
3917 example @kbd{C-3 C-c C-t} will change the state immediately to VERIFY@.
3918 Or you can use @kbd{S-@key{left}} to go backward through the sequence. If you
3919 define many keywords, you can use in-buffer completion
3920 (@pxref{Completion}) or even a special one-key selection scheme
3921 (@pxref{Fast access to TODO states}) to insert these words into the
3922 buffer. Changing a TODO state can be logged with a timestamp, see
3923 @ref{Tracking TODO state changes}, for more information.
3925 @node TODO types, Multiple sets in one file, Workflow states, TODO extensions
3926 @subsection TODO keywords as types
3928 @cindex names as TODO keywords
3929 @cindex types as TODO keywords
3931 The second possibility is to use TODO keywords to indicate different
3932 @emph{types} of action items. For example, you might want to indicate
3933 that items are for ``work'' or ``home''. Or, when you work with several
3934 people on a single project, you might want to assign action items
3935 directly to persons, by using their names as TODO keywords. This would
3936 be set up like this:
3939 (setq org-todo-keywords '((type "Fred" "Sara" "Lucy" "|" "DONE")))
3942 In this case, different keywords do not indicate a sequence, but rather
3943 different types. So the normal work flow would be to assign a task to a
3944 person, and later to mark it DONE@. Org mode supports this style by adapting
3945 the workings of the command @kbd{C-c C-t}@footnote{This is also true for the
3946 @kbd{t} command in the timeline and agenda buffers.}. When used several
3947 times in succession, it will still cycle through all names, in order to first
3948 select the right type for a task. But when you return to the item after some
3949 time and execute @kbd{C-c C-t} again, it will switch from any name directly
3950 to DONE@. Use prefix arguments or completion to quickly select a specific
3951 name. You can also review the items of a specific TODO type in a sparse tree
3952 by using a numeric prefix to @kbd{C-c / t}. For example, to see all things
3953 Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items
3954 from all agenda files into a single buffer, you would use the numeric prefix
3955 argument as well when creating the global TODO list: @kbd{C-3 C-c a t}.
3957 @node Multiple sets in one file, Fast access to TODO states, TODO types, TODO extensions
3958 @subsection Multiple keyword sets in one file
3959 @cindex TODO keyword sets
3961 Sometimes you may want to use different sets of TODO keywords in
3962 parallel. For example, you may want to have the basic
3963 @code{TODO}/@code{DONE}, but also a workflow for bug fixing, and a
3964 separate state indicating that an item has been canceled (so it is not
3965 DONE, but also does not require action). Your setup would then look
3969 (setq org-todo-keywords
3970 '((sequence "TODO" "|" "DONE")
3971 (sequence "REPORT" "BUG" "KNOWNCAUSE" "|" "FIXED")
3972 (sequence "|" "CANCELED")))
3975 The keywords should all be different, this helps Org mode to keep track
3976 of which subsequence should be used for a given entry. In this setup,
3977 @kbd{C-c C-t} only operates within a subsequence, so it switches from
3978 @code{DONE} to (nothing) to @code{TODO}, and from @code{FIXED} to
3979 (nothing) to @code{REPORT}. Therefore you need a mechanism to initially
3980 select the correct sequence. Besides the obvious ways like typing a
3981 keyword or using completion, you may also apply the following commands:
3984 @kindex C-S-@key{right}
3985 @kindex C-S-@key{left}
3986 @kindex C-u C-u C-c C-t
3987 @item C-u C-u C-c C-t
3988 @itemx C-S-@key{right}
3989 @itemx C-S-@key{left}
3990 These keys jump from one TODO subset to the next. In the above example,
3991 @kbd{C-u C-u C-c C-t} or @kbd{C-S-@key{right}} would jump from @code{TODO} or
3992 @code{DONE} to @code{REPORT}, and any of the words in the second row to
3993 @code{CANCELED}. Note that the @kbd{C-S-} key binding conflict with
3994 @code{shift-selection-mode} (@pxref{Conflicts}).
3995 @kindex S-@key{right}
3996 @kindex S-@key{left}
3999 @kbd{S-@key{<left>}} and @kbd{S-@key{<right>}} and walk through @emph{all}
4000 keywords from all sets, so for example @kbd{S-@key{<right>}} would switch
4001 from @code{DONE} to @code{REPORT} in the example above. See also
4002 @ref{Conflicts}, for a discussion of the interaction with
4003 @code{shift-selection-mode}.
4006 @node Fast access to TODO states, Per-file keywords, Multiple sets in one file, TODO extensions
4007 @subsection Fast access to TODO states
4009 If you would like to quickly change an entry to an arbitrary TODO state
4010 instead of cycling through the states, you can set up keys for single-letter
4011 access to the states. This is done by adding the selection character after
4012 each keyword, in parentheses@footnote{All characters are allowed except
4013 @code{@@^!}, which have a special meaning here.}. For example:
4016 (setq org-todo-keywords
4017 '((sequence "TODO(t)" "|" "DONE(d)")
4018 (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")
4019 (sequence "|" "CANCELED(c)")))
4022 @vindex org-fast-tag-selection-include-todo
4023 If you then press @kbd{C-c C-t} followed by the selection key, the entry
4024 will be switched to this state. @kbd{SPC} can be used to remove any TODO
4025 keyword from an entry.@footnote{Check also the variable
4026 @code{org-fast-tag-selection-include-todo}, it allows you to change the TODO
4027 state through the tags interface (@pxref{Setting tags}), in case you like to
4028 mingle the two concepts. Note that this means you need to come up with
4029 unique keys across both sets of keywords.}
4031 @node Per-file keywords, Faces for TODO keywords, Fast access to TODO states, TODO extensions
4032 @subsection Setting up keywords for individual files
4033 @cindex keyword options
4034 @cindex per-file keywords
4039 It can be very useful to use different aspects of the TODO mechanism in
4040 different files. For file-local settings, you need to add special lines
4041 to the file which set the keywords and interpretation for that file
4042 only. For example, to set one of the two examples discussed above, you
4043 need one of the following lines, starting in column zero anywhere in the
4047 #+TODO: TODO FEEDBACK VERIFY | DONE CANCELED
4049 @noindent (you may also write @code{#+SEQ_TODO} to be explicit about the
4050 interpretation, but it means the same as @code{#+TODO}), or
4052 #+TYP_TODO: Fred Sara Lucy Mike | DONE
4055 A setup for using several sets in parallel would be:
4059 #+TODO: REPORT BUG KNOWNCAUSE | FIXED
4063 @cindex completion, of option keywords
4065 @noindent To make sure you are using the correct keyword, type
4066 @samp{#+} into the buffer and then use @kbd{M-@key{TAB}} completion.
4068 @cindex DONE, final TODO keyword
4069 Remember that the keywords after the vertical bar (or the last keyword
4070 if no bar is there) must always mean that the item is DONE (although you
4071 may use a different word). After changing one of these lines, use
4072 @kbd{C-c C-c} with the cursor still in the line to make the changes
4073 known to Org mode@footnote{Org mode parses these lines only when
4074 Org mode is activated after visiting a file. @kbd{C-c C-c} with the
4075 cursor in a line starting with @samp{#+} is simply restarting Org mode
4076 for the current buffer.}.
4078 @node Faces for TODO keywords, TODO dependencies, Per-file keywords, TODO extensions
4079 @subsection Faces for TODO keywords
4080 @cindex faces, for TODO keywords
4082 @vindex org-todo @r{(face)}
4083 @vindex org-done @r{(face)}
4084 @vindex org-todo-keyword-faces
4085 Org mode highlights TODO keywords with special faces: @code{org-todo}
4086 for keywords indicating that an item still has to be acted upon, and
4087 @code{org-done} for keywords indicating that an item is finished. If
4088 you are using more than 2 different states, you might want to use
4089 special faces for some of them. This can be done using the variable
4090 @code{org-todo-keyword-faces}. For example:
4094 (setq org-todo-keyword-faces
4095 '(("TODO" . org-warning) ("STARTED" . "yellow")
4096 ("CANCELED" . (:foreground "blue" :weight bold))))
4100 While using a list with face properties as shown for CANCELED @emph{should}
4101 work, this does not always seem to be the case. If necessary, define a
4102 special face and use that. A string is interpreted as a color. The variable
4103 @code{org-faces-easy-properties} determines if that color is interpreted as a
4104 foreground or a background color.
4106 @node TODO dependencies, , Faces for TODO keywords, TODO extensions
4107 @subsection TODO dependencies
4108 @cindex TODO dependencies
4109 @cindex dependencies, of TODO states
4111 @vindex org-enforce-todo-dependencies
4112 @cindex property, ORDERED
4113 The structure of Org files (hierarchy and lists) makes it easy to define TODO
4114 dependencies. Usually, a parent TODO task should not be marked DONE until
4115 all subtasks (defined as children tasks) are marked as DONE@. And sometimes
4116 there is a logical sequence to a number of (sub)tasks, so that one task
4117 cannot be acted upon before all siblings above it are done. If you customize
4118 the variable @code{org-enforce-todo-dependencies}, Org will block entries
4119 from changing state to DONE while they have children that are not DONE@.
4120 Furthermore, if an entry has a property @code{ORDERED}, each of its children
4121 will be blocked until all earlier siblings are marked DONE@. Here is an
4125 * TODO Blocked until (two) is done
4134 ** TODO b, needs to wait for (a)
4135 ** TODO c, needs to wait for (a) and (b)
4139 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4140 @vindex org-track-ordered-property-with-tag
4141 @cindex property, ORDERED
4142 Toggle the @code{ORDERED} property of the current entry. A property is used
4143 for this behavior because this should be local to the current entry, not
4144 inherited like a tag. However, if you would like to @i{track} the value of
4145 this property with a tag for better visibility, customize the variable
4146 @code{org-track-ordered-property-with-tag}.
4147 @orgkey{C-u C-u C-u C-c C-t}
4148 Change TODO state, circumventing any state blocking.
4151 @vindex org-agenda-dim-blocked-tasks
4152 If you set the variable @code{org-agenda-dim-blocked-tasks}, TODO entries
4153 that cannot be closed because of such dependencies will be shown in a dimmed
4154 font or even made invisible in agenda views (@pxref{Agenda Views}).
4156 @cindex checkboxes and TODO dependencies
4157 @vindex org-enforce-todo-dependencies
4158 You can also block changes of TODO states by looking at checkboxes
4159 (@pxref{Checkboxes}). If you set the variable
4160 @code{org-enforce-todo-checkbox-dependencies}, an entry that has unchecked
4161 checkboxes will be blocked from switching to DONE.
4163 If you need more complex dependency structures, for example dependencies
4164 between entries in different trees or files, check out the contributed
4165 module @file{org-depend.el}.
4168 @node Progress logging, Priorities, TODO extensions, TODO Items
4169 @section Progress logging
4170 @cindex progress logging
4171 @cindex logging, of progress
4173 Org mode can automatically record a timestamp and possibly a note when
4174 you mark a TODO item as DONE, or even each time you change the state of
4175 a TODO item. This system is highly configurable, settings can be on a
4176 per-keyword basis and can be localized to a file or even a subtree. For
4177 information on how to clock working time for a task, see @ref{Clocking
4181 * Closing items:: When was this entry marked DONE?
4182 * Tracking TODO state changes:: When did the status change?
4183 * Tracking your habits:: How consistent have you been?
4186 @node Closing items, Tracking TODO state changes, Progress logging, Progress logging
4187 @subsection Closing items
4189 The most basic logging is to keep track of @emph{when} a certain TODO
4190 item was finished. This is achieved with@footnote{The corresponding
4191 in-buffer setting is: @code{#+STARTUP: logdone}}
4194 (setq org-log-done 'time)
4198 Then each time you turn an entry from a TODO (not-done) state into any
4199 of the DONE states, a line @samp{CLOSED: [timestamp]} will be inserted
4200 just after the headline. If you turn the entry back into a TODO item
4201 through further state cycling, that line will be removed again. If you
4202 want to record a note along with the timestamp, use@footnote{The
4203 corresponding in-buffer setting is: @code{#+STARTUP: lognotedone}}
4206 (setq org-log-done 'note)
4210 You will then be prompted for a note, and that note will be stored below
4211 the entry with a @samp{Closing Note} heading.
4213 In the timeline (@pxref{Timeline}) and in the agenda
4214 (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to
4215 display the TODO items with a @samp{CLOSED} timestamp on each day,
4216 giving you an overview of what has been done.
4218 @node Tracking TODO state changes, Tracking your habits, Closing items, Progress logging
4219 @subsection Tracking TODO state changes
4220 @cindex drawer, for state change recording
4222 @vindex org-log-states-order-reversed
4223 @vindex org-log-into-drawer
4224 @cindex property, LOG_INTO_DRAWER
4225 When TODO keywords are used as workflow states (@pxref{Workflow states}), you
4226 might want to keep track of when a state change occurred and maybe take a
4227 note about this change. You can either record just a timestamp, or a
4228 time-stamped note for a change. These records will be inserted after the
4229 headline as an itemized list, newest first@footnote{See the variable
4230 @code{org-log-states-order-reversed}}. When taking a lot of notes, you might
4231 want to get the notes out of the way into a drawer (@pxref{Drawers}).
4232 Customize the variable @code{org-log-into-drawer} to get this behavior---the
4233 recommended drawer for this is called @code{LOGBOOK}@footnote{Note that the
4234 @code{LOGBOOK} drawer is unfolded when pressing @key{SPC} in the agenda to
4235 show an entry---use @key{C-u SPC} to keep it folded here}. You can also
4236 overrule the setting of this variable for a subtree by setting a
4237 @code{LOG_INTO_DRAWER} property.
4239 Since it is normally too much to record a note for every state, Org mode
4240 expects configuration on a per-keyword basis for this. This is achieved by
4241 adding special markers @samp{!} (for a timestamp) or @samp{@@} (for a note
4242 with timestamp) in parentheses after each keyword. For example, with the
4246 (setq org-todo-keywords
4247 '((sequence "TODO(t)" "WAIT(w@@/!)" "|" "DONE(d!)" "CANCELED(c@@)")))
4250 To record a timestamp without a note for TODO keywords configured with
4251 @samp{@@}, just type @kbd{C-c C-c} to enter a blank note when prompted.
4254 @vindex org-log-done
4255 you not only define global TODO keywords and fast access keys, but also
4256 request that a time is recorded when the entry is set to
4257 DONE@footnote{It is possible that Org mode will record two timestamps
4258 when you are using both @code{org-log-done} and state change logging.
4259 However, it will never prompt for two notes---if you have configured
4260 both, the state change recording note will take precedence and cancel
4261 the @samp{Closing Note}.}, and that a note is recorded when switching to
4262 WAIT or CANCELED@. The setting for WAIT is even more special: the
4263 @samp{!} after the slash means that in addition to the note taken when
4264 entering the state, a timestamp should be recorded when @i{leaving} the
4265 WAIT state, if and only if the @i{target} state does not configure
4266 logging for entering it. So it has no effect when switching from WAIT
4267 to DONE, because DONE is configured to record a timestamp only. But
4268 when switching from WAIT back to TODO, the @samp{/!} in the WAIT
4269 setting now triggers a timestamp even though TODO has no logging
4272 You can use the exact same syntax for setting logging preferences local
4275 #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
4278 @cindex property, LOGGING
4279 In order to define logging settings that are local to a subtree or a
4280 single item, define a LOGGING property in this entry. Any non-empty
4281 LOGGING property resets all logging settings to nil. You may then turn
4282 on logging for this specific tree using STARTUP keywords like
4283 @code{lognotedone} or @code{logrepeat}, as well as adding state specific
4284 settings like @code{TODO(!)}. For example
4287 * TODO Log each state with only a time
4289 :LOGGING: TODO(!) WAIT(!) DONE(!) CANCELED(!)
4291 * TODO Only log when switching to WAIT, and when repeating
4293 :LOGGING: WAIT(@@) logrepeat
4295 * TODO No logging at all
4301 @node Tracking your habits, , Tracking TODO state changes, Progress logging
4302 @subsection Tracking your habits
4305 Org has the ability to track the consistency of a special category of TODOs,
4306 called ``habits''. A habit has the following properties:
4310 You have enabled the @code{habits} module by customizing the variable
4313 The habit is a TODO item, with a TODO keyword representing an open state.
4315 The property @code{STYLE} is set to the value @code{habit}.
4317 The TODO has a scheduled date, usually with a @code{.+} style repeat
4318 interval. A @code{++} style may be appropriate for habits with time
4319 constraints, e.g., must be done on weekends, or a @code{+} style for an
4320 unusual habit that can have a backlog, e.g., weekly reports.
4322 The TODO may also have minimum and maximum ranges specified by using the
4323 syntax @samp{.+2d/3d}, which says that you want to do the task at least every
4324 three days, but at most every two days.
4326 You must also have state logging for the @code{DONE} state enabled
4327 (@pxref{Tracking TODO state changes}), in order for historical data to be
4328 represented in the consistency graph. If it is not enabled it is not an
4329 error, but the consistency graphs will be largely meaningless.
4332 To give you an idea of what the above rules look like in action, here's an
4333 actual habit with some history:
4337 SCHEDULED: <2009-10-17 Sat .+2d/4d>
4338 - State "DONE" from "TODO" [2009-10-15 Thu]
4339 - State "DONE" from "TODO" [2009-10-12 Mon]
4340 - State "DONE" from "TODO" [2009-10-10 Sat]
4341 - State "DONE" from "TODO" [2009-10-04 Sun]
4342 - State "DONE" from "TODO" [2009-10-02 Fri]
4343 - State "DONE" from "TODO" [2009-09-29 Tue]
4344 - State "DONE" from "TODO" [2009-09-25 Fri]
4345 - State "DONE" from "TODO" [2009-09-19 Sat]
4346 - State "DONE" from "TODO" [2009-09-16 Wed]
4347 - State "DONE" from "TODO" [2009-09-12 Sat]
4350 :LAST_REPEAT: [2009-10-19 Mon 00:36]
4354 What this habit says is: I want to shave at most every 2 days (given by the
4355 @code{SCHEDULED} date and repeat interval) and at least every 4 days. If
4356 today is the 15th, then the habit first appears in the agenda on Oct 17,
4357 after the minimum of 2 days has elapsed, and will appear overdue on Oct 19,
4358 after four days have elapsed.
4360 What's really useful about habits is that they are displayed along with a
4361 consistency graph, to show how consistent you've been at getting that task
4362 done in the past. This graph shows every day that the task was done over the
4363 past three weeks, with colors for each day. The colors used are:
4367 If the task wasn't to be done yet on that day.
4369 If the task could have been done on that day.
4371 If the task was going to be overdue the next day.
4373 If the task was overdue on that day.
4376 In addition to coloring each day, the day is also marked with an asterisk if
4377 the task was actually done that day, and an exclamation mark to show where
4378 the current day falls in the graph.
4380 There are several configuration variables that can be used to change the way
4381 habits are displayed in the agenda.
4384 @item org-habit-graph-column
4385 The buffer column at which the consistency graph should be drawn. This will
4386 overwrite any text in that column, so it is a good idea to keep your habits'
4387 titles brief and to the point.
4388 @item org-habit-preceding-days
4389 The amount of history, in days before today, to appear in consistency graphs.
4390 @item org-habit-following-days
4391 The number of days after today that will appear in consistency graphs.
4392 @item org-habit-show-habits-only-for-today
4393 If non-nil, only show habits in today's agenda view. This is set to true by
4397 Lastly, pressing @kbd{K} in the agenda buffer will cause habits to
4398 temporarily be disabled and they won't appear at all. Press @kbd{K} again to
4399 bring them back. They are also subject to tag filtering, if you have habits
4400 which should only be done in certain contexts, for example.
4402 @node Priorities, Breaking down tasks, Progress logging, TODO Items
4406 If you use Org mode extensively, you may end up with enough TODO items that
4407 it starts to make sense to prioritize them. Prioritizing can be done by
4408 placing a @emph{priority cookie} into the headline of a TODO item, like this
4411 *** TODO [#A] Write letter to Sam Fortune
4415 @vindex org-priority-faces
4416 By default, Org mode supports three priorities: @samp{A}, @samp{B}, and
4417 @samp{C}. @samp{A} is the highest priority. An entry without a cookie is
4418 treated just like priority @samp{B}. Priorities make a difference only for
4419 sorting in the agenda (@pxref{Weekly/daily agenda}); outside the agenda, they
4420 have no inherent meaning to Org mode. The cookies can be highlighted with
4421 special faces by customizing the variable @code{org-priority-faces}.
4423 Priorities can be attached to any outline node; they do not need to be TODO
4429 @findex org-priority
4430 Set the priority of the current headline (@command{org-priority}). The
4431 command prompts for a priority character @samp{A}, @samp{B} or @samp{C}.
4432 When you press @key{SPC} instead, the priority cookie is removed from the
4433 headline. The priorities can also be changed ``remotely'' from the timeline
4434 and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}).
4436 @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down}
4437 @vindex org-priority-start-cycle-with-default
4438 Increase/decrease priority of current headline@footnote{See also the option
4439 @code{org-priority-start-cycle-with-default}.}. Note that these keys are
4440 also used to modify timestamps (@pxref{Creating timestamps}). See also
4441 @ref{Conflicts}, for a discussion of the interaction with
4442 @code{shift-selection-mode}.
4445 @vindex org-highest-priority
4446 @vindex org-lowest-priority
4447 @vindex org-default-priority
4448 You can change the range of allowed priorities by setting the variables
4449 @code{org-highest-priority}, @code{org-lowest-priority}, and
4450 @code{org-default-priority}. For an individual buffer, you may set
4451 these values (highest, lowest, default) like this (please make sure that
4452 the highest priority is earlier in the alphabet than the lowest
4455 @cindex #+PRIORITIES
4460 @node Breaking down tasks, Checkboxes, Priorities, TODO Items
4461 @section Breaking tasks down into subtasks
4462 @cindex tasks, breaking down
4463 @cindex statistics, for TODO items
4465 @vindex org-agenda-todo-list-sublevels
4466 It is often advisable to break down large tasks into smaller, manageable
4467 subtasks. You can do this by creating an outline tree below a TODO item,
4468 with detailed subtasks on the tree@footnote{To keep subtasks out of the
4469 global TODO list, see the @code{org-agenda-todo-list-sublevels}.}. To keep
4470 the overview over the fraction of subtasks that are already completed, insert
4471 either @samp{[/]} or @samp{[%]} anywhere in the headline. These cookies will
4472 be updated each time the TODO status of a child changes, or when pressing
4473 @kbd{C-c C-c} on the cookie. For example:
4476 * Organize Party [33%]
4477 ** TODO Call people [1/2]
4481 ** DONE Talk to neighbor
4484 @cindex property, COOKIE_DATA
4485 If a heading has both checkboxes and TODO children below it, the meaning of
4486 the statistics cookie become ambiguous. Set the property
4487 @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve
4490 @vindex org-hierarchical-todo-statistics
4491 If you would like to have the statistics cookie count any TODO entries in the
4492 subtree (not just direct children), configure the variable
4493 @code{org-hierarchical-todo-statistics}. To do this for a single subtree,
4494 include the word @samp{recursive} into the value of the @code{COOKIE_DATA}
4498 * Parent capturing statistics [2/20]
4500 :COOKIE_DATA: todo recursive
4504 If you would like a TODO entry to automatically change to DONE
4505 when all children are done, you can use the following setup:
4508 (defun org-summary-todo (n-done n-not-done)
4509 "Switch entry to DONE when all subentries are done, to TODO otherwise."
4510 (let (org-log-done org-log-states) ; turn off logging
4511 (org-todo (if (= n-not-done 0) "DONE" "TODO"))))
4513 (add-hook 'org-after-todo-statistics-hook 'org-summary-todo)
4517 Another possibility is the use of checkboxes to identify (a hierarchy of) a
4518 large number of subtasks (@pxref{Checkboxes}).
4521 @node Checkboxes, , Breaking down tasks, TODO Items
4525 @vindex org-list-automatic-rules
4526 Every item in a plain list@footnote{With the exception of description
4527 lists. But you can allow it by modifying @code{org-list-automatic-rules}
4528 accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
4529 it with the string @samp{[ ]}. This feature is similar to TODO items
4530 (@pxref{TODO Items}), but is more lightweight. Checkboxes are not included
4531 into the global TODO list, so they are often great to split a task into a
4532 number of simple steps. Or you can use them in a shopping list. To toggle a
4533 checkbox, use @kbd{C-c C-c}, or use the mouse (thanks to Piotr Zielinski's
4534 @file{org-mouse.el}).
4536 Here is an example of a checkbox list.
4539 * TODO Organize party [2/4]
4540 - [-] call people [1/3]
4545 - [ ] think about what music to play
4546 - [X] talk to the neighbors
4549 Checkboxes work hierarchically, so if a checkbox item has children that
4550 are checkboxes, toggling one of the children checkboxes will make the
4551 parent checkbox reflect if none, some, or all of the children are
4554 @cindex statistics, for checkboxes
4555 @cindex checkbox statistics
4556 @cindex property, COOKIE_DATA
4557 @vindex org-hierarchical-checkbox-statistics
4558 The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies
4559 indicating how many checkboxes present in this entry have been checked off,
4560 and the total number of checkboxes present. This can give you an idea on how
4561 many checkboxes remain, even without opening a folded entry. The cookies can
4562 be placed into a headline or into (the first line of) a plain list item.
4563 Each cookie covers checkboxes of direct children structurally below the
4564 headline/item on which the cookie appears@footnote{Set the variable
4565 @code{org-hierarchical-checkbox-statistics} if you want such cookies to
4566 count all checkboxes below the cookie, not just those belonging to direct
4567 children.}. You have to insert the cookie yourself by typing either
4568 @samp{[/]} or @samp{[%]}. With @samp{[/]} you get an @samp{n out of m}
4569 result, as in the examples above. With @samp{[%]} you get information about
4570 the percentage of checkboxes checked (in the above example, this would be
4571 @samp{[50%]} and @samp{[33%]}, respectively). In a headline, a cookie can
4572 count either checkboxes below the heading or TODO states of children, and it
4573 will display whatever was changed last. Set the property @code{COOKIE_DATA}
4574 to either @samp{checkbox} or @samp{todo} to resolve this issue.
4576 @cindex blocking, of checkboxes
4577 @cindex checkbox blocking
4578 @cindex property, ORDERED
4579 If the current outline node has an @code{ORDERED} property, checkboxes must
4580 be checked off in sequence, and an error will be thrown if you try to check
4581 off a box while there are unchecked boxes above it.
4583 @noindent The following commands work with checkboxes:
4586 @orgcmd{C-c C-c,org-toggle-checkbox}
4587 Toggle checkbox status or (with prefix arg) checkbox presence at point.
4588 With a single prefix argument, add an empty checkbox or remove the current
4589 one@footnote{`C-u C-c C-c' on the @emph{first} item of a list with no checkbox
4590 will add checkboxes to the rest of the list.}. With a double prefix argument, set it to @samp{[-]}, which is
4591 considered to be an intermediate state.
4592 @orgcmd{C-c C-x C-b,org-toggle-checkbox}
4593 Toggle checkbox status or (with prefix arg) checkbox presence at point. With
4594 double prefix argument, set it to @samp{[-]}, which is considered to be an
4598 If there is an active region, toggle the first checkbox in the region
4599 and set all remaining boxes to the same status as the first. With a prefix
4600 arg, add or remove the checkbox for all items in the region.
4602 If the cursor is in a headline, toggle checkboxes in the region between
4603 this headline and the next (so @emph{not} the entire subtree).
4605 If there is no active region, just toggle the checkbox at point.
4607 @orgcmd{M-S-@key{RET},org-insert-todo-heading}
4608 Insert a new item with a checkbox. This works only if the cursor is already
4609 in a plain list item (@pxref{Plain lists}).
4610 @orgcmd{C-c C-x o,org-toggle-ordered-property}
4611 @vindex org-track-ordered-property-with-tag
4612 @cindex property, ORDERED
4613 Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must
4614 be checked off in sequence. A property is used for this behavior because
4615 this should be local to the current entry, not inherited like a tag.
4616 However, if you would like to @i{track} the value of this property with a tag
4617 for better visibility, customize the variable
4618 @code{org-track-ordered-property-with-tag}.
4619 @orgcmd{C-c #,org-update-statistics-cookies}
4620 Update the statistics cookie in the current outline entry. When called with
4621 a @kbd{C-u} prefix, update the entire file. Checkbox statistic cookies are
4622 updated automatically if you toggle checkboxes with @kbd{C-c C-c} and make
4623 new ones with @kbd{M-S-@key{RET}}. TODO statistics cookies update when
4624 changing TODO states. If you delete boxes/entries or add/change them by
4625 hand, use this command to get things back into sync.
4628 @node Tags, Properties and Columns, TODO Items, Top
4631 @cindex headline tagging
4632 @cindex matching, tags
4633 @cindex sparse tree, tag based
4635 An excellent way to implement labels and contexts for cross-correlating
4636 information is to assign @i{tags} to headlines. Org mode has extensive
4639 @vindex org-tag-faces
4640 Every headline can contain a list of tags; they occur at the end of the
4641 headline. Tags are normal words containing letters, numbers, @samp{_}, and
4642 @samp{@@}. Tags must be preceded and followed by a single colon, e.g.,
4643 @samp{:work:}. Several tags can be specified, as in @samp{:work:urgent:}.
4644 Tags will by default be in bold face with the same color as the headline.
4645 You may specify special faces for specific tags using the variable
4646 @code{org-tag-faces}, in much the same way as you can for TODO keywords
4647 (@pxref{Faces for TODO keywords}).
4650 * Tag inheritance:: Tags use the tree structure of the outline
4651 * Setting tags:: How to assign tags to a headline
4652 * Tag searches:: Searching for combinations of tags
4655 @node Tag inheritance, Setting tags, Tags, Tags
4656 @section Tag inheritance
4657 @cindex tag inheritance
4658 @cindex inheritance, of tags
4659 @cindex sublevels, inclusion into tags match
4661 @i{Tags} make use of the hierarchical structure of outline trees. If a
4662 heading has a certain tag, all subheadings will inherit the tag as
4663 well. For example, in the list
4666 * Meeting with the French group :work:
4667 ** Summary by Frank :boss:notes:
4668 *** TODO Prepare slides for him :action:
4672 the final heading will have the tags @samp{:work:}, @samp{:boss:},
4673 @samp{:notes:}, and @samp{:action:} even though the final heading is not
4674 explicitly marked with those tags. You can also set tags that all entries in
4675 a file should inherit just as if these tags were defined in a hypothetical
4676 level zero that surrounds the entire file. Use a line like this@footnote{As
4677 with all these in-buffer settings, pressing @kbd{C-c C-c} activates any
4678 changes in the line.}:
4682 #+FILETAGS: :Peter:Boss:Secret:
4686 @vindex org-use-tag-inheritance
4687 @vindex org-tags-exclude-from-inheritance
4688 To limit tag inheritance to specific tags, or to turn it off entirely, use
4689 the variables @code{org-use-tag-inheritance} and
4690 @code{org-tags-exclude-from-inheritance}.
4692 @vindex org-tags-match-list-sublevels
4693 When a headline matches during a tags search while tag inheritance is turned
4694 on, all the sublevels in the same tree will (for a simple match form) match
4695 as well@footnote{This is only true if the search does not involve more
4696 complex tests including properties (@pxref{Property searches}).}. The list
4697 of matches may then become very long. If you only want to see the first tags
4698 match in a subtree, configure the variable
4699 @code{org-tags-match-list-sublevels} (not recommended).
4701 @node Setting tags, Tag searches, Tag inheritance, Tags
4702 @section Setting tags
4703 @cindex setting tags
4704 @cindex tags, setting
4707 Tags can simply be typed into the buffer at the end of a headline.
4708 After a colon, @kbd{M-@key{TAB}} offers completion on tags. There is
4709 also a special command for inserting tags:
4712 @orgcmd{C-c C-q,org-set-tags-command}
4713 @cindex completion, of tags
4714 @vindex org-tags-column
4715 Enter new tags for the current headline. Org mode will either offer
4716 completion or a special single-key interface for setting tags, see
4717 below. After pressing @key{RET}, the tags will be inserted and aligned
4718 to @code{org-tags-column}. When called with a @kbd{C-u} prefix, all
4719 tags in the current buffer will be aligned to that column, just to make
4720 things look nice. TAGS are automatically realigned after promotion,
4721 demotion, and TODO state changes (@pxref{TODO basics}).
4722 @orgcmd{C-c C-c,org-set-tags-command}
4723 When the cursor is in a headline, this does the same as @kbd{C-c C-q}.
4726 @vindex org-tag-alist
4727 Org supports tag insertion based on a @emph{list of tags}. By
4728 default this list is constructed dynamically, containing all tags
4729 currently used in the buffer. You may also globally specify a hard list
4730 of tags with the variable @code{org-tag-alist}. Finally you can set
4731 the default tags for a given file with lines like
4735 #+TAGS: @@work @@home @@tennisclub
4736 #+TAGS: laptop car pc sailboat
4739 If you have globally defined your preferred set of tags using the
4740 variable @code{org-tag-alist}, but would like to use a dynamic tag list
4741 in a specific file, add an empty TAGS option line to that file:
4747 @vindex org-tag-persistent-alist
4748 If you have a preferred set of tags that you would like to use in every file,
4749 in addition to those defined on a per-file basis by TAGS option lines, then
4750 you may specify a list of tags with the variable
4751 @code{org-tag-persistent-alist}. You may turn this off on a per-file basis
4752 by adding a STARTUP option line to that file:
4758 By default Org mode uses the standard minibuffer completion facilities for
4759 entering tags. However, it also implements another, quicker, tag selection
4760 method called @emph{fast tag selection}. This allows you to select and
4761 deselect tags with just a single key press. For this to work well you should
4762 assign unique letters to most of your commonly used tags. You can do this
4763 globally by configuring the variable @code{org-tag-alist} in your
4764 @file{.emacs} file. For example, you may find the need to tag many items in
4765 different files with @samp{:@@home:}. In this case you can set something
4769 (setq org-tag-alist '(("@@work" . ?w) ("@@home" . ?h) ("laptop" . ?l)))
4772 @noindent If the tag is only relevant to the file you are working on, then you
4773 can instead set the TAGS option line as:
4776 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) laptop(l) pc(p)
4779 @noindent The tags interface will show the available tags in a splash
4780 window. If you want to start a new line after a specific tag, insert
4781 @samp{\n} into the tag list
4784 #+TAGS: @@work(w) @@home(h) @@tennisclub(t) \n laptop(l) pc(p)
4787 @noindent or write them in two lines:
4790 #+TAGS: @@work(w) @@home(h) @@tennisclub(t)
4791 #+TAGS: laptop(l) pc(p)
4795 You can also group together tags that are mutually exclusive by using
4799 #+TAGS: @{ @@work(w) @@home(h) @@tennisclub(t) @} laptop(l) pc(p)
4802 @noindent you indicate that at most one of @samp{@@work}, @samp{@@home},
4803 and @samp{@@tennisclub} should be selected. Multiple such groups are allowed.
4805 @noindent Don't forget to press @kbd{C-c C-c} with the cursor in one of
4806 these lines to activate any changes.
4809 To set these mutually exclusive groups in the variable @code{org-tags-alist},
4810 you must use the dummy tags @code{:startgroup} and @code{:endgroup} instead
4811 of the braces. Similarly, you can use @code{:newline} to indicate a line
4812 break. The previous example would be set globally by the following
4816 (setq org-tag-alist '((:startgroup . nil)
4817 ("@@work" . ?w) ("@@home" . ?h)
4818 ("@@tennisclub" . ?t)
4820 ("laptop" . ?l) ("pc" . ?p)))
4823 If at least one tag has a selection key then pressing @kbd{C-c C-c} will
4824 automatically present you with a special interface, listing inherited tags,
4825 the tags of the current headline, and a list of all valid tags with
4826 corresponding keys@footnote{Keys will automatically be assigned to tags which
4827 have no configured keys.}. In this interface, you can use the following
4832 Pressing keys assigned to tags will add or remove them from the list of
4833 tags in the current line. Selecting a tag in a group of mutually
4834 exclusive tags will turn off any other tags from that group.
4837 Enter a tag in the minibuffer, even if the tag is not in the predefined
4838 list. You will be able to complete on all tags present in the buffer.
4839 You can also add several tags: just separate them with a comma.
4843 Clear all tags for this line.
4846 Accept the modified set.
4848 Abort without installing changes.
4850 If @kbd{q} is not assigned to a tag, it aborts like @kbd{C-g}.
4852 Turn off groups of mutually exclusive tags. Use this to (as an
4853 exception) assign several tags from such a group.
4855 Toggle auto-exit after the next change (see below).
4856 If you are using expert mode, the first @kbd{C-c} will display the
4861 This method lets you assign tags to a headline with very few keys. With
4862 the above setup, you could clear the current tags and set @samp{@@home},
4863 @samp{laptop} and @samp{pc} tags with just the following keys: @kbd{C-c
4864 C-c @key{SPC} h l p @key{RET}}. Switching from @samp{@@home} to
4865 @samp{@@work} would be done with @kbd{C-c C-c w @key{RET}} or
4866 alternatively with @kbd{C-c C-c C-c w}. Adding the non-predefined tag
4867 @samp{Sarah} could be done with @kbd{C-c C-c @key{TAB} S a r a h
4868 @key{RET} @key{RET}}.
4870 @vindex org-fast-tag-selection-single-key
4871 If you find that most of the time you need only a single key press to
4872 modify your list of tags, set the variable
4873 @code{org-fast-tag-selection-single-key}. Then you no longer have to
4874 press @key{RET} to exit fast tag selection---it will immediately exit
4875 after the first change. If you then occasionally need more keys, press
4876 @kbd{C-c} to turn off auto-exit for the current tag selection process
4877 (in effect: start selection with @kbd{C-c C-c C-c} instead of @kbd{C-c
4878 C-c}). If you set the variable to the value @code{expert}, the special
4879 window is not even shown for single-key tag selection, it comes up only
4880 when you press an extra @kbd{C-c}.
4882 @node Tag searches, , Setting tags, Tags
4883 @section Tag searches
4884 @cindex tag searches
4885 @cindex searching for tags
4887 Once a system of tags has been set up, it can be used to collect related
4888 information into special lists.
4891 @orgcmdkkc{C-c / m,C-c \\,org-match-sparse-tree}
4892 Create a sparse tree with all headlines matching a tags search. With a
4893 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
4894 @orgcmd{C-c a m,org-tags-view}
4895 Create a global list of tag matches from all agenda files.
4896 @xref{Matching tags and properties}.
4897 @orgcmd{C-c a M,org-tags-view}
4898 @vindex org-tags-match-list-sublevels
4899 Create a global list of tag matches from all agenda files, but check
4900 only TODO items and force checking subitems (see variable
4901 @code{org-tags-match-list-sublevels}).
4904 These commands all prompt for a match string which allows basic Boolean logic
4905 like @samp{+boss+urgent-project1}, to find entries with tags @samp{boss} and
4906 @samp{urgent}, but not @samp{project1}, or @samp{Kathy|Sally} to find entries
4907 which are tagged, like @samp{Kathy} or @samp{Sally}. The full syntax of the search
4908 string is rich and allows also matching against TODO keywords, entry levels
4909 and properties. For a complete description with many examples, see
4910 @ref{Matching tags and properties}.
4913 @node Properties and Columns, Dates and Times, Tags, Top
4914 @chapter Properties and columns
4917 A property is a key-value pair associated with an entry. Properties can be
4918 set so they are associated with a single entry, with every entry in a tree,
4919 or with every entry in an Org mode file.
4921 There are two main applications for properties in Org mode. First,
4922 properties are like tags, but with a value. Imagine maintaining a file where
4923 you document bugs and plan releases for a piece of software. Instead of
4924 using tags like @code{:release_1:}, @code{:release_2:}, you can use a
4925 property, say @code{:Release:}, that in different subtrees has different
4926 values, such as @code{1.0} or @code{2.0}. Second, you can use properties to
4927 implement (very basic) database capabilities in an Org buffer. Imagine
4928 keeping track of your music CDs, where properties could be things such as the
4929 album, artist, date of release, number of tracks, and so on.
4931 Properties can be conveniently edited and viewed in column view
4932 (@pxref{Column view}).
4935 * Property syntax:: How properties are spelled out
4936 * Special properties:: Access to other Org mode features
4937 * Property searches:: Matching property values
4938 * Property inheritance:: Passing values down the tree
4939 * Column view:: Tabular viewing and editing
4940 * Property API:: Properties for Lisp programmers
4943 @node Property syntax, Special properties, Properties and Columns, Properties and Columns
4944 @section Property syntax
4945 @cindex property syntax
4946 @cindex drawer, for properties
4948 Properties are key-value pairs. When they are associated with a single entry
4949 or with a tree they need to be inserted into a special
4950 drawer (@pxref{Drawers}) with the name @code{PROPERTIES}. Each property
4951 is specified on a single line, with the key (surrounded by colons)
4952 first, and the value after it. Here is an example:
4957 *** Goldberg Variations
4959 :Title: Goldberg Variations
4960 :Composer: J.S. Bach
4962 :Publisher: Deutsche Grammophon
4967 Depending on the value of @code{org-use-property-inheritance}, a property set
4968 this way will either be associated with a single entry, or the sub-tree
4969 defined by the entry, see @ref{Property inheritance}.
4971 You may define the allowed values for a particular property @samp{:Xyz:}
4972 by setting a property @samp{:Xyz_ALL:}. This special property is
4973 @emph{inherited}, so if you set it in a level 1 entry, it will apply to
4974 the entire tree. When allowed values are defined, setting the
4975 corresponding property becomes easier and is less prone to typing
4976 errors. For the example with the CD collection, we can predefine
4977 publishers and the number of disks in a box like this:
4982 :NDisks_ALL: 1 2 3 4
4983 :Publisher_ALL: "Deutsche Grammophon" Philips EMI
4987 If you want to set properties that can be inherited by any entry in a
4988 file, use a line like
4989 @cindex property, _ALL
4992 #+PROPERTY: NDisks_ALL 1 2 3 4
4995 If you want to add to the value of an existing property, append a @code{+} to
4996 the property name. The following results in the property @code{var} having
4997 the value ``foo=1 bar=2''.
5000 #+PROPERTY: var foo=1
5001 #+PROPERTY: var+ bar=2
5004 It is also possible to add to the values of inherited properties. The
5005 following results in the @code{genres} property having the value ``Classic
5006 Baroque'' under the @code{Goldberg Variations} subtree.
5014 *** Goldberg Variations
5016 :Title: Goldberg Variations
5017 :Composer: J.S. Bach
5019 :Publisher: Deutsche Grammophon
5024 Note that a property can only have one entry per Drawer.
5026 @vindex org-global-properties
5027 Property values set with the global variable
5028 @code{org-global-properties} can be inherited by all entries in all
5032 The following commands help to work with properties:
5035 @orgcmd{M-@key{TAB},pcomplete}
5036 After an initial colon in a line, complete property keys. All keys used
5037 in the current file will be offered as possible completions.
5038 @orgcmd{C-c C-x p,org-set-property}
5039 Set a property. This prompts for a property name and a value. If
5040 necessary, the property drawer is created as well.
5041 @item C-u M-x org-insert-drawer
5042 @cindex org-insert-drawer
5043 Insert a property drawer into the current entry. The drawer will be
5044 inserted early in the entry, but after the lines with planning
5045 information like deadlines.
5046 @orgcmd{C-c C-c,org-property-action}
5047 With the cursor in a property drawer, this executes property commands.
5048 @orgcmd{C-c C-c s,org-set-property}
5049 Set a property in the current entry. Both the property and the value
5050 can be inserted using completion.
5051 @orgcmdkkcc{S-@key{right},S-@key{left},org-property-next-allowed-value,org-property-previous-allowed-value}
5052 Switch property at point to the next/previous allowed value.
5053 @orgcmd{C-c C-c d,org-delete-property}
5054 Remove a property from the current entry.
5055 @orgcmd{C-c C-c D,org-delete-property-globally}
5056 Globally remove a property, from all entries in the current file.
5057 @orgcmd{C-c C-c c,org-compute-property-at-point}
5058 Compute the property at point, using the operator and scope from the
5059 nearest column format definition.
5062 @node Special properties, Property searches, Property syntax, Properties and Columns
5063 @section Special properties
5064 @cindex properties, special
5066 Special properties provide an alternative access method to Org mode features,
5067 like the TODO state or the priority of an entry, discussed in the previous
5068 chapters. This interface exists so that you can include these states in a
5069 column view (@pxref{Column view}), or to use them in queries. The following
5070 property names are special and (except for @code{:CATEGORY:}) should not be
5071 used as keys in the properties drawer:
5073 @cindex property, special, ID
5074 @cindex property, special, TODO
5075 @cindex property, special, TAGS
5076 @cindex property, special, ALLTAGS
5077 @cindex property, special, CATEGORY
5078 @cindex property, special, PRIORITY
5079 @cindex property, special, DEADLINE
5080 @cindex property, special, SCHEDULED
5081 @cindex property, special, CLOSED
5082 @cindex property, special, TIMESTAMP
5083 @cindex property, special, TIMESTAMP_IA
5084 @cindex property, special, CLOCKSUM
5085 @cindex property, special, CLOCKSUM_T
5086 @cindex property, special, BLOCKED
5087 @c guessing that ITEM is needed in this area; also, should this list be sorted?
5088 @cindex property, special, ITEM
5089 @cindex property, special, FILE
5091 ID @r{A globally unique ID used for synchronization during}
5092 @r{iCalendar or MobileOrg export.}
5093 TODO @r{The TODO keyword of the entry.}
5094 TAGS @r{The tags defined directly in the headline.}
5095 ALLTAGS @r{All tags, including inherited ones.}
5096 CATEGORY @r{The category of an entry.}
5097 PRIORITY @r{The priority of the entry, a string with a single letter.}
5098 DEADLINE @r{The deadline time string, without the angular brackets.}
5099 SCHEDULED @r{The scheduling timestamp, without the angular brackets.}
5100 CLOSED @r{When was this entry closed?}
5101 TIMESTAMP @r{The first keyword-less timestamp in the entry.}
5102 TIMESTAMP_IA @r{The first inactive timestamp in the entry.}
5103 CLOCKSUM @r{The sum of CLOCK intervals in the subtree. @code{org-clock-sum}}
5104 @r{must be run first to compute the values in the current buffer.}
5105 CLOCKSUM_T @r{The sum of CLOCK intervals in the subtree for today.}
5106 @r{@code{org-clock-sum-today} must be run first to compute the}
5107 @r{values in the current buffer.}
5108 BLOCKED @r{"t" if task is currently blocked by children or siblings}
5109 ITEM @r{The headline of the entry.}
5110 FILE @r{The filename the entry is located in.}
5113 @node Property searches, Property inheritance, Special properties, Properties and Columns
5114 @section Property searches
5115 @cindex properties, searching
5116 @cindex searching, of properties
5118 To create sparse trees and special lists with selection based on properties,
5119 the same commands are used as for tag searches (@pxref{Tag searches}).
5121 @orgcmdkkc{C-c / m,C-c \,org-match-sparse-tree}
5122 Create a sparse tree with all matching entries. With a
5123 @kbd{C-u} prefix argument, ignore headlines that are not a TODO line.
5124 @orgcmd{C-c a m,org-tags-view}
5125 Create a global list of tag/property matches from all agenda files.
5126 @xref{Matching tags and properties}.
5127 @orgcmd{C-c a M,org-tags-view}
5128 @vindex org-tags-match-list-sublevels
5129 Create a global list of tag matches from all agenda files, but check
5130 only TODO items and force checking of subitems (see variable
5131 @code{org-tags-match-list-sublevels}).
5134 The syntax for the search string is described in @ref{Matching tags and
5137 There is also a special command for creating sparse trees based on a
5142 Create a sparse tree based on the value of a property. This first
5143 prompts for the name of a property, and then for a value. A sparse tree
5144 is created with all entries that define this property with the given
5145 value. If you enclose the value in curly braces, it is interpreted as
5146 a regular expression and matched against the property values.
5149 @node Property inheritance, Column view, Property searches, Properties and Columns
5150 @section Property Inheritance
5151 @cindex properties, inheritance
5152 @cindex inheritance, of properties
5154 @vindex org-use-property-inheritance
5155 The outline structure of Org mode documents lends itself to an
5156 inheritance model of properties: if the parent in a tree has a certain
5157 property, the children can inherit this property. Org mode does not
5158 turn this on by default, because it can slow down property searches
5159 significantly and is often not needed. However, if you find inheritance
5160 useful, you can turn it on by setting the variable
5161 @code{org-use-property-inheritance}. It may be set to @code{t} to make
5162 all properties inherited from the parent, to a list of properties
5163 that should be inherited, or to a regular expression that matches
5164 inherited properties. If a property has the value @samp{nil}, this is
5165 interpreted as an explicit undefine of the property, so that inheritance
5166 search will stop at this value and return @code{nil}.
5168 Org mode has a few properties for which inheritance is hard-coded, at
5169 least for the special applications for which they are used:
5171 @cindex property, COLUMNS
5174 The @code{:COLUMNS:} property defines the format of column view
5175 (@pxref{Column view}). It is inherited in the sense that the level
5176 where a @code{:COLUMNS:} property is defined is used as the starting
5177 point for a column view table, independently of the location in the
5178 subtree from where columns view is turned on.
5180 @cindex property, CATEGORY
5181 For agenda view, a category set through a @code{:CATEGORY:} property
5182 applies to the entire subtree.
5184 @cindex property, ARCHIVE
5185 For archiving, the @code{:ARCHIVE:} property may define the archive
5186 location for the entire subtree (@pxref{Moving subtrees}).
5188 @cindex property, LOGGING
5189 The LOGGING property may define logging settings for an entry or a
5190 subtree (@pxref{Tracking TODO state changes}).
5193 @node Column view, Property API, Property inheritance, Properties and Columns
5194 @section Column view
5196 A great way to view and edit properties in an outline tree is
5197 @emph{column view}. In column view, each outline node is turned into a
5198 table row. Columns in this table provide access to properties of the
5199 entries. Org mode implements columns by overlaying a tabular structure
5200 over the headline of each item. While the headlines have been turned
5201 into a table row, you can still change the visibility of the outline
5202 tree. For example, you get a compact table by switching to CONTENTS
5203 view (@kbd{S-@key{TAB} S-@key{TAB}}, or simply @kbd{c} while column view
5204 is active), but you can still open, read, and edit the entry below each
5205 headline. Or, you can switch to column view after executing a sparse
5206 tree command and in this way get a table only for the selected items.
5207 Column view also works in agenda buffers (@pxref{Agenda Views}) where
5208 queries have collected selected items, possibly from a number of files.
5211 * Defining columns:: The COLUMNS format property
5212 * Using column view:: How to create and use column view
5213 * Capturing column view:: A dynamic block for column view
5216 @node Defining columns, Using column view, Column view, Column view
5217 @subsection Defining columns
5218 @cindex column view, for properties
5219 @cindex properties, column view
5221 Setting up a column view first requires defining the columns. This is
5222 done by defining a column format line.
5225 * Scope of column definitions:: Where defined, where valid?
5226 * Column attributes:: Appearance and content of a column
5229 @node Scope of column definitions, Column attributes, Defining columns, Defining columns
5230 @subsubsection Scope of column definitions
5232 To define a column format for an entire file, use a line like
5236 #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5239 To specify a format that only applies to a specific tree, add a
5240 @code{:COLUMNS:} property to the top node of that tree, for example:
5243 ** Top node for columns view
5245 :COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
5249 If a @code{:COLUMNS:} property is present in an entry, it defines columns
5250 for the entry itself, and for the entire subtree below it. Since the
5251 column definition is part of the hierarchical structure of the document,
5252 you can define columns on level 1 that are general enough for all
5253 sublevels, and more specific columns further down, when you edit a
5254 deeper part of the tree.
5256 @node Column attributes, , Scope of column definitions, Defining columns
5257 @subsubsection Column attributes
5258 A column definition sets the attributes of a column. The general
5259 definition looks like this:
5262 %[@var{width}]@var{property}[(@var{title})][@{@var{summary-type}@}]
5266 Except for the percent sign and the property name, all items are
5267 optional. The individual parts have the following meaning:
5270 @var{width} @r{An integer specifying the width of the column in characters.}
5271 @r{If omitted, the width will be determined automatically.}
5272 @var{property} @r{The property that should be edited in this column.}
5273 @r{Special properties representing meta data are allowed here}
5274 @r{as well (@pxref{Special properties})}
5275 @var{title} @r{The header text for the column. If omitted, the property}
5277 @{@var{summary-type}@} @r{The summary type. If specified, the column values for}
5278 @r{parent nodes are computed from the children.}
5279 @r{Supported summary types are:}
5280 @{+@} @r{Sum numbers in this column.}
5281 @{+;%.1f@} @r{Like @samp{+}, but format result with @samp{%.1f}.}
5282 @{$@} @r{Currency, short for @samp{+;%.2f}.}
5283 @{:@} @r{Sum times, HH:MM, plain numbers are hours.}
5284 @{X@} @r{Checkbox status, @samp{[X]} if all children are @samp{[X]}.}
5285 @{X/@} @r{Checkbox status, @samp{[n/m]}.}
5286 @{X%@} @r{Checkbox status, @samp{[n%]}.}
5287 @{min@} @r{Smallest number in column.}
5288 @{max@} @r{Largest number.}
5289 @{mean@} @r{Arithmetic mean of numbers.}
5290 @{:min@} @r{Smallest time value in column.}
5291 @{:max@} @r{Largest time value.}
5292 @{:mean@} @r{Arithmetic mean of time values.}
5293 @{@@min@} @r{Minimum age (in days/hours/mins/seconds).}
5294 @{@@max@} @r{Maximum age (in days/hours/mins/seconds).}
5295 @{@@mean@} @r{Arithmetic mean of ages (in days/hours/mins/seconds).}
5296 @{est+@} @r{Add low-high estimates.}
5300 Be aware that you can only have one summary type for any property you
5301 include. Subsequent columns referencing the same property will all display the
5302 same summary information.
5304 The @code{est+} summary type requires further explanation. It is used for
5305 combining estimates, expressed as low-high ranges. For example, instead
5306 of estimating a particular task will take 5 days, you might estimate it as
5307 5--6 days if you're fairly confident you know how much work is required, or
5308 1--10 days if you don't really know what needs to be done. Both ranges
5309 average at 5.5 days, but the first represents a more predictable delivery.
5311 When combining a set of such estimates, simply adding the lows and highs
5312 produces an unrealistically wide result. Instead, @code{est+} adds the
5313 statistical mean and variance of the sub-tasks, generating a final estimate
5314 from the sum. For example, suppose you had ten tasks, each of which was
5315 estimated at 0.5 to 2 days of work. Straight addition produces an estimate
5316 of 5 to 20 days, representing what to expect if everything goes either
5317 extremely well or extremely poorly. In contrast, @code{est+} estimates the
5318 full job more realistically, at 10--15 days.
5320 Here is an example for a complete columns definition, along with allowed
5324 :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.}
5325 %10Time_Estimate@{:@} %CLOCKSUM %CLOCKSUM_T
5326 :Owner_ALL: Tammy Mark Karl Lisa Don
5327 :Status_ALL: "In progress" "Not started yet" "Finished" ""
5328 :Approved_ALL: "[ ]" "[X]"
5332 The first column, @samp{%25ITEM}, means the first 25 characters of the
5333 item itself, i.e., of the headline. You probably always should start the
5334 column definition with the @samp{ITEM} specifier. The other specifiers
5335 create columns @samp{Owner} with a list of names as allowed values, for
5336 @samp{Status} with four different possible values, and for a checkbox
5337 field @samp{Approved}. When no width is given after the @samp{%}
5338 character, the column will be exactly as wide as it needs to be in order
5339 to fully display all values. The @samp{Approved} column does have a
5340 modified title (@samp{Approved?}, with a question mark). Summaries will
5341 be created for the @samp{Time_Estimate} column by adding time duration
5342 expressions like HH:MM, and for the @samp{Approved} column, by providing
5343 an @samp{[X]} status if all children have been checked. The
5344 @samp{CLOCKSUM} and @samp{CLOCKSUM_T} columns are special, they lists the
5345 sums of CLOCK intervals in the subtree, either for all clocks or just for
5348 @node Using column view, Capturing column view, Defining columns, Column view
5349 @subsection Using column view
5352 @tsubheading{Turning column view on and off}
5353 @orgcmd{C-c C-x C-c,org-columns}
5354 @vindex org-columns-default-format
5355 Turn on column view. If the cursor is before the first headline in the file,
5356 column view is turned on for the entire file, using the @code{#+COLUMNS}
5357 definition. If the cursor is somewhere inside the outline, this command
5358 searches the hierarchy, up from point, for a @code{:COLUMNS:} property that
5359 defines a format. When one is found, the column view table is established
5360 for the tree starting at the entry that contains the @code{:COLUMNS:}
5361 property. If no such property is found, the format is taken from the
5362 @code{#+COLUMNS} line or from the variable @code{org-columns-default-format},
5363 and column view is established for the current entry and its subtree.
5364 @orgcmd{r,org-columns-redo}
5365 Recreate the column view, to include recent changes made in the buffer.
5366 @orgcmd{g,org-columns-redo}
5368 @orgcmd{q,org-columns-quit}
5370 @tsubheading{Editing values}
5371 @item @key{left} @key{right} @key{up} @key{down}
5372 Move through the column view from field to field.
5373 @kindex S-@key{left}
5374 @kindex S-@key{right}
5375 @item S-@key{left}/@key{right}
5376 Switch to the next/previous allowed value of the field. For this, you
5377 have to have specified allowed values for a property.
5379 Directly select the Nth allowed value, @kbd{0} selects the 10th value.
5380 @orgcmdkkcc{n,p,org-columns-next-allowed-value,org-columns-previous-allowed-value}
5381 Same as @kbd{S-@key{left}/@key{right}}
5382 @orgcmd{e,org-columns-edit-value}
5383 Edit the property at point. For the special properties, this will
5384 invoke the same interface that you normally use to change that
5385 property. For example, when editing a TAGS property, the tag completion
5386 or fast selection interface will pop up.
5387 @orgcmd{C-c C-c,org-columns-set-tags-or-toggle}
5388 When there is a checkbox at point, toggle it.
5389 @orgcmd{v,org-columns-show-value}
5390 View the full value of this property. This is useful if the width of
5391 the column is smaller than that of the value.
5392 @orgcmd{a,org-columns-edit-allowed}
5393 Edit the list of allowed values for this property. If the list is found
5394 in the hierarchy, the modified values is stored there. If no list is
5395 found, the new value is stored in the first entry that is part of the
5396 current column view.
5397 @tsubheading{Modifying the table structure}
5398 @orgcmdkkcc{<,>,org-columns-narrow,org-columns-widen}
5399 Make the column narrower/wider by one character.
5400 @orgcmd{S-M-@key{right},org-columns-new}
5401 Insert a new column, to the left of the current column.
5402 @orgcmd{S-M-@key{left},org-columns-delete}
5403 Delete the current column.
5406 @node Capturing column view, , Using column view, Column view
5407 @subsection Capturing column view
5409 Since column view is just an overlay over a buffer, it cannot be
5410 exported or printed directly. If you want to capture a column view, use
5411 a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame
5412 of this block looks like this:
5414 @cindex #+BEGIN, columnview
5417 #+BEGIN: columnview :hlines 1 :id "label"
5422 @noindent This dynamic block has the following parameters:
5426 This is the most important parameter. Column view is a feature that is
5427 often localized to a certain (sub)tree, and the capture block might be
5428 at a different location in the file. To identify the tree whose view to
5429 capture, you can use 4 values:
5430 @cindex property, ID
5432 local @r{use the tree in which the capture block is located}
5433 global @r{make a global view, including all headings in the file}
5434 "file:@var{path-to-file}"
5435 @r{run column view at the top of this file}
5436 "@var{ID}" @r{call column view in the tree that has an @code{:ID:}}
5437 @r{property with the value @i{label}. You can use}
5438 @r{@kbd{M-x org-id-copy} to create a globally unique ID for}
5439 @r{the current entry and copy it to the kill-ring.}
5442 When @code{t}, insert an hline after every line. When a number @var{N}, insert
5443 an hline before each headline with level @code{<= @var{N}}.
5445 When set to @code{t}, force column groups to get vertical lines.
5447 When set to a number, don't capture entries below this level.
5448 @item :skip-empty-rows
5449 When set to @code{t}, skip rows where the only non-empty specifier of the
5450 column view is @code{ITEM}.
5455 The following commands insert or update the dynamic block:
5458 @orgcmd{C-c C-x i,org-insert-columns-dblock}
5459 Insert a dynamic block capturing a column view. You will be prompted
5460 for the scope or ID of the view.
5461 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
5462 Update dynamic block at point. The cursor needs to be in the
5463 @code{#+BEGIN} line of the dynamic block.
5464 @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks}
5465 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
5466 you have several clock table blocks, column-capturing blocks or other dynamic
5470 You can add formulas to the column view table and you may add plotting
5471 instructions in front of the table---these will survive an update of the
5472 block. If there is a @code{#+TBLFM:} after the table, the table will
5473 actually be recalculated automatically after an update.
5475 An alternative way to capture and process property values into a table is
5476 provided by Eric Schulte's @file{org-collector.el} which is a contributed
5477 package@footnote{Contributed packages are not part of Emacs, but are
5478 distributed with the main distribution of Org (visit
5479 @uref{http://orgmode.org}).}. It provides a general API to collect
5480 properties from entries in a certain scope, and arbitrary Lisp expressions to
5481 process these values before inserting them into a table or a dynamic block.
5483 @node Property API, , Column view, Properties and Columns
5484 @section The Property API
5485 @cindex properties, API
5486 @cindex API, for properties
5488 There is a full API for accessing and changing properties. This API can
5489 be used by Emacs Lisp programs to work with properties and to implement
5490 features based on them. For more information see @ref{Using the
5493 @node Dates and Times, Capture - Refile - Archive, Properties and Columns, Top
5494 @chapter Dates and times
5500 To assist project planning, TODO items can be labeled with a date and/or
5501 a time. The specially formatted string carrying the date and time
5502 information is called a @emph{timestamp} in Org mode. This may be a
5503 little confusing because timestamp is often used as indicating when
5504 something was created or last changed. However, in Org mode this term
5505 is used in a much wider sense.
5508 * Timestamps:: Assigning a time to a tree entry
5509 * Creating timestamps:: Commands which insert timestamps
5510 * Deadlines and scheduling:: Planning your work
5511 * Clocking work time:: Tracking how long you spend on a task
5512 * Effort estimates:: Planning work effort in advance
5513 * Relative timer:: Notes with a running timer
5514 * Countdown timer:: Starting a countdown timer for a task
5518 @node Timestamps, Creating timestamps, Dates and Times, Dates and Times
5519 @section Timestamps, deadlines, and scheduling
5521 @cindex ranges, time
5526 A timestamp is a specification of a date (possibly with a time or a range of
5527 times) in a special format, either @samp{<2003-09-16 Tue>}@footnote{In this
5528 simplest form, the day name is optional when you type the date yourself.
5529 However, any dates inserted or modified by Org will add that day name, for
5530 reading convenience.} or @samp{<2003-09-16 Tue 09:39>} or @samp{<2003-09-16
5531 Tue 12:00-12:30>}@footnote{This is inspired by the standard ISO 8601
5532 date/time format. To use an alternative format, see @ref{Custom time
5533 format}.}. A timestamp can appear anywhere in the headline or body of an Org
5534 tree entry. Its presence causes entries to be shown on specific dates in the
5535 agenda (@pxref{Weekly/daily agenda}). We distinguish:
5538 @item Plain timestamp; Event; Appointment
5541 A simple timestamp just assigns a date/time to an item. This is just
5542 like writing down an appointment or event in a paper agenda. In the
5543 timeline and agenda displays, the headline of an entry associated with a
5544 plain timestamp will be shown exactly on that date.
5547 * Meet Peter at the movies
5548 <2006-11-01 Wed 19:15>
5549 * Discussion on climate change
5550 <2006-11-02 Thu 20:00-22:00>
5553 @item Timestamp with repeater interval
5554 @cindex timestamp, with repeater interval
5555 A timestamp may contain a @emph{repeater interval}, indicating that it
5556 applies not only on the given date, but again and again after a certain
5557 interval of N days (d), weeks (w), months (m), or years (y). The
5558 following will show up in the agenda every Wednesday:
5561 * Pick up Sam at school
5562 <2007-05-16 Wed 12:30 +1w>
5565 @item Diary-style sexp entries
5566 For more complex date specifications, Org mode supports using the special
5567 sexp diary entries implemented in the Emacs calendar/diary
5568 package@footnote{When working with the standard diary sexp functions, you
5569 need to be very careful with the order of the arguments. That order depend
5570 evilly on the variable @code{calendar-date-style} (or, for older Emacs
5571 versions, @code{european-calendar-style}). For example, to specify a date
5572 December 12, 2005, the call might look like @code{(diary-date 12 1 2005)} or
5573 @code{(diary-date 1 12 2005)} or @code{(diary-date 2005 12 1)}, depending on
5574 the settings. This has been the source of much confusion. Org mode users
5575 can resort to special versions of these functions like @code{org-date} or
5576 @code{org-anniversary}. These work just like the corresponding @code{diary-}
5577 functions, but with stable ISO order of arguments (year, month, day) wherever
5578 applicable, independent of the value of @code{calendar-date-style}.}. For
5579 example with optional time
5582 * 22:00-23:00 The nerd meeting on every 2nd Thursday of the month
5583 <%%(org-float t 4 2)>
5586 @item Time/Date range
5589 Two timestamps connected by @samp{--} denote a range. The headline
5590 will be shown on the first and last day of the range, and on any dates
5591 that are displayed and fall in the range. Here is an example:
5594 ** Meeting in Amsterdam
5595 <2004-08-23 Mon>--<2004-08-26 Thu>
5598 @item Inactive timestamp
5599 @cindex timestamp, inactive
5600 @cindex inactive timestamp
5601 Just like a plain timestamp, but with square brackets instead of
5602 angular ones. These timestamps are inactive in the sense that they do
5603 @emph{not} trigger an entry to show up in the agenda.
5606 * Gillian comes late for the fifth time
5612 @node Creating timestamps, Deadlines and scheduling, Timestamps, Dates and Times
5613 @section Creating timestamps
5614 @cindex creating timestamps
5615 @cindex timestamps, creating
5617 For Org mode to recognize timestamps, they need to be in the specific
5618 format. All commands listed below produce timestamps in the correct
5622 @orgcmd{C-c .,org-time-stamp}
5623 Prompt for a date and insert a corresponding timestamp. When the cursor is
5624 at an existing timestamp in the buffer, the command is used to modify this
5625 timestamp instead of inserting a new one. When this command is used twice in
5626 succession, a time range is inserted.
5628 @orgcmd{C-c !,org-time-stamp-inactive}
5629 Like @kbd{C-c .}, but insert an inactive timestamp that will not cause
5636 @vindex org-time-stamp-rounding-minutes
5637 Like @kbd{C-c .} and @kbd{C-c !}, but use the alternative format which
5638 contains date and time. The default time can be rounded to multiples of 5
5639 minutes, see the option @code{org-time-stamp-rounding-minutes}.
5642 Normalize timestamp, insert/fix day name if missing or wrong.
5644 @orgcmd{C-c <,org-date-from-calendar}
5645 Insert a timestamp corresponding to the cursor date in the Calendar.
5647 @orgcmd{C-c >,org-goto-calendar}
5648 Access the Emacs calendar for the current date. If there is a
5649 timestamp in the current line, go to the corresponding date
5652 @orgcmd{C-c C-o,org-open-at-point}
5653 Access the agenda for the date given by the timestamp or -range at
5654 point (@pxref{Weekly/daily agenda}).
5656 @orgcmdkkcc{S-@key{left},S-@key{right},org-timestamp-down-day,org-timestamp-up-day}
5657 Change date at cursor by one day. These key bindings conflict with
5658 shift-selection and related modes (@pxref{Conflicts}).
5660 @orgcmdkkcc{S-@key{up},S-@key{down},org-timestamp-up,org-timestamp-down-down}
5661 Change the item under the cursor in a timestamp. The cursor can be on a
5662 year, month, day, hour or minute. When the timestamp contains a time range
5663 like @samp{15:30-16:30}, modifying the first time will also shift the second,
5664 shifting the time block with constant length. To change the length, modify
5665 the second time. Note that if the cursor is in a headline and not at a
5666 timestamp, these same keys modify the priority of an item.
5667 (@pxref{Priorities}). The key bindings also conflict with shift-selection and
5668 related modes (@pxref{Conflicts}).
5670 @orgcmd{C-c C-y,org-evaluate-time-range}
5671 @cindex evaluate time range
5672 Evaluate a time range by computing the difference between start and end.
5673 With a prefix argument, insert result after the time range (in a table: into
5674 the following column).
5679 * The date/time prompt:: How Org mode helps you entering date and time
5680 * Custom time format:: Making dates look different
5683 @node The date/time prompt, Custom time format, Creating timestamps, Creating timestamps
5684 @subsection The date/time prompt
5685 @cindex date, reading in minibuffer
5686 @cindex time, reading in minibuffer
5688 @vindex org-read-date-prefer-future
5689 When Org mode prompts for a date/time, the default is shown in default
5690 date/time format, and the prompt therefore seems to ask for a specific
5691 format. But it will in fact accept date/time information in a variety of
5692 formats. Generally, the information should start at the beginning of the
5693 string. Org mode will find whatever information is in
5694 there and derive anything you have not specified from the @emph{default date
5695 and time}. The default is usually the current date and time, but when
5696 modifying an existing timestamp, or when entering the second stamp of a
5697 range, it is taken from the stamp in the buffer. When filling in
5698 information, Org mode assumes that most of the time you will want to enter a
5699 date in the future: if you omit the month/year and the given day/month is
5700 @i{before} today, it will assume that you mean a future date@footnote{See the
5701 variable @code{org-read-date-prefer-future}. You may set that variable to
5702 the symbol @code{time} to even make a time before now shift the date to
5703 tomorrow.}. If the date has been automatically shifted into the future, the
5704 time prompt will show this with @samp{(=>F).}
5706 For example, let's assume that today is @b{June 13, 2006}. Here is how
5707 various inputs will be interpreted, the items filled in by Org mode are
5711 3-2-5 @result{} 2003-02-05
5712 2/5/3 @result{} 2003-02-05
5713 14 @result{} @b{2006}-@b{06}-14
5714 12 @result{} @b{2006}-@b{07}-12
5715 2/5 @result{} @b{2007}-02-05
5716 Fri @result{} nearest Friday (default date or later)
5717 sep 15 @result{} @b{2006}-09-15
5718 feb 15 @result{} @b{2007}-02-15
5719 sep 12 9 @result{} 2009-09-12
5720 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45
5721 22 sept 0:34 @result{} @b{2006}-09-22 0:34
5722 w4 @result{} ISO week for of the current year @b{2006}
5723 2012 w4 fri @result{} Friday of ISO week 4 in 2012
5724 2012-w04-5 @result{} Same as above
5727 Furthermore you can specify a relative date by giving, as the
5728 @emph{first} thing in the input: a plus/minus sign, a number and a
5729 letter ([dwmy]) to indicate change in days, weeks, months, or years. With a
5730 single plus or minus, the date is always relative to today. With a
5731 double plus or minus, it is relative to the default date. If instead of
5732 a single letter, you use the abbreviation of day name, the date will be
5733 the Nth such day, e.g.:
5738 +4d @result{} four days from today
5739 +4 @result{} same as above
5740 +2w @result{} two weeks from today
5741 ++5 @result{} five days from default date
5742 +2tue @result{} second Tuesday from now.
5745 @vindex parse-time-months
5746 @vindex parse-time-weekdays
5747 The function understands English month and weekday abbreviations. If
5748 you want to use unabbreviated names and/or other languages, configure
5749 the variables @code{parse-time-months} and @code{parse-time-weekdays}.
5751 @vindex org-read-date-force-compatible-dates
5752 Not all dates can be represented in a given Emacs implementation. By default
5753 Org mode forces dates into the compatibility range 1970--2037 which works on
5754 all Emacs implementations. If you want to use dates outside of this range,
5755 read the docstring of the variable
5756 @code{org-read-date-force-compatible-dates}.
5758 You can specify a time range by giving start and end times or by giving a
5759 start time and a duration (in HH:MM format). Use one or two dash(es) as the
5760 separator in the former case and use '+' as the separator in the latter
5764 11am-1:15pm @result{} 11:00-13:15
5765 11am--1:15pm @result{} same as above
5766 11am+2:15 @result{} same as above
5769 @cindex calendar, for selecting date
5770 @vindex org-popup-calendar-for-date-prompt
5771 Parallel to the minibuffer prompt, a calendar is popped up@footnote{If
5772 you don't need/want the calendar, configure the variable
5773 @code{org-popup-calendar-for-date-prompt}.}. When you exit the date
5774 prompt, either by clicking on a date in the calendar, or by pressing
5775 @key{RET}, the date selected in the calendar will be combined with the
5776 information entered at the prompt. You can control the calendar fully
5777 from the minibuffer:
5784 @kindex S-@key{right}
5785 @kindex S-@key{left}
5786 @kindex S-@key{down}
5788 @kindex M-S-@key{right}
5789 @kindex M-S-@key{left}
5792 @key{RET} @r{Choose date at cursor in calendar.}
5793 mouse-1 @r{Select date by clicking on it.}
5794 S-@key{right}/@key{left} @r{One day forward/backward.}
5795 S-@key{down}/@key{up} @r{One week forward/backward.}
5796 M-S-@key{right}/@key{left} @r{One month forward/backward.}
5797 > / < @r{Scroll calendar forward/backward by one month.}
5798 M-v / C-v @r{Scroll calendar forward/backward by 3 months.}
5801 @vindex org-read-date-display-live
5802 The actions of the date/time prompt may seem complex, but I assure you they
5803 will grow on you, and you will start getting annoyed by pretty much any other
5804 way of entering a date/time out there. To help you understand what is going
5805 on, the current interpretation of your input will be displayed live in the
5806 minibuffer@footnote{If you find this distracting, turn the display of with
5807 @code{org-read-date-display-live}.}.
5809 @node Custom time format, , The date/time prompt, Creating timestamps
5810 @subsection Custom time format
5811 @cindex custom date/time format
5812 @cindex time format, custom
5813 @cindex date format, custom
5815 @vindex org-display-custom-times
5816 @vindex org-time-stamp-custom-formats
5817 Org mode uses the standard ISO notation for dates and times as it is
5818 defined in ISO 8601. If you cannot get used to this and require another
5819 representation of date and time to keep you happy, you can get it by
5820 customizing the variables @code{org-display-custom-times} and
5821 @code{org-time-stamp-custom-formats}.
5824 @orgcmd{C-c C-x C-t,org-toggle-time-stamp-overlays}
5825 Toggle the display of custom formats for dates and times.
5829 Org mode needs the default format for scanning, so the custom date/time
5830 format does not @emph{replace} the default format---instead it is put
5831 @emph{over} the default format using text properties. This has the
5832 following consequences:
5835 You cannot place the cursor onto a timestamp anymore, only before or
5838 The @kbd{S-@key{up}/@key{down}} keys can no longer be used to adjust
5839 each component of a timestamp. If the cursor is at the beginning of
5840 the stamp, @kbd{S-@key{up}/@key{down}} will change the stamp by one day,
5841 just like @kbd{S-@key{left}/@key{right}}. At the end of the stamp, the
5842 time will be changed by one minute.
5844 If the timestamp contains a range of clock times or a repeater, these
5845 will not be overlaid, but remain in the buffer as they were.
5847 When you delete a timestamp character-by-character, it will only
5848 disappear from the buffer after @emph{all} (invisible) characters
5849 belonging to the ISO timestamp have been removed.
5851 If the custom timestamp format is longer than the default and you are
5852 using dates in tables, table alignment will be messed up. If the custom
5853 format is shorter, things do work as expected.
5857 @node Deadlines and scheduling, Clocking work time, Creating timestamps, Dates and Times
5858 @section Deadlines and scheduling
5860 A timestamp may be preceded by special keywords to facilitate planning:
5864 @cindex DEADLINE keyword
5866 Meaning: the task (most likely a TODO item, though not necessarily) is supposed
5867 to be finished on that date.
5869 @vindex org-deadline-warning-days
5870 On the deadline date, the task will be listed in the agenda. In
5871 addition, the agenda for @emph{today} will carry a warning about the
5872 approaching or missed deadline, starting
5873 @code{org-deadline-warning-days} before the due date, and continuing
5874 until the entry is marked DONE@. An example:
5877 *** TODO write article about the Earth for the Guide
5878 DEADLINE: <2004-02-29 Sun>
5879 The editor in charge is [[bbdb:Ford Prefect]]
5882 You can specify a different lead time for warnings for a specific
5883 deadlines using the following syntax. Here is an example with a warning
5884 period of 5 days @code{DEADLINE: <2004-02-29 Sun -5d>}.
5887 @cindex SCHEDULED keyword
5889 Meaning: you are planning to start working on that task on the given
5892 @vindex org-agenda-skip-scheduled-if-done
5893 The headline will be listed under the given date@footnote{It will still
5894 be listed on that date after it has been marked DONE@. If you don't like
5895 this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In
5896 addition, a reminder that the scheduled date has passed will be present
5897 in the compilation for @emph{today}, until the entry is marked DONE, i.e.,
5898 the task will automatically be forwarded until completed.
5901 *** TODO Call Trillian for a date on New Years Eve.
5902 SCHEDULED: <2004-12-25 Sat>
5906 @b{Important:} Scheduling an item in Org mode should @i{not} be
5907 understood in the same way that we understand @i{scheduling a meeting}.
5908 Setting a date for a meeting is just a simple appointment, you should
5909 mark this entry with a simple plain timestamp, to get this item shown
5910 on the date where it applies. This is a frequent misunderstanding by
5911 Org users. In Org mode, @i{scheduling} means setting a date when you
5912 want to start working on an action item.
5915 You may use timestamps with repeaters in scheduling and deadline
5916 entries. Org mode will issue early and late warnings based on the
5917 assumption that the timestamp represents the @i{nearest instance} of
5918 the repeater. However, the use of diary sexp entries like
5920 @code{<%%(org-float t 42)>}
5922 in scheduling and deadline timestamps is limited. Org mode does not
5923 know enough about the internals of each sexp function to issue early and
5924 late warnings. However, it will show the item on each day where the
5928 * Inserting deadline/schedule:: Planning items
5929 * Repeated tasks:: Items that show up again and again
5932 @node Inserting deadline/schedule, Repeated tasks, Deadlines and scheduling, Deadlines and scheduling
5933 @subsection Inserting deadlines or schedules
5935 The following commands allow you to quickly insert@footnote{The @samp{SCHEDULED} and
5936 @samp{DEADLINE} dates are inserted on the line right below the headline. Don't put
5937 any text between this line and the headline.} a deadline or to schedule
5942 @orgcmd{C-c C-d,org-deadline}
5943 Insert @samp{DEADLINE} keyword along with a stamp. The insertion will happen
5944 in the line directly following the headline. Any CLOSED timestamp will be
5945 removed. When called with a prefix arg, an existing deadline will be removed
5946 from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding
5947 @code{#+STARTUP} keywords @code{logredeadline}, @code{lognoteredeadline},
5948 and @code{nologredeadline}}, a note will be taken when changing an existing
5951 @orgcmd{C-c C-s,org-schedule}
5952 Insert @samp{SCHEDULED} keyword along with a stamp. The insertion will
5953 happen in the line directly following the headline. Any CLOSED timestamp
5954 will be removed. When called with a prefix argument, remove the scheduling
5955 date from the entry. Depending on the variable
5956 @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP}
5957 keywords @code{logreschedule}, @code{lognotereschedule}, and
5958 @code{nologreschedule}}, a note will be taken when changing an existing
5961 @orgcmd{C-c C-x C-k,org-mark-entry-for-agenda-action}
5964 Mark the current entry for agenda action. After you have marked the entry
5965 like this, you can open the agenda or the calendar to find an appropriate
5966 date. With the cursor on the selected date, press @kbd{k s} or @kbd{k d} to
5967 schedule the marked item.
5969 @orgcmd{C-c / d,org-check-deadlines}
5970 @cindex sparse tree, for deadlines
5971 @vindex org-deadline-warning-days
5972 Create a sparse tree with all deadlines that are either past-due, or
5973 which will become due within @code{org-deadline-warning-days}.
5974 With @kbd{C-u} prefix, show all deadlines in the file. With a numeric
5975 prefix, check that many days. For example, @kbd{C-1 C-c / d} shows
5976 all deadlines due tomorrow.
5978 @orgcmd{C-c / b,org-check-before-date}
5979 Sparse tree for deadlines and scheduled items before a given date.
5981 @orgcmd{C-c / a,org-check-after-date}
5982 Sparse tree for deadlines and scheduled items after a given date.
5985 Note that @code{org-schedule} and @code{org-deadline} supports
5986 setting the date by indicating a relative time: e.g., +1d will set
5987 the date to the next day after today, and --1w will set the date
5988 to the previous week before any current timestamp.
5990 @node Repeated tasks, , Inserting deadline/schedule, Deadlines and scheduling
5991 @subsection Repeated tasks
5992 @cindex tasks, repeated
5993 @cindex repeated tasks
5995 Some tasks need to be repeated again and again. Org mode helps to
5996 organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED,
5997 or plain timestamp. In the following example
5999 ** TODO Pay the rent
6000 DEADLINE: <2005-10-01 Sat +1m>
6003 the @code{+1m} is a repeater; the intended interpretation is that the task
6004 has a deadline on <2005-10-01> and repeats itself every (one) month starting
6005 from that time. You can use yearly, monthly, weekly, daily and hourly repeat
6006 cookies by using the @code{y/w/m/d/h} letters. If you need both a repeater
6007 and a special warning period in a deadline entry, the repeater should come
6008 first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}.
6010 @vindex org-todo-repeat-to-state
6011 Deadlines and scheduled items produce entries in the agenda when they are
6012 over-due, so it is important to be able to mark such an entry as completed
6013 once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO
6014 keyword DONE, it will no longer produce entries in the agenda. The problem
6015 with this is, however, that then also the @emph{next} instance of the
6016 repeated entry will not be active. Org mode deals with this in the following
6017 way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will
6018 shift the base date of the repeating timestamp by the repeater interval, and
6019 immediately set the entry state back to TODO@footnote{In fact, the target
6020 state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or
6021 the variable @code{org-todo-repeat-to-state}. If neither of these is
6022 specified, the target state defaults to the first state of the TODO state
6023 sequence.}. In the example above, setting the state to DONE would actually
6024 switch the date like this:
6027 ** TODO Pay the rent
6028 DEADLINE: <2005-11-01 Tue +1m>
6031 @vindex org-log-repeat
6032 A timestamp@footnote{You can change this using the option
6033 @code{org-log-repeat}, or the @code{#+STARTUP} options @code{logrepeat},
6034 @code{lognoterepeat}, and @code{nologrepeat}. With @code{lognoterepeat}, you
6035 will also be prompted for a note.} will be added under the deadline, to keep
6036 a record that you actually acted on the previous instance of this deadline.
6038 As a consequence of shifting the base date, this entry will no longer be
6039 visible in the agenda when checking past dates, but all future instances
6042 With the @samp{+1m} cookie, the date shift will always be exactly one
6043 month. So if you have not paid the rent for three months, marking this
6044 entry DONE will still keep it as an overdue deadline. Depending on the
6045 task, this may not be the best way to handle it. For example, if you
6046 forgot to call your father for 3 weeks, it does not make sense to call
6047 him 3 times in a single day to make up for it. Finally, there are tasks
6048 like changing batteries which should always repeat a certain time
6049 @i{after} the last time you did it. For these tasks, Org mode has
6050 special repeaters @samp{++} and @samp{.+}. For example:
6054 DEADLINE: <2008-02-10 Sun ++1w>
6055 Marking this DONE will shift the date by at least one week,
6056 but also by as many weeks as it takes to get this date into
6057 the future. However, it stays on a Sunday, even if you called
6058 and marked it done on Saturday.
6059 ** TODO Check the batteries in the smoke detectors
6060 DEADLINE: <2005-11-01 Tue .+1m>
6061 Marking this DONE will shift the date to one month after
6065 You may have both scheduling and deadline information for a specific
6066 task---just make sure that the repeater intervals on both are the same.
6068 An alternative to using a repeater is to create a number of copies of a task
6069 subtree, with dates shifted in each copy. The command @kbd{C-c C-x c} was
6070 created for this purpose, it is described in @ref{Structure editing}.
6073 @node Clocking work time, Effort estimates, Deadlines and scheduling, Dates and Times
6074 @section Clocking work time
6075 @cindex clocking time
6076 @cindex time clocking
6078 Org mode allows you to clock the time you spend on specific tasks in a
6079 project. When you start working on an item, you can start the clock. When
6080 you stop working on that task, or when you mark the task done, the clock is
6081 stopped and the corresponding time interval is recorded. It also computes
6082 the total time spent on each subtree@footnote{Clocking only works if all
6083 headings are indented with less than 30 stars. This is a hardcoded
6084 limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a
6085 history or tasks recently clocked, to that you can jump quickly between a
6086 number of tasks absorbing your time.
6088 To save the clock history across Emacs sessions, use
6090 (setq org-clock-persist 'history)
6091 (org-clock-persistence-insinuate)
6093 When you clock into a new task after resuming Emacs, the incomplete
6094 clock@footnote{To resume the clock under the assumption that you have worked
6095 on this task while outside Emacs, use @code{(setq org-clock-persist t)}.}
6096 will be found (@pxref{Resolving idle time}) and you will be prompted about
6100 * Clocking commands:: Starting and stopping a clock
6101 * The clock table:: Detailed reports
6102 * Resolving idle time:: Resolving time when you've been idle
6105 @node Clocking commands, The clock table, Clocking work time, Clocking work time
6106 @subsection Clocking commands
6109 @orgcmd{C-c C-x C-i,org-clock-in}
6110 @vindex org-clock-into-drawer
6111 @vindex org-clock-continuously
6112 @cindex property, LOG_INTO_DRAWER
6113 Start the clock on the current item (clock-in). This inserts the CLOCK
6114 keyword together with a timestamp. If this is not the first clocking of
6115 this item, the multiple CLOCK lines will be wrapped into a
6116 @code{:LOGBOOK:} drawer (see also the variable
6117 @code{org-clock-into-drawer}). You can also overrule
6118 the setting of this variable for a subtree by setting a
6119 @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property.
6120 When called with a @kbd{C-u} prefix argument,
6121 select the task from a list of recently clocked tasks. With two @kbd{C-u
6122 C-u} prefixes, clock into the task at point and mark it as the default task;
6123 the default task will then always be available with letter @kbd{d} when
6124 selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force
6125 continuous clocking by starting the clock when the last clock stopped.@*
6126 @cindex property: CLOCK_MODELINE_TOTAL
6127 @cindex property: LAST_REPEAT
6128 @vindex org-clock-modeline-total
6129 While the clock is running, the current clocking time is shown in the mode
6130 line, along with the title of the task. The clock time shown will be all
6131 time ever clocked for this task and its children. If the task has an effort
6132 estimate (@pxref{Effort estimates}), the mode line displays the current
6133 clocking time against it@footnote{To add an effort estimate ``on the fly'',
6134 hook a function doing this to @code{org-clock-in-prepare-hook}.} If the task
6135 is a repeating one (@pxref{Repeated tasks}), only the time since the last
6136 reset of the task @footnote{as recorded by the @code{LAST_REPEAT} property}
6137 will be shown. More control over what time is shown can be exercised with
6138 the @code{CLOCK_MODELINE_TOTAL} property. It may have the values
6139 @code{current} to show only the current clocking instance, @code{today} to
6140 show all time clocked on this tasks today (see also the variable
6141 @code{org-extend-today-until}), @code{all} to include all time, or
6142 @code{auto} which is the default@footnote{See also the variable
6143 @code{org-clock-modeline-total}.}.@* Clicking with @kbd{mouse-1} onto the
6144 mode line entry will pop up a menu with clocking options.
6146 @orgcmd{C-c C-x C-o,org-clock-out}
6147 @vindex org-log-note-clock-out
6148 Stop the clock (clock-out). This inserts another timestamp at the same
6149 location where the clock was last started. It also directly computes
6150 the resulting time in inserts it after the time range as @samp{=>
6151 HH:MM}. See the variable @code{org-log-note-clock-out} for the
6152 possibility to record an additional note together with the clock-out
6153 timestamp@footnote{The corresponding in-buffer setting is:
6154 @code{#+STARTUP: lognoteclock-out}}.
6155 @orgcmd{C-c C-x C-x,org-clock-in-last}
6156 @vindex org-clock-continuously
6157 Reclock the last clocked task. With one @kbd{C-u} prefix argument,
6158 select the task from the clock history. With two @kbd{C-u} prefixes,
6159 force continuous clocking by starting the clock when the last clock
6161 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6162 Update the effort estimate for the current clock task.
6165 @orgcmdkkc{C-c C-c,C-c C-y,org-evaluate-time-range}
6166 Recompute the time interval after changing one of the timestamps. This
6167 is only necessary if you edit the timestamps directly. If you change
6168 them with @kbd{S-@key{cursor}} keys, the update is automatic.
6169 @orgcmd{C-S-@key{up/down},org-clock-timestamps-up/down}
6170 On @code{CLOCK} log lines, increase/decrease both timestamps so that the
6171 clock duration keeps the same.
6172 @orgcmd{S-M-@key{up/down},org-timestamp-up/down}
6173 On @code{CLOCK} log lines, increase/decrease the timestamp at point and
6174 the one of the previous (or the next clock) timestamp by the same duration.
6175 For example, if you hit @kbd{S-M-@key{up}} to increase a clocked-out timestamp
6176 by five minutes, then the clocked-in timestamp of the next clock will be
6177 increased by five minutes.
6178 @orgcmd{C-c C-t,org-todo}
6179 Changing the TODO state of an item to DONE automatically stops the clock
6180 if it is running in this same item.
6181 @orgcmd{C-c C-x C-q,org-clock-cancel}
6182 Cancel the current clock. This is useful if a clock was started by
6183 mistake, or if you ended up working on something else.
6184 @orgcmd{C-c C-x C-j,org-clock-goto}
6185 Jump to the headline of the currently clocked in task. With a @kbd{C-u}
6186 prefix arg, select the target task from a list of recently clocked tasks.
6187 @orgcmd{C-c C-x C-d,org-clock-display}
6188 @vindex org-remove-highlights-with-change
6189 Display time summaries for each subtree in the current buffer. This puts
6190 overlays at the end of each headline, showing the total time recorded under
6191 that heading, including the time of any subheadings. You can use visibility
6192 cycling to study the tree, but the overlays disappear when you change the
6193 buffer (see variable @code{org-remove-highlights-with-change}) or press
6197 The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in
6198 the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
6199 worked on or closed during a day.
6201 @strong{Important:} note that both @code{org-clock-out} and
6202 @code{org-clock-in-last} can have a global keybinding and will not
6203 modify the window disposition.
6205 @node The clock table, Resolving idle time, Clocking commands, Clocking work time
6206 @subsection The clock table
6207 @cindex clocktable, dynamic block
6208 @cindex report, of clocked time
6210 Org mode can produce quite complex reports based on the time clocking
6211 information. Such a report is called a @emph{clock table}, because it is
6212 formatted as one or several Org tables.
6215 @orgcmd{C-c C-x C-r,org-clock-report}
6216 Insert a dynamic block (@pxref{Dynamic blocks}) containing a clock
6217 report as an Org mode table into the current file. When the cursor is
6218 at an existing clock table, just update it. When called with a prefix
6219 argument, jump to the first clock report in the current document and
6220 update it. The clock table always includes also trees with
6221 @code{:ARCHIVE:} tag.
6222 @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update}
6223 Update dynamic block at point. The cursor needs to be in the
6224 @code{#+BEGIN} line of the dynamic block.
6225 @orgkey{C-u C-c C-x C-u}
6226 Update all dynamic blocks (@pxref{Dynamic blocks}). This is useful if
6227 you have several clock table blocks in a buffer.
6228 @orgcmdkxkc{S-@key{left},S-@key{right},org-clocktable-try-shift}
6229 Shift the current @code{:block} interval and update the table. The cursor
6230 needs to be in the @code{#+BEGIN: clocktable} line for this command. If
6231 @code{:block} is @code{today}, it will be shifted to @code{today-1} etc.
6235 Here is an example of the frame for a clock table as it is inserted into the
6236 buffer with the @kbd{C-c C-x C-r} command:
6238 @cindex #+BEGIN, clocktable
6240 #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
6244 @vindex org-clocktable-defaults
6245 The @samp{BEGIN} line and specify a number of options to define the scope,
6246 structure, and formatting of the report. Defaults for all these options can
6247 be configured in the variable @code{org-clocktable-defaults}.
6249 @noindent First there are options that determine which clock entries are to
6252 :maxlevel @r{Maximum level depth to which times are listed in the table.}
6253 @r{Clocks at deeper levels will be summed into the upper level.}
6254 :scope @r{The scope to consider. This can be any of the following:}
6255 nil @r{the current buffer or narrowed region}
6256 file @r{the full current buffer}
6257 subtree @r{the subtree where the clocktable is located}
6258 tree@var{N} @r{the surrounding level @var{N} tree, for example @code{tree3}}
6259 tree @r{the surrounding level 1 tree}
6260 agenda @r{all agenda files}
6261 ("file"..) @r{scan these files}
6262 file-with-archives @r{current file and its archives}
6263 agenda-with-archives @r{all agenda files, including archives}
6264 :block @r{The time block to consider. This block is specified either}
6265 @r{absolute, or relative to the current time and may be any of}
6267 2007-12-31 @r{New year eve 2007}
6268 2007-12 @r{December 2007}
6269 2007-W50 @r{ISO-week 50 in 2007}
6270 2007-Q2 @r{2nd quarter in 2007}
6271 2007 @r{the year 2007}
6272 today, yesterday, today-@var{N} @r{a relative day}
6273 thisweek, lastweek, thisweek-@var{N} @r{a relative week}
6274 thismonth, lastmonth, thismonth-@var{N} @r{a relative month}
6275 thisyear, lastyear, thisyear-@var{N} @r{a relative year}
6276 @r{Use @kbd{S-@key{left}/@key{right}} keys to shift the time interval.}
6277 :tstart @r{A time string specifying when to start considering times.}
6278 @r{Relative times like @code{"<-2w>"} can also be used. See}
6279 @r{@ref{Matching tags and properties} for relative time syntax.}
6280 :tend @r{A time string specifying when to stop considering times.}
6281 @r{Relative times like @code{"<now>"} can also be used. See}
6282 @r{@ref{Matching tags and properties} for relative time syntax.}
6283 :wstart @r{The starting day of the week. The default is 1 for monday.}
6284 :step @r{@code{week} or @code{day}, to split the table into chunks.}
6285 @r{To use this, @code{:block} or @code{:tstart}, @code{:tend} are needed.}
6286 :stepskip0 @r{Do not show steps that have zero time.}
6287 :fileskip0 @r{Do not show table sections from files which did not contribute.}
6288 :tags @r{A tags match to select entries that should contribute. See}
6289 @r{@ref{Matching tags and properties} for the match syntax.}
6292 Then there are options which determine the formatting of the table. There
6293 options are interpreted by the function @code{org-clocktable-write-default},
6294 but you can specify your own function using the @code{:formatter} parameter.
6296 :emphasize @r{When @code{t}, emphasize level one and level two items.}
6297 :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".}
6298 :link @r{Link the item headlines in the table to their origins.}
6299 :narrow @r{An integer to limit the width of the headline column in}
6300 @r{the org table. If you write it like @samp{50!}, then the}
6301 @r{headline will also be shortened in export.}
6302 :indent @r{Indent each headline field according to its level.}
6303 :tcolumns @r{Number of columns to be used for times. If this is smaller}
6304 @r{than @code{:maxlevel}, lower levels will be lumped into one column.}
6305 :level @r{Should a level number column be included?}
6306 :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}}
6307 @r{All are overwritten except if there is an explicit @code{:narrow}}
6308 :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,}
6309 @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
6310 :properties @r{List of properties that should be shown in the table. Each}
6311 @r{property will get its own column.}
6312 :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.}
6313 :formula @r{Content of a @code{#+TBLFM} line to be added and evaluated.}
6314 @r{As a special case, @samp{:formula %} adds a column with % time.}
6315 @r{If you do not specify a formula here, any existing formula}
6316 @r{below the clock table will survive updates and be evaluated.}
6317 :formatter @r{A function to format clock data and insert it into the buffer.}
6319 To get a clock summary of the current level 1 tree, for the current
6320 day, you could write
6322 #+BEGIN: clocktable :maxlevel 2 :block today :scope tree1 :link t
6326 and to use a specific time range you could write@footnote{Note that all
6327 parameters must be specified in a single line---the line is broken here
6328 only to fit it into the manual.}
6330 #+BEGIN: clocktable :tstart "<2006-08-10 Thu 10:00>"
6331 :tend "<2006-08-10 Thu 12:00>"
6334 A range starting a week ago and ending right now could be written as
6336 #+BEGIN: clocktable :tstart "<-1w>" :tend "<now>"
6339 A summary of the current subtree with % times would be
6341 #+BEGIN: clocktable :scope subtree :link t :formula %
6344 A horizontally compact representation of everything clocked during last week
6347 #+BEGIN: clocktable :scope agenda :block lastweek :compact t
6351 @node Resolving idle time, , The clock table, Clocking work time
6352 @subsection Resolving idle time and continuous clocking
6354 @subsubheading Resolving idle time
6355 @cindex resolve idle time
6357 @cindex idle, resolve, dangling
6358 If you clock in on a work item, and then walk away from your
6359 computer---perhaps to take a phone call---you often need to ``resolve'' the
6360 time you were away by either subtracting it from the current clock, or
6361 applying it to another one.
6363 @vindex org-clock-idle-time
6364 By customizing the variable @code{org-clock-idle-time} to some integer, such
6365 as 10 or 15, Emacs can alert you when you get back to your computer after
6366 being idle for that many minutes@footnote{On computers using Mac OS X,
6367 idleness is based on actual user idleness, not just Emacs' idle time. For
6368 X11, you can install a utility program @file{x11idle.c}, available in the
6369 @code{contrib/scripts} directory of the Org git distribution, to get the same
6370 general treatment of idleness. On other systems, idle time refers to Emacs
6371 idle time only.}, and ask what you want to do with the idle time. There will
6372 be a question waiting for you when you get back, indicating how much idle
6373 time has passed (constantly updated with the current amount), as well as a
6374 set of choices to correct the discrepancy:
6378 To keep some or all of the minutes and stay clocked in, press @kbd{k}. Org
6379 will ask how many of the minutes to keep. Press @key{RET} to keep them all,
6380 effectively changing nothing, or enter a number to keep that many minutes.
6382 If you use the shift key and press @kbd{K}, it will keep however many minutes
6383 you request and then immediately clock out of that task. If you keep all of
6384 the minutes, this is the same as just clocking out of the current task.
6386 To keep none of the minutes, use @kbd{s} to subtract all the away time from
6387 the clock, and then check back in from the moment you returned.
6389 To keep none of the minutes and just clock out at the start of the away time,
6390 use the shift key and press @kbd{S}. Remember that using shift will always
6391 leave you clocked out, no matter which option you choose.
6393 To cancel the clock altogether, use @kbd{C}. Note that if instead of
6394 canceling you subtract the away time, and the resulting clock amount is less
6395 than a minute, the clock will still be canceled rather than clutter up the
6396 log with an empty entry.
6399 What if you subtracted those away minutes from the current clock, and now
6400 want to apply them to a new clock? Simply clock in to any task immediately
6401 after the subtraction. Org will notice that you have subtracted time ``on
6402 the books'', so to speak, and will ask if you want to apply those minutes to
6403 the next task you clock in on.
6405 There is one other instance when this clock resolution magic occurs. Say you
6406 were clocked in and hacking away, and suddenly your cat chased a mouse who
6407 scared a hamster that crashed into your UPS's power button! You suddenly
6408 lose all your buffers, but thanks to auto-save you still have your recent Org
6409 mode changes, including your last clock in.
6411 If you restart Emacs and clock into any task, Org will notice that you have a
6412 dangling clock which was never clocked out from your last session. Using
6413 that clock's starting time as the beginning of the unaccounted-for period,
6414 Org will ask how you want to resolve that time. The logic and behavior is
6415 identical to dealing with away time due to idleness; it is just happening due
6416 to a recovery event rather than a set amount of idle time.
6418 You can also check all the files visited by your Org agenda for dangling
6419 clocks at any time using @kbd{M-x org-resolve-clocks RET} (or @kbd{C-c C-x C-z}).
6421 @subsubheading Continuous clocking
6422 @cindex continuous clocking
6423 @vindex org-clock-continuously
6425 You may want to start clocking from the time when you clocked out the
6426 previous task. To enable this systematically, set @code{org-clock-continuously}
6427 to @code{t}. Each time you clock in, Org retrieves the clock-out time of the
6428 last clocked entry for this session, and start the new clock from there.
6430 If you only want this from time to time, use three universal prefix arguments
6431 with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}.
6433 @node Effort estimates, Relative timer, Clocking work time, Dates and Times
6434 @section Effort estimates
6435 @cindex effort estimates
6437 @cindex property, Effort
6438 @vindex org-effort-property
6439 If you want to plan your work in a very detailed way, or if you need to
6440 produce offers with quotations of the estimated work effort, you may want to
6441 assign effort estimates to entries. If you are also clocking your work, you
6442 may later want to compare the planned effort with the actual working time, a
6443 great way to improve planning estimates. Effort estimates are stored in a
6444 special property @samp{Effort}@footnote{You may change the property being
6445 used with the variable @code{org-effort-property}.}. You can set the effort
6446 for an entry with the following commands:
6449 @orgcmd{C-c C-x e,org-set-effort}
6450 Set the effort estimate for the current entry. With a numeric prefix
6451 argument, set it to the Nth allowed value (see below). This command is also
6452 accessible from the agenda with the @kbd{e} key.
6453 @orgcmd{C-c C-x C-e,org-clock-modify-effort-estimate}
6454 Modify the effort estimate of the item currently being clocked.
6457 Clearly the best way to work with effort estimates is through column view
6458 (@pxref{Column view}). You should start by setting up discrete values for
6459 effort estimates, and a @code{COLUMNS} format that displays these values
6460 together with clock sums (if you want to clock your time). For a specific
6464 #+PROPERTY: Effort_ALL 0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00
6465 #+COLUMNS: %40ITEM(Task) %17Effort(Estimated Effort)@{:@} %CLOCKSUM
6469 @vindex org-global-properties
6470 @vindex org-columns-default-format
6471 or, even better, you can set up these values globally by customizing the
6472 variables @code{org-global-properties} and @code{org-columns-default-format}.
6473 In particular if you want to use this setup also in the agenda, a global
6474 setup may be advised.
6476 The way to assign estimates to individual items is then to switch to column
6477 mode, and to use @kbd{S-@key{right}} and @kbd{S-@key{left}} to change the
6478 value. The values you enter will immediately be summed up in the hierarchy.
6479 In the column next to it, any clocked time will be displayed.
6481 @vindex org-agenda-columns-add-appointments-to-effort-sum
6482 If you switch to column view in the daily/weekly agenda, the effort column
6483 will summarize the estimated work effort for each day@footnote{Please note
6484 the pitfalls of summing hierarchical data in a flat list (@pxref{Agenda
6485 column view}).}, and you can use this to find space in your schedule. To get
6486 an overview of the entire part of the day that is committed, you can set the
6487 option @code{org-agenda-columns-add-appointments-to-effort-sum}. The
6488 appointments on a day that take place over a specified time interval will
6489 then also be added to the load estimate of the day.
6491 Effort estimates can be used in secondary agenda filtering that is triggered
6492 with the @kbd{/} key in the agenda (@pxref{Agenda commands}). If you have
6493 these estimates defined consistently, two or three key presses will narrow
6494 down the list to stuff that fits into an available time slot.
6496 @node Relative timer, Countdown timer, Effort estimates, Dates and Times
6497 @section Taking notes with a relative timer
6498 @cindex relative timer
6500 When taking notes during, for example, a meeting or a video viewing, it can
6501 be useful to have access to times relative to a starting time. Org provides
6502 such a relative timer and make it easy to create timed notes.
6505 @orgcmd{C-c C-x .,org-timer}
6506 Insert a relative time into the buffer. The first time you use this, the
6507 timer will be started. When called with a prefix argument, the timer is
6509 @orgcmd{C-c C-x -,org-timer-item}
6510 Insert a description list item with the current relative time. With a prefix
6511 argument, first reset the timer to 0.
6512 @orgcmd{M-@key{RET},org-insert-heading}
6513 Once the timer list is started, you can also use @kbd{M-@key{RET}} to insert
6515 @c for key sequences with a comma, command name macros fail :(
6518 Pause the timer, or continue it if it is already paused
6519 (@command{org-timer-pause-or-continue}).
6520 @c removed the sentence because it is redundant to the following item
6521 @kindex C-u C-c C-x ,
6523 Stop the timer. After this, you can only start a new timer, not continue the
6524 old one. This command also removes the timer from the mode line.
6525 @orgcmd{C-c C-x 0,org-timer-start}
6526 Reset the timer without inserting anything into the buffer. By default, the
6527 timer is reset to 0. When called with a @kbd{C-u} prefix, reset the timer to
6528 specific starting offset. The user is prompted for the offset, with a
6529 default taken from a timer string at point, if any, So this can be used to
6530 restart taking notes after a break in the process. When called with a double
6531 prefix argument @kbd{C-u C-u}, change all timer strings in the active region
6532 by a certain amount. This can be used to fix timer strings if the timer was
6533 not started at exactly the right moment.
6536 @node Countdown timer, , Relative timer, Dates and Times
6537 @section Countdown timer
6538 @cindex Countdown timer
6542 Calling @code{org-timer-set-timer} from an Org mode buffer runs a countdown
6543 timer. Use @kbd{;} from agenda buffers, @key{C-c C-x ;} everywhere else.
6545 @code{org-timer-set-timer} prompts the user for a duration and displays a
6546 countdown timer in the modeline. @code{org-timer-default-timer} sets the
6547 default countdown value. Giving a prefix numeric argument overrides this
6550 @node Capture - Refile - Archive, Agenda Views, Dates and Times, Top
6551 @chapter Capture - Refile - Archive
6554 An important part of any organization system is the ability to quickly
6555 capture new ideas and tasks, and to associate reference material with them.
6556 Org does this using a process called @i{capture}. It also can store files
6557 related to a task (@i{attachments}) in a special directory. Once in the
6558 system, tasks and projects need to be moved around. Moving completed project
6559 trees to an archive file keeps the system compact and fast.
6562 * Capture:: Capturing new stuff
6563 * Attachments:: Add files to tasks
6564 * RSS Feeds:: Getting input from RSS feeds
6565 * Protocols:: External (e.g., Browser) access to Emacs and Org
6566 * Refile and copy:: Moving/copying a tree from one place to another
6567 * Archiving:: What to do with finished projects
6570 @node Capture, Attachments, Capture - Refile - Archive, Capture - Refile - Archive
6574 Org's method for capturing new items is heavily inspired by John Wiegley
6575 excellent remember package. Up to version 6.36 Org used a special setup
6576 for @file{remember.el}. @file{org-remember.el} is still part of Org mode for
6577 backward compatibility with existing setups. You can find the documentation
6578 for org-remember at @url{http://orgmode.org/org-remember.pdf}.
6580 The new capturing setup described here is preferred and should be used by new
6581 users. To convert your @code{org-remember-templates}, run the command
6583 @kbd{M-x org-capture-import-remember-templates @key{RET}}
6585 @noindent and then customize the new variable with @kbd{M-x
6586 customize-variable org-capture-templates}, check the result, and save the
6587 customization. You can then use both remember and capture until
6588 you are familiar with the new mechanism.
6590 Capture lets you quickly store notes with little interruption of your work
6591 flow. The basic process of capturing is very similar to remember, but Org
6592 does enhance it with templates and more.
6595 * Setting up capture:: Where notes will be stored
6596 * Using capture:: Commands to invoke and terminate capture
6597 * Capture templates:: Define the outline of different note types
6600 @node Setting up capture, Using capture, Capture, Capture
6601 @subsection Setting up capture
6603 The following customization sets a default target file for notes, and defines
6604 a global key@footnote{Please select your own key, @kbd{C-c c} is only a
6605 suggestion.} for capturing new material.
6607 @vindex org-default-notes-file
6609 (setq org-default-notes-file (concat org-directory "/notes.org"))
6610 (define-key global-map "\C-cc" 'org-capture)
6613 @node Using capture, Capture templates, Setting up capture, Capture
6614 @subsection Using capture
6617 @orgcmd{C-c c,org-capture}
6618 Call the command @code{org-capture}. Note that this keybinding is global and
6619 not active by default: you need to install it. If you have templates
6621 defined @pxref{Capture templates}, it will offer these templates for
6622 selection or use a new Org outline node as the default template. It will
6623 insert the template into the target file and switch to an indirect buffer
6624 narrowed to this new node. You may then insert the information you want.
6626 @orgcmd{C-c C-c,org-capture-finalize}
6627 Once you have finished entering information into the capture buffer, @kbd{C-c
6628 C-c} will return you to the window configuration before the capture process,
6629 so that you can resume your work without further distraction. When called
6630 with a prefix arg, finalize and then jump to the captured item.
6632 @orgcmd{C-c C-w,org-capture-refile}
6633 Finalize the capture process by refiling (@pxref{Refile and copy}) the note to
6634 a different place. Please realize that this is a normal refiling command
6635 that will be executed---so the cursor position at the moment you run this
6636 command is important. If you have inserted a tree with a parent and
6637 children, first move the cursor back to the parent. Any prefix argument
6638 given to this command will be passed on to the @code{org-refile} command.
6640 @orgcmd{C-c C-k,org-capture-kill}
6641 Abort the capture process and return to the previous state.
6645 You can also call @code{org-capture} in a special way from the agenda, using
6646 the @kbd{k c} key combination. With this access, any timestamps inserted by
6647 the selected capture template will default to the cursor date in the agenda,
6648 rather than to the current date.
6650 To find the locations of the last stored capture, use @code{org-capture} with
6655 Visit the target location of a capture template. You get to select the
6656 template in the usual way.
6657 @orgkey{C-u C-u C-c c}
6658 Visit the last stored capture item in its buffer.
6661 @vindex org-capture-bookmark
6662 @cindex org-capture-last-stored
6663 You can also jump to the bookmark @code{org-capture-last-stored}, which will
6664 automatically be created unless you set @code{org-capture-bookmark} to
6667 To insert the capture at point in an Org buffer, call @code{org-capture} with
6668 a @code{C-0} prefix argument.
6670 @node Capture templates, , Using capture, Capture
6671 @subsection Capture templates
6672 @cindex templates, for Capture
6674 You can use templates for different types of capture items, and
6675 for different target locations. The easiest way to create such templates is
6676 through the customize interface.
6680 Customize the variable @code{org-capture-templates}.
6683 Before we give the formal description of template definitions, let's look at
6684 an example. Say you would like to use one template to create general TODO
6685 entries, and you want to put these entries under the heading @samp{Tasks} in
6686 your file @file{~/org/gtd.org}. Also, a date tree in the file
6687 @file{journal.org} should capture journal entries. A possible configuration
6691 (setq org-capture-templates
6692 '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
6693 "* TODO %?\n %i\n %a")
6694 ("j" "Journal" entry (file+datetree "~/org/journal.org")
6695 "* %?\nEntered on %U\n %i\n %a")))
6698 @noindent If you then press @kbd{C-c c t}, Org will prepare the template
6702 [[file:@var{link to where you initiated capture}]]
6706 During expansion of the template, @code{%a} has been replaced by a link to
6707 the location from where you called the capture command. This can be
6708 extremely useful for deriving tasks from emails, for example. You fill in
6709 the task definition, press @code{C-c C-c} and Org returns you to the same
6710 place where you started the capture process.
6712 To define special keys to capture to a particular template without going
6713 through the interactive template selection, you can create your key binding
6717 (define-key global-map "\C-cx"
6718 (lambda () (interactive) (org-capture nil "x")))
6722 * Template elements:: What is needed for a complete template entry
6723 * Template expansion:: Filling in information about time and context
6724 * Templates in contexts:: Only show a template in a specific context
6727 @node Template elements, Template expansion, Capture templates, Capture templates
6728 @subsubsection Template elements
6730 Now lets look at the elements of a template definition. Each entry in
6731 @code{org-capture-templates} is a list with the following items:
6735 The keys that will select the template, as a string, characters
6736 only, for example @code{"a"} for a template to be selected with a
6737 single key, or @code{"bt"} for selection with two keys. When using
6738 several keys, keys using the same prefix key must be sequential
6739 in the list and preceded by a 2-element entry explaining the
6740 prefix key, for example
6742 ("b" "Templates for marking stuff to buy")
6744 @noindent If you do not define a template for the @kbd{C} key, this key will
6745 be used to open the customize buffer for this complex variable.
6748 A short string describing the template, which will be shown during
6752 The type of entry, a symbol. Valid values are:
6755 An Org mode node, with a headline. Will be filed as the child of the target
6756 entry or as a top-level entry. The target file should be an Org mode file.
6758 A plain list item, placed in the first plain list at the target
6759 location. Again the target file should be an Org file.
6761 A checkbox item. This only differs from the plain list item by the
6764 a new line in the first table at the target location. Where exactly the
6765 line will be inserted depends on the properties @code{:prepend} and
6766 @code{:table-line-pos} (see below).
6768 Text to be inserted as it is.
6772 @vindex org-default-notes-file
6773 Specification of where the captured item should be placed. In Org mode
6774 files, targets usually define a node. Entries will become children of this
6775 node. Other types will be added to the table or list in the body of this
6776 node. Most target specifications contain a file name. If that file name is
6777 the empty string, it defaults to @code{org-default-notes-file}. A file can
6778 also be given as a variable, function, or Emacs Lisp form.
6782 @item (file "path/to/file")
6783 Text will be placed at the beginning or end of that file.
6785 @item (id "id of existing org entry")
6786 Filing as child of this entry, or in the body of the entry.
6788 @item (file+headline "path/to/file" "node headline")
6789 Fast configuration if the target heading is unique in the file.
6791 @item (file+olp "path/to/file" "Level 1 heading" "Level 2" ...)
6792 For non-unique headings, the full path is safer.
6794 @item (file+regexp "path/to/file" "regexp to find location")
6795 Use a regular expression to position the cursor.
6797 @item (file+datetree "path/to/file")
6798 Will create a heading in a date tree for today's date.
6800 @item (file+datetree+prompt "path/to/file")
6801 Will create a heading in a date tree, but will prompt for the date.
6803 @item (file+function "path/to/file" function-finding-location)
6804 A function to find the right location in the file.
6807 File to the entry that is currently being clocked.
6809 @item (function function-finding-location)
6810 Most general way, write your own function to find both
6815 The template for creating the capture item. If you leave this empty, an
6816 appropriate default template will be used. Otherwise this is a string with
6817 escape codes, which will be replaced depending on time and context of the
6818 capture call. The string with escapes may be loaded from a template file,
6819 using the special syntax @code{(file "path/to/template")}. See below for
6823 The rest of the entry is a property list of additional options.
6824 Recognized properties are:
6827 Normally new captured information will be appended at
6828 the target location (last child, last table line, last list item...).
6829 Setting this property will change that.
6831 @item :immediate-finish
6832 When set, do not offer to edit the information, just
6833 file it away immediately. This makes sense if the template only needs
6834 information that can be added automatically.
6837 Set this to the number of lines to insert
6838 before and after the new item. Default 0, only common other value is 1.
6841 Start the clock in this item.
6844 Keep the clock running when filing the captured entry.
6847 If starting the capture interrupted a clock, restart that clock when finished
6848 with the capture. Note that @code{:clock-keep} has precedence over
6849 @code{:clock-resume}. When setting both to @code{t}, the current clock will
6850 run and the previous one will not be resumed.
6853 Do not narrow the target buffer, simply show the full buffer. Default is to
6854 narrow it so that you only see the new material.
6856 @item :table-line-pos
6857 Specification of the location in the table where the new line should be
6858 inserted. It should be a string like @code{"II-3"} meaning that the new
6859 line should become the third line before the second horizontal separator
6863 If the target file was not yet visited when capture was invoked, kill the
6864 buffer again after capture is completed.
6868 @node Template expansion, Templates in contexts, Template elements, Capture templates
6869 @subsubsection Template expansion
6871 In the template itself, special @kbd{%}-escapes@footnote{If you need one of
6872 these sequences literally, escape the @kbd{%} with a backslash.} allow
6873 dynamic insertion of content. The templates are expanded in the order given here:
6876 %[@var{file}] @r{Insert the contents of the file given by @var{file}.}
6877 %(@var{sexp}) @r{Evaluate Elisp @var{sexp} and replace with the result.}
6878 @r{For convenience, %:keyword (see below) placeholders}
6879 @r{within the expression will be expanded prior to this.}
6880 @r{The sexp must return a string.}
6881 %<...> @r{The result of format-time-string on the ... format specification.}
6882 %t @r{Timestamp, date only.}
6883 %T @r{Timestamp, with date and time.}
6884 %u, %U @r{Like the above, but inactive timestamps.}
6885 %i @r{Initial content, the region when capture is called while the}
6886 @r{region is active.}
6887 @r{The entire text will be indented like @code{%i} itself.}
6888 %a @r{Annotation, normally the link created with @code{org-store-link}.}
6889 %A @r{Like @code{%a}, but prompt for the description part.}
6890 %l @r{Like %a, but only insert the literal link.}
6891 %c @r{Current kill ring head.}
6892 %x @r{Content of the X clipboard.}
6893 %k @r{Title of the currently clocked task.}
6894 %K @r{Link to the currently clocked task.}
6895 %n @r{User name (taken from @code{user-full-name}).}
6896 %f @r{File visited by current buffer when org-capture was called.}
6897 %F @r{Full path of the file or directory visited by current buffer.}
6898 %:keyword @r{Specific information for certain link types, see below.}
6899 %^g @r{Prompt for tags, with completion on tags in target file.}
6900 %^G @r{Prompt for tags, with completion all tags in all agenda files.}
6901 %^t @r{Like @code{%t}, but prompt for date. Similarly @code{%^T}, @code{%^u}, @code{%^U}.}
6902 @r{You may define a prompt like @code{%^@{Birthday@}t}.}
6903 %^C @r{Interactive selection of which kill or clip to use.}
6904 %^L @r{Like @code{%^C}, but insert as link.}
6905 %^@{@var{prop}@}p @r{Prompt the user for a value for property @var{prop}.}
6906 %^@{@var{prompt}@} @r{prompt the user for a string and replace this sequence with it.}
6907 @r{You may specify a default value and a completion table with}
6908 @r{%^@{prompt|default|completion2|completion3...@}.}
6909 @r{The arrow keys access a prompt-specific history.}
6910 %\n @r{Insert the text entered at the nth %^@{@var{prompt}@}, where @code{n} is}
6911 @r{a number, starting from 1.}
6912 %? @r{After completing the template, position cursor here.}
6916 For specific link types, the following keywords will be
6917 defined@footnote{If you define your own link types (@pxref{Adding
6918 hyperlink types}), any property you store with
6919 @code{org-store-link-props} can be accessed in capture templates in a
6922 @vindex org-from-is-user-regexp
6924 Link type | Available keywords
6925 ---------------------------------+----------------------------------------------
6926 bbdb | %:name %:company
6927 irc | %:server %:port %:nick
6928 vm, vm-imap, wl, mh, mew, rmail | %:type %:subject %:message-id
6929 | %:from %:fromname %:fromaddress
6930 | %:to %:toname %:toaddress
6931 | %:date @r{(message date header field)}
6932 | %:date-timestamp @r{(date as active timestamp)}
6933 | %:date-timestamp-inactive @r{(date as inactive timestamp)}
6934 | %: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}.}}
6935 gnus | %:group, @r{for messages also all email fields}
6937 info | %:file %:node
6942 To place the cursor after template expansion use:
6945 %? @r{After completing the template, position cursor here.}
6948 @node Templates in contexts, , Template expansion, Capture templates
6949 @subsubsection Templates in contexts
6951 @vindex org-capture-templates-contexts
6952 To control whether a capture template should be accessible from a specific
6953 context, you can customize @var{org-capture-templates-contexts}. Let's say
6954 for example that you have a capture template @code{"p"} for storing Gnus
6955 emails containing patches. Then you would configure this option like this:
6958 (setq org-capture-templates-contexts
6959 '(("p" (in-mode . "message-mode"))))
6962 You can also tell that the command key @code{"p"} should refer to another
6963 template. In that case, add this command key like this:
6966 (setq org-capture-templates-contexts
6967 '(("p" "q" (in-mode . "message-mode"))))
6970 See the docstring of the variable for more information.
6972 @node Attachments, RSS Feeds, Capture, Capture - Refile - Archive
6973 @section Attachments
6976 @vindex org-attach-directory
6977 It is often useful to associate reference material with an outline node/task.
6978 Small chunks of plain text can simply be stored in the subtree of a project.
6979 Hyperlinks (@pxref{Hyperlinks}) can establish associations with
6980 files that live elsewhere on your computer or in the cloud, like emails or
6981 source code files belonging to a project. Another method is @i{attachments},
6982 which are files located in a directory belonging to an outline node. Org
6983 uses directories named by the unique ID of each entry. These directories are
6984 located in the @file{data} directory which lives in the same directory where
6985 your Org file lives@footnote{If you move entries or Org files from one
6986 directory to another, you may want to configure @code{org-attach-directory}
6987 to contain an absolute path.}. If you initialize this directory with
6988 @code{git init}, Org will automatically commit changes when it sees them.
6989 The attachment system has been contributed to Org by John Wiegley.
6991 In cases where it seems better to do so, you can also attach a directory of your
6992 choice to an entry. You can also make children inherit the attachment
6993 directory from a parent, so that an entire subtree uses the same attached
6996 @noindent The following commands deal with attachments:
7000 @orgcmd{C-c C-a,org-attach}
7001 The dispatcher for commands related to the attachment system. After these
7002 keys, a list of commands is displayed and you must press an additional key
7003 to select a command:
7006 @orgcmdtkc{a,C-c C-a a,org-attach-attach}
7007 @vindex org-attach-method
7008 Select a file and move it into the task's attachment directory. The file
7009 will be copied, moved, or linked, depending on @code{org-attach-method}.
7010 Note that hard links are not supported on all systems.
7016 Attach a file using the copy/move/link method.
7017 Note that hard links are not supported on all systems.
7019 @orgcmdtkc{n,C-c C-a n,org-attach-new}
7020 Create a new attachment as an Emacs buffer.
7022 @orgcmdtkc{z,C-c C-a z,org-attach-sync}
7023 Synchronize the current task with its attachment directory, in case you added
7024 attachments yourself.
7026 @orgcmdtkc{o,C-c C-a o,org-attach-open}
7027 @vindex org-file-apps
7028 Open current task's attachment. If there is more than one, prompt for a
7029 file name first. Opening will follow the rules set by @code{org-file-apps}.
7030 For more details, see the information on following hyperlinks
7031 (@pxref{Handling links}).
7033 @orgcmdtkc{O,C-c C-a O,org-attach-open-in-emacs}
7034 Also open the attachment, but force opening the file in Emacs.
7036 @orgcmdtkc{f,C-c C-a f,org-attach-reveal}
7037 Open the current task's attachment directory.
7039 @orgcmdtkc{F,C-c C-a F,org-attach-reveal-in-emacs}
7040 Also open the directory, but force using @command{dired} in Emacs.
7042 @orgcmdtkc{d,C-c C-a d,org-attach-delete-one}
7043 Select and delete a single attachment.
7045 @orgcmdtkc{D,C-c C-a D,org-attach-delete-all}
7046 Delete all of a task's attachments. A safer way is to open the directory in
7047 @command{dired} and delete from there.
7049 @orgcmdtkc{s,C-c C-a s,org-attach-set-directory}
7050 @cindex property, ATTACH_DIR
7051 Set a specific directory as the entry's attachment directory. This works by
7052 putting the directory path into the @code{ATTACH_DIR} property.
7054 @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit}
7055 @cindex property, ATTACH_DIR_INHERIT
7056 Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the
7057 same directory for attachments as the parent does.
7061 @node RSS Feeds, Protocols, Attachments, Capture - Refile - Archive
7066 Org can add and change entries based on information found in RSS feeds and
7067 Atom feeds. You could use this to make a task out of each new podcast in a
7068 podcast feed. Or you could use a phone-based note-creating service on the
7069 web to import tasks into Org. To access feeds, configure the variable
7070 @code{org-feed-alist}. The docstring of this variable has detailed
7071 information. Here is just an example:
7074 (setq org-feed-alist
7076 "http://rss.slashdot.org/Slashdot/slashdot"
7077 "~/txt/org/feeds.org" "Slashdot Entries")))
7081 will configure that new items from the feed provided by
7082 @code{rss.slashdot.org} will result in new entries in the file
7083 @file{~/org/feeds.org} under the heading @samp{Slashdot Entries}, whenever
7084 the following command is used:
7087 @orgcmd{C-c C-x g,org-feed-update-all}
7089 Collect items from the feeds configured in @code{org-feed-alist} and act upon
7091 @orgcmd{C-c C-x G,org-feed-goto-inbox}
7092 Prompt for a feed name and go to the inbox configured for this feed.
7095 Under the same headline, Org will create a drawer @samp{FEEDSTATUS} in which
7096 it will store information about the status of items in the feed, to avoid
7097 adding the same item several times. You should add @samp{FEEDSTATUS} to the
7098 list of drawers in that file:
7101 #+DRAWERS: LOGBOOK PROPERTIES FEEDSTATUS
7104 For more information, including how to read atom feeds, see
7105 @file{org-feed.el} and the docstring of @code{org-feed-alist}.
7107 @node Protocols, Refile and copy, RSS Feeds, Capture - Refile - Archive
7108 @section Protocols for external access
7109 @cindex protocols, for external access
7112 You can set up Org for handling protocol calls from outside applications that
7113 are passed to Emacs through the @file{emacsserver}. For example, you can
7114 configure bookmarks in your web browser to send a link to the current page to
7115 Org and create a note from it using capture (@pxref{Capture}). Or you
7116 could create a bookmark that will tell Emacs to open the local source file of
7117 a remote website you are looking at with the browser. See
7118 @uref{http://orgmode.org/worg/org-contrib/org-protocol.php} for detailed
7119 documentation and setup instructions.
7121 @node Refile and copy, Archiving, Protocols, Capture - Refile - Archive
7122 @section Refile and copy
7123 @cindex refiling notes
7124 @cindex copying notes
7126 When reviewing the captured data, you may want to refile or to copy some of
7127 the entries into a different list, for example into a project. Cutting,
7128 finding the right location, and then pasting the note is cumbersome. To
7129 simplify this process, you can use the following special command:
7132 @orgcmd{C-c M-w,org-copy}
7134 Copying works like refiling, except that the original note is not deleted.
7135 @orgcmd{C-c C-w,org-refile}
7137 @vindex org-reverse-note-order
7138 @vindex org-refile-targets
7139 @vindex org-refile-use-outline-path
7140 @vindex org-outline-path-complete-in-steps
7141 @vindex org-refile-allow-creating-parent-nodes
7142 @vindex org-log-refile
7143 @vindex org-refile-use-cache
7144 Refile the entry or region at point. This command offers possible locations
7145 for refiling the entry and lets you select one with completion. The item (or
7146 all items in the region) is filed below the target heading as a subitem.
7147 Depending on @code{org-reverse-note-order}, it will be either the first or
7149 By default, all level 1 headlines in the current buffer are considered to be
7150 targets, but you can have more complex definitions across a number of files.
7151 See the variable @code{org-refile-targets} for details. If you would like to
7152 select a location via a file-path-like completion along the outline path, see
7153 the variables @code{org-refile-use-outline-path} and
7154 @code{org-outline-path-complete-in-steps}. If you would like to be able to
7155 create new nodes as new parents for refiling on the fly, check the
7156 variable @code{org-refile-allow-creating-parent-nodes}.
7157 When the variable @code{org-log-refile}@footnote{with corresponding
7158 @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile},
7159 and @code{nologrefile}} is set, a timestamp or a note will be
7160 recorded when an entry has been refiled.
7161 @orgkey{C-u C-c C-w}
7162 Use the refile interface to jump to a heading.
7163 @orgcmd{C-u C-u C-c C-w,org-refile-goto-last-stored}
7164 Jump to the location where @code{org-refile} last moved a tree to.
7166 Refile as the child of the item currently being clocked.
7167 @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}
7168 Clear the target cache. Caching of refile targets can be turned on by
7169 setting @code{org-refile-use-cache}. To make the command see new possible
7170 targets, you have to clear the cache with this command.
7173 @node Archiving, , Refile and copy, Capture - Refile - Archive
7177 When a project represented by a (sub)tree is finished, you may want
7178 to move the tree out of the way and to stop it from contributing to the
7179 agenda. Archiving is important to keep your working files compact and global
7180 searches like the construction of agenda views fast.
7183 @orgcmd{C-c C-x C-a,org-archive-subtree-default}
7184 @vindex org-archive-default-command
7185 Archive the current entry using the command specified in the variable
7186 @code{org-archive-default-command}.
7190 * Moving subtrees:: Moving a tree to an archive file
7191 * Internal archiving:: Switch off a tree but keep it in the file
7194 @node Moving subtrees, Internal archiving, Archiving, Archiving
7195 @subsection Moving a tree to the archive file
7196 @cindex external archiving
7198 The most common archiving action is to move a project tree to another file,
7202 @orgcmdkskc{C-c C-x C-s,C-c $,org-archive-subtree}
7203 @vindex org-archive-location
7204 Archive the subtree starting at the cursor position to the location
7205 given by @code{org-archive-location}.
7206 @orgkey{C-u C-c C-x C-s}
7207 Check if any direct children of the current headline could be moved to
7208 the archive. To do this, each subtree is checked for open TODO entries.
7209 If none are found, the command offers to move it to the archive
7210 location. If the cursor is @emph{not} on a headline when this command
7211 is invoked, the level 1 trees will be checked.
7214 @cindex archive locations
7215 The default archive location is a file in the same directory as the
7216 current file, with the name derived by appending @file{_archive} to the
7217 current file name. You can also choose what heading to file archived
7218 items under, with the possibility to add them to a datetree in a file.
7219 For information and examples on how to specify the file and the heading,
7220 see the documentation string of the variable
7221 @code{org-archive-location}.
7223 There is also an in-buffer option for setting this variable, for
7224 example@footnote{For backward compatibility, the following also works:
7225 If there are several such lines in a file, each specifies the archive
7226 location for the text below it. The first such line also applies to any
7227 text before its definition. However, using this method is
7228 @emph{strongly} deprecated as it is incompatible with the outline
7229 structure of the document. The correct method for setting multiple
7230 archive locations in a buffer is using properties.}:
7234 #+ARCHIVE: %s_done::
7237 @cindex property, ARCHIVE
7239 If you would like to have a special ARCHIVE location for a single entry
7240 or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the
7241 location as the value (@pxref{Properties and Columns}).
7243 @vindex org-archive-save-context-info
7244 When a subtree is moved, it receives a number of special properties that
7245 record context information like the file from where the entry came, its
7246 outline path the archiving time etc. Configure the variable
7247 @code{org-archive-save-context-info} to adjust the amount of information
7251 @node Internal archiving, , Moving subtrees, Archiving
7252 @subsection Internal archiving
7254 If you want to just switch off (for agenda views) certain subtrees without
7255 moving them to a different file, you can use the @code{ARCHIVE tag}.
7257 A headline that is marked with the ARCHIVE tag (@pxref{Tags}) stays at
7258 its location in the outline tree, but behaves in the following way:
7261 @vindex org-cycle-open-archived-trees
7262 It does not open when you attempt to do so with a visibility cycling
7263 command (@pxref{Visibility cycling}). You can force cycling archived
7264 subtrees with @kbd{C-@key{TAB}}, or by setting the option
7265 @code{org-cycle-open-archived-trees}. Also normal outline commands like
7266 @code{show-all} will open archived subtrees.
7268 @vindex org-sparse-tree-open-archived-trees
7269 During sparse tree construction (@pxref{Sparse trees}), matches in
7270 archived subtrees are not exposed, unless you configure the option
7271 @code{org-sparse-tree-open-archived-trees}.
7273 @vindex org-agenda-skip-archived-trees
7274 During agenda view construction (@pxref{Agenda Views}), the content of
7275 archived trees is ignored unless you configure the option
7276 @code{org-agenda-skip-archived-trees}, in which case these trees will always
7277 be included. In the agenda you can press @kbd{v a} to get archives
7278 temporarily included.
7280 @vindex org-export-with-archived-trees
7281 Archived trees are not exported (@pxref{Exporting}), only the headline
7282 is. Configure the details using the variable
7283 @code{org-export-with-archived-trees}.
7285 @vindex org-columns-skip-archived-trees
7286 Archived trees are excluded from column view unless the variable
7287 @code{org-columns-skip-archived-trees} is configured to @code{nil}.
7290 The following commands help manage the ARCHIVE tag:
7293 @orgcmd{C-c C-x a,org-toggle-archive-tag}
7294 Toggle the ARCHIVE tag for the current headline. When the tag is set,
7295 the headline changes to a shadowed face, and the subtree below it is
7297 @orgkey{C-u C-c C-x a}
7298 Check if any direct children of the current headline should be archived.
7299 To do this, each subtree is checked for open TODO entries. If none are
7300 found, the command offers to set the ARCHIVE tag for the child. If the
7301 cursor is @emph{not} on a headline when this command is invoked, the
7302 level 1 trees will be checked.
7303 @orgcmd{C-@kbd{TAB},org-force-cycle-archived}
7304 Cycle a tree even if it is tagged with ARCHIVE.
7305 @orgcmd{C-c C-x A,org-archive-to-archive-sibling}
7306 Move the current entry to the @emph{Archive Sibling}. This is a sibling of
7307 the entry with the heading @samp{Archive} and the tag @samp{ARCHIVE}. The
7308 entry becomes a child of that sibling and in this way retains a lot of its
7309 original context, including inherited tags and approximate position in the
7314 @node Agenda Views, Markup, Capture - Refile - Archive, Top
7315 @chapter Agenda views
7316 @cindex agenda views
7318 Due to the way Org works, TODO items, time-stamped items, and
7319 tagged headlines can be scattered throughout a file or even a number of
7320 files. To get an overview of open action items, or of events that are
7321 important for a particular date, this information must be collected,
7322 sorted and displayed in an organized way.
7324 Org can select items based on various criteria and display them
7325 in a separate buffer. Seven different view types are provided:
7329 an @emph{agenda} that is like a calendar and shows information
7332 a @emph{TODO list} that covers all unfinished
7335 a @emph{match view}, showings headlines based on the tags, properties, and
7336 TODO state associated with them,
7338 a @emph{timeline view} that shows all events in a single Org file,
7339 in time-sorted view,
7341 a @emph{text search view} that shows all entries from multiple files
7342 that contain specified keywords,
7344 a @emph{stuck projects view} showing projects that currently don't move
7347 @emph{custom views} that are special searches and combinations of different
7352 The extracted information is displayed in a special @emph{agenda
7353 buffer}. This buffer is read-only, but provides commands to visit the
7354 corresponding locations in the original Org files, and even to
7355 edit these files remotely.
7357 @vindex org-agenda-window-setup
7358 @vindex org-agenda-restore-windows-after-quit
7359 Two variables control how the agenda buffer is displayed and whether the
7360 window configuration is restored when the agenda exits:
7361 @code{org-agenda-window-setup} and
7362 @code{org-agenda-restore-windows-after-quit}.
7365 * Agenda files:: Files being searched for agenda information
7366 * Agenda dispatcher:: Keyboard access to agenda views
7367 * Built-in agenda views:: What is available out of the box?
7368 * Presentation and sorting:: How agenda items are prepared for display
7369 * Agenda commands:: Remote editing of Org trees
7370 * Custom agenda views:: Defining special searches and views
7371 * Exporting Agenda Views:: Writing a view to a file
7372 * Agenda column view:: Using column view for collected entries
7375 @node Agenda files, Agenda dispatcher, Agenda Views, Agenda Views
7376 @section Agenda files
7377 @cindex agenda files
7378 @cindex files for agenda
7380 @vindex org-agenda-files
7381 The information to be shown is normally collected from all @emph{agenda
7382 files}, the files listed in the variable
7383 @code{org-agenda-files}@footnote{If the value of that variable is not a
7384 list, but a single file name, then the list of agenda files will be
7385 maintained in that external file.}. If a directory is part of this list,
7386 all files with the extension @file{.org} in this directory will be part
7389 Thus, even if you only work with a single Org file, that file should
7390 be put into the list@footnote{When using the dispatcher, pressing
7391 @kbd{<} before selecting a command will actually limit the command to
7392 the current file, and ignore @code{org-agenda-files} until the next
7393 dispatcher command.}. You can customize @code{org-agenda-files}, but
7394 the easiest way to maintain it is through the following commands
7396 @cindex files, adding to agenda list
7398 @orgcmd{C-c [,org-agenda-file-to-front}
7399 Add current file to the list of agenda files. The file is added to
7400 the front of the list. If it was already in the list, it is moved to
7401 the front. With a prefix argument, file is added/moved to the end.
7402 @orgcmd{C-c ],org-remove-file}
7403 Remove current file from the list of agenda files.
7405 @cindex cycling, of agenda files
7406 @orgcmd{C-',org-cycle-agenda-files}
7408 Cycle through agenda file list, visiting one file after the other.
7409 @kindex M-x org-iswitchb
7410 @item M-x org-iswitchb
7411 Command to use an @code{iswitchb}-like interface to switch to and between Org
7416 The Org menu contains the current list of files and can be used
7417 to visit any of them.
7419 If you would like to focus the agenda temporarily on a file not in
7420 this list, or on just one file in the list, or even on only a subtree in a
7421 file, then this can be done in different ways. For a single agenda command,
7422 you may press @kbd{<} once or several times in the dispatcher
7423 (@pxref{Agenda dispatcher}). To restrict the agenda scope for an
7424 extended period, use the following commands:
7427 @orgcmd{C-c C-x <,org-agenda-set-restriction-lock}
7428 Permanently restrict the agenda to the current subtree. When with a
7429 prefix argument, or with the cursor before the first headline in a file,
7430 the agenda scope is set to the entire file. This restriction remains in
7431 effect until removed with @kbd{C-c C-x >}, or by typing either @kbd{<}
7432 or @kbd{>} in the agenda dispatcher. If there is a window displaying an
7433 agenda view, the new restriction takes effect immediately.
7434 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
7435 Remove the permanent restriction created by @kbd{C-c C-x <}.
7439 When working with @file{speedbar.el}, you can use the following commands in
7442 @orgcmdtkc{< @r{in the speedbar frame},<,org-speedbar-set-agenda-restriction}
7443 Permanently restrict the agenda to the item---either an Org file or a subtree
7444 in such a file---at the cursor in the Speedbar frame.
7445 If there is a window displaying an agenda view, the new restriction takes
7447 @orgcmdtkc{> @r{in the speedbar frame},>,org-agenda-remove-restriction-lock}
7448 Lift the restriction.
7451 @node Agenda dispatcher, Built-in agenda views, Agenda files, Agenda Views
7452 @section The agenda dispatcher
7453 @cindex agenda dispatcher
7454 @cindex dispatching agenda commands
7455 The views are created through a dispatcher, which should be bound to a
7456 global key---for example @kbd{C-c a} (@pxref{Activation}). In the
7457 following we will assume that @kbd{C-c a} is indeed how the dispatcher
7458 is accessed and list keyboard access to commands accordingly. After
7459 pressing @kbd{C-c a}, an additional letter is required to execute a
7460 command. The dispatcher offers the following default commands:
7463 Create the calendar-like agenda (@pxref{Weekly/daily agenda}).
7465 Create a list of all TODO items (@pxref{Global TODO list}).
7467 Create a list of headlines matching a TAGS expression (@pxref{Matching
7468 tags and properties}).
7470 Create the timeline view for the current buffer (@pxref{Timeline}).
7472 Create a list of entries selected by a boolean expression of keywords
7473 and/or regular expressions that must or must not occur in the entry.
7475 @vindex org-agenda-text-search-extra-files
7476 Search for a regular expression in all agenda files and additionally in
7477 the files listed in @code{org-agenda-text-search-extra-files}. This
7478 uses the Emacs command @code{multi-occur}. A prefix argument can be
7479 used to specify the number of context lines for each match, default is
7482 Create a list of stuck projects (@pxref{Stuck projects}).
7484 Restrict an agenda command to the current buffer@footnote{For backward
7485 compatibility, you can also press @kbd{1} to restrict to the current
7486 buffer.}. After pressing @kbd{<}, you still need to press the character
7487 selecting the command.
7489 If there is an active region, restrict the following agenda command to
7490 the region. Otherwise, restrict it to the current subtree@footnote{For
7491 backward compatibility, you can also press @kbd{0} to restrict to the
7492 current region/subtree.}. After pressing @kbd{< <}, you still need to press the
7493 character selecting the command.
7496 @vindex org-agenda-sticky
7497 Toggle sticky agenda views. By default, Org maintains only a single agenda
7498 buffer and rebuilds it each time you change the view, to make sure everything
7499 is always up to date. If you switch between views often and the build time
7500 bothers you, you can turn on sticky agenda buffers (make this the default by
7501 customizing the variable @code{org-agenda-sticky}). With sticky agendas, the
7502 dispatcher only switches to the selected view, you need to update it by hand
7503 with @kbd{r} or @kbd{g}. You can toggle sticky agenda view any time with
7504 @code{org-toggle-sticky-agenda}.
7507 You can also define custom commands that will be accessible through the
7508 dispatcher, just like the default commands. This includes the
7509 possibility to create extended agenda buffers that contain several
7510 blocks together, for example the weekly agenda, the global TODO list and
7511 a number of special tags matches. @xref{Custom agenda views}.
7513 @node Built-in agenda views, Presentation and sorting, Agenda dispatcher, Agenda Views
7514 @section The built-in agenda views
7516 In this section we describe the built-in views.
7519 * Weekly/daily agenda:: The calendar page with current tasks
7520 * Global TODO list:: All unfinished action items
7521 * Matching tags and properties:: Structured information with fine-tuned search
7522 * Timeline:: Time-sorted view for single file
7523 * Search view:: Find entries by searching for text
7524 * Stuck projects:: Find projects you need to review
7527 @node Weekly/daily agenda, Global TODO list, Built-in agenda views, Built-in agenda views
7528 @subsection The weekly/daily agenda
7530 @cindex weekly agenda
7531 @cindex daily agenda
7533 The purpose of the weekly/daily @emph{agenda} is to act like a page of a
7534 paper agenda, showing all the tasks for the current week or day.
7537 @cindex org-agenda, command
7538 @orgcmd{C-c a a,org-agenda-list}
7539 Compile an agenda for the current week from a list of Org files. The agenda
7540 shows the entries for each day. With a numeric prefix@footnote{For backward
7541 compatibility, the universal prefix @kbd{C-u} causes all TODO entries to be
7542 listed before the agenda. This feature is deprecated, use the dedicated TODO
7543 list, or a block agenda instead (@pxref{Block agenda}).} (like @kbd{C-u 2 1
7544 C-c a a}) you may set the number of days to be displayed.
7547 @vindex org-agenda-span
7548 @vindex org-agenda-ndays
7549 The default number of days displayed in the agenda is set by the variable
7550 @code{org-agenda-span} (or the obsolete @code{org-agenda-ndays}). This
7551 variable can be set to any number of days you want to see by default in the
7552 agenda, or to a span name, such a @code{day}, @code{week}, @code{month} or
7555 Remote editing from the agenda buffer means, for example, that you can
7556 change the dates of deadlines and appointments from the agenda buffer.
7557 The commands available in the Agenda buffer are listed in @ref{Agenda
7560 @subsubheading Calendar/Diary integration
7561 @cindex calendar integration
7562 @cindex diary integration
7564 Emacs contains the calendar and diary by Edward M. Reingold. The
7565 calendar displays a three-month calendar with holidays from different
7566 countries and cultures. The diary allows you to keep track of
7567 anniversaries, lunar phases, sunrise/set, recurrent appointments
7568 (weekly, monthly) and more. In this way, it is quite complementary to
7569 Org. It can be very useful to combine output from Org with
7572 In order to include entries from the Emacs diary into Org mode's
7573 agenda, you only need to customize the variable
7576 (setq org-agenda-include-diary t)
7579 @noindent After that, everything will happen automatically. All diary
7580 entries including holidays, anniversaries, etc., will be included in the
7581 agenda buffer created by Org mode. @key{SPC}, @key{TAB}, and
7582 @key{RET} can be used from the agenda buffer to jump to the diary
7583 file in order to edit existing diary entries. The @kbd{i} command to
7584 insert new entries for the current date works in the agenda buffer, as
7585 well as the commands @kbd{S}, @kbd{M}, and @kbd{C} to display
7586 Sunrise/Sunset times, show lunar phases and to convert to other
7587 calendars, respectively. @kbd{c} can be used to switch back and forth
7588 between calendar and agenda.
7590 If you are using the diary only for sexp entries and holidays, it is
7591 faster to not use the above setting, but instead to copy or even move
7592 the entries into an Org file. Org mode evaluates diary-style sexp
7593 entries, and does it faster because there is no overhead for first
7594 creating the diary display. Note that the sexp entries must start at
7595 the left margin, no whitespace is allowed before them. For example,
7596 the following segment of an Org file will be processed and entries
7597 will be made in the agenda:
7600 * Birthdays and similar stuff
7602 %%(org-calendar-holiday) ; special function for holiday names
7604 %%(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
7605 %%(org-anniversary 1869 10 2) Mahatma Gandhi would be %d years old
7608 @subsubheading Anniversaries from BBDB
7609 @cindex BBDB, anniversaries
7610 @cindex anniversaries, from BBDB
7612 If you are using the Big Brothers Database to store your contacts, you will
7613 very likely prefer to store anniversaries in BBDB rather than in a
7614 separate Org or diary file. Org supports this and will show BBDB
7615 anniversaries as part of the agenda. All you need to do is to add the
7616 following to one of your agenda files:
7623 %%(org-bbdb-anniversaries)
7626 You can then go ahead and define anniversaries for a BBDB record. Basically,
7627 you need to press @kbd{C-o anniversary @key{RET}} with the cursor in a BBDB
7628 record and then add the date in the format @code{YYYY-MM-DD} or @code{MM-DD},
7629 followed by a space and the class of the anniversary (@samp{birthday} or
7630 @samp{wedding}, or a format string). If you omit the class, it will default to
7631 @samp{birthday}. Here are a few examples, the header for the file
7632 @file{org-bbdb.el} contains more detailed information.
7638 2008-04-14 %s released version 6.01 of org mode, %d years ago
7641 After a change to BBDB, or for the first agenda display during an Emacs
7642 session, the agenda display will suffer a short delay as Org updates its
7643 hash with anniversaries. However, from then on things will be very fast---much
7644 faster in fact than a long list of @samp{%%(diary-anniversary)} entries
7645 in an Org or Diary file.
7647 @subsubheading Appointment reminders
7648 @cindex @file{appt.el}
7649 @cindex appointment reminders
7653 Org can interact with Emacs appointments notification facility. To add the
7654 appointments of your agenda files, use the command @code{org-agenda-to-appt}.
7655 This command lets you filter through the list of your appointments and add
7656 only those belonging to a specific category or matching a regular expression.
7657 It also reads a @code{APPT_WARNTIME} property which will then override the
7658 value of @code{appt-message-warning-time} for this appointment. See the
7659 docstring for details.
7661 @node Global TODO list, Matching tags and properties, Weekly/daily agenda, Built-in agenda views
7662 @subsection The global TODO list
7663 @cindex global TODO list
7664 @cindex TODO list, global
7666 The global TODO list contains all unfinished TODO items formatted and
7667 collected into a single place.
7670 @orgcmd{C-c a t,org-todo-list}
7671 Show the global TODO list. This collects the TODO items from all agenda
7672 files (@pxref{Agenda Views}) into a single buffer. By default, this lists
7673 items with a state the is not a DONE state. The buffer is in
7674 @code{agenda-mode}, so there are commands to examine and manipulate the TODO
7675 entries directly from that buffer (@pxref{Agenda commands}).
7676 @orgcmd{C-c a T,org-todo-list}
7677 @cindex TODO keyword matching
7678 @vindex org-todo-keywords
7679 Like the above, but allows selection of a specific TODO keyword. You can
7680 also do this by specifying a prefix argument to @kbd{C-c a t}. You are
7681 prompted for a keyword, and you may also specify several keywords by
7682 separating them with @samp{|} as the boolean OR operator. With a numeric
7683 prefix, the Nth keyword in @code{org-todo-keywords} is selected.
7685 The @kbd{r} key in the agenda buffer regenerates it, and you can give
7686 a prefix argument to this command to change the selected TODO keyword,
7687 for example @kbd{3 r}. If you often need a search for a specific
7688 keyword, define a custom command for it (@pxref{Agenda dispatcher}).@*
7689 Matching specific TODO keywords can also be done as part of a tags
7690 search (@pxref{Tag searches}).
7693 Remote editing of TODO items means that you can change the state of a
7694 TODO entry with a single key press. The commands available in the
7695 TODO list are described in @ref{Agenda commands}.
7697 @cindex sublevels, inclusion into TODO list
7698 Normally the global TODO list simply shows all headlines with TODO
7699 keywords. This list can become very long. There are two ways to keep
7703 @vindex org-agenda-todo-ignore-scheduled
7704 @vindex org-agenda-todo-ignore-deadlines
7705 @vindex org-agenda-todo-ignore-timestamp
7706 @vindex org-agenda-todo-ignore-with-date
7707 Some people view a TODO item that has been @emph{scheduled} for execution or
7708 have a @emph{deadline} (@pxref{Timestamps}) as no longer @emph{open}.
7709 Configure the variables @code{org-agenda-todo-ignore-scheduled},
7710 @code{org-agenda-todo-ignore-deadlines},
7711 @code{org-agenda-todo-ignore-timestamp} and/or
7712 @code{org-agenda-todo-ignore-with-date} to exclude such items from the global
7715 @vindex org-agenda-todo-list-sublevels
7716 TODO items may have sublevels to break up the task into subtasks. In
7717 such cases it may be enough to list only the highest level TODO headline
7718 and omit the sublevels from the global list. Configure the variable
7719 @code{org-agenda-todo-list-sublevels} to get this behavior.
7722 @node Matching tags and properties, Timeline, Global TODO list, Built-in agenda views
7723 @subsection Matching tags and properties
7724 @cindex matching, of tags
7725 @cindex matching, of properties
7729 If headlines in the agenda files are marked with @emph{tags} (@pxref{Tags}),
7730 or have properties (@pxref{Properties and Columns}), you can select headlines
7731 based on this metadata and collect them into an agenda buffer. The match
7732 syntax described here also applies when creating sparse trees with @kbd{C-c /
7736 @orgcmd{C-c a m,org-tags-view}
7737 Produce a list of all headlines that match a given set of tags. The
7738 command prompts for a selection criterion, which is a boolean logic
7739 expression with tags, like @samp{+work+urgent-withboss} or
7740 @samp{work|home} (@pxref{Tags}). If you often need a specific search,
7741 define a custom command for it (@pxref{Agenda dispatcher}).
7742 @orgcmd{C-c a M,org-tags-view}
7743 @vindex org-tags-match-list-sublevels
7744 @vindex org-agenda-tags-todo-honor-ignore-options
7745 Like @kbd{C-c a m}, but only select headlines that are also TODO items in a
7746 not-DONE state and force checking subitems (see variable
7747 @code{org-tags-match-list-sublevels}). To exclude scheduled/deadline items,
7748 see the variable @code{org-agenda-tags-todo-honor-ignore-options}. Matching
7749 specific TODO keywords together with a tags match is also possible, see
7753 The commands available in the tags list are described in @ref{Agenda
7756 @subsubheading Match syntax
7758 @cindex Boolean logic, for tag/property searches
7759 A search string can use Boolean operators @samp{&} for AND and @samp{|} for
7760 OR@. @samp{&} binds more strongly than @samp{|}. Parentheses are currently
7761 not implemented. Each element in the search is either a tag, a regular
7762 expression matching tags, or an expression like @code{PROPERTY OPERATOR
7763 VALUE} with a comparison operator, accessing a property value. Each element
7764 may be preceded by @samp{-}, to select against it, and @samp{+} is syntactic
7765 sugar for positive selection. The AND operator @samp{&} is optional when
7766 @samp{+} or @samp{-} is present. Here are some examples, using only tags.
7770 Select headlines tagged @samp{:work:}, but discard those also tagged
7773 Selects lines tagged @samp{:work:} or @samp{:laptop:}.
7774 @item work|laptop+night
7775 Like before, but require the @samp{:laptop:} lines to be tagged also
7779 @cindex regular expressions, with tags search
7780 Instead of a tag, you may also specify a regular expression enclosed in curly
7781 braces. For example,
7782 @samp{work+@{^boss.*@}} matches headlines that contain the tag
7783 @samp{:work:} and any tag @i{starting} with @samp{boss}.
7785 @cindex TODO keyword matching, with tags search
7786 @cindex level, require for tags/property match
7787 @cindex category, require for tags/property match
7788 @vindex org-odd-levels-only
7789 You may also test for properties (@pxref{Properties and Columns}) at the same
7790 time as matching tags. The properties may be real properties, or special
7791 properties that represent other metadata (@pxref{Special properties}). For
7792 example, the ``property'' @code{TODO} represents the TODO keyword of the
7793 entry. Or, the ``property'' @code{LEVEL} represents the level of an entry.
7794 So a search @samp{+LEVEL=3+boss-TODO="DONE"} lists all level three headlines
7795 that have the tag @samp{boss} and are @emph{not} marked with the TODO keyword
7796 DONE@. In buffers with @code{org-odd-levels-only} set, @samp{LEVEL} does not
7797 count the number of stars, but @samp{LEVEL=2} will correspond to 3 stars etc.
7798 The ITEM special property cannot currently be used in tags/property
7799 searches@footnote{But @pxref{x-agenda-skip-entry-regexp,
7800 ,skipping entries based on regexp}.}.
7802 Here are more examples:
7804 @item work+TODO="WAITING"
7805 Select @samp{:work:}-tagged TODO lines with the specific TODO
7806 keyword @samp{WAITING}.
7807 @item work+TODO="WAITING"|home+TODO="WAITING"
7808 Waiting tasks both at work and at home.
7811 When matching properties, a number of different operators can be used to test
7812 the value of a property. Here is a complex example:
7815 +work-boss+PRIORITY="A"+Coffee="unlimited"+Effort<2 \
7816 +With=@{Sarah\|Denny@}+SCHEDULED>="<2008-10-11>"
7820 The type of comparison will depend on how the comparison value is written:
7823 If the comparison value is a plain number, a numerical comparison is done,
7824 and the allowed operators are @samp{<}, @samp{=}, @samp{>}, @samp{<=},
7825 @samp{>=}, and @samp{<>}.
7827 If the comparison value is enclosed in double-quotes,
7828 a string comparison is done, and the same operators are allowed.
7830 If the comparison value is enclosed in double-quotes @emph{and} angular
7831 brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are
7832 assumed to be date/time specifications in the standard Org way, and the
7833 comparison will be done accordingly. Special values that will be recognized
7834 are @code{"<now>"} for now (including time), and @code{"<today>"}, and
7835 @code{"<tomorrow>"} for these days at 0:00 hours, i.e., without a time
7836 specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units
7837 @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year,
7838 respectively, can be used.
7840 If the comparison value is enclosed
7841 in curly braces, a regexp match is performed, with @samp{=} meaning that the
7842 regexp matches the property value, and @samp{<>} meaning that it does not
7846 So the search string in the example finds entries tagged @samp{:work:} but
7847 not @samp{:boss:}, which also have a priority value @samp{A}, a
7848 @samp{:Coffee:} property with the value @samp{unlimited}, an @samp{Effort}
7849 property that is numerically smaller than 2, a @samp{:With:} property that is
7850 matched by the regular expression @samp{Sarah\|Denny}, and that are scheduled
7851 on or after October 11, 2008.
7853 Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing any
7854 other properties will slow down the search. However, once you have paid the
7855 price by accessing one property, testing additional properties is cheap
7858 You can configure Org mode to use property inheritance during a search, but
7859 beware that this can slow down searches considerably. See @ref{Property
7860 inheritance}, for details.
7862 For backward compatibility, and also for typing speed, there is also a
7863 different way to test TODO states in a search. For this, terminate the
7864 tags/property part of the search string (which may include several terms
7865 connected with @samp{|}) with a @samp{/} and then specify a Boolean
7866 expression just for TODO keywords. The syntax is then similar to that for
7867 tags, but should be applied with care: for example, a positive selection on
7868 several TODO keywords cannot meaningfully be combined with boolean AND@.
7869 However, @emph{negative selection} combined with AND can be meaningful. To
7870 make sure that only lines are checked that actually have any TODO keyword
7871 (resulting in a speed-up), use @kbd{C-c a M}, or equivalently start the TODO
7872 part after the slash with @samp{!}. Using @kbd{C-c a M} or @samp{/!} will
7873 not match TODO keywords in a DONE state. Examples:
7877 Same as @samp{work+TODO="WAITING"}
7878 @item work/!-WAITING-NEXT
7879 Select @samp{:work:}-tagged TODO lines that are neither @samp{WAITING}
7881 @item work/!+WAITING|+NEXT
7882 Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or
7886 @node Timeline, Search view, Matching tags and properties, Built-in agenda views
7887 @subsection Timeline for a single file
7888 @cindex timeline, single file
7889 @cindex time-sorted view
7891 The timeline summarizes all time-stamped items from a single Org mode
7892 file in a @emph{time-sorted view}. The main purpose of this command is
7893 to give an overview over events in a project.
7896 @orgcmd{C-c a L,org-timeline}
7897 Show a time-sorted view of the Org file, with all time-stamped items.
7898 When called with a @kbd{C-u} prefix, all unfinished TODO entries
7899 (scheduled or not) are also listed under the current date.
7903 The commands available in the timeline buffer are listed in
7904 @ref{Agenda commands}.
7906 @node Search view, Stuck projects, Timeline, Built-in agenda views
7907 @subsection Search view
7910 @cindex searching, for text
7912 This agenda view is a general text search facility for Org mode entries.
7913 It is particularly useful to find notes.
7916 @orgcmd{C-c a s,org-search-view}
7917 This is a special search that lets you select entries by matching a substring
7918 or specific words using a boolean logic.
7920 For example, the search string @samp{computer equipment} will find entries
7921 that contain @samp{computer equipment} as a substring. If the two words are
7922 separated by more space or a line break, the search will still match.
7923 Search view can also search for specific keywords in the entry, using Boolean
7924 logic. The search string @samp{+computer +wifi -ethernet -@{8\.11[bg]@}}
7925 will search for note entries that contain the keywords @code{computer}
7926 and @code{wifi}, but not the keyword @code{ethernet}, and which are also
7927 not matched by the regular expression @code{8\.11[bg]}, meaning to
7928 exclude both 8.11b and 8.11g. The first @samp{+} is necessary to turn on
7929 word search, other @samp{+} characters are optional. For more details, see
7930 the docstring of the command @code{org-search-view}.
7932 @vindex org-agenda-text-search-extra-files
7933 Note that in addition to the agenda files, this command will also search
7934 the files listed in @code{org-agenda-text-search-extra-files}.
7936 @node Stuck projects, , Search view, Built-in agenda views
7937 @subsection Stuck projects
7938 @pindex GTD, Getting Things Done
7940 If you are following a system like David Allen's GTD to organize your
7941 work, one of the ``duties'' you have is a regular review to make sure
7942 that all projects move along. A @emph{stuck} project is a project that
7943 has no defined next actions, so it will never show up in the TODO lists
7944 Org mode produces. During the review, you need to identify such
7945 projects and define next actions for them.
7948 @orgcmd{C-c a #,org-agenda-list-stuck-projects}
7949 List projects that are stuck.
7952 @vindex org-stuck-projects
7953 Customize the variable @code{org-stuck-projects} to define what a stuck
7954 project is and how to find it.
7957 You almost certainly will have to configure this view before it will
7958 work for you. The built-in default assumes that all your projects are
7959 level-2 headlines, and that a project is not stuck if it has at least
7960 one entry marked with a TODO keyword TODO or NEXT or NEXTACTION.
7962 Let's assume that you, in your own way of using Org mode, identify
7963 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to
7964 indicate a project that should not be considered yet. Let's further
7965 assume that the TODO keyword DONE marks finished projects, and that NEXT
7966 and TODO indicate next actions. The tag @@SHOP indicates shopping and
7967 is a next action even without the NEXT tag. Finally, if the project
7968 contains the special word IGNORE anywhere, it should not be listed
7969 either. In this case you would start by identifying eligible projects
7970 with a tags/todo match@footnote{@xref{Tag searches}.}
7971 @samp{+PROJECT/-MAYBE-DONE}, and then check for TODO, NEXT, @@SHOP, and
7972 IGNORE in the subtree to identify projects that are not stuck. The
7973 correct customization for this is
7976 (setq org-stuck-projects
7977 '("+PROJECT/-MAYBE-DONE" ("NEXT" "TODO") ("@@SHOP")
7981 Note that if a project is identified as non-stuck, the subtree of this entry
7982 will still be searched for stuck projects.
7984 @node Presentation and sorting, Agenda commands, Built-in agenda views, Agenda Views
7985 @section Presentation and sorting
7986 @cindex presentation, of agenda items
7988 @vindex org-agenda-prefix-format
7989 @vindex org-agenda-tags-column
7990 Before displaying items in an agenda view, Org mode visually prepares the
7991 items and sorts them. Each item occupies a single line. The line starts
7992 with a @emph{prefix} that contains the @emph{category} (@pxref{Categories})
7993 of the item and other important information. You can customize in which
7994 column tags will be displayed through @code{org-agenda-tags-column}. You can
7995 also customize the prefix using the option @code{org-agenda-prefix-format}.
7996 This prefix is followed by a cleaned-up version of the outline headline
7997 associated with the item.
8000 * Categories:: Not all tasks are equal
8001 * Time-of-day specifications:: How the agenda knows the time
8002 * Sorting of agenda items:: The order of things
8005 @node Categories, Time-of-day specifications, Presentation and sorting, Presentation and sorting
8006 @subsection Categories
8010 The category is a broad label assigned to each agenda item. By default,
8011 the category is simply derived from the file name, but you can also
8012 specify it with a special line in the buffer, like this@footnote{For
8013 backward compatibility, the following also works: if there are several
8014 such lines in a file, each specifies the category for the text below it.
8015 The first category also applies to any text before the first CATEGORY
8016 line. However, using this method is @emph{strongly} deprecated as it is
8017 incompatible with the outline structure of the document. The correct
8018 method for setting multiple categories in a buffer is using a
8026 @cindex property, CATEGORY
8027 If you would like to have a special CATEGORY for a single entry or a
8028 (sub)tree, give the entry a @code{:CATEGORY:} property with the
8029 special category you want to apply as the value.
8032 The display in the agenda buffer looks best if the category is not
8033 longer than 10 characters.
8036 You can set up icons for category by customizing the
8037 @code{org-agenda-category-icon-alist} variable.
8039 @node Time-of-day specifications, Sorting of agenda items, Categories, Presentation and sorting
8040 @subsection Time-of-day specifications
8041 @cindex time-of-day specification
8043 Org mode checks each agenda item for a time-of-day specification. The
8044 time can be part of the timestamp that triggered inclusion into the
8045 agenda, for example as in @w{@samp{<2005-05-10 Tue 19:00>}}. Time
8046 ranges can be specified with two timestamps, like
8048 @w{@samp{<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>}}.
8050 In the headline of the entry itself, a time(range) may also appear as
8051 plain text (like @samp{12:45} or a @samp{8:30-1pm}). If the agenda
8052 integrates the Emacs diary (@pxref{Weekly/daily agenda}), time
8053 specifications in diary entries are recognized as well.
8055 For agenda display, Org mode extracts the time and displays it in a
8056 standard 24 hour format as part of the prefix. The example times in
8057 the previous paragraphs would end up in the agenda like this:
8060 8:30-13:00 Arthur Dent lies in front of the bulldozer
8061 12:45...... Ford Prefect arrives and takes Arthur to the pub
8062 19:00...... The Vogon reads his poem
8063 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8067 If the agenda is in single-day mode, or for the display of today, the
8068 timed entries are embedded in a time grid, like
8071 8:00...... ------------------
8072 8:30-13:00 Arthur Dent lies in front of the bulldozer
8073 10:00...... ------------------
8074 12:00...... ------------------
8075 12:45...... Ford Prefect arrives and takes Arthur to the pub
8076 14:00...... ------------------
8077 16:00...... ------------------
8078 18:00...... ------------------
8079 19:00...... The Vogon reads his poem
8080 20:00...... ------------------
8081 20:30-22:15 Marvin escorts the Hitchhikers to the bridge
8084 @vindex org-agenda-use-time-grid
8085 @vindex org-agenda-time-grid
8086 The time grid can be turned on and off with the variable
8087 @code{org-agenda-use-time-grid}, and can be configured with
8088 @code{org-agenda-time-grid}.
8090 @node Sorting of agenda items, , Time-of-day specifications, Presentation and sorting
8091 @subsection Sorting of agenda items
8092 @cindex sorting, of agenda items
8093 @cindex priorities, of agenda items
8094 Before being inserted into a view, the items are sorted. How this is
8095 done depends on the type of view.
8098 @vindex org-agenda-files
8099 For the daily/weekly agenda, the items for each day are sorted. The
8100 default order is to first collect all items containing an explicit
8101 time-of-day specification. These entries will be shown at the beginning
8102 of the list, as a @emph{schedule} for the day. After that, items remain
8103 grouped in categories, in the sequence given by @code{org-agenda-files}.
8104 Within each category, items are sorted by priority (@pxref{Priorities}),
8105 which is composed of the base priority (2000 for priority @samp{A}, 1000
8106 for @samp{B}, and 0 for @samp{C}), plus additional increments for
8107 overdue scheduled or deadline items.
8109 For the TODO list, items remain in the order of categories, but within
8110 each category, sorting takes place according to priority
8111 (@pxref{Priorities}). The priority used for sorting derives from the
8112 priority cookie, with additions depending on how close an item is to its due
8115 For tags matches, items are not sorted at all, but just appear in the
8116 sequence in which they are found in the agenda files.
8119 @vindex org-agenda-sorting-strategy
8120 Sorting can be customized using the variable
8121 @code{org-agenda-sorting-strategy}, and may also include criteria based on
8122 the estimated effort of an entry (@pxref{Effort estimates}).
8124 @node Agenda commands, Custom agenda views, Presentation and sorting, Agenda Views
8125 @section Commands in the agenda buffer
8126 @cindex commands, in agenda buffer
8128 Entries in the agenda buffer are linked back to the Org file or diary
8129 file where they originate. You are not allowed to edit the agenda
8130 buffer itself, but commands are provided to show and jump to the
8131 original entry location, and to edit the Org files ``remotely'' from
8132 the agenda buffer. In this way, all information is stored only once,
8133 removing the risk that your agenda and note files may diverge.
8135 Some commands can be executed with mouse clicks on agenda lines. For
8136 the other commands, the cursor needs to be in the desired line.
8139 @tsubheading{Motion}
8140 @cindex motion commands in agenda
8141 @orgcmd{n,org-agenda-next-line}
8142 Next line (same as @key{down} and @kbd{C-n}).
8143 @orgcmd{p,org-agenda-previous-line}
8144 Previous line (same as @key{up} and @kbd{C-p}).
8145 @tsubheading{View/Go to Org file}
8146 @orgcmdkkc{@key{SPC},mouse-3,org-agenda-show-and-scroll-up}
8147 Display the original location of the item in another window.
8148 With prefix arg, make sure that the entire entry is made visible in the
8149 outline, not only the heading.
8151 @orgcmd{L,org-agenda-recenter}
8152 Display original location and recenter that window.
8154 @orgcmdkkc{@key{TAB},mouse-2,org-agenda-goto}
8155 Go to the original location of the item in another window.
8157 @orgcmd{@key{RET},org-agenda-switch-to}
8158 Go to the original location of the item and delete other windows.
8160 @orgcmd{F,org-agenda-follow-mode}
8161 @vindex org-agenda-start-with-follow-mode
8162 Toggle Follow mode. In Follow mode, as you move the cursor through
8163 the agenda buffer, the other window always shows the corresponding
8164 location in the Org file. The initial setting for this mode in new
8165 agenda buffers can be set with the variable
8166 @code{org-agenda-start-with-follow-mode}.
8168 @orgcmd{C-c C-x b,org-agenda-tree-to-indirect-buffer}
8169 Display the entire subtree of the current item in an indirect buffer. With a
8170 numeric prefix argument N, go up to level N and then take that tree. If N is
8171 negative, go up that many levels. With a @kbd{C-u} prefix, do not remove the
8172 previously used indirect buffer.
8174 @orgcmd{C-c C-o,org-agenda-open-link}
8175 Follow a link in the entry. This will offer a selection of any links in the
8176 text belonging to the referenced Org node. If there is only one link, it
8177 will be followed without a selection prompt.
8179 @tsubheading{Change display}
8180 @cindex display changing, in agenda
8183 Interactively select another agenda view and append it to the current view.
8187 Delete other windows.
8189 @orgcmdkskc{v d,d,org-agenda-day-view}
8190 @xorgcmdkskc{v w,w,org-agenda-week-view}
8191 @xorgcmd{v m,org-agenda-month-view}
8192 @xorgcmd{v y,org-agenda-year-view}
8193 @xorgcmd{v SPC,org-agenda-reset-view}
8194 @vindex org-agenda-span
8195 Switch to day/week/month/year view. When switching to day or week view, this
8196 setting becomes the default for subsequent agenda refreshes. Since month and
8197 year views are slow to create, they do not become the default. A numeric
8198 prefix argument may be used to jump directly to a specific day of the year,
8199 ISO week, month, or year, respectively. For example, @kbd{32 d} jumps to
8200 February 1st, @kbd{9 w} to ISO week number 9. When setting day, week, or
8201 month view, a year may be encoded in the prefix argument as well. For
8202 example, @kbd{200712 w} will jump to week 12 in 2007. If such a year
8203 specification has only one or two digits, it will be mapped to the interval
8204 1938--2037. @kbd{v @key{SPC}} will reset to what is set in
8205 @code{org-agenda-span}.
8207 @orgcmd{f,org-agenda-later}
8208 Go forward in time to display the following @code{org-agenda-current-span} days.
8209 For example, if the display covers a week, switch to the following week.
8210 With prefix arg, go forward that many times @code{org-agenda-current-span} days.
8212 @orgcmd{b,org-agenda-earlier}
8213 Go backward in time to display earlier dates.
8215 @orgcmd{.,org-agenda-goto-today}
8218 @orgcmd{j,org-agenda-goto-date}
8219 Prompt for a date and go there.
8221 @orgcmd{J,org-agenda-clock-goto}
8222 Go to the currently clocked-in task @i{in the agenda buffer}.
8224 @orgcmd{D,org-agenda-toggle-diary}
8225 Toggle the inclusion of diary entries. See @ref{Weekly/daily agenda}.
8227 @orgcmdkskc{v l,l,org-agenda-log-mode}
8229 @vindex org-log-done
8230 @vindex org-agenda-log-mode-items
8231 Toggle Logbook mode. In Logbook mode, entries that were marked DONE while
8232 logging was on (variable @code{org-log-done}) are shown in the agenda, as are
8233 entries that have been clocked on that day. You can configure the entry
8234 types that should be included in log mode using the variable
8235 @code{org-agenda-log-mode-items}. When called with a @kbd{C-u} prefix, show
8236 all possible logbook entries, including state changes. When called with two
8237 prefix args @kbd{C-u C-u}, show only logging information, nothing else.
8238 @kbd{v L} is equivalent to @kbd{C-u v l}.
8240 @orgcmdkskc{v [,[,org-agenda-manipulate-query-add}
8241 Include inactive timestamps into the current view. Only for weekly/daily
8242 agenda and timeline views.
8244 @orgcmd{v a,org-agenda-archives-mode}
8245 @xorgcmd{v A,org-agenda-archives-mode 'files}
8246 Toggle Archives mode. In Archives mode, trees that are marked
8247 @code{ARCHIVED} are also scanned when producing the agenda. When you use the
8248 capital @kbd{A}, even all archive files are included. To exit archives mode,
8249 press @kbd{v a} again.
8251 @orgcmdkskc{v R,R,org-agenda-clockreport-mode}
8252 @vindex org-agenda-start-with-clockreport-mode
8253 @vindex org-clock-report-include-clocking-task
8254 Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will
8255 always show a table with the clocked times for the timespan and file scope
8256 covered by the current agenda view. The initial setting for this mode in new
8257 agenda buffers can be set with the variable
8258 @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument
8259 when toggling this mode (i.e., @kbd{C-u R}), the clock table will not show
8260 contributions from entries that are hidden by agenda filtering@footnote{Only
8261 tags filtering will be respected here, effort filtering is ignored.}. See
8262 also the variable @code{org-clock-report-include-clocking-task}.
8265 @vindex org-agenda-clock-consistency-checks
8266 Show overlapping clock entries, clocking gaps, and other clocking problems in
8267 the current agenda range. You can then visit clocking lines and fix them
8268 manually. See the variable @code{org-agenda-clock-consistency-checks} for
8269 information on how to customize the definition of what constituted a clocking
8270 problem. To return to normal agenda display, press @kbd{l} to exit Logbook
8273 @orgcmdkskc{v E,E,org-agenda-entry-text-mode}
8274 @vindex org-agenda-start-with-entry-text-mode
8275 @vindex org-agenda-entry-text-maxlines
8276 Toggle entry text mode. In entry text mode, a number of lines from the Org
8277 outline node referenced by an agenda line will be displayed below the line.
8278 The maximum number of lines is given by the variable
8279 @code{org-agenda-entry-text-maxlines}. Calling this command with a numeric
8280 prefix argument will temporarily modify that number to the prefix value.
8282 @orgcmd{G,org-agenda-toggle-time-grid}
8283 @vindex org-agenda-use-time-grid
8284 @vindex org-agenda-time-grid
8285 Toggle the time grid on and off. See also the variables
8286 @code{org-agenda-use-time-grid} and @code{org-agenda-time-grid}.
8288 @orgcmd{r,org-agenda-redo}
8289 Recreate the agenda buffer, for example to reflect the changes after
8290 modification of the timestamps of items with @kbd{S-@key{left}} and
8291 @kbd{S-@key{right}}. When the buffer is the global TODO list, a prefix
8292 argument is interpreted to create a selective list for a specific TODO
8294 @orgcmd{g,org-agenda-redo}
8297 @orgcmdkskc{C-x C-s,s,org-save-all-org-buffers}
8298 Save all Org buffers in the current Emacs session, and also the locations of
8301 @orgcmd{C-c C-x C-c,org-agenda-columns}
8302 @vindex org-columns-default-format
8303 Invoke column view (@pxref{Column view}) in the agenda buffer. The column
8304 view format is taken from the entry at point, or (if there is no entry at
8305 point), from the first entry in the agenda view. So whatever the format for
8306 that entry would be in the original buffer (taken from a property, from a
8307 @code{#+COLUMNS} line, or from the default variable
8308 @code{org-columns-default-format}), will be used in the agenda.
8310 @orgcmd{C-c C-x >,org-agenda-remove-restriction-lock}
8311 Remove the restriction lock on the agenda, if it is currently restricted to a
8312 file or subtree (@pxref{Agenda files}).
8314 @tsubheading{Secondary filtering and query editing}
8315 @cindex filtering, by tag category and effort, in agenda
8316 @cindex tag filtering, in agenda
8317 @cindex category filtering, in agenda
8318 @cindex effort filtering, in agenda
8319 @cindex query editing, in agenda
8321 @orgcmd{<,org-agenda-filter-by-category}
8322 @vindex org-agenda-category-filter-preset
8324 Filter the current agenda view with respect to the category of the item at
8325 point. Pressing @code{<} another time will remove this filter. You can add
8326 a filter preset through the option @code{org-agenda-category-filter-preset}
8329 @orgcmd{/,org-agenda-filter-by-tag}
8330 @vindex org-agenda-tag-filter-preset
8331 Filter the current agenda view with respect to a tag and/or effort estimates.
8332 The difference between this and a custom agenda command is that filtering is
8333 very fast, so that you can switch quickly between different filters without
8334 having to recreate the agenda.@footnote{Custom commands can preset a filter by
8335 binding the variable @code{org-agenda-tag-filter-preset} as an option. This
8336 filter will then be applied to the view and persist as a basic filter through
8337 refreshes and more secondary filtering. The filter is a global property of
8338 the entire agenda view---in a block agenda, you should only set this in the
8339 global options section, not in the section of an individual block.}
8341 You will be prompted for a tag selection letter; @key{SPC} will mean any tag at
8342 all. Pressing @key{TAB} at that prompt will offer use completion to select a
8343 tag (including any tags that do not have a selection character). The command
8344 then hides all entries that do not contain or inherit this tag. When called
8345 with prefix arg, remove the entries that @emph{do} have the tag. A second
8346 @kbd{/} at the prompt will turn off the filter and unhide any hidden entries.
8347 If the first key you press is either @kbd{+} or @kbd{-}, the previous filter
8348 will be narrowed by requiring or forbidding the selected additional tag.
8349 Instead of pressing @kbd{+} or @kbd{-} after @kbd{/}, you can also
8350 immediately use the @kbd{\} command.
8352 @vindex org-sort-agenda-noeffort-is-high
8353 In order to filter for effort estimates, you should set up allowed
8354 efforts globally, for example
8356 (setq org-global-properties
8357 '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00")))
8359 You can then filter for an effort by first typing an operator, one of
8360 @kbd{<}, @kbd{>}, and @kbd{=}, and then the one-digit index of an effort
8361 estimate in your array of allowed values, where @kbd{0} means the 10th value.
8362 The filter will then restrict to entries with effort smaller-or-equal, equal,
8363 or larger-or-equal than the selected value. If the digits 0--9 are not used
8364 as fast access keys to tags, you can also simply press the index digit
8365 directly without an operator. In this case, @kbd{<} will be assumed. For
8366 application of the operator, entries without a defined effort will be treated
8367 according to the value of @code{org-sort-agenda-noeffort-is-high}. To filter
8368 for tasks without effort definition, press @kbd{?} as the operator.
8370 Org also supports automatic, context-aware tag filtering. If the variable
8371 @code{org-agenda-auto-exclude-function} is set to a user-defined function,
8372 that function can decide which tags should be excluded from the agenda
8373 automatically. Once this is set, the @kbd{/} command then accepts @kbd{RET}
8374 as a sub-option key and runs the auto exclusion logic. For example, let's
8375 say you use a @code{Net} tag to identify tasks which need network access, an
8376 @code{Errand} tag for errands in town, and a @code{Call} tag for making phone
8377 calls. You could auto-exclude these tags based on the availability of the
8378 Internet, and outside of business hours, with something like this:
8382 (defun org-my-auto-exclude-function (tag)
8384 ((string= tag "Net")
8385 (/= 0 (call-process "/sbin/ping" nil nil nil
8386 "-c1" "-q" "-t1" "mail.gnu.org")))
8387 ((or (string= tag "Errand") (string= tag "Call"))
8388 (let ((hour (nth 2 (decode-time))))
8389 (or (< hour 8) (> hour 21)))))
8392 (setq org-agenda-auto-exclude-function 'org-my-auto-exclude-function)
8396 @orgcmd{\\,org-agenda-filter-by-tag-refine}
8397 Narrow the current agenda filter by an additional condition. When called with
8398 prefix arg, remove the entries that @emph{do} have the tag, or that do match
8399 the effort criterion. You can achieve the same effect by pressing @kbd{+} or
8400 @kbd{-} as the first key after the @kbd{/} command.
8409 @item @r{in} search view
8410 add new search words (@kbd{[} and @kbd{]}) or new regular expressions
8411 (@kbd{@{} and @kbd{@}}) to the query string. The opening bracket/brace will
8412 add a positive search term prefixed by @samp{+}, indicating that this search
8413 term @i{must} occur/match in the entry. The closing bracket/brace will add a
8414 negative search term which @i{must not} occur/match in the entry for it to be
8418 @tsubheading{Remote editing}
8419 @cindex remote editing, from agenda
8424 @cindex undoing remote-editing events
8425 @cindex remote editing, undo
8426 @orgcmd{C-_,org-agenda-undo}
8427 Undo a change due to a remote editing command. The change is undone
8428 both in the agenda buffer and in the remote buffer.
8430 @orgcmd{t,org-agenda-todo}
8431 Change the TODO state of the item, both in the agenda and in the
8434 @orgcmd{C-S-@key{right},org-agenda-todo-nextset}
8435 @orgcmd{C-S-@key{left},org-agenda-todo-previousset}
8436 Switch to the next/previous set of TODO keywords.
8438 @orgcmd{C-k,org-agenda-kill}
8439 @vindex org-agenda-confirm-kill
8440 Delete the current agenda item along with the entire subtree belonging
8441 to it in the original Org file. If the text to be deleted remotely
8442 is longer than one line, the kill needs to be confirmed by the user. See
8443 variable @code{org-agenda-confirm-kill}.
8445 @orgcmd{C-c C-w,org-agenda-refile}
8446 Refile the entry at point.
8448 @orgcmdkskc{C-c C-x C-a,a,org-agenda-archive-default-with-confirmation}
8449 @vindex org-archive-default-command
8450 Archive the subtree corresponding to the entry at point using the default
8451 archiving command set in @code{org-archive-default-command}. When using the
8452 @code{a} key, confirmation will be required.
8454 @orgcmd{C-c C-x a,org-agenda-toggle-archive-tag}
8455 Toggle the ARCHIVE tag for the current headline.
8457 @orgcmd{C-c C-x A,org-agenda-archive-to-archive-sibling}
8458 Move the subtree corresponding to the current entry to its @emph{archive
8461 @orgcmdkskc{C-c C-x C-s,$,org-agenda-archive}
8462 Archive the subtree corresponding to the current headline. This means the
8463 entry will be moved to the configured archive location, most likely a
8466 @orgcmd{T,org-agenda-show-tags}
8467 @vindex org-agenda-show-inherited-tags
8468 Show all tags associated with the current item. This is useful if you have
8469 turned off @code{org-agenda-show-inherited-tags}, but still want to see all
8470 tags of a headline occasionally.
8472 @orgcmd{:,org-agenda-set-tags}
8473 Set tags for the current headline. If there is an active region in the
8474 agenda, change a tag for all headings in the region.
8478 Set the priority for the current item (@command{org-agenda-priority}).
8479 Org mode prompts for the priority character. If you reply with @key{SPC},
8480 the priority cookie is removed from the entry.
8482 @orgcmd{P,org-agenda-show-priority}
8483 Display weighted priority of current item.
8485 @orgcmdkkc{+,S-@key{up},org-agenda-priority-up}
8486 Increase the priority of the current item. The priority is changed in
8487 the original buffer, but the agenda is not resorted. Use the @kbd{r}
8490 @orgcmdkkc{-,S-@key{down},org-agenda-priority-down}
8491 Decrease the priority of the current item.
8493 @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
8494 @vindex org-log-into-drawer
8495 Add a note to the entry. This note will be recorded, and then filed to the
8496 same location where state change notes are put. Depending on
8497 @code{org-log-into-drawer}, this may be inside a drawer.
8499 @orgcmd{C-c C-a,org-attach}
8500 Dispatcher for all command related to attachments.
8502 @orgcmd{C-c C-s,org-agenda-schedule}
8503 Schedule this item. With prefix arg remove the scheduling timestamp
8505 @orgcmd{C-c C-d,org-agenda-deadline}
8506 Set a deadline for this item. With prefix arg remove the deadline.
8508 @orgcmd{S-@key{right},org-agenda-do-date-later}
8509 Change the timestamp associated with the current line by one day into the
8510 future. If the date is in the past, the first call to this command will move
8512 With a numeric prefix argument, change it by that many days. For example,
8513 @kbd{3 6 5 S-@key{right}} will change it by a year. With a @kbd{C-u} prefix,
8514 change the time by one hour. If you immediately repeat the command, it will
8515 continue to change hours even without the prefix arg. With a double @kbd{C-u
8516 C-u} prefix, do the same for changing minutes.@*
8517 The stamp is changed in the original Org file, but the change is not directly
8518 reflected in the agenda buffer. Use @kbd{r} or @kbd{g} to update the buffer.
8520 @orgcmd{S-@key{left},org-agenda-do-date-earlier}
8521 Change the timestamp associated with the current line by one day
8524 @orgcmd{>,org-agenda-date-prompt}
8525 Change the timestamp associated with the current line. The key @kbd{>} has
8526 been chosen, because it is the same as @kbd{S-.} on my keyboard.
8528 @orgcmd{I,org-agenda-clock-in}
8529 Start the clock on the current item. If a clock is running already, it
8532 @orgcmd{O,org-agenda-clock-out}
8533 Stop the previously started clock.
8535 @orgcmd{X,org-agenda-clock-cancel}
8536 Cancel the currently running clock.
8538 @orgcmd{J,org-agenda-clock-goto}
8539 Jump to the running clock in another window.
8541 @orgcmd{k,org-agenda-capture}
8542 Like @code{org-capture}, but use the date at point as the default date for
8543 the capture template. See @var{org-capture-use-agenda-date} to make this
8544 the default behavior of @code{org-capture}.
8545 @cindex capturing, from agenda
8546 @vindex org-capture-use-agenda-date
8548 @tsubheading{Bulk remote editing selected entries}
8549 @cindex remote editing, bulk, from agenda
8550 @vindex org-agenda-bulk-persistent-marks
8551 @vindex org-agenda-bulk-custom-functions
8553 @orgcmd{m,org-agenda-bulk-mark}
8554 Mark the entry at point for bulk action. With prefix arg, mark that many
8557 @orgcmd{%,org-agenda-bulk-mark-regexp}
8558 Mark entries matching a regular expression for bulk action.
8560 @orgcmd{u,org-agenda-bulk-unmark}
8561 Unmark entry for bulk action.
8563 @orgcmd{U,org-agenda-bulk-remove-all-marks}
8564 Unmark all marked entries for bulk action.
8566 @orgcmd{B,org-agenda-bulk-action}
8567 Bulk action: act on all marked entries in the agenda. This will prompt for
8568 another key to select the action to be applied. The prefix arg to @kbd{B}
8569 will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove
8570 these special timestamps. By default, marks are removed after the bulk. If
8571 you want them to persist, set @code{org-agenda-bulk-persistent-marks} to
8572 @code{t} or hit @kbd{p} at the prompt.
8575 * @r{Toggle persistent marks.}
8576 $ @r{Archive all selected entries.}
8577 A @r{Archive entries by moving them to their respective archive siblings.}
8578 t @r{Change TODO state. This prompts for a single TODO keyword and}
8579 @r{changes the state of all selected entries, bypassing blocking and}
8580 @r{suppressing logging notes (but not timestamps).}
8581 + @r{Add a tag to all selected entries.}
8582 - @r{Remove a tag from all selected entries.}
8583 s @r{Schedule all items to a new date. To shift existing schedule dates}
8584 @r{by a fixed number of days, use something starting with double plus}
8585 @r{at the prompt, for example @samp{++8d} or @samp{++2w}.}
8586 d @r{Set deadline to a specific date.}
8587 r @r{Prompt for a single refile target and move all entries. The entries}
8588 @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.}
8589 S @r{Reschedule randomly into the coming N days. N will be prompted for.}
8590 @r{With prefix arg (@kbd{C-u B S}), scatter only across weekdays.}
8591 f @r{Apply a function@footnote{You can also create persistent custom functions through@code{org-agenda-bulk-custom-functions}.} to marked entries.}
8592 @r{For example, the function below sets the CATEGORY property of the}
8594 @r{(defun set-category ()}
8595 @r{ (interactive "P")}
8596 @r{ (let* ((marker (or (org-get-at-bol 'org-hd-marker)}
8597 @r{ (org-agenda-error)))}
8598 @r{ (buffer (marker-buffer marker)))}
8599 @r{ (with-current-buffer buffer}
8600 @r{ (save-excursion}
8601 @r{ (save-restriction}
8603 @r{ (goto-char marker)}
8604 @r{ (org-back-to-heading t)}
8605 @r{ (org-set-property "CATEGORY" "web"))))))}
8609 @tsubheading{Calendar commands}
8610 @cindex calendar commands, from agenda
8612 @orgcmd{c,org-agenda-goto-calendar}
8613 Open the Emacs calendar and move to the date at the agenda cursor.
8615 @orgcmd{c,org-calendar-goto-agenda}
8616 When in the calendar, compute and show the Org mode agenda for the
8619 @cindex diary entries, creating from agenda
8620 @orgcmd{i,org-agenda-diary-entry}
8621 @vindex org-agenda-diary-file
8622 Insert a new entry into the diary, using the date at the cursor and (for
8623 block entries) the date at the mark. This will add to the Emacs diary
8624 file@footnote{This file is parsed for the agenda when
8625 @code{org-agenda-include-diary} is set.}, in a way similar to the @kbd{i}
8626 command in the calendar. The diary file will pop up in another window, where
8627 you can add the entry.
8629 If you configure @code{org-agenda-diary-file} to point to an Org mode file,
8630 Org will create entries (in Org mode syntax) in that file instead. Most
8631 entries will be stored in a date-based outline tree that will later make it
8632 easy to archive appointments from previous months/years. The tree will be
8633 built under an entry with a @code{DATE_TREE} property, or else with years as
8634 top-level entries. Emacs will prompt you for the entry text---if you specify
8635 it, the entry will be created in @code{org-agenda-diary-file} without further
8636 interaction. If you directly press @key{RET} at the prompt without typing
8637 text, the target file will be shown in another window for you to finish the
8638 entry there. See also the @kbd{k r} command.
8640 @orgcmd{M,org-agenda-phases-of-moon}
8641 Show the phases of the moon for the three months around current date.
8643 @orgcmd{S,org-agenda-sunrise-sunset}
8644 Show sunrise and sunset times. The geographical location must be set
8645 with calendar variables, see the documentation for the Emacs calendar.
8647 @orgcmd{C,org-agenda-convert-date}
8648 Convert the date at cursor into many other cultural and historic
8651 @orgcmd{H,org-agenda-holidays}
8652 Show holidays for three months around the cursor date.
8654 @item M-x org-export-icalendar-combine-agenda-files
8655 Export a single iCalendar file containing entries from all agenda files.
8656 This is a globally available command, and also available in the agenda menu.
8658 @tsubheading{Exporting to a file}
8659 @orgcmd{C-x C-w,org-agenda-write}
8660 @cindex exporting agenda views
8661 @cindex agenda views, exporting
8662 @vindex org-agenda-exporter-settings
8663 Write the agenda view to a file. Depending on the extension of the selected
8664 file name, the view will be exported as HTML (extension @file{.html} or
8665 @file{.htm}), Postscript (extension @file{.ps}), PDF (extension @file{.pdf}),
8666 and plain text (any other extension). When called with a @kbd{C-u} prefix
8667 argument, immediately open the newly created file. Use the variable
8668 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8669 for @file{htmlize} to be used during export.
8671 @tsubheading{Quit and Exit}
8672 @orgcmd{q,org-agenda-quit}
8673 Quit agenda, remove the agenda buffer.
8675 @cindex agenda files, removing buffers
8676 @orgcmd{x,org-agenda-exit}
8677 Exit agenda, remove the agenda buffer and all buffers loaded by Emacs
8678 for the compilation of the agenda. Buffers created by the user to
8679 visit Org files will not be removed.
8683 @node Custom agenda views, Exporting Agenda Views, Agenda commands, Agenda Views
8684 @section Custom agenda views
8685 @cindex custom agenda views
8686 @cindex agenda views, custom
8688 Custom agenda commands serve two purposes: to store and quickly access
8689 frequently used TODO and tags searches, and to create special composite
8690 agenda buffers. Custom agenda commands will be accessible through the
8691 dispatcher (@pxref{Agenda dispatcher}), just like the default commands.
8694 * Storing searches:: Type once, use often
8695 * Block agenda:: All the stuff you need in a single buffer
8696 * Setting Options:: Changing the rules
8699 @node Storing searches, Block agenda, Custom agenda views, Custom agenda views
8700 @subsection Storing searches
8702 The first application of custom searches is the definition of keyboard
8703 shortcuts for frequently used searches, either creating an agenda
8704 buffer, or a sparse tree (the latter covering of course only the current
8707 @vindex org-agenda-custom-commands
8708 @cindex agenda views, main example
8709 @cindex tags, as an agenda view
8710 @cindex todo, as an agenda view
8716 Custom commands are configured in the variable
8717 @code{org-agenda-custom-commands}. You can customize this variable, for
8718 example by pressing @kbd{C-c a C}. You can also directly set it with Emacs
8719 Lisp in @file{.emacs}. The following example contains all valid search
8724 (setq org-agenda-custom-commands
8725 '(("w" todo "WAITING")
8726 ("W" todo-tree "WAITING")
8727 ("u" tags "+boss-urgent")
8728 ("v" tags-todo "+boss-urgent")
8729 ("U" tags-tree "+boss-urgent")
8730 ("f" occur-tree "\\<FIXME\\>")
8731 ("h" . "HOME+Name tags searches") ; description for "h" prefix
8732 ("hl" tags "+home+Lisa")
8733 ("hp" tags "+home+Peter")
8734 ("hk" tags "+home+Kim")))
8739 The initial string in each entry defines the keys you have to press
8740 after the dispatcher command @kbd{C-c a} in order to access the command.
8741 Usually this will be just a single character, but if you have many
8742 similar commands, you can also define two-letter combinations where the
8743 first character is the same in several combinations and serves as a
8744 prefix key@footnote{You can provide a description for a prefix key by
8745 inserting a cons cell with the prefix and the description.}. The second
8746 parameter is the search type, followed by the string or regular
8747 expression to be used for the matching. The example above will
8752 as a global search for TODO entries with @samp{WAITING} as the TODO
8755 as the same search, but only in the current buffer and displaying the
8756 results as a sparse tree
8758 as a global tags search for headlines marked @samp{:boss:} but not
8761 as the same search as @kbd{C-c a u}, but limiting the search to
8762 headlines that are also TODO items
8764 as the same search as @kbd{C-c a u}, but only in the current buffer and
8765 displaying the result as a sparse tree
8767 to create a sparse tree (again: current buffer only) with all entries
8768 containing the word @samp{FIXME}
8770 as a prefix command for a HOME tags search where you have to press an
8771 additional key (@kbd{l}, @kbd{p} or @kbd{k}) to select a name (Lisa,
8772 Peter, or Kim) as additional tag to match.
8775 Note that the @code{*-tree} agenda views need to be called from an
8776 Org buffer as they operate on the current buffer only.
8778 @node Block agenda, Setting Options, Storing searches, Custom agenda views
8779 @subsection Block agenda
8780 @cindex block agenda
8781 @cindex agenda, with block views
8783 Another possibility is the construction of agenda views that comprise
8784 the results of @emph{several} commands, each of which creates a block in
8785 the agenda buffer. The available commands include @code{agenda} for the
8786 daily or weekly agenda (as created with @kbd{C-c a a}), @code{alltodo}
8787 for the global TODO list (as constructed with @kbd{C-c a t}), and the
8788 matching commands discussed above: @code{todo}, @code{tags}, and
8789 @code{tags-todo}. Here are two examples:
8793 (setq org-agenda-custom-commands
8794 '(("h" "Agenda and Home-related tasks"
8798 ("o" "Agenda and Office-related tasks"
8806 This will define @kbd{C-c a h} to create a multi-block view for stuff
8807 you need to attend to at home. The resulting agenda buffer will contain
8808 your agenda for the current week, all TODO items that carry the tag
8809 @samp{home}, and also all lines tagged with @samp{garden}. Finally the
8810 command @kbd{C-c a o} provides a similar view for office tasks.
8812 @node Setting Options, , Block agenda, Custom agenda views
8813 @subsection Setting options for custom commands
8814 @cindex options, for custom agenda views
8816 @vindex org-agenda-custom-commands
8817 Org mode contains a number of variables regulating agenda construction
8818 and display. The global variables define the behavior for all agenda
8819 commands, including the custom commands. However, if you want to change
8820 some settings just for a single custom view, you can do so. Setting
8821 options requires inserting a list of variable names and values at the
8822 right spot in @code{org-agenda-custom-commands}. For example:
8826 (setq org-agenda-custom-commands
8827 '(("w" todo "WAITING"
8828 ((org-agenda-sorting-strategy '(priority-down))
8829 (org-agenda-prefix-format " Mixed: ")))
8830 ("U" tags-tree "+boss-urgent"
8831 ((org-show-following-heading nil)
8832 (org-show-hierarchy-above nil)))
8834 ((org-agenda-files '("~org/notes.org"))
8835 (org-agenda-text-search-extra-files nil)))))
8840 Now the @kbd{C-c a w} command will sort the collected entries only by
8841 priority, and the prefix format is modified to just say @samp{ Mixed: }
8842 instead of giving the category of the entry. The sparse tags tree of
8843 @kbd{C-c a U} will now turn out ultra-compact, because neither the
8844 headline hierarchy above the match, nor the headline following the match
8845 will be shown. The command @kbd{C-c a N} will do a text search limited
8846 to only a single file.
8848 @vindex org-agenda-custom-commands
8849 For command sets creating a block agenda,
8850 @code{org-agenda-custom-commands} has two separate spots for setting
8851 options. You can add options that should be valid for just a single
8852 command in the set, and options that should be valid for all commands in
8853 the set. The former are just added to the command entry; the latter
8854 must come after the list of command entries. Going back to the block
8855 agenda example (@pxref{Block agenda}), let's change the sorting strategy
8856 for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort
8857 the results for GARDEN tags query in the opposite order,
8858 @code{priority-up}. This would look like this:
8862 (setq org-agenda-custom-commands
8863 '(("h" "Agenda and Home-related tasks"
8867 ((org-agenda-sorting-strategy '(priority-up)))))
8868 ((org-agenda-sorting-strategy '(priority-down))))
8869 ("o" "Agenda and Office-related tasks"
8876 As you see, the values and parentheses setting is a little complex.
8877 When in doubt, use the customize interface to set this variable---it
8878 fully supports its structure. Just one caveat: when setting options in
8879 this interface, the @emph{values} are just Lisp expressions. So if the
8880 value is a string, you need to add the double-quotes around the value
8883 @vindex org-agenda-custom-commands-contexts
8884 To control whether an agenda command should be accessible from a specific
8885 context, you can customize @var{org-agenda-custom-commands-contexts}. Let's
8886 say for example that you have an agenda commands @code{"o"} displaying a view
8887 that you only need when reading emails. Then you would configure this option
8891 (setq org-agenda-custom-commands-contexts
8892 '(("o" (in-mode . "message-mode"))))
8895 You can also tell that the command key @code{"o"} should refer to another
8896 command key @code{"r"}. In that case, add this command key like this:
8899 (setq org-agenda-custom-commands-contexts
8900 '(("o" "r" (in-mode . "message-mode"))))
8903 See the docstring of the variable for more information.
8905 @node Exporting Agenda Views, Agenda column view, Custom agenda views, Agenda Views
8906 @section Exporting Agenda Views
8907 @cindex agenda views, exporting
8909 If you are away from your computer, it can be very useful to have a printed
8910 version of some agenda views to carry around. Org mode can export custom
8911 agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
8912 @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
8913 ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
8914 a PDF file will also create the postscript file.}, and iCalendar files. If
8915 you want to do this only occasionally, use the command
8918 @orgcmd{C-x C-w,org-agenda-write}
8919 @cindex exporting agenda views
8920 @cindex agenda views, exporting
8921 @vindex org-agenda-exporter-settings
8922 Write the agenda view to a file. Depending on the extension of the selected
8923 file name, the view will be exported as HTML (extension @file{.html} or
8924 @file{.htm}), Postscript (extension @file{.ps}), iCalendar (extension
8925 @file{.ics}), or plain text (any other extension). Use the variable
8926 @code{org-agenda-exporter-settings} to set options for @file{ps-print} and
8927 for @file{htmlize} to be used during export, for example
8929 @vindex org-agenda-add-entry-text-maxlines
8930 @vindex htmlize-output-type
8931 @vindex ps-number-of-columns
8932 @vindex ps-landscape-mode
8934 (setq org-agenda-exporter-settings
8935 '((ps-number-of-columns 2)
8936 (ps-landscape-mode t)
8937 (org-agenda-add-entry-text-maxlines 5)
8938 (htmlize-output-type 'css)))
8942 If you need to export certain agenda views frequently, you can associate
8943 any custom agenda command with a list of output file names
8944 @footnote{If you want to store standard views like the weekly agenda
8945 or the global TODO list as well, you need to define custom commands for
8946 them in order to be able to specify file names.}. Here is an example
8947 that first defines custom commands for the agenda and the global
8948 TODO list, together with a number of files to which to export them.
8949 Then we define two block agenda commands and specify file names for them
8950 as well. File names can be relative to the current working directory,
8955 (setq org-agenda-custom-commands
8956 '(("X" agenda "" nil ("agenda.html" "agenda.ps"))
8957 ("Y" alltodo "" nil ("todo.html" "todo.txt" "todo.ps"))
8958 ("h" "Agenda and Home-related tasks"
8963 ("~/views/home.html"))
8964 ("o" "Agenda and Office-related tasks"
8969 ("~/views/office.ps" "~/calendars/office.ics"))))
8973 The extension of the file name determines the type of export. If it is
8974 @file{.html}, Org mode will use the @file{htmlize.el} package to convert
8975 the buffer to HTML and save it to this file name. If the extension is
8976 @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce
8977 Postscript output. If the extension is @file{.ics}, iCalendar export is
8978 run export over all files that were used to construct the agenda, and
8979 limit the export to entries listed in the agenda. Any other
8980 extension produces a plain ASCII file.
8982 The export files are @emph{not} created when you use one of those
8983 commands interactively because this might use too much overhead.
8984 Instead, there is a special command to produce @emph{all} specified
8988 @orgcmd{C-c a e,org-store-agenda-views}
8989 Export all agenda views that have export file names associated with
8993 You can use the options section of the custom agenda commands to also
8994 set options for the export commands. For example:
8997 (setq org-agenda-custom-commands
8999 ((ps-number-of-columns 2)
9000 (ps-landscape-mode t)
9001 (org-agenda-prefix-format " [ ] ")
9002 (org-agenda-with-colors nil)
9003 (org-agenda-remove-tags t))
9008 This command sets two options for the Postscript exporter, to make it
9009 print in two columns in landscape format---the resulting page can be cut
9010 in two and then used in a paper agenda. The remaining settings modify
9011 the agenda prefix to omit category and scheduling information, and
9012 instead include a checkbox to check off items. We also remove the tags
9013 to make the lines compact, and we don't want to use colors for the
9014 black-and-white printer. Settings specified in
9015 @code{org-agenda-exporter-settings} will also apply, but the settings
9016 in @code{org-agenda-custom-commands} take precedence.
9019 From the command line you may also use
9021 emacs -eval (org-batch-store-agenda-views) -kill
9024 or, if you need to modify some parameters@footnote{Quoting depends on the
9025 system you use, please check the FAQ for examples.}
9027 emacs -eval '(org-batch-store-agenda-views \
9028 org-agenda-span (quote month) \
9029 org-agenda-start-day "2007-11-01" \
9030 org-agenda-include-diary nil \
9031 org-agenda-files (quote ("~/org/project.org")))' \
9035 which will create the agenda views restricted to the file
9036 @file{~/org/project.org}, without diary entries and with a 30-day
9039 You can also extract agenda information in a way that allows further
9040 processing by other programs. See @ref{Extracting agenda information}, for
9044 @node Agenda column view, , Exporting Agenda Views, Agenda Views
9045 @section Using column view in the agenda
9046 @cindex column view, in agenda
9047 @cindex agenda, column view
9049 Column view (@pxref{Column view}) is normally used to view and edit
9050 properties embedded in the hierarchical structure of an Org file. It can be
9051 quite useful to use column view also from the agenda, where entries are
9052 collected by certain criteria.
9055 @orgcmd{C-c C-x C-c,org-agenda-columns}
9056 Turn on column view in the agenda.
9059 To understand how to use this properly, it is important to realize that the
9060 entries in the agenda are no longer in their proper outline environment.
9061 This causes the following issues:
9065 @vindex org-columns-default-format
9066 @vindex org-overriding-columns-format
9067 Org needs to make a decision which @code{COLUMNS} format to use. Since the
9068 entries in the agenda are collected from different files, and different files
9069 may have different @code{COLUMNS} formats, this is a non-trivial problem.
9070 Org first checks if the variable @code{org-agenda-overriding-columns-format} is
9071 currently set, and if so, takes the format from there. Otherwise it takes
9072 the format associated with the first item in the agenda, or, if that item
9073 does not have a specific format (defined in a property, or in its file), it
9074 uses @code{org-columns-default-format}.
9076 @cindex property, special, CLOCKSUM
9077 If any of the columns has a summary type defined (@pxref{Column attributes}),
9078 turning on column view in the agenda will visit all relevant agenda files and
9079 make sure that the computations of this property are up to date. This is
9080 also true for the special @code{CLOCKSUM} property. Org will then sum the
9081 values displayed in the agenda. In the daily/weekly agenda, the sums will
9082 cover a single day; in all other views they cover the entire block. It is
9083 vital to realize that the agenda may show the same entry @emph{twice} (for
9084 example as scheduled and as a deadline), and it may show two entries from the
9085 same hierarchy (for example a @emph{parent} and its @emph{child}). In these
9086 cases, the summation in the agenda will lead to incorrect results because
9087 some values will count double.
9089 When the column view in the agenda shows the @code{CLOCKSUM}, that is always
9090 the entire clocked time for this item. So even in the daily/weekly agenda,
9091 the clocksum listed in column view may originate from times outside the
9092 current view. This has the advantage that you can compare these values with
9093 a column listing the planned total effort for a task---one of the major
9094 applications for column view in the agenda. If you want information about
9095 clocked time in the displayed period use clock table mode (press @kbd{R} in
9099 @cindex property, special, CLOCKSUM_T
9100 When the column view in the agenda shows the @code{CLOCKSUM_T}, that is
9101 always today's clocked time for this item. So even in the weekly agenda,
9102 the clocksum listed in column view only originates from today. This lets
9103 you compare the time you spent on a task for today, with the time already
9104 spent (via @code{CLOCKSUM}) and with the planned total effort for it.
9108 @node Markup, Exporting, Agenda Views, Top
9109 @chapter Markup for rich export
9111 When exporting Org mode documents, the exporter tries to reflect the
9112 structure of the document as accurately as possible in the backend. Since
9113 export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting,
9114 Org mode has rules on how to prepare text for rich export. This section
9115 summarizes the markup rules used in an Org mode buffer.
9118 * Structural markup elements:: The basic structure as seen by the exporter
9119 * Images and tables:: Tables and Images will be included
9120 * Literal examples:: Source code examples with special formatting
9121 * Include files:: Include additional files into a document
9122 * Index entries:: Making an index
9123 * Macro replacement:: Use macros to create complex output
9124 * Embedded @LaTeX{}:: LaTeX can be freely used inside Org documents
9127 @node Structural markup elements, Images and tables, Markup, Markup
9128 @section Structural markup elements
9131 * Document title:: Where the title is taken from
9132 * Headings and sections:: The document structure as seen by the exporter
9133 * Table of contents:: The if and where of the table of contents
9134 * Initial text:: Text before the first heading?
9136 * Paragraphs:: Paragraphs
9137 * Footnote markup:: Footnotes
9138 * Emphasis and monospace:: Bold, italic, etc.
9139 * Horizontal rules:: Make a line
9140 * Comment lines:: What will *not* be exported
9143 @node Document title, Headings and sections, Structural markup elements, Structural markup elements
9144 @subheading Document title
9145 @cindex document title, markup rules
9148 The title of the exported document is taken from the special line
9152 #+TITLE: This is the title of the document
9156 If this line does not exist, the title is derived from the first non-empty,
9157 non-comment line in the buffer. If no such line exists, or if you have
9158 turned off exporting of the text before the first headline (see below), the
9159 title will be the file name without extension.
9161 @cindex property, EXPORT_TITLE
9162 If you are exporting only a subtree by marking is as the region, the heading
9163 of the subtree will become the title of the document. If the subtree has a
9164 property @code{EXPORT_TITLE}, that will take precedence.
9166 @node Headings and sections, Table of contents, Document title, Structural markup elements
9167 @subheading Headings and sections
9168 @cindex headings and sections, markup rules
9170 @vindex org-export-headline-levels
9171 The outline structure of the document as described in @ref{Document
9172 Structure}, forms the basis for defining sections of the exported document.
9173 However, since the outline structure is also used for (for example) lists of
9174 tasks, only the first three outline levels will be used as headings. Deeper
9175 levels will become itemized lists. You can change the location of this
9176 switch globally by setting the variable @code{org-export-headline-levels}, or on a
9177 per-file basis with a line
9184 @node Table of contents, Initial text, Headings and sections, Structural markup elements
9185 @subheading Table of contents
9186 @cindex table of contents, markup rules
9188 @vindex org-export-with-toc
9189 The table of contents is normally inserted directly before the first headline
9190 of the file. If you would like to get it to a different location, insert the
9191 string @code{[TABLE-OF-CONTENTS]} on a line by itself at the desired
9192 location. The depth of the table of contents is by default the same as the
9193 number of headline levels, but you can choose a smaller number, or turn off
9194 the table of contents entirely, by configuring the variable
9195 @code{org-export-with-toc}, or on a per-file basis with a line like
9198 #+OPTIONS: toc:2 (only to two levels in TOC)
9199 #+OPTIONS: toc:nil (no TOC at all)
9202 @node Initial text, Lists, Table of contents, Structural markup elements
9203 @subheading Text before the first headline
9204 @cindex text before first headline, markup rules
9207 Org mode normally exports the text before the first headline, and even uses
9208 the first line as the document title. The text will be fully marked up. If
9209 you need to include literal HTML, @LaTeX{}, or DocBook code, use the special
9210 constructs described below in the sections for the individual exporters.
9212 @vindex org-export-skip-text-before-1st-heading
9213 Some people like to use the space before the first headline for setup and
9214 internal links and therefore would like to control the exported text before
9215 the first headline in a different way. You can do so by setting the variable
9216 @code{org-export-skip-text-before-1st-heading} to @code{t}. On a per-file
9217 basis, you can get the same effect with @samp{#+OPTIONS: skip:t}.
9220 If you still want to have some text before the first headline, use the
9221 @code{#+TEXT} construct:
9225 #+TEXT: This text will go before the *first* headline.
9226 #+TEXT: [TABLE-OF-CONTENTS]
9227 #+TEXT: This goes between the table of contents and the *first* headline
9230 @node Lists, Paragraphs, Initial text, Structural markup elements
9232 @cindex lists, markup rules
9234 Plain lists as described in @ref{Plain lists}, are translated to the backend's
9235 syntax for such lists. Most backends support unordered, ordered, and
9238 @node Paragraphs, Footnote markup, Lists, Structural markup elements
9239 @subheading Paragraphs, line breaks, and quoting
9240 @cindex paragraphs, markup rules
9242 Paragraphs are separated by at least one empty line. If you need to enforce
9243 a line break within a paragraph, use @samp{\\} at the end of a line.
9245 To keep the line breaks in a region, but otherwise use normal formatting, you
9246 can use this construct, which can also be used to format poetry.
9248 @cindex #+BEGIN_VERSE
9251 Great clouds overhead
9252 Tiny black birds rise and fall
9259 When quoting a passage from another document, it is customary to format this
9260 as a paragraph that is indented on both the left and the right margin. You
9261 can include quotations in Org mode documents like this:
9263 @cindex #+BEGIN_QUOTE
9266 Everything should be made as simple as possible,
9267 but not any simpler -- Albert Einstein
9271 If you would like to center some text, do it like this:
9272 @cindex #+BEGIN_CENTER
9275 Everything should be made as simple as possible, \\
9281 @node Footnote markup, Emphasis and monospace, Paragraphs, Structural markup elements
9282 @subheading Footnote markup
9283 @cindex footnotes, markup rules
9284 @cindex @file{footnote.el}
9286 Footnotes defined in the way described in @ref{Footnotes}, will be exported
9287 by all backends. Org allows multiple references to the same note, and
9288 multiple footnotes side by side.
9290 @node Emphasis and monospace, Horizontal rules, Footnote markup, Structural markup elements
9291 @subheading Emphasis and monospace
9293 @cindex underlined text, markup rules
9294 @cindex bold text, markup rules
9295 @cindex italic text, markup rules
9296 @cindex verbatim text, markup rules
9297 @cindex code text, markup rules
9298 @cindex strike-through text, markup rules
9299 You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=}
9300 and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text
9301 in the code and verbatim string is not processed for Org mode specific
9302 syntax; it is exported verbatim.
9304 @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements
9305 @subheading Horizontal rules
9306 @cindex horizontal rules, markup rules
9307 A line consisting of only dashes, and at least 5 of them, will be exported as
9308 a horizontal line (@samp{<hr/>} in HTML and @code{\hrule} in @LaTeX{}).
9310 @node Comment lines, , Horizontal rules, Structural markup elements
9311 @subheading Comment lines
9312 @cindex comment lines
9313 @cindex exporting, not
9314 @cindex #+BEGIN_COMMENT
9316 Lines starting with zero or more whitespace characters followed by one
9317 @samp{#} and a whitespace are treated as comments and will never be exported.
9318 Also entire subtrees starting with the word @samp{COMMENT} will never be
9319 exported. Finally, regions surrounded by @samp{#+BEGIN_COMMENT}
9320 ... @samp{#+END_COMMENT} will not be exported.
9325 Toggle the COMMENT keyword at the beginning of an entry.
9329 @node Images and tables, Literal examples, Structural markup elements, Markup
9330 @section Images and Tables
9332 @cindex tables, markup rules
9335 Both the native Org mode tables (@pxref{Tables}) and tables formatted with
9336 the @file{table.el} package will be exported properly. For Org mode tables,
9337 the lines before the first horizontal separator line will become table header
9338 lines. You can use the following lines somewhere before the table to assign
9339 a caption and a label for cross references, and in the text you can refer to
9340 the object with @code{\ref@{tab:basic-data@}}:
9343 #+CAPTION: This is the caption for the next table (or link)
9344 #+LABEL: tab:basic-data
9349 Optionally, the caption can take the form:
9351 #+CAPTION: [Caption for list of figures]@{Caption for table (or link).@}
9354 @cindex inlined images, markup rules
9355 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
9356 images into the exported document. Org does this, if a link to an image
9357 files does not have a description part, for example @code{[[./img/a.jpg]]}.
9358 If you wish to define a caption for the image and maybe a label for internal
9359 cross references, make sure that the link is on a line by itself and precede
9360 it with @code{#+CAPTION} and @code{#+LABEL} as follows:
9363 #+CAPTION: This is the caption for the next figure link (or table)
9364 #+LABEL: fig:SED-HR4049
9368 You may also define additional attributes for the figure. As this is
9369 backend-specific, see the sections about the individual backends for more
9372 @xref{Handling links,the discussion of image links}.
9374 @node Literal examples, Include files, Images and tables, Markup
9375 @section Literal examples
9376 @cindex literal examples, markup rules
9377 @cindex code line references, markup rules
9379 You can include literal examples that should not be subjected to
9380 markup. Such examples will be typeset in monospace, so this is well suited
9381 for source code and similar examples.
9382 @cindex #+BEGIN_EXAMPLE
9386 Some example from a text file.
9390 Note that such blocks may be @i{indented} in order to align nicely with
9391 indented text and in particular with plain list structure (@pxref{Plain
9392 lists}). For simplicity when using small examples, you can also start the
9393 example lines with a colon followed by a space. There may also be additional
9394 whitespace before the colon:
9398 : Some example from a text file.
9401 @cindex formatting source code, markup rules
9402 If the example is source code from a programming language, or any other text
9403 that can be marked up by font-lock in Emacs, you can ask for the example to
9404 look like the fontified Emacs buffer@footnote{This works automatically for
9405 the HTML backend (it requires version 1.34 of the @file{htmlize.el} package,
9406 which is distributed with Org). Fontified code chunks in @LaTeX{} can be
9407 achieved using either the listings or the
9408 @url{http://code.google.com/p/minted, minted,} package. Refer to
9409 @code{org-export-latex-listings} documentation for details.}. This is done
9410 with the @samp{src} block, where you also need to specify the name of the
9411 major mode that should be used to fontify the example@footnote{Code in
9412 @samp{src} blocks may also be evaluated either interactively or on export.
9413 See @pxref{Working With Source Code} for more information on evaluating code
9414 blocks.}, see @ref{Easy Templates} for shortcuts to easily insert code
9419 #+BEGIN_SRC emacs-lisp
9420 (defun org-xor (a b)
9426 Both in @code{example} and in @code{src} snippets, you can add a @code{-n}
9427 switch to the end of the @code{BEGIN} line, to get the lines of the example
9428 numbered. If you use a @code{+n} switch, the numbering from the previous
9429 numbered snippet will be continued in the current one. In literal examples,
9430 Org will interpret strings like @samp{(ref:name)} as labels, and use them as
9431 targets for special hyperlinks like @code{[[(name)]]} (i.e., the reference name
9432 enclosed in single parenthesis). In HTML, hovering the mouse over such a
9433 link will remote-highlight the corresponding code line, which is kind of
9436 You can also add a @code{-r} switch which @i{removes} the labels from the
9437 source code@footnote{Adding @code{-k} to @code{-n -r} will @i{keep} the
9438 labels in the source code while using line numbers for the links, which might
9439 be useful to explain those in an Org mode example code.}. With the @code{-n}
9440 switch, links to these references will be labeled by the line numbers from
9441 the code listing, otherwise links will use the labels with no parentheses.
9445 #+BEGIN_SRC emacs-lisp -n -r
9446 (save-excursion (ref:sc)
9447 (goto-char (point-min)) (ref:jump)
9449 In line [[(sc)]] we remember the current position. [[(jump)][Line (jump)]]
9453 @vindex org-coderef-label-format
9454 If the syntax for the label format conflicts with the language syntax, use a
9455 @code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
9456 -n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
9458 HTML export also allows examples to be published as text areas (@pxref{Text
9459 areas in HTML export}).
9461 Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
9462 so often, shortcuts are provided using the Easy Templates facility
9463 (@pxref{Easy Templates}).
9468 Edit the source code example at point in its native mode. This works by
9469 switching to a temporary buffer with the source code. You need to exit by
9470 pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*},
9471 @samp{,*}, @samp{#+} and @samp{,#+} will get a comma prepended, to keep them
9472 from being interpreted by Org as outline nodes or special syntax. These
9473 commas will be stripped for editing with @kbd{C-c '}, and also for export.}.
9474 The edited version will then replace the old version in the Org buffer.
9475 Fixed-width regions (where each line starts with a colon followed by a space)
9476 will be edited using @code{artist-mode}@footnote{You may select
9477 a different-mode with the variable @code{org-edit-fixed-width-region-mode}.}
9478 to allow creating ASCII drawings easily. Using this command in an empty line
9479 will create a new fixed-width region.
9482 Calling @code{org-store-link} while editing a source code example in a
9483 temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure
9484 that it is unique in the current buffer, and insert it with the proper
9485 formatting like @samp{(ref:label)} at the end of the current line. Then the
9486 label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}.
9490 @node Include files, Index entries, Literal examples, Markup
9491 @section Include files
9492 @cindex include files, markup rules
9494 During export, you can include the content of another file. For example, to
9495 include your @file{.emacs} file, you could use:
9499 #+INCLUDE: "~/.emacs" src emacs-lisp
9503 The optional second and third parameter are the markup (e.g., @samp{quote},
9504 @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the
9505 language for formatting the contents. The markup is optional; if it is not
9506 given, the text will be assumed to be in Org mode format and will be
9507 processed normally. The include line will also allow additional keyword
9508 parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the
9509 first line and for each following line, @code{:minlevel} in order to get
9510 Org mode content demoted to a specified level, as well as any options
9511 accepted by the selected markup. For example, to include a file as an item,
9515 #+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " "
9518 You can also include a portion of a file by specifying a lines range using
9519 the @code{:lines} parameter. The line at the upper end of the range will not
9520 be included. The start and/or the end of the range may be omitted to use the
9524 #+INCLUDE: "~/.emacs" :lines "5-10" @r{Include lines 5 to 10, 10 excluded}
9525 #+INCLUDE: "~/.emacs" :lines "-10" @r{Include lines 1 to 10, 10 excluded}
9526 #+INCLUDE: "~/.emacs" :lines "10-" @r{Include lines from 10 to EOF}
9532 Visit the include file at point.
9535 @node Index entries, Macro replacement, Include files, Markup
9536 @section Index entries
9537 @cindex index entries, for publishing
9539 You can specify entries that will be used for generating an index during
9540 publishing. This is done by lines starting with @code{#+INDEX}. An entry
9541 the contains an exclamation mark will create a sub item. See @ref{Generating
9542 an index} for more information.
9547 #+INDEX: Application!CV
9553 @node Macro replacement, Embedded @LaTeX{}, Index entries, Markup
9554 @section Macro replacement
9555 @cindex macro replacement, during export
9558 You can define text snippets with
9561 #+MACRO: name replacement text $1, $2 are arguments
9564 @noindent which can be referenced anywhere in the document (even in
9565 code examples) with @code{@{@{@{name(arg1,arg2)@}@}@}}. In addition to
9566 defined macros, @code{@{@{@{title@}@}@}}, @code{@{@{@{author@}@}@}}, etc.,
9567 will reference information set by the @code{#+TITLE:}, @code{#+AUTHOR:}, and
9568 similar lines. Also, @code{@{@{@{date(@var{FORMAT})@}@}@}} and
9569 @code{@{@{@{modification-time(@var{FORMAT})@}@}@}} refer to current date time
9570 and to the modification time of the file being exported, respectively.
9571 @var{FORMAT} should be a format string understood by
9572 @code{format-time-string}.
9574 Macro expansion takes place during export, and some people use it to
9575 construct complex HTML code.
9578 @node Embedded @LaTeX{}, , Macro replacement, Markup
9579 @section Embedded @LaTeX{}
9580 @cindex @TeX{} interpretation
9581 @cindex @LaTeX{} interpretation
9583 Plain ASCII is normally sufficient for almost all note taking. Exceptions
9584 include scientific notes, which often require mathematical symbols and the
9585 occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on
9586 Donald E. Knuth's @TeX{} system. Many of the features described here as
9587 ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this
9588 distinction.} is widely used to typeset scientific documents. Org mode
9589 supports embedding @LaTeX{} code into its files, because many academics are
9590 used to writing and reading @LaTeX{} source code, and because it can be
9591 readily processed to produce pretty output for a number of export backends.
9594 * Special symbols:: Greek letters and other symbols
9595 * Subscripts and superscripts:: Simple syntax for raising/lowering text
9596 * @LaTeX{} fragments:: Complex formulas made easy
9597 * Previewing @LaTeX{} fragments:: What will this snippet look like?
9598 * CDLaTeX mode:: Speed up entering of formulas
9601 @node Special symbols, Subscripts and superscripts, Embedded @LaTeX{}, Embedded @LaTeX{}
9602 @subsection Special symbols
9603 @cindex math symbols
9604 @cindex special symbols
9605 @cindex @TeX{} macros
9606 @cindex @LaTeX{} fragments, markup rules
9607 @cindex HTML entities
9608 @cindex @LaTeX{} entities
9610 You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to
9611 indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion
9612 for these macros is available, just type @samp{\} and maybe a few letters,
9613 and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{}
9614 code, Org mode allows these macros to be present without surrounding math
9615 delimiters, for example:
9618 Angles are written as Greek letters \alpha, \beta and \gamma.
9621 @vindex org-entities
9622 During export, these symbols will be transformed into the native format of
9623 the exporter backend. Strings like @code{\alpha} will be exported as
9624 @code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{}
9625 output. Similarly, @code{\nbsp} will become @code{ } in HTML and
9626 @code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it
9627 like this: @samp{\Aacute@{@}stor}.
9629 A large number of entities is provided, with names taken from both HTML and
9630 @LaTeX{}; see the variable @code{org-entities} for the complete list.
9631 @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and
9632 @samp{...} are all converted into special commands creating hyphens of
9633 different lengths or a compact set of dots.
9635 If you would like to see entities displayed as UTF8 characters, use the
9636 following command@footnote{You can turn this on by default by setting the
9637 variable @code{org-pretty-entities}, or on a per-file base with the
9638 @code{#+STARTUP} option @code{entitiespretty}.}:
9643 Toggle display of entities as UTF-8 characters. This does not change the
9644 buffer content which remains plain ASCII, but it overlays the UTF-8 character
9645 for display purposes only.
9648 @node Subscripts and superscripts, @LaTeX{} fragments, Special symbols, Embedded @LaTeX{}
9649 @subsection Subscripts and superscripts
9653 Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super-
9654 and subscripts. Again, these can be used without embedding them in
9655 math-mode delimiters. To increase the readability of ASCII text, it is
9656 not necessary (but OK) to surround multi-character sub- and superscripts
9657 with curly braces. For example
9660 The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of
9661 the sun is R_@{sun@} = 6.96 x 10^8 m.
9664 @vindex org-export-with-sub-superscripts
9665 To avoid interpretation as raised or lowered text, you can quote @samp{^} and
9666 @samp{_} with a backslash: @samp{\^} and @samp{\_}. If you write a text
9667 where the underscore is often used in a different context, Org's convention
9668 to always interpret these as subscripts can get in your way. Configure the
9669 variable @code{org-export-with-sub-superscripts} to globally change this
9670 convention, or use, on a per-file basis:
9676 @noindent With this setting, @samp{a_b} will not be interpreted as a
9677 subscript, but @samp{a_@{b@}} will.
9682 In addition to showing entities as UTF-8 characters, this command will also
9683 format sub- and superscripts in a WYSIWYM way.
9686 @node @LaTeX{} fragments, Previewing @LaTeX{} fragments, Subscripts and superscripts, Embedded @LaTeX{}
9687 @subsection @LaTeX{} fragments
9688 @cindex @LaTeX{} fragments
9690 @vindex org-format-latex-header
9691 Going beyond symbols and sub- and superscripts, a full formula language is
9692 needed. Org mode can contain @LaTeX{} math fragments, and it supports ways
9693 to process these for several export backends. When exporting to @LaTeX{},
9694 the code is obviously left as it is. When exporting to HTML, Org invokes the
9695 @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in
9696 HTML export}) to process and display the math@footnote{If you plan to use
9697 this regularly or on pages with significant page views, you should install
9698 @file{MathJax} on your own
9699 server in order to limit the load of our server.}. Finally, it can also
9700 process the mathematical expressions into images@footnote{For this to work
9701 you need to be on a system with a working @LaTeX{} installation. You also
9702 need the @file{dvipng} program or the @file{convert}, respectively available
9703 at @url{http://sourceforge.net/projects/dvipng/} and from the
9704 @file{imagemagick} suite. The @LaTeX{} header that will be used when
9705 processing a fragment can be configured with the variable
9706 @code{org-format-latex-header}.} that can be displayed in a browser or in
9709 @LaTeX{} fragments don't need any special marking at all. The following
9710 snippets will be identified as @LaTeX{} source code:
9713 Environments of any kind@footnote{When @file{MathJax} is used, only the
9714 environment recognized by @file{MathJax} will be processed. When
9715 @file{dvipng} is used to create images, any @LaTeX{} environments will be
9716 handled.}. The only requirement is that the @code{\begin} statement appears
9717 on a new line, preceded by only whitespace.
9719 Text within the usual @LaTeX{} math delimiters. To avoid conflicts with
9720 currency specifications, single @samp{$} characters are only recognized as
9721 math delimiters if the enclosed text contains at most two line breaks, is
9722 directly attached to the @samp{$} characters with no whitespace in between,
9723 and if the closing @samp{$} is followed by whitespace, punctuation or a dash.
9724 For the other delimiters, there is no such restriction, so when in doubt, use
9725 @samp{\(...\)} as inline math delimiters.
9728 @noindent For example:
9731 \begin@{equation@} % arbitrary environments,
9732 x=\sqrt@{b@} % even tables, figures
9733 \end@{equation@} % etc
9735 If $a^2=b$ and \( b=2 \), then the solution must be
9736 either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \].
9740 @vindex org-format-latex-options
9741 If you need any of the delimiter ASCII sequences for other purposes, you
9742 can configure the option @code{org-format-latex-options} to deselect the
9743 ones you do not wish to have interpreted by the @LaTeX{} converter.
9745 @vindex org-export-with-LaTeX-fragments
9746 @LaTeX{} processing can be configured with the variable
9747 @code{org-export-with-LaTeX-fragments}. The default setting is @code{t}
9748 which means @file{MathJax} for HTML, and no processing for DocBook, ASCII and
9749 @LaTeX{} backends. You can also set this variable on a per-file basis using one
9753 #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)}
9754 #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images}
9755 #+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all}
9756 #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so}
9759 @node Previewing @LaTeX{} fragments, CDLaTeX mode, @LaTeX{} fragments, Embedded @LaTeX{}
9760 @subsection Previewing @LaTeX{} fragments
9761 @cindex @LaTeX{} fragments, preview
9763 If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to
9764 produce preview images of the typeset expressions:
9769 Produce a preview image of the @LaTeX{} fragment at point and overlay it
9770 over the source code. If there is no fragment at point, process all
9771 fragments in the current entry (between two headlines). When called
9772 with a prefix argument, process the entire subtree. When called with
9773 two prefix arguments, or when the cursor is before the first headline,
9774 process the entire buffer.
9777 Remove the overlay preview images.
9780 @vindex org-format-latex-options
9781 You can customize the variable @code{org-format-latex-options} to influence
9782 some aspects of the preview. In particular, the @code{:scale} (and for HTML
9783 export, @code{:html-scale}) property can be used to adjust the size of the
9786 @node CDLaTeX mode, , Previewing @LaTeX{} fragments, Embedded @LaTeX{}
9787 @subsection Using CD@LaTeX{} to enter math
9790 CD@LaTeX{} mode is a minor mode that is normally used in combination with a
9791 major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of
9792 environments and math templates. Inside Org mode, you can make use of
9793 some of the features of CD@LaTeX{} mode. You need to install
9794 @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with
9795 AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}.
9796 Don't use CD@LaTeX{} mode itself under Org mode, but use the light
9797 version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it
9798 on for the current buffer with @code{M-x org-cdlatex-mode}, or for all
9802 (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
9805 When this mode is enabled, the following features are present (for more
9806 details see the documentation of CD@LaTeX{} mode):
9810 Environment templates can be inserted with @kbd{C-c @{}.
9813 The @key{TAB} key will do template expansion if the cursor is inside a
9814 @LaTeX{} fragment@footnote{Org mode has a method to test if the cursor is
9815 inside such a fragment, see the documentation of the function
9816 @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will
9817 expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor
9818 correctly inside the first brace. Another @key{TAB} will get you into
9819 the second brace. Even outside fragments, @key{TAB} will expand
9820 environment abbreviations at the beginning of a line. For example, if
9821 you write @samp{equ} at the beginning of a line and press @key{TAB},
9822 this abbreviation will be expanded to an @code{equation} environment.
9823 To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}.
9827 @vindex cdlatex-simplify-sub-super-scripts
9828 Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these
9829 characters together with a pair of braces. If you use @key{TAB} to move
9830 out of the braces, and if the braces surround only a single character or
9831 macro, they are removed again (depending on the variable
9832 @code{cdlatex-simplify-sub-super-scripts}).
9835 Pressing the backquote @kbd{`} followed by a character inserts math
9836 macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds
9837 after the backquote, a help window will pop up.
9840 Pressing the single-quote @kbd{'} followed by another character modifies
9841 the symbol before point with an accent or a font. If you wait more than
9842 1.5 seconds after the single-quote, a help window will pop up. Character
9843 modification will work only inside @LaTeX{} fragments; outside the quote
9847 @node Exporting, Publishing, Markup, Top
9851 Org mode documents can be exported into a variety of other formats. For
9852 printing and sharing of notes, ASCII export produces a readable and simple
9853 version of an Org file. HTML export allows you to publish a notes file on
9854 the web, while the XOXO format provides a solid base for exchange with a
9855 broad range of other applications. @LaTeX{} export lets you use Org mode and
9856 its structured editing functions to easily create @LaTeX{} files. DocBook
9857 export makes it possible to convert Org files to many other formats using
9858 DocBook tools. OpenDocument Text (ODT) export allows seamless
9859 collaboration across organizational boundaries. For project management you
9860 can create gantt and resource charts by using TaskJuggler export. To
9861 incorporate entries with associated times like deadlines or appointments into
9862 a desktop calendar program like iCal, Org mode can also produce extracts in
9863 the iCalendar format. Currently, Org mode only supports export, not import of
9864 these different formats.
9866 Org supports export of selected regions when @code{transient-mark-mode} is
9867 enabled (default in Emacs 23).
9870 * Selective export:: Using tags to select and exclude trees
9871 * Export options:: Per-file export settings
9872 * The export dispatcher:: How to access exporter commands
9873 * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding
9874 * HTML export:: Exporting to HTML
9875 * @LaTeX{} and PDF export:: Exporting to @LaTeX{}, and processing to PDF
9876 * DocBook export:: Exporting to DocBook
9877 * OpenDocument Text export:: Exporting to OpenDocument Text
9878 * TaskJuggler export:: Exporting to TaskJuggler
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
9948 @cindex #+EXPORT_SELECT_TAGS
9949 @cindex #+EXPORT_EXCLUDE_TAGS
9951 @cindex #+LaTeX_HEADER
9952 @vindex user-full-name
9953 @vindex user-mail-address
9954 @vindex org-export-default-language
9955 @vindex org-export-date-timestamp-format
9957 #+TITLE: the title to be shown (default is the buffer name)
9958 #+AUTHOR: the author (default taken from @code{user-full-name})
9959 #+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}
9960 #+EMAIL: his/her email address (default from @code{user-mail-address})
9961 #+DESCRIPTION: the page description, e.g., for the XHTML meta tag
9962 #+KEYWORDS: the page keywords, e.g., for the XHTML meta tag
9963 #+LANGUAGE: language for HTML, e.g., @samp{en} (@code{org-export-default-language})
9964 #+TEXT: Some descriptive text to be inserted at the beginning.
9965 #+TEXT: Several lines may be given.
9966 #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ...
9967 #+BIND: lisp-var lisp-val, e.g., @code{org-export-latex-low-levels itemize}
9968 @r{You need to confirm using these, or configure @code{org-export-allow-BIND}}
9969 #+LINK_UP: the ``up'' link of an exported page
9970 #+LINK_HOME: the ``home'' link of an exported page
9971 #+LaTeX_HEADER: extra line(s) for the @LaTeX{} header, like \usepackage@{xyz@}
9972 #+EXPORT_SELECT_TAGS: Tags that select a tree for export
9973 #+EXPORT_EXCLUDE_TAGS: Tags that exclude a tree from export
9974 #+XSLT: the XSLT stylesheet used by DocBook exporter to generate FO file
9978 The @code{#+OPTIONS} line is a compact@footnote{If you want to configure many options
9979 this way, you can use several @code{#+OPTIONS} lines.} form to specify export
9980 settings. Here you can:
9981 @cindex headline levels
9982 @cindex section-numbers
9983 @cindex table of contents
9984 @cindex line-break preservation
9985 @cindex quoted HTML tags
9986 @cindex fixed-width sections
9988 @cindex @TeX{}-like syntax for sub- and superscripts
9990 @cindex special strings
9991 @cindex emphasized text
9992 @cindex @TeX{} macros
9993 @cindex @LaTeX{} fragments
9994 @cindex author info, in export
9995 @cindex time info, in export
9996 @vindex org-export-plist-vars
9997 @vindex org-export-author-info
9998 @vindex org-export-creator-info
9999 @vindex org-export-email-info
10000 @vindex org-export-time-stamp-file
10002 H: @r{set the number of headline levels for export}
10003 num: @r{turn on/off section-numbers}
10004 toc: @r{turn on/off table of contents, or set level limit (integer)}
10005 \n: @r{turn on/off line-break-preservation (DOES NOT WORK)}
10006 @@: @r{turn on/off quoted HTML tags}
10007 :: @r{turn on/off fixed-width sections}
10008 |: @r{turn on/off tables}
10009 ^: @r{turn on/off @TeX{}-like syntax for sub- and superscripts. If}
10010 @r{you write "^:@{@}", @code{a_@{b@}} will be interpreted, but}
10011 @r{the simple @code{a_b} will be left as it is.}
10012 -: @r{turn on/off conversion of special strings.}
10013 f: @r{turn on/off footnotes like this[1].}
10014 todo: @r{turn on/off inclusion of TODO keywords into exported text}
10015 tasks: @r{turn on/off inclusion of tasks (TODO items), can be nil to remove}
10016 @r{all tasks, @code{todo} to remove DONE tasks, or list of kwds to keep}
10017 pri: @r{turn on/off priority cookies}
10018 tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}}
10019 <: @r{turn on/off inclusion of any time/date stamps like DEADLINES}
10020 *: @r{turn on/off emphasized text (bold, italic, underlined)}
10021 TeX: @r{turn on/off simple @TeX{} macros in plain text}
10022 LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}}
10023 skip: @r{turn on/off skipping the text before the first heading}
10024 author: @r{turn on/off inclusion of author name/email into exported file}
10025 email: @r{turn on/off inclusion of author email into exported file}
10026 creator: @r{turn on/off inclusion of creator info into exported file}
10027 timestamp: @r{turn on/off inclusion creation time into exported file}
10028 d: @r{turn on/off inclusion of drawers, or list drawers to include}
10031 These options take effect in both the HTML and @LaTeX{} export, except for
10032 @code{TeX} and @code{LaTeX} options, which are respectively @code{t} and
10033 @code{nil} for the @LaTeX{} export.
10035 The default values for these and many other options are given by a set of
10036 variables. For a list of such variables, the corresponding OPTIONS keys and
10037 also the publishing keys (@pxref{Project alist}), see the constant
10038 @code{org-export-plist-vars}.
10040 When exporting only a single subtree by selecting it with @kbd{C-c @@} before
10041 calling an export command, the subtree can overrule some of the file's export
10042 settings with properties @code{EXPORT_FILE_NAME}, @code{EXPORT_TITLE},
10043 @code{EXPORT_TEXT}, @code{EXPORT_AUTHOR}, @code{EXPORT_DATE}, and
10044 @code{EXPORT_OPTIONS}.
10046 @node The export dispatcher, ASCII/Latin-1/UTF-8 export, Export options, Exporting
10047 @section The export dispatcher
10048 @cindex dispatcher, for export commands
10050 All export commands can be reached using the export dispatcher, which is a
10051 prefix key that prompts for an additional key specifying the command.
10052 Normally the entire file is exported, but if there is an active region that
10053 contains one outline tree, the first heading is used as document title and
10054 the subtrees are exported.
10057 @orgcmd{C-c C-e,org-export}
10058 @vindex org-export-run-in-background
10059 Dispatcher for export and publishing commands. Displays a help-window
10060 listing the additional key(s) needed to launch an export or publishing
10061 command. The prefix arg is passed through to the exporter. A double prefix
10062 @kbd{C-u C-u} causes most commands to be executed in the background, in a
10063 separate Emacs process@footnote{To make this behavior the default, customize
10064 the variable @code{org-export-run-in-background}.}.
10065 @orgcmd{C-c C-e v,org-export-visible}
10066 Like @kbd{C-c C-e}, but only export the text that is currently visible
10067 (i.e., not hidden by outline visibility).
10068 @orgcmd{C-u C-u C-c C-e,org-export}
10069 @vindex org-export-run-in-background
10070 Call the exporter, but reverse the setting of
10071 @code{org-export-run-in-background}, i.e., request background processing if
10072 not set, or force processing in the current Emacs process if set.
10075 @node ASCII/Latin-1/UTF-8 export, HTML export, The export dispatcher, Exporting
10076 @section ASCII/Latin-1/UTF-8 export
10077 @cindex ASCII export
10078 @cindex Latin-1 export
10079 @cindex UTF-8 export
10081 ASCII export produces a simple and very readable version of an Org mode
10082 file, containing only plain ASCII@. Latin-1 and UTF-8 export augment the file
10083 with special characters and symbols available in these encodings.
10085 @cindex region, active
10086 @cindex active region
10087 @cindex transient-mark-mode
10089 @orgcmd{C-c C-e a,org-export-as-ascii}
10090 @cindex property, EXPORT_FILE_NAME
10091 Export as an ASCII file. For an Org file, @file{myfile.org}, the ASCII file
10092 will be @file{myfile.txt}. The file will be overwritten without
10093 warning. If there is an active region@footnote{This requires
10094 @code{transient-mark-mode} be turned on.}, only the region will be
10095 exported. If the selected region is a single tree@footnote{To select the
10096 current subtree, use @kbd{C-c @@}.}, the tree head will
10097 become the document title. If the tree head entry has or inherits an
10098 @code{EXPORT_FILE_NAME} property, that name will be used for the
10100 @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
10101 Export to a temporary buffer. Do not create a file.
10102 @orgcmd{C-c C-e n,org-export-as-latin1}
10103 @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
10104 Like the above commands, but use Latin-1 encoding.
10105 @orgcmd{C-c C-e u,org-export-as-utf8}
10106 @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
10107 Like the above commands, but use UTF-8 encoding.
10108 @item C-c C-e v a/n/u
10109 Export only the visible part of the document.
10112 @cindex headline levels, for exporting
10113 In the exported version, the first 3 outline levels will become
10114 headlines, defining a general document structure. Additional levels
10115 will be exported as itemized lists. If you want that transition to occur
10116 at a different level, specify it with a prefix argument. For example,
10119 @kbd{C-1 C-c C-e a}
10123 creates only top level headlines and exports the rest as items. When
10124 headlines are converted to items, the indentation of the text following
10125 the headline is changed to fit nicely under the item. This is done with
10126 the assumption that the first body line indicates the base indentation of
10127 the body text. Any indentation larger than this is adjusted to preserve
10128 the layout relative to the first line. Should there be lines with less
10129 indentation than the first one, these are left alone.
10131 @vindex org-export-ascii-links-to-notes
10132 Links will be exported in a footnote-like style, with the descriptive part in
10133 the text and the link in a note before the next heading. See the variable
10134 @code{org-export-ascii-links-to-notes} for details and other options.
10136 @node HTML export, @LaTeX{} and PDF export, ASCII/Latin-1/UTF-8 export, Exporting
10137 @section HTML export
10138 @cindex HTML export
10140 Org mode contains a HTML (XHTML 1.0 strict) exporter with extensive
10141 HTML formatting, in ways similar to John Gruber's @emph{markdown}
10142 language, but with additional support for tables.
10145 * HTML Export commands:: How to invoke HTML export
10146 * HTML preamble and postamble:: How to insert a preamble and a postamble
10147 * Quoting HTML tags:: Using direct HTML in Org mode
10148 * Links in HTML export:: How links will be interpreted and formatted
10149 * Tables in HTML export:: How to modify the formatting of tables
10150 * Images in HTML export:: How to insert figures into HTML output
10151 * Math formatting in HTML export:: Beautiful math also on the web
10152 * Text areas in HTML export:: An alternative way to show an example
10153 * CSS support:: Changing the appearance of the output
10154 * JavaScript support:: Info and Folding in a web browser
10157 @node HTML Export commands, HTML preamble and postamble, HTML export, HTML export
10158 @subsection HTML export commands
10160 @cindex region, active
10161 @cindex active region
10162 @cindex transient-mark-mode
10164 @orgcmd{C-c C-e h,org-export-as-html}
10165 @cindex property, EXPORT_FILE_NAME
10166 Export as a HTML file. For an Org file @file{myfile.org},
10167 the HTML file will be @file{myfile.html}. The file will be overwritten
10168 without warning. If there is an active region@footnote{This requires
10169 @code{transient-mark-mode} be turned on.}, only the region will be
10170 exported. If the selected region is a single tree@footnote{To select the
10171 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10172 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10173 property, that name will be used for the export.
10174 @orgcmd{C-c C-e b,org-export-as-html-and-open}
10175 Export as a HTML file and immediately open it with a browser.
10176 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
10177 Export to a temporary buffer. Do not create a file.
10178 @orgcmd{C-c C-e R,org-export-region-as-html}
10179 Export the active region to a temporary buffer. With a prefix argument, do
10180 not produce the file header and footer, but just the plain HTML section for
10181 the region. This is good for cut-and-paste operations.
10182 @item C-c C-e v h/b/H/R
10183 Export only the visible part of the document.
10184 @item M-x org-export-region-as-html
10185 Convert the region to HTML under the assumption that it was in Org mode
10186 syntax before. This is a global command that can be invoked in any
10188 @item M-x org-replace-region-by-HTML
10189 Replace the active region (assumed to be in Org mode syntax) by HTML
10193 @cindex headline levels, for exporting
10194 In the exported version, the first 3 outline levels will become headlines,
10195 defining a general document structure. Additional levels will be exported as
10196 itemized lists. If you want that transition to occur at a different level,
10197 specify it with a numeric prefix argument. For example,
10200 @kbd{C-2 C-c C-e b}
10204 creates two levels of headings and does the rest as items.
10207 @node HTML preamble and postamble, Quoting HTML tags, HTML Export commands, HTML export
10208 @subsection HTML preamble and postamble
10209 @vindex org-export-html-preamble
10210 @vindex org-export-html-postamble
10211 @vindex org-export-html-preamble-format
10212 @vindex org-export-html-postamble-format
10213 @vindex org-export-html-validation-link
10214 @vindex org-export-author-info
10215 @vindex org-export-email-info
10216 @vindex org-export-creator-info
10217 @vindex org-export-time-stamp-file
10219 The HTML exporter lets you define a preamble and a postamble.
10221 The default value for @code{org-export-html-preamble} is @code{t}, which
10222 means that the preamble is inserted depending on the relevant format string
10223 in @code{org-export-html-preamble-format}.
10225 Setting @code{org-export-html-preamble} to a string will override the default
10226 format string. Setting it to a function, will insert the output of the
10227 function, which must be a string; such a function takes no argument but you
10228 can check against the value of @code{opt-plist}, which contains the list of
10229 publishing properties for the current file. Setting to @code{nil} will not
10230 insert any preamble.
10232 The default value for @code{org-export-html-postamble} is @code{'auto}, which
10233 means that the HTML exporter will look for the value of
10234 @code{org-export-author-info}, @code{org-export-email-info},
10235 @code{org-export-creator-info} and @code{org-export-time-stamp-file},
10236 @code{org-export-html-validation-link} and build the postamble from these
10237 values. Setting @code{org-export-html-postamble} to @code{t} will insert the
10238 postamble from the relevant format string found in
10239 @code{org-export-html-postamble-format}. Setting it to @code{nil} will not
10240 insert any postamble.
10242 @node Quoting HTML tags, Links in HTML export, HTML preamble and postamble, HTML export
10243 @subsection Quoting HTML tags
10245 Plain @samp{<} and @samp{>} are always transformed to @samp{<} and
10246 @samp{>} in HTML export. If you want to include simple HTML tags
10247 which should be interpreted as such, mark them with @samp{@@} as in
10248 @samp{@@<b>bold text@@</b>}. Note that this really works only for
10249 simple tags. For more extensive HTML that should be copied verbatim to
10250 the exported file use either
10253 @cindex #+BEGIN_HTML
10255 #+HTML: Literal HTML code for export
10259 @cindex #+BEGIN_HTML
10263 All lines between these markers are exported literally
10268 @node Links in HTML export, Tables in HTML export, Quoting HTML tags, HTML export
10269 @subsection Links in HTML export
10271 @cindex links, in HTML export
10272 @cindex internal links, in HTML export
10273 @cindex external links, in HTML export
10274 Internal links (@pxref{Internal links}) will continue to work in HTML@. This
10275 includes automatic links created by radio targets (@pxref{Radio
10276 targets}). Links to external files will still work if the target file is on
10277 the same @i{relative} path as the published Org file. Links to other
10278 @file{.org} files will be translated into HTML links under the assumption
10279 that a HTML version also exists of the linked file, at the same relative
10280 path. @samp{id:} links can then be used to jump to specific entries across
10281 files. For information related to linking files while publishing them to a
10282 publishing directory see @ref{Publishing links}.
10284 If you want to specify attributes for links, you can do so using a special
10285 @code{#+ATTR_HTML} line to define attributes that will be added to the
10286 @code{<a>} or @code{<img>} tags. Here is an example that sets @code{title}
10287 and @code{style} attributes for a link:
10289 @cindex #+ATTR_HTML
10291 #+ATTR_HTML: title="The Org mode homepage" style="color:red;"
10292 [[http://orgmode.org]]
10295 @node Tables in HTML export, Images in HTML export, Links in HTML export, HTML export
10297 @cindex tables, in HTML
10298 @vindex org-export-html-table-tag
10300 Org mode tables are exported to HTML using the table tag defined in
10301 @code{org-export-html-table-tag}. The default setting makes tables without
10302 cell borders and frame. If you would like to change this for individual
10303 tables, place something like the following before the table:
10306 @cindex #+ATTR_HTML
10308 #+CAPTION: This is a table with lines around and between cells
10309 #+ATTR_HTML: border="2" rules="all" frame="border"
10312 @node Images in HTML export, Math formatting in HTML export, Tables in HTML export, HTML export
10313 @subsection Images in HTML export
10315 @cindex images, inline in HTML
10316 @cindex inlining images in HTML
10317 @vindex org-export-html-inline-images
10318 HTML export can inline images given as links in the Org file, and
10319 it can make an image the clickable part of a link. By
10320 default@footnote{But see the variable
10321 @code{org-export-html-inline-images}.}, images are inlined if a link does
10322 not have a description. So @samp{[[file:myimg.jpg]]} will be inlined,
10323 while @samp{[[file:myimg.jpg][the image]]} will just produce a link
10324 @samp{the image} that points to the image. If the description part
10325 itself is a @code{file:} link or a @code{http:} URL pointing to an
10326 image, this image will be inlined and activated so that clicking on the
10327 image will activate the link. For example, to include a thumbnail that
10328 will link to a high resolution version of the image, you could use:
10331 [[file:highres.jpg][file:thumb.jpg]]
10334 If you need to add attributes to an inlined image, use a @code{#+ATTR_HTML}.
10335 In the example below we specify the @code{alt} and @code{title} attributes to
10336 support text viewers and accessibility, and align it to the right.
10339 @cindex #+ATTR_HTML
10341 #+CAPTION: A black cat stalking a spider
10342 #+ATTR_HTML: alt="cat/spider image" title="Action!" align="right"
10347 You could use @code{http} addresses just as well.
10349 @node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
10350 @subsection Math formatting in HTML export
10354 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be displayed in two
10355 different ways on HTML pages. The default is to use the
10356 @uref{http://www.mathjax.org, MathJax system} which should work out of the
10357 box with Org mode installation because @code{http://orgmode.org} serves
10358 @file{MathJax} for Org mode users for small applications and for testing
10359 purposes. @b{If you plan to use this regularly or on pages with significant
10360 page views, you should install@footnote{Installation instructions can be
10361 found on the MathJax website, see
10362 @uref{http://www.mathjax.org/resources/docs/?installation.html}.} MathJax on
10363 your own server in order to limit the load of our server.} To configure
10364 @file{MathJax}, use the variable @code{org-export-html-mathjax-options} or
10365 insert something like the following into the buffer:
10368 #+MATHJAX: align:"left" mathml:t path:"/MathJax/MathJax.js"
10371 @noindent See the docstring of the variable
10372 @code{org-export-html-mathjax-options} for the meaning of the parameters in
10375 If you prefer, you can also request that @LaTeX{} fragments are processed
10376 into small images that will be inserted into the browser page. Before the
10377 availability of MathJax, this was the default method for Org files. This
10378 method requires that the @file{dvipng} program is available on your system.
10379 You can still get this processing with
10382 #+OPTIONS: LaTeX:dvipng
10385 @node Text areas in HTML export, CSS support, Math formatting in HTML export, HTML export
10386 @subsection Text areas in HTML export
10388 @cindex text areas, in HTML
10389 An alternative way to publish literal code examples in HTML is to use text
10390 areas, where the example can even be edited before pasting it into an
10391 application. It is triggered by a @code{-t} switch at an @code{example} or
10392 @code{src} block. Using this switch disables any options for syntax and
10393 label highlighting, and line numbering, which may be present. You may also
10394 use @code{-h} and @code{-w} switches to specify the height and width of the
10395 text area, which default to the number of lines in the example, and 80,
10396 respectively. For example
10399 #+BEGIN_EXAMPLE -t -w 40
10400 (defun org-xor (a b)
10407 @node CSS support, JavaScript support, Text areas in HTML export, HTML export
10408 @subsection CSS support
10409 @cindex CSS, for HTML export
10410 @cindex HTML export, CSS
10412 @vindex org-export-html-todo-kwd-class-prefix
10413 @vindex org-export-html-tag-class-prefix
10414 You can also give style information for the exported file. The HTML exporter
10415 assigns the following special CSS classes@footnote{If the classes on TODO
10416 keywords and tags lead to conflicts, use the variables
10417 @code{org-export-html-todo-kwd-class-prefix} and
10418 @code{org-export-html-tag-class-prefix} to make them unique.} to appropriate
10419 parts of the document---your style specifications may change these, in
10420 addition to any of the standard classes like for headlines, tables, etc.
10422 p.author @r{author information, including email}
10423 p.date @r{publishing date}
10424 p.creator @r{creator info, about org mode version}
10425 .title @r{document title}
10426 .todo @r{TODO keywords, all not-done states}
10427 .done @r{the DONE keywords, all states that count as done}
10428 .WAITING @r{each TODO keyword also uses a class named after itself}
10429 .timestamp @r{timestamp}
10430 .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED}
10431 .timestamp-wrapper @r{span around keyword plus timestamp}
10432 .tag @r{tag in a headline}
10433 ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"}
10434 .target @r{target for links}
10435 .linenr @r{the line number in a code example}
10436 .code-highlighted @r{for highlighting referenced code lines}
10437 div.outline-N @r{div for outline level N (headline plus text))}
10438 div.outline-text-N @r{extra div for text at outline level N}
10439 .section-number-N @r{section number in headlines, different for each level}
10440 div.figure @r{how to format an inlined image}
10441 pre.src @r{formatted source code}
10442 pre.example @r{normal example}
10443 p.verse @r{verse paragraph}
10444 div.footnotes @r{footnote section headline}
10445 p.footnote @r{footnote definition paragraph, containing a footnote}
10446 .footref @r{a footnote reference number (always a <sup>)}
10447 .footnum @r{footnote number in footnote definition (always <sup>)}
10450 @vindex org-export-html-style-default
10451 @vindex org-export-html-style-include-default
10452 @vindex org-export-html-style
10453 @vindex org-export-html-extra
10454 @vindex org-export-html-style-default
10455 Each exported file contains a compact default style that defines these
10456 classes in a basic way@footnote{This style is defined in the constant
10457 @code{org-export-html-style-default}, which you should not modify. To turn
10458 inclusion of these defaults off, customize
10459 @code{org-export-html-style-include-default}}. You may overwrite these
10460 settings, or add to them by using the variables @code{org-export-html-style}
10461 (for Org-wide settings) and @code{org-export-html-style-extra} (for more
10462 fine-grained settings, like file-local settings). To set the latter variable
10463 individually for each file, you can use
10467 #+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
10471 For longer style definitions, you can use several such lines. You could also
10472 directly write a @code{<style>} @code{</style>} section in this way, without
10473 referring to an external file.
10475 In order to add styles to a subtree, use the @code{:HTML_CONTAINER_CLASS:}
10476 property to assign a class to the tree. In order to specify CSS styles for a
10477 particular headline, you can use the id specified in a @code{:CUSTOM_ID:}
10480 @c FIXME: More about header and footer styles
10481 @c FIXME: Talk about links and targets.
10483 @node JavaScript support, , CSS support, HTML export
10484 @subsection JavaScript supported display of web pages
10486 @cindex Rose, Sebastian
10487 Sebastian Rose has written a JavaScript program especially designed to
10488 enhance the web viewing experience of HTML files created with Org. This
10489 program allows you to view large files in two different ways. The first one
10490 is an @emph{Info}-like mode where each section is displayed separately and
10491 navigation can be done with the @kbd{n} and @kbd{p} keys (and some other keys
10492 as well, press @kbd{?} for an overview of the available keys). The second
10493 view type is a @emph{folding} view much like Org provides inside Emacs. The
10494 script is available at @url{http://orgmode.org/org-info.js} and you can find
10495 the documentation for it at @url{http://orgmode.org/worg/code/org-info-js/}.
10496 We host the script at our site, but if you use it a lot, you might
10497 not want to be dependent on @url{orgmode.org} and prefer to install a local
10498 copy on your own web server.
10500 To use the script, you need to make sure that the @file{org-jsinfo.el} module
10501 gets loaded. It should be loaded by default, but you can try @kbd{M-x
10502 customize-variable @key{RET} org-modules @key{RET}} to convince yourself that
10503 this is indeed the case. All it then takes to make use of the program is
10504 adding a single line to the Org file:
10506 @cindex #+INFOJS_OPT
10508 #+INFOJS_OPT: view:info toc:nil
10512 If this line is found, the HTML header will automatically contain the code
10513 needed to invoke the script. Using the line above, you can set the following
10517 path: @r{The path to the script. The default is to grab the script from}
10518 @r{@url{http://orgmode.org/org-info.js}, but you might want to have}
10519 @r{a local copy and use a path like @samp{../scripts/org-info.js}.}
10520 view: @r{Initial view when the website is first shown. Possible values are:}
10521 info @r{Info-like interface with one section per page.}
10522 overview @r{Folding interface, initially showing only top-level.}
10523 content @r{Folding interface, starting with all headlines visible.}
10524 showall @r{Folding interface, all headlines and text visible.}
10525 sdepth: @r{Maximum headline level that will still become an independent}
10526 @r{section for info and folding modes. The default is taken from}
10527 @r{@code{org-export-headline-levels} (= the @code{H} switch in @code{#+OPTIONS}).}
10528 @r{If this is smaller than in @code{org-export-headline-levels}, each}
10529 @r{info/folding section can still contain child headlines.}
10530 toc: @r{Should the table of contents @emph{initially} be visible?}
10531 @r{Even when @code{nil}, you can always get to the "toc" with @kbd{i}.}
10532 tdepth: @r{The depth of the table of contents. The defaults are taken from}
10533 @r{the variables @code{org-export-headline-levels} and @code{org-export-with-toc}.}
10534 ftoc: @r{Does the CSS of the page specify a fixed position for the "toc"?}
10535 @r{If yes, the toc will never be displayed as a section.}
10536 ltoc: @r{Should there be short contents (children) in each section?}
10537 @r{Make this @code{above} if the section should be above initial text.}
10538 mouse: @r{Headings are highlighted when the mouse is over them. Should be}
10539 @r{@samp{underline} (default) or a background color like @samp{#cccccc}.}
10540 buttons: @r{Should view-toggle buttons be everywhere? When @code{nil} (the}
10541 @r{default), only one such button will be present.}
10544 @vindex org-infojs-options
10545 @vindex org-export-html-use-infojs
10546 You can choose default values for these options by customizing the variable
10547 @code{org-infojs-options}. If you always want to apply the script to your
10548 pages, configure the variable @code{org-export-html-use-infojs}.
10550 @node @LaTeX{} and PDF export, DocBook export, HTML export, Exporting
10551 @section @LaTeX{} and PDF export
10552 @cindex @LaTeX{} export
10554 @cindex Guerry, Bastien
10556 Org mode contains a @LaTeX{} exporter written by Bastien Guerry. With
10557 further processing@footnote{The default @LaTeX{} output is designed for
10558 processing with @code{pdftex} or @LaTeX{}. It includes packages that are not
10559 compatible with @code{xetex} and possibly @code{luatex}. See the variables
10560 @code{org-export-latex-default-packages-alist} and
10561 @code{org-export-latex-packages-alist}.}, this backend is also used to
10562 produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to
10563 implement links and cross references, the PDF output file will be fully
10564 linked. Beware of the fact that your @code{org} file has to be properly
10565 structured in order to be correctly exported: respect the hierarchy of
10569 * @LaTeX{}/PDF export commands::
10570 * Header and sectioning:: Setting up the export file structure
10571 * Quoting @LaTeX{} code:: Incorporating literal @LaTeX{} code
10572 * Tables in @LaTeX{} export:: Options for exporting tables to @LaTeX{}
10573 * Images in @LaTeX{} export:: How to insert figures into @LaTeX{} output
10574 * Beamer class export:: Turning the file into a presentation
10577 @node @LaTeX{}/PDF export commands, Header and sectioning, @LaTeX{} and PDF export, @LaTeX{} and PDF export
10578 @subsection @LaTeX{} export commands
10580 @cindex region, active
10581 @cindex active region
10582 @cindex transient-mark-mode
10584 @orgcmd{C-c C-e l,org-export-as-latex}
10585 @cindex property EXPORT_FILE_NAME
10586 Export as a @LaTeX{} file. For an Org file
10587 @file{myfile.org}, the @LaTeX{} file will be @file{myfile.tex}. The file will
10588 be overwritten without warning. If there is an active region@footnote{This
10589 requires @code{transient-mark-mode} be turned on.}, only the region will be
10590 exported. If the selected region is a single tree@footnote{To select the
10591 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10592 title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
10593 property, that name will be used for the export.
10594 @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
10595 Export to a temporary buffer. Do not create a file.
10596 @item C-c C-e v l/L
10597 Export only the visible part of the document.
10598 @item M-x org-export-region-as-latex
10599 Convert the region to @LaTeX{} under the assumption that it was in Org mode
10600 syntax before. This is a global command that can be invoked in any
10602 @item M-x org-replace-region-by-latex
10603 Replace the active region (assumed to be in Org mode syntax) by @LaTeX{}
10605 @orgcmd{C-c C-e p,org-export-as-pdf}
10606 Export as @LaTeX{} and then process to PDF.
10607 @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
10608 Export as @LaTeX{} and then process to PDF, then open the resulting PDF file.
10611 @cindex headline levels, for exporting
10612 @vindex org-latex-low-levels
10613 In the exported version, the first 3 outline levels will become
10614 headlines, defining a general document structure. Additional levels
10615 will be exported as description lists. The exporter can ignore them or
10616 convert them to a custom string depending on
10617 @code{org-latex-low-levels}.
10619 If you want that transition to occur at a different level, specify it
10620 with a numeric prefix argument. For example,
10623 @kbd{C-2 C-c C-e l}
10627 creates two levels of headings and does the rest as items.
10629 @node Header and sectioning, Quoting @LaTeX{} code, @LaTeX{}/PDF export commands, @LaTeX{} and PDF export
10630 @subsection Header and sectioning structure
10631 @cindex @LaTeX{} class
10632 @cindex @LaTeX{} sectioning structure
10633 @cindex @LaTeX{} header
10634 @cindex header, for @LaTeX{} files
10635 @cindex sectioning structure, for @LaTeX{} export
10637 By default, the @LaTeX{} output uses the class @code{article}.
10639 @vindex org-export-latex-default-class
10640 @vindex org-export-latex-classes
10641 @vindex org-export-latex-default-packages-alist
10642 @vindex org-export-latex-packages-alist
10643 @cindex #+LaTeX_HEADER
10644 @cindex #+LaTeX_CLASS
10645 @cindex #+LaTeX_CLASS_OPTIONS
10646 @cindex property, LaTeX_CLASS
10647 @cindex property, LaTeX_CLASS_OPTIONS
10648 You can change this globally by setting a different value for
10649 @code{org-export-latex-default-class} or locally by adding an option like
10650 @code{#+LaTeX_CLASS: myclass} in your file, or with a @code{:LaTeX_CLASS:}
10651 property that applies when exporting a region containing only this (sub)tree.
10652 The class must be listed in @code{org-export-latex-classes}. This variable
10653 defines a header template for each class@footnote{Into which the values of
10654 @code{org-export-latex-default-packages-alist} and
10655 @code{org-export-latex-packages-alist} are spliced.}, and allows you to
10656 define the sectioning structure for each class. You can also define your own
10657 classes there. @code{#+LaTeX_CLASS_OPTIONS} or a @code{:LaTeX_CLASS_OPTIONS:}
10658 property can specify the options for the @code{\documentclass} macro. The
10659 options to documentclass have to be provided, as expected by @LaTeX{}, within
10660 square brackets. You can also use @code{#+LaTeX_HEADER: \usepackage@{xyz@}}
10661 to add lines to the header. See the docstring of
10662 @code{org-export-latex-classes} for more information. An example is shown
10666 #+LaTeX_CLASS: article
10667 #+LaTeX_CLASS_OPTIONS: [a4paper]
10668 #+LaTeX_HEADER: \usepackage@{xyz@}
10674 @node Quoting @LaTeX{} code, Tables in @LaTeX{} export, Header and sectioning, @LaTeX{} and PDF export
10675 @subsection Quoting @LaTeX{} code
10677 Embedded @LaTeX{} as described in @ref{Embedded @LaTeX{}}, will be correctly
10678 inserted into the @LaTeX{} file. This includes simple macros like
10679 @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore,
10680 you can add special code that should only be present in @LaTeX{} export with
10681 the following constructs:
10684 @cindex #+BEGIN_LaTeX
10686 #+LaTeX: Literal @LaTeX{} code for export
10690 @cindex #+BEGIN_LaTeX
10694 All lines between these markers are exported literally
10699 @node Tables in @LaTeX{} export, Images in @LaTeX{} export, Quoting @LaTeX{} code, @LaTeX{} and PDF export
10700 @subsection Tables in @LaTeX{} export
10701 @cindex tables, in @LaTeX{} export
10703 For @LaTeX{} export of a table, you can specify a label, a caption and
10704 placement options (@pxref{Images and tables}). You can also use the
10705 @code{ATTR_LaTeX} line to request a @code{longtable} environment for the
10706 table, so that it may span several pages, or to change the default table
10707 environment from @code{table} to @code{table*} or to change the default inner
10708 tabular environment to @code{tabularx} or @code{tabulary}. Finally, you can
10709 set the alignment string, and (with @code{tabularx} or @code{tabulary}) the
10714 @cindex #+ATTR_LaTeX
10716 #+CAPTION: A long table
10718 #+ATTR_LaTeX: longtable align=l|lp@{3cm@}r|l
10723 or to specify a multicolumn table with @code{tabulary}
10727 @cindex #+ATTR_LaTeX
10729 #+CAPTION: A wide table with tabulary
10731 #+ATTR_LaTeX: table* tabulary width=\textwidth
10736 @node Images in @LaTeX{} export, Beamer class export, Tables in @LaTeX{} export, @LaTeX{} and PDF export
10737 @subsection Images in @LaTeX{} export
10738 @cindex images, inline in @LaTeX{}
10739 @cindex inlining images in @LaTeX{}
10741 Images that are linked to without a description part in the link, like
10742 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF
10743 output file resulting from @LaTeX{} processing. Org will use an
10744 @code{\includegraphics} macro to insert the image. If you have specified a
10745 caption and/or a label as described in @ref{Images and tables}, the figure
10746 will be wrapped into a @code{figure} environment and thus become a floating
10747 element. You can use an @code{#+ATTR_LaTeX:} line to specify various other
10748 options. You can ask org to export an image as a float without specifying
10749 a label or a caption by using the keyword @code{float} in this line. Various
10750 optional arguments to the @code{\includegraphics} macro can also be specified
10751 in this fashion. To modify the placement option of the floating environment,
10752 add something like @samp{placement=[h!]} to the attributes. It is to be noted
10753 this option can be used with tables as well@footnote{One can also take
10754 advantage of this option to pass other, unrelated options into the figure or
10755 table environment. For an example see the section ``Exporting org files'' in
10756 @url{http://orgmode.org/worg/org-hacks.html}}.
10758 If you would like to let text flow around the image, add the word @samp{wrap}
10759 to the @code{#+ATTR_LaTeX:} line, which will make the figure occupy the left
10760 half of the page. To fine-tune, the @code{placement} field will be the set
10761 of additional arguments needed by the @code{wrapfigure} environment. Note
10762 that if you change the size of the image, you need to use compatible settings
10763 for @code{\includegraphics} and @code{wrapfigure}.
10767 @cindex #+ATTR_LaTeX
10769 #+CAPTION: The black-body emission of the disk around HR 4049
10770 #+LABEL: fig:SED-HR4049
10771 #+ATTR_LaTeX: width=5cm,angle=90
10772 [[./img/sed-hr4049.pdf]]
10774 #+ATTR_LaTeX: width=0.38\textwidth wrap placement=@{r@}@{0.4\textwidth@}
10778 If you wish to include an image which spans multiple columns in a page, you
10779 can use the keyword @code{multicolumn} in the @code{#+ATTR_LaTeX} line. This
10780 will export the image wrapped in a @code{figure*} environment.
10782 If you need references to a label created in this way, write
10783 @samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}.
10785 @node Beamer class export, , Images in @LaTeX{} export, @LaTeX{} and PDF export
10786 @subsection Beamer class export
10788 The @LaTeX{} class @file{beamer} allows production of high quality presentations
10789 using @LaTeX{} and pdf processing. Org mode has special support for turning an
10790 Org mode file or tree into a @file{beamer} presentation.
10792 When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS:
10793 beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is
10794 @code{beamer}, a special export mode will turn the file or tree into a beamer
10795 presentation. Any tree with not-too-deep level nesting should in principle be
10796 exportable as a beamer presentation. By default, the top-level entries (or
10797 the first level below the selected subtree heading) will be turned into
10798 frames, and the outline structure below this level will become itemize lists.
10799 You can also configure the variable @code{org-beamer-frame-level} to a
10800 different level---then the hierarchy above frames will produce the sectioning
10801 structure of the presentation.
10803 A template for useful in-buffer settings or properties can be inserted into
10804 the buffer with @kbd{M-x org-insert-beamer-options-template}. Among other
10805 things, this will install a column view format which is very handy for
10806 editing special properties used by beamer.
10808 You can influence the structure of the presentation using the following
10813 The environment that should be used to format this entry. Valid environments
10814 are defined in the constant @code{org-beamer-environments-default}, and you
10815 can define more in @code{org-beamer-environments-extra}. If this property is
10816 set, the entry will also get a @code{:B_environment:} tag to make this
10817 visible. This tag has no semantic meaning, it is only a visual aid.
10818 @item BEAMER_envargs
10819 The beamer-special arguments that should be used for the environment, like
10820 @code{[t]} or @code{[<+->]} of @code{<2-3>}. If the @code{BEAMER_col}
10821 property is also set, something like @code{C[t]} can be added here as well to
10822 set an options argument for the implied @code{columns} environment.
10823 @code{c[t]} or @code{c<2->} will set an options for the implied @code{column}
10826 The width of a column that should start with this entry. If this property is
10827 set, the entry will also get a @code{:BMCOL:} property to make this visible.
10828 Also this tag is only a visual aid. When this is a plain number, it will be
10829 interpreted as a fraction of @code{\textwidth}. Otherwise it will be assumed
10830 that you have specified the units, like @samp{3cm}. The first such property
10831 in a frame will start a @code{columns} environment to surround the columns.
10832 This environment is closed when an entry has a @code{BEAMER_col} property
10833 with value 0 or 1, or automatically at the end of the frame.
10835 Additional commands that should be inserted after the environment has been
10836 opened. For example, when creating a frame, this can be used to specify
10840 Frames will automatically receive a @code{fragile} option if they contain
10841 source code that uses the verbatim environment. Special @file{beamer}
10842 specific code can be inserted using @code{#+BEAMER:} and
10843 @code{#+BEGIN_BEAMER...#+END_BEAMER} constructs, similar to other export
10844 backends, but with the difference that @code{#+LaTeX:} stuff will be included
10845 in the presentation as well.
10847 Outline nodes with @code{BEAMER_env} property value @samp{note} or
10848 @samp{noteNH} will be formatted as beamer notes, i,e, they will be wrapped
10849 into @code{\note@{...@}}. The former will include the heading as part of the
10850 note text, the latter will ignore the heading of that node. To simplify note
10851 generation, it is actually enough to mark the note with a @emph{tag} (either
10852 @code{:B_note:} or @code{:B_noteNH:}) instead of creating the
10853 @code{BEAMER_env} property.
10855 You can turn on a special minor mode @code{org-beamer-mode} for editing
10863 @orgcmd{C-c C-b,org-beamer-select-environment}
10864 In @code{org-beamer-mode}, this key offers fast selection of a beamer
10865 environment or the @code{BEAMER_col} property.
10868 Column view provides a great way to set the environment of a node and other
10869 important parameters. Make sure you are using a COLUMN format that is geared
10870 toward this special purpose. The command @kbd{M-x
10871 org-insert-beamer-options-template} defines such a format.
10873 Here is a simple example Org document that is intended for beamer export.
10876 #+LaTeX_CLASS: beamer
10877 #+TITLE: Example Presentation
10878 #+AUTHOR: Carsten Dominik
10879 #+LaTeX_CLASS_OPTIONS: [presentation]
10880 #+BEAMER_FRAME_LEVEL: 2
10881 #+BEAMER_HEADER_EXTRA: \usetheme@{Madrid@}\usecolortheme@{default@}
10882 #+COLUMNS: %35ITEM %10BEAMER_env(Env) %10BEAMER_envargs(Args) %4BEAMER_col(Col) %8BEAMER_extra(Ex)
10884 * This is the first structural section
10886 ** Frame 1 \\ with a subtitle
10887 *** Thanks to Eric Fraga :BMCOL:B_block:
10890 :BEAMER_envargs: C[t]
10893 for the first viable beamer setup in Org
10894 *** Thanks to everyone else :BMCOL:B_block:
10898 :BEAMER_envargs: <2->
10900 for contributing to the discussion
10901 **** This will be formatted as a beamer note :B_note:
10902 ** Frame 2 \\ where we will not use columns
10903 *** Request :B_block:
10904 Please test this stuff!
10910 For more information, see the documentation on Worg.
10912 @node DocBook export, OpenDocument Text export, @LaTeX{} and PDF export, Exporting
10913 @section DocBook export
10914 @cindex DocBook export
10916 @cindex Cui, Baoqiu
10918 Org contains a DocBook exporter written by Baoqiu Cui. Once an Org file is
10919 exported to DocBook format, it can be further processed to produce other
10920 formats, including PDF, HTML, man pages, etc., using many available DocBook
10921 tools and stylesheets.
10923 Currently DocBook exporter only supports DocBook V5.0.
10926 * DocBook export commands:: How to invoke DocBook export
10927 * Quoting DocBook code:: Incorporating DocBook code in Org files
10928 * Recursive sections:: Recursive sections in DocBook
10929 * Tables in DocBook export:: Tables are exported as HTML tables
10930 * Images in DocBook export:: How to insert figures into DocBook output
10931 * Special characters:: How to handle special characters
10934 @node DocBook export commands, Quoting DocBook code, DocBook export, DocBook export
10935 @subsection DocBook export commands
10937 @cindex region, active
10938 @cindex active region
10939 @cindex transient-mark-mode
10941 @orgcmd{C-c C-e D,org-export-as-docbook}
10942 @cindex property EXPORT_FILE_NAME
10943 Export as a DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
10944 file will be @file{myfile.xml}. The file will be overwritten without
10945 warning. If there is an active region@footnote{This requires
10946 @code{transient-mark-mode} to be turned on}, only the region will be
10947 exported. If the selected region is a single tree@footnote{To select the
10948 current subtree, use @kbd{C-c @@}.}, the tree head will become the document
10949 title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
10950 property, that name will be used for the export.
10951 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
10952 Export as a DocBook file, process to PDF, then open the resulting PDF file.
10954 @vindex org-export-docbook-xslt-proc-command
10955 @vindex org-export-docbook-xsl-fo-proc-command
10956 Note that, in order to produce PDF output based on an exported DocBook file,
10957 you need to have XSLT processor and XSL-FO processor software installed on your
10958 system. Check variables @code{org-export-docbook-xslt-proc-command} and
10959 @code{org-export-docbook-xsl-fo-proc-command}.
10961 @vindex org-export-docbook-xslt-stylesheet
10962 The stylesheet argument @code{%s} in variable
10963 @code{org-export-docbook-xslt-proc-command} is replaced by the value of
10964 variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
10965 the user. You can also overrule this global setting on a per-file basis by
10966 adding an in-buffer setting @code{#+XSLT:} to the Org file.
10968 @orgkey{C-c C-e v D}
10969 Export only the visible part of the document.
10972 @node Quoting DocBook code, Recursive sections, DocBook export commands, DocBook export
10973 @subsection Quoting DocBook code
10975 You can quote DocBook code in Org files and copy it verbatim into exported
10976 DocBook file with the following constructs:
10979 @cindex #+BEGIN_DOCBOOK
10981 #+DOCBOOK: Literal DocBook code for export
10985 @cindex #+BEGIN_DOCBOOK
10989 All lines between these markers are exported by DocBook exporter
10994 For example, you can use the following lines to include a DocBook warning
10995 admonition. As to what this warning says, you should pay attention to the
10996 document context when quoting DocBook code in Org files. You may make
10997 exported DocBook XML files invalid by not quoting DocBook code correctly.
11002 <para>You should know what you are doing when quoting DocBook XML code
11003 in your Org file. Invalid DocBook XML may be generated by
11004 DocBook exporter if you are not careful!</para>
11009 @node Recursive sections, Tables in DocBook export, Quoting DocBook code, DocBook export
11010 @subsection Recursive sections
11011 @cindex DocBook recursive sections
11013 DocBook exporter exports Org files as articles using the @code{article}
11014 element in DocBook. Recursive sections, i.e., @code{section} elements, are
11015 used in exported articles. Top level headlines in Org files are exported as
11016 top level sections, and lower level headlines are exported as nested
11017 sections. The entire structure of Org files will be exported completely, no
11018 matter how many nested levels of headlines there are.
11020 Using recursive sections makes it easy to port and reuse exported DocBook
11021 code in other DocBook document types like @code{book} or @code{set}.
11023 @node Tables in DocBook export, Images in DocBook export, Recursive sections, DocBook export
11024 @subsection Tables in DocBook export
11025 @cindex tables, in DocBook export
11027 Tables in Org files are exported as HTML tables, which have been supported since
11030 If a table does not have a caption, an informal table is generated using the
11031 @code{informaltable} element; otherwise, a formal table will be generated
11032 using the @code{table} element.
11034 @node Images in DocBook export, Special characters, Tables in DocBook export, DocBook export
11035 @subsection Images in DocBook export
11036 @cindex images, inline in DocBook
11037 @cindex inlining images in DocBook
11039 Images that are linked to without a description part in the link, like
11040 @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]}, will be exported to DocBook
11041 using @code{mediaobject} elements. Each @code{mediaobject} element contains
11042 an @code{imageobject} that wraps an @code{imagedata} element. If you have
11043 specified a caption for an image as described in @ref{Images and tables}, a
11044 @code{caption} element will be added in @code{mediaobject}. If a label is
11045 also specified, it will be exported as an @code{xml:id} attribute of the
11046 @code{mediaobject} element.
11048 @vindex org-export-docbook-default-image-attributes
11049 Image attributes supported by the @code{imagedata} element, like @code{align}
11050 or @code{width}, can be specified in two ways: you can either customize
11051 variable @code{org-export-docbook-default-image-attributes} or use the
11052 @code{#+ATTR_DOCBOOK:} line. Attributes specified in variable
11053 @code{org-export-docbook-default-image-attributes} are applied to all inline
11054 images in the Org file to be exported (unless they are overridden by image
11055 attributes specified in @code{#+ATTR_DOCBOOK:} lines).
11057 The @code{#+ATTR_DOCBOOK:} line can be used to specify additional image
11058 attributes or override default image attributes for individual images. If
11059 the same attribute appears in both the @code{#+ATTR_DOCBOOK:} line and
11060 variable @code{org-export-docbook-default-image-attributes}, the former
11061 takes precedence. Here is an example about how image attributes can be
11066 @cindex #+ATTR_DOCBOOK
11068 #+CAPTION: The logo of Org mode
11069 #+LABEL: unicorn-svg
11070 #+ATTR_DOCBOOK: scalefit="1" width="100%" depth="100%"
11071 [[./img/org-mode-unicorn.svg]]
11074 @vindex org-export-docbook-inline-image-extensions
11075 By default, DocBook exporter recognizes the following image file types:
11076 @file{jpeg}, @file{jpg}, @file{png}, @file{gif}, and @file{svg}. You can
11077 customize variable @code{org-export-docbook-inline-image-extensions} to add
11078 more types to this list as long as DocBook supports them.
11080 @node Special characters, , Images in DocBook export, DocBook export
11081 @subsection Special characters in DocBook export
11082 @cindex Special characters in DocBook export
11084 @vindex org-export-docbook-doctype
11085 @vindex org-entities
11086 Special characters that are written in @TeX{}-like syntax, such as @code{\alpha},
11087 @code{\Gamma}, and @code{\Zeta}, are supported by DocBook exporter. These
11088 characters are rewritten to XML entities, like @code{α},
11089 @code{Γ}, and @code{Ζ}, based on the list saved in variable
11090 @code{org-entities}. As long as the generated DocBook file includes the
11091 corresponding entities, these special characters are recognized.
11093 You can customize variable @code{org-export-docbook-doctype} to include the
11094 entities you need. For example, you can set variable
11095 @code{org-export-docbook-doctype} to the following value to recognize all
11096 special characters included in XHTML entities:
11099 "<!DOCTYPE article [
11100 <!ENTITY % xhtml1-symbol PUBLIC
11101 \"-//W3C//ENTITIES Symbol for HTML//EN//XML\"
11102 \"http://www.w3.org/2003/entities/2007/xhtml1-symbol.ent\"
11109 @c begin opendocument
11111 @node OpenDocument Text export, TaskJuggler export, DocBook export, Exporting
11112 @section OpenDocument Text export
11113 @cindex K, Jambunathan
11115 @cindex OpenDocument
11116 @cindex export, OpenDocument
11117 @cindex LibreOffice
11119 @cindex org-modules
11121 Org Mode@footnote{Versions 7.8 or later} supports export to OpenDocument Text
11122 (ODT) format using the @file{org-odt.el} module. Documents created
11123 by this exporter use the @cite{OpenDocument-v1.2
11124 specification}@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11125 Open Document Format for Office Applications (OpenDocument) Version 1.2}} and
11126 are compatible with LibreOffice 3.4.
11129 * Pre-requisites for ODT export:: What packages ODT exporter relies on
11130 * ODT export commands:: How to invoke ODT export
11131 * Extending ODT export:: How to produce @samp{doc}, @samp{pdf} files
11132 * Applying custom styles:: How to apply custom styles to the output
11133 * Links in ODT export:: How links will be interpreted and formatted
11134 * Tables in ODT export:: How Tables are exported
11135 * Images in ODT export:: How to insert images
11136 * Math formatting in ODT export:: How @LaTeX{} fragments are formatted
11137 * Labels and captions in ODT export:: How captions are rendered
11138 * Literal examples in ODT export:: How source and example blocks are formatted
11139 * Advanced topics in ODT export:: Read this if you are a power user
11142 @node Pre-requisites for ODT export, ODT export commands, OpenDocument Text export, OpenDocument Text export
11143 @subsection Pre-requisites for ODT export
11145 The ODT exporter relies on the @file{zip} program to create the final
11146 output. Check the availability of this program before proceeding further.
11148 @node ODT export commands, Extending ODT export, Pre-requisites for ODT export, OpenDocument Text export
11149 @subsection ODT export commands
11151 @subsubheading Exporting to ODT
11152 @anchor{x-export-to-odt}
11154 @cindex region, active
11155 @cindex active region
11156 @cindex transient-mark-mode
11158 @orgcmd{C-c C-e o,org-export-as-odt}
11159 @cindex property EXPORT_FILE_NAME
11161 Export as OpenDocument Text file.
11163 @vindex org-export-odt-preferred-output-format
11164 If @code{org-export-odt-preferred-output-format} is specified, automatically
11165 convert the exported file to that format. @xref{x-export-to-other-formats, ,
11166 Automatically exporting to other formats}.
11168 For an Org file @file{myfile.org}, the ODT file will be
11169 @file{myfile.odt}. The file will be overwritten without warning. If there
11170 is an active region,@footnote{This requires @code{transient-mark-mode} to be
11171 turned on} only the region will be exported. If the selected region is a
11172 single tree,@footnote{To select the current subtree, use @kbd{C-c @@}} the
11173 tree head will become the document title. If the tree head entry has, or
11174 inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
11177 @orgcmd{C-c C-e O,org-export-as-odt-and-open}
11178 Export as an OpenDocument Text file and open the resulting file.
11180 @vindex org-export-odt-preferred-output-format
11181 If @code{org-export-odt-preferred-output-format} is specified, open the
11182 converted file instead. @xref{x-export-to-other-formats, , Automatically
11183 exporting to other formats}.
11186 @node Extending ODT export, Applying custom styles, ODT export commands, OpenDocument Text export
11187 @subsection Extending ODT export
11189 The ODT exporter can interface with a variety of document
11190 converters and supports popular converters out of the box. As a result, you
11191 can use it to export to formats like @samp{doc} or convert a document from
11192 one format (say @samp{csv}) to another format (say @samp{ods} or @samp{xls}).
11194 @cindex @file{unoconv}
11195 @cindex LibreOffice
11196 If you have a working installation of LibreOffice, a document converter is
11197 pre-configured for you and you can use it right away. If you would like to
11198 use @file{unoconv} as your preferred converter, customize the variable
11199 @code{org-export-odt-convert-process} to point to @code{unoconv}. You can
11200 also use your own favorite converter or tweak the default settings of the
11201 @file{LibreOffice} and @samp{unoconv} converters. @xref{Configuring a
11202 document converter}.
11204 @subsubsection Automatically exporting to other formats
11205 @anchor{x-export-to-other-formats}
11207 @vindex org-export-odt-preferred-output-format
11208 Very often, you will find yourself exporting to ODT format, only to
11209 immediately save the exported document to other formats like @samp{doc},
11210 @samp{docx}, @samp{rtf}, @samp{pdf} etc. In such cases, you can specify your
11211 preferred output format by customizing the variable
11212 @code{org-export-odt-preferred-output-format}. This way, the export commands
11213 (@pxref{x-export-to-odt,,Exporting to ODT}) can be extended to export to a
11214 format that is of immediate interest to you.
11216 @subsubsection Converting between document formats
11217 @anchor{x-convert-to-other-formats}
11219 There are many document converters in the wild which support conversion to
11220 and from various file formats, including, but not limited to the
11221 ODT format. LibreOffice converter, mentioned above, is one such
11222 converter. Once a converter is configured, you can interact with it using
11223 the following command.
11225 @vindex org-export-odt-convert
11228 @item M-x org-export-odt-convert
11229 Convert an existing document from one format to another. With a prefix
11230 argument, also open the newly produced file.
11233 @node Applying custom styles, Links in ODT export, Extending ODT export, OpenDocument Text export
11234 @subsection Applying custom styles
11235 @cindex styles, custom
11236 @cindex template, custom
11238 The ODT exporter ships with a set of OpenDocument styles
11239 (@pxref{Working with OpenDocument style files}) that ensure a well-formatted
11240 output. These factory styles, however, may not cater to your specific
11241 tastes. To customize the output, you can either modify the above styles
11242 files directly, or generate the required styles using an application like
11243 LibreOffice. The latter method is suitable for expert and non-expert
11244 users alike, and is described here.
11246 @subsubsection Applying custom styles: the easy way
11250 Create a sample @file{example.org} file with the below settings and export it
11254 #+OPTIONS: H:10 num:t
11258 Open the above @file{example.odt} using LibreOffice. Use the @file{Stylist}
11259 to locate the target styles---these typically have the @samp{Org} prefix---and
11260 modify those to your taste. Save the modified file either as an
11261 OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file.
11264 @cindex #+ODT_STYLES_FILE
11265 @vindex org-export-odt-styles-file
11266 Customize the variable @code{org-export-odt-styles-file} and point it to the
11267 newly created file. For additional configuration options
11268 @pxref{x-overriding-factory-styles,,Overriding factory styles}.
11270 If you would like to choose a style on a per-file basis, you can use the
11271 @code{#+ODT_STYLES_FILE} option. A typical setting will look like
11274 #+ODT_STYLES_FILE: "/path/to/example.ott"
11280 #+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png"))
11285 @subsubsection Using third-party styles and templates
11287 You can use third-party styles and templates for customizing your output.
11288 This will produce the desired output only if the template provides all
11289 style names that the @samp{ODT} exporter relies on. Unless this condition is
11290 met, the output is going to be less than satisfactory. So it is highly
11291 recommended that you only work with templates that are directly derived from
11292 the factory settings.
11294 @node Links in ODT export, Tables in ODT export, Applying custom styles, OpenDocument Text export
11295 @subsection Links in ODT export
11296 @cindex tables, in DocBook export
11298 ODT exporter creates native cross-references for internal links. It creates
11299 Internet-style links for all other links.
11301 A link with no description and destined to a regular (un-itemized) outline
11302 heading is replaced with a cross-reference and section number of the heading.
11304 A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced
11305 with a cross-reference and sequence number of the labeled entity.
11306 @xref{Labels and captions in ODT export}.
11308 @node Tables in ODT export, Images in ODT export, Links in ODT export, OpenDocument Text export
11309 @subsection Tables in ODT export
11310 @cindex tables, in DocBook export
11312 Export of native Org mode tables (@pxref{Tables}) and simple @file{table.el}
11313 tables is supported. However, export of complex @file{table.el} tables---tables
11314 that have column or row spans---is not supported. Such tables are
11315 stripped from the exported document.
11317 By default, a table is exported with top and bottom frames and with rules
11318 separating row and column groups (@pxref{Column groups}). Furthermore, all
11319 tables are typeset to occupy the same width. If the table specifies
11320 alignment and relative width for its columns (@pxref{Column width and
11321 alignment}) then these are honored on export.@footnote{The column widths are
11322 interpreted as weighted ratios with the default weight being 1}
11325 You can control the width of the table by specifying @code{:rel-width}
11326 property using an @code{#+ATTR_ODT} line.
11328 For example, consider the following table which makes use of all the rules
11332 #+ATTR_ODT: :rel-width 50
11333 | Area/Month | Jan | Feb | Mar | Sum |
11334 |---------------+-------+-------+-------+-------|
11336 | <l13> | <r5> | <r5> | <r5> | <r6> |
11337 | North America | 1 | 21 | 926 | 948 |
11338 | Middle East | 6 | 75 | 844 | 925 |
11339 | Asia Pacific | 9 | 27 | 790 | 826 |
11340 |---------------+-------+-------+-------+-------|
11341 | Sum | 16 | 123 | 2560 | 2699 |
11344 On export, the table will occupy 50% of text area. The columns will be sized
11345 (roughly) in the ratio of 13:5:5:5:6. The first column will be left-aligned
11346 and rest of the columns will be right-aligned. There will be vertical rules
11347 after separating the header and last columns from other columns. There will
11348 be horizontal rules separating the header and last rows from other rows.
11350 If you are not satisfied with the above formatting options, you can create
11351 custom table styles and associate them with a table using the
11352 @code{#+ATTR_ODT} line. @xref{Customizing tables in ODT export}.
11354 @node Images in ODT export, Math formatting in ODT export, Tables in ODT export, OpenDocument Text export
11355 @subsection Images in ODT export
11356 @cindex images, embedding in ODT
11357 @cindex embedding images in ODT
11359 @subsubheading Embedding images
11360 You can embed images within the exported document by providing a link to the
11361 desired image file with no link description. For example, to embed
11362 @samp{img.png} do either of the following:
11372 @subsubheading Embedding clickable images
11373 You can create clickable images by providing a link whose description is a
11374 link to an image file. For example, to embed a image
11375 @file{org-mode-unicorn.png} which when clicked jumps to
11376 @uref{http://Orgmode.org} website, do the following
11379 [[http://orgmode.org][./org-mode-unicorn.png]]
11382 @subsubheading Sizing and scaling of embedded images
11385 You can control the size and scale of the embedded images using the
11386 @code{#+ATTR_ODT} attribute.
11388 @cindex identify, ImageMagick
11389 @vindex org-export-odt-pixels-per-inch
11390 The exporter specifies the desired size of the image in the final document in
11391 units of centimeters. In order to scale the embedded images, the exporter
11392 queries for pixel dimensions of the images using one of a) ImageMagick's
11393 @file{identify} program or b) Emacs `create-image' and `image-size'
11394 APIs.@footnote{Use of @file{ImageMagick} is only desirable. However, if you
11395 routinely produce documents that have large images or you export your Org
11396 files that has images using a Emacs batch script, then the use of
11397 @file{ImageMagick} is mandatory.} The pixel dimensions are subsequently
11398 converted in to units of centimeters using
11399 @code{org-export-odt-pixels-per-inch}. The default value of this variable is
11400 set to @code{display-pixels-per-inch}. You can tweak this variable to
11401 achieve the best results.
11403 The examples below illustrate the various possibilities.
11406 @item Explicitly size the image
11407 To embed @file{img.png} as a 10 cm x 10 cm image, do the following:
11410 #+ATTR_ODT: :width 10 :height 10
11414 @item Scale the image
11415 To embed @file{img.png} at half its size, do the following:
11418 #+ATTR_ODT: :scale 0.5
11422 @item Scale the image to a specific width
11423 To embed @file{img.png} with a width of 10 cm while retaining the original
11424 height:width ratio, do the following:
11427 #+ATTR_ODT: :width 10
11431 @item Scale the image to a specific height
11432 To embed @file{img.png} with a height of 10 cm while retaining the original
11433 height:width ratio, do the following
11436 #+ATTR_ODT: :height 10
11441 @subsubheading Anchoring of images
11444 You can control the manner in which an image is anchored by setting the
11445 @code{:anchor} property of it's @code{#+ATTR_ODT} line. You can specify one
11446 of the the following three values for the @code{:anchor} property:
11447 @samp{"as-char"}, @samp{"paragraph"} and @samp{"page"}.
11449 To create an image that is anchored to a page, do the following:
11451 #+ATTR_ODT: :anchor "page"
11455 @node Math formatting in ODT export, Labels and captions in ODT export, Images in ODT export, OpenDocument Text export
11456 @subsection Math formatting in ODT export
11458 The ODT exporter has special support for handling math.
11461 * Working with @LaTeX{} math snippets:: How to embed @LaTeX{} math fragments
11462 * Working with MathML or OpenDocument formula files:: How to embed equations in native format
11465 @node Working with @LaTeX{} math snippets, Working with MathML or OpenDocument formula files, Math formatting in ODT export, Math formatting in ODT export
11466 @subsubsection Working with @LaTeX{} math snippets
11468 @LaTeX{} math snippets (@pxref{@LaTeX{} fragments}) can be embedded in the ODT
11469 document in one of the following ways:
11475 This option is activated on a per-file basis with
11481 With this option, @LaTeX{} fragments are first converted into MathML
11482 fragments using an external @LaTeX{}-to-MathML converter program. The
11483 resulting MathML fragments are then embedded as an OpenDocument Formula in
11484 the exported document.
11486 @vindex org-latex-to-mathml-convert-command
11487 @vindex org-latex-to-mathml-jar-file
11489 You can specify the @LaTeX{}-to-MathML converter by customizing the variables
11490 @code{org-latex-to-mathml-convert-command} and
11491 @code{org-latex-to-mathml-jar-file}.
11493 If you prefer to use @file{MathToWeb}@footnote{See
11494 @uref{http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl, MathToWeb}} as your
11495 converter, you can configure the above variables as shown below.
11498 (setq org-latex-to-mathml-convert-command
11499 "java -jar %j -unicode -force -df %o %I"
11500 org-latex-to-mathml-jar-file
11501 "/path/to/mathtoweb.jar")
11504 You can use the following commands to quickly verify the reliability of
11505 the @LaTeX{}-to-MathML converter.
11509 @item M-x org-export-as-odf
11510 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
11512 @item M-x org-export-as-odf-and-open
11513 Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
11514 and open the formula file with the system-registered application.
11520 This option is activated on a per-file basis with
11523 #+OPTIONS: LaTeX:dvipng
11526 With this option, @LaTeX{} fragments are processed into PNG images and the
11527 resulting images are embedded in the exported document. This method requires
11528 that the @file{dvipng} program be available on your system.
11531 @node Working with MathML or OpenDocument formula files, , Working with @LaTeX{} math snippets, Math formatting in ODT export
11532 @subsubsection Working with MathML or OpenDocument formula files
11534 For various reasons, you may find embedding @LaTeX{} math snippets in an
11535 ODT document less than reliable. In that case, you can embed a
11536 math equation by linking to its MathML (@file{.mml}) source or its
11537 OpenDocument formula (@file{.odf}) file as shown below:
11549 @node Labels and captions in ODT export, Literal examples in ODT export, Math formatting in ODT export, OpenDocument Text export
11550 @subsection Labels and captions in ODT export
11552 You can label and caption various category of objects---an inline image, a
11553 table, a @LaTeX{} fragment or a Math formula---using @code{#+LABEL} and
11554 @code{#+CAPTION} lines. @xref{Images and tables}. ODT exporter enumerates
11555 each labeled or captioned object of a given category separately. As a
11556 result, each such object is assigned a sequence number based on order of it's
11557 appearance in the Org file.
11559 In the exported document, a user-provided caption is augmented with the
11560 category and sequence number. Consider the following inline image in an Org
11564 #+CAPTION: Bell curve
11565 #+LABEL: fig:SED-HR4049
11569 It could be rendered as shown below in the exported document.
11572 Figure 2: Bell curve
11575 @vindex org-export-odt-category-strings
11576 You can modify the category component of the caption by customizing the
11577 variable @code{org-export-odt-category-strings}. For example, to tag all
11578 embedded images with the string @samp{Illustration} (instead of the default
11579 @samp{Figure}) use the following setting.
11582 (setq org-export-odt-category-strings
11583 '(("en" "Table" "Illustration" "Equation" "Equation")))
11586 With this, previous image will be captioned as below in the exported
11590 Illustration 2: Bell curve
11593 @node Literal examples in ODT export, Advanced topics in ODT export, Labels and captions in ODT export, OpenDocument Text export
11594 @subsection Literal examples in ODT export
11596 Export of literal examples (@pxref{Literal examples}) with full fontification
11597 is supported. Internally, the exporter relies on @file{htmlfontify.el} to
11598 generate all style definitions needed for a fancy listing.@footnote{Your
11599 @file{htmlfontify.el} library must at least be at Emacs 24.1 levels for
11600 fontification to be turned on.} The auto-generated styles have @samp{OrgSrc}
11601 as prefix and inherit their color from the faces used by Emacs
11602 @code{font-lock} library for the source language.
11604 @vindex org-export-odt-fontify-srcblocks
11605 If you prefer to use your own custom styles for fontification, you can do so
11606 by customizing the variable
11607 @code{org-export-odt-create-custom-styles-for-srcblocks}.
11609 @vindex org-export-odt-create-custom-styles-for-srcblocks
11610 You can turn off fontification of literal examples by customizing the
11611 variable @code{org-export-odt-fontify-srcblocks}.
11613 @node Advanced topics in ODT export, , Literal examples in ODT export, OpenDocument Text export
11614 @subsection Advanced topics in ODT export
11616 If you rely heavily on ODT export, you may want to exploit the full
11617 set of features that the exporter offers. This section describes features
11618 that would be of interest to power users.
11621 * Configuring a document converter:: How to register a document converter
11622 * Working with OpenDocument style files:: Explore the internals
11623 * Creating one-off styles:: How to produce custom highlighting etc
11624 * Customizing tables in ODT export:: How to define and use Table templates
11625 * Validating OpenDocument XML:: How to debug corrupt OpenDocument files
11628 @node Configuring a document converter, Working with OpenDocument style files, Advanced topics in ODT export, Advanced topics in ODT export
11629 @subsubsection Configuring a document converter
11631 @cindex doc, docx, rtf
11634 The ODT exporter can work with popular converters with little or no
11635 extra configuration from your side. @xref{Extending ODT export}.
11636 If you are using a converter that is not supported by default or if you would
11637 like to tweak the default converter settings, proceed as below.
11640 @item Register the converter
11642 @vindex org-export-odt-convert-processes
11643 Name your converter and add it to the list of known converters by customizing
11644 the variable @code{org-export-odt-convert-processes}. Also specify how the
11645 converter can be invoked via command-line to effect the conversion.
11647 @item Configure its capabilities
11649 @vindex org-export-odt-convert-capabilities
11650 @anchor{x-odt-converter-capabilities}
11651 Specify the set of formats the converter can handle by customizing the
11652 variable @code{org-export-odt-convert-capabilities}. Use the default value
11653 for this variable as a guide for configuring your converter. As suggested by
11654 the default setting, you can specify the full set of formats supported by the
11655 converter and not limit yourself to specifying formats that are related to
11656 just the OpenDocument Text format.
11658 @item Choose the converter
11660 @vindex org-export-odt-convert-process
11661 Select the newly added converter as the preferred one by customizing the
11662 variable @code{org-export-odt-convert-process}.
11665 @node Working with OpenDocument style files, Creating one-off styles, Configuring a document converter, Advanced topics in ODT export
11666 @subsubsection Working with OpenDocument style files
11667 @cindex styles, custom
11668 @cindex template, custom
11670 This section explores the internals of the ODT exporter and the
11671 means by which it produces styled documents. Read this section if you are
11672 interested in exploring the automatic and custom OpenDocument styles used by
11675 @anchor{x-factory-styles}
11676 @subsubheading Factory styles
11678 The ODT exporter relies on two files for generating its output.
11679 These files are bundled with the distribution under the directory pointed to
11680 by the variable @code{org-odt-styles-dir}. The two files are:
11683 @anchor{x-orgodtstyles-xml}
11685 @file{OrgOdtStyles.xml}
11687 This file contributes to the @file{styles.xml} file of the final @samp{ODT}
11688 document. This file gets modified for the following purposes:
11692 To control outline numbering based on user settings.
11695 To add styles generated by @file{htmlfontify.el} for fontification of code
11699 @anchor{x-orgodtcontenttemplate-xml}
11701 @file{OrgOdtContentTemplate.xml}
11703 This file contributes to the @file{content.xml} file of the final @samp{ODT}
11704 document. The contents of the Org outline are inserted between the
11705 @samp{<office:text>}@dots{}@samp{</office:text>} elements of this file.
11707 Apart from serving as a template file for the final @file{content.xml}, the
11708 file serves the following purposes:
11712 It contains automatic styles for formatting of tables which are referenced by
11716 It contains @samp{<text:sequence-decl>}@dots{}@samp{</text:sequence-decl>}
11717 elements that control how various entities---tables, images, equations,
11718 etc.---are numbered.
11722 @anchor{x-overriding-factory-styles}
11723 @subsubheading Overriding factory styles
11724 The following two variables control the location from which the ODT
11725 exporter picks up the custom styles and content template files. You can
11726 customize these variables to override the factory styles used by the
11730 @anchor{x-org-export-odt-styles-file}
11732 @code{org-export-odt-styles-file}
11734 Use this variable to specify the @file{styles.xml} that will be used in the
11735 final output. You can specify one of the following values:
11738 @item A @file{styles.xml} file
11740 Use this file instead of the default @file{styles.xml}
11742 @item A @file{.odt} or @file{.ott} file
11744 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11747 @item A @file{.odt} or @file{.ott} file and a subset of files contained within them
11749 Use the @file{styles.xml} contained in the specified OpenDocument Text or
11750 Template file. Additionally extract the specified member files and embed
11751 those within the final @samp{ODT} document.
11753 Use this option if the @file{styles.xml} file references additional files
11754 like header and footer images.
11758 Use the default @file{styles.xml}
11761 @anchor{x-org-export-odt-content-template-file}
11763 @code{org-export-odt-content-template-file}
11765 Use this variable to specify the blank @file{content.xml} that will be used
11766 in the final output.
11769 @node Creating one-off styles, Customizing tables in ODT export, Working with OpenDocument style files, Advanced topics in ODT export
11770 @subsubsection Creating one-off styles
11772 There are times when you would want one-off formatting in the exported
11773 document. You can achieve this by embedding raw OpenDocument XML in the Org
11774 file. The use of this feature is better illustrated with couple of examples.
11777 @item Embedding ODT tags as part of regular text
11779 You can include simple OpenDocument tags by prefixing them with
11780 @samp{@@}. For example, to highlight a region of text do the following:
11783 @@<text:span text:style-name="Highlight">This is a
11784 highlighted text@@</text:span>. But this is a
11788 @strong{Hint:} To see the above example in action, edit your
11789 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11790 custom @samp{Highlight} style as shown below.
11793 <style:style style:name="Highlight" style:family="text">
11794 <style:text-properties fo:background-color="#ff0000"/>
11798 @item Embedding a one-line OpenDocument XML
11800 You can add a simple OpenDocument one-liner using the @code{#+ODT:}
11801 directive. For example, to force a page break do the following:
11804 #+ODT: <text:p text:style-name="PageBreak"/>
11807 @strong{Hint:} To see the above example in action, edit your
11808 @file{styles.xml} (@pxref{x-orgodtstyles-xml,,Factory styles}) and add a
11809 custom @samp{PageBreak} style as shown below.
11812 <style:style style:name="PageBreak" style:family="paragraph"
11813 style:parent-style-name="Text_20_body">
11814 <style:paragraph-properties fo:break-before="page"/>
11818 @item Embedding a block of OpenDocument XML
11820 You can add a large block of OpenDocument XML using the
11821 @code{#+BEGIN_ODT}@dots{}@code{#+END_ODT} construct.
11823 For example, to create a one-off paragraph that uses bold text, do the
11828 <text:p text:style-name="Text_20_body_20_bold">
11829 This paragraph is specially formatted and uses bold text.
11836 @node Customizing tables in ODT export, Validating OpenDocument XML, Creating one-off styles, Advanced topics in ODT export
11837 @subsubsection Customizing tables in ODT export
11838 @cindex tables, in ODT export
11841 You can override the default formatting of the table by specifying a custom
11842 table style with the @code{#+ATTR_ODT} line. For a discussion on default
11843 formatting of tables @pxref{Tables in ODT export}.
11845 This feature closely mimics the way table templates are defined in the
11847 specification.@footnote{@url{http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html,
11848 OpenDocument-v1.2 Specification}}
11852 @subsubheading Custom table styles: an illustration
11854 To have a quick preview of this feature, install the below setting and export
11855 the table that follows.
11858 (setq org-export-odt-table-styles
11859 (append org-export-odt-table-styles
11860 '(("TableWithHeaderRowAndColumn" "Custom"
11861 ((use-first-row-styles . t)
11862 (use-first-column-styles . t)))
11863 ("TableWithFirstRowandLastRow" "Custom"
11864 ((use-first-row-styles . t)
11865 (use-last-row-styles . t))))))
11869 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
11870 | Name | Phone | Age |
11871 | Peter | 1234 | 17 |
11872 | Anna | 4321 | 25 |
11875 In the above example, you used a template named @samp{Custom} and installed
11876 two table styles with the names @samp{TableWithHeaderRowAndColumn} and
11877 @samp{TableWithFirstRowandLastRow}. (@strong{Important:} The OpenDocument
11878 styles needed for producing the above template have been pre-defined for you.
11879 These styles are available under the section marked @samp{Custom Table
11880 Template} in @file{OrgOdtContentTemplate.xml}
11881 (@pxref{x-orgodtcontenttemplate-xml,,Factory styles}). If you need
11882 additional templates you have to define these styles yourselves.
11884 @subsubheading Custom table styles: the nitty-gritty
11885 To use this feature proceed as follows:
11889 Create a table template@footnote{See the @code{<table:table-template>}
11890 element of the OpenDocument-v1.2 specification}
11892 A table template is nothing but a set of @samp{table-cell} and
11893 @samp{paragraph} styles for each of the following table cell categories:
11907 The names for the above styles must be chosen based on the name of the table
11908 template using a well-defined convention.
11910 The naming convention is better illustrated with an example. For a table
11911 template with the name @samp{Custom}, the needed style names are listed in
11912 the following table.
11914 @multitable {Table cell type} {CustomEvenColumnTableCell} {CustomEvenColumnTableParagraph}
11915 @headitem Table cell type
11916 @tab @code{table-cell} style
11917 @tab @code{paragraph} style
11922 @tab @samp{CustomTableCell}
11923 @tab @samp{CustomTableParagraph}
11925 @tab @samp{CustomFirstColumnTableCell}
11926 @tab @samp{CustomFirstColumnTableParagraph}
11928 @tab @samp{CustomLastColumnTableCell}
11929 @tab @samp{CustomLastColumnTableParagraph}
11931 @tab @samp{CustomFirstRowTableCell}
11932 @tab @samp{CustomFirstRowTableParagraph}
11934 @tab @samp{CustomLastRowTableCell}
11935 @tab @samp{CustomLastRowTableParagraph}
11937 @tab @samp{CustomEvenRowTableCell}
11938 @tab @samp{CustomEvenRowTableParagraph}
11940 @tab @samp{CustomOddRowTableCell}
11941 @tab @samp{CustomOddRowTableParagraph}
11943 @tab @samp{CustomEvenColumnTableCell}
11944 @tab @samp{CustomEvenColumnTableParagraph}
11946 @tab @samp{CustomOddColumnTableCell}
11947 @tab @samp{CustomOddColumnTableParagraph}
11950 To create a table template with the name @samp{Custom}, define the above
11952 @code{<office:automatic-styles>}...@code{</office:automatic-styles>} element
11953 of the content template file (@pxref{x-orgodtcontenttemplate-xml,,Factory
11957 Define a table style@footnote{See the attributes @code{table:template-name},
11958 @code{table:use-first-row-styles}, @code{table:use-last-row-styles},
11959 @code{table:use-first-column-styles}, @code{table:use-last-column-styles},
11960 @code{table:use-banding-rows-styles}, and
11961 @code{table:use-banding-column-styles} of the @code{<table:table>} element in
11962 the OpenDocument-v1.2 specification}
11964 @vindex org-export-odt-table-styles
11965 To define a table style, create an entry for the style in the variable
11966 @code{org-export-odt-table-styles} and specify the following:
11969 @item the name of the table template created in step (1)
11970 @item the set of cell styles in that template that are to be activated
11973 For example, the entry below defines two different table styles
11974 @samp{TableWithHeaderRowAndColumn} and @samp{TableWithFirstRowandLastRow}
11975 based on the same template @samp{Custom}. The styles achieve their intended
11976 effect by selectively activating the individual cell styles in that template.
11979 (setq org-export-odt-table-styles
11980 (append org-export-odt-table-styles
11981 '(("TableWithHeaderRowAndColumn" "Custom"
11982 ((use-first-row-styles . t)
11983 (use-first-column-styles . t)))
11984 ("TableWithFirstRowandLastRow" "Custom"
11985 ((use-first-row-styles . t)
11986 (use-last-row-styles . t))))))
11990 Associate a table with the table style
11992 To do this, specify the table style created in step (2) as part of
11993 the @code{ATTR_ODT} line as shown below.
11996 #+ATTR_ODT: :style "TableWithHeaderRowAndColumn"
11997 | Name | Phone | Age |
11998 | Peter | 1234 | 17 |
11999 | Anna | 4321 | 25 |
12003 @node Validating OpenDocument XML, , Customizing tables in ODT export, Advanced topics in ODT export
12004 @subsubsection Validating OpenDocument XML
12006 Occasionally, you will discover that the document created by the
12007 ODT exporter cannot be opened by your favorite application. One of
12008 the common reasons for this is that the @file{.odt} file is corrupt. In such
12009 cases, you may want to validate the document against the OpenDocument RELAX
12010 NG Compact Syntax (RNC) schema.
12012 For de-compressing the @file{.odt} file@footnote{@file{.odt} files are
12013 nothing but @samp{zip} archives}: @inforef{File Archives,,emacs}. For
12014 general help with validation (and schema-sensitive editing) of XML files:
12015 @inforef{Introduction,,nxml-mode}.
12017 @vindex org-export-odt-schema-dir
12018 If you have ready access to OpenDocument @file{.rnc} files and the needed
12019 schema-locating rules in a single folder, you can customize the variable
12020 @code{org-export-odt-schema-dir} to point to that directory. The
12021 ODT exporter will take care of updating the
12022 @code{rng-schema-locating-files} for you.
12024 @c end opendocument
12026 @node TaskJuggler export, Freemind export, OpenDocument Text export, Exporting
12027 @section TaskJuggler export
12028 @cindex TaskJuggler export
12029 @cindex Project management
12031 @uref{http://www.taskjuggler.org/, TaskJuggler} is a project management tool.
12032 It provides an optimizing scheduler that computes your project time lines and
12033 resource assignments based on the project outline and the constraints that
12036 The TaskJuggler exporter is a bit different from other exporters, such as the
12037 @code{HTML} and @LaTeX{} exporters for example, in that it does not export all the
12038 nodes of a document or strictly follow the order of the nodes in the
12041 Instead the TaskJuggler exporter looks for a tree that defines the tasks and
12042 optionally trees that define the resources and reports for this project.
12043 It then creates a TaskJuggler file based on these trees and the attributes
12044 defined in all the nodes.
12046 @subsection TaskJuggler export commands
12049 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
12050 Export as a TaskJuggler file.
12052 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
12053 Export as a TaskJuggler file and then open the file with TaskJugglerUI (only
12054 for TaskJugglerUI 2.x).
12059 @vindex org-export-taskjuggler-project-tag
12060 Create your tasks as you usually do with Org mode. Assign efforts to each
12061 task using properties (it is easiest to do this in the column view). You
12062 should end up with something similar to the example by Peter Jones in
12063 @url{http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org}.
12064 Now mark the top node of your tasks with a tag named
12065 @code{:taskjuggler_project:} (or whatever you customized
12066 @code{org-export-taskjuggler-project-tag} to). You are now ready to export
12067 the project plan with @kbd{C-c C-e J} which will export the project plan and
12068 open a gantt chart in TaskJugglerUI.
12070 @subsection Resources
12072 @vindex org-export-taskjuggler-resource-tag
12073 Next you can define resources and assign those to work on specific tasks. You
12074 can group your resources hierarchically. Tag the top node of the resources
12075 with @code{:taskjuggler_resource:} (or whatever you customized
12076 @code{org-export-taskjuggler-resource-tag} to). You can optionally assign an
12077 identifier (named @samp{resource_id}) to the resources (using the standard
12078 Org properties commands, @pxref{Property syntax}) or you can let the exporter
12079 generate identifiers automatically (the exporter picks the first word of the
12080 headline as the identifier as long as it is unique---see the documentation of
12081 @code{org-taskjuggler-get-unique-id}). Using that identifier you can then
12082 allocate resources to tasks. This is again done with the @samp{allocate}
12083 property on the tasks. Do this in column view or when on the task type
12084 @kbd{C-c C-x p allocate @key{RET} <resource_id> @key{RET}}.
12086 Once the allocations are done you can again export to TaskJuggler and check
12087 in the Resource Allocation Graph which person is working on what task at what
12090 @subsection Export of properties
12092 The exporter also takes TODO state information into consideration, i.e., if
12093 a task is marked as done it will have the corresponding attribute in
12094 TaskJuggler (@samp{complete 100}). Scheduling information is also taken into
12095 account to set start/end dates for tasks.
12097 The exporter will also export any property on a task resource or resource
12098 node which is known to TaskJuggler, such as @samp{limits}, @samp{vacation},
12099 @samp{shift}, @samp{booking}, @samp{efficiency}, @samp{journalentry},
12100 @samp{rate} for resources or @samp{account}, @samp{start}, @samp{note},
12101 @samp{duration}, @samp{end}, @samp{journalentry}, @samp{milestone},
12102 @samp{reference}, @samp{responsible}, @samp{scheduling}, etc for tasks.
12104 @subsection Dependencies
12106 The exporter will handle dependencies that are defined in the tasks either
12107 with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the
12108 @samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a
12109 @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends}
12110 attribute can be either @samp{previous-sibling} or a reference to an
12111 identifier (named @samp{task_id}) which is defined for another task in the
12112 project. @samp{BLOCKER} and the @samp{depends} attribute can define multiple
12113 dependencies separated by either space or comma. You can also specify
12114 optional attributes on the dependency by simply appending it. The following
12115 examples should illustrate this:
12120 :task_id: preparation
12123 * Training material
12125 :task_id: training_material
12128 ** Markup Guidelines
12132 ** Workflow Guidelines
12139 :BLOCKER: training_material @{ gapduration 1d @} preparation
12143 @subsection Reports
12145 @vindex org-export-taskjuggler-default-reports
12146 TaskJuggler can produce many kinds of reports (e.g., gantt chart, resource
12147 allocation, etc). The user defines what kind of reports should be generated
12148 for a project in the TaskJuggler file. By default, the exporter will
12149 automatically insert some pre-set reports in the file. These defaults are
12150 defined in @code{org-export-taskjuggler-default-reports}. They can be
12151 modified using customize along with a number of other options. For a more
12152 complete list, see @kbd{M-x customize-group @key{RET} org-export-taskjuggler
12155 Alternately, the user can tag a tree with
12156 @code{org-export-taskjuggler-report-tag}, and define reports in sub-nodes,
12157 similarly to what is done with tasks or resources. The properties used for
12158 report generation are defined in
12159 @code{org-export-taskjuggler-valid-report-attributes}. In addition, a special
12160 property named @samp{report-kind} is used to define the kind of report one
12161 wants to generate (by default, a @samp{taskreport}).
12163 For more information and examples see the Org-taskjuggler tutorial at
12164 @uref{http://orgmode.org/worg/org-tutorials/org-taskjuggler.html}.
12166 @node Freemind export, XOXO export, TaskJuggler export, Exporting
12167 @section Freemind export
12168 @cindex Freemind export
12171 The Freemind exporter was written by Lennart Borgman.
12174 @orgcmd{C-c C-e m,org-export-as-freemind}
12175 Export as a Freemind mind map. For an Org file @file{myfile.org}, the Freemind
12176 file will be @file{myfile.mm}.
12179 @node XOXO export, iCalendar export, Freemind export, Exporting
12180 @section XOXO export
12181 @cindex XOXO export
12183 Org mode contains an exporter that produces XOXO-style output.
12184 Currently, this exporter only handles the general outline structure and
12185 does not interpret any additional Org mode features.
12188 @orgcmd{C-c C-e x,org-export-as-xoxo}
12189 Export as an XOXO file. For an Org file @file{myfile.org}, the XOXO file will be
12190 @file{myfile.html}.
12191 @orgkey{C-c C-e v x}
12192 Export only the visible part of the document.
12195 @node iCalendar export, , XOXO export, Exporting
12196 @section iCalendar export
12197 @cindex iCalendar export
12199 @vindex org-icalendar-include-todo
12200 @vindex org-icalendar-use-deadline
12201 @vindex org-icalendar-use-scheduled
12202 @vindex org-icalendar-categories
12203 @vindex org-icalendar-alarm-time
12204 Some people use Org mode for keeping track of projects, but still prefer a
12205 standard calendar application for anniversaries and appointments. In this
12206 case it can be useful to show deadlines and other time-stamped items in Org
12207 files in the calendar application. Org mode can export calendar information
12208 in the standard iCalendar format. If you also want to have TODO entries
12209 included in the export, configure the variable
12210 @code{org-icalendar-include-todo}. Plain timestamps are exported as VEVENT,
12211 and TODO items as VTODO@. It will also create events from deadlines that are
12212 in non-TODO items. Deadlines and scheduling dates in TODO items will be used
12213 to set the start and due dates for the TODO entry@footnote{See the variables
12214 @code{org-icalendar-use-deadline} and @code{org-icalendar-use-scheduled}.}.
12215 As categories, it will use the tags locally defined in the heading, and the
12216 file/tree category@footnote{To add inherited tags or the TODO state,
12217 configure the variable @code{org-icalendar-categories}.}. See the variable
12218 @code{org-icalendar-alarm-time} for a way to assign alarms to entries with a
12221 @vindex org-icalendar-store-UID
12222 @cindex property, ID
12223 The iCalendar standard requires each entry to have a globally unique
12224 identifier (UID). Org creates these identifiers during export. If you set
12225 the variable @code{org-icalendar-store-UID}, the UID will be stored in the
12226 @code{:ID:} property of the entry and re-used next time you report this
12227 entry. Since a single entry can give rise to multiple iCalendar entries (as
12228 a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds
12229 prefixes to the UID, depending on what triggered the inclusion of the entry.
12230 In this way the UID remains unique, but a synchronization program can still
12231 figure out from which entry all the different instances originate.
12234 @orgcmd{C-c C-e i,org-export-icalendar-this-file}
12235 Create iCalendar entries for the current file and store them in the same
12236 directory, using a file extension @file{.ics}.
12237 @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
12238 @vindex org-agenda-files
12239 Like @kbd{C-c C-e i}, but do this for all files in
12240 @code{org-agenda-files}. For each of these files, a separate iCalendar
12241 file will be written.
12242 @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
12243 @vindex org-combined-agenda-icalendar-file
12244 Create a single large iCalendar file from all files in
12245 @code{org-agenda-files} and write it to the file given by
12246 @code{org-combined-agenda-icalendar-file}.
12249 @vindex org-use-property-inheritance
12250 @vindex org-icalendar-include-body
12251 @cindex property, SUMMARY
12252 @cindex property, DESCRIPTION
12253 @cindex property, LOCATION
12254 The export will honor SUMMARY, DESCRIPTION and LOCATION@footnote{The LOCATION
12255 property can be inherited from higher in the hierarchy if you configure
12256 @code{org-use-property-inheritance} accordingly.} properties if the selected
12257 entries have them. If not, the summary will be derived from the headline,
12258 and the description from the body (limited to
12259 @code{org-icalendar-include-body} characters).
12261 How this calendar is best read and updated, depends on the application
12262 you are using. The FAQ covers this issue.
12264 @node Publishing, Working With Source Code, Exporting, Top
12265 @chapter Publishing
12268 Org includes a publishing management system that allows you to configure
12269 automatic HTML conversion of @emph{projects} composed of interlinked org
12270 files. You can also configure Org to automatically upload your exported HTML
12271 pages and related attachments, such as images and source code files, to a web
12274 You can also use Org to convert files into PDF, or even combine HTML and PDF
12275 conversion so that files are available in both formats on the server.
12277 Publishing has been contributed to Org by David O'Toole.
12280 * Configuration:: Defining projects
12281 * Uploading files:: How to get files up on the server
12282 * Sample configuration:: Example projects
12283 * Triggering publication:: Publication commands
12286 @node Configuration, Uploading files, Publishing, Publishing
12287 @section Configuration
12289 Publishing needs significant configuration to specify files, destination
12290 and many other properties of a project.
12293 * Project alist:: The central configuration variable
12294 * Sources and destinations:: From here to there
12295 * Selecting files:: What files are part of the project?
12296 * Publishing action:: Setting the function doing the publishing
12297 * Publishing options:: Tweaking HTML/@LaTeX{} export
12298 * Publishing links:: Which links keep working after publishing?
12299 * Sitemap:: Generating a list of all pages
12300 * Generating an index:: An index that reaches across pages
12303 @node Project alist, Sources and destinations, Configuration, Configuration
12304 @subsection The variable @code{org-publish-project-alist}
12305 @cindex org-publish-project-alist
12306 @cindex projects, for publishing
12308 @vindex org-publish-project-alist
12309 Publishing is configured almost entirely through setting the value of one
12310 variable, called @code{org-publish-project-alist}. Each element of the list
12311 configures one project, and may be in one of the two following forms:
12314 ("project-name" :property value :property value ...)
12315 @r{i.e., a well-formed property list with alternating keys and values}
12317 ("project-name" :components ("project-name" "project-name" ...))
12321 In both cases, projects are configured by specifying property values. A
12322 project defines the set of files that will be published, as well as the
12323 publishing configuration to use when publishing those files. When a project
12324 takes the second form listed above, the individual members of the
12325 @code{:components} property are taken to be sub-projects, which group
12326 together files requiring different publishing options. When you publish such
12327 a ``meta-project'', all the components will also be published, in the
12330 @node Sources and destinations, Selecting files, Project alist, Configuration
12331 @subsection Sources and destinations for files
12332 @cindex directories, for publishing
12334 Most properties are optional, but some should always be set. In
12335 particular, Org needs to know where to look for source files,
12336 and where to put published files.
12338 @multitable @columnfractions 0.3 0.7
12339 @item @code{:base-directory}
12340 @tab Directory containing publishing source files
12341 @item @code{:publishing-directory}
12342 @tab Directory where output files will be published. You can directly
12343 publish to a webserver using a file name syntax appropriate for
12344 the Emacs @file{tramp} package. Or you can publish to a local directory and
12345 use external tools to upload your website (@pxref{Uploading files}).
12346 @item @code{:preparation-function}
12347 @tab Function or list of functions to be called before starting the
12348 publishing process, for example, to run @code{make} for updating files to be
12349 published. The project property list is scoped into this call as the
12350 variable @code{project-plist}.
12351 @item @code{:completion-function}
12352 @tab Function or list of functions called after finishing the publishing
12353 process, for example, to change permissions of the resulting files. The
12354 project property list is scoped into this call as the variable
12355 @code{project-plist}.
12359 @node Selecting files, Publishing action, Sources and destinations, Configuration
12360 @subsection Selecting files
12361 @cindex files, selecting for publishing
12363 By default, all files with extension @file{.org} in the base directory
12364 are considered part of the project. This can be modified by setting the
12366 @multitable @columnfractions 0.25 0.75
12367 @item @code{:base-extension}
12368 @tab Extension (without the dot!) of source files. This actually is a
12369 regular expression. Set this to the symbol @code{any} if you want to get all
12370 files in @code{:base-directory}, even without extension.
12372 @item @code{:exclude}
12373 @tab Regular expression to match file names that should not be
12374 published, even though they have been selected on the basis of their
12377 @item @code{:include}
12378 @tab List of files to be included regardless of @code{:base-extension}
12379 and @code{:exclude}.
12381 @item @code{:recursive}
12382 @tab Non-nil means, check base-directory recursively for files to publish.
12385 @node Publishing action, Publishing options, Selecting files, Configuration
12386 @subsection Publishing action
12387 @cindex action, for publishing
12389 Publishing means that a file is copied to the destination directory and
12390 possibly transformed in the process. The default transformation is to export
12391 Org files as HTML files, and this is done by the function
12392 @code{org-publish-org-to-html} which calls the HTML exporter (@pxref{HTML
12393 export}). But you also can publish your content as PDF files using
12394 @code{org-publish-org-to-pdf}, or as @code{ascii}, @code{latin1} or
12395 @code{utf8} encoded files using the corresponding functions. If you want to
12396 publish the Org file itself, but with @i{archived}, @i{commented}, and
12397 @i{tag-excluded} trees removed, use @code{org-publish-org-to-org} and set the
12398 parameters @code{:plain-source} and/or @code{:htmlized-source}. This will
12399 produce @file{file.org} and @file{file.org.html} in the publishing
12400 directory@footnote{@file{file-source.org} and @file{file-source.org.html} if
12401 source and publishing directories are equal. Note that with this kind of
12402 setup, you need to add @code{:exclude "-source\\.org"} to the project
12403 definition in @code{org-publish-project-alist} to prevent the published
12404 source files from being considered as new org files the next time the project
12405 is published.}. Other files like images only need to be copied to the
12406 publishing destination; for this you may use @code{org-publish-attachment}.
12407 For non-Org files, you always need to specify the publishing function:
12409 @multitable @columnfractions 0.3 0.7
12410 @item @code{:publishing-function}
12411 @tab Function executing the publication of a file. This may also be a
12412 list of functions, which will all be called in turn.
12413 @item @code{:plain-source}
12414 @tab Non-nil means, publish plain source.
12415 @item @code{:htmlized-source}
12416 @tab Non-nil means, publish htmlized source.
12419 The function must accept three arguments: a property list containing at least
12420 a @code{:publishing-directory} property, the name of the file to be
12421 published, and the path to the publishing directory of the output file. It
12422 should take the specified file, make the necessary transformation (if any)
12423 and place the result into the destination folder.
12425 @node Publishing options, Publishing links, Publishing action, Configuration
12426 @subsection Options for the HTML/@LaTeX{} exporters
12427 @cindex options, for publishing
12429 The property list can be used to set many export options for the HTML
12430 and @LaTeX{} exporters. In most cases, these properties correspond to user
12431 variables in Org. The table below lists these properties along
12432 with the variable they belong to. See the documentation string for the
12433 respective variable for details.
12435 @vindex org-export-html-link-up
12436 @vindex org-export-html-link-home
12437 @vindex org-export-default-language
12438 @vindex org-display-custom-times
12439 @vindex org-export-headline-levels
12440 @vindex org-export-with-section-numbers
12441 @vindex org-export-section-number-format
12442 @vindex org-export-with-toc
12443 @vindex org-export-preserve-breaks
12444 @vindex org-export-with-archived-trees
12445 @vindex org-export-with-emphasize
12446 @vindex org-export-with-sub-superscripts
12447 @vindex org-export-with-special-strings
12448 @vindex org-export-with-footnotes
12449 @vindex org-export-with-drawers
12450 @vindex org-export-with-tags
12451 @vindex org-export-with-todo-keywords
12452 @vindex org-export-with-tasks
12453 @vindex org-export-with-done-tasks
12454 @vindex org-export-with-priority
12455 @vindex org-export-with-TeX-macros
12456 @vindex org-export-with-LaTeX-fragments
12457 @vindex org-export-skip-text-before-1st-heading
12458 @vindex org-export-with-fixed-width
12459 @vindex org-export-with-timestamps
12460 @vindex org-export-author-info
12461 @vindex org-export-email-info
12462 @vindex org-export-creator-info
12463 @vindex org-export-time-stamp-file
12464 @vindex org-export-with-tables
12465 @vindex org-export-highlight-first-table-line
12466 @vindex org-export-html-style-include-default
12467 @vindex org-export-html-style-include-scripts
12468 @vindex org-export-html-style
12469 @vindex org-export-html-style-extra
12470 @vindex org-export-html-link-org-files-as-html
12471 @vindex org-export-html-inline-images
12472 @vindex org-export-html-extension
12473 @vindex org-export-html-table-tag
12474 @vindex org-export-html-expand
12475 @vindex org-export-html-with-timestamp
12476 @vindex org-export-publishing-directory
12477 @vindex org-export-html-preamble
12478 @vindex org-export-html-postamble
12479 @vindex user-full-name
12480 @vindex user-mail-address
12481 @vindex org-export-select-tags
12482 @vindex org-export-exclude-tags
12484 @multitable @columnfractions 0.32 0.68
12485 @item @code{:link-up} @tab @code{org-export-html-link-up}
12486 @item @code{:link-home} @tab @code{org-export-html-link-home}
12487 @item @code{:language} @tab @code{org-export-default-language}
12488 @item @code{:customtime} @tab @code{org-display-custom-times}
12489 @item @code{:headline-levels} @tab @code{org-export-headline-levels}
12490 @item @code{:section-numbers} @tab @code{org-export-with-section-numbers}
12491 @item @code{:section-number-format} @tab @code{org-export-section-number-format}
12492 @item @code{:table-of-contents} @tab @code{org-export-with-toc}
12493 @item @code{:preserve-breaks} @tab @code{org-export-preserve-breaks}
12494 @item @code{:archived-trees} @tab @code{org-export-with-archived-trees}
12495 @item @code{:emphasize} @tab @code{org-export-with-emphasize}
12496 @item @code{:sub-superscript} @tab @code{org-export-with-sub-superscripts}
12497 @item @code{:special-strings} @tab @code{org-export-with-special-strings}
12498 @item @code{:footnotes} @tab @code{org-export-with-footnotes}
12499 @item @code{:drawers} @tab @code{org-export-with-drawers}
12500 @item @code{:tags} @tab @code{org-export-with-tags}
12501 @item @code{:todo-keywords} @tab @code{org-export-with-todo-keywords}
12502 @item @code{:tasks} @tab @code{org-export-with-tasks}
12503 @item @code{:priority} @tab @code{org-export-with-priority}
12504 @item @code{:TeX-macros} @tab @code{org-export-with-TeX-macros}
12505 @item @code{:LaTeX-fragments} @tab @code{org-export-with-LaTeX-fragments}
12506 @item @code{:latex-listings} @tab @code{org-export-latex-listings}
12507 @item @code{:skip-before-1st-heading} @tab @code{org-export-skip-text-before-1st-heading}
12508 @item @code{:fixed-width} @tab @code{org-export-with-fixed-width}
12509 @item @code{:timestamps} @tab @code{org-export-with-timestamps}
12510 @item @code{:author} @tab @code{user-full-name}
12511 @item @code{:email} @tab @code{user-mail-address} : @code{addr;addr;..}
12512 @item @code{:author-info} @tab @code{org-export-author-info}
12513 @item @code{:email-info} @tab @code{org-export-email-info}
12514 @item @code{:creator-info} @tab @code{org-export-creator-info}
12515 @item @code{:tables} @tab @code{org-export-with-tables}
12516 @item @code{:table-auto-headline} @tab @code{org-export-highlight-first-table-line}
12517 @item @code{:style-include-default} @tab @code{org-export-html-style-include-default}
12518 @item @code{:style-include-scripts} @tab @code{org-export-html-style-include-scripts}
12519 @item @code{:style} @tab @code{org-export-html-style}
12520 @item @code{:style-extra} @tab @code{org-export-html-style-extra}
12521 @item @code{:convert-org-links} @tab @code{org-export-html-link-org-files-as-html}
12522 @item @code{:inline-images} @tab @code{org-export-html-inline-images}
12523 @item @code{:html-extension} @tab @code{org-export-html-extension}
12524 @item @code{:html-preamble} @tab @code{org-export-html-preamble}
12525 @item @code{:html-postamble} @tab @code{org-export-html-postamble}
12526 @item @code{:xml-declaration} @tab @code{org-export-html-xml-declaration}
12527 @item @code{:html-table-tag} @tab @code{org-export-html-table-tag}
12528 @item @code{:expand-quoted-html} @tab @code{org-export-html-expand}
12529 @item @code{:timestamp} @tab @code{org-export-html-with-timestamp}
12530 @item @code{:publishing-directory} @tab @code{org-export-publishing-directory}
12531 @item @code{:select-tags} @tab @code{org-export-select-tags}
12532 @item @code{:exclude-tags} @tab @code{org-export-exclude-tags}
12533 @item @code{:latex-image-options} @tab @code{org-export-latex-image-default-option}
12536 Most of the @code{org-export-with-*} variables have the same effect in
12537 both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and
12538 @code{:LaTeX-fragments} options, respectively @code{nil} and @code{t} in the
12539 @LaTeX{} export. See @code{org-export-plist-vars} to check this list of
12544 @vindex org-publish-project-alist
12545 When a property is given a value in @code{org-publish-project-alist},
12546 its setting overrides the value of the corresponding user variable (if
12547 any) during publishing. Options set within a file (@pxref{Export
12548 options}), however, override everything.
12550 @node Publishing links, Sitemap, Publishing options, Configuration
12551 @subsection Links between published files
12552 @cindex links, publishing
12554 To create a link from one Org file to another, you would use
12555 something like @samp{[[file:foo.org][The foo]]} or simply
12556 @samp{file:foo.org.} (@pxref{Hyperlinks}). When published, this link
12557 becomes a link to @file{foo.html}. In this way, you can interlink the
12558 pages of your "org web" project and the links will work as expected when
12559 you publish them to HTML@. If you also publish the Org source file and want
12560 to link to that, use an @code{http:} link instead of a @code{file:} link,
12561 because @code{file:} links are converted to link to the corresponding
12564 You may also link to related files, such as images. Provided you are careful
12565 with relative file names, and provided you have also configured Org to upload
12566 the related files, these links will work too. See @ref{Complex example}, for
12567 an example of this usage.
12569 Sometimes an Org file to be published may contain links that are
12570 only valid in your production environment, but not in the publishing
12571 location. In this case, use the property
12573 @multitable @columnfractions 0.4 0.6
12574 @item @code{:link-validation-function}
12575 @tab Function to validate links
12579 to define a function for checking link validity. This function must
12580 accept two arguments, the file name and a directory relative to which
12581 the file name is interpreted in the production environment. If this
12582 function returns @code{nil}, then the HTML generator will only insert a
12583 description into the HTML file, but no link. One option for this
12584 function is @code{org-publish-validate-link} which checks if the given
12585 file is part of any project in @code{org-publish-project-alist}.
12587 @node Sitemap, Generating an index, Publishing links, Configuration
12588 @subsection Generating a sitemap
12589 @cindex sitemap, of published pages
12591 The following properties may be used to control publishing of
12592 a map of files for a given project.
12594 @multitable @columnfractions 0.35 0.65
12595 @item @code{:auto-sitemap}
12596 @tab When non-nil, publish a sitemap during @code{org-publish-current-project}
12597 or @code{org-publish-all}.
12599 @item @code{:sitemap-filename}
12600 @tab Filename for output of sitemap. Defaults to @file{sitemap.org} (which
12601 becomes @file{sitemap.html}).
12603 @item @code{:sitemap-title}
12604 @tab Title of sitemap page. Defaults to name of file.
12606 @item @code{:sitemap-function}
12607 @tab Plug-in function to use for generation of the sitemap.
12608 Defaults to @code{org-publish-org-sitemap}, which generates a plain list
12609 of links to all files in the project.
12611 @item @code{:sitemap-sort-folders}
12612 @tab Where folders should appear in the sitemap. Set this to @code{first}
12613 (default) or @code{last} to display folders first or last,
12614 respectively. Any other value will mix files and folders.
12616 @item @code{:sitemap-sort-files}
12617 @tab How the files are sorted in the site map. Set this to
12618 @code{alphabetically} (default), @code{chronologically} or
12619 @code{anti-chronologically}. @code{chronologically} sorts the files with
12620 older date first while @code{anti-chronologically} sorts the files with newer
12621 date first. @code{alphabetically} sorts the files alphabetically. The date of
12622 a file is retrieved with @code{org-publish-find-date}.
12624 @item @code{:sitemap-ignore-case}
12625 @tab Should sorting be case-sensitive? Default @code{nil}.
12627 @item @code{:sitemap-file-entry-format}
12628 @tab With this option one can tell how a sitemap's entry is formatted in the
12629 sitemap. This is a format string with some escape sequences: @code{%t} stands
12630 for the title of the file, @code{%a} stands for the author of the file and
12631 @code{%d} stands for the date of the file. The date is retrieved with the
12632 @code{org-publish-find-date} function and formatted with
12633 @code{org-publish-sitemap-date-format}. Default @code{%t}.
12635 @item @code{:sitemap-date-format}
12636 @tab Format string for the @code{format-time-string} function that tells how
12637 a sitemap entry's date is to be formatted. This property bypasses
12638 @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}.
12640 @item @code{:sitemap-sans-extension}
12641 @tab When non-nil, remove filenames' extensions from the generated sitemap.
12642 Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}).
12643 Defaults to @code{nil}.
12647 @node Generating an index, , Sitemap, Configuration
12648 @subsection Generating an index
12649 @cindex index, in a publishing project
12651 Org mode can generate an index across the files of a publishing project.
12653 @multitable @columnfractions 0.25 0.75
12654 @item @code{:makeindex}
12655 @tab When non-nil, generate in index in the file @file{theindex.org} and
12656 publish it as @file{theindex.html}.
12659 The file will be created when first publishing a project with the
12660 @code{:makeindex} set. The file only contains a statement @code{#+INCLUDE:
12661 "theindex.inc"}. You can then build around this include statement by adding
12662 a title, style information, etc.
12664 @node Uploading files, Sample configuration, Configuration, Publishing
12665 @section Uploading files
12669 For those people already utilizing third party sync tools such as
12670 @command{rsync} or @command{unison}, it might be preferable not to use the built in
12671 @i{remote} publishing facilities of Org mode which rely heavily on
12672 Tramp. Tramp, while very useful and powerful, tends not to be
12673 so efficient for multiple file transfer and has been known to cause problems
12676 Specialized synchronization utilities offer several advantages. In addition
12677 to timestamp comparison, they also do content and permissions/attribute
12678 checks. For this reason you might prefer to publish your web to a local
12679 directory (possibly even @i{in place} with your Org files) and then use
12680 @file{unison} or @file{rsync} to do the synchronization with the remote host.
12682 Since Unison (for example) can be configured as to which files to transfer to
12683 a certain remote destination, it can greatly simplify the project publishing
12684 definition. Simply keep all files in the correct location, process your Org
12685 files with @code{org-publish} and let the synchronization tool do the rest.
12686 You do not need, in this scenario, to include attachments such as @file{jpg},
12687 @file{css} or @file{gif} files in the project definition since the 3rd party
12690 Publishing to a local directory is also much faster than to a remote one, so
12691 that you can afford more easily to republish entire projects. If you set
12692 @code{org-publish-use-timestamps-flag} to @code{nil}, you gain the main
12693 benefit of re-including any changed external files such as source example
12694 files you might include with @code{#+INCLUDE:}. The timestamp mechanism in
12695 Org is not smart enough to detect if included files have been modified.
12697 @node Sample configuration, Triggering publication, Uploading files, Publishing
12698 @section Sample configuration
12700 Below we provide two example configurations. The first one is a simple
12701 project publishing only a set of Org files. The second example is
12702 more complex, with a multi-component project.
12705 * Simple example:: One-component publishing
12706 * Complex example:: A multi-component publishing example
12709 @node Simple example, Complex example, Sample configuration, Sample configuration
12710 @subsection Example: simple publishing configuration
12712 This example publishes a set of Org files to the @file{public_html}
12713 directory on the local machine.
12716 (setq org-publish-project-alist
12718 :base-directory "~/org/"
12719 :publishing-directory "~/public_html"
12720 :section-numbers nil
12721 :table-of-contents nil
12722 :style "<link rel=\"stylesheet\"
12723 href=\"../other/mystyle.css\"
12724 type=\"text/css\"/>")))
12727 @node Complex example, , Simple example, Sample configuration
12728 @subsection Example: complex publishing configuration
12730 This more complicated example publishes an entire website, including
12731 Org files converted to HTML, image files, Emacs Lisp source code, and
12732 style sheets. The publishing directory is remote and private files are
12735 To ensure that links are preserved, care should be taken to replicate
12736 your directory structure on the web server, and to use relative file
12737 paths. For example, if your Org files are kept in @file{~/org} and your
12738 publishable images in @file{~/images}, you would link to an image with
12741 file:../images/myimage.png
12744 On the web server, the relative path to the image should be the
12745 same. You can accomplish this by setting up an "images" folder in the
12746 right place on the web server, and publishing images to it.
12749 (setq org-publish-project-alist
12751 :base-directory "~/org/"
12752 :base-extension "org"
12753 :publishing-directory "/ssh:user@@host:~/html/notebook/"
12754 :publishing-function org-publish-org-to-html
12755 :exclude "PrivatePage.org" ;; regexp
12757 :section-numbers nil
12758 :table-of-contents nil
12759 :style "<link rel=\"stylesheet\"
12760 href=\"../other/mystyle.css\" type=\"text/css\"/>"
12764 :base-directory "~/images/"
12765 :base-extension "jpg\\|gif\\|png"
12766 :publishing-directory "/ssh:user@@host:~/html/images/"
12767 :publishing-function org-publish-attachment)
12770 :base-directory "~/other/"
12771 :base-extension "css\\|el"
12772 :publishing-directory "/ssh:user@@host:~/html/other/"
12773 :publishing-function org-publish-attachment)
12774 ("website" :components ("orgfiles" "images" "other"))))
12777 @node Triggering publication, , Sample configuration, Publishing
12778 @section Triggering publication
12780 Once properly configured, Org can publish with the following commands:
12783 @orgcmd{C-c C-e X,org-publish}
12784 Prompt for a specific project and publish all files that belong to it.
12785 @orgcmd{C-c C-e P,org-publish-current-project}
12786 Publish the project containing the current file.
12787 @orgcmd{C-c C-e F,org-publish-current-file}
12788 Publish only the current file.
12789 @orgcmd{C-c C-e E,org-publish-all}
12790 Publish every project.
12793 @vindex org-publish-use-timestamps-flag
12794 Org uses timestamps to track when a file has changed. The above functions
12795 normally only publish changed files. You can override this and force
12796 publishing of all files by giving a prefix argument to any of the commands
12797 above, or by customizing the variable @code{org-publish-use-timestamps-flag}.
12798 This may be necessary in particular if files include other files via
12799 @code{#+SETUPFILE:} or @code{#+INCLUDE:}.
12801 @comment node-name, next, previous, up
12802 @comment Working With Source Code, Miscellaneous, Publishing, Top
12804 @node Working With Source Code, Miscellaneous, Publishing, Top
12805 @chapter Working with source code
12806 @cindex Schulte, Eric
12807 @cindex Davison, Dan
12808 @cindex source code, working with
12810 Source code can be included in Org mode documents using a @samp{src} block,
12814 #+BEGIN_SRC emacs-lisp
12815 (defun org-xor (a b)
12821 Org mode provides a number of features for working with live source code,
12822 including editing of code blocks in their native major-mode, evaluation of
12823 code blocks, converting code blocks into source files (known as @dfn{tangling}
12824 in literate programming), and exporting code blocks and their
12825 results in several formats. This functionality was contributed by Eric
12826 Schulte and Dan Davison, and was originally named Org-babel.
12828 The following sections describe Org mode's code block handling facilities.
12831 * Structure of code blocks:: Code block syntax described
12832 * Editing source code:: Language major-mode editing
12833 * Exporting code blocks:: Export contents and/or results
12834 * Extracting source code:: Create pure source code files
12835 * Evaluating code blocks:: Place results of evaluation in the Org mode buffer
12836 * Library of Babel:: Use and contribute to a library of useful code blocks
12837 * Languages:: List of supported code block languages
12838 * Header arguments:: Configure code block functionality
12839 * Results of evaluation:: How evaluation results are handled
12840 * Noweb reference syntax:: Literate programming in Org mode
12841 * Key bindings and useful functions:: Work quickly with code blocks
12842 * Batch execution:: Call functions from the command line
12845 @comment node-name, next, previous, up
12846 @comment Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12848 @node Structure of code blocks, Editing source code, Working With Source Code, Working With Source Code
12849 @section Structure of code blocks
12850 @cindex code block, structure
12851 @cindex source code, block structure
12853 @cindex #+BEGIN_SRC
12855 Live code blocks can be specified with a @samp{src} block or
12856 inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
12857 @ref{Easy Templates} system} The structure of a @samp{src} block is
12861 #+BEGIN_SRC <language> <switches> <header arguments>
12866 The @code{#+NAME:} line is optional, and can be used to name the code
12867 block. Live code blocks require that a language be specified on the
12868 @code{#+BEGIN_SRC} line. Switches and header arguments are optional.
12869 @cindex source code, inline
12871 Live code blocks can also be specified inline using
12874 src_<language>@{<body>@}
12880 src_<language>[<header arguments>]@{<body>@}
12884 @item <#+NAME: name>
12885 This line associates a name with the code block. This is similar to the
12886 @code{#+TBLNAME: NAME} lines that can be used to name tables in Org mode
12887 files. Referencing the name of a code block makes it possible to evaluate
12888 the block from other places in the file, from other files, or from Org mode
12889 table formulas (see @ref{The spreadsheet}). Names are assumed to be unique
12890 and the behavior of Org mode when two or more blocks share the same name is
12894 The language of the code in the block (see @ref{Languages}).
12895 @cindex source code, language
12897 Optional switches control code block export (see the discussion of switches in
12898 @ref{Literal examples})
12899 @cindex source code, switches
12900 @item <header arguments>
12901 Optional header arguments control many aspects of evaluation, export and
12902 tangling of code blocks (see @ref{Header arguments}).
12903 Header arguments can also be set on a per-buffer or per-subtree
12904 basis using properties.
12905 @item source code, header arguments
12907 Source code in the specified language.
12910 @comment node-name, next, previous, up
12911 @comment Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12913 @node Editing source code, Exporting code blocks, Structure of code blocks, Working With Source Code
12914 @section Editing source code
12915 @cindex code block, editing
12916 @cindex source code, editing
12919 Use @kbd{C-c '} to edit the current code block. This brings up
12920 a language major-mode edit buffer containing the body of the code
12921 block. Saving this buffer will write the new contents back to the Org
12922 buffer. Use @kbd{C-c '} again to exit.
12924 The @code{org-src-mode} minor mode will be active in the edit buffer. The
12925 following variables can be used to configure the behavior of the edit
12926 buffer. See also the customization group @code{org-edit-structure} for
12927 further configuration options.
12930 @item org-src-lang-modes
12931 If an Emacs major-mode named @code{<lang>-mode} exists, where
12932 @code{<lang>} is the language named in the header line of the code block,
12933 then the edit buffer will be placed in that major-mode. This variable
12934 can be used to map arbitrary language names to existing major modes.
12935 @item org-src-window-setup
12936 Controls the way Emacs windows are rearranged when the edit buffer is created.
12937 @item org-src-preserve-indentation
12938 This variable is especially useful for tangling languages such as
12939 Python, in which whitespace indentation in the output is critical.
12940 @item org-src-ask-before-returning-to-edit-buffer
12941 By default, Org will ask before returning to an open edit buffer. Set this
12942 variable to nil to switch without asking.
12945 To turn on native code fontification in the @emph{Org} buffer, configure the
12946 variable @code{org-src-fontify-natively}.
12948 @comment node-name, next, previous, up
12949 @comment Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12951 @node Exporting code blocks, Extracting source code, Editing source code, Working With Source Code
12952 @section Exporting code blocks
12953 @cindex code block, exporting
12954 @cindex source code, exporting
12956 It is possible to export the @emph{code} of code blocks, the @emph{results}
12957 of code block evaluation, @emph{both} the code and the results of code block
12958 evaluation, or @emph{none}. For most languages, the default exports code.
12959 However, for some languages (e.g., @code{ditaa}) the default exports the
12960 results of code block evaluation. For information on exporting code block
12961 bodies, see @ref{Literal examples}.
12963 The @code{:exports} header argument can be used to specify export
12966 @subsubheading Header arguments:
12968 @item :exports code
12969 The default in most languages. The body of the code block is exported, as
12970 described in @ref{Literal examples}.
12971 @item :exports results
12972 The code block will be evaluated and the results will be placed in the
12973 Org mode buffer for export, either updating previous results of the code
12974 block located anywhere in the buffer or, if no previous results exist,
12975 placing the results immediately after the code block. The body of the code
12976 block will not be exported.
12977 @item :exports both
12978 Both the code block and its results will be exported.
12979 @item :exports none
12980 Neither the code block nor its results will be exported.
12983 It is possible to inhibit the evaluation of code blocks during export.
12984 Setting the @code{org-export-babel-evaluate} variable to @code{nil} will
12985 ensure that no code blocks are evaluated as part of the export process. This
12986 can be useful in situations where potentially untrusted Org mode files are
12987 exported in an automated fashion, for example when Org mode is used as the
12988 markup language for a wiki.
12990 @comment node-name, next, previous, up
12991 @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12992 @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code
12993 @section Extracting source code
12995 @cindex source code, extracting
12996 @cindex code block, extracting source code
12998 Creating pure source code files by extracting code from source blocks is
12999 referred to as ``tangling''---a term adopted from the literate programming
13000 community. During ``tangling'' of code blocks their bodies are expanded
13001 using @code{org-babel-expand-src-block} which can expand both variable and
13002 ``noweb'' style references (see @ref{Noweb reference syntax}).
13004 @subsubheading Header arguments
13007 The default. The code block is not included in the tangled output.
13009 Include the code block in the tangled output. The output file name is the
13010 name of the org file with the extension @samp{.org} replaced by the extension
13011 for the block language.
13012 @item :tangle filename
13013 Include the code block in the tangled output to file @samp{filename}.
13017 @subsubheading Functions
13019 @item org-babel-tangle
13020 Tangle the current file. Bound to @kbd{C-c C-v t}.
13022 With prefix argument only tangle the current code block.
13023 @item org-babel-tangle-file
13024 Choose a file to tangle. Bound to @kbd{C-c C-v f}.
13027 @subsubheading Hooks
13029 @item org-babel-post-tangle-hook
13030 This hook is run from within code files tangled by @code{org-babel-tangle}.
13031 Example applications could include post-processing, compilation or evaluation
13032 of tangled code files.
13035 @node Evaluating code blocks, Library of Babel, Extracting source code, Working With Source Code
13036 @section Evaluating code blocks
13037 @cindex code block, evaluating
13038 @cindex source code, evaluating
13041 Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
13042 potential for that code to do harm. Org mode provides safeguards to ensure
13043 that code is only evaluated after explicit confirmation from the user. For
13044 information on these safeguards (and on how to disable them) see @ref{Code
13045 evaluation security}.} and the results of evaluation optionally placed in the
13046 Org mode buffer. The results of evaluation are placed following a line that
13047 begins by default with @code{#+RESULTS} and optionally a cache identifier
13048 and/or the name of the evaluated code block. The default value of
13049 @code{#+RESULTS} can be changed with the customizable variable
13050 @code{org-babel-results-keyword}.
13052 By default, the evaluation facility is only enabled for Lisp code blocks
13053 specified as @code{emacs-lisp}. However, source code blocks in many languages
13054 can be evaluated within Org mode (see @ref{Languages} for a list of supported
13055 languages and @ref{Structure of code blocks} for information on the syntax
13056 used to define a code block).
13059 There are a number of ways to evaluate code blocks. The simplest is to press
13060 @kbd{C-c C-c} or @kbd{C-c C-v e} with the point on a code block@footnote{The
13061 @code{org-babel-no-eval-on-ctrl-c-ctrl-c} variable can be used to remove code
13062 evaluation from the @kbd{C-c C-c} key binding.}. This will call the
13063 @code{org-babel-execute-src-block} function to evaluate the block and insert
13064 its results into the Org mode buffer.
13067 It is also possible to evaluate named code blocks from anywhere in an Org
13068 mode buffer or an Org mode table. Live code blocks located in the current
13069 Org mode buffer or in the ``Library of Babel'' (see @ref{Library of Babel})
13070 can be executed. Named code blocks can be executed with a separate
13071 @code{#+CALL:} line or inline within a block of text.
13073 The syntax of the @code{#+CALL:} line is
13076 #+CALL: <name>(<arguments>)
13077 #+CALL: <name>[<inside header arguments>](<arguments>) <end header arguments>
13080 The syntax for inline evaluation of named code blocks is
13083 ... call_<name>(<arguments>) ...
13084 ... call_<name>[<inside header arguments>](<arguments>)[<end header arguments>] ...
13089 The name of the code block to be evaluated (see @ref{Structure of code blocks}).
13091 Arguments specified in this section will be passed to the code block. These
13092 arguments use standard function call syntax, rather than
13093 header argument syntax. For example, a @code{#+CALL:} line that passes the
13094 number four to a code block named @code{double}, which declares the header
13095 argument @code{:var n=2}, would be written as @code{#+CALL: double(n=4)}.
13096 @item <inside header arguments>
13097 Inside header arguments are passed through and applied to the named code
13098 block. These arguments use header argument syntax rather than standard
13099 function call syntax. Inside header arguments affect how the code block is
13100 evaluated. For example, @code{[:results output]} will collect the results of
13101 everything printed to @code{STDOUT} during execution of the code block.
13102 @item <end header arguments>
13103 End header arguments are applied to the calling instance and do not affect
13104 evaluation of the named code block. They affect how the results are
13105 incorporated into the Org mode buffer and how the call line is exported. For
13106 example, @code{:results html} will insert the results of the call line
13107 evaluation in the Org buffer, wrapped in a @code{BEGIN_HTML:} block.
13109 For more examples of passing header arguments to @code{#+CALL:} lines see
13110 @ref{Header arguments in function calls}.
13113 @node Library of Babel, Languages, Evaluating code blocks, Working With Source Code
13114 @section Library of Babel
13115 @cindex babel, library of
13116 @cindex source code, library
13117 @cindex code block, library
13119 The ``Library of Babel'' consists of code blocks that can be called from any
13120 Org mode file. Code blocks defined in the ``Library of Babel'' can be called
13121 remotely as if they were in the current Org mode buffer (see @ref{Evaluating
13122 code blocks} for information on the syntax of remote code block evaluation).
13125 The central repository of code blocks in the ``Library of Babel'' is housed
13126 in an Org mode file located in the @samp{contrib} directory of Org mode.
13128 Users can add code blocks they believe to be generally useful to their
13129 ``Library of Babel.'' The code blocks can be stored in any Org mode file and
13130 then loaded into the library with @code{org-babel-lob-ingest}.
13134 Code blocks located in any Org mode file can be loaded into the ``Library of
13135 Babel'' with the @code{org-babel-lob-ingest} function, bound to @kbd{C-c C-v
13138 @node Languages, Header arguments, Library of Babel, Working With Source Code
13140 @cindex babel, languages
13141 @cindex source code, languages
13142 @cindex code block, languages
13144 Code blocks in the following languages are supported.
13146 @multitable @columnfractions 0.28 0.3 0.22 0.2
13147 @item @b{Language} @tab @b{Identifier} @tab @b{Language} @tab @b{Identifier}
13148 @item Asymptote @tab asymptote @tab Awk @tab awk
13149 @item Emacs Calc @tab calc @tab C @tab C
13150 @item C++ @tab C++ @tab Clojure @tab clojure
13151 @item CSS @tab css @tab ditaa @tab ditaa
13152 @item Graphviz @tab dot @tab Emacs Lisp @tab emacs-lisp
13153 @item gnuplot @tab gnuplot @tab Haskell @tab haskell
13154 @item Java @tab java @tab @tab
13155 @item Javascript @tab js @tab LaTeX @tab latex
13156 @item Ledger @tab ledger @tab Lisp @tab lisp
13157 @item Lilypond @tab lilypond @tab MATLAB @tab matlab
13158 @item Mscgen @tab mscgen @tab Objective Caml @tab ocaml
13159 @item Octave @tab octave @tab Org mode @tab org
13160 @item Oz @tab oz @tab Perl @tab perl
13161 @item Plantuml @tab plantuml @tab Python @tab python
13162 @item R @tab R @tab Ruby @tab ruby
13163 @item Sass @tab sass @tab Scheme @tab scheme
13164 @item GNU Screen @tab screen @tab shell @tab sh
13165 @item SQL @tab sql @tab SQLite @tab sqlite
13168 Language-specific documentation is available for some languages. If
13169 available, it can be found at
13170 @uref{http://orgmode.org/worg/org-contrib/babel/languages.html}.
13172 The @code{org-babel-load-languages} controls which languages are enabled for
13173 evaluation (by default only @code{emacs-lisp} is enabled). This variable can
13174 be set using the customization interface or by adding code like the following
13175 to your emacs configuration.
13178 The following disables @code{emacs-lisp} evaluation and enables evaluation of
13179 @code{R} code blocks.
13183 (org-babel-do-load-languages
13184 'org-babel-load-languages
13185 '((emacs-lisp . nil)
13189 It is also possible to enable support for a language by loading the related
13190 elisp file with @code{require}.
13193 The following adds support for evaluating @code{clojure} code blocks.
13197 (require 'ob-clojure)
13200 @node Header arguments, Results of evaluation, Languages, Working With Source Code
13201 @section Header arguments
13202 @cindex code block, header arguments
13203 @cindex source code, block header arguments
13205 Code block functionality can be configured with header arguments. This
13206 section provides an overview of the use of header arguments, and then
13207 describes each header argument in detail.
13210 * Using header arguments:: Different ways to set header arguments
13211 * Specific header arguments:: List of header arguments
13214 @node Using header arguments, Specific header arguments, Header arguments, Header arguments
13215 @subsection Using header arguments
13217 The values of header arguments can be set in six different ways, each more
13218 specific (and having higher priority) than the last.
13220 * System-wide header arguments:: Set global default values
13221 * Language-specific header arguments:: Set default values by language
13222 * Buffer-wide header arguments:: Set default values for a specific buffer
13223 * Header arguments in Org mode properties:: Set default values for a buffer or heading
13224 * Code block specific header arguments:: The most common way to set values
13225 * Header arguments in function calls:: The most specific level
13229 @node System-wide header arguments, Language-specific header arguments, Using header arguments, Using header arguments
13230 @subsubheading System-wide header arguments
13231 @vindex org-babel-default-header-args
13232 System-wide values of header arguments can be specified by customizing the
13233 @code{org-babel-default-header-args} variable:
13237 :results => "replace"
13244 @c org-babel-default-header-args is a variable defined in `org-babel.el'.
13246 @c ((:session . "none")
13247 @c (:results . "replace")
13248 @c (:exports . "code")
13250 @c (:noweb . "no"))
13254 @c Default arguments to use when evaluating a code block.
13257 For example, the following example could be used to set the default value of
13258 @code{:noweb} header arguments to @code{yes}. This would have the effect of
13259 expanding @code{:noweb} references by default when evaluating source code
13263 (setq org-babel-default-header-args
13264 (cons '(:noweb . "yes")
13265 (assq-delete-all :noweb org-babel-default-header-args)))
13268 @node Language-specific header arguments, Buffer-wide header arguments, System-wide header arguments, Using header arguments
13269 @subsubheading Language-specific header arguments
13270 Each language can define its own set of default header arguments. See the
13271 language-specific documentation available online at
13272 @uref{http://orgmode.org/worg/org-contrib/babel}.
13274 @node Buffer-wide header arguments, Header arguments in Org mode properties, Language-specific header arguments, Using header arguments
13275 @subsubheading Buffer-wide header arguments
13276 Buffer-wide header arguments may be specified as properties through the use
13277 of @code{#+PROPERTY:} lines placed anywhere in an Org mode file (see
13278 @ref{Property syntax}).
13280 For example the following would set @code{session} to @code{*R*}, and
13281 @code{results} to @code{silent} for every code block in the buffer, ensuring
13282 that all execution took place in the same session, and no results would be
13283 inserted into the buffer.
13286 #+PROPERTY: session *R*
13287 #+PROPERTY: results silent
13290 @node Header arguments in Org mode properties, Code block specific header arguments, Buffer-wide header arguments, Using header arguments
13291 @subsubheading Header arguments in Org mode properties
13293 Header arguments are also read from Org mode properties (see @ref{Property
13294 syntax}), which can be set on a buffer-wide or per-heading basis. An example
13295 of setting a header argument for all code blocks in a buffer is
13298 #+PROPERTY: tangle yes
13301 @vindex org-use-property-inheritance
13302 When properties are used to set default header arguments, they are looked up
13303 with inheritance, regardless of the value of
13304 @code{org-use-property-inheritance}. In the following example the value of
13305 the @code{:cache} header argument will default to @code{yes} in all code
13306 blocks in the subtree rooted at the following heading:
13316 @vindex org-babel-default-header-args
13317 Properties defined in this way override the properties set in
13318 @code{org-babel-default-header-args}. It is convenient to use the
13319 @code{org-set-property} function bound to @kbd{C-c C-x p} to set properties
13320 in Org mode documents.
13322 @node Code block specific header arguments, Header arguments in function calls, Header arguments in Org mode properties, Using header arguments
13323 @subsubheading Code block specific header arguments
13325 The most common way to assign values to header arguments is at the
13326 code block level. This can be done by listing a sequence of header
13327 arguments and their values as part of the @code{#+BEGIN_SRC} line.
13328 Properties set in this way override both the values of
13329 @code{org-babel-default-header-args} and header arguments specified as
13330 properties. In the following example, the @code{:results} header argument
13331 is set to @code{silent}, meaning the results of execution will not be
13332 inserted in the buffer, and the @code{:exports} header argument is set to
13333 @code{code}, meaning only the body of the code block will be
13334 preserved on export to HTML or @LaTeX{}.
13338 #+BEGIN_SRC haskell :results silent :exports code :var n=0
13340 fac n = n * fac (n-1)
13343 Similarly, it is possible to set header arguments for inline code blocks
13346 src_haskell[:exports both]@{fac 5@}
13349 Code block header arguments can span multiple lines using @code{#+HEADER:} or
13350 @code{#+HEADERS:} lines preceding a code block or nested between the
13351 @code{#+NAME:} line and the @code{#+BEGIN_SRC} line of a named code block.
13355 Multi-line header arguments on an un-named code block:
13358 #+HEADERS: :var data1=1
13359 #+BEGIN_SRC emacs-lisp :var data2=2
13360 (message "data1:%S, data2:%S" data1 data2)
13367 Multi-line header arguments on a named code block:
13370 #+NAME: named-block
13371 #+HEADER: :var data=2
13372 #+BEGIN_SRC emacs-lisp
13373 (message "data:%S" data)
13376 #+RESULTS: named-block
13380 @node Header arguments in function calls, , Code block specific header arguments, Using header arguments
13381 @comment node-name, next, previous, up
13382 @subsubheading Header arguments in function calls
13384 At the most specific level, header arguments for ``Library of Babel'' or
13385 @code{#+CALL:} lines can be set as shown in the two examples below. For more
13386 information on the structure of @code{#+CALL:} lines see @ref{Evaluating code
13389 The following will apply the @code{:exports results} header argument to the
13390 evaluation of the @code{#+CALL:} line.
13393 #+CALL: factorial(n=5) :exports results
13396 The following will apply the @code{:session special} header argument to the
13397 evaluation of the @code{factorial} code block.
13400 #+CALL: factorial[:session special](n=5)
13403 @node Specific header arguments, , Using header arguments, Header arguments
13404 @subsection Specific header arguments
13405 Header arguments consist of an initial colon followed by the name of the
13406 argument in lowercase letters. The following header arguments are defined:
13409 * var:: Pass arguments to code blocks
13410 * results:: Specify the type of results and how they will
13411 be collected and handled
13412 * file:: Specify a path for file output
13413 * file-desc:: Specify a description for file results
13414 * dir:: Specify the default (possibly remote)
13415 directory for code block execution
13416 * exports:: Export code and/or results
13417 * tangle:: Toggle tangling and specify file name
13418 * mkdirp:: Toggle creation of parent directories of target
13419 files during tangling
13420 * comments:: Toggle insertion of comments in tangled
13422 * padline:: Control insertion of padding lines in tangled
13424 * no-expand:: Turn off variable assignment and noweb
13425 expansion during tangling
13426 * session:: Preserve the state of code evaluation
13427 * noweb:: Toggle expansion of noweb references
13428 * noweb-ref:: Specify block's noweb reference resolution target
13429 * noweb-sep:: String used to separate noweb references
13430 * cache:: Avoid re-evaluating unchanged code blocks
13431 * sep:: Delimiter for writing tabular results outside Org
13432 * hlines:: Handle horizontal lines in tables
13433 * colnames:: Handle column names in tables
13434 * rownames:: Handle row names in tables
13435 * shebang:: Make tangled files executable
13436 * eval:: Limit evaluation of specific code blocks
13437 * wrap:: Mark source block evaluation results
13440 Additional header arguments are defined on a language-specific basis, see
13443 @node var, results, Specific header arguments, Specific header arguments
13444 @subsubsection @code{:var}
13445 The @code{:var} header argument is used to pass arguments to code blocks.
13446 The specifics of how arguments are included in a code block vary by language;
13447 these are addressed in the language-specific documentation. However, the
13448 syntax used to specify arguments is the same across all languages. In every
13449 case, variables require a default value when they are declared.
13451 The values passed to arguments can either be literal values, references, or
13452 Emacs Lisp code (see @ref{var, Emacs Lisp evaluation of variables}). References
13453 include anything in the Org mode file that takes a @code{#+NAME:},
13454 @code{#+TBLNAME:}, or @code{#+RESULTS:} line. This includes tables, lists,
13455 @code{#+BEGIN_EXAMPLE} blocks, other code blocks, and the results of other
13458 Argument values can be indexed in a manner similar to arrays (see @ref{var,
13459 Indexable variable values}).
13461 The following syntax is used to pass arguments to code blocks using the
13462 @code{:var} header argument.
13468 The argument, @code{assign}, can either be a literal value, such as a string
13469 @samp{"string"} or a number @samp{9}, or a reference to a table, a list, a
13470 literal example, another code block (with or without arguments), or the
13471 results of evaluating another code block.
13473 Here are examples of passing values by reference:
13478 an Org mode table named with either a @code{#+NAME:} or @code{#+TBLNAME:} line
13481 #+TBLNAME: example-table
13487 #+NAME: table-length
13488 #+BEGIN_SRC emacs-lisp :var table=example-table
13492 #+RESULTS: table-length
13497 a simple list named with a @code{#+NAME:} line (note that nesting is not
13498 carried through to the source code block)
13501 #+NAME: example-list
13507 #+BEGIN_SRC emacs-lisp :var x=example-list
13515 @item code block without arguments
13516 a code block name (from the example above), as assigned by @code{#+NAME:},
13517 optionally followed by parentheses
13520 #+BEGIN_SRC emacs-lisp :var length=table-length()
13528 @item code block with arguments
13529 a code block name, as assigned by @code{#+NAME:}, followed by parentheses and
13530 optional arguments passed within the parentheses following the
13531 code block name using standard function call syntax
13535 #+BEGIN_SRC emacs-lisp :var input=8
13543 #+BEGIN_SRC emacs-lisp :var input=double(input=1)
13551 @item literal example
13552 a literal example block named with a @code{#+NAME:} line
13555 #+NAME: literal-example
13561 #+NAME: read-literal-example
13562 #+BEGIN_SRC emacs-lisp :var x=literal-example
13563 (concatenate 'string x " for you.")
13566 #+RESULTS: read-literal-example
13567 : A literal example
13568 : on two lines for you.
13574 @subsubheading Alternate argument syntax
13575 It is also possible to specify arguments in a potentially more natural way
13576 using the @code{#+NAME:} line of a code block. As in the following
13577 example, arguments can be packed inside of parentheses, separated by commas,
13578 following the source name.
13581 #+NAME: double(input=0, x=2)
13582 #+BEGIN_SRC emacs-lisp
13587 @subsubheading Indexable variable values
13588 It is possible to reference portions of variable values by ``indexing'' into
13589 the variables. Indexes are 0 based with negative values counting back from
13590 the end. If an index is separated by @code{,}s then each subsequent section
13591 will index into the next deepest nesting or dimension of the value. Note
13592 that this indexing occurs @emph{before} other table related header arguments
13593 like @code{:hlines}, @code{:colnames} and @code{:rownames} are applied. The
13594 following example assigns the last cell of the first row the table
13595 @code{example-table} to the variable @code{data}:
13598 #+NAME: example-table
13604 #+BEGIN_SRC emacs-lisp :var data=example-table[0,-1]
13612 Ranges of variable values can be referenced using two integers separated by a
13613 @code{:}, in which case the entire inclusive range is referenced. For
13614 example the following assigns the middle three rows of @code{example-table}
13618 #+NAME: example-table
13625 #+BEGIN_SRC emacs-lisp :var data=example-table[1:3]
13635 Additionally, an empty index, or the single character @code{*}, are both
13636 interpreted to mean the entire range and as such are equivalent to
13637 @code{0:-1}, as shown in the following example in which the entire first
13638 column is referenced.
13641 #+NAME: example-table
13647 #+BEGIN_SRC emacs-lisp :var data=example-table[,0]
13655 It is possible to index into the results of code blocks as well as tables.
13656 Any number of dimensions can be indexed. Dimensions are separated from one
13657 another by commas, as shown in the following example.
13661 #+BEGIN_SRC emacs-lisp
13662 '(((1 2 3) (4 5 6) (7 8 9))
13663 ((10 11 12) (13 14 15) (16 17 18))
13664 ((19 20 21) (22 23 24) (25 26 27)))
13667 #+BEGIN_SRC emacs-lisp :var data=3D[1,,1]
13675 @subsubheading Emacs Lisp evaluation of variables
13677 Emacs lisp code can be used to initialize variable values. When a variable
13678 value starts with @code{(}, @code{[}, @code{'} or @code{`} it will be
13679 evaluated as Emacs Lisp and the result of the evaluation will be assigned as
13680 the variable value. The following example demonstrates use of this
13681 evaluation to reliably pass the file-name of the Org mode buffer to a code
13682 block---note that evaluation of header arguments is guaranteed to take place
13683 in the original Org mode file, while there is no such guarantee for
13684 evaluation of the code block body.
13687 #+BEGIN_SRC sh :var filename=(buffer-file-name) :exports both
13692 Note that values read from tables and lists will not be evaluated as
13693 Emacs Lisp, as shown in the following example.
13699 #+HEADERS: :var data=table[0,0]
13708 @node results, file, var, Specific header arguments
13709 @subsubsection @code{:results}
13711 There are three classes of @code{:results} header argument. Only one option
13712 per class may be supplied per code block.
13716 @b{collection} header arguments specify how the results should be collected
13717 from the code block
13719 @b{type} header arguments specify what type of result the code block will
13720 return---which has implications for how they will be inserted into the
13723 @b{handling} header arguments specify how the results of evaluating the code
13724 block should be handled.
13727 @subsubheading Collection
13728 The following options are mutually exclusive, and specify how the results
13729 should be collected from the code block.
13733 This is the default. The result is the value of the last statement in the
13734 code block. This header argument places the evaluation in functional
13735 mode. Note that in some languages, e.g., Python, use of this result type
13736 requires that a @code{return} statement be included in the body of the source
13737 code block. E.g., @code{:results value}.
13738 @item @code{output}
13739 The result is the collection of everything printed to STDOUT during the
13740 execution of the code block. This header argument places the
13741 evaluation in scripting mode. E.g., @code{:results output}.
13744 @subsubheading Type
13746 The following options are mutually exclusive and specify what type of results
13747 the code block will return. By default, results are inserted as either a
13748 table or scalar depending on their value.
13751 @item @code{table}, @code{vector}
13752 The results should be interpreted as an Org mode table. If a single value is
13753 returned, it will be converted into a table with one row and one column.
13754 E.g., @code{:results value table}.
13756 The results should be interpreted as an Org mode list. If a single scalar
13757 value is returned it will be converted into a list with only one element.
13758 @item @code{scalar}, @code{verbatim}
13759 The results should be interpreted literally---they will not be
13760 converted into a table. The results will be inserted into the Org mode
13761 buffer as quoted text. E.g., @code{:results value verbatim}.
13763 The results will be interpreted as the path to a file, and will be inserted
13764 into the Org mode buffer as a file link. E.g., @code{:results value file}.
13766 The results are interpreted as raw Org mode code and are inserted directly
13767 into the buffer. If the results look like a table they will be aligned as
13768 such by Org mode. E.g., @code{:results value raw}.
13770 The results are will be enclosed in a @code{BEGIN_SRC org} block.
13771 They are not comma-escaped by default but they will be if you hit @kbd{TAB}
13772 in the block and/or if you export the file. E.g., @code{:results value org}.
13774 Results are assumed to be HTML and will be enclosed in a @code{BEGIN_HTML}
13775 block. E.g., @code{:results value html}.
13777 Results assumed to be @LaTeX{} and are enclosed in a @code{BEGIN_LaTeX} block.
13778 E.g., @code{:results value latex}.
13780 Result are assumed to be parsable code and are enclosed in a code block.
13781 E.g., @code{:results value code}.
13783 The result is converted to pretty-printed code and is enclosed in a code
13784 block. This option currently supports Emacs Lisp, Python, and Ruby. E.g.,
13785 @code{:results value pp}.
13786 @item @code{drawer}
13787 The result is wrapped in a RESULTS drawer. This can be useful for
13788 inserting @code{raw} or @code{org} syntax results in such a way that their
13789 extent is known and they can be automatically removed or replaced.
13792 @subsubheading Handling
13793 The following results options indicate what happens with the
13794 results once they are collected.
13797 @item @code{silent}
13798 The results will be echoed in the minibuffer but will not be inserted into
13799 the Org mode buffer. E.g., @code{:results output silent}.
13800 @item @code{replace}
13801 The default value. Any existing results will be removed, and the new results
13802 will be inserted into the Org mode buffer in their place. E.g.,
13803 @code{:results output replace}.
13804 @item @code{append}
13805 If there are pre-existing results of the code block then the new results will
13806 be appended to the existing results. Otherwise the new results will be
13807 inserted as with @code{replace}.
13808 @item @code{prepend}
13809 If there are pre-existing results of the code block then the new results will
13810 be prepended to the existing results. Otherwise the new results will be
13811 inserted as with @code{replace}.
13814 @node file, file-desc, results, Specific header arguments
13815 @subsubsection @code{:file}
13817 The header argument @code{:file} is used to specify an external file in which
13818 to save code block results. After code block evaluation an Org mode style
13819 @code{[[file:]]} link (see @ref{Link format}) to the file will be inserted
13820 into the Org mode buffer. Some languages including R, gnuplot, dot, and
13821 ditaa provide special handling of the @code{:file} header argument
13822 automatically wrapping the code block body in the boilerplate code required
13823 to save output to the specified file. This is often useful for saving
13824 graphical output of a code block to the specified file.
13826 The argument to @code{:file} should be either a string specifying the path to
13827 a file, or a list of two strings in which case the first element of the list
13828 should be the path to a file and the second a description for the link.
13830 @node file-desc, dir, file, Specific header arguments
13831 @subsubsection @code{:file-desc}
13833 The value of the @code{:file-desc} header argument is used to provide a
13834 description for file code block results which are inserted as Org mode links
13835 (see @ref{Link format}). If the @code{:file-desc} header argument is given
13836 with no value the link path will be placed in both the ``link'' and the
13837 ``description'' portion of the Org mode link.
13839 @node dir, exports, file-desc, Specific header arguments
13840 @subsubsection @code{:dir} and remote execution
13842 While the @code{:file} header argument can be used to specify the path to the
13843 output file, @code{:dir} specifies the default directory during code block
13844 execution. If it is absent, then the directory associated with the current
13845 buffer is used. In other words, supplying @code{:dir path} temporarily has
13846 the same effect as changing the current directory with @kbd{M-x cd path}, and
13847 then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets
13848 the value of the Emacs variable @code{default-directory}.
13850 When using @code{:dir}, you should supply a relative path for file output
13851 (e.g., @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which
13852 case that path will be interpreted relative to the default directory.
13854 In other words, if you want your plot to go into a folder called @file{Work}
13855 in your home directory, you could use
13858 #+BEGIN_SRC R :file myplot.png :dir ~/Work
13859 matplot(matrix(rnorm(100), 10), type="l")
13863 @subsubheading Remote execution
13864 A directory on a remote machine can be specified using tramp file syntax, in
13865 which case the code will be evaluated on the remote machine. An example is
13868 #+BEGIN_SRC R :file plot.png :dir /dand@@yakuba.princeton.edu:
13869 plot(1:10, main=system("hostname", intern=TRUE))
13873 Text results will be returned to the local Org mode buffer as usual, and file
13874 output will be created on the remote machine with relative paths interpreted
13875 relative to the remote directory. An Org mode link to the remote file will be
13878 So, in the above example a plot will be created on the remote machine,
13879 and a link of the following form will be inserted in the org buffer:
13882 [[file:/scp:dand@@yakuba.princeton.edu:/home/dand/plot.png][plot.png]]
13885 Most of this functionality follows immediately from the fact that @code{:dir}
13886 sets the value of the Emacs variable @code{default-directory}, thanks to
13887 tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to
13888 install tramp separately in order for these features to work correctly.
13890 @subsubheading Further points
13894 If @code{:dir} is used in conjunction with @code{:session}, although it will
13895 determine the starting directory for a new session as expected, no attempt is
13896 currently made to alter the directory associated with an existing session.
13898 @code{:dir} should typically not be used to create files during export with
13899 @code{:exports results} or @code{:exports both}. The reason is that, in order
13900 to retain portability of exported material between machines, during export
13901 links inserted into the buffer will @emph{not} be expanded against @code{default
13902 directory}. Therefore, if @code{default-directory} is altered using
13903 @code{:dir}, it is probable that the file will be created in a location to
13904 which the link does not point.
13907 @node exports, tangle, dir, Specific header arguments
13908 @subsubsection @code{:exports}
13910 The @code{:exports} header argument specifies what should be included in HTML
13911 or @LaTeX{} exports of the Org mode file.
13915 The default. The body of code is included into the exported file. E.g.,
13916 @code{:exports code}.
13917 @item @code{results}
13918 The result of evaluating the code is included in the exported file. E.g.,
13919 @code{:exports results}.
13921 Both the code and results are included in the exported file. E.g.,
13922 @code{:exports both}.
13924 Nothing is included in the exported file. E.g., @code{:exports none}.
13927 @node tangle, mkdirp, exports, Specific header arguments
13928 @subsubsection @code{:tangle}
13930 The @code{:tangle} header argument specifies whether or not the code
13931 block should be included in tangled extraction of source code files.
13934 @item @code{tangle}
13935 The code block is exported to a source code file named after the full path
13936 (including the directory) and file name (w/o extension) of the Org mode file.
13937 E.g., @code{:tangle yes}.
13939 The default. The code block is not exported to a source code file.
13940 E.g., @code{:tangle no}.
13942 Any other string passed to the @code{:tangle} header argument is interpreted
13943 as a path (directory and file name relative to the directory of the Org mode
13944 file) to which the block will be exported. E.g., @code{:tangle path}.
13947 @node mkdirp, comments, tangle, Specific header arguments
13948 @subsubsection @code{:mkdirp}
13950 The @code{:mkdirp} header argument can be used to create parent directories
13951 of tangled files when missing. This can be set to @code{yes} to enable
13952 directory creation or to @code{no} to inhibit directory creation.
13954 @node comments, padline, mkdirp, Specific header arguments
13955 @subsubsection @code{:comments}
13956 By default code blocks are tangled to source-code files without any insertion
13957 of comments beyond those which may already exist in the body of the code
13958 block. The @code{:comments} header argument can be set as follows to control
13959 the insertion of extra comments into the tangled code file.
13963 The default. No extra comments are inserted during tangling.
13965 The code block is wrapped in comments which contain pointers back to the
13966 original Org file from which the code was tangled.
13968 A synonym for ``link'' to maintain backwards compatibility.
13970 Include text from the Org mode file as a comment.
13972 The text is picked from the leading context of the tangled code and is
13973 limited by the nearest headline or source block as the case may be.
13975 Turns on both the ``link'' and ``org'' comment options.
13977 Turns on the ``link'' comment option, and additionally wraps expanded noweb
13978 references in the code block body in link comments.
13981 @node padline, no-expand, comments, Specific header arguments
13982 @subsubsection @code{:padline}
13983 Control in insertion of padding lines around code block bodies in tangled
13984 code files. The default value is @code{yes} which results in insertion of
13985 newlines before and after each tangled code block. The following arguments
13990 Insert newlines before and after each code block body in tangled code files.
13992 Do not insert any newline padding in tangled output.
13995 @node no-expand, session, padline, Specific header arguments
13996 @subsubsection @code{:no-expand}
13998 By default, code blocks are expanded with @code{org-babel-expand-src-block}
13999 during tangling. This has the effect of assigning values to variables
14000 specified with @code{:var} (see @ref{var}), and of replacing ``noweb''
14001 references (see @ref{Noweb reference syntax}) with their targets. The
14002 @code{:no-expand} header argument can be used to turn off this behavior.
14004 @node session, noweb, no-expand, Specific header arguments
14005 @subsubsection @code{:session}
14007 The @code{:session} header argument starts a session for an interpreted
14008 language where state is preserved.
14010 By default, a session is not started.
14012 A string passed to the @code{:session} header argument will give the session
14013 a name. This makes it possible to run concurrent sessions for each
14014 interpreted language.
14016 @node noweb, noweb-ref, session, Specific header arguments
14017 @subsubsection @code{:noweb}
14019 The @code{:noweb} header argument controls expansion of ``noweb'' syntax
14020 references (see @ref{Noweb reference syntax}) when the code block is
14021 evaluated, tangled, or exported. The @code{:noweb} header argument can have
14022 one of the five values: @code{no}, @code{yes}, @code{tangle}, or
14023 @code{no-export} @code{strip-export}.
14027 The default. ``Noweb'' syntax references in the body of the code block will
14028 not be expanded before the code block is evaluated, tangled or exported.
14030 ``Noweb'' syntax references in the body of the code block will be
14031 expanded before the code block is evaluated, tangled or exported.
14032 @item @code{tangle}
14033 ``Noweb'' syntax references in the body of the code block will be expanded
14034 before the code block is tangled. However, ``noweb'' syntax references will
14035 not be expanded when the code block is evaluated or exported.
14036 @item @code{no-export}
14037 ``Noweb'' syntax references in the body of the code block will be expanded
14038 before the block is evaluated or tangled. However, ``noweb'' syntax
14039 references will not be expanded when the code block is exported.
14040 @item @code{strip-export}
14041 ``Noweb'' syntax references in the body of the code block will be expanded
14042 before the block is evaluated or tangled. However, ``noweb'' syntax
14043 references will not be removed when the code block is exported.
14045 ``Noweb'' syntax references in the body of the code block will only be
14046 expanded before the block is evaluated.
14049 @subsubheading Noweb prefix lines
14050 Noweb insertions are now placed behind the line prefix of the
14051 @code{<<reference>>}.
14052 This behavior is illustrated in the following example. Because the
14053 @code{<<example>>} noweb reference appears behind the SQL comment syntax,
14054 each line of the expanded noweb reference will be commented.
14066 -- multi-line body of example
14069 Note that noweb replacement text that does not contain any newlines will not
14070 be affected by this change, so it is still possible to use inline noweb
14073 @node noweb-ref, noweb-sep, noweb, Specific header arguments
14074 @subsubsection @code{:noweb-ref}
14075 When expanding ``noweb'' style references the bodies of all code block with
14076 @emph{either} a block name matching the reference name @emph{or} a
14077 @code{:noweb-ref} header argument matching the reference name will be
14078 concatenated together to form the replacement text.
14080 By setting this header argument at the sub-tree or file level, simple code
14081 block concatenation may be achieved. For example, when tangling the
14082 following Org mode file, the bodies of code blocks will be concatenated into
14083 the resulting pure code file@footnote{(The example needs property inheritance
14084 to be turned on for the @code{noweb-ref} property, see @ref{Property
14088 #+BEGIN_SRC sh :tangle yes :noweb yes :shebang #!/bin/sh
14091 * the mount point of the fullest disk
14093 :noweb-ref: fullest-disk
14096 ** query all mounted disks
14101 ** strip the header row
14106 ** sort by the percent full
14108 |awk '@{print $5 " " $6@}'|sort -n |tail -1 \
14111 ** extract the mount point
14113 |awk '@{print $2@}'
14117 The @code{:noweb-sep} (see @ref{noweb-sep}) header argument holds the string
14118 used to separate accumulate noweb references like those above. By default a
14121 @node noweb-sep, cache, noweb-ref, Specific header arguments
14122 @subsubsection @code{:noweb-sep}
14124 The @code{:noweb-sep} header argument holds the string used to separate
14125 accumulate noweb references (see @ref{noweb-ref}). By default a newline is
14128 @node cache, sep, noweb-sep, Specific header arguments
14129 @subsubsection @code{:cache}
14131 The @code{:cache} header argument controls the use of in-buffer caching of
14132 the results of evaluating code blocks. It can be used to avoid re-evaluating
14133 unchanged code blocks. Note that the @code{:cache} header argument will not
14134 attempt to cache results when the @code{:session} header argument is used,
14135 because the results of the code block execution may be stored in the session
14136 outside of the Org mode buffer. The @code{:cache} header argument can have
14137 one of two values: @code{yes} or @code{no}.
14141 The default. No caching takes place, and the code block will be evaluated
14142 every time it is called.
14144 Every time the code block is run a SHA1 hash of the code and arguments
14145 passed to the block will be generated. This hash is packed into the
14146 @code{#+RESULTS:} line and will be checked on subsequent
14147 executions of the code block. If the code block has not
14148 changed since the last time it was evaluated, it will not be re-evaluated.
14151 Code block caches notice if the value of a variable argument
14152 to the code block has changed. If this is the case, the cache is
14153 invalidated and the code block is re-run. In the following example,
14154 @code{caller} will not be re-run unless the results of @code{random} have
14155 changed since it was last run.
14159 #+BEGIN_SRC R :cache yes
14163 #+RESULTS[a2a72cd647ad44515fab62e144796432793d68e1]: random
14167 #+BEGIN_SRC emacs-lisp :var x=random :cache yes
14171 #+RESULTS[bec9c8724e397d5df3b696502df3ed7892fc4f5f]: caller
14175 @node sep, hlines, cache, Specific header arguments
14176 @subsubsection @code{:sep}
14178 The @code{:sep} header argument can be used to control the delimiter used
14179 when writing tabular results out to files external to Org mode. This is used
14180 either when opening tabular results of a code block by calling the
14181 @code{org-open-at-point} function bound to @kbd{C-c C-o} on the code block,
14182 or when writing code block results to an external file (see @ref{file})
14185 By default, when @code{:sep} is not specified output tables are tab
14188 @node hlines, colnames, sep, Specific header arguments
14189 @subsubsection @code{:hlines}
14191 Tables are frequently represented with one or more horizontal lines, or
14192 hlines. The @code{:hlines} argument to a code block accepts the
14193 values @code{yes} or @code{no}, with a default value of @code{no}.
14197 Strips horizontal lines from the input table. In most languages this is the
14198 desired effect because an @code{hline} symbol is interpreted as an unbound
14199 variable and raises an error. Setting @code{:hlines no} or relying on the
14200 default value yields the following results.
14203 #+TBLNAME: many-cols
14211 #+BEGIN_SRC python :var tab=many-cols
14215 #+RESULTS: echo-table
14222 Leaves hlines in the table. Setting @code{:hlines yes} has this effect.
14225 #+TBLNAME: many-cols
14233 #+BEGIN_SRC python :var tab=many-cols :hlines yes
14237 #+RESULTS: echo-table
14246 @node colnames, rownames, hlines, Specific header arguments
14247 @subsubsection @code{:colnames}
14249 The @code{:colnames} header argument accepts the values @code{yes},
14250 @code{no}, or @code{nil} for unassigned. The default value is @code{nil}.
14251 Note that the behavior of the @code{:colnames} header argument may differ
14252 across languages. For example Emacs Lisp code blocks ignore the
14253 @code{:colnames} header argument entirely given the ease with which tables
14254 with column names may be handled directly in Emacs Lisp.
14258 If an input table looks like it has column names
14259 (because its second row is an hline), then the column
14260 names will be removed from the table before
14261 processing, then reapplied to the results.
14264 #+TBLNAME: less-cols
14270 #+NAME: echo-table-again
14271 #+BEGIN_SRC python :var tab=less-cols
14272 return [[val + '*' for val in row] for row in tab]
14275 #+RESULTS: echo-table-again
14282 Please note that column names are not removed before the table is indexed
14283 using variable indexing @xref{var, Indexable variable values}.
14286 No column name pre-processing takes place
14289 Column names are removed and reapplied as with @code{nil} even if the table
14290 does not ``look like'' it has column names (i.e., the second row is not an
14294 @node rownames, shebang, colnames, Specific header arguments
14295 @subsubsection @code{:rownames}
14297 The @code{:rownames} header argument can take on the values @code{yes}
14298 or @code{no}, with a default value of @code{no}.
14302 No row name pre-processing will take place.
14305 The first column of the table is removed from the table before processing,
14306 and is then reapplied to the results.
14309 #+TBLNAME: with-rownames
14310 | one | 1 | 2 | 3 | 4 | 5 |
14311 | two | 6 | 7 | 8 | 9 | 10 |
14313 #+NAME: echo-table-once-again
14314 #+BEGIN_SRC python :var tab=with-rownames :rownames yes
14315 return [[val + 10 for val in row] for row in tab]
14318 #+RESULTS: echo-table-once-again
14319 | one | 11 | 12 | 13 | 14 | 15 |
14320 | two | 16 | 17 | 18 | 19 | 20 |
14323 Please note that row names are not removed before the table is indexed using
14324 variable indexing @xref{var, Indexable variable values}.
14328 @node shebang, eval, rownames, Specific header arguments
14329 @subsubsection @code{:shebang}
14331 Setting the @code{:shebang} header argument to a string value
14332 (e.g., @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the
14333 first line of any tangled file holding the code block, and the file
14334 permissions of the tangled file are set to make it executable.
14336 @node eval, wrap, shebang, Specific header arguments
14337 @subsubsection @code{:eval}
14338 The @code{:eval} header argument can be used to limit the evaluation of
14339 specific code blocks. The @code{:eval} header argument can be useful for
14340 protecting against the evaluation of dangerous code blocks or to ensure that
14341 evaluation will require a query regardless of the value of the
14342 @code{org-confirm-babel-evaluate} variable. The possible values of
14343 @code{:eval} and their effects are shown below.
14347 The code block will not be evaluated under any circumstances.
14349 Evaluation of the code block will require a query.
14350 @item never-export or no-export
14351 The code block will not be evaluated during export but may still be called
14354 Evaluation of the code block during export will require a query.
14357 If this header argument is not set then evaluation is determined by the value
14358 of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation
14361 @node wrap, , eval, Specific header arguments
14362 @subsubsection @code{:wrap}
14363 The @code{:wrap} header argument is used to mark the results of source block
14364 evaluation. The header argument can be passed a string that will be appended
14365 to @code{#+BEGIN_} and @code{#+END_}, which will then be used to wrap the
14366 results. If not string is specified then the results will be wrapped in a
14367 @code{#+BEGIN/END_RESULTS} block.
14369 @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code
14370 @section Results of evaluation
14371 @cindex code block, results of evaluation
14372 @cindex source code, results of evaluation
14374 The way in which results are handled depends on whether a session is invoked,
14375 as well as on whether @code{:results value} or @code{:results output} is
14376 used. The following table shows the table possibilities. For a full listing
14377 of the possible results header arguments see @ref{results}.
14379 @multitable @columnfractions 0.26 0.33 0.41
14380 @item @tab @b{Non-session} @tab @b{Session}
14381 @item @code{:results value} @tab value of last expression @tab value of last expression
14382 @item @code{:results output} @tab contents of STDOUT @tab concatenation of interpreter output
14385 Note: With @code{:results value}, the result in both @code{:session} and
14386 non-session is returned to Org mode as a table (a one- or two-dimensional
14387 vector of strings or numbers) when appropriate.
14389 @subsection Non-session
14390 @subsubsection @code{:results value}
14391 This is the default. Internally, the value is obtained by wrapping the code
14392 in a function definition in the external language, and evaluating that
14393 function. Therefore, code should be written as if it were the body of such a
14394 function. In particular, note that Python does not automatically return a
14395 value from a function unless a @code{return} statement is present, and so a
14396 @samp{return} statement will usually be required in Python.
14398 This is the only one of the four evaluation contexts in which the code is
14399 automatically wrapped in a function definition.
14401 @subsubsection @code{:results output}
14402 The code is passed to the interpreter as an external process, and the
14403 contents of the standard output stream are returned as text. (In certain
14404 languages this also contains the error output stream; this is an area for
14407 @subsection Session
14408 @subsubsection @code{:results value}
14409 The code is passed to an interpreter running as an interactive Emacs inferior
14410 process. Only languages which provide tools for interactive evaluation of
14411 code have session support, so some language (e.g., C and ditaa) do not
14412 support the @code{:session} header argument, and in other languages (e.g.,
14413 Python and Haskell) which have limitations on the code which may be entered
14414 into interactive sessions, those limitations apply to the code in code blocks
14415 using the @code{:session} header argument as well.
14417 Unless the @code{:results output} option is supplied (see below) the result
14418 returned is the result of the last evaluation performed by the
14419 interpreter. (This is obtained in a language-specific manner: the value of
14420 the variable @code{_} in Python and Ruby, and the value of @code{.Last.value}
14423 @subsubsection @code{:results output}
14424 The code is passed to the interpreter running as an interactive Emacs
14425 inferior process. The result returned is the concatenation of the sequence of
14426 (text) output from the interactive interpreter. Notice that this is not
14427 necessarily the same as what would be sent to @code{STDOUT} if the same code
14428 were passed to a non-interactive interpreter running as an external
14429 process. For example, compare the following two blocks:
14432 #+BEGIN_SRC python :results output
14443 In non-session mode, the `2' is not printed and does not appear.
14446 #+BEGIN_SRC python :results output :session
14458 But in @code{:session} mode, the interactive interpreter receives input `2'
14459 and prints out its value, `2'. (Indeed, the other print statements are
14462 @node Noweb reference syntax, Key bindings and useful functions, Results of evaluation, Working With Source Code
14463 @section Noweb reference syntax
14464 @cindex code block, noweb reference
14465 @cindex syntax, noweb
14466 @cindex source code, noweb reference
14468 The ``noweb'' (see @uref{http://www.cs.tufts.edu/~nr/noweb/}) Literate
14469 Programming system allows named blocks of code to be referenced by using the
14470 familiar Noweb syntax:
14473 <<code-block-name>>
14476 When a code block is tangled or evaluated, whether or not ``noweb''
14477 references are expanded depends upon the value of the @code{:noweb} header
14478 argument. If @code{:noweb yes}, then a Noweb reference is expanded before
14479 evaluation. If @code{:noweb no}, the default, then the reference is not
14480 expanded before evaluation. See the @ref{noweb-ref} header argument for
14481 a more flexible way to resolve noweb references.
14483 It is possible to include the @emph{results} of a code block rather than the
14484 body. This is done by appending parenthesis to the code block name which may
14485 optionally contain arguments to the code block as shown below.
14488 <<code-block-name(optional arguments)>>
14491 Note: the default value, @code{:noweb no}, was chosen to ensure that
14492 correct code is not broken in a language, such as Ruby, where
14493 @code{<<arg>>} is a syntactically valid construct. If @code{<<arg>>} is not
14494 syntactically valid in languages that you use, then please consider setting
14497 Note: if noweb tangling is slow in large Org mode files consider setting the
14498 @code{*org-babel-use-quick-and-dirty-noweb-expansion*} variable to true.
14499 This will result in faster noweb reference resolution at the expense of not
14500 correctly resolving inherited values of the @code{:noweb-ref} header
14503 @node Key bindings and useful functions, Batch execution, Noweb reference syntax, Working With Source Code
14504 @section Key bindings and useful functions
14505 @cindex code block, key bindings
14507 Many common Org mode key sequences are re-bound depending on
14510 Within a code block, the following key bindings
14513 @multitable @columnfractions 0.25 0.75
14515 @item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block}
14517 @item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result}
14519 @item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session}
14521 @item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session}
14524 In an Org mode buffer, the following key bindings are active:
14526 @multitable @columnfractions 0.45 0.55
14528 @kindex C-c C-v C-p
14529 @item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-previous-src-block}
14531 @kindex C-c C-v C-n
14532 @item @kbd{C-c C-v n} @ @ @r{or} @ @ @kbd{C-c C-v C-n} @tab @code{org-babel-next-src-block}
14534 @kindex C-c C-v C-e
14535 @item @kbd{C-c C-v e} @ @ @r{or} @ @ @kbd{C-c C-v C-e} @tab @code{org-babel-execute-maybe}
14537 @kindex C-c C-v C-o
14538 @item @kbd{C-c C-v o} @ @ @r{or} @ @ @kbd{C-c C-v C-o} @tab @code{org-babel-open-src-block-result}
14540 @kindex C-c C-v C-v
14541 @item @kbd{C-c C-v v} @ @ @r{or} @ @ @kbd{C-c C-v C-v} @tab @code{org-babel-expand-src-block}
14543 @kindex C-c C-v C-u
14544 @item @kbd{C-c C-v u} @ @ @r{or} @ @ @kbd{C-c C-v C-u} @tab @code{org-babel-goto-src-block-head}
14546 @kindex C-c C-v C-g
14547 @item @kbd{C-c C-v g} @ @ @r{or} @ @ @kbd{C-c C-v C-g} @tab @code{org-babel-goto-named-src-block}
14549 @kindex C-c C-v C-r
14550 @item @kbd{C-c C-v r} @ @ @r{or} @ @ @kbd{C-c C-v C-r} @tab @code{org-babel-goto-named-result}
14552 @kindex C-c C-v C-b
14553 @item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14555 @kindex C-c C-v C-s
14556 @item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14558 @kindex C-c C-v C-d
14559 @item @kbd{C-c C-v d} @ @ @r{or} @ @ @kbd{C-c C-v C-d} @tab @code{org-babel-demarcate-block}
14561 @kindex C-c C-v C-t
14562 @item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14564 @kindex C-c C-v C-f
14565 @item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14567 @kindex C-c C-v C-c
14568 @item @kbd{C-c C-v c} @ @ @r{or} @ @ @kbd{C-c C-v C-c} @tab @code{org-babel-check-src-block}
14570 @kindex C-c C-v C-j
14571 @item @kbd{C-c C-v j} @ @ @r{or} @ @ @kbd{C-c C-v C-j} @tab @code{org-babel-insert-header-arg}
14573 @kindex C-c C-v C-l
14574 @item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-load-in-session}
14576 @kindex C-c C-v C-i
14577 @item @kbd{C-c C-v i} @ @ @r{or} @ @ @kbd{C-c C-v C-i} @tab @code{org-babel-lob-ingest}
14579 @kindex C-c C-v C-I
14580 @item @kbd{C-c C-v I} @ @ @r{or} @ @ @kbd{C-c C-v C-I} @tab @code{org-babel-view-src-block-info}
14582 @kindex C-c C-v C-z
14583 @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}
14585 @kindex C-c C-v C-a
14586 @item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14588 @kindex C-c C-v C-h
14589 @item @kbd{C-c C-v h} @ @ @r{or} @ @ @kbd{C-c C-v C-h} @tab @code{org-babel-describe-bindings}
14591 @kindex C-c C-v C-x
14592 @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}
14595 @c When possible these keybindings were extended to work when the control key is
14596 @c kept pressed, resulting in the following additional keybindings.
14598 @c @multitable @columnfractions 0.25 0.75
14599 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
14600 @c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer}
14601 @c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file}
14602 @c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest}
14603 @c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block}
14604 @c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree}
14605 @c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle}
14606 @c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session}
14609 @node Batch execution, , Key bindings and useful functions, Working With Source Code
14610 @section Batch execution
14611 @cindex code block, batch execution
14612 @cindex source code, batch execution
14614 It is possible to call functions from the command line. This shell
14615 script calls @code{org-babel-tangle} on every one of its arguments.
14617 Be sure to adjust the paths to fit your system.
14621 # -*- mode: shell-script -*-
14623 # tangle files with org-mode
14628 # wrap each argument in the code required to call tangle on it
14630 FILES="$FILES \"$i\""
14635 (add-to-list 'load-path (expand-file-name \"~/src/org/lisp/\"))
14636 (add-to-list 'load-path (expand-file-name \"~/src/org/contrib/lisp/\" t))
14637 (require 'org)(require 'org-exp)(require 'ob)(require 'ob-tangle)
14638 (mapc (lambda (file)
14639 (find-file (expand-file-name file \"$DIR\"))
14641 (kill-buffer)) '($FILES)))" 2>&1 |grep tangled
14644 @node Miscellaneous, Hacking, Working With Source Code, Top
14645 @chapter Miscellaneous
14648 * Completion:: M-TAB knows what you need
14649 * Easy Templates:: Quick insertion of structural elements
14650 * Speed keys:: Electric commands at the beginning of a headline
14651 * Code evaluation security:: Org mode files evaluate inline code
14652 * Customization:: Adapting Org to your taste
14653 * In-buffer settings:: Overview of the #+KEYWORDS
14654 * The very busy C-c C-c key:: When in doubt, press C-c C-c
14655 * Clean view:: Getting rid of leading stars in the outline
14656 * TTY keys:: Using Org on a tty
14657 * Interaction:: Other Emacs packages
14658 * org-crypt.el:: Encrypting Org files
14662 @node Completion, Easy Templates, Miscellaneous, Miscellaneous
14663 @section Completion
14664 @cindex completion, of @TeX{} symbols
14665 @cindex completion, of TODO keywords
14666 @cindex completion, of dictionary words
14667 @cindex completion, of option keywords
14668 @cindex completion, of tags
14669 @cindex completion, of property keys
14670 @cindex completion, of link abbreviations
14671 @cindex @TeX{} symbol completion
14672 @cindex TODO keywords completion
14673 @cindex dictionary word completion
14674 @cindex option keyword completion
14675 @cindex tag completion
14676 @cindex link abbreviations, completion of
14678 Emacs would not be Emacs without completion, and Org mode uses it whenever it
14679 makes sense. If you prefer an @i{iswitchb}- or @i{ido}-like interface for
14680 some of the completion prompts, you can specify your preference by setting at
14681 most one of the variables @code{org-completion-use-iswitchb}
14682 @code{org-completion-use-ido}.
14684 Org supports in-buffer completion. This type of completion does
14685 not make use of the minibuffer. You simply type a few letters into
14686 the buffer and use the key to complete text right there.
14689 @kindex M-@key{TAB}
14691 Complete word at point
14694 At the beginning of a headline, complete TODO keywords.
14696 After @samp{\}, complete @TeX{} symbols supported by the exporter.
14698 After @samp{*}, complete headlines in the current buffer so that they
14699 can be used in search links like @samp{[[*find this headline]]}.
14701 After @samp{:} in a headline, complete tags. The list of tags is taken
14702 from the variable @code{org-tag-alist} (possibly set through the
14703 @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created
14704 dynamically from all tags used in the current buffer.
14706 After @samp{:} and not in a headline, complete property keys. The list
14707 of keys is constructed dynamically from all keys used in the current
14710 After @samp{[}, complete link abbreviations (@pxref{Link abbreviations}).
14712 After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or
14713 @samp{OPTIONS} which set file-specific options for Org mode. When the
14714 option keyword is already complete, pressing @kbd{M-@key{TAB}} again
14715 will insert example settings for this keyword.
14717 In the line after @samp{#+STARTUP: }, complete startup keywords,
14718 i.e., valid keys for this line.
14720 Elsewhere, complete dictionary words using Ispell.
14724 @node Easy Templates, Speed keys, Completion, Miscellaneous
14725 @section Easy Templates
14726 @cindex template insertion
14727 @cindex insertion, of templates
14729 Org mode supports insertion of empty structural elements (like
14730 @code{#+BEGIN_SRC} and @code{#+END_SRC} pairs) with just a few key
14731 strokes. This is achieved through a native template expansion mechanism.
14732 Note that Emacs has several other template mechanisms which could be used in
14733 a similar way, for example @file{yasnippet}.
14735 To insert a structural element, type a @samp{<}, followed by a template
14736 selector and @kbd{@key{TAB}}. Completion takes effect only when the above
14737 keystrokes are typed on a line by itself.
14739 The following template selectors are currently supported.
14741 @multitable @columnfractions 0.1 0.9
14742 @item @kbd{s} @tab @code{#+BEGIN_SRC ... #+END_SRC}
14743 @item @kbd{e} @tab @code{#+BEGIN_EXAMPLE ... #+END_EXAMPLE}
14744 @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE}
14745 @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE}
14746 @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER}
14747 @item @kbd{l} @tab @code{#+BEGIN_LaTeX ... #+END_LaTeX}
14748 @item @kbd{L} @tab @code{#+LaTeX:}
14749 @item @kbd{h} @tab @code{#+BEGIN_HTML ... #+END_HTML}
14750 @item @kbd{H} @tab @code{#+HTML:}
14751 @item @kbd{a} @tab @code{#+BEGIN_ASCII ... #+END_ASCII}
14752 @item @kbd{A} @tab @code{#+ASCII:}
14753 @item @kbd{i} @tab @code{#+INDEX:} line
14754 @item @kbd{I} @tab @code{#+INCLUDE:} line
14757 For example, on an empty line, typing "<e" and then pressing TAB, will expand
14758 into a complete EXAMPLE template.
14760 You can install additional templates by customizing the variable
14761 @code{org-structure-template-alist}. See the docstring of the variable for
14762 additional details.
14764 @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous
14765 @section Speed keys
14767 @vindex org-use-speed-commands
14768 @vindex org-speed-commands-user
14770 Single keys can be made to execute commands when the cursor is at the
14771 beginning of a headline, i.e., before the first star. Configure the variable
14772 @code{org-use-speed-commands} to activate this feature. There is a
14773 pre-defined list of commands, and you can add more such commands using the
14774 variable @code{org-speed-commands-user}. Speed keys do not only speed up
14775 navigation and other commands, but they also provide an alternative way to
14776 execute commands bound to keys that are not or not easily available on a TTY,
14777 or on a small mobile device with a limited keyboard.
14779 To see which commands are available, activate the feature and press @kbd{?}
14780 with the cursor at the beginning of a headline.
14782 @node Code evaluation security, Customization, Speed keys, Miscellaneous
14783 @section Code evaluation and security issues
14785 Org provides tools to work with the code snippets, including evaluating them.
14787 Running code on your machine always comes with a security risk. Badly
14788 written or malicious code can be executed on purpose or by accident. Org has
14789 default settings which will only evaluate such code if you give explicit
14790 permission to do so, and as a casual user of these features you should leave
14791 these precautions intact.
14793 For people who regularly work with such code, the confirmation prompts can
14794 become annoying, and you might want to turn them off. This can be done, but
14795 you must be aware of the risks that are involved.
14797 Code evaluation can happen under the following circumstances:
14800 @item Source code blocks
14801 Source code blocks can be evaluated during export, or when pressing @kbd{C-c
14802 C-c} in the block. The most important thing to realize here is that Org mode
14803 files which contain code snippets are, in a certain sense, like executable
14804 files. So you should accept them and load them into Emacs only from trusted
14805 sources---just like you would do with a program you install on your computer.
14807 Make sure you know what you are doing before customizing the variables
14808 which take off the default security brakes.
14810 @defopt org-confirm-babel-evaluate
14811 When t (the default), the user is asked before every code block evaluation.
14812 When nil, the user is not asked. When set to a function, it is called with
14813 two arguments (language and body of the code block) and should return t to
14814 ask and nil not to ask.
14817 For example, here is how to execute "ditaa" code (which is considered safe)
14821 (defun my-org-confirm-babel-evaluate (lang body)
14822 (not (string= lang "ditaa"))) ; don't ask for ditaa
14823 (setq org-confirm-babel-evaluate 'my-org-confirm-babel-evaluate)
14826 @item Following @code{shell} and @code{elisp} links
14827 Org has two link types that can directly evaluate code (@pxref{External
14828 links}). These links can be problematic because the code to be evaluated is
14831 @defopt org-confirm-shell-link-function
14832 Function to queries user about shell link execution.
14834 @defopt org-confirm-elisp-link-function
14835 Functions to query user for Emacs Lisp link execution.
14838 @item Formulas in tables
14839 Formulas in tables (@pxref{The spreadsheet}) are code that is evaluated
14840 either by the @i{calc} interpreter, or by the @i{Emacs Lisp} interpreter.
14843 @node Customization, In-buffer settings, Code evaluation security, Miscellaneous
14844 @section Customization
14845 @cindex customization
14846 @cindex options, for customization
14847 @cindex variables, for customization
14849 There are more than 500 variables that can be used to customize
14850 Org. For the sake of compactness of the manual, I am not
14851 describing the variables here. A structured overview of customization
14852 variables is available with @kbd{M-x org-customize}. Or select
14853 @code{Browse Org Group} from the @code{Org->Customization} menu. Many
14854 settings can also be activated on a per-file basis, by putting special
14855 lines into the buffer (@pxref{In-buffer settings}).
14857 @node In-buffer settings, The very busy C-c C-c key, Customization, Miscellaneous
14858 @section Summary of in-buffer settings
14859 @cindex in-buffer settings
14860 @cindex special keywords
14862 Org mode uses special lines in the buffer to define settings on a
14863 per-file basis. These lines start with a @samp{#+} followed by a
14864 keyword, a colon, and then individual words defining a setting. Several
14865 setting words can be in the same line, but you can also have multiple
14866 lines for the keyword. While these settings are described throughout
14867 the manual, here is a summary. After changing any of those lines in the
14868 buffer, press @kbd{C-c C-c} with the cursor still in the line to
14869 activate the changes immediately. Otherwise they become effective only
14870 when the file is visited again in a new Emacs session.
14872 @vindex org-archive-location
14874 @item #+ARCHIVE: %s_done::
14875 This line sets the archive location for the agenda file. It applies for
14876 all subsequent lines until the next @samp{#+ARCHIVE} line, or the end
14877 of the file. The first such line also applies to any entries before it.
14878 The corresponding variable is @code{org-archive-location}.
14880 This line sets the category for the agenda file. The category applies
14881 for all subsequent lines until the next @samp{#+CATEGORY} line, or the
14882 end of the file. The first such line also applies to any entries before it.
14883 @item #+COLUMNS: %25ITEM .....
14884 @cindex property, COLUMNS
14885 Set the default format for columns view. This format applies when
14886 columns view is invoked in locations where no @code{COLUMNS} property
14888 @item #+CONSTANTS: name1=value1 ...
14889 @vindex org-table-formula-constants
14890 @vindex org-table-formula
14891 Set file-local values for constants to be used in table formulas. This
14892 line sets the local variable @code{org-table-formula-constants-local}.
14893 The global version of this variable is
14894 @code{org-table-formula-constants}.
14895 @item #+FILETAGS: :tag1:tag2:tag3:
14896 Set tags that can be inherited by any entry in the file, including the
14898 @item #+DRAWERS: NAME1 .....
14899 @vindex org-drawers
14900 Set the file-local set of additional drawers. The corresponding global
14901 variable is @code{org-drawers}.
14902 @item #+LINK: linkword replace
14903 @vindex org-link-abbrev-alist
14904 These lines (several are allowed) specify link abbreviations.
14905 @xref{Link abbreviations}. The corresponding variable is
14906 @code{org-link-abbrev-alist}.
14907 @item #+PRIORITIES: highest lowest default
14908 @vindex org-highest-priority
14909 @vindex org-lowest-priority
14910 @vindex org-default-priority
14911 This line sets the limits and the default for the priorities. All three
14912 must be either letters A--Z or numbers 0--9. The highest priority must
14913 have a lower ASCII number than the lowest priority.
14914 @item #+PROPERTY: Property_Name Value
14915 This line sets a default inheritance value for entries in the current
14916 buffer, most useful for specifying the allowed values of a property.
14917 @cindex #+SETUPFILE
14918 @item #+SETUPFILE: file
14919 This line defines a file that holds more in-buffer setup. Normally this is
14920 entirely ignored. Only when the buffer is parsed for option-setting lines
14921 (i.e., when starting Org mode for a file, when pressing @kbd{C-c C-c} in a
14922 settings line, or when exporting), then the contents of this file are parsed
14923 as if they had been included in the buffer. In particular, the file can be
14924 any other Org mode file with internal setup. You can visit the file the
14925 cursor is in the line with @kbd{C-c '}.
14928 This line sets options to be used at startup of Org mode, when an
14929 Org file is being visited.
14931 The first set of options deals with the initial visibility of the outline
14932 tree. The corresponding variable for global default settings is
14933 @code{org-startup-folded}, with a default value @code{t}, which means
14935 @vindex org-startup-folded
14936 @cindex @code{overview}, STARTUP keyword
14937 @cindex @code{content}, STARTUP keyword
14938 @cindex @code{showall}, STARTUP keyword
14939 @cindex @code{showeverything}, STARTUP keyword
14941 overview @r{top-level headlines only}
14942 content @r{all headlines}
14943 showall @r{no folding of any entries}
14944 showeverything @r{show even drawer contents}
14947 @vindex org-startup-indented
14948 @cindex @code{indent}, STARTUP keyword
14949 @cindex @code{noindent}, STARTUP keyword
14950 Dynamic virtual indentation is controlled by the variable
14951 @code{org-startup-indented}@footnote{Emacs 23 and Org mode 6.29 are required}
14953 indent @r{start with @code{org-indent-mode} turned on}
14954 noindent @r{start with @code{org-indent-mode} turned off}
14957 @vindex org-startup-align-all-tables
14958 Then there are options for aligning tables upon visiting a file. This
14959 is useful in files containing narrowed table columns. The corresponding
14960 variable is @code{org-startup-align-all-tables}, with a default value
14962 @cindex @code{align}, STARTUP keyword
14963 @cindex @code{noalign}, STARTUP keyword
14965 align @r{align all tables}
14966 noalign @r{don't align tables on startup}
14969 @vindex org-startup-with-inline-images
14970 When visiting a file, inline images can be automatically displayed. The
14971 corresponding variable is @code{org-startup-with-inline-images}, with a
14972 default value @code{nil} to avoid delays when visiting a file.
14973 @cindex @code{inlineimages}, STARTUP keyword
14974 @cindex @code{noinlineimages}, STARTUP keyword
14976 inlineimages @r{show inline images}
14977 noinlineimages @r{don't show inline images on startup}
14980 @vindex org-log-done
14981 @vindex org-log-note-clock-out
14982 @vindex org-log-repeat
14983 Logging the closing and reopening of TODO items and clock intervals can be
14984 configured using these options (see variables @code{org-log-done},
14985 @code{org-log-note-clock-out} and @code{org-log-repeat})
14986 @cindex @code{logdone}, STARTUP keyword
14987 @cindex @code{lognotedone}, STARTUP keyword
14988 @cindex @code{nologdone}, STARTUP keyword
14989 @cindex @code{lognoteclock-out}, STARTUP keyword
14990 @cindex @code{nolognoteclock-out}, STARTUP keyword
14991 @cindex @code{logrepeat}, STARTUP keyword
14992 @cindex @code{lognoterepeat}, STARTUP keyword
14993 @cindex @code{nologrepeat}, STARTUP keyword
14994 @cindex @code{logreschedule}, STARTUP keyword
14995 @cindex @code{lognotereschedule}, STARTUP keyword
14996 @cindex @code{nologreschedule}, STARTUP keyword
14997 @cindex @code{logredeadline}, STARTUP keyword
14998 @cindex @code{lognoteredeadline}, STARTUP keyword
14999 @cindex @code{nologredeadline}, STARTUP keyword
15000 @cindex @code{logrefile}, STARTUP keyword
15001 @cindex @code{lognoterefile}, STARTUP keyword
15002 @cindex @code{nologrefile}, STARTUP keyword
15003 @cindex @code{logdrawer}, STARTUP keyword
15004 @cindex @code{nologdrawer}, STARTUP keyword
15005 @cindex @code{logstatesreversed}, STARTUP keyword
15006 @cindex @code{nologstatesreversed}, STARTUP keyword
15008 logdone @r{record a timestamp when an item is marked DONE}
15009 lognotedone @r{record timestamp and a note when DONE}
15010 nologdone @r{don't record when items are marked DONE}
15011 logrepeat @r{record a time when reinstating a repeating item}
15012 lognoterepeat @r{record a note when reinstating a repeating item}
15013 nologrepeat @r{do not record when reinstating repeating item}
15014 lognoteclock-out @r{record a note when clocking out}
15015 nolognoteclock-out @r{don't record a note when clocking out}
15016 logreschedule @r{record a timestamp when scheduling time changes}
15017 lognotereschedule @r{record a note when scheduling time changes}
15018 nologreschedule @r{do not record when a scheduling date changes}
15019 logredeadline @r{record a timestamp when deadline changes}
15020 lognoteredeadline @r{record a note when deadline changes}
15021 nologredeadline @r{do not record when a deadline date changes}
15022 logrefile @r{record a timestamp when refiling}
15023 lognoterefile @r{record a note when refiling}
15024 nologrefile @r{do not record when refiling}
15025 logdrawer @r{store log into drawer}
15026 nologdrawer @r{store log outside of drawer}
15027 logstatesreversed @r{reverse the order of states notes}
15028 nologstatesreversed @r{do not reverse the order of states notes}
15030 @vindex org-hide-leading-stars
15031 @vindex org-odd-levels-only
15032 Here are the options for hiding leading stars in outline headings, and for
15033 indenting outlines. The corresponding variables are
15034 @code{org-hide-leading-stars} and @code{org-odd-levels-only}, both with a
15035 default setting @code{nil} (meaning @code{showstars} and @code{oddeven}).
15036 @cindex @code{hidestars}, STARTUP keyword
15037 @cindex @code{showstars}, STARTUP keyword
15038 @cindex @code{odd}, STARTUP keyword
15039 @cindex @code{even}, STARTUP keyword
15041 hidestars @r{make all but one of the stars starting a headline invisible.}
15042 showstars @r{show all stars starting a headline}
15043 indent @r{virtual indentation according to outline level}
15044 noindent @r{no virtual indentation according to outline level}
15045 odd @r{allow only odd outline levels (1,3,...)}
15046 oddeven @r{allow all outline levels}
15048 @vindex org-put-time-stamp-overlays
15049 @vindex org-time-stamp-overlay-formats
15050 To turn on custom format overlays over timestamps (variables
15051 @code{org-put-time-stamp-overlays} and
15052 @code{org-time-stamp-overlay-formats}), use
15053 @cindex @code{customtime}, STARTUP keyword
15055 customtime @r{overlay custom time format}
15057 @vindex constants-unit-system
15058 The following options influence the table spreadsheet (variable
15059 @code{constants-unit-system}).
15060 @cindex @code{constcgs}, STARTUP keyword
15061 @cindex @code{constSI}, STARTUP keyword
15063 constcgs @r{@file{constants.el} should use the c-g-s unit system}
15064 constSI @r{@file{constants.el} should use the SI unit system}
15066 @vindex org-footnote-define-inline
15067 @vindex org-footnote-auto-label
15068 @vindex org-footnote-auto-adjust
15069 To influence footnote settings, use the following keywords. The
15070 corresponding variables are @code{org-footnote-define-inline},
15071 @code{org-footnote-auto-label}, and @code{org-footnote-auto-adjust}.
15072 @cindex @code{fninline}, STARTUP keyword
15073 @cindex @code{nofninline}, STARTUP keyword
15074 @cindex @code{fnlocal}, STARTUP keyword
15075 @cindex @code{fnprompt}, STARTUP keyword
15076 @cindex @code{fnauto}, STARTUP keyword
15077 @cindex @code{fnconfirm}, STARTUP keyword
15078 @cindex @code{fnplain}, STARTUP keyword
15079 @cindex @code{fnadjust}, STARTUP keyword
15080 @cindex @code{nofnadjust}, STARTUP keyword
15082 fninline @r{define footnotes inline}
15083 fnnoinline @r{define footnotes in separate section}
15084 fnlocal @r{define footnotes near first reference, but not inline}
15085 fnprompt @r{prompt for footnote labels}
15086 fnauto @r{create @code{[fn:1]}-like labels automatically (default)}
15087 fnconfirm @r{offer automatic label for editing or confirmation}
15088 fnplain @r{create @code{[1]}-like labels automatically}
15089 fnadjust @r{automatically renumber and sort footnotes}
15090 nofnadjust @r{do not renumber and sort automatically}
15092 @cindex org-hide-block-startup
15093 To hide blocks on startup, use these keywords. The corresponding variable is
15094 @code{org-hide-block-startup}.
15095 @cindex @code{hideblocks}, STARTUP keyword
15096 @cindex @code{nohideblocks}, STARTUP keyword
15098 hideblocks @r{Hide all begin/end blocks on startup}
15099 nohideblocks @r{Do not hide blocks on startup}
15101 @cindex org-pretty-entities
15102 The display of entities as UTF-8 characters is governed by the variable
15103 @code{org-pretty-entities} and the keywords
15104 @cindex @code{entitiespretty}, STARTUP keyword
15105 @cindex @code{entitiesplain}, STARTUP keyword
15107 entitiespretty @r{Show entities as UTF-8 characters where possible}
15108 entitiesplain @r{Leave entities plain}
15110 @item #+TAGS: TAG1(c1) TAG2(c2)
15111 @vindex org-tag-alist
15112 These lines (several such lines are allowed) specify the valid tags in
15113 this file, and (potentially) the corresponding @emph{fast tag selection}
15114 keys. The corresponding variable is @code{org-tag-alist}.
15116 This line contains the formulas for the table directly above the line.
15117 @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+TEXT:, #+DATE:,
15118 @itemx #+OPTIONS:, #+BIND:, #+XSLT:,
15119 @itemx #+DESCRIPTION:, #+KEYWORDS:,
15120 @itemx #+LaTeX_HEADER:, #+STYLE:, #+LINK_UP:, #+LINK_HOME:,
15121 @itemx #+EXPORT_SELECT_TAGS:, #+EXPORT_EXCLUDE_TAGS:
15122 These lines provide settings for exporting files. For more details see
15123 @ref{Export options}.
15124 @item #+TODO: #+SEQ_TODO: #+TYP_TODO:
15125 @vindex org-todo-keywords
15126 These lines set the TODO keywords and their interpretation in the
15127 current file. The corresponding variable is @code{org-todo-keywords}.
15130 @node The very busy C-c C-c key, Clean view, In-buffer settings, Miscellaneous
15131 @section The very busy C-c C-c key
15133 @cindex C-c C-c, overview
15135 The key @kbd{C-c C-c} has many purposes in Org, which are all
15136 mentioned scattered throughout this manual. One specific function of
15137 this key is to add @emph{tags} to a headline (@pxref{Tags}). In many
15138 other circumstances it means something like @emph{``Hey Org, look
15139 here and update according to what you see here''}. Here is a summary of
15140 what this means in different contexts.
15144 If there are highlights in the buffer from the creation of a sparse
15145 tree, or from clock display, remove these highlights.
15147 If the cursor is in one of the special @code{#+KEYWORD} lines, this
15148 triggers scanning the buffer for these lines and updating the
15151 If the cursor is inside a table, realign the table. This command
15152 works even if the automatic table editor has been turned off.
15154 If the cursor is on a @code{#+TBLFM} line, re-apply the formulas to
15157 If the current buffer is a capture buffer, close the note and file it.
15158 With a prefix argument, file it, without further interaction, to the
15161 If the cursor is on a @code{<<<target>>>}, update radio targets and
15162 corresponding links in this buffer.
15164 If the cursor is in a property line or at the start or end of a property
15165 drawer, offer property commands.
15167 If the cursor is at a footnote reference, go to the corresponding
15168 definition, and vice versa.
15170 If the cursor is on a statistics cookie, update it.
15172 If the cursor is in a plain list item with a checkbox, toggle the status
15175 If the cursor is on a numbered item in a plain list, renumber the
15178 If the cursor is on the @code{#+BEGIN} line of a dynamic block, the
15181 If the cursor is at a timestamp, fix the day name in the timestamp.
15184 @node Clean view, TTY keys, The very busy C-c C-c key, Miscellaneous
15185 @section A cleaner outline view
15186 @cindex hiding leading stars
15187 @cindex dynamic indentation
15188 @cindex odd-levels-only outlines
15189 @cindex clean outline view
15191 Some people find it noisy and distracting that the Org headlines start with a
15192 potentially large number of stars, and that text below the headlines is not
15193 indented. While this is no problem when writing a @emph{book-like} document
15194 where the outline headings are really section headings, in a more
15195 @emph{list-oriented} outline, indented structure is a lot cleaner:
15199 * Top level headline | * Top level headline
15200 ** Second level | * Second level
15201 *** 3rd level | * 3rd level
15202 some text | some text
15203 *** 3rd level | * 3rd level
15204 more text | more text
15205 * Another top level headline | * Another top level headline
15211 If you are using at least Emacs 23.2@footnote{Emacs 23.1 can actually crash
15212 with @code{org-indent-mode}} and version 6.29 of Org, this kind of view can
15213 be achieved dynamically at display time using @code{org-indent-mode}. In
15214 this minor mode, all lines are prefixed for display with the necessary amount
15215 of space@footnote{@code{org-indent-mode} also sets the @code{wrap-prefix}
15216 property, such that @code{visual-line-mode} (or purely setting
15217 @code{word-wrap}) wraps long lines (including headlines) correctly indented.
15218 }. Also headlines are prefixed with additional stars, so that the amount of
15219 indentation shifts by two@footnote{See the variable
15220 @code{org-indent-indentation-per-level}.} spaces per level. All headline
15221 stars but the last one are made invisible using the @code{org-hide}
15222 face@footnote{Turning on @code{org-indent-mode} sets
15223 @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to
15224 @code{nil}.}; see below under @samp{2.} for more information on how this
15225 works. You can turn on @code{org-indent-mode} for all files by customizing
15226 the variable @code{org-startup-indented}, or you can turn it on for
15227 individual files using
15233 If you want a similar effect in an earlier version of Emacs and/or Org, or if
15234 you want the indentation to be hard space characters so that the plain text
15235 file looks as similar as possible to the Emacs display, Org supports you in
15240 @emph{Indentation of text below headlines}@*
15241 You may indent text below each headline to make the left boundary line up
15242 with the headline, like
15246 more text, now indented
15249 @vindex org-adapt-indentation
15250 Org supports this with paragraph filling, line wrapping, and structure
15251 editing@footnote{See also the variable @code{org-adapt-indentation}.},
15252 preserving or adapting the indentation as appropriate.
15255 @vindex org-hide-leading-stars
15256 @emph{Hiding leading stars}@* You can modify the display in such a way that
15257 all leading stars become invisible. To do this in a global way, configure
15258 the variable @code{org-hide-leading-stars} or change this on a per-file basis
15262 #+STARTUP: hidestars
15263 #+STARTUP: showstars
15266 With hidden stars, the tree becomes:
15270 * Top level headline
15278 @vindex org-hide @r{(face)}
15279 The leading stars are not truly replaced by whitespace, they are only
15280 fontified with the face @code{org-hide} that uses the background color as
15281 font color. If you are not using either white or black background, you may
15282 have to customize this face to get the wanted effect. Another possibility is
15283 to set this font such that the extra stars are @i{almost} invisible, for
15284 example using the color @code{grey90} on a white background.
15287 @vindex org-odd-levels-only
15288 Things become cleaner still if you skip all the even levels and use only odd
15289 levels 1, 3, 5..., effectively adding two stars to go from one outline level
15290 to the next@footnote{When you need to specify a level for a property search
15291 or refile targets, @samp{LEVEL=2} will correspond to 3 stars, etc.}. In this
15292 way we get the outline view shown at the beginning of this section. In order
15293 to make the structure editing and export commands handle this convention
15294 correctly, configure the variable @code{org-odd-levels-only}, or set this on
15295 a per-file basis with one of the following lines:
15302 You can convert an Org file from single-star-per-level to the
15303 double-star-per-level convention with @kbd{M-x org-convert-to-odd-levels
15304 RET} in that file. The reverse operation is @kbd{M-x
15305 org-convert-to-oddeven-levels}.
15308 @node TTY keys, Interaction, Clean view, Miscellaneous
15309 @section Using Org on a tty
15310 @cindex tty key bindings
15312 Because Org contains a large number of commands, by default many of
15313 Org's core commands are bound to keys that are generally not
15314 accessible on a tty, such as the cursor keys (@key{left}, @key{right},
15315 @key{up}, @key{down}), @key{TAB} and @key{RET}, in particular when used
15316 together with modifiers like @key{Meta} and/or @key{Shift}. To access
15317 these commands on a tty when special keys are unavailable, the following
15318 alternative bindings can be used. The tty bindings below will likely be
15319 more cumbersome; you may find for some of the bindings below that a
15320 customized workaround suits you better. For example, changing a timestamp
15321 is really only fun with @kbd{S-@key{cursor}} keys, whereas on a
15322 tty you would rather use @kbd{C-c .} to re-insert the timestamp.
15324 @multitable @columnfractions 0.15 0.2 0.1 0.2
15325 @item @b{Default} @tab @b{Alternative 1} @tab @b{Speed key} @tab @b{Alternative 2}
15326 @item @kbd{S-@key{TAB}} @tab @kbd{C-u @key{TAB}} @tab @kbd{C} @tab
15327 @item @kbd{M-@key{left}} @tab @kbd{C-c C-x l} @tab @kbd{l} @tab @kbd{@key{Esc} @key{left}}
15328 @item @kbd{M-S-@key{left}} @tab @kbd{C-c C-x L} @tab @kbd{L} @tab
15329 @item @kbd{M-@key{right}} @tab @kbd{C-c C-x r} @tab @kbd{r} @tab @kbd{@key{Esc} @key{right}}
15330 @item @kbd{M-S-@key{right}} @tab @kbd{C-c C-x R} @tab @kbd{R} @tab
15331 @item @kbd{M-@key{up}} @tab @kbd{C-c C-x u} @tab @kbd{ } @tab @kbd{@key{Esc} @key{up}}
15332 @item @kbd{M-S-@key{up}} @tab @kbd{C-c C-x U} @tab @kbd{U} @tab
15333 @item @kbd{M-@key{down}} @tab @kbd{C-c C-x d} @tab @kbd{ } @tab @kbd{@key{Esc} @key{down}}
15334 @item @kbd{M-S-@key{down}} @tab @kbd{C-c C-x D} @tab @kbd{D} @tab
15335 @item @kbd{S-@key{RET}} @tab @kbd{C-c C-x c} @tab @kbd{ } @tab
15336 @item @kbd{M-@key{RET}} @tab @kbd{C-c C-x m} @tab @kbd{ } @tab @kbd{@key{Esc} @key{RET}}
15337 @item @kbd{M-S-@key{RET}} @tab @kbd{C-c C-x M} @tab @kbd{ } @tab
15338 @item @kbd{S-@key{left}} @tab @kbd{C-c @key{left}} @tab @kbd{ } @tab
15339 @item @kbd{S-@key{right}} @tab @kbd{C-c @key{right}} @tab @kbd{ } @tab
15340 @item @kbd{S-@key{up}} @tab @kbd{C-c @key{up}} @tab @kbd{ } @tab
15341 @item @kbd{S-@key{down}} @tab @kbd{C-c @key{down}} @tab @kbd{ } @tab
15342 @item @kbd{C-S-@key{left}} @tab @kbd{C-c C-x @key{left}} @tab @kbd{ } @tab
15343 @item @kbd{C-S-@key{right}} @tab @kbd{C-c C-x @key{right}} @tab @kbd{ } @tab
15347 @node Interaction, org-crypt.el, TTY keys, Miscellaneous
15348 @section Interaction with other packages
15349 @cindex packages, interaction with other
15350 Org lives in the world of GNU Emacs and interacts in various ways
15351 with other code out there.
15354 * Cooperation:: Packages Org cooperates with
15355 * Conflicts:: Packages that lead to conflicts
15358 @node Cooperation, Conflicts, Interaction, Interaction
15359 @subsection Packages that Org cooperates with
15362 @cindex @file{calc.el}
15363 @cindex Gillespie, Dave
15364 @item @file{calc.el} by Dave Gillespie
15365 Org uses the Calc package for implementing spreadsheet
15366 functionality in its tables (@pxref{The spreadsheet}). Org
15367 checks for the availability of Calc by looking for the function
15368 @code{calc-eval} which will have been autoloaded during setup if Calc has
15369 been installed properly. As of Emacs 22, Calc is part of the Emacs
15370 distribution. Another possibility for interaction between the two
15371 packages is using Calc for embedded calculations. @xref{Embedded Mode,
15372 , Embedded Mode, calc, GNU Emacs Calc Manual}.
15373 @item @file{constants.el} by Carsten Dominik
15374 @cindex @file{constants.el}
15375 @cindex Dominik, Carsten
15376 @vindex org-table-formula-constants
15377 In a table formula (@pxref{The spreadsheet}), it is possible to use
15378 names for natural constants or units. Instead of defining your own
15379 constants in the variable @code{org-table-formula-constants}, install
15380 the @file{constants} package which defines a large number of constants
15381 and units, and lets you use unit prefixes like @samp{M} for
15382 @samp{Mega}, etc. You will need version 2.0 of this package, available
15383 at @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks for
15384 the function @code{constants-get}, which has to be autoloaded in your
15385 setup. See the installation instructions in the file
15386 @file{constants.el}.
15387 @item @file{cdlatex.el} by Carsten Dominik
15388 @cindex @file{cdlatex.el}
15389 @cindex Dominik, Carsten
15390 Org mode can make use of the CD@LaTeX{} package to efficiently enter
15391 @LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}.
15392 @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg
15393 @cindex @file{imenu.el}
15394 Imenu allows menu access to an index of items in a file. Org mode
15395 supports Imenu---all you need to do to get the index is the following:
15397 (add-hook 'org-mode-hook
15398 (lambda () (imenu-add-to-menubar "Imenu")))
15400 @vindex org-imenu-depth
15401 By default the index is two levels deep---you can modify the depth using
15402 the option @code{org-imenu-depth}.
15403 @item @file{remember.el} by John Wiegley
15404 @cindex @file{remember.el}
15405 @cindex Wiegley, John
15406 Org used to use this package for capture, but no longer does.
15407 @item @file{speedbar.el} by Eric M. Ludlam
15408 @cindex @file{speedbar.el}
15409 @cindex Ludlam, Eric M.
15410 Speedbar is a package that creates a special frame displaying files and
15411 index items in files. Org mode supports Speedbar and allows you to
15412 drill into Org files directly from the Speedbar. It also allows you to
15413 restrict the scope of agenda commands to a file or a subtree by using
15414 the command @kbd{<} in the Speedbar frame.
15415 @cindex @file{table.el}
15416 @item @file{table.el} by Takaaki Ota
15418 @cindex table editor, @file{table.el}
15419 @cindex @file{table.el}
15420 @cindex Ota, Takaaki
15422 Complex ASCII tables with automatic line wrapping, column- and row-spanning,
15423 and alignment can be created using the Emacs table package by Takaaki Ota
15424 (@uref{http://sourceforge.net/projects/table}, and also part of Emacs 22).
15425 Org mode will recognize these tables and export them properly. Because of
15426 interference with other Org mode functionality, you unfortunately cannot edit
15427 these tables directly in the buffer. Instead, you need to use the command
15428 @kbd{C-c '} to edit them, similar to source code snippets.
15431 @orgcmd{C-c ',org-edit-special}
15432 Edit a @file{table.el} table. Works when the cursor is in a table.el table.
15434 @orgcmd{C-c ~,org-table-create-with-table.el}
15435 Insert a @file{table.el} table. If there is already a table at point, this
15436 command converts it between the @file{table.el} format and the Org mode
15437 format. See the documentation string of the command
15438 @code{org-convert-table} for the restrictions under which this is
15441 @file{table.el} is part of Emacs since Emacs 22.
15442 @item @file{footnote.el} by Steven L. Baur
15443 @cindex @file{footnote.el}
15444 @cindex Baur, Steven L.
15445 Org mode recognizes numerical footnotes as provided by this package.
15446 However, Org mode also has its own footnote support (@pxref{Footnotes}),
15447 which makes using @file{footnote.el} unnecessary.
15450 @node Conflicts, , Cooperation, Interaction
15451 @subsection Packages that lead to conflicts with Org mode
15455 @cindex @code{shift-selection-mode}
15456 @vindex org-support-shift-select
15457 In Emacs 23, @code{shift-selection-mode} is on by default, meaning that
15458 cursor motions combined with the shift key should start or enlarge regions.
15459 This conflicts with the use of @kbd{S-@key{cursor}} commands in Org to change
15460 timestamps, TODO keywords, priorities, and item bullet types if the cursor is
15461 at such a location. By default, @kbd{S-@key{cursor}} commands outside
15462 special contexts don't do anything, but you can customize the variable
15463 @code{org-support-shift-select}. Org mode then tries to accommodate shift
15464 selection by (i) using it outside of the special contexts where special
15465 commands apply, and by (ii) extending an existing active region even if the
15466 cursor moves across a special context.
15468 @item @file{CUA.el} by Kim. F. Storm
15469 @cindex @file{CUA.el}
15470 @cindex Storm, Kim. F.
15471 @vindex org-replace-disputed-keys
15472 Key bindings in Org conflict with the @kbd{S-<cursor>} keys used by CUA mode
15473 (as well as @code{pc-select-mode} and @code{s-region-mode}) to select and extend the
15474 region. In fact, Emacs 23 has this built-in in the form of
15475 @code{shift-selection-mode}, see previous paragraph. If you are using Emacs
15476 23, you probably don't want to use another package for this purpose. However,
15477 if you prefer to leave these keys to a different package while working in
15478 Org mode, configure the variable @code{org-replace-disputed-keys}. When set,
15479 Org will move the following key bindings in Org files, and in the agenda
15480 buffer (but not during date selection).
15483 S-UP @result{} M-p S-DOWN @result{} M-n
15484 S-LEFT @result{} M-- S-RIGHT @result{} M-+
15485 C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+
15488 @vindex org-disputed-keys
15489 Yes, these are unfortunately more difficult to remember. If you want
15490 to have other replacement keys, look at the variable
15491 @code{org-disputed-keys}.
15493 @item @file{filladapt.el} by Kyle Jones
15494 @cindex @file{filladapt.el}
15496 Org mode tries to do the right thing when filling paragraphs, list items and
15497 other elements. Many users reported they had problems using both
15498 @file{filladapt.el} and Org mode, so a safe thing to do is to disable it like
15502 (add-hook 'org-mode-hook 'turn-off-filladapt-mode)
15505 @item @file{yasnippet.el}
15506 @cindex @file{yasnippet.el}
15507 The way Org mode binds the TAB key (binding to @code{[tab]} instead of
15508 @code{"\t"}) overrules YASnippet's access to this key. The following code
15509 fixed this problem:
15512 (add-hook 'org-mode-hook
15514 (org-set-local 'yas/trigger-key [tab])
15515 (define-key yas/keymap [tab] 'yas/next-field-or-maybe-expand)))
15518 The latest version of yasnippet doesn't play well with Org mode. If the
15519 above code does not fix the conflict, start by defining the following
15523 (defun yas/org-very-safe-expand ()
15524 (let ((yas/fallback-behavior 'return-nil)) (yas/expand)))
15527 Then, tell Org mode what to do with the new function:
15530 (add-hook 'org-mode-hook
15532 (make-variable-buffer-local 'yas/trigger-key)
15533 (setq yas/trigger-key [tab])
15534 (add-to-list 'org-tab-first-hook 'yas/org-very-safe-expand)
15535 (define-key yas/keymap [tab] 'yas/next-field)))
15538 @item @file{windmove.el} by Hovav Shacham
15539 @cindex @file{windmove.el}
15540 This package also uses the @kbd{S-<cursor>} keys, so everything written
15541 in the paragraph above about CUA mode also applies here. If you want make
15542 the windmove function active in locations where Org mode does not have
15543 special functionality on @kbd{S-@key{cursor}}, add this to your
15547 ;; Make windmove work in org-mode:
15548 (add-hook 'org-shiftup-final-hook 'windmove-up)
15549 (add-hook 'org-shiftleft-final-hook 'windmove-left)
15550 (add-hook 'org-shiftdown-final-hook 'windmove-down)
15551 (add-hook 'org-shiftright-final-hook 'windmove-right)
15554 @item @file{viper.el} by Michael Kifer
15555 @cindex @file{viper.el}
15557 Viper uses @kbd{C-c /} and therefore makes this key not access the
15558 corresponding Org mode command @code{org-sparse-tree}. You need to find
15559 another key for this command, or override the key in
15560 @code{viper-vi-global-user-map} with
15563 (define-key viper-vi-global-user-map "C-c /" 'org-sparse-tree)
15568 @node org-crypt.el, , Interaction, Miscellaneous
15569 @section org-crypt.el
15570 @cindex @file{org-crypt.el}
15571 @cindex @code{org-decrypt-entry}
15573 Org-crypt will encrypt the text of an entry, but not the headline, or
15574 properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
15577 Any text below a headline that has a @samp{:crypt:} tag will be automatically
15578 be encrypted when the file is saved. If you want to use a different tag just
15579 customize the @code{org-crypt-tag-matcher} setting.
15581 To use org-crypt it is suggested that you have the following in your
15585 (require 'org-crypt)
15586 (org-crypt-use-before-save-magic)
15587 (setq org-tags-exclude-from-inheritance (quote ("crypt")))
15589 (setq org-crypt-key nil)
15590 ;; GPG key to use for encryption
15591 ;; Either the Key ID or set to nil to use symmetric encryption.
15593 (setq auto-save-default nil)
15594 ;; Auto-saving does not cooperate with org-crypt.el: so you need
15595 ;; to turn it off if you plan to use org-crypt.el quite often.
15596 ;; Otherwise, you'll get an (annoying) message each time you
15599 ;; To turn it off only locally, you can insert this:
15601 ;; # -*- buffer-auto-save-file-name: nil; -*-
15604 Excluding the crypt tag from inheritance prevents already encrypted text
15605 being encrypted again.
15607 @node Hacking, MobileOrg, Miscellaneous, Top
15611 This appendix covers some aspects where users can extend the functionality of
15615 * Hooks:: How to reach into Org's internals
15616 * Add-on packages:: Available extensions
15617 * Adding hyperlink types:: New custom link types
15618 * Context-sensitive commands:: How to add functionality to such commands
15619 * Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs
15620 * Dynamic blocks:: Automatically filled blocks
15621 * Special agenda views:: Customized views
15622 * Extracting agenda information:: Postprocessing of agenda information
15623 * Using the property API:: Writing programs that use entry properties
15624 * Using the mapping API:: Mapping over all or selected entries
15627 @node Hooks, Add-on packages, Hacking, Hacking
15631 Org has a large number of hook variables that can be used to add
15632 functionality. This appendix about hacking is going to illustrate the
15633 use of some of them. A complete list of all hooks with documentation is
15634 maintained by the Worg project and can be found at
15635 @uref{http://orgmode.org/worg/org-configs/org-hooks.php}.
15637 @node Add-on packages, Adding hyperlink types, Hooks, Hacking
15638 @section Add-on packages
15639 @cindex add-on packages
15641 A large number of add-on packages have been written by various authors.
15642 These packages are not part of Emacs, but they are distributed as contributed
15643 packages with the separate release available at the Org mode home page at
15644 @uref{http://orgmode.org}. The list of contributed packages, along with
15645 documentation about each package, is maintained by the Worg project at
15646 @uref{http://orgmode.org/worg/org-contrib/}.
15650 @node Adding hyperlink types, Context-sensitive commands, Add-on packages, Hacking
15651 @section Adding hyperlink types
15652 @cindex hyperlinks, adding new types
15654 Org has a large number of hyperlink types built-in
15655 (@pxref{Hyperlinks}). If you would like to add new link types, Org
15656 provides an interface for doing so. Let's look at an example file,
15657 @file{org-man.el}, that will add support for creating links like
15658 @samp{[[man:printf][The printf manpage]]} to show Unix manual pages inside
15662 ;;; org-man.el - Support for links to manpages in Org
15666 (org-add-link-type "man" 'org-man-open)
15667 (add-hook 'org-store-link-functions 'org-man-store-link)
15669 (defcustom org-man-command 'man
15670 "The Emacs command to be used to display a man page."
15672 :type '(choice (const man) (const woman)))
15674 (defun org-man-open (path)
15675 "Visit the manpage on PATH.
15676 PATH should be a topic that can be thrown at the man command."
15677 (funcall org-man-command path))
15679 (defun org-man-store-link ()
15680 "Store a link to a manpage."
15681 (when (memq major-mode '(Man-mode woman-mode))
15682 ;; This is a man page, we do make this link
15683 (let* ((page (org-man-get-page-name))
15684 (link (concat "man:" page))
15685 (description (format "Manpage for %s" page)))
15686 (org-store-link-props
15689 :description description))))
15691 (defun org-man-get-page-name ()
15692 "Extract the page name from the buffer name."
15693 ;; This works for both `Man-mode' and `woman-mode'.
15694 (if (string-match " \\(\\S-+\\)\\*" (buffer-name))
15695 (match-string 1 (buffer-name))
15696 (error "Cannot create link to this man page")))
15700 ;;; org-man.el ends here
15704 You would activate this new link type in @file{.emacs} with
15711 Let's go through the file and see what it does.
15714 It does @code{(require 'org)} to make sure that @file{org.el} has been
15717 The next line calls @code{org-add-link-type} to define a new link type
15718 with prefix @samp{man}. The call also contains the name of a function
15719 that will be called to follow such a link.
15721 @vindex org-store-link-functions
15722 The next line adds a function to @code{org-store-link-functions}, in
15723 order to allow the command @kbd{C-c l} to record a useful link in a
15724 buffer displaying a man page.
15727 The rest of the file defines the necessary variables and functions.
15728 First there is a customization variable that determines which Emacs
15729 command should be used to display man pages. There are two options,
15730 @code{man} and @code{woman}. Then the function to follow a link is
15731 defined. It gets the link path as an argument---in this case the link
15732 path is just a topic for the manual command. The function calls the
15733 value of @code{org-man-command} to display the man page.
15735 Finally the function @code{org-man-store-link} is defined. When you try
15736 to store a link with @kbd{C-c l}, this function will be called to
15737 try to make a link. The function must first decide if it is supposed to
15738 create the link for this buffer type; we do this by checking the value
15739 of the variable @code{major-mode}. If not, the function must exit and
15740 return the value @code{nil}. If yes, the link is created by getting the
15741 manual topic from the buffer name and prefixing it with the string
15742 @samp{man:}. Then it must call the command @code{org-store-link-props}
15743 and set the @code{:type} and @code{:link} properties. Optionally you
15744 can also set the @code{:description} property to provide a default for
15745 the link description when the link is later inserted into an Org
15746 buffer with @kbd{C-c C-l}.
15748 When it makes sense for your new link type, you may also define a function
15749 @code{org-PREFIX-complete-link} that implements special (e.g., completion)
15750 support for inserting such a link with @kbd{C-c C-l}. Such a function should
15751 not accept any arguments, and return the full link with prefix.
15753 @node Context-sensitive commands, Tables in arbitrary syntax, Adding hyperlink types, Hacking
15754 @section Context-sensitive commands
15755 @cindex context-sensitive commands, hooks
15756 @cindex add-ons, context-sensitive commands
15757 @vindex org-ctrl-c-ctrl-c-hook
15759 Org has several commands that act differently depending on context. The most
15760 important example is the @kbd{C-c C-c} (@pxref{The very busy C-c C-c key}).
15761 Also the @kbd{M-cursor} and @kbd{M-S-cursor} keys have this property.
15763 Add-ons can tap into this functionality by providing a function that detects
15764 special context for that add-on and executes functionality appropriate for
15765 the context. Here is an example from Dan Davison's @file{org-R.el} which
15766 allows you to evaluate commands based on the @file{R} programming language
15767 @footnote{@file{org-R.el} has been replaced by the Org mode functionality
15768 described in @ref{Working With Source Code} and is now obsolete.}. For this
15769 package, special contexts are lines that start with @code{#+R:} or
15773 (defun org-R-apply-maybe ()
15774 "Detect if this is context for org-R and execute R commands."
15775 (if (save-excursion
15776 (beginning-of-line 1)
15777 (looking-at "#\\+RR?:"))
15778 (progn (call-interactively 'org-R-apply)
15779 t) ;; to signal that we took action
15780 nil)) ;; to signal that we did not
15782 (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe)
15785 The function first checks if the cursor is in such a line. If that is the
15786 case, @code{org-R-apply} is called and the function returns @code{t} to
15787 signal that action was taken, and @kbd{C-c C-c} will stop looking for other
15788 contexts. If the function finds it should do nothing locally, it returns
15789 @code{nil} so that other, similar functions can have a try.
15792 @node Tables in arbitrary syntax, Dynamic blocks, Context-sensitive commands, Hacking
15793 @section Tables and lists in arbitrary syntax
15794 @cindex tables, in other modes
15795 @cindex lists, in other modes
15796 @cindex Orgtbl mode
15798 Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a
15799 frequent feature request has been to make it work with native tables in
15800 specific languages, for example @LaTeX{}. However, this is extremely
15801 hard to do in a general way, would lead to a customization nightmare,
15802 and would take away much of the simplicity of the Orgtbl mode table
15805 This appendix describes a different approach. We keep the Orgtbl mode
15806 table in its native format (the @i{source table}), and use a custom
15807 function to @i{translate} the table to the correct syntax, and to
15808 @i{install} it in the right location (the @i{target table}). This puts
15809 the burden of writing conversion functions on the user, but it allows
15810 for a very flexible system.
15812 Bastien added the ability to do the same with lists, in Orgstruct mode. You
15813 can use Org's facilities to edit and structure lists by turning
15814 @code{orgstruct-mode} on, then locally exporting such lists in another format
15815 (HTML, @LaTeX{} or Texinfo.)
15819 * Radio tables:: Sending and receiving radio tables
15820 * A @LaTeX{} example:: Step by step, almost a tutorial
15821 * Translator functions:: Copy and modify
15822 * Radio lists:: Doing the same for lists
15825 @node Radio tables, A @LaTeX{} example, Tables in arbitrary syntax, Tables in arbitrary syntax
15826 @subsection Radio tables
15827 @cindex radio tables
15829 To define the location of the target table, you first need to create two
15830 lines that are comments in the current mode, but contain magic words for
15831 Orgtbl mode to find. Orgtbl mode will insert the translated table
15832 between these lines, replacing whatever was there before. For example:
15835 /* BEGIN RECEIVE ORGTBL table_name */
15836 /* END RECEIVE ORGTBL table_name */
15840 Just above the source table, we put a special line that tells
15841 Orgtbl mode how to translate this table and where to install it. For
15845 #+ORGTBL: SEND table_name translation_function arguments....
15849 @code{table_name} is the reference name for the table that is also used
15850 in the receiver lines. @code{translation_function} is the Lisp function
15851 that does the translation. Furthermore, the line can contain a list of
15852 arguments (alternating key and value) at the end. The arguments will be
15853 passed as a property list to the translation function for
15854 interpretation. A few standard parameters are already recognized and
15855 acted upon before the translation function is called:
15859 Skip the first N lines of the table. Hlines do count as separate lines for
15862 @item :skipcols (n1 n2 ...)
15863 List of columns that should be skipped. If the table has a column with
15864 calculation marks, that column is automatically discarded as well.
15865 Please note that the translator function sees the table @emph{after} the
15866 removal of these columns, the function never knows that there have been
15867 additional columns.
15870 When non-nil, do not escape special characters @code{&%#_^} when exporting
15871 the table. The default value is nil.
15875 The one problem remaining is how to keep the source table in the buffer
15876 without disturbing the normal workings of the file, for example during
15877 compilation of a C file or processing of a @LaTeX{} file. There are a
15878 number of different solutions:
15882 The table could be placed in a block comment if that is supported by the
15883 language. For example, in C mode you could wrap the table between
15884 @samp{/*} and @samp{*/} lines.
15886 Sometimes it is possible to put the table after some kind of @i{END}
15887 statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}}
15890 You can just comment the table line-by-line whenever you want to process
15891 the file, and uncomment it whenever you need to edit the table. This
15892 only sounds tedious---the command @kbd{M-x orgtbl-toggle-comment}
15893 makes this comment-toggling very easy, in particular if you bind it to a
15897 @node A @LaTeX{} example, Translator functions, Radio tables, Tables in arbitrary syntax
15898 @subsection A @LaTeX{} example of radio tables
15899 @cindex @LaTeX{}, and Orgtbl mode
15901 The best way to wrap the source table in @LaTeX{} is to use the
15902 @code{comment} environment provided by @file{comment.sty}. It has to be
15903 activated by placing @code{\usepackage@{comment@}} into the document
15904 header. Orgtbl mode can insert a radio table skeleton@footnote{By
15905 default this works only for @LaTeX{}, HTML, and Texinfo. Configure the
15906 variable @code{orgtbl-radio-tables} to install templates for other
15907 modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will
15908 be prompted for a table name, let's say we use @samp{salesfigures}. You
15909 will then get the following template:
15911 @cindex #+ORGTBL, SEND
15913 % BEGIN RECEIVE ORGTBL salesfigures
15914 % END RECEIVE ORGTBL salesfigures
15916 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15922 @vindex @LaTeX{}-verbatim-environments
15923 The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function
15924 @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it
15925 into the receiver location with name @code{salesfigures}. You may now
15926 fill in the table---feel free to use the spreadsheet features@footnote{If
15927 the @samp{#+TBLFM} line contains an odd number of dollar characters,
15928 this may cause problems with font-lock in @LaTeX{} mode. As shown in the
15929 example you can fix this by adding an extra line inside the
15930 @code{comment} environment that is used to balance the dollar
15931 expressions. If you are using AUC@TeX{} with the font-latex library, a
15932 much better solution is to add the @code{comment} environment to the
15933 variable @code{LaTeX-verbatim-environments}.}:
15936 % BEGIN RECEIVE ORGTBL salesfigures
15937 % END RECEIVE ORGTBL salesfigures
15939 #+ORGTBL: SEND salesfigures orgtbl-to-latex
15940 | Month | Days | Nr sold | per day |
15941 |-------+------+---------+---------|
15942 | Jan | 23 | 55 | 2.4 |
15943 | Feb | 21 | 16 | 0.8 |
15944 | March | 22 | 278 | 12.6 |
15945 #+TBLFM: $4=$3/$2;%.1f
15946 % $ (optional extra dollar to keep font-lock happy, see footnote)
15951 When you are done, press @kbd{C-c C-c} in the table to get the converted
15952 table inserted between the two marker lines.
15954 Now let's assume you want to make the table header by hand, because you
15955 want to control how columns are aligned, etc. In this case we make sure
15956 that the table translator skips the first 2 lines of the source
15957 table, and tell the command to work as a @i{splice}, i.e., to not produce
15958 header and footer commands of the target table:
15961 \begin@{tabular@}@{lrrr@}
15962 Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\
15963 % BEGIN RECEIVE ORGTBL salesfigures
15964 % END RECEIVE ORGTBL salesfigures
15968 #+ORGTBL: SEND salesfigures orgtbl-to-latex :splice t :skip 2
15969 | Month | Days | Nr sold | per day |
15970 |-------+------+---------+---------|
15971 | Jan | 23 | 55 | 2.4 |
15972 | Feb | 21 | 16 | 0.8 |
15973 | March | 22 | 278 | 12.6 |
15974 #+TBLFM: $4=$3/$2;%.1f
15978 The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of
15979 Orgtbl mode. It uses a @code{tabular} environment to typeset the table
15980 and marks horizontal lines with @code{\hline}. Furthermore, it
15981 interprets the following parameters (see also @pxref{Translator functions}):
15984 @item :splice nil/t
15985 When set to t, return only table body lines, don't wrap them into a
15986 tabular environment. Default is nil.
15989 A format to be used to wrap each field, it should contain @code{%s} for the
15990 original field value. For example, to wrap each field value in dollars,
15991 you could use @code{:fmt "$%s$"}. This may also be a property list with
15992 column numbers and formats, for example @code{:fmt (2 "$%s$" 4 "%s\\%%")}.
15993 A function of one argument can be used in place of the strings; the
15994 function must return a formatted string.
15997 Use this format to print numbers with exponentials. The format should
15998 have @code{%s} twice for inserting mantissa and exponent, for example
15999 @code{"%s\\times10^@{%s@}"}. The default is @code{"%s\\,(%s)"}. This
16000 may also be a property list with column numbers and formats, for example
16001 @code{:efmt (2 "$%s\\times10^@{%s@}$" 4 "$%s\\cdot10^@{%s@}$")}. After
16002 @code{efmt} has been applied to a value, @code{fmt} will also be
16003 applied. Similar to @code{fmt}, functions of two arguments can be
16004 supplied instead of strings.
16007 @node Translator functions, Radio lists, A @LaTeX{} example, Tables in arbitrary syntax
16008 @subsection Translator functions
16009 @cindex HTML, and Orgtbl mode
16010 @cindex translator function
16012 Orgtbl mode has several translator functions built-in: @code{orgtbl-to-csv}
16013 (comma-separated values), @code{orgtbl-to-tsv} (TAB-separated values)
16014 @code{orgtbl-to-latex}, @code{orgtbl-to-html}, and @code{orgtbl-to-texinfo}.
16015 Except for @code{orgtbl-to-html}@footnote{The HTML translator uses the same
16016 code that produces tables during HTML export.}, these all use a generic
16017 translator, @code{orgtbl-to-generic}. For example, @code{orgtbl-to-latex}
16018 itself is a very short function that computes the column definitions for the
16019 @code{tabular} environment, defines a few field and line separators and then
16020 hands processing over to the generic translator. Here is the entire code:
16024 (defun orgtbl-to-latex (table params)
16025 "Convert the Orgtbl mode TABLE to LaTeX."
16026 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
16027 org-table-last-alignment ""))
16030 :tstart (concat "\\begin@{tabular@}@{" alignment "@}")
16031 :tend "\\end@{tabular@}"
16032 :lstart "" :lend " \\\\" :sep " & "
16033 :efmt "%s\\,(%s)" :hline "\\hline")))
16034 (orgtbl-to-generic table (org-combine-plists params2 params))))
16038 As you can see, the properties passed into the function (variable
16039 @var{PARAMS}) are combined with the ones newly defined in the function
16040 (variable @var{PARAMS2}). The ones passed into the function (i.e., the
16041 ones set by the @samp{ORGTBL SEND} line) take precedence. So if you
16042 would like to use the @LaTeX{} translator, but wanted the line endings to
16043 be @samp{\\[2mm]} instead of the default @samp{\\}, you could just
16044 overrule the default with
16047 #+ORGTBL: SEND test orgtbl-to-latex :lend " \\\\[2mm]"
16050 For a new language, you can either write your own converter function in
16051 analogy with the @LaTeX{} translator, or you can use the generic function
16052 directly. For example, if you have a language where a table is started
16053 with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are
16054 started with @samp{!BL!}, ended with @samp{!EL!}, and where the field
16055 separator is a TAB, you could call the generic translator like this (on
16059 #+ORGTBL: SEND test orgtbl-to-generic :tstart "!BTBL!" :tend "!ETBL!"
16060 :lstart "!BL! " :lend " !EL!" :sep "\t"
16064 Please check the documentation string of the function
16065 @code{orgtbl-to-generic} for a full list of parameters understood by
16066 that function, and remember that you can pass each of them into
16067 @code{orgtbl-to-latex}, @code{orgtbl-to-texinfo}, and any other function
16068 using the generic function.
16070 Of course you can also write a completely new function doing complicated
16071 things the generic translator cannot do. A translator function takes
16072 two arguments. The first argument is the table, a list of lines, each
16073 line either the symbol @code{hline} or a list of fields. The second
16074 argument is the property list containing all parameters specified in the
16075 @samp{#+ORGTBL: SEND} line. The function must return a single string
16076 containing the formatted table. If you write a generally useful
16077 translator, please post it on @email{emacs-orgmode@@gnu.org} so that
16078 others can benefit from your work.
16080 @node Radio lists, , Translator functions, Tables in arbitrary syntax
16081 @subsection Radio lists
16082 @cindex radio lists
16083 @cindex org-list-insert-radio-list
16085 Sending and receiving radio lists works exactly the same way as sending and
16086 receiving radio tables (@pxref{Radio tables}). As for radio tables, you can
16087 insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling
16088 @code{org-list-insert-radio-list}.
16090 Here are the differences with radio tables:
16094 Orgstruct mode must be active.
16096 Use the @code{ORGLST} keyword instead of @code{ORGTBL}.
16098 The available translation functions for radio lists don't take
16101 @kbd{C-c C-c} will work when pressed on the first item of the list.
16104 Here is a @LaTeX{} example. Let's say that you have this in your
16109 % BEGIN RECEIVE ORGLST to-buy
16110 % END RECEIVE ORGLST to-buy
16112 #+ORGLST: SEND to-buy org-list-to-latex
16121 Pressing `C-c C-c' on @code{a new house} and will insert the converted
16122 @LaTeX{} list between the two marker lines.
16124 @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking
16125 @section Dynamic blocks
16126 @cindex dynamic blocks
16128 Org documents can contain @emph{dynamic blocks}. These are
16129 specially marked regions that are updated by some user-written function.
16130 A good example for such a block is the clock table inserted by the
16131 command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
16133 Dynamic blocks are enclosed by a BEGIN-END structure that assigns a name
16134 to the block and can also specify parameters for the function producing
16135 the content of the block.
16137 @cindex #+BEGIN:dynamic block
16139 #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
16144 Dynamic blocks are updated with the following commands
16147 @orgcmd{C-c C-x C-u,org-dblock-update}
16148 Update dynamic block at point.
16149 @orgkey{C-u C-c C-x C-u}
16150 Update all dynamic blocks in the current file.
16153 Updating a dynamic block means to remove all the text between BEGIN and
16154 END, parse the BEGIN line for parameters and then call the specific
16155 writer function for this block to insert the new content. If you want
16156 to use the original content in the writer function, you can use the
16157 extra parameter @code{:content}.
16159 For a block with name @code{myblock}, the writer function is
16160 @code{org-dblock-write:myblock} with as only parameter a property list
16161 with the parameters given in the begin line. Here is a trivial example
16162 of a block that keeps track of when the block update function was last
16166 #+BEGIN: block-update-time :format "on %m/%d/%Y at %H:%M"
16172 The corresponding block writer function could look like this:
16175 (defun org-dblock-write:block-update-time (params)
16176 (let ((fmt (or (plist-get params :format) "%d. %m. %Y")))
16177 (insert "Last block update at: "
16178 (format-time-string fmt (current-time)))))
16181 If you want to make sure that all dynamic blocks are always up-to-date,
16182 you could add the function @code{org-update-all-dblocks} to a hook, for
16183 example @code{before-save-hook}. @code{org-update-all-dblocks} is
16184 written in a way such that it does nothing in buffers that are not in
16187 You can narrow the current buffer to the current dynamic block (like any
16188 other block) with @code{org-narrow-to-block}.
16190 @node Special agenda views, Extracting agenda information, Dynamic blocks, Hacking
16191 @section Special agenda views
16192 @cindex agenda views, user-defined
16194 @vindex org-agenda-skip-function
16195 @vindex org-agenda-skip-function-global
16196 Org provides a special hook that can be used to narrow down the selection
16197 made by these agenda views: @code{agenda}, @code{todo}, @code{alltodo},
16198 @code{tags}, @code{tags-todo}, @code{tags-tree}. You may specify a function
16199 that is used at each match to verify if the match should indeed be part of
16200 the agenda view, and if not, how much should be skipped. You can specify a
16201 global condition that will be applied to all agenda views, this condition
16202 would be stored in the variable @code{org-agenda-skip-function-global}. More
16203 commonly, such a definition is applied only to specific custom searches,
16204 using @code{org-agenda-skip-function}.
16206 Let's say you want to produce a list of projects that contain a WAITING
16207 tag anywhere in the project tree. Let's further assume that you have
16208 marked all tree headings that define a project with the TODO keyword
16209 PROJECT@. In this case you would run a TODO search for the keyword
16210 PROJECT, but skip the match unless there is a WAITING tag anywhere in
16211 the subtree belonging to the project line.
16213 To achieve this, you must write a function that searches the subtree for
16214 the tag. If the tag is found, the function must return @code{nil} to
16215 indicate that this match should not be skipped. If there is no such
16216 tag, return the location of the end of the subtree, to indicate that
16217 search should continue from there.
16220 (defun my-skip-unless-waiting ()
16221 "Skip trees that are not waiting"
16222 (let ((subtree-end (save-excursion (org-end-of-subtree t))))
16223 (if (re-search-forward ":waiting:" subtree-end t)
16224 nil ; tag found, do not skip
16225 subtree-end))) ; tag not found, continue after end of subtree
16228 Now you may use this function in an agenda custom command, for example
16232 (org-add-agenda-custom-command
16233 '("b" todo "PROJECT"
16234 ((org-agenda-skip-function 'my-skip-unless-waiting)
16235 (org-agenda-overriding-header "Projects waiting for something: "))))
16238 @vindex org-agenda-overriding-header
16239 Note that this also binds @code{org-agenda-overriding-header} to get a
16240 meaningful header in the agenda view.
16242 @vindex org-odd-levels-only
16243 @vindex org-agenda-skip-function
16244 A general way to create custom searches is to base them on a search for
16245 entries with a certain level limit. If you want to study all entries with
16246 your custom search function, simply do a search for
16247 @samp{LEVEL>0}@footnote{Note that, when using @code{org-odd-levels-only}, a
16248 level number corresponds to order in the hierarchy, not to the number of
16249 stars.}, and then use @code{org-agenda-skip-function} to select the entries
16250 you really want to have.
16252 You may also put a Lisp form into @code{org-agenda-skip-function}. In
16253 particular, you may use the functions @code{org-agenda-skip-entry-if}
16254 and @code{org-agenda-skip-subtree-if} in this form, for example:
16257 @item (org-agenda-skip-entry-if 'scheduled)
16258 Skip current entry if it has been scheduled.
16259 @item (org-agenda-skip-entry-if 'notscheduled)
16260 Skip current entry if it has not been scheduled.
16261 @item (org-agenda-skip-entry-if 'deadline)
16262 Skip current entry if it has a deadline.
16263 @item (org-agenda-skip-entry-if 'scheduled 'deadline)
16264 Skip current entry if it has a deadline, or if it is scheduled.
16265 @item (org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))
16266 Skip current entry if the TODO keyword is TODO or WAITING.
16267 @item (org-agenda-skip-entry-if 'todo 'done)
16268 Skip current entry if the TODO keyword marks a DONE state.
16269 @item (org-agenda-skip-entry-if 'timestamp)
16270 Skip current entry if it has any timestamp, may also be deadline or scheduled.
16271 @anchor{x-agenda-skip-entry-regexp}
16272 @item (org-agenda-skip-entry-if 'regexp "regular expression")
16273 Skip current entry if the regular expression matches in the entry.
16274 @item (org-agenda-skip-entry-if 'notregexp "regular expression")
16275 Skip current entry unless the regular expression matches.
16276 @item (org-agenda-skip-subtree-if 'regexp "regular expression")
16277 Same as above, but check and skip the entire subtree.
16280 Therefore we could also have written the search for WAITING projects
16281 like this, even without defining a special function:
16284 (org-add-agenda-custom-command
16285 '("b" todo "PROJECT"
16286 ((org-agenda-skip-function '(org-agenda-skip-subtree-if
16287 'regexp ":waiting:"))
16288 (org-agenda-overriding-header "Projects waiting for something: "))))
16291 @node Extracting agenda information, Using the property API, Special agenda views, Hacking
16292 @section Extracting agenda information
16293 @cindex agenda, pipe
16294 @cindex Scripts, for agenda processing
16296 @vindex org-agenda-custom-commands
16297 Org provides commands to access agenda information for the command
16298 line in Emacs batch mode. This extracted information can be sent
16299 directly to a printer, or it can be read by a program that does further
16300 processing of the data. The first of these commands is the function
16301 @code{org-batch-agenda}, that produces an agenda view and sends it as
16302 ASCII text to STDOUT@. The command takes a single string as parameter.
16303 If the string has length 1, it is used as a key to one of the commands
16304 you have configured in @code{org-agenda-custom-commands}, basically any
16305 key you can use after @kbd{C-c a}. For example, to directly print the
16306 current TODO list, you could use
16309 emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr
16312 If the parameter is a string with 2 or more characters, it is used as a
16313 tags/TODO match string. For example, to print your local shopping list
16314 (all items with the tag @samp{shop}, but excluding the tag
16315 @samp{NewYork}), you could use
16318 emacs -batch -l ~/.emacs \
16319 -eval '(org-batch-agenda "+shop-NewYork")' | lpr
16323 You may also modify parameters on the fly like this:
16326 emacs -batch -l ~/.emacs \
16327 -eval '(org-batch-agenda "a" \
16328 org-agenda-span (quote month) \
16329 org-agenda-include-diary nil \
16330 org-agenda-files (quote ("~/org/project.org")))' \
16335 which will produce a 30-day agenda, fully restricted to the Org file
16336 @file{~/org/projects.org}, not even including the diary.
16338 If you want to process the agenda data in more sophisticated ways, you
16339 can use the command @code{org-batch-agenda-csv} to get a comma-separated
16340 list of values for each agenda item. Each line in the output will
16341 contain a number of fields separated by commas. The fields in a line
16345 category @r{The category of the item}
16346 head @r{The headline, without TODO keyword, TAGS and PRIORITY}
16347 type @r{The type of the agenda entry, can be}
16348 todo @r{selected in TODO match}
16349 tagsmatch @r{selected in tags match}
16350 diary @r{imported from diary}
16351 deadline @r{a deadline}
16352 scheduled @r{scheduled}
16353 timestamp @r{appointment, selected by timestamp}
16354 closed @r{entry was closed on date}
16355 upcoming-deadline @r{warning about nearing deadline}
16356 past-scheduled @r{forwarded scheduled item}
16357 block @r{entry has date block including date}
16358 todo @r{The TODO keyword, if any}
16359 tags @r{All tags including inherited ones, separated by colons}
16360 date @r{The relevant date, like 2007-2-14}
16361 time @r{The time, like 15:00-16:50}
16362 extra @r{String with extra planning info}
16363 priority-l @r{The priority letter if any was given}
16364 priority-n @r{The computed numerical priority}
16368 Time and date will only be given if a timestamp (or deadline/scheduled)
16369 led to the selection of the item.
16371 A CSV list like this is very easy to use in a post-processing script.
16372 For example, here is a Perl program that gets the TODO list from
16373 Emacs/Org and prints all the items, preceded by a checkbox:
16378 # define the Emacs command to run
16379 $cmd = "emacs -batch -l ~/.emacs -eval '(org-batch-agenda-csv \"t\")'";
16381 # run it and capture the output
16382 $agenda = qx@{$cmd 2>/dev/null@};
16384 # loop over all lines
16385 foreach $line (split(/\n/,$agenda)) @{
16386 # get the individual values
16387 ($category,$head,$type,$todo,$tags,$date,$time,$extra,
16388 $priority_l,$priority_n) = split(/,/,$line);
16389 # process and print
16390 print "[ ] $head\n";
16394 @node Using the property API, Using the mapping API, Extracting agenda information, Hacking
16395 @section Using the property API
16396 @cindex API, for properties
16397 @cindex properties, API
16399 Here is a description of the functions that can be used to work with
16402 @defun org-entry-properties &optional pom which
16403 Get all properties of the entry at point-or-marker POM.@*
16404 This includes the TODO keyword, the tags, time strings for deadline,
16405 scheduled, and clocking, and any additional properties defined in the
16406 entry. The return value is an alist. Keys may occur multiple times
16407 if the property key was used several times.@*
16408 POM may also be nil, in which case the current entry is used.
16409 If WHICH is nil or `all', get all properties. If WHICH is
16410 `special' or `standard', only get that subclass.
16412 @vindex org-use-property-inheritance
16413 @findex org-insert-property-drawer
16414 @defun org-entry-get pom property &optional inherit
16415 Get value of PROPERTY for entry at point-or-marker POM@. By default,
16416 this only looks at properties defined locally in the entry. If INHERIT
16417 is non-nil and the entry does not have the property, then also check
16418 higher levels of the hierarchy. If INHERIT is the symbol
16419 @code{selective}, use inheritance if and only if the setting of
16420 @code{org-use-property-inheritance} selects PROPERTY for inheritance.
16423 @defun org-entry-delete pom property
16424 Delete the property PROPERTY from entry at point-or-marker POM.
16427 @defun org-entry-put pom property value
16428 Set PROPERTY to VALUE for entry at point-or-marker POM.
16431 @defun org-buffer-property-keys &optional include-specials
16432 Get all property keys in the current buffer.
16435 @defun org-insert-property-drawer
16436 Insert a property drawer for the current entry. Also
16439 @defun org-entry-put-multivalued-property pom property &rest values
16440 Set PROPERTY at point-or-marker POM to VALUES@. VALUES should be a list of
16441 strings. They will be concatenated, with spaces as separators.
16444 @defun org-entry-get-multivalued-property pom property
16445 Treat the value of the property PROPERTY as a whitespace-separated list of
16446 values and return the values as a list of strings.
16449 @defun org-entry-add-to-multivalued-property pom property value
16450 Treat the value of the property PROPERTY as a whitespace-separated list of
16451 values and make sure that VALUE is in this list.
16454 @defun org-entry-remove-from-multivalued-property pom property value
16455 Treat the value of the property PROPERTY as a whitespace-separated list of
16456 values and make sure that VALUE is @emph{not} in this list.
16459 @defun org-entry-member-in-multivalued-property pom property value
16460 Treat the value of the property PROPERTY as a whitespace-separated list of
16461 values and check if VALUE is in this list.
16464 @defopt org-property-allowed-value-functions
16465 Hook for functions supplying allowed values for a specific property.
16466 The functions must take a single argument, the name of the property, and
16467 return a flat list of allowed values. If @samp{:ETC} is one of
16468 the values, use the values as completion help, but allow also other values
16469 to be entered. The functions must return @code{nil} if they are not
16470 responsible for this property.
16473 @node Using the mapping API, , Using the property API, Hacking
16474 @section Using the mapping API
16475 @cindex API, for mapping
16476 @cindex mapping entries, API
16478 Org has sophisticated mapping capabilities to find all entries satisfying
16479 certain criteria. Internally, this functionality is used to produce agenda
16480 views, but there is also an API that can be used to execute arbitrary
16481 functions for each or selected entries. The main entry point for this API
16484 @defun org-map-entries func &optional match scope &rest skip
16485 Call FUNC at each headline selected by MATCH in SCOPE.
16487 FUNC is a function or a Lisp form. The function will be called without
16488 arguments, with the cursor positioned at the beginning of the headline.
16489 The return values of all calls to the function will be collected and
16490 returned as a list.
16492 The call to FUNC will be wrapped into a save-excursion form, so FUNC
16493 does not need to preserve point. After evaluation, the cursor will be
16494 moved to the end of the line (presumably of the headline of the
16495 processed entry) and search continues from there. Under some
16496 circumstances, this may not produce the wanted results. For example,
16497 if you have removed (e.g., archived) the current (sub)tree it could
16498 mean that the next entry will be skipped entirely. In such cases, you
16499 can specify the position from where search should continue by making
16500 FUNC set the variable `org-map-continue-from' to the desired buffer
16503 MATCH is a tags/property/todo match as it is used in the agenda match view.
16504 Only headlines that are matched by this query will be considered during
16505 the iteration. When MATCH is nil or t, all headlines will be
16506 visited by the iteration.
16508 SCOPE determines the scope of this command. It can be any of:
16511 nil @r{the current buffer, respecting the restriction if any}
16512 tree @r{the subtree started with the entry at point}
16513 region @r{The entries within the active region, if any}
16514 file @r{the current buffer, without restriction}
16516 @r{the current buffer, and any archives associated with it}
16517 agenda @r{all agenda files}
16518 agenda-with-archives
16519 @r{all agenda files with any archive files associated with them}
16521 @r{if this is a list, all files in the list will be scanned}
16524 The remaining args are treated as settings for the skipping facilities of
16525 the scanner. The following items can be given here:
16527 @vindex org-agenda-skip-function
16529 archive @r{skip trees with the archive tag}
16530 comment @r{skip trees with the COMMENT keyword}
16531 function or Lisp form
16532 @r{will be used as value for @code{org-agenda-skip-function},}
16533 @r{so whenever the function returns t, FUNC}
16534 @r{will not be called for that entry and search will}
16535 @r{continue from the point where the function leaves it}
16539 The function given to that mapping routine can really do anything you like.
16540 It can use the property API (@pxref{Using the property API}) to gather more
16541 information about the entry, or in order to change metadata in the entry.
16542 Here are a couple of functions that might be handy:
16544 @defun org-todo &optional arg
16545 Change the TODO state of the entry. See the docstring of the functions for
16546 the many possible values for the argument ARG.
16549 @defun org-priority &optional action
16550 Change the priority of the entry. See the docstring of this function for the
16551 possible values for ACTION.
16554 @defun org-toggle-tag tag &optional onoff
16555 Toggle the tag TAG in the current entry. Setting ONOFF to either @code{on}
16556 or @code{off} will not toggle tag, but ensure that it is either on or off.
16560 Promote the current entry.
16564 Demote the current entry.
16567 Here is a simple example that will turn all entries in the current file with
16568 a tag @code{TOMORROW} into TODO entries with the keyword @code{UPCOMING}.
16569 Entries in comment trees and in archive trees will be ignored.
16573 '(org-todo "UPCOMING")
16574 "+TOMORROW" 'file 'archive 'comment)
16577 The following example counts the number of entries with TODO keyword
16578 @code{WAITING}, in all agenda files.
16581 (length (org-map-entries t "/+WAITING" 'agenda))
16584 @node MobileOrg, History and Acknowledgments, Hacking, Top
16585 @appendix MobileOrg
16589 @i{MobileOrg} is the name of the mobile companion app for Org mode, currently
16590 available for iOS and for Android. @i{MobileOrg} offers offline viewing and
16591 capture support for an Org mode system rooted on a ``real'' computer. It
16592 does also allow you to record changes to existing entries.
16593 The @uref{http://mobileorg.ncogni.to/, iOS implementation} for the
16594 @i{iPhone/iPod Touch/iPad} series of devices, was developed by Richard
16595 Moreland. Android users should check out
16596 @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg Android}
16597 by Matt Jones. The two implementations are not identical but offer similar
16600 This appendix describes the support Org has for creating agenda views in a
16601 format that can be displayed by @i{MobileOrg}, and for integrating notes
16602 captured and changes made by @i{MobileOrg} into the main system.
16604 For changing tags and TODO states in MobileOrg, you should have set up the
16605 customization variables @code{org-todo-keywords} and @code{org-tags-alist} to
16606 cover all important tags and TODO keywords, even if individual files use only
16607 part of these. MobileOrg will also offer you states and tags set up with
16608 in-buffer settings, but it will understand the logistics of TODO state
16609 @i{sets} (@pxref{Per-file keywords}) and @i{mutually exclusive} tags
16610 (@pxref{Setting tags}) only for those set in these variables.
16613 * Setting up the staging area:: Where to interact with the mobile device
16614 * Pushing to MobileOrg:: Uploading Org files and agendas
16615 * Pulling from MobileOrg:: Integrating captured and flagged items
16618 @node Setting up the staging area, Pushing to MobileOrg, MobileOrg, MobileOrg
16619 @section Setting up the staging area
16621 MobileOrg needs to interact with Emacs through a directory on a server. If you
16622 are using a public server, you should consider to encrypt the files that are
16623 uploaded to the server. This can be done with Org mode 7.02 and with
16624 @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
16625 installation on your system. To turn on encryption, set a password in
16626 @i{MobileOrg} and, on the Emacs side, configure the variable
16627 @code{org-mobile-use-encryption}@footnote{If you can safely store the
16628 password in your Emacs setup, you might also want to configure
16629 @code{org-mobile-encryption-password}. Please read the docstring of that
16630 variable. Note that encryption will apply only to the contents of the
16631 @file{.org} files. The file names themselves will remain visible.}.
16633 The easiest way to create that directory is to use a free
16634 @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot use
16635 Dropbox, or if your version of MobileOrg does not support it, you can use a
16636 webdav server. For more information, check out the documentation of MobileOrg and also this
16637 @uref{http://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
16638 When MobileOrg first connects to your Dropbox, it will create a directory
16639 @i{MobileOrg} inside the Dropbox. After the directory has been created, tell
16643 (setq org-mobile-directory "~/Dropbox/MobileOrg")
16646 Org mode has commands to put files for @i{MobileOrg} into that directory,
16647 and to read captured notes from there.
16649 @node Pushing to MobileOrg, Pulling from MobileOrg, Setting up the staging area, MobileOrg
16650 @section Pushing to MobileOrg
16652 This operation copies all files currently listed in @code{org-mobile-files}
16653 to the directory @code{org-mobile-directory}. By default this list contains
16654 all agenda files (as listed in @code{org-agenda-files}), but additional files
16655 can be included by customizing @code{org-mobile-files}. File names will be
16656 staged with paths relative to @code{org-directory}, so all files should be
16657 inside this directory. The push operation also creates a special Org file
16658 @file{agendas.org} with all custom agenda view defined by the
16659 user@footnote{While creating the agendas, Org mode will force ID properties
16660 on all referenced entries, so that these entries can be uniquely identified
16661 if @i{MobileOrg} flags them for further action. If you do not want to get
16662 these properties in so many entries, you can set the variable
16663 @code{org-mobile-force-id-on-agenda-items} to @code{nil}. Org mode will then
16664 rely on outline paths, in the hope that these will be unique enough.}.
16665 Finally, Org writes the file @file{index.org}, containing links to all other
16666 files. @i{MobileOrg} first reads this file from the server, and then
16667 downloads all agendas and Org files listed in it. To speed up the download,
16668 MobileOrg will only read files whose checksums@footnote{Checksums are stored
16669 automatically in the file @file{checksums.dat}} have changed.
16671 @node Pulling from MobileOrg, , Pushing to MobileOrg, MobileOrg
16672 @section Pulling from MobileOrg
16674 When @i{MobileOrg} synchronizes with the server, it not only pulls the Org
16675 files for viewing. It also appends captured entries and pointers to flagged
16676 and changed entries to the file @file{mobileorg.org} on the server. Org has
16677 a @emph{pull} operation that integrates this information into an inbox file
16678 and operates on the pointers to flagged entries. Here is how it works:
16682 Org moves all entries found in
16683 @file{mobileorg.org}@footnote{@file{mobileorg.org} will be empty after this
16684 operation.} and appends them to the file pointed to by the variable
16685 @code{org-mobile-inbox-for-pull}. Each captured entry and each editing event
16686 will be a top-level entry in the inbox file.
16688 After moving the entries, Org will attempt to implement the changes made in
16689 @i{MobileOrg}. Some changes are applied directly and without user
16690 interaction. Examples are all changes to tags, TODO state, headline and body
16691 text that can be cleanly applied. Entries that have been flagged for further
16692 action will receive a tag @code{:FLAGGED:}, so that they can be easily found
16693 again. When there is a problem finding an entry or applying the change, the
16694 pointer entry will remain in the inbox and will be marked with an error
16695 message. You need to later resolve these issues by hand.
16697 Org will then generate an agenda view with all flagged entries. The user
16698 should then go through these entries and do whatever actions are necessary.
16699 If a note has been stored while flagging an entry in @i{MobileOrg}, that note
16700 will be displayed in the echo area when the cursor is on the corresponding
16705 Pressing @kbd{?} in that special agenda will display the full flagging note in
16706 another window and also push it onto the kill ring. So you could use @kbd{?
16707 z C-y C-c C-c} to store that flagging note as a normal note in the entry.
16708 Pressing @kbd{?} twice in succession will offer to remove the
16709 @code{:FLAGGED:} tag along with the recorded flagging note (which is stored
16710 in a property). In this way you indicate that the intended processing for
16711 this flagged entry is finished.
16716 If you are not able to process all flagged entries directly, you can always
16717 return to this agenda view@footnote{Note, however, that there is a subtle
16718 difference. The view created automatically by @kbd{M-x org-mobile-pull
16719 @key{RET}} is guaranteed to search all files that have been addressed by the
16720 last pull. This might include a file that is not currently in your list of
16721 agenda files. If you later use @kbd{C-c a ?} to regenerate the view, only
16722 the current agenda files will be searched.} using @kbd{C-c a ?}.
16724 @node History and Acknowledgments, GNU Free Documentation License, MobileOrg, Top
16725 @appendix History and acknowledgments
16726 @cindex acknowledgments
16730 @section From Carsten
16732 Org was born in 2003, out of frustration over the user interface of the Emacs
16733 Outline mode. I was trying to organize my notes and projects, and using
16734 Emacs seemed to be the natural way to go. However, having to remember eleven
16735 different commands with two or three keys per command, only to hide and show
16736 parts of the outline tree, that seemed entirely unacceptable to me. Also,
16737 when using outlines to take notes, I constantly wanted to restructure the
16738 tree, organizing it parallel to my thoughts and plans. @emph{Visibility
16739 cycling} and @emph{structure editing} were originally implemented in the
16740 package @file{outline-magic.el}, but quickly moved to the more general
16741 @file{org.el}. As this environment became comfortable for project planning,
16742 the next step was adding @emph{TODO entries}, basic @emph{timestamps}, and
16743 @emph{table support}. These areas highlighted the two main goals that Org
16744 still has today: to be a new, outline-based, plain text mode with innovative
16745 and intuitive editing features, and to incorporate project planning
16746 functionality directly into a notes file.
16748 Since the first release, literally thousands of emails to me or to
16749 @email{emacs-orgmode@@gnu.org} have provided a constant stream of bug
16750 reports, feedback, new ideas, and sometimes patches and add-on code.
16751 Many thanks to everyone who has helped to improve this package. I am
16752 trying to keep here a list of the people who had significant influence
16753 in shaping one or more aspects of Org. The list may not be
16754 complete, if I have forgotten someone, please accept my apologies and
16757 Before I get to this list, a few special mentions are in order:
16760 @item Bastien Guerry
16761 Bastien has written a large number of extensions to Org (most of them
16762 integrated into the core by now), including the @LaTeX{} exporter and the plain
16763 list parser. His support during the early days, when he basically acted as
16764 co-maintainer, was central to the success of this project. Bastien also
16765 invented Worg, helped establishing the Web presence of Org, and sponsored
16766 hosting costs for the orgmode.org website.
16767 @item Eric Schulte and Dan Davison
16768 Eric and Dan are jointly responsible for the Org-babel system, which turns
16769 Org into a multi-language environment for evaluating code and doing literate
16770 programming and reproducible research.
16772 John has contributed a number of great ideas and patches directly to Org,
16773 including the attachment system (@file{org-attach.el}), integration with
16774 Apple Mail (@file{org-mac-message.el}), hierarchical dependencies of TODO
16775 items, habit tracking (@file{org-habits.el}), and encryption
16776 (@file{org-crypt.el}). Also, the capture system is really an extended copy
16777 of his great @file{remember.el}.
16778 @item Sebastian Rose
16779 Without Sebastian, the HTML/XHTML publishing of Org would be the pitiful work
16780 of an ignorant amateur. Sebastian has pushed this part of Org onto a much
16781 higher level. He also wrote @file{org-info.js}, a Java script for displaying
16782 webpages derived from Org using an Info-like or a folding interface with
16783 single-key navigation.
16786 @noindent See below for the full list of contributions! Again, please
16787 let me know what I am missing here!
16789 @section From Bastien
16791 I (Bastien) have been maintaining Org since January 2011. This appendix
16792 would not be complete without adding a few more acknowledgements and thanks
16793 to Carsten's ones above.
16795 I am first grateful to Carsten for his trust while handing me over the
16796 maintainership of Org. His support as been great since day one of this new
16797 adventure, and it helped a lot.
16799 When I took over maintainership, I knew I would have to make Org more
16800 collaborative than ever, as I would have to rely on people that are more
16801 knowledgeable than I am on many parts of the code. Here is a list of the
16802 persons I could rely on, they should really be considered co-maintainers,
16803 either of the code or the community:
16807 Eric is maintaining the Babel parts of Org. His reactivity here kept me away
16808 from worrying about possible bugs here and let me focus on other parts.
16810 @item Nicolas Goaziou
16811 Nicolas is maintaining the consistency of the deepest parts of Org. His work
16812 on @file{org-element.el} and @file{org-export.el} has been outstanding, and
16813 opened the doors for many new ideas and features.
16815 @item Jambunathan K
16816 Jambunathan contributed the ODT exporter, definitely a killer feature of
16817 Org mode. He also contributed the new HTML exporter, which is another core
16818 feature of Org. Here too, I knew I could rely on him to fix bugs in these
16819 areas and to patiently explain the users what was the problems and solutions.
16822 Achim rewrote the building process of Org, turning some @emph{ad hoc} tools
16823 into a flexible and conceptually clean process. He patiently coped with the
16824 many hiccups that such a change can create for users.
16827 The Org mode mailing list would not be such a nice place without Nick, who
16828 patiently helped users so many times. It is impossible to overestimate such
16829 a great help, and the list would not be so active without him.
16832 I received support from so many users that it is clearly impossible to be
16833 fair when shortlisting a few of them, but Org's history would not be
16834 complete if the ones above were not mentioned in this manual.
16836 @section List of contributions
16841 @i{Russel Adams} came up with the idea for drawers.
16843 @i{Thomas Baumann} wrote @file{org-bbdb.el} and @file{org-mhe.el}.
16845 @i{Christophe Bataillon} created the great unicorn logo that we use on the
16848 @i{Alex Bochannek} provided a patch for rounding timestamps.
16850 @i{Jan Böcker} wrote @file{org-docview.el}.
16852 @i{Brad Bozarth} showed how to pull RSS feed data into Org mode files.
16854 @i{Tom Breton} wrote @file{org-choose.el}.
16856 @i{Charles Cave}'s suggestion sparked the implementation of templates
16857 for Remember, which are now templates for capture.
16859 @i{Pavel Chalmoviansky} influenced the agenda treatment of items with
16862 @i{Gregory Chernov} patched support for Lisp forms into table
16863 calculations and improved XEmacs compatibility, in particular by porting
16864 @file{nouline.el} to XEmacs.
16866 @i{Sacha Chua} suggested copying some linking code from Planner.
16868 @i{Baoqiu Cui} contributed the DocBook exporter.
16870 @i{Eddward DeVilla} proposed and tested checkbox statistics. He also
16871 came up with the idea of properties, and that there should be an API for
16874 @i{Nick Dokos} tracked down several nasty bugs.
16876 @i{Kees Dullemond} used to edit projects lists directly in HTML and so
16877 inspired some of the early development, including HTML export. He also
16878 asked for a way to narrow wide table columns.
16880 @i{Thomas S. Dye} contributed documentation on Worg and helped integrating
16881 the Org-Babel documentation into the manual.
16883 @i{Christian Egli} converted the documentation into Texinfo format, inspired
16884 the agenda, patched CSS formatting into the HTML exporter, and wrote
16885 @file{org-taskjuggler.el}.
16887 @i{David Emery} provided a patch for custom CSS support in exported
16890 @i{Nic Ferrier} contributed mailcap and XOXO support.
16892 @i{Miguel A. Figueroa-Villanueva} implemented hierarchical checkboxes.
16894 @i{John Foerch} figured out how to make incremental search show context
16895 around a match in a hidden outline tree.
16897 @i{Raimar Finken} wrote @file{org-git-line.el}.
16899 @i{Mikael Fornius} works as a mailing list moderator.
16901 @i{Austin Frank} works as a mailing list moderator.
16903 @i{Eric Fraga} drove the development of BEAMER export with ideas and
16906 @i{Barry Gidden} did proofreading the manual in preparation for the book
16907 publication through Network Theory Ltd.
16909 @i{Niels Giesen} had the idea to automatically archive DONE trees.
16911 @i{Nicolas Goaziou} rewrote much of the plain list code.
16913 @i{Kai Grossjohann} pointed out key-binding conflicts with other packages.
16915 @i{Brian Gough} of Network Theory Ltd publishes the Org mode manual as a
16918 @i{Bernt Hansen} has driven much of the support for auto-repeating tasks,
16919 task state change logging, and the clocktable. His clear explanations have
16920 been critical when we started to adopt the Git version control system.
16922 @i{Manuel Hermenegildo} has contributed various ideas, small fixes and
16925 @i{Phil Jackson} wrote @file{org-irc.el}.
16927 @i{Scott Jaderholm} proposed footnotes, control over whitespace between
16928 folded entries, and column view for properties.
16930 @i{Matt Jones} wrote @i{MobileOrg Android}.
16932 @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}.
16934 @i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also
16935 provided frequent feedback and some patches.
16937 @i{Matt Lundin} has proposed last-row references for table formulas and named
16938 invisible anchors. He has also worked a lot on the FAQ.
16940 @i{David Maus} wrote @file{org-atom.el}, maintains the issues file for Org,
16941 and is a prolific contributor on the mailing list with competent replies,
16942 small fixes and patches.
16944 @i{Jason F. McBrayer} suggested agenda export to CSV format.
16946 @i{Max Mikhanosha} came up with the idea of refiling.
16948 @i{Dmitri Minaev} sent a patch to set priority limits on a per-file
16951 @i{Stefan Monnier} provided a patch to keep the Emacs-Lisp compiler
16954 @i{Richard Moreland} wrote @i{MobileOrg} for the iPhone.
16956 @i{Rick Moynihan} proposed allowing multiple TODO sequences in a file
16957 and being able to quickly restrict the agenda to a subtree.
16959 @i{Todd Neal} provided patches for links to Info files and Elisp forms.
16961 @i{Greg Newman} refreshed the unicorn logo into its current form.
16963 @i{Tim O'Callaghan} suggested in-file links, search options for general
16964 file links, and TAGS.
16966 @i{Osamu Okano} wrote @file{orgcard2ref.pl}, a Perl program to create a text
16967 version of the reference card.
16969 @i{Takeshi Okano} translated the manual and David O'Toole's tutorial
16972 @i{Oliver Oppitz} suggested multi-state TODO items.
16974 @i{Scott Otterson} sparked the introduction of descriptive text for
16975 links, among other things.
16977 @i{Pete Phillips} helped during the development of the TAGS feature, and
16978 provided frequent feedback.
16980 @i{Martin Pohlack} provided the code snippet to bundle character insertion
16981 into bundles of 20 for undo.
16983 @i{T.V. Raman} reported bugs and suggested improvements.
16985 @i{Matthias Rempe} (Oelde) provided ideas, Windows support, and quality
16988 @i{Paul Rivier} provided the basic implementation of named footnotes. He
16989 also acted as mailing list moderator for some time.
16991 @i{Kevin Rogers} contributed code to access VM files on remote hosts.
16993 @i{Frank Ruell} solved the mystery of the @code{keymapp nil} bug, a
16994 conflict with @file{allout.el}.
16996 @i{Jason Riedy} generalized the send-receive mechanism for Orgtbl tables with
16999 @i{Philip Rooke} created the Org reference card, provided lots
17000 of feedback, developed and applied standards to the Org documentation.
17002 @i{Christian Schlauer} proposed angular brackets around links, among
17005 @i{Paul Sexton} wrote @file{org-ctags.el}.
17007 Linking to VM/BBDB/Gnus was first inspired by @i{Tom Shannon}'s
17008 @file{organizer-mode.el}.
17010 @i{Ilya Shlyakhter} proposed the Archive Sibling, line numbering in literal
17011 examples, and remote highlighting for referenced code lines.
17013 @i{Stathis Sideris} wrote the @file{ditaa.jar} ASCII to PNG converter that is
17014 now packaged into Org's @file{contrib} directory.
17016 @i{Daniel Sinder} came up with the idea of internal archiving by locking
17019 @i{Dale Smith} proposed link abbreviations.
17021 @i{James TD Smith} has contributed a large number of patches for useful
17022 tweaks and features.
17024 @i{Adam Spiers} asked for global linking commands, inspired the link
17025 extension system, added support for mairix, and proposed the mapping API.
17027 @i{Ulf Stegemann} created the table to translate special symbols to HTML,
17028 @LaTeX{}, UTF-8, Latin-1 and ASCII.
17030 @i{Andy Stewart} contributed code to @file{org-w3m.el}, to copy HTML content
17031 with links transformation to Org syntax.
17033 @i{David O'Toole} wrote @file{org-publish.el} and drafted the manual
17034 chapter about publishing.
17036 @i{Jambunathan K} contributed the ODT exporter.
17038 @i{Sebastien Vauban} reported many issues with @LaTeX{} and BEAMER export and
17039 enabled source code highlighting in Gnus.
17041 @i{Stefan Vollmar} organized a video-recorded talk at the
17042 Max-Planck-Institute for Neurology. He also inspired the creation of a
17043 concept index for HTML export.
17045 @i{J@"urgen Vollmer} contributed code generating the table of contents
17048 @i{Samuel Wales} has provided important feedback and bug reports.
17050 @i{Chris Wallace} provided a patch implementing the @samp{QUOTE}
17053 @i{David Wainberg} suggested archiving, and improvements to the linking
17056 @i{Carsten Wimmer} suggested some changes and helped fix a bug in
17059 @i{Roland Winkler} requested additional key bindings to make Org
17062 @i{Piotr Zielinski} wrote @file{org-mouse.el}, proposed agenda blocks
17063 and contributed various ideas and code snippets.
17067 @node GNU Free Documentation License, Main Index, History and Acknowledgments, Top
17068 @appendix GNU Free Documentation License
17069 @include doclicense.texi
17072 @node Main Index, Key Index, GNU Free Documentation License, Top
17073 @unnumbered Concept index
17077 @node Key Index, Command and Function Index, Main Index, Top
17078 @unnumbered Key index
17082 @node Command and Function Index, Variable Index, Key Index, Top
17083 @unnumbered Command and function index
17087 @node Variable Index, , Command and Function Index, Top
17088 @unnumbered Variable index
17090 This is not a complete index of variables and faces, only the ones that are
17091 mentioned in the manual. For a more complete list, use @kbd{M-x
17092 org-customize @key{RET}} and then click yourself through the tree.
17098 @c Local variables:
17100 @c indent-tabs-mode: nil
17101 @c paragraph-start: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|\f\\|[ ]*$"
17102 @c paragraph-separate: "
\b\\|^@[a-zA-Z]*[ \n]\\|^@x?org\\(key\\|cmd\\)\\|[ \f]*$"
17106 @c LocalWords: webdavhost pre